-
Notifications
You must be signed in to change notification settings - Fork 0
/
packager_markdown.py
219 lines (169 loc) · 9.13 KB
/
packager_markdown.py
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
from generallibrary import Markdown, floor, Date, deco_cache, ObjInfo, flatten, exclusive
from generalfile import Path
import re
class _PackagerMarkdown:
""" Contains methods to generate readme sections from arguments. """
def get_badges_dict(self):
""" Get badges as a dict.
:param generalpackager.Packager self: """
return {
"UnitTests": f"[](https://github.com/ManderaGeneral/{self.name}/actions)",
"Commit": f"",
"Release": f"[](https://pypi.org/project/{self.name}/)",
"Python": f"[](https://pypi.python.org/pypi/{self.name}/)",
"Operating System": f"[}-blue.svg)](https://shields.io/)",
}
def _create_todo_dict(self, text, path, line):
""" :param generalpackager.Packager self: """
path = Path(path)
return {
"Package": Markdown.link(text=self.name, url=self.github.url),
"Module": self.github_link_path_line(text=path.name(), path=path, line=1),
"Message": self.github_link_path_line(text=text, path=path, line=line),
}
def _get_codeline_todos(self):
""" :param generalpackager.Packager self: """
todos = []
for path in self.path.get_children(depth=-1, gen=True):
if path.match(*self.git_exclude_lines, "shelved.patch", "readme.md"):
continue
try:
text = path.text.read()
except:
continue
relative_path = path.relative(self.path)
for i, line in enumerate(text.splitlines()):
result = re.findall("todo+: (.+)", line, re.I)
if result:
text = re.sub('[" ]*$', "", result[0])
todos.append(self._create_todo_dict(text=text, path=relative_path, line=i + 1))
return todos
def _get_untested_todos(self):
""" :param generalpackager.Packager self: """
todos = []
for name, objInfo in self.get_untested_objInfo_dict().items(): # type: ObjInfo
text = f"[UnitTest] for {repr(objInfo)}"
path = objInfo.file(relative=True)
line = objInfo.get_definition_line()
todos.append(self._create_todo_dict(text=text, path=path, line=line))
return todos
@deco_cache()
def get_todos(self):
""" Get a list of dicts containing cleaned up todos.
:param generalpackager.Packager self:
:rtype: dict[list[str]] """
return self._get_codeline_todos() + self._get_untested_todos()
def get_todos_markdown(self, *packagers, drop_package_col=False):
""" :param generalpackager.Packager self:
:param drop_package_col: """
todos = flatten([packager.get_todos() for packager in packagers])
if drop_package_col:
todos = [exclusive(todo, "Package") for todo in todos]
markdown = Markdown(header=self._todo_header)
if todos:
markdown.add_table_lines(*todos)
else:
markdown.add_node("No todos!")
return markdown
def get_description_markdown(self):
""" :param generalpackager.Packager self: """
part_of = f"This package and {len(self.get_all()) - 1} other make up {Markdown.link(text='ManderaGeneral', url='https://github.com/ManderaGeneral')}."
return Markdown(self.localrepo.description, "\n", part_of, header=self.name)
def get_information_markdown(self, *packagers):
""" Get information table.
:param generalpackager.Packager self: """
if not packagers:
packagers = (self, )
markdown = Markdown(header="Information")
python_url = "https://www.python.org/downloads/release/python-"
list_of_dicts = []
for packager in packagers:
attrs = packager._get_attributes_view().count("\n")
untested_attrs = len(packager.get_untested_objInfo_dict())
test_percentage = floor((attrs - untested_attrs) / attrs * 100, 1) if attrs else 100
list_of_dicts.append({
"Package": Markdown.link(text=packager.name, url=packager.github.url),
"Ver": Markdown.link(text=packager.localrepo.version, url=packager.pypi.url),
"Latest Release": packager.get_latest_release(),
"Python": ", ".join([Markdown.link(text=ver, url=f"{python_url}{str(ver).replace('.', '')}0/") for ver in packager.python]),
"Platform": ", ".join(map(str.capitalize, packager.os)),
"Lvl": packager.get_ordered_index(),
"Todo": Markdown.link(text=len(packager.get_todos()), url=f"{packager.github.url}#{self._todo_header}"),
"Tests": f"{test_percentage} %",
})
markdown.add_table_lines(*list_of_dicts, sort_by=["Lvl", "Package"])
return markdown
def get_installation_markdown(self):
""" Get install markdown.
:param generalpackager.Packager self: """
markdown = Markdown(header="Installation")
dependencies_required = self.localrepo.install_requires.copy()
dependencies_optional = list(set().union(*self.localrepo.extras_require.values()))
dependencies_optional.sort()
options = {self.name: dependencies_required}
options.update({f"{self.name}[{key}]": value + dependencies_required for key, value in self.localrepo.extras_require.items()})
list_of_dicts = []
for command, packages in options.items():
row = {"Command": f"`pip install {command}`"}
for dependency in dependencies_required + dependencies_optional:
row[Markdown.link(dependency, url=f"https://pypi.org/project/{dependency}", href=True)] = "Yes" if dependency in packages else "No"
list_of_dicts.append(row)
markdown.add_table_lines(*list_of_dicts)
return markdown
def _configure_contents_markdown(self, markdown):
""" Configure table of contents lines from markdown.
:param generalpackager.Packager self:
:param markdown: """
parent_markdown = markdown.get_parent(-1, -1)
markdown.add_pre_lines(parent_markdown.view(custom_repr=lambda md: md.link(md.header, href=True), print_out=False))
return markdown
def github_link(self, text, suffix):
""" Get an HREF link to this repo's github.
:param generalpackager.Packager self:
:param text: Text to be clickable.
:param suffix: URL suffix. """
url = f"{self.github.url}/{suffix}"
return Markdown.link(text=text, url=url, href=True)
def github_link_path_line(self, text, path, line=None):
""" :param generalpackager.Packager self:
:param text:
:param path:
:param line: """
if line is None:
line = 1
path = Path(path)
return self.github_link(text=text, suffix=f"blob/{self.commit_sha}/{path.encode()}#L{line}")
def _attr_repr(self, objInfo):
""" Return a nice representation of each attribute made by this module, in this case a link to code definition.
:param generalpackager.Packager self:
:param generallibrary.ObjInfo objInfo: """
text = repr(objInfo)
path = objInfo.file(relative=True)
line = objInfo.get_definition_line()
string = self.github_link_path_line(text=text, path=path, line=line)
if objInfo.name in self.get_untested_objInfo_dict():
string = f"{string} <b>(Untested)</b>"
return string
def _get_attributes_view(self):
""" :param generalpackager.Packager self: """
if self.localmodule.module is None:
return "No module to get attributes"
return self._cache_get_attributes_view(self.commit_sha)
@deco_cache()
def _cache_get_attributes_view(self, commit_sha):
""" Additional method here to store seperate cache for different commit_shas
:param generalpackager.Packager self:
:param commit_sha: """
return self.localmodule.objInfo.view(custom_repr=self._attr_repr, print_out=False)
def get_attributes_markdown(self):
""" Get a recursive view of attributes markdown.
:param generalpackager.Packager self: """
return Markdown(header="Attributes").add_pre_lines(self._get_attributes_view())
def get_footnote_markdown(self, commit=True):
""" Get a markdown for footnote containing date, time and commit link.
:param generalpackager.Packager self:
:param commit: """
line = f"Generated {Date.now()}"
if commit:
line += f" for commit {self.github_link(text=self.commit_sha, suffix=f'commit/{self.commit_sha}')}."
return Markdown(line).wrap_with_tags("sup")