diff -r 2bd590c40309 -r 397f385b95d8 src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html --- a/src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html Thu Dec 08 18:03:42 2022 +0100 +++ b/src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html Thu Dec 08 18:04:00 2022 +0100 @@ -41,7 +41,7 @@ <h3>Global Attributes</h3> <table> -<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> +<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> </table> <h3>Classes</h3> @@ -109,12 +109,16 @@ <td></td> </tr> <tr> +<td><a href="#filter_string">filter_string</a></td> +<td></td> +</tr> +<tr> <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td> <td></td> </tr> <tr> <td><a href="#get_installed_distributions">get_installed_distributions</a></td> -<td></td> +<td>Function to get the installed packages via pip.</td> </tr> <tr> <td><a href="#get_output_fields">get_output_fields</a></td> @@ -187,7 +191,7 @@ <a NAME="CompatibleArgumentParser.parse_args" ID="CompatibleArgumentParser.parse_args"></a> <h4>CompatibleArgumentParser.parse_args</h4> -<b>parse_args</b>(<i>args: Optional[Sequence[Text]] = None, namespace: CustomNamespace = None</i>) +<b>parse_args</b>(<i>args: None | Sequence[str] = None, namespace: None | CustomNamespace = None, </i>) <div align="right"><a href="#top">Up</a></div> <hr /> @@ -236,7 +240,7 @@ <a NAME="CustomHelpFormatter.__init__" ID="CustomHelpFormatter.__init__"></a> <h4>CustomHelpFormatter (Constructor)</h4> -<b>CustomHelpFormatter</b>(<i>prog: Text, indent_increment: int = 2, max_help_position: int = 24, width: Optional[int] = None</i>) +<b>CustomHelpFormatter</b>(<i>prog: str, indent_increment: int = 2, max_help_position: int = 24, width: Optional[int] = None, </i>) <a NAME="CustomHelpFormatter._expand_help" ID="CustomHelpFormatter._expand_help"></a> <h4>CustomHelpFormatter._expand_help</h4> @@ -248,7 +252,7 @@ <a NAME="CustomHelpFormatter._split_lines" ID="CustomHelpFormatter._split_lines"></a> <h4>CustomHelpFormatter._split_lines</h4> -<b>_split_lines</b>(<i>text: Text, width: int</i>) +<b>_split_lines</b>(<i>text: str, width: int</i>) <div align="right"><a href="#top">Up</a></div> <hr /> @@ -409,14 +413,14 @@ <a NAME="SelectAction.__call__" ID="SelectAction.__call__"></a> <h4>SelectAction.__call__</h4> -<b>__call__</b>(<i>parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: Text, option_string: Optional[Text] = None, </i>) +<b>__call__</b>(<i>parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: str, option_string: Optional[str] = None, </i>) <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="choices_from_enum" ID="choices_from_enum"></a> <h2>choices_from_enum</h2> -<b>choices_from_enum</b>(<i>enum_cls: NoValueEnum</i>) +<b>choices_from_enum</b>(<i>enum_cls: Type[NoValueEnum]</i>) <div align="right"><a href="#top">Up</a></div> <hr /> @@ -463,9 +467,16 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="filter_string" ID="filter_string"></a> +<h2>filter_string</h2> +<b>filter_string</b>(<i>item: str</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="find_license_from_classifier" ID="find_license_from_classifier"></a> <h2>find_license_from_classifier</h2> -<b>find_license_from_classifier</b>(<i>message</i>) +<b>find_license_from_classifier</b>(<i>classifiers: list[str]</i>) <div align="right"><a href="#top">Up</a></div> <hr /> @@ -474,26 +485,56 @@ <h2>get_installed_distributions</h2> <b>get_installed_distributions</b>(<i>local_only=True, user_only=False</i>) +<p> + Function to get the installed packages via pip. +</p> +<p> + Note: importlib_metadata.distributions() does not respect + 'local_only' and 'user_only' keyword parameters. +</p> +<dl> + +<dt><i>local_only</i> (TYPE (optional))</dt> +<dd> +DESCRIPTION (defaults to True) +</dd> +<dt><i>user_only</i> (TYPE (optional))</dt> +<dd> +DESCRIPTION (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +DESCRIPTION +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +TYPE +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="get_output_fields" ID="get_output_fields"></a> <h2>get_output_fields</h2> -<b>get_output_fields</b>(<i>args: "CustomNamespace"</i>) +<b>get_output_fields</b>(<i>args: CustomNamespace</i>) <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="get_packages" ID="get_packages"></a> <h2>get_packages</h2> -<b>get_packages</b>(<i>args: "CustomNamespace"</i>) +<b>get_packages</b>(<i>args: CustomNamespace, </i>) <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="get_pkg_included_file" ID="get_pkg_included_file"></a> <h2>get_pkg_included_file</h2> -<b>get_pkg_included_file</b>(<i>pkg, file_names</i>) +<b>get_pkg_included_file</b>(<i>pkg, file_names_rgx: str</i>) <p> Attempt to find the package's included file on disk and return the @@ -518,7 +559,7 @@ <hr /> <a NAME="select_license_by_source" ID="select_license_by_source"></a> <h2>select_license_by_source</h2> -<b>select_license_by_source</b>(<i>from_source, license_classifier, license_meta</i>) +<b>select_license_by_source</b>(<i>from_source: FromArg, license_classifier: list[str], license_meta: str</i>) <div align="right"><a href="#top">Up</a></div> <hr />