Python Object Inspector Tool

A command-line utility that provides detailed inspection capabilities for Python objects, including functions, classes, and modules.

Capabilities

Object Information Retrieval

• Given a Python function object, retrieve and display its name, docstring, and signature @test
• Given a Python class object, retrieve and display its name, docstring, and list of methods @test
• Given a built-in type (e.g., list, dict), retrieve and display its docstring and available methods @test

Source Code Extraction

• Given a user-defined function, extract and return its source code as a string @test
• Given a user-defined class, extract and return its source code as a string @test
• Handle built-in objects gracefully when source code is not available, returning an appropriate message @test

Implementation

@generates

API

def inspect_object(obj):
    """
    Inspects a Python object and returns detailed information about it.

    Args:
        obj: Any Python object (function, class, module, built-in, etc.)

    Returns:
        dict: A dictionary containing:
            - 'name': The name of the object
            - 'type': The type of the object as a string
            - 'docstring': The object's docstring (if available)
            - 'signature': Function/method signature (if applicable)
            - 'methods': List of method names (for classes)
    """
    pass

def get_source_code(obj):
    """
    Retrieves the source code for a Python object.

    Args:
        obj: A Python object (function, class, or method)

    Returns:
        str: The source code as a string, or an error message if unavailable
    """
    pass

Dependencies { .dependencies }

IPython { .dependency }

Provides advanced object introspection capabilities for Python objects.

@satisfied-by