griffelib

import os from griffe.loader import GriffeLoader from griffe.dataclasses import Module, Class, Function from pathlib import Path # Create a dummy Python module for demonstration dummy_module_code = """ def my_function(param1: str, param2: int) -> bool: """A sample function.""" return len(param1) == param2 class MyClass: """A sample class.""" def __init__(self, name: str): self.name = name def get_name(self) -> str: """Returns the name.""" return self.name """ # Create a temporary directory and file for the dummy module # In a real scenario, you would load an existing module tmp_dir = Path("./_griffelib_temp_module") tmp_dir.mkdir(exist_ok=True) dummy_file = tmp_dir / "dummy_example.py" dummy_file.write_text(dummy_module_code) # Initialize the Griffe loader and load the module loader = GriffeLoader() loaded_module: Module = loader.load_module("dummy_example", search_paths=[tmp_dir]) print(f"Module name: {loaded_module.name}") # Iterate through members (functions, classes) for member in loaded_module.members.values(): if isinstance(member, Function): print(f" Function: {member.name}") print(f" Signature: {member.signature}") print(f" Docstring: {member.docstring.value if member.docstring else 'N/A'}") elif isinstance(member, Class): print(f" Class: {member.name}") print(f" Docstring: {member.docstring.value if member.docstring else 'N/A'}") for method in member.members.values(): if isinstance(method, Function): print(f" Method: {method.name}") print(f" Signature: {method.signature}") # Clean up temporary directory (optional) import shutil shutil.rmtree(tmp_dir)