Skip to main content

Find and visualise reference cycles between Python objects

Project description

Documentation build status GitHub status

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

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-hypernode.com/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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

refcycle-0.3.1.tar.gz (121.8 kB view details)

Uploaded Source

Built Distribution

refcycle-0.3.1-py3-none-any.whl (44.0 kB view details)

Uploaded Python 3

File details

Details for the file refcycle-0.3.1.tar.gz.

File metadata

  • Download URL: refcycle-0.3.1.tar.gz
  • Upload date:
  • Size: 121.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for refcycle-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3c601aade586dcdbbc8b1283385d3f9dba80fe90187efc9f7c85e7c1961efd3d
MD5 293317e768e940a916a6425217df353a
BLAKE2b-256 9df9e5adbb15b4e6e955b0aabeda392d63f6e9637adfecccb57476303fbc6b93

See more details on using hashes here.

File details

Details for the file refcycle-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: refcycle-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 44.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for refcycle-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c838c0b66a80ba0fe24efcb7576e24d428f8953b671a30f15f27346336e7116
MD5 3248fb63283f89c7cde7e2bcc8ef29cc
BLAKE2b-256 d782ee9c9727f163eb45688b8116babf5410af8ebd7110b95c24e2de4d8ace8d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page