diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:01:48 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:01:48 +0000 |
commit | a9278322e6c5b7424a4d4cfcf10ea4d234f9491b (patch) | |
tree | 3b727ec73a465e91806ec4532434274f4fc33e11 | |
parent | 30d3d13ed0fa95a5db1a90d93ef758851023f971 (diff) |
automatic import of python-flake8-functions
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-flake8-functions.spec | 374 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 376 insertions, 0 deletions
@@ -0,0 +1 @@ +/flake8_functions-0.0.8.tar.gz diff --git a/python-flake8-functions.spec b/python-flake8-functions.spec new file mode 100644 index 0000000..a12755d --- /dev/null +++ b/python-flake8-functions.spec @@ -0,0 +1,374 @@ +%global _empty_manifest_terminate_build 0 +Name: python-flake8-functions +Version: 0.0.8 +Release: 1 +Summary: A flake8 extension that checks functions +License: MIT +URL: https://github.com/best-doctor/flake8-functions +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/7e/f4/af475b75382a6403a6a184f01ae42e8c9bdd97ee8e84b4c4d6660da0f4d9/flake8_functions-0.0.8.tar.gz +BuildArch: noarch + +Requires: python3-setuptools +Requires: python3-mr-proper + +%description +# flake8-functions + +[](https://travis-ci.org/best-doctor/flake8-functions) +[](https://codeclimate.com/github/best-doctor/flake8-functions/maintainability) +[](https://codeclimate.com/github/best-doctor/flake8-functions/test_coverage) +[](https://badge.fury.io/py/flake8-functions) + + +An extension for flake8 to report on issues with functions. + +We believe code readability is very important for a team that consists of +more than one person. One of the issues we've encountered is functions +that are more that two screens long. + +The validator checks for: + +* CFQ001 - function length (default max length is 100) +* CFQ002 - function arguments number (default max arguments amount is 6) +* CFQ003 - function is not pure. +* CFQ004 - function returns number (default max returns amount is 3) + +## Installation + +```terminal +pip install flake8-functions +``` + +## Example + +```python +def some_long_function( + first_parameter: int, + second_parameter: int, + third_parameter: int, +): + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + return first_parameter +``` + +Usage: + +```terminal +$ flake8 --max-function-length=20 test.py +test.py:1:0: CFQ001 "some_long_function" function has length 25 +that exceeds max allowed length 20 +``` + +## Error codes + +| Error code | Description | +|:----------:|:--------------------------------------------------------------------------------------------------:| +| CFQ001 | Function "some_function" has length %function_length% that exceeds max allowed length %max_length% | +| CFQ002 | Function "some_function" has %args_amount% arguments that exceeds max allowed %max_args_amount% | +| CFQ003 | Function "some_function" is not pure. | +| CFQ004 | Function "some_function" has %returns_amount% returns that exceeds max allowed %max_returns_amount%| + +## Code prerequisites + +1. Python 3.7+; + +## Contributing + +We would love you to contribute to our project. It's simple: + +1. Create an issue with bug you found or proposal you have. + Wait for approve from maintainer. +1. Create a pull request. Make sure all checks are green. +1. Fix review comments if any. +1. Be awesome. + +Here are useful tips: + +* You can run all checks and tests with `make check`. + Please do it before TravisCI does. +* We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md). +* We respect [Django CoC](https://www.djangoproject.com/conduct/). + Make soft, not bullshit. + + +%package -n python3-flake8-functions +Summary: A flake8 extension that checks functions +Provides: python-flake8-functions +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-flake8-functions +# flake8-functions + +[](https://travis-ci.org/best-doctor/flake8-functions) +[](https://codeclimate.com/github/best-doctor/flake8-functions/maintainability) +[](https://codeclimate.com/github/best-doctor/flake8-functions/test_coverage) +[](https://badge.fury.io/py/flake8-functions) + + +An extension for flake8 to report on issues with functions. + +We believe code readability is very important for a team that consists of +more than one person. One of the issues we've encountered is functions +that are more that two screens long. + +The validator checks for: + +* CFQ001 - function length (default max length is 100) +* CFQ002 - function arguments number (default max arguments amount is 6) +* CFQ003 - function is not pure. +* CFQ004 - function returns number (default max returns amount is 3) + +## Installation + +```terminal +pip install flake8-functions +``` + +## Example + +```python +def some_long_function( + first_parameter: int, + second_parameter: int, + third_parameter: int, +): + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + return first_parameter +``` + +Usage: + +```terminal +$ flake8 --max-function-length=20 test.py +test.py:1:0: CFQ001 "some_long_function" function has length 25 +that exceeds max allowed length 20 +``` + +## Error codes + +| Error code | Description | +|:----------:|:--------------------------------------------------------------------------------------------------:| +| CFQ001 | Function "some_function" has length %function_length% that exceeds max allowed length %max_length% | +| CFQ002 | Function "some_function" has %args_amount% arguments that exceeds max allowed %max_args_amount% | +| CFQ003 | Function "some_function" is not pure. | +| CFQ004 | Function "some_function" has %returns_amount% returns that exceeds max allowed %max_returns_amount%| + +## Code prerequisites + +1. Python 3.7+; + +## Contributing + +We would love you to contribute to our project. It's simple: + +1. Create an issue with bug you found or proposal you have. + Wait for approve from maintainer. +1. Create a pull request. Make sure all checks are green. +1. Fix review comments if any. +1. Be awesome. + +Here are useful tips: + +* You can run all checks and tests with `make check`. + Please do it before TravisCI does. +* We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md). +* We respect [Django CoC](https://www.djangoproject.com/conduct/). + Make soft, not bullshit. + + +%package help +Summary: Development documents and examples for flake8-functions +Provides: python3-flake8-functions-doc +%description help +# flake8-functions + +[](https://travis-ci.org/best-doctor/flake8-functions) +[](https://codeclimate.com/github/best-doctor/flake8-functions/maintainability) +[](https://codeclimate.com/github/best-doctor/flake8-functions/test_coverage) +[](https://badge.fury.io/py/flake8-functions) + + +An extension for flake8 to report on issues with functions. + +We believe code readability is very important for a team that consists of +more than one person. One of the issues we've encountered is functions +that are more that two screens long. + +The validator checks for: + +* CFQ001 - function length (default max length is 100) +* CFQ002 - function arguments number (default max arguments amount is 6) +* CFQ003 - function is not pure. +* CFQ004 - function returns number (default max returns amount is 3) + +## Installation + +```terminal +pip install flake8-functions +``` + +## Example + +```python +def some_long_function( + first_parameter: int, + second_parameter: int, + third_parameter: int, +): + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + first_parameter = ( + first_parameter + + second_parameter + + third_parameter + ) + + return first_parameter +``` + +Usage: + +```terminal +$ flake8 --max-function-length=20 test.py +test.py:1:0: CFQ001 "some_long_function" function has length 25 +that exceeds max allowed length 20 +``` + +## Error codes + +| Error code | Description | +|:----------:|:--------------------------------------------------------------------------------------------------:| +| CFQ001 | Function "some_function" has length %function_length% that exceeds max allowed length %max_length% | +| CFQ002 | Function "some_function" has %args_amount% arguments that exceeds max allowed %max_args_amount% | +| CFQ003 | Function "some_function" is not pure. | +| CFQ004 | Function "some_function" has %returns_amount% returns that exceeds max allowed %max_returns_amount%| + +## Code prerequisites + +1. Python 3.7+; + +## Contributing + +We would love you to contribute to our project. It's simple: + +1. Create an issue with bug you found or proposal you have. + Wait for approve from maintainer. +1. Create a pull request. Make sure all checks are green. +1. Fix review comments if any. +1. Be awesome. + +Here are useful tips: + +* You can run all checks and tests with `make check`. + Please do it before TravisCI does. +* We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md). +* We respect [Django CoC](https://www.djangoproject.com/conduct/). + Make soft, not bullshit. + + +%prep +%autosetup -n flake8-functions-0.0.8 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-flake8-functions -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.8-1 +- Package Spec generated @@ -0,0 +1 @@ +fdab1ace3178a5d520ae696be895f547 flake8_functions-0.0.8.tar.gz |