griffe-runtime-objects 0.1.0__py3-none-any.whl

griffe_runtime_objects/__init__.py

@@ -0,0 +1,8 @@
+"""griffe-runtime-objects package.
+
+Make runtime objects available through `extra`.
+"""
+
+from __future__ import annotations
+
+__all__: list[str] = []

griffe_runtime_objects/debug.py

@@ -0,0 +1,109 @@
+"""Debugging utilities."""
+
+from __future__ import annotations
+
+import os
+import platform
+import sys
+from dataclasses import dataclass
+from importlib import metadata
+
+
+@dataclass
+class Variable:
+    """Dataclass describing an environment variable."""
+
+    name: str
+    """Variable name."""
+    value: str
+    """Variable value."""
+
+
+@dataclass
+class Package:
+    """Dataclass describing a Python package."""
+
+    name: str
+    """Package name."""
+    version: str
+    """Package version."""
+
+
+@dataclass
+class Environment:
+    """Dataclass to store environment information."""
+
+    interpreter_name: str
+    """Python interpreter name."""
+    interpreter_version: str
+    """Python interpreter version."""
+    interpreter_path: str
+    """Path to Python executable."""
+    platform: str
+    """Operating System."""
+    packages: list[Package]
+    """Installed packages."""
+    variables: list[Variable]
+    """Environment variables."""
+
+
+def _interpreter_name_version() -> tuple[str, str]:
+    if hasattr(sys, "implementation"):
+        impl = sys.implementation.version
+        version = f"{impl.major}.{impl.minor}.{impl.micro}"
+        kind = impl.releaselevel
+        if kind != "final":
+            version += kind[0] + str(impl.serial)
+        return sys.implementation.name, version
+    return "", "0.0.0"
+
+
+def get_version(dist: str = "griffe-runtime-objects") -> str:
+    """Get version of the given distribution.
+
+    Parameters:
+        dist: A distribution name.
+
+    Returns:
+        A version number.
+    """
+    try:
+        return metadata.version(dist)
+    except metadata.PackageNotFoundError:
+        return "0.0.0"
+
+
+def get_debug_info() -> Environment:
+    """Get debug/environment information.
+
+    Returns:
+        Environment information.
+    """
+    py_name, py_version = _interpreter_name_version()
+    packages = ["griffe-runtime-objects"]
+    variables = ["PYTHONPATH", *[var for var in os.environ if var.startswith("GRIFFE_RUNTIME_OBJECTS")]]
+    return Environment(
+        interpreter_name=py_name,
+        interpreter_version=py_version,
+        interpreter_path=sys.executable,
+        platform=platform.platform(),
+        variables=[Variable(var, val) for var in variables if (val := os.getenv(var))],
+        packages=[Package(pkg, get_version(pkg)) for pkg in packages],
+    )
+
+
+def print_debug_info() -> None:
+    """Print debug/environment information."""
+    info = get_debug_info()
+    print(f"- __System__: {info.platform}")
+    print(f"- __Python__: {info.interpreter_name} {info.interpreter_version} ({info.interpreter_path})")
+    print("- __Environment variables__:")
+    for var in info.variables:
+        print(f"  - `{var.name}`: `{var.value}`")
+    print("- __Installed packages__:")
+    for pkg in info.packages:
+        print(f"  - `{pkg.name}` v{pkg.version}")
+
+
+if __name__ == "__main__":
+    print_debug_info()

griffe_runtime_objects-0.1.0.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: griffe-runtime-objects
+Version: 0.1.0
+Summary: Make runtime objects available through `extra`.
+Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+License: ISC
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://mkdocstrings.github.io/griffe-runtime-objects
+Project-URL: Documentation, https://mkdocstrings.github.io/griffe-runtime-objects
+Project-URL: Changelog, https://mkdocstrings.github.io/griffe-runtime-objects/changelog
+Project-URL: Repository, https://github.com/mkdocstrings/griffe-runtime-objects
+Project-URL: Issues, https://github.com/mkdocstrings/griffe-runtime-objects/issues
+Project-URL: Discussions, https://github.com/mkdocstrings/griffe-runtime-objects/discussions
+Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-runtime-objects
+Project-URL: Funding, https://github.com/sponsors/pawamoy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# griffe-runtime-objects
+
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-runtime-objects/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-runtime-objects)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-runtime-objects:gitter.im)
+
+Make runtime objects available through `extra`.
+
+## Installation
+
+This project is available to sponsors only, through my Insiders program.
+See Insiders [explanation](https://mkdocstrings.github.io/griffe-runtime-objects/insiders/)
+and [installation instructions](https://mkdocstrings.github.io/griffe-runtime-objects/insiders/installation/).

griffe_runtime_objects-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+griffe_runtime_objects-0.1.0.dist-info/METADATA,sha256=GxdqemEdH5n4FYpmyS7JPKp_zSxaw-9p91t52U-YgvY,2362
+griffe_runtime_objects-0.1.0.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
+griffe_runtime_objects-0.1.0.dist-info/licenses/LICENSE,sha256=nke00CVElTmhjAOYXkupvTNauLNPzBTuASi3u9moZ1U,754
+griffe_runtime_objects/__init__.py,sha256=iM8__IJyBOi2qxAEh9zaw8aFv__r4kipirHz2cDvQ2Q,149
+griffe_runtime_objects/debug.py,sha256=4PLLW0mdNSvZs5fbVCcY68-k2dxJgNvtDqDJ5zhJtGQ,2867
+griffe_runtime_objects/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+griffe_runtime_objects-0.1.0.dist-info/RECORD,,

griffe_runtime_objects-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.3.3)
+Root-Is-Purelib: true
+Tag: py3-none-any

griffe_runtime_objects-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024, Timothée Mazzucotelli
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.