batrachian-toad 0.5.22__py3-none-any.whl

toad/__init__.py

@@ -0,0 +1,46 @@
+from typing import Literal, Mapping
+import platform
+
+NAME = "toad"
+TITLE = "Toad"
+
+type OS = Literal["linux", "macos", "windows", "*"]
+
+_system = platform.system()
+_OS_map: dict[str, OS] = {
+    "Linux": "linux",
+    "Darwin": "macos",
+    "Windows": "windows",
+}
+os: OS = _OS_map.get(_system, "linux")
+
+
+def get_os_matrix(matrix: Mapping[OS, str]) -> str | None:
+    """Get a value from a mapping where the key is an OS, falling back to a wildcard ("*").
+
+    Args:
+        matrix: A mapping where an OS literal is the key.
+
+    Returns:
+        The value, if one is found, or `None`.
+    """
+    if (result := matrix.get(os)) is None:
+        result = matrix.get("*")
+    return result
+
+
+def get_version() -> str:
+    """Get the current version of Toad.
+
+    Returns:
+        str: Version string, e.g "1.2.3"
+    """
+    from importlib.metadata import version
+
+    try:
+        return version("batrachian-toad")
+    except Exception:
+        try:
+            return version("toad")
+        except Exception:
+            return "0.1.0unknown"

toad/__main__.py

@@ -0,0 +1,4 @@
+from toad.cli import main
+
+if __name__ == "__main__":
+    main()

toad/_loop.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+from typing import Iterable, Literal, Sequence, TypeVar
+
+T = TypeVar("T")
+
+
+def loop_first(values: Iterable[T]) -> Iterable[tuple[bool, T]]:
+    """Iterate and generate a tuple with a flag for first value."""
+    iter_values = iter(values)
+    try:
+        value = next(iter_values)
+    except StopIteration:
+        return
+    yield True, value
+    for value in iter_values:
+        yield False, value
+
+
+def loop_last(values: Iterable[T]) -> Iterable[tuple[bool, T]]:
+    """Iterate and generate a tuple with a flag for last value."""
+    iter_values = iter(values)
+    try:
+        previous_value = next(iter_values)
+    except StopIteration:
+        return
+    for value in iter_values:
+        yield False, previous_value
+        previous_value = value
+    yield True, previous_value
+
+
+def loop_first_last(values: Iterable[T]) -> Iterable[tuple[bool, bool, T]]:
+    """Iterate and generate a tuple with a flag for first and last value."""
+    iter_values = iter(values)
+    try:
+        previous_value = next(iter_values)
+    except StopIteration:
+        return
+    first = True
+    for value in iter_values:
+        yield first, False, previous_value
+        first = False
+        previous_value = value
+    yield first, True, previous_value
+
+
+def loop_from_index(
+    values: Sequence[T],
+    index: int,
+    direction: Literal[-1, +1] = +1,
+    wrap: bool = True,
+) -> Iterable[tuple[int, T]]:
+    """Iterate over values in a sequence from a given starting index, potentially wrapping the index
+    if it would go out of bounds.
+
+    Note that the first value to be yielded is a step from `index`, and `index` will be yielded *last*.
+
+
+    Args:
+        values: A sequence of values.
+        index: Starting index.
+        direction: Direction to move index (+1 for forward, -1 for backward).
+        bool: Should the index wrap when out of bounds?
+
+    Yields:
+        A tuple of index and value from the sequence.
+    """
+    # Sanity check for devs who miss the typing errors
+    assert direction in (-1, +1), "direction must be -1 or +1"
+    count = len(values)
+    if wrap:
+        for _ in range(count):
+            index = (index + direction) % count
+            yield (index, values[index])
+    else:
+        if direction == +1:
+            for _ in range(count):
+                if (index := index + 1) >= count:
+                    break
+                yield (index, values[index])
+        else:
+            for _ in range(count):
+                if (index := index - 1) < 0:
+                    break
+                yield (index, values[index])

toad/about.py

@@ -0,0 +1,90 @@
+import os
+from importlib.metadata import version
+import platform
+from string import Template
+
+from toad.app import ToadApp
+from toad import paths
+from toad import get_version
+
+ABOUT_TEMPLATE = Template(
+    """\
+# About Toad v${TOAD_VERSION}
+
+© Will McGugan.
+                          
+Toad is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/agpl-3.0.txt).
+
+
+## Config
+
+config read from `$SETTINGS_PATH`
+                                       
+```json
+$CONFIG                       
+```
+
+## Paths
+
+| Name | Path |
+| --- | --- |
+| App data | `$DATA_PATH` |
+| App logs | `$LOG_PATH` |
+                          
+## System
+
+| System | Version |
+| --- | --- |
+| Python | $PYTHON |
+| OS | $PLATFORM |
+
+## Dependencies
+
+| Library | Version |
+| --- | --- | 
+| Toad | $TOAD_VERSION |
+| Textual | $TEXTUAL_VERSION |
+| Rich | $RICH_VERSION |
+                          
+## Environment
+
+| Environment variable | Value |                
+| --- | --- |
+| `SHELL` | $SHELL |
+| `TERM` | $TERM |
+| `COLORTERM` | $COLORTERM |
+| `TERM_PROGRAM` | $TERM_PROGRAM |
+| `TERM_PROGRAM_VERSION` | $TERM_PROGRAM_VERSION |
+"""
+)
+
+
+def render(app: ToadApp) -> str:
+    """Render about markdown.
+
+    Returns:
+        Markdown string.
+    """
+
+    try:
+        config: str | None = app.settings_path.read_text()
+    except Exception:
+        config = None
+
+    template_data = {
+        "COLORTERM": os.environ.get("COLORTERM", ""),
+        "CONFIG": config,
+        "DATA_PATH": paths.get_data(),
+        "LOG_PATH": paths.get_log(),
+        "PLATFORM": platform.platform(),
+        "PYTHON": f"{platform.python_implementation()} {platform.python_version()}",
+        "RICH_VERSION": version("rich"),
+        "SETTINGS_PATH": str(app.settings_path),
+        "SHELL": os.environ.get("SHELL", ""),
+        "TERM_PROGRAM_VERSION": os.environ.get("TERM_PROGRAM_VERSION", ""),
+        "TERM_PROGRAM": os.environ.get("TERM_PROGRAM", ""),
+        "TERM": os.environ.get("TERM", ""),
+        "TEXTUAL_VERSION": version("textual"),
+        "TOAD_VERSION": get_version(),
+    }
+    return ABOUT_TEMPLATE.safe_substitute(template_data)