Introspection in Python

Introspection in Python refers to the ability of a program to examine the type or properties of an object at runtime. It is a powerful feature of Python, leveraging its dynamic nature.

Key Features of Introspection

Type checking

• You can check the type of an object using the type() or isinstance() functions.
• Example:
  python Wrap Copy

  x = 42
  print(type(x))  # Output: <class 'int'>
  print(isinstance(x, int))  # Output: True

Attributes and methods

• Use the dir() function to list all attributes and methods of an object.
• Example:
  python Wrap Copy

  print(dir(str))  # Lists all methods and attributes of the string class

Documentation

• Access an object’s documentation string using the help() function or .__doc__ attribute.
• Example:
  python Wrap Copy

  print(help(len))  # Displays documentation for the `len` function
  print(str.__doc__)  # Displays the docstring of the string class

Base classes

• Use the __bases__ attribute to find the base classes of a class.
• Example:
  python Wrap Copy

  class MyClass:
      pass
  
  # Output: (<class 'object'>,)
  print(MyClass.__bases__)

Module contents

• Use dir() on a module to list its contents.
• Example:
  python Wrap Copy

  import math
  print(dir(math))  # Lists all functions and constants in the math module

Reading attributes dynamically

• Use getattr(), setattr(), and hasattr() to dynamically interact with attributes of an object.
• Example:
  python Wrap Copy

  class MyClass:
      x = 10
  
  obj = MyClass()
  print(getattr(obj, 'x'))  # Output: 10
  setattr(obj, 'y', 20)
  print(hasattr(obj, 'y'))  # Output: True

Why Introspection is Useful

• Debugging: Easily inspect objects to understand their properties and methods.
• Dynamic Programming: Create adaptable and flexible programs that can handle unknown types at runtime.
• Reflection: Perform operations like dynamically calling methods or inspecting classes.

Example: Introspection in Action

class Animal:
    def speak(self):
        return "I am an animal"

obj = Animal()

# Introspection example
print(type(obj))  # Output: <class '__main__.Animal'>
print(dir(obj))  # Lists all attributes and methods of the object
print(obj.speak())  # Output: I am an animal

Introspection allows Python programs to be highly dynamic and flexible by enabling runtime examination of objects. It is a cornerstone of Python’s dynamic typing and reflective capabilities.

# Example 1: Type Checking
x = 42
print(type(x))  # Output: <class 'int'>
print(isinstance(x, int))  # Output: True

# Example 2: Inspecting Attributes and Methods
# Lists all methods and attributes of the string class
print(dir(str))

# Example 3: Getting Documentation
print(help(len))  # Displays documentation for the `len` function
print(str.__doc__)  # Displays the docstring of the string class

# Example 4: Determining Base Classes
class MyClass:
    pass

print(MyClass.__bases__)  # Output: (<class 'object'>,)

# Example 5: Inspecting Module Contents
import math
# Lists all functions and constants in the math module
print(dir(math))

# Example 6: Accessing Object Attributes
class MyClass:
    x = 10

obj = MyClass()
print(getattr(obj, 'x'))  # Output: 10
setattr(obj, 'y', 20)
print(hasattr(obj, 'y'))  # Output: True
print(obj.y)  # Output: 20

# Example 7: Introspection in Action
class Animal:
    def speak(self):
        return "I am an animal"

obj = Animal()

# Introspection example
print(type(obj))  # Output: <class '__main__.Animal'>
print(dir(obj))  # Lists all attributes and methods of the object
print(obj.speak())  # Output: I am an animal