Is there a built-in function to print all the current properties and values of an object?

python

introspection

object-inspection

python-module

byNikita Barsukov·Oct 17, 2024

Secondary school intro to inspecting your object's attributes and values: bring vars() or __dict__ to the field. These provide the attribute dictionary olympics.

print(vars(your_object))  # Pass the baton to your_object instance

Appealing to the higher classes that don't have __dict__? Swing around dir(your_object), and filter the essence with getattr().

attributes = {attr: getattr(your_object, attr) for attr in dir(your_object) if not attr.startswith('__')}
print(attributes)  # Don't forget to share your spoils!

These snippets are turbo-charged and immediately deployable: they encapsulate the core inspection methods for object attributes.

Introspection toolset

Get that inspector badge!

Looking into depths of an object? Python hands you inspect module like a courage badge. Dial specific numbers to talk to callable methods, functions, classes, and their members.

import inspect
print(inspect.getmembers(your_object))  # Dialing directory

While vars() recognize attributes in __dict__, inspect.getmembers() talks to non-dictionary properties as well.

Your secrets are safe...

Sensitive data in properties? Like any respectful inspector, shield them when needed. Define a custom function to exclude private attributes and filter for certain member types:

def safe_inspect(object, exclude_private=True, include_type=None):
   attributes = inspect.getmembers(object)
   if exclude_private:
       attributes = [a for a in attributes if not a[0].startswith('_')]  # Respect the private space
   if include_type:
       attributes = [a for a in attributes if isinstance(a[1], include_type)]  # Fan of specific types only
   return attributes

print(safe_inspect(your_object, include_type=property))  # Careful inspection

Do Not Touch - Delicate

Using __dict__ directly, or inspecting without thinking, might poke the object wrongly. Always clone or serialize the attributes for inspection and avoid turning on the alarm.

import copy
object_dict = copy.deepcopy(vars(your_object))  # Clone it, don't own it

In-depth inspection guide

Your toolbox essentials

Distinguish between dunder tools like __repr__ and __str__ while showcasing object properties. Utilize __slots__ for a space-saving object property party.

The matter of speed

Object inspection can be a heavy-duty task. Refine the scope of inspection and cache those sprinters if your application can't catch breath because of repeated inspections.

Customizing the magnifier

Your tailored custom inspection can light up unique insights about objects. Especially when a consistent output format is your target.

def custom_inspect(object):
    return {key: repr(value) for key, value in vars(object).items()}  # Styled for you

print(custom_inspect(your_object))  # All yours!