diff options
Diffstat (limited to 'python-flake8-import-restrictions.spec')
| -rw-r--r-- | python-flake8-import-restrictions.spec | 591 |
1 files changed, 591 insertions, 0 deletions
diff --git a/python-flake8-import-restrictions.spec b/python-flake8-import-restrictions.spec new file mode 100644 index 0000000..922655e --- /dev/null +++ b/python-flake8-import-restrictions.spec @@ -0,0 +1,591 @@ +%global _empty_manifest_terminate_build 0 +Name: python-flake8-import-restrictions +Version: 1.1.1 +Release: 1 +Summary: A flake8 plugin used to disallow certain forms of imports. +License: MIT +URL: https://github.com/atollk/flake8-import-restrictions +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/4e/68/379c6692e3a795ad9556da360b625cea41deae00e48811cc61453942b8d4/flake8-import-restrictions-1.1.1.tar.gz +BuildArch: noarch + + +%description +# flake8-import-restrictions +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) + +A flake8 plugin used to disallow certain forms of imports. + +This plugin talks about the `import` syntax (`import X.Y.Z [as foo]`) +and the `from` syntax (`from X.Y import Z [as foo]`). It talks about +`import` segments (`import X`), `from` segments (`from Y`), and `as` +segments (`as Z`). + +## Options +For every error `I20xx` listed below, there are options `--i20xx_include` and `--i20xx_exclude` +which are passed a comma separated list of UNIX wildcard patterns each. The error +will then only be reported on imports of modules that match a include pattern but no exclude +pattern. + +By default, I2000, I2001, I2002, I2021, I2023, I2041, and I2043 include all (`*`) modules. Only I2041 excludes the +`typing` module from checks, the other errors have no excludes by default. + +## General Import Errors + +### I2000 +Imports should only happen on module level, not locally. + +```python +# Bad +def f(): + import os.path + return os.path.join("a", "b") + +# Good +import os.path +def f(): + return os.path.join("a", "b") +``` + +### I2001 +Alias identifiers defined from `as` segments should be at +least two characters long. + +```python +# Bad +import os.path as p + +# Good +import os.path as path +``` + +### I2002 +Alias identifiers should not have the same name as the imported object. + +```python +# Bad +import sys as sys + +# Good +import sys +``` + +## `import` Syntax Errors + +### I2020 +When using the `import` syntax, if the imported module is a submodule, +i.e. not a top level module, an `as` segment should be present. + +```python +# Bad +import os.path + +# Good +import sys +import os.path as path +``` + +### I2021 +When using the `import` syntax, each import statement should +only import one module. + +```python +# Bad +import sys, os + +# Good +import sys +import os +``` + +### I2022 +The `import` syntax should not be used. + + +### I2023 +When using the `import` syntax, do not duplicate module names in the `as` +segment. + +```python +# Bad +import os.path as path + +# Good +from os import path +import os.path as ospath +``` + + +## `from` Syntax Errors + +### I2040 +When using the `from` syntax, the `import` segment only contains one +import. + +```python +# Bad +from os import path, environ + +# Good +from os import path +from os import environ +``` + +### I2041 +When using the `from` syntax, only submodules are imported, not +module elements. + +```python +# Bad +from os.path import join + +# Good +from os import path +``` + +### I2042 +When using the `from` syntax, only module elements are imported, +not submodules. + +```python +# Bad +from os import path + +# Good +from os.path import join +``` + +### I2043 +When using the `from` syntax, `import *` should not be used. + +```python +# Bad +from os.path import * + +# Good +from os.path import join +``` + +### I2044 +Relative imports should not be used. + +```python +# Bad +from . import foo + +# Good +from flake8_import_restrictions import foo +``` + +### I2045 +The `from` syntax should not be used. + + + + +%package -n python3-flake8-import-restrictions +Summary: A flake8 plugin used to disallow certain forms of imports. +Provides: python-flake8-import-restrictions +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-flake8-import-restrictions +# flake8-import-restrictions +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) + +A flake8 plugin used to disallow certain forms of imports. + +This plugin talks about the `import` syntax (`import X.Y.Z [as foo]`) +and the `from` syntax (`from X.Y import Z [as foo]`). It talks about +`import` segments (`import X`), `from` segments (`from Y`), and `as` +segments (`as Z`). + +## Options +For every error `I20xx` listed below, there are options `--i20xx_include` and `--i20xx_exclude` +which are passed a comma separated list of UNIX wildcard patterns each. The error +will then only be reported on imports of modules that match a include pattern but no exclude +pattern. + +By default, I2000, I2001, I2002, I2021, I2023, I2041, and I2043 include all (`*`) modules. Only I2041 excludes the +`typing` module from checks, the other errors have no excludes by default. + +## General Import Errors + +### I2000 +Imports should only happen on module level, not locally. + +```python +# Bad +def f(): + import os.path + return os.path.join("a", "b") + +# Good +import os.path +def f(): + return os.path.join("a", "b") +``` + +### I2001 +Alias identifiers defined from `as` segments should be at +least two characters long. + +```python +# Bad +import os.path as p + +# Good +import os.path as path +``` + +### I2002 +Alias identifiers should not have the same name as the imported object. + +```python +# Bad +import sys as sys + +# Good +import sys +``` + +## `import` Syntax Errors + +### I2020 +When using the `import` syntax, if the imported module is a submodule, +i.e. not a top level module, an `as` segment should be present. + +```python +# Bad +import os.path + +# Good +import sys +import os.path as path +``` + +### I2021 +When using the `import` syntax, each import statement should +only import one module. + +```python +# Bad +import sys, os + +# Good +import sys +import os +``` + +### I2022 +The `import` syntax should not be used. + + +### I2023 +When using the `import` syntax, do not duplicate module names in the `as` +segment. + +```python +# Bad +import os.path as path + +# Good +from os import path +import os.path as ospath +``` + + +## `from` Syntax Errors + +### I2040 +When using the `from` syntax, the `import` segment only contains one +import. + +```python +# Bad +from os import path, environ + +# Good +from os import path +from os import environ +``` + +### I2041 +When using the `from` syntax, only submodules are imported, not +module elements. + +```python +# Bad +from os.path import join + +# Good +from os import path +``` + +### I2042 +When using the `from` syntax, only module elements are imported, +not submodules. + +```python +# Bad +from os import path + +# Good +from os.path import join +``` + +### I2043 +When using the `from` syntax, `import *` should not be used. + +```python +# Bad +from os.path import * + +# Good +from os.path import join +``` + +### I2044 +Relative imports should not be used. + +```python +# Bad +from . import foo + +# Good +from flake8_import_restrictions import foo +``` + +### I2045 +The `from` syntax should not be used. + + + + +%package help +Summary: Development documents and examples for flake8-import-restrictions +Provides: python3-flake8-import-restrictions-doc +%description help +# flake8-import-restrictions +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) +[](https://github.com/atollk/flake8-import-restrictions/actions) + +A flake8 plugin used to disallow certain forms of imports. + +This plugin talks about the `import` syntax (`import X.Y.Z [as foo]`) +and the `from` syntax (`from X.Y import Z [as foo]`). It talks about +`import` segments (`import X`), `from` segments (`from Y`), and `as` +segments (`as Z`). + +## Options +For every error `I20xx` listed below, there are options `--i20xx_include` and `--i20xx_exclude` +which are passed a comma separated list of UNIX wildcard patterns each. The error +will then only be reported on imports of modules that match a include pattern but no exclude +pattern. + +By default, I2000, I2001, I2002, I2021, I2023, I2041, and I2043 include all (`*`) modules. Only I2041 excludes the +`typing` module from checks, the other errors have no excludes by default. + +## General Import Errors + +### I2000 +Imports should only happen on module level, not locally. + +```python +# Bad +def f(): + import os.path + return os.path.join("a", "b") + +# Good +import os.path +def f(): + return os.path.join("a", "b") +``` + +### I2001 +Alias identifiers defined from `as` segments should be at +least two characters long. + +```python +# Bad +import os.path as p + +# Good +import os.path as path +``` + +### I2002 +Alias identifiers should not have the same name as the imported object. + +```python +# Bad +import sys as sys + +# Good +import sys +``` + +## `import` Syntax Errors + +### I2020 +When using the `import` syntax, if the imported module is a submodule, +i.e. not a top level module, an `as` segment should be present. + +```python +# Bad +import os.path + +# Good +import sys +import os.path as path +``` + +### I2021 +When using the `import` syntax, each import statement should +only import one module. + +```python +# Bad +import sys, os + +# Good +import sys +import os +``` + +### I2022 +The `import` syntax should not be used. + + +### I2023 +When using the `import` syntax, do not duplicate module names in the `as` +segment. + +```python +# Bad +import os.path as path + +# Good +from os import path +import os.path as ospath +``` + + +## `from` Syntax Errors + +### I2040 +When using the `from` syntax, the `import` segment only contains one +import. + +```python +# Bad +from os import path, environ + +# Good +from os import path +from os import environ +``` + +### I2041 +When using the `from` syntax, only submodules are imported, not +module elements. + +```python +# Bad +from os.path import join + +# Good +from os import path +``` + +### I2042 +When using the `from` syntax, only module elements are imported, +not submodules. + +```python +# Bad +from os import path + +# Good +from os.path import join +``` + +### I2043 +When using the `from` syntax, `import *` should not be used. + +```python +# Bad +from os.path import * + +# Good +from os.path import join +``` + +### I2044 +Relative imports should not be used. + +```python +# Bad +from . import foo + +# Good +from flake8_import_restrictions import foo +``` + +### I2045 +The `from` syntax should not be used. + + + + +%prep +%autosetup -n flake8-import-restrictions-1.1.1 + +%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-import-restrictions -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.1-1 +- Package Spec generated |