Skip to main content

python-introspect

Extensible analysis of callable signatures, dataclass fields, type hints, and docstrings, plus signature-derived callable declaration projection.

Python 3.10+ PyPI version

Quick start

from python_introspect import SignatureAnalyzer

def resize(image, factor: float = 0.5, *, preserve_range: bool = True):
    """Resize an image.

    Args:
        image: Input image.
        factor: Scale factor.
        preserve_range: Preserve the input intensity range.
    """

parameters = SignatureAnalyzer().analyze(resize)

for name, info in parameters.items():
    print(name, info.param_type, info.default_value, info.is_required)

analyze is the unified entry point for functions, methods, classes, dataclass types, and instances. It returns a mapping of names to ParameterInfo records.

Use callable_declaration_kwargs when declaration identity should omit keyword arguments equal to their signature defaults. The caller supplies value equality so array, lazy, or other framework-specific values keep their owning semantics.

Extension points

Use register_namespace_provider to contribute names used while resolving forward references and register_type_resolver to unwrap application proxy types. Wrappers can declare their user-facing inspection target through the signature-target helpers in python_introspect.signature_analyzer.

Installation

python -m pip install python-introspect

The runtime depends on metaclass-registry. Repository and issues: OpenHCSDev/python-introspect.

Documentation

The maintained sources are in docs/source. Documentation changes are checked by the repository's documentation workflow; the local warnings-as-errors build command is documented in development.rst.

Parameter declarations in 0.2

UnifiedParameterAnalyzer now returns the original ParameterInfo declarations from SignatureAnalyzer. UnifiedParameterInfo, its source_type tag, and analyze_nested were removed. Use analyze and the declared param_type for parameter topology.

ParameterInfo retains its five public fields, constructor and _replace operation, and is now a frozen declaration rather than a tuple. Tuple unpacking and NamedTuple helpers are no longer supported. Dataclass descriptions are derived on first help access; value/default overlays preserve that deferred source, and renaming preserves the original field's help. Callable descriptions still participate eagerly in inferred parameter types. A presentation extraction error yields absent help without discarding valid types/defaults. Factory errors remain uncached and retryable.

Metadata

Release files for python-introspect 0.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-introspect 0.2.8
File Size Uploaded
python_introspect-0.2.8.tar.gz 58.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for python-introspect 0.2.8
File Interpreter ABI Platform
python_introspect-0.2.8-py3-none-any.whl Python 3 none any Details

Total release size: 102.9 kB

Release files / python_introspect-0.2.8.tar.gz

Download URL python_introspect-0.2.8.tar.gz
Size 58.5 kB
Tags Source
SHA-256 checksum
How to use checksums
35ee71364dfaf897f4f577a8b526dc1e38afcbc2db0e33180b18bb7de09de51a
BLAKE2b-256 checksum
How to use checksums
bdaf3e444a47e58de1cf4f1e5767b62ddbad55b69fd207960facde8566c9aa48
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / python_introspect-0.2.8-py3-none-any.whl

Download URL python_introspect-0.2.8-py3-none-any.whl
Size 44.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4e8ef0c50dd0dad8f300f68836cef4ecba4ffcc74a4b9d2d2624eebe03b167e4
BLAKE2b-256 checksum
How to use checksums
224c15f356c798be43f7b5f134ad67d56d4208b8fff2762938265d28b082307e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release history Release notifications | RSS feed

0.3.0

2 release files

This release

0.2.8 This release

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page