stdl 0.6.7__py3-none-any.whl

stdl/st.py

@@ -0,0 +1,422 @@
+import os
+import re
+import textwrap
+from dataclasses import dataclass
+from platform import system
+from sys import stdout
+from typing import Any, Literal
+
+CSI_RESET = "\033["
+NO_COLOR = bool(os.environ.get("NO_COLOR", False))
+
+
+def ansi_code(n: int) -> str:
+    return f"{CSI_RESET}{n}m"
+
+
+class ColorANSI:
+    # Cancel SGR codes if we don't write to a terminal
+    if not stdout.isatty():
+        for attr in dir():
+            if isinstance(attr, str) and attr[0] != "_":
+                locals()[attr] = ""
+    else:
+        # Enable VT mode on Windows
+        if system() == "Windows":
+            import ctypes
+
+            kernel32 = ctypes.windll.kernel32
+            handle = kernel32.GetStdHandle(-11)
+            if handle:
+                kernel32.SetConsoleMode(handle, 7)
+            del kernel32
+            del handle
+            del ctypes
+
+    @classmethod
+    def __class_getitem__(cls, key: str) -> str:
+        key = key.upper().replace(" ", "_")
+        if key in dir(cls):
+            return getattr(cls, key)
+        raise KeyError(key)
+
+    @classmethod
+    def dict(cls) -> dict[str, str]:
+        ignored = ["dict", "print_all", "get_names"]
+        data = {}
+        for attr in dir(cls):
+            if attr[0] != "_" and attr not in ignored:
+                data[attr] = cls[attr]
+        return data
+
+    @classmethod
+    def get_names(cls) -> list[str]:
+        return [i for i in cls.dict.keys()]
+
+    @classmethod
+    def print_all(cls) -> None:
+        for k, v in cls.dict().items():
+            if k == "RESET":
+                continue
+            print(colored(k, v))  # type:ignore
+
+
+class FG(ColorANSI):
+    """Foreground Color"""
+
+    BLACK = ansi_code(30)
+    RED = ansi_code(31)
+    GREEN = ansi_code(32)
+    YELLOW = ansi_code(33)
+    BLUE = ansi_code(34)
+    MAGENTA = ansi_code(35)
+    CYAN = ansi_code(36)
+    WHITE = ansi_code(37)
+    GRAY = ansi_code(90)
+    LIGHT_RED = ansi_code(91)
+    LIGHT_GREEN = ansi_code(92)
+    LIGHT_YELLOW = ansi_code(93)
+    LIGHT_BLUE = ansi_code(94)
+    LIGHT_MAGENTA = ansi_code(95)
+    LIGHT_CYAN = ansi_code(96)
+    LIGHT_WHITE = ansi_code(97)
+    BOLD = ansi_code(1)
+
+
+class BG(ColorANSI):
+    """Background Color"""
+
+    BLACK = ansi_code(40)
+    RED = ansi_code(41)
+    GREEN = ansi_code(42)
+    YELLOW = ansi_code(43)
+    BLUE = ansi_code(44)
+    MAGENTA = ansi_code(45)
+    CYAN = ansi_code(46)
+    WHITE = ansi_code(47)
+    GRAY = ansi_code(100)
+    LIGHT_RED = ansi_code(101)
+    LIGHT_GREEN = ansi_code(102)
+    LIGHT_YELLOW = ansi_code(103)
+    LIGHT_BLUE = ansi_code(104)
+    LIGHT_MAGENTA = ansi_code(105)
+    LIGHT_CYAN = ansi_code(106)
+    LIGHT_WHITE = ansi_code(107)
+
+
+class ST(ColorANSI):
+    """Style"""
+
+    RESET = ansi_code(0)
+    BOLD = ansi_code(1)
+    DIM = ansi_code(2)
+    ITALIC = ansi_code(3)
+    UNDERLINE = ansi_code(4)
+    BLINK = ansi_code(5)
+
+
+ForegroundColor = Literal[
+    "black",
+    "blue",
+    "bold",
+    "cyan",
+    "gray",
+    "green",
+    "light_blue",
+    "light_cyan",
+    "light_green",
+    "light_magenta",
+    "light_red",
+    "light_white",
+    "light_yellow",
+    "magenta",
+    "red",
+    "white",
+    "yellow",
+]
+
+
+BackgroundColor = Literal[
+    "black",
+    "blue",
+    "cyan",
+    "gray",
+    "green",
+    "light_blue",
+    "light_cyan",
+    "light_green",
+    "light_magenta",
+    "light_red",
+    "light_white",
+    "light_yellow",
+    "magenta",
+    "red",
+    "white",
+    "yellow",
+]
+
+Style = Literal["blink", "bold", "dim", "italic", "reset", "underline"]
+
+
+def _get_ansi_value(value: str | None, handler: Any) -> str:
+    if not value:
+        return ""
+    try:
+        return handler[value]
+    except KeyError:
+        return value
+
+
+def colored(
+    text: str,
+    color: ForegroundColor | str | None = None,
+    background: BackgroundColor | str | None = None,
+    style: Style | str | None = None,
+) -> str:
+    """
+    Returns the text with ansi color, background color and text style codes.
+
+    Args:
+        text (str): The text that should be colorized.
+        color (str, optional): The color to use for the text.
+        background (str, optional): The color to use for the background.
+        style (str, optional): The style to use for the text.
+
+    Returns:
+        str: The colorized text.
+    """
+    if NO_COLOR or not stdout.isatty():
+        return text
+    color = _get_ansi_value(color, FG)  # type: ignore
+    background = _get_ansi_value(background, BG)  # type: ignore
+    style = _get_ansi_value(style, ST)  # type: ignore
+    return f"{color}{background}{style}{text}{ST.RESET}"
+
+
+@dataclass
+class TextStyle:
+    color: ForegroundColor | str | None = None
+    background: BackgroundColor | str | None = None
+    style: Style | str | None = None
+
+
+def with_style(text: str, style: TextStyle) -> str:
+    return colored(text, color=style.color, background=style.background, style=style.style)
+
+
+def terminal_link(
+    uri: str,
+    label: str | None = None,
+    color: ForegroundColor = "white",
+    background: BackgroundColor | None = None,
+    style: Style | None = None,
+) -> str:
+    """
+    Returns a hyperlink that can be used in terminals.
+
+    Note:
+        Hyperlinks are not supported in all terminals.
+        For more information visit
+        <https://github.com/Alhadis/OSC8-Adoption/>
+        and
+        <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>
+
+    Args:
+        uri (str): The URI of the link.
+        label (str, optional): The label of the link. Defaults to the URI.
+        color (str, optional): The color of the link. Defaults to white.
+        background (str, optional): The background color of the link.
+        style (str, optional): The style of the link.
+
+    Returns:
+        str: The link as a string.
+    """
+    if label is None:
+        label = uri
+
+    if stdout.isatty():
+        link = f"\033]8;;{uri}\033\\{label}\033]8;;\033\\"
+    else:
+        link = uri
+    link = colored(link, color, background, style)
+    return link
+
+
+def remove(s: str, chars: str | set, replace_with: str = "") -> str:
+    """
+    Remove or replace characters in a string.
+
+    Args:
+        s (str): Input string.
+        chars (str | set): Characters to remove
+        replace_with (str, optional): If provided, replace the characters with this value.
+
+    """
+    string = []
+    chars = set(chars)
+    for c in s:
+        if c not in chars:
+            string.append(c)
+        else:
+            if replace_with:
+                string.append(replace_with)
+    return "".join(string)
+
+
+def keep(s: str, chars: str | set, replace_with: str = "") -> str:
+    """
+    Keep provided characters in a string. Remove or replace others.
+
+    Args:
+        s (str): Input string
+        chars (str | set): Characters to keep
+        replace_with (str, optional): If provided, replace other characters with this value.
+
+    """
+    string = []
+    chars = set(chars)
+    for c in s:
+        if c in chars:
+            string.append(c)
+        else:
+            if replace_with:
+                string.append(replace_with)
+    return "".join(string)
+
+
+ASCII = set("".join(chr(x) for x in range(128)))
+
+
+class sf:
+    """A collection of functions that can be used to filter strings."""
+
+    @classmethod
+    def filename(cls, filename: str, replace_with: str = "") -> str:
+        """Removes or replaces characters that are not allowed to be in a filename."""
+        return remove(filename, chars='|?*<>:"\\', replace_with=replace_with)
+
+    @classmethod
+    def filepath(cls, filepath: str, replace_with: str = "") -> str:
+        """Removes or replaces characters that are not allowed to be in a filepath."""
+        if not filepath:
+            return ""
+        dirname, filename = os.path.split(filepath)
+        filename = sf.filename(filename, replace_with)
+        dirname = remove(dirname, '|?*<>:"')
+        return f"{dirname}{os.sep}{filename}"
+
+    @classmethod
+    def ascii(cls, s: str, replace_with: str = "") -> str:
+        """Removes or replaces non-ASCII characters from the string."""
+        return keep(s, ASCII, replace_with)
+
+
+def snake_case(s: str) -> str:
+    """Converts a given string to snake_case."""
+    return "_".join(
+        re.sub(
+            "([A-Z][a-z]+)",
+            r" \1",
+            re.sub("([A-Z]+)", r" \1", s.replace("-", " ")),
+        ).split()
+    ).lower()
+
+
+def camel_case(s: str) -> str:
+    """Converts a given string to camelCase."""
+    s = re.sub(r"(_|-)+", " ", s).title().replace(" ", "")
+    return s[0].lower() + s[1:]
+
+
+def kebab_case(s: str) -> str:
+    """Converts a given string to kebab-case."""
+    RE_WORDS = r"[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+"
+    RE_SEP = r"(\s|_|-)+"
+    return "-".join(
+        re.sub(
+            RE_SEP,
+            " ",
+            re.sub(
+                RE_WORDS,
+                lambda mo: " " + mo.group(0).lower(),
+                s,
+            ),
+        ).split()
+    )
+
+
+def wrapped(text: str, width: int, newline: str = "\n") -> str:
+    """Wraps the given text to a specified width and separates lines with the given newline character."""
+    return newline.join(textwrap.wrap(text, width=width))
+
+
+def ansi_len(s: str) -> int:
+    """Returns the length of the string without the ANSI codes."""
+    ascii_codes = re.findall(r"\x1b\[[0-9;]*[m]", s)
+    codes_len = sum(len(code) for code in ascii_codes)
+    return len(s) - codes_len
+
+
+def ansi_ljust(s: str, width: int, fillchar: str = " ") -> str:
+    """
+    Ljust function that takes into account the length of the ANSI codes in the string.
+
+    Args:
+        s (str): The string to be left justified.
+        width (int): The width of the string.
+        fillchar (str, optional): The character to fill the string with. Defaults to " ".
+    """
+    ascii_codes = re.findall(r"\x1b\[[0-9;]*[m]", s)
+    codes_len = sum(len(code) for code in ascii_codes)
+    new_width = width + codes_len
+    return s.ljust(new_width, fillchar)
+
+
+def ansi_rjust(s: str, width: int, fillchar: str = " ") -> str:
+    """
+    Rjust function that takes into account the length of the ANSI codes in the string.
+
+    Args:
+        s (str): The string to be right justified.
+        width (int): The width of the string.
+        fillchar (str, optional): The character to fill the string with. Defaults to " ".
+    """
+    ascii_codes = re.findall(r"\x1b\[[0-9;]*[m]", s)
+    codes_len = sum(len(code) for code in ascii_codes)
+    new_width = width + codes_len
+    return s.rjust(new_width, fillchar)
+
+
+def ansi_strip(r: str) -> str:
+    """Remove ANSI escape codes from a string."""
+    ansi_escape = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
+    return ansi_escape.sub("", r)
+
+
+if __name__ == "__main__":
+    FG.print_all()
+    BG.print_all()
+    ST.print_all()
+
+
+__all__ = [
+    "FG",
+    "BG",
+    "ST",
+    "colored",
+    "terminal_link",
+    "remove",
+    "keep",
+    "ASCII",
+    "sf",
+    "snake_case",
+    "camel_case",
+    "kebab_case",
+    "wrapped",
+    "ansi_len",
+    "ansi_ljust",
+    "ansi_rjust",
+    "Style",
+    "ForegroundColor",
+    "BackgroundColor",
+]

stdl-0.6.7.dist-info/METADATA

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: stdl
+Version: 0.6.7
+Summary: Extended Python Standard Library
+Project-URL: Repository, https://github.com/zigai/stdl
+Project-URL: Issues, https://github.com/zigai/stdl/issues
+Project-URL: Homepage, https://github.com/zigai/stdl
+Author-email: Žiga Ivanšek <ziga.ivansek@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 Žiga Ivanšek
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: ANSI colors,color formats,filesystem,lazy import,list utils,logging configuration,python lazy import,python utilities,standard library,stdl,string utils,terminal links,terminal output
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: codespell; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pydantic>=2; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: full
+Requires-Dist: tqdm>=4.67.1; extra == 'full'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pydantic>=2; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# stdl
+
+[![Tests](https://github.com/zigai/stdl/actions/workflows/test.yml/badge.svg)](https://github.com/zigai/stdl/actions/workflows/test.yml)
+[![Documentation Status](https://readthedocs.org/projects/stdl/badge/?version=latest)](https://stdl.readthedocs.io/en/latest/?badge=latest)
+[![PyPI version](https://badge.fury.io/py/stdl.svg)](https://badge.fury.io/py/stdl)
+![Supported versions](https://img.shields.io/badge/python-3.10+-blue.svg)
+[![Downloads](https://static.pepy.tech/badge/stdl)](https://pepy.tech/project/stdl)
+[![license](https://img.shields.io/github/license/zigai/stdl.svg)](https://github.com/zigai/stdl/blob/master/LICENSE)
+
+`stdl` is a collection of Python utilities that complement the standard library.
+
+## Features
+
+- File and directory operations
+- String manipulation
+- ANSI color support for terminal output
+- Date and time formatting
+- List utils
+- Lazy imports
+- Logging configuration for `logging` and `loguru`
+- [See docs](https://stdl.readthedocs.io/en/latest/?badge=latest)
+
+## Installation
+
+### Using pip
+
+```sh
+pip install stdl
+```
+
+### Using uv
+
+```sh
+uv add stdl
+```
+
+### From source
+
+```sh
+pip install git+https://github.com/zigai/stdl.git
+# or
+uv add git+https://github.com/zigai/stdl.git
+```
+
+## Examples
+
+### Lazy imports
+
+```python
+from typing import TYPE_CHECKING
+from stdl.import_lazy import import_lazy
+
+if TYPE_CHECKING:
+    from os.path import abspath, join
+    import numpy as np
+    import torch
+else:
+    import_lazy("os.path", ["join", "abspath"], verbose=True)
+    import_lazy("numpy", alias="np", verbose=True)
+    import_lazy("torch", verbose=True)
+
+print(np.zeros(4))
+# importing "numpy" took 0.060s
+# [0. 0. 0. 0.]
+print(torch)
+# <LazyImport: torch>
+print(torch.randn(8))
+# importing "torch" took 1.118s
+# tensor([0., 0., 0., 0., 0., 0., 0., 0.])
+print(torch)
+# <module 'torch' from .../torch/__init__.py'
+```
+
+## License
+
+[MIT License](https://github.com/zigai/stdl/blob/master/LICENSE)

stdl-0.6.7.dist-info/RECORD

@@ -0,0 +1,14 @@
+stdl/__init__.py,sha256=XXNSego9YjRnY5QY77ZfWVXGSCfbwosm9Z2MLhECMtI,111
+stdl/color.py,sha256=Vi2MAkF6kPUNDTnctFChT2ldGSHyEKR-Maw-amzfwIQ,45055
+stdl/decorators.py,sha256=vsHGXfzCf9m6pyeT0AiWuVFpwPOQ2FT4xaDOK_MSaFY,3256
+stdl/dt.py,sha256=XmEf0BqkmxM3HMsYwELGjKaVppx3NdbmI6sppCNk-zY,10203
+stdl/fs.py,sha256=vFr4OrWM5hr8qsX_GzREJ-P4xsZh-vP0BiBVUECjbDM,52292
+stdl/import_lazy.py,sha256=xqJU5S4ngYitpLwiGuBwGpeW4d3VYRb1-tN3n3ppqDI,4127
+stdl/log.py,sha256=Bro5Oyeo_RMHzWsi_mcbph6kbPSUvPW1KxmOKqRwqN8,4224
+stdl/lst.py,sha256=xeekFnqpuSpQnPETJCgylWrka5nspQkhyUQIr0D3u6U,4067
+stdl/net.py,sha256=xEaet5wM3Olplvn79E-80C-SPUlI8L-2aqCK1qL87-M,2566
+stdl/st.py,sha256=3bEiDf0Q6xs153aPMCVPAO-MDkvuDW9Z243POJ0mT1s,11061
+stdl-0.6.7.dist-info/METADATA,sha256=XyTEN3jbfRprAZRN-A-bIKMlS95zM1Tq6rPQPX--t94,5086
+stdl-0.6.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+stdl-0.6.7.dist-info/licenses/LICENSE,sha256=MwAJrJWzBVMNkmJSjdRctks7VcSbh8yAXezV_uf4yu8,1071
+stdl-0.6.7.dist-info/RECORD,,

stdl-0.6.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

stdl-0.6.7.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Žiga Ivanšek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.