Skip to content

Allow special characters in class names #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
user202729 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow special characters in class names #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions mro_graph/mro_graph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ def mro(cls):
return "\n".join(out)


def quote_id(s):
"""
Quote a Graphviz ID.
"""
# according to https://www.graphviz.org/doc/info/lang.html backslash need not be escaped
# which means odd number of trailing backslash cannot be escaped
# we don't test for it here
return '"' + s.replace('"', r'\"') + '"'


class MROGraph(object):
def __init__(self, *classes, **options):
"""Generates the MRO graph of a set of given classes.
Expand Down Expand Up @@ -112,7 +122,7 @@ def __init__(self, *classes, **options):
*[self.generate_mro_dot_code(cls) for cls in classes]
)

self.dot_code = "digraph %s{\n%s%s}" % (name, setup_code, "\n".join(code_iter))
self.dot_code = "digraph %s{\n%s%s}" % (quote_id(name), setup_code, "\n".join(code_iter))

if file_format == "dot":
with open(filename, "w") as f:
Expand All @@ -135,8 +145,8 @@ def generate_mro_dot_code(self, cls):
[
" edge [style=solid]; %s -> %s %s;\n"
% (
b.__name__,
name,
quote_id(b.__name__),
quote_id(name),
'[label="%s"]' % (i + 1)
if many_parents and self.labels == 2
else "",
Expand All @@ -153,10 +163,10 @@ def generate_mro_dot_code(self, cls):
option = (
"[%s]" % label if issubclass(cls, type) else "[shape=box,%s]" % label
)
yield " %s %s;\n" % (name, option)
yield " %s %s;\n" % (quote_id(name), option)
if type(c) is not type: # c has a custom metaclass
meta_name = type(c).__name__
yield " edge [style=dashed]; %s -> %s;" % (meta_name, name)
yield " edge [style=dashed]; %s -> %s;" % (quote_id(meta_name), quote_id(name))

def __repr__(self):
"""Returns the Dot representation of the graph"""
Expand Down