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 | def define_argument(version: str = None) -> ArgumentParser:
"""Parse user given arguments.
Parameters
----------
version : `str`, optional
The script version. By default None.
Returns
-------
`ArgumentParser`
The object with unchecked parsed arguments.
"""
logo: str = """
▄▀▀█▄ ▄▀▀▀▀▄ ▄▀▀▀▀▄ ▄▀▀█▄▄▄▄ ▄▀▀▀▀▄ ▄▀▀▀▀▄
▐ ▄▀ ▀▄ █ █ ▐ █ █ ▐ ▐ ▄▀ ▐ █ █ ▐ █ █ ▐
█▄▄▄█ ▀▄ ▀▄ █▄▄▄▄▄ ▀▄ ▀▄
▄▀ █ ▀▄ █ ▀▄ █ █ ▌ ▀▄ █ ▀▄ █
█ ▄▀ █▀▀▀ █▀▀▀ ▄▀▄▄▄▄ █▀▀▀ █▀▀▀ ▄
▐ ▐ ▐ ▐ █ ▐ ▐ ▐
▐
_____________________________________
|""|""|""|""|""|""|""|""|""|""|""|""|"|
| 1 2 3 4 5 6 7 8 9 10 11 12 |
'-------------------------------------'
"""
print(logo[1:])
# Description of the program given when the help is cast.
description: str = """
"Assess." is a program to assess the time execution of a given script in
python. To use it, launch:
\033[7m [[NORMAL USE]] \033[0m\n
$ perfassess -s script.py \\
-f function_name \\
-o output_directory/ \\
-a argument.yml
You can actually directly test the program in the repository root
(perfassess/) using:
$ perfassess -s src/perfassess/testor.py \\
-f testor \\
-a data/argument.yml \\
-o data/
\033[7m [[PACKAGE USE]] \033[0m\n
Let us say that you want to test a package, which should have this kind of
tree structure:
package/
└── src/
├── __init__.py
└── script.py
In package, you can use relative paths. But with these, the "normal use"
method do not work. Instead, use the next command, if you are in package/,
in order to evaluate script.py:
$ perfassess -s src/script.py \\
-f function_name \\
-o output_directory/ \\
--package src/__init__.py \\
-a argument.yml
In addition of the previous "normal use" method, you have to indicate a
__init__.py file.
\033[7m [[SUBACKAGE USE]] \033[0m\n
Let us say that you want to test a subpackage, which should have this kind
of tree structure:
./package/
└── src/
├── __init__.py
└── subpackage/
├── __init__.py
└── script.py
In subpackage, you can use relative paths. But with these, the "normal use"
method do not work. But the "package use" also do not work. Instead, use
the next command, if you are in package/, in order to evaluate script.py:
$ perfassess -s src/subpackage/script.py \\
-f function_name \\
-o output_directory/ \\
--package src/__init__.py \\
--subpackage src/subpackage/__init__.py \\
-a argument.yml
In addition of the previous "normal use" and "package use" method, you have
to indicate two __init__.py files. The first one is the top package
__init__.py file. The second one is the __init__.py file of the subpackage
to test.
"""
# ===================
#
# ADD ARGUMENT PARSER
#
# ===================
# Setup the arguments parser object.
parser: object = ArgumentParser(
description=dedent(description)[1:-1],
formatter_class=RawTextHelpFormatter,
add_help=False
)
# == REQUIRED.
parser.add_argument(
"-s",
"--script",
dest="script",
required=True,
type=str,
metavar="[FILE][\".py\"]",
help=("\033[7m [[MANDATORY]] \033[0m\n > The \"scrit.py\" file to "
"assess.")
)
parser.add_argument(
"-o",
"--output",
dest="output",
required=True,
type=str,
metavar="[DIRECTORY]",
help=("\033[7m [[MANDATORY]] \033[0m\n > A folder where the "
"plots will be stored.")
)
# == OPTIONAL.
parser.add_argument(
"-h",
"--help",
action="help",
help=" > Display this help message, then exit the program."
)
parser.add_argument(
"-v",
"--version",
action="version",
version=f"Program version is {version}",
help=" > Display the program's version, then exit the\nprogram."
)
parser.add_argument(
"-f",
"--function",
dest="function",
required=False,
default="main",
type=str,
metavar="[str|main]",
help=(" > The entry point to assess a script. It have to be\nthe "
"name of a function. By default, \"main\".")
)
parser.add_argument(
"--n_field",
dest="n_field",
required=False,
default=0,
type=int,
metavar="[int|0]",
help=(" > The number of field to keep in function name. "
"By\ndefault 0.")
)
parser.add_argument(
"--package",
dest="package",
required=False,
default=None,
type=str,
metavar="[FILE][\".py\"]",
help=" > The path to an \"__init__.py\" package. By default\nNone."
)
parser.add_argument(
"--subpackage",
dest="subpackage",
required=False,
default=None,
type=str,
metavar="[FILE][\".py\"]",
help=(" > The path to an \"__init__.py\" subpackage. By\ndefault "
"None.")
)
parser.add_argument(
"-a",
"--argument",
dest="argument",
required=False,
default=None,
type=None,
metavar="[FILE][\".yml\"]",
help=(" > A YAML file containing all argument for the\nfunction to "
"test. By default None.")
)
argument: ArgumentParser = parser.parse_args()
return argument
|