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
|
# Copyright (c) 2008-2010, 2012-2014 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2014 Brett Cannon <brett@python.org>
# Copyright (c) 2014 Arun Persaud <arun@nubati.net>
# Copyright (c) 2015-2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
# Copyright (c) 2016 Alexander Pervakov <frost.nzcr4@jagmort.com>
# Copyright (c) 2018 ssolanki <sushobhitsolanki@gmail.com>
# Copyright (c) 2019, 2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
# Copyright (c) 2020 Peter Kolbus <peter.kolbus@gmail.com>
# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 Andreas Finkler <andi.finkler@gmail.com>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Copyright (c) 2021 Mark Byrne <31762852+mbyrnepr2@users.noreply.github.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
"""
%prog [options] <packages>
create UML diagrams for classes and modules in <packages>
"""
import os
import sys
from typing import Iterable
from pylint.config import ConfigurationMixIn
from pylint.pyreverse import writer
from pylint.pyreverse.diadefslib import DiadefsHandler
from pylint.pyreverse.inspector import Linker, project_from_files
from pylint.pyreverse.utils import check_graphviz_availability, insert_default_options
OPTIONS = (
(
"filter-mode",
dict(
short="f",
default="PUB_ONLY",
dest="mode",
type="string",
action="store",
metavar="<mode>",
help="""filter attributes and functions according to
<mode>. Correct modes are :
'PUB_ONLY' filter all non public attributes
[DEFAULT], equivalent to PRIVATE+SPECIAL_A
'ALL' no filter
'SPECIAL' filter Python special functions
except constructor
'OTHER' filter protected and private
attributes""",
),
),
(
"class",
dict(
short="c",
action="append",
metavar="<class>",
dest="classes",
default=[],
help="create a class diagram with all classes related to <class>;\
this uses by default the options -ASmy",
),
),
(
"show-ancestors",
dict(
short="a",
action="store",
metavar="<ancestor>",
type="int",
help="show <ancestor> generations of ancestor classes not in <projects>",
),
),
(
"all-ancestors",
dict(
short="A",
default=None,
help="show all ancestors off all classes in <projects>",
),
),
(
"show-associated",
dict(
short="s",
action="store",
metavar="<association_level>",
type="int",
help="show <association_level> levels of associated classes not in <projects>",
),
),
(
"all-associated",
dict(
short="S",
default=None,
help="show recursively all associated off all associated classes",
),
),
(
"show-builtin",
dict(
short="b",
action="store_true",
default=False,
help="include builtin objects in representation of classes",
),
),
(
"module-names",
dict(
short="m",
default=None,
type="yn",
metavar="[yn]",
help="include module name in representation of classes",
),
),
(
"only-classnames",
dict(
short="k",
action="store_true",
default=False,
help="don't show attributes and methods in the class boxes; this disables -f values",
),
),
(
"output",
dict(
short="o",
dest="output_format",
action="store",
default="dot",
metavar="<format>",
help="create a *.<format> output file if format available.",
),
),
(
"colorized",
dict(
dest="colorized",
action="store_true",
default=False,
help="Use colored output. Classes/modules of the same package get the same color.",
),
),
(
"max-color-depth",
dict(
dest="max_color_depth",
action="store",
default=2,
metavar="<depth>",
type="int",
help="Use separate colors up to package depth of <depth>",
),
),
(
"ignore",
dict(
type="csv",
metavar="<file[,file...]>",
dest="ignore_list",
default=("CVS",),
help="Files or directories to be skipped. They should be base names, not paths.",
),
),
(
"project",
dict(
default="",
type="string",
short="p",
metavar="<project name>",
help="set the project name.",
),
),
(
"output-directory",
dict(
default="",
type="string",
short="d",
action="store",
metavar="<output_directory>",
help="set the output directory path.",
),
),
)
class Run(ConfigurationMixIn):
"""base class providing common behaviour for pyreverse commands"""
options = OPTIONS
def __init__(self, args: Iterable[str]):
ConfigurationMixIn.__init__(self, usage=__doc__)
insert_default_options()
args = self.load_command_line_configuration(args)
if self.config.output_format not in ("dot", "vcg"):
check_graphviz_availability()
sys.exit(self.run(args))
def run(self, args):
"""checking arguments and run project"""
if not args:
print(self.help())
return 1
# insert current working directory to the python path to recognize
# dependencies to local modules even if cwd is not in the PYTHONPATH
sys.path.insert(0, os.getcwd())
try:
project = project_from_files(
args,
project_name=self.config.project,
black_list=self.config.ignore_list,
)
linker = Linker(project, tag=True)
handler = DiadefsHandler(self.config)
diadefs = handler.get_diadefs(project, linker)
finally:
sys.path.pop(0)
writer.DiagramWriter(self.config).write(diadefs)
return 0
if __name__ == "__main__":
Run(sys.argv[1:])
|
