From 133571ded9f4b1d07de3b4afb91677d0e1fe89c2 Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Tue, 25 Apr 2023 12:24:08 +0000 Subject: automatic import of python-docstr-coverage --- python-docstr-coverage.spec | 69 +++++++++++++++------------------------------ 1 file changed, 23 insertions(+), 46 deletions(-) (limited to 'python-docstr-coverage.spec') diff --git a/python-docstr-coverage.spec b/python-docstr-coverage.spec index 80ec3ba..692b182 100644 --- a/python-docstr-coverage.spec +++ b/python-docstr-coverage.spec @@ -1,15 +1,16 @@ %global _empty_manifest_terminate_build 0 Name: python-docstr-coverage -Version: 2.2.0 +Version: 2.3.0 Release: 1 Summary: Utility for examining python source files to ensure proper documentation. Lists missing docstrings, and calculates overall docstring coverage percentage rating. License: MIT URL: https://github.com/HunterMcGushion/docstr_coverage -Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c4/27/4c7488507c249611859af99aa280ef531a30c44c19b427cff31d28af603d/docstr-coverage-2.2.0.tar.gz +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/72/dc/11f051ee70b802c0713d5ad8f27305502117d2a13825dfaade8819ae60fb/docstr-coverage-2.3.0.tar.gz BuildArch: noarch Requires: python3-click Requires: python3-PyYAML +Requires: python3-tqdm Requires: python3-flake8 Requires: python3-black Requires: python3-isort @@ -111,16 +112,6 @@ docstr-coverage some_project/src - 3 - Also print missing docstrings (function names, class names, etc.) - 4 - Also print information about present docstrings - _--fail-under=, -F _ - Fail if under a certain percentage of coverage (default: 100.0) -- _--docstr-ignore-file=\, -d \_ - Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairs - - File content example: - - ``` - SomeFile method_to_ignore1 method_to_ignore2 method_to_ignore3 - FileWhereWeWantToIgnoreAllSpecialMethods __.+__ - .* method_to_ignore_in_all_files - a_very_important_view_file ^get$ ^set$ ^post$ - detect_.* get_val.* - ``` - _--badge=\, -b \_ - Generate a docstring coverage percent badge as an SVG saved to a given filepath - Include the badge in a repo's README using ```[![docstr_coverage]()](https://github.com/HunterMcGushion/docstr_coverage)```, @@ -131,7 +122,7 @@ docstr-coverage some_project/src #### Config File All options can be saved in a config file. A file named `.docstr.yaml` in the folder in which `docstr-coverage` is executed is picked up automatically. -Other locations can be passed using `docstr-coverage -C path/to/config.json` or the long version `--config`. +Other locations can be passed using `docstr-coverage -C path/to/config.yml` or the long version `--config`. Example: ```yaml @@ -171,8 +162,10 @@ docstr-coverage docstr_coverage -e ".*/test" --skip-magic --skip-init --badge="d Note that options passed as command line arguments have precedence over options configured in a config file. -Exception: If a `--docstr-ignore-file` is present and the yml config contains `ignore_patterns`, -a `ValueError` is raised. + +#### Ignoring by Regex +In your config files, using `ignore_patterns`, you can specify regex patterns for files names and nodes (methods, ...) +which should be ignored. See config file example above. #### Overriding by Comments Note that `docstr-coverage` can not parse @@ -205,7 +198,7 @@ and configuring the `paths` section of the [`.docstr.yaml` config](#config-file) ```yaml repos: - repo: https://github.com/HunterMcGushion/docstr_coverage - rev: v2.2.0 # most recent docstr-coverage release or commit sha + rev: v2.3.0 # most recent docstr-coverage release or commit sha hooks: - id: docstr-coverage args: ["--verbose", "2"] # override the .docstr.yaml to see less output @@ -355,16 +348,6 @@ docstr-coverage some_project/src - 3 - Also print missing docstrings (function names, class names, etc.) - 4 - Also print information about present docstrings - _--fail-under=, -F _ - Fail if under a certain percentage of coverage (default: 100.0) -- _--docstr-ignore-file=\, -d \_ - Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairs - - File content example: - - ``` - SomeFile method_to_ignore1 method_to_ignore2 method_to_ignore3 - FileWhereWeWantToIgnoreAllSpecialMethods __.+__ - .* method_to_ignore_in_all_files - a_very_important_view_file ^get$ ^set$ ^post$ - detect_.* get_val.* - ``` - _--badge=\, -b \_ - Generate a docstring coverage percent badge as an SVG saved to a given filepath - Include the badge in a repo's README using ```[![docstr_coverage]()](https://github.com/HunterMcGushion/docstr_coverage)```, @@ -375,7 +358,7 @@ docstr-coverage some_project/src #### Config File All options can be saved in a config file. A file named `.docstr.yaml` in the folder in which `docstr-coverage` is executed is picked up automatically. -Other locations can be passed using `docstr-coverage -C path/to/config.json` or the long version `--config`. +Other locations can be passed using `docstr-coverage -C path/to/config.yml` or the long version `--config`. Example: ```yaml @@ -415,8 +398,10 @@ docstr-coverage docstr_coverage -e ".*/test" --skip-magic --skip-init --badge="d Note that options passed as command line arguments have precedence over options configured in a config file. -Exception: If a `--docstr-ignore-file` is present and the yml config contains `ignore_patterns`, -a `ValueError` is raised. + +#### Ignoring by Regex +In your config files, using `ignore_patterns`, you can specify regex patterns for files names and nodes (methods, ...) +which should be ignored. See config file example above. #### Overriding by Comments Note that `docstr-coverage` can not parse @@ -449,7 +434,7 @@ and configuring the `paths` section of the [`.docstr.yaml` config](#config-file) ```yaml repos: - repo: https://github.com/HunterMcGushion/docstr_coverage - rev: v2.2.0 # most recent docstr-coverage release or commit sha + rev: v2.3.0 # most recent docstr-coverage release or commit sha hooks: - id: docstr-coverage args: ["--verbose", "2"] # override the .docstr.yaml to see less output @@ -596,16 +581,6 @@ docstr-coverage some_project/src - 3 - Also print missing docstrings (function names, class names, etc.) - 4 - Also print information about present docstrings - _--fail-under=, -F _ - Fail if under a certain percentage of coverage (default: 100.0) -- _--docstr-ignore-file=\, -d \_ - Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairs - - File content example: - - ``` - SomeFile method_to_ignore1 method_to_ignore2 method_to_ignore3 - FileWhereWeWantToIgnoreAllSpecialMethods __.+__ - .* method_to_ignore_in_all_files - a_very_important_view_file ^get$ ^set$ ^post$ - detect_.* get_val.* - ``` - _--badge=\, -b \_ - Generate a docstring coverage percent badge as an SVG saved to a given filepath - Include the badge in a repo's README using ```[![docstr_coverage]()](https://github.com/HunterMcGushion/docstr_coverage)```, @@ -616,7 +591,7 @@ docstr-coverage some_project/src #### Config File All options can be saved in a config file. A file named `.docstr.yaml` in the folder in which `docstr-coverage` is executed is picked up automatically. -Other locations can be passed using `docstr-coverage -C path/to/config.json` or the long version `--config`. +Other locations can be passed using `docstr-coverage -C path/to/config.yml` or the long version `--config`. Example: ```yaml @@ -656,8 +631,10 @@ docstr-coverage docstr_coverage -e ".*/test" --skip-magic --skip-init --badge="d Note that options passed as command line arguments have precedence over options configured in a config file. -Exception: If a `--docstr-ignore-file` is present and the yml config contains `ignore_patterns`, -a `ValueError` is raised. + +#### Ignoring by Regex +In your config files, using `ignore_patterns`, you can specify regex patterns for files names and nodes (methods, ...) +which should be ignored. See config file example above. #### Overriding by Comments Note that `docstr-coverage` can not parse @@ -690,7 +667,7 @@ and configuring the `paths` section of the [`.docstr.yaml` config](#config-file) ```yaml repos: - repo: https://github.com/HunterMcGushion/docstr_coverage - rev: v2.2.0 # most recent docstr-coverage release or commit sha + rev: v2.3.0 # most recent docstr-coverage release or commit sha hooks: - id: docstr-coverage args: ["--verbose", "2"] # override the .docstr.yaml to see less output @@ -740,7 +717,7 @@ Thank you to Alexey "DataGreed" Strelkov, and James Harlow for doing all the har %prep -%autosetup -n docstr-coverage-2.2.0 +%autosetup -n docstr-coverage-2.3.0 %build %py3_build @@ -780,5 +757,5 @@ mv %{buildroot}/doclist.lst . %{_docdir}/* %changelog -* Wed Apr 12 2023 Python_Bot - 2.2.0-1 +* Tue Apr 25 2023 Python_Bot - 2.3.0-1 - Package Spec generated -- cgit v1.2.3