diff options
Diffstat (limited to 'python-mr-proper.spec')
| -rw-r--r-- | python-mr-proper.spec | 394 |
1 files changed, 394 insertions, 0 deletions
diff --git a/python-mr-proper.spec b/python-mr-proper.spec new file mode 100644 index 0000000..c7becdd --- /dev/null +++ b/python-mr-proper.spec @@ -0,0 +1,394 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mr-proper +Version: 0.0.7 +Release: 1 +Summary: Static Python code analyzer, that tries to check if functions in code are pure or not and why. +License: MIT +URL: https://github.com/best-doctor/mr_proper +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/e3/35/a50ba9e3097ee0d71232c996c626a17f80424140b365122c8f1bc9933118/mr_proper-0.0.7.tar.gz +BuildArch: noarch + +Requires: python3-click +Requires: python3-setuptools +Requires: python3-stdlib-list +Requires: python3-typing-extensions + +%description +# mr. Proper + +[](https://travis-ci.org/best-doctor/mr_proper) +[](https://badge.fury.io/py/mr-proper) +[](https://codeclimate.com/github/best-doctor/mr_proper/maintainability) +[](https://codeclimate.com/github/best-doctor/mr_proper/test_coverage) + +Static Python code analyzer, that tries to check if functions in code are +[pure](https://en.wikipedia.org/wiki/Pure_function) or not and why. + + + +*DISCLAIMER*: this library is very experimental and has a lot of edge cases. +Functions that mr. Proper marks as pure can be not pure, but they are +usually cleaner than other functions. + +## Installation + +```bash +pip install mr_proper +``` + +## What mr. Proper check + +1. that function has no blacklisted calls (like `print`) + and blacklisted attributes access (like `smth.count`); +1. that function not uses global objects (only local vars and function arguments); +1. that function has al least one return; +1. that function not mutates it's arguments; +1. that function has no local imports; +1. that function has no arguments of forbidden types (like ORM objects); +1. that function not uses `self`, `class` or `super`; +1. that function has calls of only pure functions. + +This list is not enought to say that function is pure and some points +are quite controversial, but it's a nice start. + +## Example + +Console usage: + +```python + # test.py + def add_one(n: int) -> int: + return n + 1 + + def print_amount_of_users(users_qs: QuerySet) -> None: + print(f'Current amount of users is {users_qs.count()}') +``` + +```bash +$ mr_propper test.py +add_one is pure! +print_amount_of_users is not pure because of: + it uses forbidden argument types (QuerySet) + it calls not pure functions (print) + it has no return +``` + +Usage inside Python code sample: + +```jupyterpython +>>> import ast +>>> from mr_propper.utils import is_function_pure +>>> funcdef = ast.parse(''' + def add_one(n: int) -> int: + return n + 1 +''').body[0] +>>> is_function_pure(funcdef) +True +>>> is_function_pure(funcdef, with_errors=True) +(True, []) +``` + +## Parameters + +CLI interface: + +- `filepath`: path to .py file to check (directories are not supported for now); +- `--recursive`: require inner calls to be pure for function pureness. + +## Code prerequisites + +1. Python 3.7+; +1. Functions are fully type-annotated; +1. No dynamic calls (like `getattr(sender, 'send_' + message_type)(message)`). + +## 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-mr-proper +Summary: Static Python code analyzer, that tries to check if functions in code are pure or not and why. +Provides: python-mr-proper +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mr-proper +# mr. Proper + +[](https://travis-ci.org/best-doctor/mr_proper) +[](https://badge.fury.io/py/mr-proper) +[](https://codeclimate.com/github/best-doctor/mr_proper/maintainability) +[](https://codeclimate.com/github/best-doctor/mr_proper/test_coverage) + +Static Python code analyzer, that tries to check if functions in code are +[pure](https://en.wikipedia.org/wiki/Pure_function) or not and why. + + + +*DISCLAIMER*: this library is very experimental and has a lot of edge cases. +Functions that mr. Proper marks as pure can be not pure, but they are +usually cleaner than other functions. + +## Installation + +```bash +pip install mr_proper +``` + +## What mr. Proper check + +1. that function has no blacklisted calls (like `print`) + and blacklisted attributes access (like `smth.count`); +1. that function not uses global objects (only local vars and function arguments); +1. that function has al least one return; +1. that function not mutates it's arguments; +1. that function has no local imports; +1. that function has no arguments of forbidden types (like ORM objects); +1. that function not uses `self`, `class` or `super`; +1. that function has calls of only pure functions. + +This list is not enought to say that function is pure and some points +are quite controversial, but it's a nice start. + +## Example + +Console usage: + +```python + # test.py + def add_one(n: int) -> int: + return n + 1 + + def print_amount_of_users(users_qs: QuerySet) -> None: + print(f'Current amount of users is {users_qs.count()}') +``` + +```bash +$ mr_propper test.py +add_one is pure! +print_amount_of_users is not pure because of: + it uses forbidden argument types (QuerySet) + it calls not pure functions (print) + it has no return +``` + +Usage inside Python code sample: + +```jupyterpython +>>> import ast +>>> from mr_propper.utils import is_function_pure +>>> funcdef = ast.parse(''' + def add_one(n: int) -> int: + return n + 1 +''').body[0] +>>> is_function_pure(funcdef) +True +>>> is_function_pure(funcdef, with_errors=True) +(True, []) +``` + +## Parameters + +CLI interface: + +- `filepath`: path to .py file to check (directories are not supported for now); +- `--recursive`: require inner calls to be pure for function pureness. + +## Code prerequisites + +1. Python 3.7+; +1. Functions are fully type-annotated; +1. No dynamic calls (like `getattr(sender, 'send_' + message_type)(message)`). + +## 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 mr-proper +Provides: python3-mr-proper-doc +%description help +# mr. Proper + +[](https://travis-ci.org/best-doctor/mr_proper) +[](https://badge.fury.io/py/mr-proper) +[](https://codeclimate.com/github/best-doctor/mr_proper/maintainability) +[](https://codeclimate.com/github/best-doctor/mr_proper/test_coverage) + +Static Python code analyzer, that tries to check if functions in code are +[pure](https://en.wikipedia.org/wiki/Pure_function) or not and why. + + + +*DISCLAIMER*: this library is very experimental and has a lot of edge cases. +Functions that mr. Proper marks as pure can be not pure, but they are +usually cleaner than other functions. + +## Installation + +```bash +pip install mr_proper +``` + +## What mr. Proper check + +1. that function has no blacklisted calls (like `print`) + and blacklisted attributes access (like `smth.count`); +1. that function not uses global objects (only local vars and function arguments); +1. that function has al least one return; +1. that function not mutates it's arguments; +1. that function has no local imports; +1. that function has no arguments of forbidden types (like ORM objects); +1. that function not uses `self`, `class` or `super`; +1. that function has calls of only pure functions. + +This list is not enought to say that function is pure and some points +are quite controversial, but it's a nice start. + +## Example + +Console usage: + +```python + # test.py + def add_one(n: int) -> int: + return n + 1 + + def print_amount_of_users(users_qs: QuerySet) -> None: + print(f'Current amount of users is {users_qs.count()}') +``` + +```bash +$ mr_propper test.py +add_one is pure! +print_amount_of_users is not pure because of: + it uses forbidden argument types (QuerySet) + it calls not pure functions (print) + it has no return +``` + +Usage inside Python code sample: + +```jupyterpython +>>> import ast +>>> from mr_propper.utils import is_function_pure +>>> funcdef = ast.parse(''' + def add_one(n: int) -> int: + return n + 1 +''').body[0] +>>> is_function_pure(funcdef) +True +>>> is_function_pure(funcdef, with_errors=True) +(True, []) +``` + +## Parameters + +CLI interface: + +- `filepath`: path to .py file to check (directories are not supported for now); +- `--recursive`: require inner calls to be pure for function pureness. + +## Code prerequisites + +1. Python 3.7+; +1. Functions are fully type-annotated; +1. No dynamic calls (like `getattr(sender, 'send_' + message_type)(message)`). + +## 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 mr-proper-0.0.7 + +%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-mr-proper -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.7-1 +- Package Spec generated |