forked from ProjectQ-Framework/ProjectQ
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage_description.py
More file actions
182 lines (158 loc) · 7.16 KB
/
package_description.py
File metadata and controls
182 lines (158 loc) · 7.16 KB
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
# -*- coding: utf-8 -*-
# Copyright 2017 ProjectQ-Framework (www.projectq.ch)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Module containing some helper classes for generating the documentation."""
import importlib
import inspect
import pkgutil
class PackageDescription: # pylint: disable=too-many-instance-attributes,too-few-public-methods
"""A package description class."""
package_list = []
def __init__( # pylint: disable=too-many-arguments
self,
pkg_name,
desc='',
module_special_members='__init__',
submodule_special_members='',
submodules_desc='',
helper_submodules=None,
):
"""
Initialize a PackageDescription object.
Args:
name (str): Name of ProjectQ module
desc (str): (optional) Description of module
module_special_members (str): (optional) Special members to include in the documentation of the module
submodule_special_members (str): (optional) Special members to include in the documentation of submodules
submodules_desc (str): (optional) Description to print out before the list of submodules
helper_submodules (list): (optional) List of tuples for helper sub-modules to include in the
documentation.
Tuples are (section_title, submodukle_name, automodule_properties)
"""
self.name = pkg_name
self.desc = desc
if pkg_name not in PackageDescription.package_list:
PackageDescription.package_list.append(pkg_name)
self.module = importlib.import_module('projectq.{}'.format(self.name))
self.module_special_members = module_special_members
self.submodule_special_members = submodule_special_members
self.submodules_desc = submodules_desc
self.helper_submodules = helper_submodules
sub = []
for _, module_name, _ in pkgutil.iter_modules(self.module.__path__, self.module.__name__ + '.'):
if not module_name.endswith('_test'):
try:
idx = len(self.module.__name__) + 1
sub.append((module_name[idx:], importlib.import_module(module_name)))
except ImportError:
pass
self.subpackages = []
self.submodules = []
for name, obj in sub:
if '{}.{}'.format(self.name, name) in PackageDescription.package_list:
self.subpackages.append((name, obj))
else:
self.submodules.append((name, obj))
self.subpackages.sort(key=lambda x: x[0].lower())
self.submodules.sort(key=lambda x: x[0].lower())
self.members = [
(name, obj)
for name, obj in inspect.getmembers(
self.module,
lambda obj: (
inspect.isclass(obj)
or inspect.isfunction(obj)
or isinstance(obj, (int, float, tuple, list, dict, set, frozenset, str))
),
)
if name[0] != '_'
]
self.members.sort(key=lambda x: x[0].lower())
def get_ReST(self): # pylint: disable=invalid-name,too-many-branches,too-many-statements
"""Conversion to ReST formatted string."""
new_lines = []
new_lines.append(self.name)
new_lines.append('=' * len(self.name))
new_lines.append('')
if self.desc:
new_lines.append(self.desc.strip())
new_lines.append('')
submodule_has_index = False
if self.subpackages:
new_lines.append('Subpackages')
new_lines.append('-' * len(new_lines[-1]))
new_lines.append('')
new_lines.append('.. toctree::')
new_lines.append(' :maxdepth: 1')
new_lines.append('')
for name, _ in self.subpackages:
new_lines.append(' projectq.{}.{}'.format(self.name, name))
new_lines.append('')
else:
submodule_has_index = True
new_lines.append('.. autosummary::')
new_lines.append('')
if self.submodules:
for name, _ in self.submodules:
new_lines.append('\tprojectq.{}.{}'.format(self.name, name))
new_lines.append('')
if self.members:
for name, _ in self.members:
new_lines.append('\tprojectq.{}.{}'.format(self.name, name))
new_lines.append('')
if self.submodules:
new_lines.append('Submodules')
new_lines.append('-' * len(new_lines[-1]))
new_lines.append('')
if self.submodules_desc:
new_lines.append(self.submodules_desc.strip())
new_lines.append('')
if not submodule_has_index:
new_lines.append('.. autosummary::')
new_lines.append('')
for name, _ in self.submodules:
new_lines.append(' projectq.{}.{}'.format(self.name, name))
new_lines.append('')
for name, _ in self.submodules:
new_lines.append(name)
new_lines.append('^' * len(new_lines[-1]))
new_lines.append('')
new_lines.append('.. automodule:: projectq.{}.{}'.format(self.name, name))
new_lines.append(' :members:')
if self.submodule_special_members:
new_lines.append(' :special-members: {}'.format(self.submodule_special_members))
new_lines.append(' :undoc-members:')
new_lines.append('')
new_lines.append('Module contents')
new_lines.append('-' * len(new_lines[-1]))
new_lines.append('')
new_lines.append('.. automodule:: projectq.{}'.format(self.name))
new_lines.append(' :members:')
new_lines.append(' :undoc-members:')
new_lines.append(' :special-members: {}'.format(self.module_special_members))
new_lines.append(' :imported-members:')
new_lines.append('')
if self.helper_submodules:
new_lines.append('Helper sub-modules')
new_lines.append('-' * len(new_lines[-1]))
new_lines.append('')
for title, name, params in self.helper_submodules:
new_lines.append(title)
new_lines.append('^' * len(title))
new_lines.append('')
new_lines.append('.. automodule:: projectq.{}.{}'.format(self.name, name))
for param in params:
new_lines.append(' {}'.format(param))
new_lines.append('')
return new_lines[:-1]