File: PKG-INFO

package info (click to toggle)
objgraph 3.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 1,092 kB
  • sloc: python: 1,208; makefile: 102; sh: 9
file content (429 lines) | stat: -rw-r--r-- 15,101 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
Metadata-Version: 1.1
Name: objgraph
Version: 3.5.0
Summary: Draws Python object reference graphs with graphviz
Home-page: https://mg.pov.lt/objgraph/
Author: Marius Gedminas
Author-email: marius@gedmin.as
License: MIT
Description: Python Object Graphs
        ====================
        
        .. image:: https://travis-ci.org/mgedmin/objgraph.svg?branch=master
           :target: https://travis-ci.org/mgedmin/objgraph
           :alt: Build Status
        
        .. image:: https://ci.appveyor.com/api/projects/status/github/mgedmin/objgraph?branch=master&svg=true
           :target: https://ci.appveyor.com/project/mgedmin/objgraph
           :alt: Build Status (Windows)
        
        .. image:: https://coveralls.io/repos/mgedmin/objgraph/badge.svg?branch=master
           :target: https://coveralls.io/r/mgedmin/objgraph?branch=master
           :alt: Test Coverage
        
        .. image:: https://readthedocs.org/projects/objgraph/badge/?version=latest
           :target: https://readthedocs.org/projects/objgraph/?badge=latest
           :alt: Documentation Status
        
        
        ``objgraph`` is a module that lets you visually explore Python object graphs.
        
        You'll need `graphviz <https://www.graphviz.org/>`_ if you want to draw
        the pretty graphs.
        
        I recommend `xdot <https://pypi.python.org/pypi/xdot>`_ for interactive use.
        ``pip install xdot`` should suffice; objgraph will automatically look for it
        in your ``PATH``.
        
        
        Installation and Documentation
        ------------------------------
        
        ``pip install objgraph`` or `download it from PyPI
        <https://pypi.python.org/pypi/objgraph>`_.
        
        Documentation lives at https://mg.pov.lt/objgraph.
        
        
        .. _history:
        
        History
        -------
        
        I've developed a set of functions that eventually became objgraph when I
        was hunting for memory leaks in a Python program.  The whole story -- with
        illustrated examples -- is in this series of blog posts:
        
        * `Hunting memory leaks in Python
          <https://mg.pov.lt/blog/hunting-python-memleaks.html>`_
        * `Python object graphs
          <https://mg.pov.lt/blog/python-object-graphs.html>`_
        * `Object graphs with graphviz
          <https://mg.pov.lt/blog/object-graphs-with-graphviz.html>`_
        
        
        .. _devel:
        
        Support and Development
        -----------------------
        
        The source code can be found in this Git repository:
        https://github.com/mgedmin/objgraph.
        
        To check it out, use ``git clone https://github.com/mgedmin/objgraph``.
        
        Report bugs at https://github.com/mgedmin/objgraph/issues.
        
        
        
        Changes
        =======
        
        
        
        3.5.0 (2020-10-11)
        ------------------
        
        - Do not require ``mock`` for the test suite on Python 3; use unittest.mock
          instead.
        
        - 100% test coverage for each version of Python rather than combined, using
          ``coverage-python-version``.
        
        - Add the optional ``extra_node_attrs`` parameter to ``show_backrefs`` and
          ``show_backrefs``
        
        - Fix IPython/Jupyter inline graph support code that would kick in even if you
          explicitly passed a filename='foo.png' argument to
          ``show_refs``/``show_backrefs``.  See `issue 47
          <https://github.com/mgedmin/objgraph/issues/47>`_.
        
        - Add support for Python 3.8.
        
        - Drop support for Python 3.5.
        
        
        3.4.1 (2019-04-23)
        ------------------
        
        - Add support for Python 3.7.
        
        - Drop support for Python 3.3 and 3.4.
        
        
        3.4.0 (2018-02-13)
        ------------------
        
        - New functions: `get_new_ids`, `at_addrs`.
        
          Contributed by Justin Black in `PR 36
          <https://github.com/mgedmin/objgraph/pull/36>`_.
        
        
        3.3.0 (2017-12-28)
        ------------------
        
        - New function: `growth`.
        
        
        3.2.0 (2017-12-20)
        ------------------
        
        - New ``filter`` argument for `typestats`, `most_common_types`,
          `show_most_common_types`, `show_growth`.
        
        - Show lambda functions in a more human-friendly way.
        
        
        3.1.2 (2017-11-27)
        ------------------
        
        - Correct UTF-8 mojibake in the changelog and switch all links to HTTPS.
        
        
        3.1.1 (2017-10-30)
        ------------------
        
        - Add support for Python 3.6.
        
        - Replace bare ``except:`` in ``safe_repr()`` with ``except Exception:``.
        
        
        3.1.0 (2016-12-07)
        ------------------
        
        - Support displaying graphs inline in IPython/Jupyter notebooks (`issue 28
          <https://github.com/mgedmin/objgraph/pull/28>`).
        
        
        3.0.1 (2016-09-17)
        ------------------
        
        - The ``file`` argument of `show_most_common_types` and
          `show_growth` now defaults to ``None`` instead of ``sys.stdout``.
          ``None`` is interpreted to be the same as ``sys.stdout``, which means
          the right stdout will be used if you change it at runtime (which happens,
          in doctests).
        
        
        3.0.0 (2016-04-13)
        ------------------
        
        - `show_most_common_types` and `show_growth` now accept a ``file``
          argument if you want to redirect the output elsewhere.
        
          Fixes `issue 24 <https://github.com/mgedmin/objgraph/pull/24>`_.  Contributed
          by "d-sun-d".
        
        - Don't trust ``__class__`` to be accurate and ``__name__`` to be a string.
          Fixes errors in some convoluted corner cases when mocks are involved.
        
          Contributed by Andrew Shannon Brown in `PR 26
          <https://github.com/mgedmin/objgraph/pull/26>`_.
        
        - Drop support for Python 2.4, 2.5, and 2.6.
        
        - Drop support for Python 3.1 and 3.2.
        
        - Add support for Python 3.5.
        
        
        2.0.1 (2015-07-28)
        ------------------
        
        - Avoid creating reference cycles between the stack frame and the local
          ``objects`` variable in `by_type`, `count`, and
          `typestats`.
        
          Fixes `issue 22 <https://github.com/mgedmin/objgraph/pull/22>`_.  Contributed
          by Erik Bray.
        
        
        2.0.0 (2015-04-18)
        ------------------
        
        - `show_refs` and `show_backrefs` now accept a file-like object
          (via the new ``output`` argument) as an alternative to a filename.
        
        - Made internal helper methods private. This includes `find_chain`,
          `show_graph`, `obj_node_id`, `obj_label`, `quote`,
          `long_typename`, `safe_repr`, `short_repr`,
          `gradient`, `edge_label`, and `_program_in_path`.
        
        - Correctly determine the name of old-style classes in `count`,
          `by_type`, and graph drawing functions.
        
          Fixes `issue 16 <https://github.com/mgedmin/objgraph/pull/16>`_.  Contributed
          by Mike Lambert.
        
        
        1.8.1 (2014-05-15)
        ------------------
        
        - Do not expect file objects to have an ``encoding`` attribute.  Makes objgraph
          compatible with Eventlet's monkey-patching.
        
          Fixes `issue 6 <https://github.com/mgedmin/objgraph/pull/6>`_.  Contributed
          by Jakub Stasiak.
        
        
        1.8.0 (2014-02-13)
        ------------------
        
        - Moved to GitHub.
        
        - Python 3.4 support (`LP#1270872 <https://launchpad.net/bugs/1270872>`_).
        
        - New function: `is_proper_module`.
        
        - New ``shortnames`` argument for `typestats`, `most_common_types`,
          `show_most_common_types`, `show_growth`, `show_refs`,
          and `show_backrefs`.
        
          `count` and `by_type` accept fully-qualified type names now.
        
          Fixes `issue 4 <https://github.com/mgedmin/objgraph/issues/4>`_.
        
        
        1.7.2 (2012-10-23)
        ------------------
        
        - Bugfix: setup.py sdist was broken on Python 2.7 (UnicodeDecodeError in
          tarfile).
        
        - The ``filename`` argument for `show_refs` and `show_backrefs` now
          allows arbitrary image formats, not just PNG.  Patch by `Riccardo
          Murri <https://launchpad.net/~rmurri>`_.
        
        - Temporary dot files are now named `objgraph-*.dot` instead of `tmp*.dot`.
        
        - Python 3.3 support: no code changes, but some tests started failing because
          the new and improved dictionary implementation no longer holds references to
          str objects used as dict keys.
        
        - Added a tox.ini for convenient multi-Python testing.
        
        
        1.7.1 (2011-12-11)
        ------------------
        
        - Bugfix: non-ASCII characters in object representations would break graph
          generation on Python 3.x, in some locales (e.g. with LC_ALL=C).  Reported and
          fixed by `Stefano Rivera <https://launchpad.net/~stefanor>`_.
        
        - Bugfix: setup.py was broken on Python 3.x
        
        - Bugfix: dot.exe/xdot.exe were not found on Windows (`LP#767239
          <https://launchpad.net/bugs/767239>`_).
        
        - Documentation updates: document the forgotten `find_ref_chain`,
          update `show_chain` prototype.
        
        
        1.7.0 (2011-03-11)
        ------------------
        
        - New function: `find_ref_chain`.
        
        - New ``backrefs`` argument for `show_chain`.
        
        - New function: `get_leaking_objects`, based on `a blog post by
          Kristj√°n Valur
          <https://cosmicpercolator.com/2010/12/08/finding-c-reference-leaks-using-the-gc-module/>`_.
        
        - New ``objects`` argument for `count`, `typestats`,
          `most_common_types`, `show_most_common_types`, and
          `by_type`.
        
        - Edges pointing to function attributes such as __defaults__ or __globals__
          are now labeled.
        
        - Edge labels that are not simple strings now show the type.
        
        - Bugfix: '\0' and other unsafe characters used in a dictionary key could
          break graph generation.
        
        - Bugfix: show_refs(..., filename='graph.dot') would then go to complain
          about unrecognized file types and then produce a png.
        
        
        1.6.0 (2010-12-18)
        ------------------
        
        - Python 3 support, thanks to Stefano Rivera (fixes `LP#687601
          <https://launchpad.net/bugs/687601>`_).
        
        - Removed weird weakref special-casing.
        
        
        1.5.1 (2010-12-09)
        ------------------
        
        - Avoid test failures in uncollectable-garbage.txt (fixes `LP#686731
          <https://launchpad.net/bugs/686731>`_).
        
        - Added HACKING.txt (later renamed to HACKING.rst).
        
        
        1.5.0 (2010-12-05)
        ------------------
        
        - Show frame objects as well (fixes `LP#361704
          <https://launchpad.net/bugs/361704>`_).
        
        - New functions: `show_growth`, `show_chain`.
        
        - `find_backref_chain` returns ``[obj]`` instead of ``None`` when a chain
          could not be found.  This makes ``show_chain(find_backref_chain(...), ...)``
          not break.
        
        - Show how many references were skipped from the output of
          `show_refs`/`show_backrefs` by specifying ``too_many``.
        
        - Make `show_refs` descend into modules.
        
        - Do not highlight classes that define a ``__del__``, highlight only instances of
          those classes.
        
        - Option to show reference counts in `show_refs`/`show_backrefs`.
        
        - Add `Sphinx <https://pypi.python.org/pypi/Sphinx>`_ documentation and a PyPI
          long description.
        
        
        1.4.0 (2010-11-03)
        ------------------
        
        - Compatibility with Python 2.4 and 2.5 (``tempfile.NamedTemporaryFile`` has no
          ``delete`` argument).
        
        - New function: `most_common_types`.
        
        
        1.3.1 (2010-07-17)
        ------------------
        
        - Rebuild an sdist with no missing files (fixes `LP#606604
          <https://launchpad.net/bugs/606604>`_).
        
        - Added MANIFEST.in and a Makefile to check that setup.py sdist generates
          source distributions with no files missing.
        
        
        1.3 (2010-07-13)
        ----------------
        
        - Highlight objects with a ``__del__`` method.
        
        - Fixes `LP#483411 <https://launchpad.net/bugs/483411>`_: suggest always passing
          ``[obj]`` to `show_refs`, `show_backrefs`, since obj might be a
          list/tuple.
        
        - Fixes `LP#514422 <https://launchpad.net/bugs/514422>`_: `show_refs`,
          `show_backrefs` don't create files in the current working directory any
          more.  Instead they accept a filename argument, which can be a .dot file or a
          .png file.  If None or not specified, those functions will try to spawn xdot
          as before.
        
        - New extra_info argument to graph-generating functions (patch by Thouis Jones,
          `LP#558914 <https://launchpad.net/bugs/558914>`_).
        
        - setup.py should work with distutils now (`LP#604430
          <https://launchpad.net/bugs/604430>`_, thanks to Randy Heydon).
        
        
        1.2 (2009-03-25)
        ----------------
        
        - Project website, public source repository, uploaded to PyPI.
        
        - No code changes.
        
        
        1.1 (2008-09-10)
        ----------------
        
        - New function: `show_refs` for showing forward references.
        
        - New functions: `typestats` and `show_most_common_types`.
        
        - Object boxes are less crammed with useless information (such as IDs).
        
        - Spawns `xdot <https://pypi.python.org/pypi/xdot>`_ if it is available.
        
        
        1.0 (2008-06-14)
        ----------------
        
        - First public release.
        
Keywords: object graph visualization graphviz garbage collection
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8