diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-06-16 10:24:49 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-06-16 19:15:31 +0200 |
| commit | 7008aa6bd17d1f56b54c30e60110668aed79a3cb (patch) | |
| tree | 7e350c61edf09b3b46e4a0f389db6fb1e5e6a7ce /sources/pyside6/doc/inheritance_diagram.py | |
| parent | 57304320c5c898ad9325576f9d8b8147df9a48ad (diff) | |
Split out a test driver from the Sphinx inheritance graph generation
Similar to 5b0918c6c6fa575a16b3ec1637281397e951f62b,
3a1e793c0a91deae4e986efb11724040349ce9ca.
Add a note to the README.md and fix it to be viewable.
Pick-to: 6.5
Task-number: PYSIDE-2362
Task-number: PYSIDE-1106
Change-Id: I1c0bbc745fffc16d6981e806618c1fce04ac8d18
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/inheritance_diagram.py')
| -rw-r--r-- | sources/pyside6/doc/inheritance_diagram.py | 102 |
1 files changed, 2 insertions, 100 deletions
diff --git a/sources/pyside6/doc/inheritance_diagram.py b/sources/pyside6/doc/inheritance_diagram.py index 22d7d87ad..d1e095ce6 100644 --- a/sources/pyside6/doc/inheritance_diagram.py +++ b/sources/pyside6/doc/inheritance_diagram.py @@ -48,111 +48,13 @@ from docutils.parsers.rst import directives, Directive from sphinx.ext.graphviz import render_dot_html, render_dot_latex +from inheritance_graph import InheritanceGraph from import_inheritance import (get_inheritance_entries_by_import, InheritanceException) from json_inheritance import (is_inheritance_from_json_enabled, get_inheritance_entries_from_json) -class InheritanceGraph(object): - """ - Given a list of classes, determines the set of classes that they inherit - from all the way to the root "object", and then is able to generate a - graphviz dot graph from them. - """ - def __init__(self, class_names, currmodule, show_builtins=False, parts=0): - """ - *class_names* is a list of child classes to show bases from. - - If *show_builtins* is True, then Python builtins will be shown - in the graph. - """ - self.class_names = class_names - if is_inheritance_from_json_enabled(): - self.class_info = get_inheritance_entries_from_json(class_names) - else: - self.class_info = get_inheritance_entries_by_import(class_names, - currmodule, - __builtins__, - show_builtins, - parts) - - def get_all_class_names(self): - """ - Get all of the class names involved in the graph. - """ - return [fullname for (_, fullname, _) in self.class_info] - - # These are the default attrs for graphviz - default_graph_attrs = { - 'rankdir': 'LR', - 'size': '"8.0, 12.0"', - } - default_node_attrs = { - 'shape': 'box', - 'fontsize': 10, - 'height': 0.25, - 'fontname': '"Vera Sans, DejaVu Sans, Liberation Sans, ' - 'Arial, Helvetica, sans"', - 'style': '"setlinewidth(0.5)"', - } - default_edge_attrs = { - 'arrowsize': 0.5, - 'style': '"setlinewidth(0.5)"', - } - - def _format_node_attrs(self, attrs): - return ','.join([f'{x[0]}={x[1]}' for x in attrs.items()]) - - def _format_graph_attrs(self, attrs): - return ''.join([f"{x[0]}={x[1]};\n" for x in attrs.items()]) - - def generate_dot(self, name, urls={}, env=None, - graph_attrs={}, node_attrs={}, edge_attrs={}): - """ - Generate a graphviz dot graph from the classes that - were passed in to __init__. - - *name* is the name of the graph. - - *urls* is a dictionary mapping class names to HTTP URLs. - - *graph_attrs*, *node_attrs*, *edge_attrs* are dictionaries containing - key/value pairs to pass on as graphviz properties. - """ - g_attrs = self.default_graph_attrs.copy() - n_attrs = self.default_node_attrs.copy() - e_attrs = self.default_edge_attrs.copy() - g_attrs.update(graph_attrs) - n_attrs.update(node_attrs) - e_attrs.update(edge_attrs) - if env: - g_attrs.update(env.config.inheritance_graph_attrs) - n_attrs.update(env.config.inheritance_node_attrs) - e_attrs.update(env.config.inheritance_edge_attrs) - - res = [] - res.append(f'digraph {name} {{\n') - res.append(self._format_graph_attrs(g_attrs)) - - for name, fullname, bases in self.class_info: - # Write the node - this_node_attrs = n_attrs.copy() - url = urls.get(fullname) - if url is not None: - this_node_attrs['URL'] = f'"{url}"' - this_node_attrs['target'] = '"_top"' # Browser target frame attribute (same page) - attribute = self._format_node_attrs(this_node_attrs) - res.append(f' "{name}" [{attribute}];\n') - - # Write the edges - for base_name in bases: - attribute = self._format_node_attrs(e_attrs) - res.append(f' "{base_name}" -> "{name}" [{attribute}];\n') - res.append('}\n') - return ''.join(res) - - class inheritance_diagram(nodes.General, nodes.Element): """ A docutils node to use as a placeholder for the inheritance diagram. @@ -186,7 +88,7 @@ class InheritanceDiagram(Directive): try: graph = InheritanceGraph( class_names, env.temp_data.get('py:module'), - parts=node['parts']) + __builtins__, parts=node['parts']) except InheritanceException as err: return [node.document.reporter.warning(err.args[0], line=self.lineno)] |