python-introspect 0.1.0__tar.gz

python_introspect-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tristan Simas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_introspect-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: python-introspect
+Version: 0.1.0
+Summary: Pure Python introspection toolkit for function signatures, dataclasses, and type hints
+Author-email: Tristan Simas <tristan.simas@mail.mcgill.ca>
+License: MIT
+Project-URL: Homepage, https://github.com/OpenHCSDev/python-introspect
+Project-URL: Repository, https://github.com/OpenHCSDev/python-introspect
+Project-URL: Issues, https://github.com/OpenHCSDev/python-introspect/issues
+Keywords: introspection,reflection,signature,dataclass,type-hints,docstring
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Dynamic: license-file
+
+# python-introspect
+
+**Pure Python introspection toolkit for function signatures, dataclasses, and type hints**
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/trissim/python-introspect/actions/workflows/ci.yml/badge.svg)](https://github.com/trissim/python-introspect/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/python-introspect.svg)](https://badge.fury.io/py/python-introspect)
+
+## Features
+
+- 🔍 **Function/Method Signature Analysis** - Extract parameter info from any callable
+- 📦 **Dataclass Field Extraction** - Analyze dataclass fields and types
+- 📝 **Docstring Parsing** - Extract and parse docstrings (Google, NumPy, Sphinx styles)
+- 🏷️ **Type Hint Resolution** - Resolve complex type hints and annotations
+- 🎯 **Unified API** - Single interface for all parameter sources
+- 🚀 **Pure Python** - No external dependencies, pure stdlib
+
+## Installation
+
+```bash
+pip install python-introspect
+```
+
+## Quick Start
+
+```python
+from python_introspect import SignatureAnalyzer
+
+def example_function(name: str, age: int = 25, *, active: bool = True):
+    """
+    Example function with parameters.
+    
+    Args:
+        name: The person's name
+        age: The person's age
+        active: Whether the person is active
+    """
+    pass
+
+# Analyze the function
+analyzer = SignatureAnalyzer()
+params = analyzer.analyze_function(example_function)
+
+for param in params:
+    print(f"{param.name}: {param.annotation} = {param.default}")
+```
+
+## Use Cases
+
+- **Form Generation** - Generate UI forms from function signatures
+- **API Documentation** - Auto-generate API docs from code
+- **Configuration Validation** - Validate config against function parameters
+- **Dynamic UI** - Build dynamic UIs based on function signatures
+- **Parameter Analysis** - Analyze and validate function parameters
+
+## Documentation
+
+Full documentation available at: https://github.com/trissim/python-introspect
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/trissim/python-introspect.git
+cd python-introspect
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode with dev dependencies
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest tests/
+
+# Run with coverage
+pytest tests/ --cov=python_introspect --cov-report=term --cov-report=html
+
+# Run linting and formatting checks
+ruff check src/ tests/
+black --check src/ tests/
+mypy src/python_introspect/
+```
+
+## Contributing
+
+Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Credits
+
+Developed by Tristan Simas as part of the OpenHCS project.

python_introspect-0.1.0/README.md

@@ -0,0 +1,99 @@
+# python-introspect
+
+**Pure Python introspection toolkit for function signatures, dataclasses, and type hints**
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/trissim/python-introspect/actions/workflows/ci.yml/badge.svg)](https://github.com/trissim/python-introspect/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/python-introspect.svg)](https://badge.fury.io/py/python-introspect)
+
+## Features
+
+- 🔍 **Function/Method Signature Analysis** - Extract parameter info from any callable
+- 📦 **Dataclass Field Extraction** - Analyze dataclass fields and types
+- 📝 **Docstring Parsing** - Extract and parse docstrings (Google, NumPy, Sphinx styles)
+- 🏷️ **Type Hint Resolution** - Resolve complex type hints and annotations
+- 🎯 **Unified API** - Single interface for all parameter sources
+- 🚀 **Pure Python** - No external dependencies, pure stdlib
+
+## Installation
+
+```bash
+pip install python-introspect
+```
+
+## Quick Start
+
+```python
+from python_introspect import SignatureAnalyzer
+
+def example_function(name: str, age: int = 25, *, active: bool = True):
+    """
+    Example function with parameters.
+    
+    Args:
+        name: The person's name
+        age: The person's age
+        active: Whether the person is active
+    """
+    pass
+
+# Analyze the function
+analyzer = SignatureAnalyzer()
+params = analyzer.analyze_function(example_function)
+
+for param in params:
+    print(f"{param.name}: {param.annotation} = {param.default}")
+```
+
+## Use Cases
+
+- **Form Generation** - Generate UI forms from function signatures
+- **API Documentation** - Auto-generate API docs from code
+- **Configuration Validation** - Validate config against function parameters
+- **Dynamic UI** - Build dynamic UIs based on function signatures
+- **Parameter Analysis** - Analyze and validate function parameters
+
+## Documentation
+
+Full documentation available at: https://github.com/trissim/python-introspect
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/trissim/python-introspect.git
+cd python-introspect
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode with dev dependencies
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest tests/
+
+# Run with coverage
+pytest tests/ --cov=python_introspect --cov-report=term --cov-report=html
+
+# Run linting and formatting checks
+ruff check src/ tests/
+black --check src/ tests/
+mypy src/python_introspect/
+```
+
+## Contributing
+
+Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Credits
+
+Developed by Tristan Simas as part of the OpenHCS project.

python_introspect-0.1.0/pyproject.toml

@@ -0,0 +1,70 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python-introspect"
+version = "0.1.0"
+description = "Pure Python introspection toolkit for function signatures, dataclasses, and type hints"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Tristan Simas", email = "tristan.simas@mail.mcgill.ca"}
+]
+keywords = ["introspection", "reflection", "signature", "dataclass", "type-hints", "docstring"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+    "black>=23.0",
+    "mypy>=1.0",
+]
+docs = [
+    "mkdocs>=1.5.0",
+    "mkdocs-material>=9.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/OpenHCSDev/python-introspect"
+Repository = "https://github.com/OpenHCSDev/python-introspect"
+Issues = "https://github.com/OpenHCSDev/python-introspect/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.black]
+line-length = 100
+target-version = ["py39"]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true

python_introspect-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

python_introspect-0.1.0/src/python_introspect/__init__.py

@@ -0,0 +1,48 @@
+"""
+python-introspect: Pure Python introspection toolkit
+
+This package provides utilities for introspecting Python functions, methods,
+dataclasses, and type hints.
+"""
+
+__version__ = "0.1.2"
+
+from .signature_analyzer import (
+    SignatureAnalyzer,
+    ParameterInfo,
+    DocstringInfo,
+    DocstringExtractor,
+    register_namespace_provider,
+    register_type_resolver,
+)
+from .unified_parameter_analyzer import (
+    UnifiedParameterAnalyzer,
+    UnifiedParameterInfo,
+)
+from .exceptions import (
+    IntrospectionError,
+    SignatureAnalysisError,
+    DocstringParsingError,
+    TypeResolutionError,
+)
+
+__all__ = [
+    # Version
+    "__version__",
+    # Signature analysis
+    "SignatureAnalyzer",
+    "ParameterInfo",
+    "DocstringInfo",
+    "DocstringExtractor",
+    # Unified analysis
+    "UnifiedParameterAnalyzer",
+    "UnifiedParameterInfo",
+    # Plugin system
+    "register_namespace_provider",
+    "register_type_resolver",
+    # Exceptions
+    "IntrospectionError",
+    "SignatureAnalysisError",
+    "DocstringParsingError",
+    "TypeResolutionError",
+]

python_introspect-0.1.0/src/python_introspect/exceptions.py

@@ -0,0 +1,21 @@
+"""Exceptions for python-introspect."""
+
+
+class IntrospectionError(Exception):
+    """Base exception for introspection errors."""
+    pass
+
+
+class SignatureAnalysisError(IntrospectionError):
+    """Exception raised when signature analysis fails."""
+    pass
+
+
+class DocstringParsingError(IntrospectionError):
+    """Exception raised when docstring parsing fails."""
+    pass
+
+
+class TypeResolutionError(IntrospectionError):
+    """Exception raised when type resolution fails."""
+    pass