?HAMA

Navigation

Breadcrumbs

/ / opt / hc_python / lib / python3.12 / site-packages / pip / _vendor / rich

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 10.08 KB

/opt/hc_python/lib/python3.12/site-packages/pip/_vendor/rich/align.py

Text Base64

from itertools import chain
from typing import TYPE_CHECKING, Iterable, Optional, Literal

from .constrain import Constrain
from .jupyter import JupyterMixin
from .measure import Measurement
from .segment import Segment
from .style import StyleType

if TYPE_CHECKING:
    from .console import Console, ConsoleOptions, RenderableType, RenderResult

AlignMethod = Literal["left", "center", "right"]
VerticalAlignMethod = Literal["top", "middle", "bottom"]

class Align(JupyterMixin):
    """Align a renderable by adding spaces if necessary.

Args:
        renderable (RenderableType): A console renderable.
        align (AlignMethod): One of "left", "center", or "right""
        style (StyleType, optional): An optional style to apply to the background.
        vertical (Optional[VerticalAlignMethod], optional): Optional vertical align, one of "top", "middle", or "bottom". Defaults to None.
        pad (bool, optional): Pad the right with spaces. Defaults to True.
        width (int, optional): Restrict contents to given width, or None to use default width. Defaults to None.
        height (int, optional): Set height of align renderable, or None to fit to contents. Defaults to None.

Raises:
        ValueError: if ``align`` is not one of the expected values.
    """

def __init__(
        self,
        renderable: "RenderableType",
        align: AlignMethod = "left",
        style: Optional[StyleType] = None,
        *,
        vertical: Optional[VerticalAlignMethod] = None,
        pad: bool = True,
        width: Optional[int] = None,
        height: Optional[int] = None,
    ) -> None:
        if align not in ("left", "center", "right"):
            raise ValueError(
                f'invalid value for align, expected "left", "center", or "right" (not {align!r})'
            )
        if vertical is not None and vertical not in ("top", "middle", "bottom"):
            raise ValueError(
                f'invalid value for vertical, expected "top", "middle", or "bottom" (not {vertical!r})'
            )
        self.renderable = renderable
        self.align = align
        self.style = style
        self.vertical = vertical
        self.pad = pad
        self.width = width
        self.height = height

def __repr__(self) -> str:
        return f"Align({self.renderable!r}, {self.align!r})"

@classmethod
    def left(
        cls,
        renderable: "RenderableType",
        style: Optional[StyleType] = None,
        *,
        vertical: Optional[VerticalAlignMethod] = None,
        pad: bool = True,
        width: Optional[int] = None,
        height: Optional[int] = None,
    ) -> "Align":
        """Align a renderable to the left."""
        return cls(
            renderable,
            "left",
            style=style,
            vertical=vertical,
            pad=pad,
            width=width,
            height=height,
        )

@classmethod
    def center(
        cls,
        renderable: "RenderableType",
        style: Optional[StyleType] = None,
        *,
        vertical: Optional[VerticalAlignMethod] = None,
        pad: bool = True,
        width: Optional[int] = None,
        height: Optional[int] = None,
    ) -> "Align":
        """Align a renderable to the center."""
        return cls(
            renderable,
            "center",
            style=style,
            vertical=vertical,
            pad=pad,
            width=width,
            height=height,
        )

@classmethod
    def right(
        cls,
        renderable: "RenderableType",
        style: Optional[StyleType] = None,
        *,
        vertical: Optional[VerticalAlignMethod] = None,
        pad: bool = True,
        width: Optional[int] = None,
        height: Optional[int] = None,
    ) -> "Align":
        """Align a renderable to the right."""
        return cls(
            renderable,
            "right",
            style=style,
            vertical=vertical,
            pad=pad,
            width=width,
            height=height,
        )

def __rich_console__(
        self, console: "Console", options: "ConsoleOptions"
    ) -> "RenderResult":
        align = self.align
        width = console.measure(self.renderable, options=options).maximum
        rendered = console.render(
            Constrain(
                self.renderable, width if self.width is None else min(width, self.width)
            ),
            options.update(height=None),
        )
        lines = list(Segment.split_lines(rendered))
        width, height = Segment.get_shape(lines)
        lines = Segment.set_shape(lines, width, height)
        new_line = Segment.line()
        excess_space = options.max_width - width
        style = console.get_style(self.style) if self.style is not None else None

def generate_segments() -> Iterable[Segment]:
            if excess_space <= 0:
                # Exact fit
                for line in lines:
                    yield from line
                    yield new_line

elif align == "left":
                # Pad on the right
                pad = Segment(" " * excess_space, style) if self.pad else None
                for line in lines:
                    yield from line
                    if pad:
                        yield pad
                    yield new_line

elif align == "center":
                # Pad left and right
                left = excess_space // 2
                pad = Segment(" " * left, style)
                pad_right = (
                    Segment(" " * (excess_space - left), style) if self.pad else None
                )
                for line in lines:
                    if left:
                        yield pad
                    yield from line
                    if pad_right:
                        yield pad_right
                    yield new_line

elif align == "right":
                # Padding on left
                pad = Segment(" " * excess_space, style)
                for line in lines:
                    yield pad
                    yield from line
                    yield new_line

blank_line = (
            Segment(f"{' ' * (self.width or options.max_width)}\n", style)
            if self.pad
            else Segment("\n")
        )

def blank_lines(count: int) -> Iterable[Segment]:
            if count > 0:
                for _ in range(count):
                    yield blank_line

vertical_height = self.height or options.height
        iter_segments: Iterable[Segment]
        if self.vertical and vertical_height is not None:
            if self.vertical == "top":
                bottom_space = vertical_height - height
                iter_segments = chain(generate_segments(), blank_lines(bottom_space))
            elif self.vertical == "middle":
                top_space = (vertical_height - height) // 2
                bottom_space = vertical_height - top_space - height
                iter_segments = chain(
                    blank_lines(top_space),
                    generate_segments(),
                    blank_lines(bottom_space),
                )
            else:  #  self.vertical == "bottom":
                top_space = vertical_height - height
                iter_segments = chain(blank_lines(top_space), generate_segments())
        else:
            iter_segments = generate_segments()
        if self.style:
            style = console.get_style(self.style)
            iter_segments = Segment.apply_style(iter_segments, style)
        yield from iter_segments

def __rich_measure__(
        self, console: "Console", options: "ConsoleOptions"
    ) -> Measurement:
        measurement = Measurement.get(console, options, self.renderable)
        return measurement

class VerticalCenter(JupyterMixin):
    """Vertically aligns a renderable.

Warn:
        This class is deprecated and may be removed in a future version. Use Align class with
        `vertical="middle"`.

Args:
        renderable (RenderableType): A renderable object.
        style (StyleType, optional): An optional style to apply to the background. Defaults to None.
    """

def __init__(
        self,
        renderable: "RenderableType",
        style: Optional[StyleType] = None,
    ) -> None:
        self.renderable = renderable
        self.style = style

def __repr__(self) -> str:
        return f"VerticalCenter({self.renderable!r})"

def __rich_console__(
        self, console: "Console", options: "ConsoleOptions"
    ) -> "RenderResult":
        style = console.get_style(self.style) if self.style is not None else None
        lines = console.render_lines(
            self.renderable, options.update(height=None), pad=False
        )
        width, _height = Segment.get_shape(lines)
        new_line = Segment.line()
        height = options.height or options.size.height
        top_space = (height - len(lines)) // 2
        bottom_space = height - top_space - len(lines)
        blank_line = Segment(f"{' ' * width}", style)

def blank_lines(count: int) -> Iterable[Segment]:
            for _ in range(count):
                yield blank_line
                yield new_line

if top_space > 0:
            yield from blank_lines(top_space)
        for line in lines:
            yield from line
            yield new_line
        if bottom_space > 0:
            yield from blank_lines(bottom_space)

if __name__ == "__main__":  # pragma: no cover
    from pip._vendor.rich.console import Console, Group
    from pip._vendor.rich.highlighter import ReprHighlighter
    from pip._vendor.rich.panel import Panel

highlighter = ReprHighlighter()
    console = Console()

panel = Panel(
        Group(
            Align.left(highlighter("align='left'")),
            Align.center(highlighter("align='center'")),
            Align.right(highlighter("align='right'")),
        ),
        width=60,
        style="on dark_blue",
        title="Align",
    )

console.print(
        Align.center(panel, vertical="middle", style="on red", height=console.height)
    )

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 1 × Files: 79

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
__pycache__ DIR	-	drwxr-xr-x	2025-12-03 08:02:42	Edit Download recursive recursive
abc.py	890 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
align.py	10.08 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
ansi.py	6.76 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
bar.py	3.19 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
box.py	10.44 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
cells.py	5.01 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
color.py	17.78 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
color_triplet.py	1.03 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
columns.py	6.96 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
console.py	98.49 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
constrain.py	1.26 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
containers.py	5.37 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
control.py	6.33 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
default_styles.py	8.06 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
diagnose.py	1.00 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
emoji.py	2.31 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
errors.py	642 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
filesize.py	2.43 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
file_proxy.py	1.64 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
highlighter.py	9.36 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
json.py	4.91 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
jupyter.py	3.18 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
layout.py	13.68 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
LICENSE	1.03 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
live.py	14.82 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
live_render.py	3.44 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
logging.py	12.18 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
markup.py	8.25 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
measure.py	5.18 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
padding.py	4.79 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
pager.py	828 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
palette.py	3.32 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
panel.py	10.90 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
pretty.py	35.54 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
progress.py	58.99 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
progress_bar.py	7.97 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
prompt.py	12.16 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
protocol.py	1.36 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
py.typed	0 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
region.py	166 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
repr.py	4.33 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
rule.py	4.49 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
scope.py	2.78 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
screen.py	1.55 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
segment.py	24.16 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
spinner.py	4.12 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
status.py	4.32 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
style.py	26.36 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
styled.py	1.23 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
syntax.py	35.52 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
table.py	39.11 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
terminal_theme.py	3.29 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
text.py	46.44 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
theme.py	3.68 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
themes.py	102 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
traceback.py	35.02 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
tree.py	9.23 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_cell_widths.py	9.97 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_emoji_codes.py	136.95 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_emoji_replace.py	1.04 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_export_format.py	2.08 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_extension.py	265 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_fileno.py	799 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_inspect.py	9.43 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_log_render.py	3.15 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_loop.py	1.21 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_null_file.py	1.36 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_palettes.py	6.90 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_pick.py	423 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_ratio.py	5.20 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_spinners.py	19.45 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_stack.py	351 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_timer.py	417 B	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_win32_console.py	22.22 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_windows.py	1.88 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_windows_renderer.py	2.72 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
_wrap.py	3.32 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
__init__.py	5.95 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive
__main__.py	7.71 KB	lrw-r--r--	2025-12-03 08:02:41	Edit Download recursive recursive