roundlet 0.2.4__py3-none-any.whl

roundlet/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+# SPDX-License-Identifier: BSD-2-Clause
+"""Random collection of helper libraries used by Ringlet software."""
+
+from __future__ import annotations
+
+from .defs import VERSION
+
+
+__all__ = [
+    "VERSION",
+]

roundlet/cli_basic.py

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+# SPDX-License-Identifier: BSD-2-Clause
+"""Helpers for parsing some very basic command-line options."""
+
+from __future__ import annotations
+
+import sys
+
+
+def handle_basic_options(
+    prog: str,
+    version: str,
+    features: list[tuple[str, str]],
+    help: str,  # ruff: ignore[builtin-argument-shadowing]
+) -> bool:
+    """Try to process some very basic command-line options.
+
+    If any of the `-h` / `--help`, `-V` / `--version`, or `--features`
+    command-line options are specified, display the requested information and
+    return true.
+
+    If any command-line options other than these are specified, return false.
+    """
+    version_flag = False
+    features_flag = False
+    help_flag = False
+    for arg in sys.argv[1:]:
+        match arg:
+            case "-h" | "--help":
+                help_flag = True
+
+            case "-V" | "--version":
+                version_flag = True
+
+            case "--features":
+                features_flag = True
+
+            case "--":
+                break
+
+            case _:
+                return False
+
+    if version_flag:
+        print(f"{prog} {version}")  # ruff: ignore[print]  # this is the whole point
+
+    if features_flag:
+        # ruff: ignore[print]  # this is the whole point
+        print(f"Features: {' '.join(f'{name}={value}' for name, value in features)}")
+
+    if help_flag:
+        print(help)  # ruff: ignore[print]  # this is the whole point
+
+    return version_flag or features_flag or help_flag

roundlet/defs.py

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+# SPDX-License-Identifier: BSD-2-Clause
+"""Common definitions for the roundlet utilities."""
+
+from __future__ import annotations
+
+import typing
+
+
+if typing.TYPE_CHECKING:
+    from typing import Final
+
+
+VERSION: Final = "0.2.4"
+"""The project version, semver-like."""

roundlet/env.py

@@ -0,0 +1,23 @@
+# SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+# SPDX-License-Identifier: BSD-2-Clause
+"""Helpers for running programs in UTF-8-compatible environments."""
+
+from __future__ import annotations
+
+import typing
+
+
+if typing.TYPE_CHECKING:
+    from typing import Final
+
+
+UTF8_VARS: Final = {
+    "LC_ALL": "C.UTF-8",
+    "LANGUAGE": "",
+}
+"""Environment settings for requesting a UTF-8 environment on most modern systems.
+
+There are still some systems out there that do not know about the POSIX C.UTF-8 locale.
+For them, the `utf8-locale` Python library would be a better choice.
+For most modern systems though, these settings will suffice.
+"""

roundlet/logging.py

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+# SPDX-License-Identifier: BSD-2-Clause
+"""Helper utilities for logging."""
+
+from __future__ import annotations
+
+import functools
+import logging
+import sys
+import typing
+
+
+if typing.TYPE_CHECKING:
+    from typing import Final
+
+
+@functools.lru_cache
+def build_logger(*, name: str, quiet: bool = False, verbose: bool = False) -> logging.Logger:
+    """Build a logger that outputs to the standard output and error streams.
+
+    Messages of level `WARNING` and higher go to the standard error stream.
+    If `quiet` is false, messages of level `INFO` also go to the standard error stream.
+    If `verbose` is true, messages of level `DEBUG` also go to the standard error stream.
+    """
+    logger: Final = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG if verbose else logging.WARNING if quiet else logging.INFO)
+    logger.propagate = False
+
+    diag_handler: Final = logging.StreamHandler(sys.stderr)
+    diag_handler.setLevel(logging.DEBUG if verbose else logging.WARNING)
+    if not quiet:
+        diag_handler.addFilter(lambda rec: rec.levelno != logging.INFO)
+    logger.addHandler(diag_handler)
+
+    if not quiet:
+        info_handler: Final = logging.StreamHandler(sys.stderr)
+        info_handler.setLevel(logging.INFO)
+        info_handler.addFilter(lambda rec: rec.levelno == logging.INFO)
+        logger.addHandler(info_handler)
+
+    return logger

roundlet-0.2.4.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.5
+Name: roundlet
+Version: 0.2.4
+Summary: Random collection of helper libraries used by Ringlet software
+License-Expression: BSD-2-Clause
+License-File: LICENSES/BSD-2-Clause.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3.16
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
+SPDX-License-Identifier: BSD-2-Clause
+-->
+
+# roundlet - a random collection of helper libraries used by Ringlet software
+
+\[[Home][ringlet-home] | [sourcehut][sourcehut] | [crates.io][crates-io] | [ReadTheDocs][readthedocs]\]
+
+## Overview
+
+A couple of helper functions for Rust programs developed at Ringlet.
+
+## Contact
+
+The `roundlet` library was written by [Peter Pentchev][roam].
+It is developed in [a Sourcehut repository][sourcehut]. This documentation is
+hosted at [Ringlet][ringlet-home] with a copy at [ReadTheDocs][readthedocs].
+
+[roam]: mailto:roam@ringlet.net "Peter Pentchev"
+[sourcehut]: https://git.sr.ht/~ppentchev/roundlet "The roundlet Sourcehut repository"
+[crates-io]: https://crates.io/crates/roundlet "The roundlet crate on crates.io"
+[readthedocs]: https://roundlet.readthedocs.io/ "The roundlet ReadTheDocs page"
+[ringlet-home]: https://devel.ringlet.net/devel/roundlet/ "The Ringlet roundlet homepage"

roundlet-0.2.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+roundlet/__init__.py,sha256=ra8j-slrQUeV_2SmIEmi2PT7MoYGp5PgCjI7HQVxSng,264
+roundlet/cli_basic.py,sha256=lC-DmMkWJOquMLq_Kj9dFunvStWYBrzh6f5cn9l7mY8,1538
+roundlet/defs.py,sha256=YwAgjA_HStM7-1uwVUA0DFWfTHs-MzubLiAJQjyWVxM,327
+roundlet/env.py,sha256=140ZpPqXzAi1_QABhwQqHyiUUsHnyT9eZd1dkUfuakw,652
+roundlet/logging.py,sha256=8nJDTfQ-teLA3shsseRyRQyNystn1D0QIkVLLyw-xN4,1428
+roundlet/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roundlet-0.2.4.dist-info/METADATA,sha256=UiSiFsS-GUgiQRC7_vgNiU99tqQNoIpeCwaVt016zo0,1995
+roundlet-0.2.4.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+roundlet-0.2.4.dist-info/licenses/LICENSES/BSD-2-Clause.txt,sha256=8y-ztBehlBZ8-tBoIj_JdbqWxZYFE6EPZqPChyCuwd8,1267
+roundlet-0.2.4.dist-info/RECORD,,

roundlet-0.2.4.dist-info/WHEEL

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

roundlet-0.2.4.dist-info/licenses/LICENSES/BSD-2-Clause.txt

@@ -0,0 +1,9 @@
+Copyright (c) <year> <owner> 
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.