Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 9596
397f385b95d8
parent 9311
8e588f403fd9
child 9850
20c49b517679
equal deleted inserted replaced
9595:2bd590c40309 9596:397f385b95d8
39 SOFTWARE. 39 SOFTWARE.
40 </p> 40 </p>
41 <h3>Global Attributes</h3> 41 <h3>Global Attributes</h3>
42 42
43 <table> 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> 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_FIELD_NAMES</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> 45 </table>
46 <h3>Classes</h3> 46 <h3>Classes</h3>
47 47
48 <table> 48 <table>
49 49
107 <tr> 107 <tr>
108 <td><a href="#enum_key_to_value">enum_key_to_value</a></td> 108 <td><a href="#enum_key_to_value">enum_key_to_value</a></td>
109 <td></td> 109 <td></td>
110 </tr> 110 </tr>
111 <tr> 111 <tr>
112 <td><a href="#filter_string">filter_string</a></td>
113 <td></td>
114 </tr>
115 <tr>
112 <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td> 116 <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td>
113 <td></td> 117 <td></td>
114 </tr> 118 </tr>
115 <tr> 119 <tr>
116 <td><a href="#get_installed_distributions">get_installed_distributions</a></td> 120 <td><a href="#get_installed_distributions">get_installed_distributions</a></td>
117 <td></td> 121 <td>Function to get the installed packages via pip.</td>
118 </tr> 122 </tr>
119 <tr> 123 <tr>
120 <td><a href="#get_output_fields">get_output_fields</a></td> 124 <td><a href="#get_output_fields">get_output_fields</a></td>
121 <td></td> 125 <td></td>
122 </tr> 126 </tr>
185 <h4>CompatibleArgumentParser._verify_args</h4> 189 <h4>CompatibleArgumentParser._verify_args</h4>
186 <b>_verify_args</b>(<i>args: CustomNamespace</i>) 190 <b>_verify_args</b>(<i>args: CustomNamespace</i>)
187 191
188 <a NAME="CompatibleArgumentParser.parse_args" ID="CompatibleArgumentParser.parse_args"></a> 192 <a NAME="CompatibleArgumentParser.parse_args" ID="CompatibleArgumentParser.parse_args"></a>
189 <h4>CompatibleArgumentParser.parse_args</h4> 193 <h4>CompatibleArgumentParser.parse_args</h4>
190 <b>parse_args</b>(<i>args: Optional[Sequence[Text]] = None, namespace: CustomNamespace = None</i>) 194 <b>parse_args</b>(<i>args: None | Sequence[str] = None, namespace: None | CustomNamespace = None, </i>)
191 195
192 <div align="right"><a href="#top">Up</a></div> 196 <div align="right"><a href="#top">Up</a></div>
193 <hr /> 197 <hr />
194 <hr /> 198 <hr />
195 <a NAME="CustomHelpFormatter" ID="CustomHelpFormatter"></a> 199 <a NAME="CustomHelpFormatter" ID="CustomHelpFormatter"></a>
234 <tr><td>None</td></tr> 238 <tr><td>None</td></tr>
235 </table> 239 </table>
236 240
237 <a NAME="CustomHelpFormatter.__init__" ID="CustomHelpFormatter.__init__"></a> 241 <a NAME="CustomHelpFormatter.__init__" ID="CustomHelpFormatter.__init__"></a>
238 <h4>CustomHelpFormatter (Constructor)</h4> 242 <h4>CustomHelpFormatter (Constructor)</h4>
239 <b>CustomHelpFormatter</b>(<i>prog: Text, indent_increment: int = 2, max_help_position: int = 24, width: Optional[int] = None</i>) 243 <b>CustomHelpFormatter</b>(<i>prog: str, indent_increment: int = 2, max_help_position: int = 24, width: Optional[int] = None, </i>)
240 244
241 <a NAME="CustomHelpFormatter._expand_help" ID="CustomHelpFormatter._expand_help"></a> 245 <a NAME="CustomHelpFormatter._expand_help" ID="CustomHelpFormatter._expand_help"></a>
242 <h4>CustomHelpFormatter._expand_help</h4> 246 <h4>CustomHelpFormatter._expand_help</h4>
243 <b>_expand_help</b>(<i>action: argparse.Action</i>) 247 <b>_expand_help</b>(<i>action: argparse.Action</i>)
244 248
246 <h4>CustomHelpFormatter._format_action</h4> 250 <h4>CustomHelpFormatter._format_action</h4>
247 <b>_format_action</b>(<i>action: argparse.Action</i>) 251 <b>_format_action</b>(<i>action: argparse.Action</i>)
248 252
249 <a NAME="CustomHelpFormatter._split_lines" ID="CustomHelpFormatter._split_lines"></a> 253 <a NAME="CustomHelpFormatter._split_lines" ID="CustomHelpFormatter._split_lines"></a>
250 <h4>CustomHelpFormatter._split_lines</h4> 254 <h4>CustomHelpFormatter._split_lines</h4>
251 <b>_split_lines</b>(<i>text: Text, width: int</i>) 255 <b>_split_lines</b>(<i>text: str, width: int</i>)
252 256
253 <div align="right"><a href="#top">Up</a></div> 257 <div align="right"><a href="#top">Up</a></div>
254 <hr /> 258 <hr />
255 <hr /> 259 <hr />
256 <a NAME="CustomNamespace" ID="CustomNamespace"></a> 260 <a NAME="CustomNamespace" ID="CustomNamespace"></a>
407 <tr><td>None</td></tr> 411 <tr><td>None</td></tr>
408 </table> 412 </table>
409 413
410 <a NAME="SelectAction.__call__" ID="SelectAction.__call__"></a> 414 <a NAME="SelectAction.__call__" ID="SelectAction.__call__"></a>
411 <h4>SelectAction.__call__</h4> 415 <h4>SelectAction.__call__</h4>
412 <b>__call__</b>(<i>parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: Text, option_string: Optional[Text] = None, </i>) 416 <b>__call__</b>(<i>parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: str, option_string: Optional[str] = None, </i>)
413 417
414 <div align="right"><a href="#top">Up</a></div> 418 <div align="right"><a href="#top">Up</a></div>
415 <hr /> 419 <hr />
416 <hr /> 420 <hr />
417 <a NAME="choices_from_enum" ID="choices_from_enum"></a> 421 <a NAME="choices_from_enum" ID="choices_from_enum"></a>
418 <h2>choices_from_enum</h2> 422 <h2>choices_from_enum</h2>
419 <b>choices_from_enum</b>(<i>enum_cls: NoValueEnum</i>) 423 <b>choices_from_enum</b>(<i>enum_cls: Type[NoValueEnum]</i>)
420 424
421 <div align="right"><a href="#top">Up</a></div> 425 <div align="right"><a href="#top">Up</a></div>
422 <hr /> 426 <hr />
423 <hr /> 427 <hr />
424 <a NAME="create_licenses_list" ID="create_licenses_list"></a> 428 <a NAME="create_licenses_list" ID="create_licenses_list"></a>
461 <b>enum_key_to_value</b>(<i>enum_key: Enum</i>) 465 <b>enum_key_to_value</b>(<i>enum_key: Enum</i>)
462 466
463 <div align="right"><a href="#top">Up</a></div> 467 <div align="right"><a href="#top">Up</a></div>
464 <hr /> 468 <hr />
465 <hr /> 469 <hr />
470 <a NAME="filter_string" ID="filter_string"></a>
471 <h2>filter_string</h2>
472 <b>filter_string</b>(<i>item: str</i>)
473
474 <div align="right"><a href="#top">Up</a></div>
475 <hr />
476 <hr />
466 <a NAME="find_license_from_classifier" ID="find_license_from_classifier"></a> 477 <a NAME="find_license_from_classifier" ID="find_license_from_classifier"></a>
467 <h2>find_license_from_classifier</h2> 478 <h2>find_license_from_classifier</h2>
468 <b>find_license_from_classifier</b>(<i>message</i>) 479 <b>find_license_from_classifier</b>(<i>classifiers: list[str]</i>)
469 480
470 <div align="right"><a href="#top">Up</a></div> 481 <div align="right"><a href="#top">Up</a></div>
471 <hr /> 482 <hr />
472 <hr /> 483 <hr />
473 <a NAME="get_installed_distributions" ID="get_installed_distributions"></a> 484 <a NAME="get_installed_distributions" ID="get_installed_distributions"></a>
474 <h2>get_installed_distributions</h2> 485 <h2>get_installed_distributions</h2>
475 <b>get_installed_distributions</b>(<i>local_only=True, user_only=False</i>) 486 <b>get_installed_distributions</b>(<i>local_only=True, user_only=False</i>)
476 487
488 <p>
489 Function to get the installed packages via pip.
490 </p>
491 <p>
492 Note: importlib_metadata.distributions() does not respect
493 'local_only' and 'user_only' keyword parameters.
494 </p>
495 <dl>
496
497 <dt><i>local_only</i> (TYPE (optional))</dt>
498 <dd>
499 DESCRIPTION (defaults to True)
500 </dd>
501 <dt><i>user_only</i> (TYPE (optional))</dt>
502 <dd>
503 DESCRIPTION (defaults to False)
504 </dd>
505 </dl>
506 <dl>
507 <dt>Return:</dt>
508 <dd>
509 DESCRIPTION
510 </dd>
511 </dl>
512 <dl>
513 <dt>Return Type:</dt>
514 <dd>
515 TYPE
516 </dd>
517 </dl>
477 <div align="right"><a href="#top">Up</a></div> 518 <div align="right"><a href="#top">Up</a></div>
478 <hr /> 519 <hr />
479 <hr /> 520 <hr />
480 <a NAME="get_output_fields" ID="get_output_fields"></a> 521 <a NAME="get_output_fields" ID="get_output_fields"></a>
481 <h2>get_output_fields</h2> 522 <h2>get_output_fields</h2>
482 <b>get_output_fields</b>(<i>args: "CustomNamespace"</i>) 523 <b>get_output_fields</b>(<i>args: CustomNamespace</i>)
483 524
484 <div align="right"><a href="#top">Up</a></div> 525 <div align="right"><a href="#top">Up</a></div>
485 <hr /> 526 <hr />
486 <hr /> 527 <hr />
487 <a NAME="get_packages" ID="get_packages"></a> 528 <a NAME="get_packages" ID="get_packages"></a>
488 <h2>get_packages</h2> 529 <h2>get_packages</h2>
489 <b>get_packages</b>(<i>args: "CustomNamespace"</i>) 530 <b>get_packages</b>(<i>args: CustomNamespace, </i>)
490 531
491 <div align="right"><a href="#top">Up</a></div> 532 <div align="right"><a href="#top">Up</a></div>
492 <hr /> 533 <hr />
493 <hr /> 534 <hr />
494 <a NAME="get_pkg_included_file" ID="get_pkg_included_file"></a> 535 <a NAME="get_pkg_included_file" ID="get_pkg_included_file"></a>
495 <h2>get_pkg_included_file</h2> 536 <h2>get_pkg_included_file</h2>
496 <b>get_pkg_included_file</b>(<i>pkg, file_names</i>) 537 <b>get_pkg_included_file</b>(<i>pkg, file_names_rgx: str</i>)
497 538
498 <p> 539 <p>
499 Attempt to find the package's included file on disk and return the 540 Attempt to find the package's included file on disk and return the
500 tuple (included_file_path, included_file_contents). 541 tuple (included_file_path, included_file_contents).
501 </p> 542 </p>
516 <div align="right"><a href="#top">Up</a></div> 557 <div align="right"><a href="#top">Up</a></div>
517 <hr /> 558 <hr />
518 <hr /> 559 <hr />
519 <a NAME="select_license_by_source" ID="select_license_by_source"></a> 560 <a NAME="select_license_by_source" ID="select_license_by_source"></a>
520 <h2>select_license_by_source</h2> 561 <h2>select_license_by_source</h2>
521 <b>select_license_by_source</b>(<i>from_source, license_classifier, license_meta</i>) 562 <b>select_license_by_source</b>(<i>from_source: FromArg, license_classifier: list[str], license_meta: str</i>)
522 563
523 <div align="right"><a href="#top">Up</a></div> 564 <div align="right"><a href="#top">Up</a></div>
524 <hr /> 565 <hr />
525 <hr /> 566 <hr />
526 <a NAME="value_to_enum_key" ID="value_to_enum_key"></a> 567 <a NAME="value_to_enum_key" ID="value_to_enum_key"></a>

Mercurial Repository: eric

eric ide

mercurial