Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.PipInterface.piplicenses.html

eric7/Documentation/Source/eric7.PipInterface.piplicenses.html

branch
eric7
changeset 9007
01b73d9ef09e
equal deleted inserted replaced
9006:b9e04026f9d5 9007:01b73d9ef09e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.piplicenses</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PipInterface.piplicenses</h1>
10
11 <p>
12 pip-licenses
13 </p>
14 <p>
15 MIT License
16 </p>
17 <p>
18 Copyright (c) 2018 raimon
19 </p>
20 <p>
21 Permission is hereby granted, free of charge, to any person obtaining a copy
22 of this software and associated documentation files (the "Software"), to deal
23 in the Software without restriction, including without limitation the rights
24 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
25 copies of the Software, and to permit persons to whom the Software is
26 furnished to do so, subject to the following conditions:
27 </p>
28 <p>
29 The above copyright notice and this permission notice shall be included in all
30 copies or substantial portions of the Software.
31 </p>
32 <p>
33 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39 SOFTWARE.
40 </p>
41 <h3>Global Attributes</h3>
42
43 <table>
44 <tr><td>DEFAULT_OUTPUT_FIELDS</td></tr><tr><td>FIELDS_TO_METADATA_KEYS</td></tr><tr><td>FIELD_NAMES</td></tr><tr><td>LICENSE_UNKNOWN</td></tr><tr><td>MAP_DEST_TO_ENUM</td></tr><tr><td>METADATA_KEYS</td></tr><tr><td>SUMMARY_OUTPUT_FIELDS</td></tr><tr><td>SYSTEM_PACKAGES</td></tr><tr><td>__author__</td></tr><tr><td>__license__</td></tr><tr><td>__pkgname__</td></tr><tr><td>__summary__</td></tr><tr><td>__url__</td></tr><tr><td>__version__</td></tr>
45 </table>
46 <h3>Classes</h3>
47
48 <table>
49
50 <tr>
51 <td><a href="#CompatibleArgumentParser">CompatibleArgumentParser</a></td>
52 <td></td>
53 </tr>
54 <tr>
55 <td><a href="#CustomHelpFormatter">CustomHelpFormatter</a></td>
56 <td></td>
57 </tr>
58 <tr>
59 <td><a href="#CustomNamespace">CustomNamespace</a></td>
60 <td></td>
61 </tr>
62 <tr>
63 <td><a href="#FromArg">FromArg</a></td>
64 <td></td>
65 </tr>
66 <tr>
67 <td><a href="#NoValueEnum">NoValueEnum</a></td>
68 <td></td>
69 </tr>
70 <tr>
71 <td><a href="#OrderArg">OrderArg</a></td>
72 <td></td>
73 </tr>
74 <tr>
75 <td><a href="#SelectAction">SelectAction</a></td>
76 <td></td>
77 </tr>
78 </table>
79 <h3>Functions</h3>
80
81 <table>
82
83 <tr>
84 <td><a href="#choices_from_enum">choices_from_enum</a></td>
85 <td></td>
86 </tr>
87 <tr>
88 <td><a href="#create_licenses_list">create_licenses_list</a></td>
89 <td></td>
90 </tr>
91 <tr>
92 <td><a href="#create_output_string">create_output_string</a></td>
93 <td></td>
94 </tr>
95 <tr>
96 <td><a href="#create_parser">create_parser</a></td>
97 <td></td>
98 </tr>
99 <tr>
100 <td><a href="#create_summary_list">create_summary_list</a></td>
101 <td></td>
102 </tr>
103 <tr>
104 <td><a href="#enum_key_to_value">enum_key_to_value</a></td>
105 <td></td>
106 </tr>
107 <tr>
108 <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td>
109 <td></td>
110 </tr>
111 <tr>
112 <td><a href="#get_installed_distributions">get_installed_distributions</a></td>
113 <td></td>
114 </tr>
115 <tr>
116 <td><a href="#get_output_fields">get_output_fields</a></td>
117 <td></td>
118 </tr>
119 <tr>
120 <td><a href="#get_packages">get_packages</a></td>
121 <td></td>
122 </tr>
123 <tr>
124 <td><a href="#get_pkg_included_file">get_pkg_included_file</a></td>
125 <td>Attempt to find the package's included file on disk and return the tuple (included_file_path, included_file_contents).</td>
126 </tr>
127 <tr>
128 <td><a href="#get_pkg_info">get_pkg_info</a></td>
129 <td></td>
130 </tr>
131 <tr>
132 <td><a href="#main">main</a></td>
133 <td></td>
134 </tr>
135 <tr>
136 <td><a href="#select_license_by_source">select_license_by_source</a></td>
137 <td></td>
138 </tr>
139 <tr>
140 <td><a href="#value_to_enum_key">value_to_enum_key</a></td>
141 <td></td>
142 </tr>
143 </table>
144 <hr />
145 <hr />
146 <a NAME="CompatibleArgumentParser" ID="CompatibleArgumentParser"></a>
147 <h2>CompatibleArgumentParser</h2>
148
149 <h3>Derived from</h3>
150 argparse.ArgumentParser
151 <h3>Class Attributes</h3>
152
153 <table>
154 <tr><td>None</td></tr>
155 </table>
156 <h3>Class Methods</h3>
157
158 <table>
159 <tr><td>None</td></tr>
160 </table>
161 <h3>Methods</h3>
162
163 <table>
164
165 <tr>
166 <td><a href="#CompatibleArgumentParser._verify_args">_verify_args</a></td>
167 <td></td>
168 </tr>
169 <tr>
170 <td><a href="#CompatibleArgumentParser.parse_args">parse_args</a></td>
171 <td></td>
172 </tr>
173 </table>
174 <h3>Static Methods</h3>
175
176 <table>
177 <tr><td>None</td></tr>
178 </table>
179
180 <a NAME="CompatibleArgumentParser._verify_args" ID="CompatibleArgumentParser._verify_args"></a>
181 <h4>CompatibleArgumentParser._verify_args</h4>
182 <b>_verify_args</b>(<i>args: CustomNamespace</i>)
183
184 <a NAME="CompatibleArgumentParser.parse_args" ID="CompatibleArgumentParser.parse_args"></a>
185 <h4>CompatibleArgumentParser.parse_args</h4>
186 <b>parse_args</b>(<i>args: Optional[Sequence[Text]] = None, namespace: CustomNamespace = None</i>)
187
188 <div align="right"><a href="#top">Up</a></div>
189 <hr />
190 <hr />
191 <a NAME="CustomHelpFormatter" ID="CustomHelpFormatter"></a>
192 <h2>CustomHelpFormatter</h2>
193
194 <h3>Derived from</h3>
195 argparse.HelpFormatter
196 <h3>Class Attributes</h3>
197
198 <table>
199 <tr><td>None</td></tr>
200 </table>
201 <h3>Class Methods</h3>
202
203 <table>
204 <tr><td>None</td></tr>
205 </table>
206 <h3>Methods</h3>
207
208 <table>
209
210 <tr>
211 <td><a href="#CustomHelpFormatter.__init__">CustomHelpFormatter</a></td>
212 <td></td>
213 </tr>
214 <tr>
215 <td><a href="#CustomHelpFormatter._expand_help">_expand_help</a></td>
216 <td></td>
217 </tr>
218 <tr>
219 <td><a href="#CustomHelpFormatter._format_action">_format_action</a></td>
220 <td></td>
221 </tr>
222 <tr>
223 <td><a href="#CustomHelpFormatter._split_lines">_split_lines</a></td>
224 <td></td>
225 </tr>
226 </table>
227 <h3>Static Methods</h3>
228
229 <table>
230 <tr><td>None</td></tr>
231 </table>
232
233 <a NAME="CustomHelpFormatter.__init__" ID="CustomHelpFormatter.__init__"></a>
234 <h4>CustomHelpFormatter (Constructor)</h4>
235 <b>CustomHelpFormatter</b>(<i>prog: Text, indent_increment: int = 2, max_help_position: int = 24, width: Optional[int] = None</i>)
236
237 <a NAME="CustomHelpFormatter._expand_help" ID="CustomHelpFormatter._expand_help"></a>
238 <h4>CustomHelpFormatter._expand_help</h4>
239 <b>_expand_help</b>(<i>action: argparse.Action</i>)
240
241 <a NAME="CustomHelpFormatter._format_action" ID="CustomHelpFormatter._format_action"></a>
242 <h4>CustomHelpFormatter._format_action</h4>
243 <b>_format_action</b>(<i>action: argparse.Action</i>)
244
245 <a NAME="CustomHelpFormatter._split_lines" ID="CustomHelpFormatter._split_lines"></a>
246 <h4>CustomHelpFormatter._split_lines</h4>
247 <b>_split_lines</b>(<i>text: Text, width: int</i>)
248
249 <div align="right"><a href="#top">Up</a></div>
250 <hr />
251 <hr />
252 <a NAME="CustomNamespace" ID="CustomNamespace"></a>
253 <h2>CustomNamespace</h2>
254
255 <h3>Derived from</h3>
256 argparse.Namespace
257 <h3>Class Attributes</h3>
258
259 <table>
260 <tr><td>None</td></tr>
261 </table>
262 <h3>Class Methods</h3>
263
264 <table>
265 <tr><td>None</td></tr>
266 </table>
267 <h3>Methods</h3>
268
269 <table>
270 <tr><td>None</td></tr>
271 </table>
272 <h3>Static Methods</h3>
273
274 <table>
275 <tr><td>None</td></tr>
276 </table>
277
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 <hr />
281 <a NAME="FromArg" ID="FromArg"></a>
282 <h2>FromArg</h2>
283
284 <h3>Derived from</h3>
285 NoValueEnum
286 <h3>Class Attributes</h3>
287
288 <table>
289 <tr><td>ALL</td></tr><tr><td>CLASSIFIER</td></tr><tr><td>META</td></tr><tr><td>MIXED</td></tr>
290 </table>
291 <h3>Class Methods</h3>
292
293 <table>
294 <tr><td>None</td></tr>
295 </table>
296 <h3>Methods</h3>
297
298 <table>
299 <tr><td>None</td></tr>
300 </table>
301 <h3>Static Methods</h3>
302
303 <table>
304 <tr><td>None</td></tr>
305 </table>
306
307 <div align="right"><a href="#top">Up</a></div>
308 <hr />
309 <hr />
310 <a NAME="NoValueEnum" ID="NoValueEnum"></a>
311 <h2>NoValueEnum</h2>
312
313 <h3>Derived from</h3>
314 Enum
315 <h3>Class Attributes</h3>
316
317 <table>
318 <tr><td>None</td></tr>
319 </table>
320 <h3>Class Methods</h3>
321
322 <table>
323 <tr><td>None</td></tr>
324 </table>
325 <h3>Methods</h3>
326
327 <table>
328
329 <tr>
330 <td><a href="#NoValueEnum.__repr__">__repr__</a></td>
331 <td></td>
332 </tr>
333 </table>
334 <h3>Static Methods</h3>
335
336 <table>
337 <tr><td>None</td></tr>
338 </table>
339
340 <a NAME="NoValueEnum.__repr__" ID="NoValueEnum.__repr__"></a>
341 <h4>NoValueEnum.__repr__</h4>
342 <b>__repr__</b>(<i></i>)
343
344 <div align="right"><a href="#top">Up</a></div>
345 <hr />
346 <hr />
347 <a NAME="OrderArg" ID="OrderArg"></a>
348 <h2>OrderArg</h2>
349
350 <h3>Derived from</h3>
351 NoValueEnum
352 <h3>Class Attributes</h3>
353
354 <table>
355 <tr><td>AUTHOR</td></tr><tr><td>COUNT</td></tr><tr><td>LICENSE</td></tr><tr><td>NAME</td></tr><tr><td>URL</td></tr>
356 </table>
357 <h3>Class Methods</h3>
358
359 <table>
360 <tr><td>None</td></tr>
361 </table>
362 <h3>Methods</h3>
363
364 <table>
365 <tr><td>None</td></tr>
366 </table>
367 <h3>Static Methods</h3>
368
369 <table>
370 <tr><td>None</td></tr>
371 </table>
372
373 <div align="right"><a href="#top">Up</a></div>
374 <hr />
375 <hr />
376 <a NAME="SelectAction" ID="SelectAction"></a>
377 <h2>SelectAction</h2>
378
379 <h3>Derived from</h3>
380 argparse.Action
381 <h3>Class Attributes</h3>
382
383 <table>
384 <tr><td>None</td></tr>
385 </table>
386 <h3>Class Methods</h3>
387
388 <table>
389 <tr><td>None</td></tr>
390 </table>
391 <h3>Methods</h3>
392
393 <table>
394
395 <tr>
396 <td><a href="#SelectAction.__call__">__call__</a></td>
397 <td></td>
398 </tr>
399 </table>
400 <h3>Static Methods</h3>
401
402 <table>
403 <tr><td>None</td></tr>
404 </table>
405
406 <a NAME="SelectAction.__call__" ID="SelectAction.__call__"></a>
407 <h4>SelectAction.__call__</h4>
408 <b>__call__</b>(<i>parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: Text, option_string: Optional[Text] = None, </i>)
409
410 <div align="right"><a href="#top">Up</a></div>
411 <hr />
412 <hr />
413 <a NAME="choices_from_enum" ID="choices_from_enum"></a>
414 <h2>choices_from_enum</h2>
415 <b>choices_from_enum</b>(<i>enum_cls: NoValueEnum</i>)
416
417 <div align="right"><a href="#top">Up</a></div>
418 <hr />
419 <hr />
420 <a NAME="create_licenses_list" ID="create_licenses_list"></a>
421 <h2>create_licenses_list</h2>
422 <b>create_licenses_list</b>(<i>args: "CustomNamespace", output_fields=DEFAULT_OUTPUT_FIELDS</i>)
423
424 <div align="right"><a href="#top">Up</a></div>
425 <hr />
426 <hr />
427 <a NAME="create_output_string" ID="create_output_string"></a>
428 <h2>create_output_string</h2>
429 <b>create_output_string</b>(<i>args: "CustomNamespace"</i>)
430
431 <div align="right"><a href="#top">Up</a></div>
432 <hr />
433 <hr />
434 <a NAME="create_parser" ID="create_parser"></a>
435 <h2>create_parser</h2>
436 <b>create_parser</b>(<i></i>)
437
438 <div align="right"><a href="#top">Up</a></div>
439 <hr />
440 <hr />
441 <a NAME="create_summary_list" ID="create_summary_list"></a>
442 <h2>create_summary_list</h2>
443 <b>create_summary_list</b>(<i>args: "CustomNamespace"</i>)
444
445 <div align="right"><a href="#top">Up</a></div>
446 <hr />
447 <hr />
448 <a NAME="enum_key_to_value" ID="enum_key_to_value"></a>
449 <h2>enum_key_to_value</h2>
450 <b>enum_key_to_value</b>(<i>enum_key: Enum</i>)
451
452 <div align="right"><a href="#top">Up</a></div>
453 <hr />
454 <hr />
455 <a NAME="find_license_from_classifier" ID="find_license_from_classifier"></a>
456 <h2>find_license_from_classifier</h2>
457 <b>find_license_from_classifier</b>(<i>message</i>)
458
459 <div align="right"><a href="#top">Up</a></div>
460 <hr />
461 <hr />
462 <a NAME="get_installed_distributions" ID="get_installed_distributions"></a>
463 <h2>get_installed_distributions</h2>
464 <b>get_installed_distributions</b>(<i>local_only=True, user_only=False</i>)
465
466 <div align="right"><a href="#top">Up</a></div>
467 <hr />
468 <hr />
469 <a NAME="get_output_fields" ID="get_output_fields"></a>
470 <h2>get_output_fields</h2>
471 <b>get_output_fields</b>(<i>args: "CustomNamespace"</i>)
472
473 <div align="right"><a href="#top">Up</a></div>
474 <hr />
475 <hr />
476 <a NAME="get_packages" ID="get_packages"></a>
477 <h2>get_packages</h2>
478 <b>get_packages</b>(<i>args: "CustomNamespace"</i>)
479
480 <div align="right"><a href="#top">Up</a></div>
481 <hr />
482 <hr />
483 <a NAME="get_pkg_included_file" ID="get_pkg_included_file"></a>
484 <h2>get_pkg_included_file</h2>
485 <b>get_pkg_included_file</b>(<i>pkg, file_names</i>)
486
487 <p>
488 Attempt to find the package's included file on disk and return the
489 tuple (included_file_path, included_file_contents).
490 </p>
491 <div align="right"><a href="#top">Up</a></div>
492 <hr />
493 <hr />
494 <a NAME="get_pkg_info" ID="get_pkg_info"></a>
495 <h2>get_pkg_info</h2>
496 <b>get_pkg_info</b>(<i>pkg</i>)
497
498 <div align="right"><a href="#top">Up</a></div>
499 <hr />
500 <hr />
501 <a NAME="main" ID="main"></a>
502 <h2>main</h2>
503 <b>main</b>(<i></i>)
504
505 <div align="right"><a href="#top">Up</a></div>
506 <hr />
507 <hr />
508 <a NAME="select_license_by_source" ID="select_license_by_source"></a>
509 <h2>select_license_by_source</h2>
510 <b>select_license_by_source</b>(<i>from_source, license_classifier, license_meta</i>)
511
512 <div align="right"><a href="#top">Up</a></div>
513 <hr />
514 <hr />
515 <a NAME="value_to_enum_key" ID="value_to_enum_key"></a>
516 <h2>value_to_enum_key</h2>
517 <b>value_to_enum_key</b>(<i>value: str</i>)
518
519 <div align="right"><a href="#top">Up</a></div>
520 <hr />
521 </body></html>

Mercurial Repository: eric

eric ide

mercurial