refcycle

|docs| |commits-since|

The refcycle package provides support for creating, analysing, and visualising graphs of Python objects and the references between them. It's intended to aid in debugging reference-related problems, for example:

• Figuring out why an object is still alive after it should have been deleted.
• Detecting reference cycles that may be preventing objects from being collected by the regular reference-count-based garbage collection.
• Finding out why garbage collection is putting objects into gc.garbage.

Features

• An ObjectGraph_ class representing a collection of objects and references.
• Computation of strongly connected components_ of the object graph.
• Ability to export to JSON and reimport later for offline analysis.
• Export of images via Graphviz_.

Prerequisites

• Requires Python 3.7 or later.

• The export_image_ method for exporting a graph in image form requires Graphviz_ to be installed.

• Refcycle is CPython only.

Documentation

Up-to-date documentation can be found on "Read the Docs", at http://refcycle.readthedocs.org/en/latest/index.html.

Installing refcycle

The latest release of refcycle is available from the Python Package Index, at https://pypi.python.org/pypi/refcycle. On most systems, it can be installed in the usual way using pip::

python -m pip install refcycle

The currently-in-development version can be obtained from the project's GitHub homepage: https://github.com/mdickinson/refcycle.

License

The refcycle package is copyright (c) 2013-2023 Mark Dickinson.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

.. _Graphviz: http://www.graphviz.org .. _ObjectGraph: http://refcycle.readthedocs.org/en/latest/reference/object_graph.html#refcycle.object_graph.ObjectGraph .. _export_image: http://refcycle.readthedocs.org/en/latest/reference/object_graph.html#refcycle.object_graph.ObjectGraph.export_image .. _strongly connected components: http://en.wikipedia.org/wiki/Strongly_connected_component

.. |docs| image:: https://readthedocs.org/projects/refcycle/badge/?version=latest :target: http://refcycle.readthedocs.org/en/latest :alt: Documentation build status .. |commits-since| image:: https://img.shields.io/github/commits-since/mdickinson/refcycle/latest.svg :target: https://github.com/mdickinson/refcycle :alt: GitHub status