Merge pull request #18 from aikikode/feature/fix_lint_and_2.7

FIX: Remove deprecated pkgversion; code reformats; fix 2.7 type hints error

Author: kammala

.gitignore

@@ -127,7 +127,6 @@ var/
 .installed.cfg
 *.egg
 .python-version
-setup.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -146,7 +145,7 @@ htmlcov/
 .coverage.*
 .cache
 nosetests.xml
-coverage.xml
+coverage*.xml
 *,cover
 
 # Translations

Makefile

@@ -31,7 +31,7 @@ venv:
 	@python3.6 -m venv venv
 	@$(PIP) install -U "pip>=7.0" -q
 	@$(PIP) install -U setuptools -q
-	@$(PIP) install -r $(DEPS)
+	@$(PIP) install --use-feature=2020-resolver -r $(DEPS)
 
 test: venv pyclean
 	$(TOX) -e $(TOX_PY_LIST)
@@ -40,8 +40,8 @@ test/%: venv pyclean
 	$(TOX) -e $(TOX_PY_LIST) -- $*
 
 lint: venv
-	@$(TOX) -e lint
 	@$(TOX) -e isort-check
+	@$(TOX) -e flake8
 
 isort: venv
 	@$(TOX) -e isort-fix
@@ -53,14 +53,9 @@ docker/%:
 	$(DOCKER_COMPOSE) run --rm --service-ports app make $*
 
 ## Distribution
-setup.py: venv
-	@$(PYTHON) setup_gen.py
-
 build: venv tox
-	-rm -f setup.py
 	-rm -rf dist build
-	$(MAKE) setup.py
-	$(PYTHON) setup.py sdist
+	$(PYTHON) setup.py sdist bdist_wheel
 	$(TWINE) check dist/*
 
 publish: build

fqn_decorators/async.py

@@ -19,11 +19,12 @@ async def async_wrapper(*args, **kwargs):
             self.before()
             try:
                 self.result = await self.func(*self.args, **self.kwargs)
-            except:
+            except:  # noqa: E722
                 self.exc_info = sys.exc_info()
                 self.exception()
                 raise
             finally:
                 self.after()
             return self.result
+
         return async_wrapper(*args, **kwargs)

fqn_decorators/asynchronous.py

@@ -9,26 +9,26 @@ def get_fqn(obj):
     It only works for classes, methods and functions.
     It is unable to properly determine the FQN of class instances, static methods and class methods.
     """
-    path = [getattr(obj, '__module__', None)]
-    qualname = getattr(obj, '__qualname__', None)
+    path = [getattr(obj, "__module__", None)]
+    qualname = getattr(obj, "__qualname__", None)
     if qualname:
-        path.append(qualname.replace('<locals>.', ''))
-        im_self = getattr(obj, '__self__', None)
-        im_class = getattr(im_self, '__class__', None)
+        path.append(qualname.replace("<locals>.", ""))
+        im_self = getattr(obj, "__self__", None)
+        im_class = getattr(im_self, "__class__", None)
         if im_self and im_class:
             path = [
-                getattr(im_class, '__module__', None),
-                getattr(im_class, '__name__', None),
-                getattr(obj, '__name__', None)
+                getattr(im_class, "__module__", None),
+                getattr(im_class, "__name__", None),
+                getattr(obj, "__name__", None),
             ]
     else:
-        im_class = getattr(obj, 'im_class', None)
-        im_class_module = getattr(im_class, '__module__', None)
+        im_class = getattr(obj, "im_class", None)
+        im_class_module = getattr(im_class, "__module__", None)
         if im_class and im_class_module:
             path = [im_class_module]
-        path.append(getattr(im_class, '__name__', None))
-        path.append(getattr(obj, '__name__', None))
-    return '.'.join(filter(None, path))
+        path.append(getattr(im_class, "__name__", None))
+        path.append(getattr(obj, "__name__", None))
+    return ".".join(filter(None, path))
 
 
 class Decorator(object):
@@ -77,7 +77,7 @@ def _ensure_decorator_instance(self, *args, **kwargs):
             if not self.func:
                 # Decorator was initialized with arguments
                 return self.__class__(args[0], **self.params), True
-            return self.__class__(self.func,  _initialized=True, **self.params)(*args, **kwargs), True
+            return self.__class__(self.func, _initialized=True, **self.params)(*args, **kwargs), True
         self.fqn = self.get_fqn()
         self.args = args
         self.kwargs = kwargs
@@ -91,7 +91,7 @@ def __call__(self, *args, **kwargs):
         self.before()
         try:
             self.result = self.func(*self.args, **self.kwargs)
-        except:
+        except:  # noqa: E722
             self.exc_info = sys.exc_info()
             self.exception()
             raise
@@ -133,14 +133,14 @@ class ChainedDecorator(Decorator):
 
     def __init__(self, func=None, decorators=None, **params):
         """Override the init just to make the decorators argument more visible"""
-        params['decorators'] = decorators
+        params["decorators"] = decorators
         super(ChainedDecorator, self).__init__(func, **params)
 
     def before(self):
-        for decorator in self.params.get('decorators', []):
+        for decorator in self.params.get("decorators", []):
             self.func = decorator(self.func)
-            if hasattr(self.func, 'fqn'):
-                setattr(self.func, 'fqn', self.fqn)
+            if hasattr(self.func, "fqn"):
+                setattr(self.func, "fqn", self.fqn)
 
 
 chained_decorator = ChainedDecorator

fqn_decorators/decorators.py

@@ -0,0 +1,28 @@
+[tool.black]
+line-length = 120
+target_version = ["py27", "py35", "py36", "py37"]
+
+[tool.isort]
+combine_as_imports = true
+default_section = "THIRDPARTY"
+known_first_party = ["fqn_decorators", "tests"]
+from_first = false
+include_trailing_comma = true
+length_sort = false
+multi_line_output = 3
+order_by_type = true
+sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
+use_parentheses = true
+line_length = 120
+force_grid_wrap = 0
+
+[tool.coverage.run]
+source = ["fqn_decorators"]
+relative_files = true
+branch = true
+omit = ["tests/*"]
+
+[tool.setuptools_scm]
+
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]

pyproject.toml

@@ -1,3 +1,20 @@
-# Additional packages
--r requirements/requirements-base.txt
--r requirements/requirements-testing.txt
+# Package in develop mode
+-e .
+
+importlib-metadata
+
+# Distribution
+twine
+wheel
+
+# Code style
+mypy; python_version >= '3.5'
+isort[pyproject]
+flake8
+
+# Tests
+tox
+pytest
+pytest-cov
+pytest-asyncio; python_version >= '3.5'
+mock

requirements.txt

@@ -1,23 +1,14 @@
 [flake8]
-exclude = build,.git,**migrations/
-ignore = E902
-max-line-length = 119
-
-[isort]
-combine_as_imports = true
-default_section = THIRDPARTY
-from_first = false
-include_trailing_comma = true
-
-length_sort = false
-multi_line_output = 5
-not_skip = __init__.py
-order_by_type = true
-sections = FUTURE,STDLIB,THIRDPARTY,OTHER,FIRSTPARTY,LOCALFOLDER
-use_parenthesis = true
-
-[wheel]
-universal = 1
-
-[coverage:run]
-omit = tests/*
+exclude = build,.git
+max-line-length = 120
+select = B,E,F,W,C,W504,B902,B903,B950
+ignore =
+    # flake8 misbehaves: https://github.com/PyCQA/pycodestyle/issues/373
+    E203
+    # duplicate for B950
+    E501
+    E902
+    # mutual exclusive with W504
+    W503
+    # conflicts with FastAPI `Query`, `Header`, `Body` functions
+    B008

requirements/requirements-base.txt

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from setuptools import find_packages, setup
+
+with open("README.md") as f:
+    long_description = f.read()
+
+
+setup(
+    name="fqn-decorators",
+    use_scm_version=True,
+    setup_requires=["setuptools_scm"],
+    description="Easily create multi-purpose decorators that have access to the FQN of the original function.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Mattias Sluis",
+    author_email="[email protected]",
+    url="https://github.com/kpn-digital/py-fqn-decorators",
+    packages=find_packages(exclude=["tests*"]),
+    tests_require=["tox"],
+    include_package_data=True,
+    zip_safe=False,
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Web Environment",
+        "Intended Audience :: Developers",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Topic :: Internet :: WWW/HTTP",
+    ],
+)

requirements/requirements-testing.txt

@@ -8,14 +8,12 @@ def my_test_func(a):
 
 @fqn_decorators.Decorator()
 class A(object):
-
     @fqn_decorators.Decorator
     def method(self, a):
         return a
 
 
 class B(object):
-
     @fqn_decorators.Decorator
     def method(self, b):
         return b