Skip to content

mkdocstrings_handlers.python special ¤

This package implements a handler for the Python language.

Modules¤

debug ¤

Debugging utilities.

Classes¤

Environment dataclass ¤

Dataclass to store environment information.

Source code in python/debug.py 
@dataclass
class Environment:
    """Dataclass to store environment information."""

    interpreter_name: str
    """Python interpreter name."""
    interpreter_version: str
    """Python interpreter version."""
    platform: str
    """Operating System."""
    packages: list[Package]
    """Installed packages."""
    variables: list[Variable]
    """Environment variables."""
Attributes¤
interpreter_name: str dataclass-field ¤

Python interpreter name.

interpreter_version: str dataclass-field ¤

Python interpreter version.

packages: list[mkdocstrings_handlers.python.debug.Package] dataclass-field ¤

Installed packages.

platform: str dataclass-field ¤

Operating System.

variables: list[mkdocstrings_handlers.python.debug.Variable] dataclass-field ¤

Environment variables.

Package dataclass ¤

Dataclass describing a Python package.

Source code in python/debug.py 
@dataclass
class Package:
    """Dataclass describing a Python package."""

    name: str
    """Package name."""
    version: str
    """Package version."""
Attributes¤
name: str dataclass-field ¤

Package name.

version: str dataclass-field ¤

Package version.

Variable dataclass ¤

Dataclass describing an environment variable.

Source code in python/debug.py