1PYDEPS(1) pydeps PYDEPS(1)
2
6 pydeps - pydeps Documentation Documentation StatusDownloads
7 Python module dependency visualization.
9 This package is primarily intended to be used from the command line
11 through the pydeps command.
12 Contents
14 • pydeps
15 • How to install
17 • Usage
19 • Example
21 • Notes
23 • Configuration files
25 • Bacon (Scoring)
27 • Import cycles
29 • Clustering
31 • Maximum module depth
33 • Graph direction
35 • Collapsing target package
37 • Intermediate format
39 • Version history
41 • Contributing
43 • API documentation
45 • Module contents
47 • pydeps.arguments module
49 • pydeps.cli module
51 • pydeps.colors module
53 • pydeps.depgraph module
55 • pydeps.depgraph2dot module
57 • pydeps.dot module
59 • pydeps.dummymodule module
61 • pydeps.configs module
63 • pydeps.mf27 module
65 • pydeps.package_names module
67 • pydeps.py2depgraph module
69 • pydeps.pycompat module
71 • pydeps.pydeps module
73 • pydeps.pystdlib module
75 • pydeps.render_context module
77 • pydeps.target module
79 • Indices and tables
81 Feature requests and bug reports:
83 Please report bugs and feature requests on GitHub at
85 https://github.com/thebjorn/pydeps/issues
86
88 pip install pydeps
89 To create graphs with pydeps you also need to install Graphviz. Please
91 follow the installation instructions provided in the Graphviz link (and
92 make sure the dot command is on your path).
93
95 usage: pydeps [-h] [--debug] [--config FILE] [--no-config] [--version] [-L LOG]
96 [--find-package] [-v] [-o file] [-T FORMAT] [--display PROGRAM]
97 [--noshow] [--show-deps] [--show-raw-deps] [--deps-output DEPS_OUT]
98 [--show-dot] [--dot-output DOT_OUT] [--nodot] [--no-output]
99 [--show-cycles] [--debug-mf INT] [--noise-level INT]
100 [--max-bacon INT] [--max-module-depth INT] [--pylib] [--pylib-all]
101 [--include-missing] [-x PATTERN [PATTERN ...]]
102 [-xx MODULE [MODULE ...]] [--only MODULE_PATH [MODULE_PATH ...]]
103 [--externals] [--reverse] [--rankdir {TB,BT,LR,RL}] [--cluster]
104 [--min-cluster-size INT] [--max-cluster-size INT]
105 [--keep-target-cluster] [--collapse-target-cluster]
106 [--rmprefix PREFIX [PREFIX ...]] [--start-color INT]
107 fname
108 positional arguments:
110 fname filename
111 optional arguments:
113 -h, --help
115 show this help message and exit
116 --debug
118 turn on all the show and verbose options (mainly for de‐
119 bugging pydeps itself)
120 --config FILE
122 specify config file
123 --no-config
125 disable processing of config files
126 --version
128 print pydeps version
129 -L LOG, --log LOG
131 set log-level to one of CRITICAL, ERROR, WARNING, INFO,
132 DEBUG, NOTSET.
133 --find-package
135 tries to automatically find the name of the current pack‐
136 age.
137 -v, --verbose
139 be more verbose (-vv, -vvv for more verbosity)
140 -o file
142 write output to 'file'
143 -T FORMAT
145 output format (svg|png)
146 --display PROGRAM
148 program to use to display the graph (png or svg file de‐
149 pending on the T parameter)
150 --noshow, --no-show
152 don't call external program to display graph
153 --show-deps
155 show output of dependency analysis
156 --show-raw-deps
158 show output of dependency analysis before removing skips
159 --deps-output
161 write output of dependency analysis to file (instead of
162 screen)
163 --show-dot
165 show output of dot conversion
166 --dot-output
168 write dot code to file (instead of screen)
169 --nodot, --no-dot
171 skip dot conversion
172 --no-output
174 don't create .svg/.png file, implies --no-show (-t/-o
175 will be ignored)
176 --show-cycles
178 show only import cycles
179 --debug-mf INT
181 set the ModuleFinder.debug flag to this value
182 --noise-level INT
184 exclude sources or sinks with degree greater than
185 noise-level
186 --max-bacon INT
188 exclude nodes that are more than n hops away (default=2,
189 0 -> infinite)
190 --max-module-depth INT
192 coalesce deep modules to at most n levels
193 --pylib
195 include python std lib modules
196 --pylib-all
198 include python all std lib modules (incl. C modules)
199 --include-missing
201 include modules that are not installed (or can't be found
202 on sys.path)
203 --only MODULE_PATH
205 only include modules that start with MODULE_PATH, multi‐
206 ple paths can be provided
207 --externals
209 create list of direct external dependencies
210 --reverse
212 draw arrows to (instead of from) imported modules
213 --rankdir
215 set the direction of the graph, legal values are TB (de‐
216 fault, imported modules above importing modules), BT (op‐
217 posite direction of TB), LR (left-to-right) and RL
218 (right-to-left)
219 --cluster
221 draw external dependencies as separate clusters
222 --min-cluster-size INT
224 the minimum number of nodes a dependency must have before
225 being clustered (default=0)
226 --max-cluster-size INT
228 the maximum number of nodes a dependency can have before
229 the cluster is collapsed to a single node (default=0)
230 --keep-target-cluster
232 draw target module as a cluster
233 --collapse-target-cluster
235 collapse target module (this implies --cluster)
236 --rmprefix PREFIX
238 remove PREFIX from the displayed name of the nodes (mul‐
239 tiple prefixes can be provided)
240 -x PATTERN, --exclude PATTERN
242 input files to skip (e.g. foo.*), multiple patterns can
243 be provided
244 --exclude-exact MODULE
246 (shorthand -xx MODULE) same as --exclude, except requires
247 the full match. -xx foo.bar will exclude foo.bar, but not
248 foo.bar.blob
249 Note: if an option with a variable number of arguments (like -x) is
251 provided before fname, separate the arguments from the filename with --
252 otherwise fname will be parsed as an argument of the option. Example: $
253 pydeps -x os sys -- pydeps.
254 You can of course also import pydeps from Python and use it as a li‐
256 brary, look in tests/test_relative_imports.py for examples.
257
259 This is the result of running pydeps on itself (pydeps pydeps): [image]
260 (full disclosure: this is for an early version of pydeps)
262
264 pydeps finds imports by looking for import-opcodes in python bytecodes
265 (think .pyc files). Therefore, only imported files will be found (ie.
266 pydeps will not look at files in your directory that are not imported).
267 Additionally, only files that can be found using the Python import ma‐
268 chinery will be considered (ie. if a module is missing or not in‐
269 stalled, it will not be included regardless if it is being imported).
270 This can be modified by using the --include-missing flag.
271 Displaying the graph:
273 To display the resulting .svg or .png files, pydeps by default calls an
275 appropriate opener for the platform, like xdg-open foo.svg.
276 This can be overridden with the --display PROGRAM option, where PROGRAM
278 is an executable that can display the image file of the graph.
279 You can also export the name of such a viewer in either the PYDEPS_DIS‐
281 PLAY or BROWSER environment variable, which changes the default behav‐
282 iour when --display is not used.
283
285 All options can also be set in a .pydeps file using .ini file syntax
286 (parsable by ConfigParser). Command line options override options in
287 the .pydeps file in the current directory, which again overrides op‐
288 tions in the user's home directory (%USERPROFILE%\.pydeps on Windows
289 and ${HOME}/.pydeps otherwise).
290 An example .pydeps file:
292 [pydeps]
294 max_bacon = 2
295 no_show = True
296 verbose = 0
297 pylib = False
298 exclude =
299 os
300 re
301 sys
302 collections
303 __future__
304 pydeps will also look for configuration data in pyproject.toml (under
306 [tool.pydeps]) and setup.cfg (under [pydeps]).
307
309 pydeps also contains an Erdős-like scoring function (a.k.a. Bacon num‐
310 ber, from Six degrees of Kevin Bacon (‐
311 http://en.wikipedia.org/wiki/Six_Degrees_of_Kevin_Bacon) that lets you
312 filter out modules that are more than a given number of 'hops' away
313 from the module you're interested in. This is useful for finding the
314 interface a module has to the rest of the world.
315 To find pydeps' interface to the Python stdlib (less some very common
317 modules).
318 shell> pydeps pydeps --show --max-bacon 2 --pylib -x os re types _* enum
320 [image]
321 --max-bacon 2 (the default) gives the modules that are at most 2 hops
323 away, and modules that belong together have similar colors. Compare
324 that to the output with the --max-bacon=0 (infinite) filter: [image]
325
327 pydeps can detect and display cycles with the --show-cycles parameter.
328 This will _only_ display the cycles, and for big libraries it is not a
329 particularly fast operation. Given a folder with the following con‐
330 tents (this uses yaml to define a directory structure, like in the
331 tests):
332 relimp:
334 - __init__.py
335 - a.py: |
336 from . import b
337 - b.py: |
338 from . import a
339 pydeps relimp --show-cycles displays: [image]
341
343 Running pydeps pydeps --max-bacon=4 on version 1.8.0 of pydeps gives
344 the following graph: [image]
345 If you are not interested in the internal structure of external mod‐
347 ules, you can add the --cluster flag, which will collapse external mod‐
348 ules into folder-shaped objects:
349 shell> pydeps pydeps --max-bacon=4 --cluster
351 [image]
352 To see the internal structure _and_ delineate external modules, use the
354 --max-cluster-size flag, which controls how many nodes can be in a
355 cluster before it is collapsed to a folder icon:
356 shell> pydeps pydeps --max-bacon=4 --cluster --max-cluster-size=1000
358 [image]
359 or, using a smaller max-cluster-size:
361 shell> pydeps pydeps --max-bacon=4 --cluster --max-cluster-size=3
363 [image]
364 To remove clusters with too few nodes, use the --min-cluster-size flag:
366 shell> pydeps pydeps --max-bacon=4 --cluster --max-cluster-size=3 --min-cluster-size=2
368 [image]
369 In some situations it can be useful to draw the target module as a
371 cluster:
372 shell> pydeps pydeps --max-bacon=4 --cluster --max-cluster-size=3 --min-cluster-size=2 --keep-target-cluster
374 [image]
375 ..and since the cluster boxes include the module name, we can remove
377 those prefixes:
378 shell> pydeps pydeps --max-bacon=4 --cluster --max-cluster-size=3 --min-cluster-size=2 --keep-target-cluster --rmprefix pydeps. stdlib_list.
380 [image]
381
383 For Python packages that have a module structure more than two levels
384 deep, the graph can easily become overwhelmingly complex. Use the
385 --max-module-depth=n flag to examine the internal dependencies of a
386 package while limiting the module depth (private and testing-related
387 modules are removed to further simplify the graph using -x ...):
388 shell> pydeps pandas --only pandas --max-module-depth=2 -x pandas._* pandas.test* pandas.conftest
390 [image]
391
393 The direction of the graph can be specified using the --rankdir flag.
394 Top to bottom (default):
396 shell> pydeps pydeps --rankdir TB
398 [image]
399 Bottom to top:
401 shell> pydeps pydeps --rankdir BT
403 [image]
404 Left to right:
406 shell> pydeps pydeps --rankdir LR
408 [image]
409 Right to left:
411 shell> pydeps pydeps --rankdir RL
413 [image]
414
416 When internal target package dependencies are unimportant, they can be
417 collapsed using the --collapse-target-cluster flag. This option also
418 implies --cluster:
419 shell> pydeps pydeps --collapse-target-cluster
421 [image]
422
424 An attempt has been made to keep the intermediate formats readable, eg.
425 the output from pydeps --show-deps .. looks like this:
426 ...
428 "pydeps.mf27": {
429 "imported_by": [
430 "__main__",
431 "pydeps.py2depgraph"
432 ],
433 "kind": "imp.PY_SOURCE",
434 "name": "pydeps.mf27",
435 "path": "pydeps\\mf27.py"
436 },
437 "pydeps.py2depgraph": {
438 "imported_by": [
439 "__main__",
440 "pydeps.pydeps"
441 ],
442 "imports": [
443 "pydeps.depgraph",
444 "pydeps.mf27"
445 ],
446 "kind": "imp.PY_SOURCE",
447 "name": "pydeps.py2depgraph",
448 "path": "pydeps\\py2depgraph.py"
449 }, ...
450
452 Version 1.12.13 Better docs for larger packages. See
453 maximum_module_depth for an example. Thanks to sheromon for the PR.
454 Version 1.12.5 Pydeps can now read configuration data from pypro‐
456 ject.toml. Thanks to septatrix for pushing the idea and for countering
457 my toml-rant with an informative argument.
458 Version 1.11.0 drop support for Python 3.6. Thanks to pawamoy for re‐
460 moving imports of the deprecated imp module. (Parts of it has been
461 vendorized due to a Python bug, see the code for details.)
462 Version 1.10.1 Thanks to vector400 for a new option --rankdir which
464 renders the graph in different directions.
465 Version 1.10.0 supports Python 3.10.
467 Version 1.9.15 Thanks to Pipeline Foundation for a very much improved
469 CI pipeline, and a CD pipeline as well.
470 Version 1.9.14 Thanks to poneill for fixing a cryptic error message
472 when run in a directory without an __init__.py file.
473 Version 1.9.13 Thanks to glumia and SimonBiggs for improving the docu‐
475 mentation.
476 Version 1.9.10 no_show is now honored when placed in .pydeps file.
478 Thanks to romain-dartigues for the PR.
479 Version 1.9.8 Fix for maximum recursion depth exceeded when using large
481 frameworks (like sympy). Thanks to tanujkhattar for finding the fix
482 and to balopat for reporting it.
483 Version 1.9.7 Check PYDEPS_DISPLAY and BROWSER for a program to open
485 the graph, PR by jhermann
486 Version 1.9.1 graphs are now stable on Python 3.x as well - this was
488 already the case for Py2.7 (thanks to pawamoy for reporting and testing
489 the issue and to kinow for helping with testing).
490 Version 1.9.0 supports Python 3.8.
492 Version 1.8.7 includes a new flag --rmprefix which lets you remove pre‐
494 fixes from the node-labels in the graph. The _name_ of the nodes are
495 not effected so this does not cause merging of nodes, nor does it
496 change coloring - but it can lead to multiple nodes with the same label
497 (hovering over the node will give the full name). Thanks to aroberge
498 for the enhancement request.
499 Version 1.8.5 With svg as the output format (which is the default),
501 paths are now hilighted on mouse hover (thanks to tomasito665 for the
502 enhancement request).
503 Version 1.8.2 incldes a new flag --only that causes pydeps to only re‐
505 port on the paths specified:
506 shell> pydeps mypackage --only mypackage.a mypackage.b
508 Version 1.8.0 includes 4 new flags for drawing external dependencies as
510 clusters. See clustering for examples. Additionally, the arrowheads
511 now have the color of the source node.
512 Version 1.7.3 includes a new flag -xx or --exclude-exact which matches
514 the functionality of the --exclude flag, except it requires an exact
515 match, i.e. -xx foo.bar will exclude foo.bar, but not foo.bar.blob
516 (thanks to AvenzaOleg for the PR).
517 Version 1.7.2 includes a new flag, --no-output, which prevents creation
519 of the .svg/.png file.
520 Version 1.7.1 fixes excludes in .pydeps files (thanks to eqvis for the
522 bug report).
523 Version 1.7.0 The new --reverse flag reverses the direction of the ar‐
525 rows in the dependency graph, so they point _to_ the imported module
526 instead of _from_ the imported module (thanks to goetzk for the bug re‐
527 port and tobiasmaier for the PR!).
528 Version 1.5.0 Python 3 support (thanks to eight04 for the PR).
530 Version 1.3.4 --externals will now include modules that haven't been
532 installed (what modulefinder calls badmodules).
533 Version 1.2.8 A shortcut for finding the direct external dependencies
535 of a package was added:
536 pydeps --externals mypackage
538 which will print a json formatted list of module names to the screen,
540 e.g.:
541 (dev) go|c:\srv\lib\dk-tasklib> pydeps --externals dktasklib
543 [
544 "dkfileutils"
545 ]
546 which means that the dktasklib package only depends on the dkfileutils
548 package.
549 This functionality is also available programmatically:
551 import os
553 from pydeps.pydeps import externals
554 # the directory that contains setup.py (one level up from actual package):
555 os.chdir('package-directory')
556 print externals('mypackage')
557 Version 1.2.5: The defaults are now sensible, such that:
559 shell> pydeps mypackage
561 will likely do what you want. It is the same as pydeps --show --max-ba‐
563 con=2 mypackage which means display the dependency graph in your
564 browser, but limit it to two hops (which includes only the modules that
565 your module imports -- not continuing down the import chain). The old
566 default behavior is available with pydeps --noshow --max-bacon=0 my‐
567 package.
568
570 1. Fork it
571 2. It is appreciated (but not required) if you raise an issue first:
573 https://github.com/thebjorn/pydeps/issues
574 3. Create your feature branch (git checkout -b my-new-feature)
576 4. Commit your changes (git commit -am 'Add some feature')
578 5. Push to the branch (git push origin my-new-feature)
580 6. Create new Pull Request
582
584 Python module dependency visualization. This package installs the py‐
585 deps command, and normal usage will be to use it from the command line.
586
588 class pydeps.arguments.Argument(*flags, **args)
589 Bases: object
590 add_to_parser(parser)
592 argname()
594 default()
596 help()
598 pytype()
600 typefn()
602 typename()
604 class pydeps.arguments.Arguments(config_files=None, debug=False,
606 *posargs, parents=None, **kwargs)
607 Bases: object
608 add(*flags, **kwargs)
610 load_config_files()
612 parse_args(argv)
614 write_default_config()
616 Utility function to create .configs.Config
617 # XXX: a more general utility to create configs from arg‐
619 parse # would be nice...
620 class pydeps.arguments.Namespace(ns)
622 Bases: object
623 items()
625
627 command line interface (cli) code.
628 pydeps.cli.base_argparser(argv=())
630 Initial parser that can set values for the rest of the parsing
631 process.
632 pydeps.cli.error(*args, **kwargs)
634 Print an error message and exit.
635 pydeps.cli.parse_args(argv=())
637 Parse command line arguments, and return a dict.
638 pydeps.cli.verbose(*args, **kwargs)
640 the (will become) verbose function
641
643 Color calculations.
644 class pydeps.colors.ColorSpace(nodes)
646 Bases: object
647 add_to_tree(parts, tree)
649 color(src)
651 pydeps.colors.brightness(r, g, b)
653 From w3c (range 0..255).
654 pydeps.colors.brightnessdiff(a, b)
656 greater than 125 is good.
657 pydeps.colors.colordiff(rgb1, rgb2)
659 From w3c (greater than 500 is good). (range [0..765])
660 pydeps.colors.distinct_hues(count)
662 Return count hues, equidistantly spaced.
663 pydeps.colors.foreground(background, *options)
665 Find the best foreground color from options based on background
666 color.
667 pydeps.colors.frange(start, end, step)
669 Like range(), but with floats.
670 pydeps.colors.name2rgb(hue)
672 Originally used to calculate color based on module name.
673 pydeps.colors.rgb2css(rgb)
675 Convert rgb to hex.
676 pydeps.colors.rgb2eightbit(rgb)
678 Convert floats in [0..1] to integers in [0..256)
679
681 class pydeps.depgraph.DepGraph(depgraf, types, target, **args)
682 Bases: object
683 The dependency graph.
685 It is the output of pydeps.py2depgraph.py2dep()
687 add_source(src)
689 calculate_bacon()
691 connect_generations()
693 Traverse depth-first adding imported_by.
694 dissimilarity_metric(a, b)
696 Return non-zero if references to this module are strange,
697 and should be drawn extra-long. The value defines the
698 length, in rank. This is also good for putting some ver‐
699 tical space between seperate subsystems.
700 Returns an int between 1 (default) and 4 (highly unre‐
702 lated).
703 exclude_bacon(limit)
705 Exclude modules that are more than limit hops away from
706 __main__.
707 exclude_noise()
709 find_import_cycles()
711 get_colors(src, colorspace=None)
713 levelcounts()
715 only_filter(paths)
717 Exclude nodes that have a prefix in paths.
718 proximity_metric(a, b)
720 Return the weight of the dependency from a to b. Higher
721 weights usually have shorter straighter edges. Return 1
722 if it has normal weight. A value of 4 is usually good for
723 ensuring that a related pair of modules are drawn next to
724 each other.
725 Returns an int between 1 (unknown, default), and 4 (very
727 related).
728 remove_excluded()
730 Remove all sources marked as excluded.
731 skip_modules = ['os', 'sys', 'qt', 'time', '__future__',
733 'types', 're', 'string', 'bdb', 'pdb', '__main__', 'south']
734 source_name(name, path=None)
736 Returns the module name, possibly limited by --max-mod‐
737 ule-depth.
738 sources
740 dict[module_name] -> Source object
741 class pydeps.depgraph.Source(name, path=None, imports=(), ex‐
743 clude=False, args=None)
744 Bases: object
745 A node (contained) in the dependency graph.
747 It contains info about which modules are imported by this
749 source, and which modules import this source.
750 property degree
752 get_label(splitlength=0, rmprefix=None)
754 property in_degree
756 Number of incoming arrows.
757 is_noise()
759 Is this module just noise? (too common either at top or
760 bottom of the graph).
761 property label
763 Convert a module name to a formatted node label. This is
764 a default policy - please override.
765 property module_depth
767 property name_parts
769 property out_degree
771 Number of outgoing arrows.
772 property path_parts
774 class pydeps.depgraph.imp(value, names=None, *values, module=None,
776 qualname=None, type=None, start=1, boundary=None)
777 Bases: Enum
778 C_BUILTIN = 6
780 C_EXTENSION = 3
782 IMP_HOOK = 9
784 PKG_DIRECTORY = 5
786 PY_CODERESOURCE = 8
788 PY_COMPILED = 2
790 PY_FROZEN = 7
792 PY_RESOURCE = 4
794 PY_SOURCE = 1
796 UNKNOWN = 0
798
800 class pydeps.depgraph2dot.CycleGraphDot(**kw)
801 Bases: object
802 render(depgraph, ctx)
804 class pydeps.depgraph2dot.PyDepGraphDot(**kw)
806 Bases: object
807 render(depgraph, ctx)
809 pydeps.depgraph2dot.cycles2dot(target, depgraph, **kw)
811 pydeps.depgraph2dot.dep2dot(target, depgraph, **kw)
813
815 Graphviz interface.
816 pydeps.dot.call_graphviz_dot(src, fmt)
818 Call dot command, and provide helpful error message if we cannot
819 find it.
820 pydeps.dot.cmd2args(cmd)
822 Prepare a command line for execution by Popen.
823 pydeps.dot.display_svg(kw, fname)
825 Try to display the svg file on this platform.
826 Note that this is also used to display PNG files, despite the
828 name.
829 pydeps.dot.dot(src, **kw)
831 Execute the dot command to create an svg output.
832 pydeps.dot.in_wsl()
834 Are we running under wsl?
835 pydeps.dot.is_unicode(s)
837 Test unicode with py3 support.
838 pydeps.dot.pipe(cmd, txt)
840 Pipe txt into the command cmd and return the output.
841 pydeps.dot.to_bytes(s)
843 Convert an item into bytes.
844
846 class pydeps.dummymodule.DummyModule(target, **args)
847 Bases: object
848 We create a file that imports the module to be investigated.
850 legal_module_name(name)
852 Legal module names are dotted strings where each part is
853 a valid Python identifier. (and not a keyword, and sup‐
854 port unicode identifiers in Python3, ..)
855 print_header(fp)
857 print_import(fp, module)
859 text() Return the content of the dummy module.
861 pydeps.dummymodule.fname2modname(fname, package_root)
863 pydeps.dummymodule.is_module(directory)
865 A directory is a module if it contains an __init__.py file.
866 pydeps.dummymodule.is_pysource(fname)
868 A file name is a python source file iff it ends with '.py(w?)'
869 and doesn't start with a dot.
870 pydeps.dummymodule.python_sources_below(directory, package=True)
872
874 class pydeps.configs.Config(**kwargs)
875 Bases: object
876 cluster = False
878 draw external dependencies as separate clusters
879 collapse_target_cluster = False
881 collapse target module (--keep-target-cluster will be ig‐
882 nored)
883 config = None
885 specify config file
886 debug = False
888 turn on all the show and verbose options (mainly for de‐
889 bugging pydeps itself)
890 debug_mf = 0
892 set the ModuleFinder.debug flag to this value
893 deps_out = None
895 write output of dependency analysis to 'file'
896 display = None
898 program to use to display the graph (png or svg file de‐
899 pending on the T parameter)
900 dot_out = None
902 write dot code to 'file'
903 exclude = []
905 input files to skip (e.g. foo.*), multiple file names can
906 be provided
907 exclude_exact = []
909 same as --exclude, except requires the full match. -xx
910 foo.bar will exclude foo.bar, but not foo.bar.blob
911 externals = False
913 create list of direct external dependencies
914 find_package = False
916 tries to automatically find the name of the current pack‐
917 age.
918 fname = None
920 filename
921 format = 'svg'
923 output format (svg|png)
924 include_missing = False
926 include modules that are not installed (or can't be found
927 on sys.path)
928 keep_target_cluster = False
930 draw target module as a cluster
931 classmethod load(fnames)
933 Load config from file.
934 log = None
936 set log-level to one of CRITICAL, ERROR, WARNING, INFO,
937 DEBUG, NOTSET.
938 max_bacon = 2
940 exclude nodes that are more than n hops away (default=2,
941 0 -> infinite)
942 max_cluster_size = 0
944 the maximum number of nodes a dependency can have before
945 the cluster is collapsed to a single node (default=0)
946 max_module_depth = 0
948 coalesce deep modules to at most n levels
949 min_cluster_size = 0
951 the minimum number of nodes a dependency must have before
952 being clustered (default=0)
953 no_config = False
955 disable processing of config files
956 no_dot = False
958 skip dot conversion
959 no_output = False
961 don't create .svg/.png file, implies --no-show (-t/-o
962 will be ignored)
963 no_show = False
965 don't call external program to display graph
966 noise_level = 200
968 exclude sources or sinks with degree greater than
969 noise-level
970 only = []
972 only include modules that start with MODULE_PATH
973 output = None
975 write output to 'file'
976 pylib = False
978 include python std lib modules
979 pylib_all = False
981 include python all std lib modules (incl. C modules)
982 rankdir = 'TB'
984 set the direction of the graph, legal values are TB (de‐
985 fault, imported modules above importing modules), BT (op‐
986 posite direction of TB), BT (opposite direction of TB),
987 LR (left-to-right) and RL (right-to-left)
988 reverse = False
990 draw arrows to (instead of from) imported modules
991 rmprefix = []
993 remove PREFIX from the displayed name of the nodes
994 set_field(field, value)
996 show_cycles = False
998 show only import cycles
999 show_deps = False
1001 show output of dependency analysis
1002 show_dot = False
1004 show output of dot conversion
1005 show_raw_deps = False
1007 show output of dependency analysis before removing skips
1008 start_color = 0
1010 starting value for hue from 0 (red/default) to 360.
1011 update(data)
1013 verbose = 0
1015 be more verbose (-vv, -vvv for more verbosity)
1016 version = False
1018 print pydeps version
1019 write_ini()
1021 write_json()
1023 write_toml()
1025 write_yaml()
1027 pydeps.configs.boolval(v)
1029 pydeps.configs.filetype(fname)
1031 pydeps.configs.identity(v)
1033 pydeps.configs.is_string(v)
1035 pydeps.configs.listval(v)
1037 pydeps.configs.load_config(filename)
1039 pydeps.configs.load_ini(filename)
1041 pydeps.configs.load_json(filename)
1043 pydeps.configs.load_toml(filename)
1045 pydeps.configs.load_yaml(filename)
1047
1049 class pydeps.mf27.ModuleFinder(path=None, debug=0, excludes=None, re‐
1050 place_paths=None)
1051 Bases: ModuleFinder
1052 import_hook(name, caller=None, fromlist=None, level=-1)
1054 load_module(fqname, fp, pathname, file_info)
1056 scan_code(co, m)
1058 pydeps.mf27.load_pyc(fp, mf=None)
1060 Load a pyc file from a file object.
1061
1063 pydeps.package_names.find_package_names()
1064
1066 class pydeps.py2depgraph.Module(name, file=None, path=None)
1067 Bases: object
1068 property shortname
1070 class pydeps.py2depgraph.MyModuleFinder(syspath, *args, **kwargs)
1072 Bases: ModuleFinder
1073 add_module(fqname)
1075 ensure_fromlist(module, fromlist, recursive=0)
1077 import_hook(name, caller=None, fromlist=None, level=-1)
1079 import_module(partnam, fqname, parent)
1081 load_module(fqname, fp, pathname, suffix_mode_kind)
1083 run_script(pathname)
1085 class pydeps.py2depgraph.RawDependencies(fname, **kw)
1087 Bases: object
1088 class pydeps.py2depgraph.imp(value, names=None, *values, module=None,
1090 qualname=None, type=None, start=1, boundary=None)
1091 Bases: IntEnum
1092 C_BUILTIN = 6
1094 C_EXTENSION = 3
1096 IMP_HOOK = 9
1098 PKG_DIRECTORY = 5
1100 PY_CODERESOURCE = 8
1102 PY_COMPILED = 2
1104 PY_FROZEN = 7
1106 PY_RESOURCE = 4
1108 PY_SOURCE = 1
1110 pydeps.py2depgraph.py2dep(target, **kw) -> DepGraph
1112 "Calculate dependencies for pattern and return a DepGraph.
1113 pydeps.py2depgraph.py2depgraph()
1115
1117 Compatibility imports between py2/py3
1118
1120 cli entrypoints.
1121 pydeps.pydeps.call_pydeps(file_or_dir, **kwargs)
1123 Programatic entry point for pydeps.
1124 See pydeps.configs.Config class for the available options.
1126 pydeps.pydeps.depgraph_to_dotsrc(target, dep_graph, **kw)
1128 Convert the dependency graph (DepGraph class) to dot source
1129 code.
1130 pydeps.pydeps.externals(trgt, **kwargs)
1132 Return a list of direct external dependencies of pkgname.
1133 Called for the pydeps --externals command.
1134 pydeps.pydeps.pydeps(**args)
1136 Entry point for the pydeps command.
1137 This function should do all the initial parameter and environ‐
1139 ment munging before calling _pydeps (so that function has a
1140 clean execution path).
1141
1143 pydeps.pystdlib.pystdlib()
1144 Return a set of all module-names in the Python standard library.
1145
1147 class pydeps.render_context.Rankdir(value, names=None, *values, mod‐
1148 ule=None, qualname=None, type=None, start=1, boundary=None)
1149 Bases: Enum
1150 BOTTOM_TOP = 'BT'
1152 LEFT_RIGHT = 'LR'
1154 RIGHT_LEFT = 'RL'
1156 TOP_BOTTOM = 'TB'
1158 reverse()
1160 class pydeps.render_context.RenderBuffer(target, reverse=False,
1162 rankdir=Rankdir.TOP_BOTTOM, cluster=False, min_cluster_size=0,
1163 max_cluster_size=1, keep_target_cluster=False, collapse_target_clus‐
1164 ter=False, **kw)
1165 Bases: object
1166 cluster_stats()
1168 graph(**kw)
1170 text()
1172 triage_clusters()
1174 write_node(n, **attrs)
1176 write_rule(a, b, **attrs)
1178 class pydeps.render_context.RenderContext(out=None, reverse=False,
1180 rankdir=Rankdir.TOP_BOTTOM)
1181 Bases: object
1182 dedent(txt)
1184 Write txt dedented.
1185 graph(**kw)
1187 Set up a graphviz graph context.
1188 rule() Write indented rule.
1190 text() Get value of output stream (StringIO).
1192 write(txt)
1194 Write txt to file and output stream (StringIO).
1195 write_attributes(attrs)
1197 Write comma separated attribute values (if exists).
1198 write_node(a, **attrs)
1200 a [a1=x,a2=y];
1201 write_rule(a, b, **attrs)
1203 a -> b [a1=x,a2=y];
1204 writeln(txt)
1206 Write txt and add newline.
1207 pydeps.render_context.to_unicode(s)
1209
1211 Abstracting the target for pydeps to work on.
1212 class pydeps.target.Target(path)
1214 Bases: object
1215 The compilation target.
1217 chdir_work()
1219 close()
1221 Clean up after ourselves.
1222 get_package_root()
1224 get_parents()
1226 is_dir = False
1228 is_module = False
1230 is_pysource = False
1232 • Index
1234 • Module Index
1236 • Search Page
1238
1241 2023 - 2023 Bjorn Pettersen
12421.12.17 Sep 07, 2023 PYDEPS(1)