PHP 8.2.30
Preview: scope.py Size: 2.78 KB
/proc/thread-self/root/opt/alt/python313/lib/python3.13/site-packages/pip/_vendor/rich/scope.py

from collections.abc import Mapping
from typing import TYPE_CHECKING, Any, Optional, Tuple

from .highlighter import ReprHighlighter
from .panel import Panel
from .pretty import Pretty
from .table import Table
from .text import Text, TextType

if TYPE_CHECKING:
    from .console import ConsoleRenderable


def render_scope(
    scope: "Mapping[str, Any]",
    *,
    title: Optional[TextType] = None,
    sort_keys: bool = True,
    indent_guides: bool = False,
    max_length: Optional[int] = None,
    max_string: Optional[int] = None,
) -> "ConsoleRenderable":
    """Render python variables in a given scope.

    Args:
        scope (Mapping): A mapping containing variable names and values.
        title (str, optional): Optional title. Defaults to None.
        sort_keys (bool, optional): Enable sorting of items. Defaults to True.
        indent_guides (bool, optional): Enable indentation guides. Defaults to False.
        max_length (int, optional): Maximum length of containers before abbreviating, or None for no abbreviation.
            Defaults to None.
        max_string (int, optional): Maximum length of string before truncating, or None to disable. Defaults to None.

    Returns:
        ConsoleRenderable: A renderable object.
    """
    highlighter = ReprHighlighter()
    items_table = Table.grid(padding=(0, 1), expand=False)
    items_table.add_column(justify="right")

    def sort_items(item: Tuple[str, Any]) -> Tuple[bool, str]:
        """Sort special variables first, then alphabetically."""
        key, _ = item
        return (not key.startswith("__"), key.lower())

    items = sorted(scope.items(), key=sort_items) if sort_keys else scope.items()
    for key, value in items:
        key_text = Text.assemble(
            (key, "scope.key.special" if key.startswith("__") else "scope.key"),
            (" =", "scope.equals"),
        )
        items_table.add_row(
            key_text,
            Pretty(
                value,
                highlighter=highlighter,
                indent_guides=indent_guides,
                max_length=max_length,
                max_string=max_string,
            ),
        )
    return Panel.fit(
        items_table,
        title=title,
        border_style="scope.border",
        padding=(0, 1),
    )


if __name__ == "__main__":  # pragma: no cover
    from pip._vendor.rich import print

    print()

    def test(foo: float, bar: float) -> None:
        list_of_things = [1, 2, 3, None, 4, True, False, "Hello World"]
        dict_of_things = {
            "version": "1.1",
            "method": "confirmFruitPurchase",
            "params": [["apple", "orange", "mangoes", "pomelo"], 1.123],
            "id": "194521489",
        }
        print(render_scope(locals(), title="[i]locals", sort_keys=False))

    test(20.3423, 3.1427)
    print()

Directory Contents

Dirs: 1 × Files: 78

Name Size Perms Modified Actions
- drwxr-xr-x 2026-02-10 08:09:26
Edit Download
890 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
10.13 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
6.74 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.19 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
9.61 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.40 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
17.80 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.03 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
6.96 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
96.89 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.26 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
5.37 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
6.47 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
7.89 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
972 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
2.44 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
642 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
2.45 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.64 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
9.36 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.91 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.18 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
13.68 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
13.94 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.58 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
11.62 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
8.01 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
5.18 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.85 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
828 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.32 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
10.33 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
35.01 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
58.31 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
7.97 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
11.04 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.36 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
0 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
166 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.33 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.49 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
2.78 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.55 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
23.68 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.24 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
4.32 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
26.44 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.23 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
34.35 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
38.75 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.29 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
44.46 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.69 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
102 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
28.91 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
8.95 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
9.86 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
136.95 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.04 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
2.05 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
265 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
799 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
9.47 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
3.15 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.21 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.35 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
6.90 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
423 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
5.34 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
19.45 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
351 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
417 B lrw-r--r-- 2026-01-10 11:03:59
Edit Download
22.29 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.88 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
2.72 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
1.80 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
5.95 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download
8.28 KB lrw-r--r-- 2026-01-10 11:03:59
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).