objsize

0.8.0 · active · verified Thu Apr 09

The objsize Python package provides functionality for traversing an object's subtree and calculating its total memory consumption in bytes (deep size). It leverages Python's internal Garbage Collection (GC) implementation, designed to ignore commonly shared objects like singletons and type objects for more accurate deep sizing. It's currently in version 0.8.0 and generally has infrequent releases.

Warnings

gotcha By design, `objsize` attempts to ignore singletons (e.g., `None`) and type objects (classes, modules, functions, lambdas) when calculating deep size. This means they won't contribute to the reported size of the object's subtree, as they are considered shared.
Fix: If you need to include sizes for specific shared objects or functions, you might need to implement a custom filter function (e.g., by modifying or replacing `objsize.traverse.shared_object_or_function_filter()`).
gotcha Unlike some alternatives (e.g., Pympler), `objsize` uses a Breadth-First Search (BFS) approach internally to traverse object subtrees, avoiding recursive calls. This prevents hitting Python's default recursion depth limits, but users migrating from recursive deep-sizing tools should be aware of this architectural difference.
Fix: No fix needed; this is a design feature of `objsize` that enhances robustness. Simply be aware of the underlying traversal mechanism.
gotcha For 'special objects' or objects with non-standard memory management (e.g., `weakref.proxy` or objects managing off-heap memory), `objsize`'s default calculation might not fully capture their size. You may need to provide custom handlers.
Fix: For such cases, the library allows users to supply custom methods for size calculation, referent identification, or object filtering to ensure accurate deep size measurement. Consult the library's documentation for details on custom handlers.

Install

pip install objsize Install latest version

Imports

get_deep_size
```
from objsize import get_deep_size
```
The primary function is `get_deep_size`.

Quickstart

Demonstrates how to calculate the deep size of a single object or multiple objects using `objsize.get_deep_size()`.

import objsize

my_data = {'name': 'Alice', 'age': 30, 'hobbies': ['reading', 'coding']}
deep_size_bytes = objsize.get_deep_size(my_data)

print(f"The deep size of my_data is: {deep_size_bytes} bytes")

another_obj = ['hello', 'world']
total_deep_size = objsize.get_deep_size(my_data, another_obj)
print(f"The deep size of multiple objects is: {total_deep_size} bytes")

view raw JSON →