Setup pre-commit hook (#385)

Author: asvetlov

.github/workflows/ci.yml

@@ -34,6 +34,8 @@ jobs:
         path: ~/.cache/pip
         restore-keys: |
             pip-lint-
+    - name: Pre-Commit hooks
+      uses: pre-commit/action@v2.0.0
     - name: Install dependencies
       uses: py-actions/py-dependency-install@v2
       with:
@@ -43,7 +45,7 @@ jobs:
         python setup.py install
     - name: Run linter
       run: |
-        make flake
+        make lint
     - name: Prepare twine checker
       run: |
         pip install -U twine wheel

.gitignore

@@ -61,4 +61,4 @@ coverage/
 .vscode
 
 .mypy_cache
-.python-version
+.python-version

.pre-commit-config.yaml

@@ -0,0 +1,64 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 'v3.3.0'
+  hooks:
+  - id: check-merge-conflict
+- repo: https://github.com/asottile/yesqa
+  rev: v1.2.2
+  hooks:
+  - id: yesqa
+- repo: https://github.com/pre-commit/mirrors-isort
+  rev: 'v5.6.4'
+  hooks:
+  - id: isort
+- repo: https://github.com/psf/black
+  rev: '20.8b1'
+  hooks:
+    - id: black
+      language_version: python3 # Should be a command that runs python3.6+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 'v3.3.0'
+  hooks:
+  - id: end-of-file-fixer
+    exclude: >-
+      ^docs/[^/]*\.svg$
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+  - id: file-contents-sorter
+    files: |
+      CONTRIBUTORS.txt|
+      docs/spelling_wordlist.txt|
+      .gitignore|
+      .gitattributes
+  - id: check-case-conflict
+  - id: check-json
+  - id: check-xml
+  - id: check-executables-have-shebangs
+  - id: check-toml
+  - id: check-xml
+  - id: check-yaml
+  - id: debug-statements
+  - id: check-added-large-files
+  - id: check-symlinks
+  - id: debug-statements
+  - id: detect-aws-credentials
+    args: ['--allow-missing-credentials']
+  - id: detect-private-key
+    exclude: ^examples/
+- repo: https://github.com/asottile/pyupgrade
+  rev: 'v2.7.3'
+  hooks:
+  - id: pyupgrade
+    args: ['--py36-plus']
+- repo: https://gitlab.com/pycqa/flake8
+  rev: '3.8.4'
+  hooks:
+  - id: flake8
+    exclude: "^docs/"
+
+- repo: git://github.com/Lucas-C/pre-commit-hooks-markup
+  rev: v1.0.0
+  hooks:
+  - id: rst-linter
+    files: >-
+      ^[^/]+[.]rst$

LICENSE

@@ -199,4 +199,3 @@ Apache License
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-

Makefile

@@ -1,16 +1,23 @@
 # Some simple testing tasks (sorry, UNIX only).
 
-flake:
-	flake8 aiohttp_jinja2 tests 
+.PHONY: init setup
+init setup:
+	pip install -r requirements-dev.txt
+	pre-commit install
+
+.PHONY: fmt
+fmt:
+	python -m pre_commit run --all-files --show-diff-on-failure
+
+.PHONY: lint
+lint: fmt
 	mypy --strict aiohttp_jinja2
 
-test: flake
+.PHONY: test
+test:
 	py.test -s ./tests/
 
-cov cover coverage:
-	py.test --cov=aiohttp_jinja2 --cov-report=html --cov-report=term ./tests/
-	@echo "open file://`pwd`/htmlcov/index.html"
-
+.PHONY: clean
 clean:
 	rm -rf `find . -name __pycache__`
 	rm -f `find . -type f -name '*.py[co]' `
@@ -25,8 +32,7 @@ clean:
 	rm -rf build
 	rm -rf cover
 
+.PHONY: doc
 doc:
 	make -C docs html
 	@echo "open file://`pwd`/docs/_build/html/index.html"
-
-.PHONY: all build venv flake test vtest testloop cov clean doc

aiohttp_jinja2/__init__.py

@@ -1,23 +1,35 @@
 import asyncio
 import functools
 import warnings
+from typing import (
+    Any,
+    Awaitable,
+    Callable,
+    Dict,
+    Iterable,
+    Mapping,
+    Optional,
+    Type,
+    Union,
+    cast,
+    overload,
+)
+
 import jinja2
-from collections.abc import Mapping
-from typing import Any, Awaitable, Callable, Dict, Iterable, Optional, Type, Union, cast, overload
 from aiohttp import web
 from aiohttp.abc import AbstractView
+
 from .helpers import GLOBAL_HELPERS
 from .typedefs import Filters
 
+__version__ = "1.2.0"
 
-__version__ = '1.2.0'
+__all__ = ("setup", "get_env", "render_template", "render_string", "template")
 
-__all__ = ('setup', 'get_env', 'render_template', 'render_string', 'template')
 
-
-APP_CONTEXT_PROCESSORS_KEY = 'aiohttp_jinja2_context_processors'
-APP_KEY = 'aiohttp_jinja2_environment'
-REQUEST_CONTEXT_KEY = 'aiohttp_jinja2_context'
+APP_CONTEXT_PROCESSORS_KEY = "aiohttp_jinja2_context_processors"
+APP_KEY = "aiohttp_jinja2_environment"
+REQUEST_CONTEXT_KEY = "aiohttp_jinja2_context"
 
 _SimpleHandler = Callable[[web.Request], Awaitable[web.StreamResponse]]
 _MethodHandler = Callable[[Any, web.Request], Awaitable[web.StreamResponse]]
@@ -27,7 +39,9 @@
 _SimpleTemplateHandler = Callable[[web.Request], _TemplateReturnType]
 _MethodTemplateHandler = Callable[[Any, web.Request], _TemplateReturnType]
 _ViewTemplateHandler = Callable[[AbstractView], _TemplateReturnType]
-_TemplateHandler = Union[_SimpleTemplateHandler, _MethodTemplateHandler, _ViewTemplateHandler]
+_TemplateHandler = Union[
+    _SimpleTemplateHandler, _MethodTemplateHandler, _ViewTemplateHandler
+]
 
 
 def setup(
@@ -37,7 +51,7 @@ def setup(
     context_processors: Iterable[Callable[[web.Request], Dict[str, Any]]] = (),
     filters: Optional[Filters] = None,
     default_helpers: bool = True,
-    **kwargs: Any
+    **kwargs: Any,
 ) -> jinja2.Environment:
     kwargs.setdefault("autoescape", True)
     env = jinja2.Environment(*args, **kwargs)
@@ -50,16 +64,12 @@ def setup(
         app[APP_CONTEXT_PROCESSORS_KEY] = context_processors
         app.middlewares.append(context_processors_middleware)
 
-    env.globals['app'] = app
+    env.globals["app"] = app
 
     return env
 
 
-def get_env(
-    app: web.Application,
-    *,
-    app_key: str = APP_KEY
-) -> jinja2.Environment:
+def get_env(app: web.Application, *, app_key: str = APP_KEY) -> jinja2.Environment:
     return cast(jinja2.Environment, app.get(app_key))
 
 
@@ -68,21 +78,23 @@ def render_string(
     request: web.Request,
     context: Mapping[str, Any],
     *,
-    app_key: str = APP_KEY
+    app_key: str = APP_KEY,
 ) -> str:
     env = request.config_dict.get(app_key)
     if env is None:
-        text = ("Template engine is not initialized, "
-                "call aiohttp_jinja2.setup(..., app_key={}) first"
-                "".format(app_key))
+        text = (
+            "Template engine is not initialized, "
+            "call aiohttp_jinja2.setup(..., app_key={}) first"
+            "".format(app_key)
+        )
         # in order to see meaningful exception message both: on console
         # output and rendered page we add same message to *reason* and
         # *text* arguments.
         raise web.HTTPInternalServerError(reason=text, text=text)
     try:
         template = env.get_template(template_name)
     except jinja2.TemplateNotFound as e:
-        text = "Template '{}' not found".format(template_name)
+        text = f"Template '{template_name}' not found"
         raise web.HTTPInternalServerError(reason=text, text=text) from e
     if not isinstance(context, Mapping):
         text = "context should be mapping, not {}".format(type(context))
@@ -100,14 +112,14 @@ def render_template(
     context: Mapping[str, Any],
     *,
     app_key: str = APP_KEY,
-    encoding: str = 'utf-8',
-    status: int = 200
+    encoding: str = "utf-8",
+    status: int = 200,
 ) -> web.Response:
     response = web.Response(status=status)
     if context is None:
         context = {}
     text = render_string(template_name, request, context, app_key=app_key)
-    response.content_type = 'text/html'
+    response.content_type = "text/html"
     response.charset = encoding
     response.text = text
     return response
@@ -117,27 +129,31 @@ def template(
     template_name: str,
     *,
     app_key: str = APP_KEY,
-    encoding: str = 'utf-8',
-    status: int = 200
+    encoding: str = "utf-8",
+    status: int = 200,
 ) -> Callable[[_TemplateHandler], _HandlerType]:
-
     def wrapper(func: _TemplateHandler) -> _HandlerType:
         @overload
         async def wrapped(request: web.Request) -> web.StreamResponse:
             ...
+
         @overload
         async def wrapped(view: AbstractView) -> web.StreamResponse:
             ...
+
         @overload
         async def wrapped(_self: Any, request: web.Request) -> web.StreamResponse:
             ...
+
         @functools.wraps(func)
-        async def wrapped(*args):
+        async def wrapped(*args: Any) -> web.StreamResponse:
             if asyncio.iscoroutinefunction(func):
                 coro = func
             else:
-                warnings.warn("Bare functions are deprecated, "
-                              "use async ones", DeprecationWarning)
+                warnings.warn(
+                    "Bare functions are deprecated, " "use async ones",
+                    DeprecationWarning,
+                )
                 coro = asyncio.coroutine(func)
             context = await coro(*args)
             if isinstance(context, web.StreamResponse):
@@ -149,18 +165,21 @@ async def wrapped(*args):
             else:
                 request = args[-1]
 
-            response = render_template(template_name, request, context,
-                                       app_key=app_key, encoding=encoding)
+            response = render_template(
+                template_name, request, context, app_key=app_key, encoding=encoding
+            )
             response.set_status(status)
             return response
+
         return wrapped
+
     return wrapper
 
 
 @web.middleware
 async def context_processors_middleware(
     request: web.Request,
-    handler: Callable[[web.Request], Awaitable[web.StreamResponse]]
+    handler: Callable[[web.Request], Awaitable[web.StreamResponse]],
 ) -> web.StreamResponse:
 
     if REQUEST_CONTEXT_KEY not in request:
@@ -171,4 +190,4 @@ async def context_processors_middleware(
 
 
 async def request_processor(request: web.Request) -> Dict[str, web.Request]:
-    return {'request': request}
+    return {"request": request}

aiohttp_jinja2/helpers.py

@@ -17,11 +17,11 @@ def url_for(context: Dict[str, Any], __route_name: str, **parts: Any) -> URL:
     {{ url('item-details', id=123, query={'active': 'true'}) }}
     might become "/items/1?active=true".
     """
-    app = cast(web.Application, context['app'])
+    app = cast(web.Application, context["app"])
 
     query = None
-    if 'query_' in parts:
-        query = parts.pop('query_')
+    if "query_" in parts:
+        query = parts.pop("query_")
 
     for key in parts:
         val = parts[key]
@@ -33,8 +33,10 @@ def url_for(context: Dict[str, Any], __route_name: str, **parts: Any) -> URL:
             # int inherited classes like bool are forbidden
             val = str(val)
         else:
-            raise TypeError("argument value should be str or int, "
-                            "got {} -> [{}] {!r}".format(key, type(val), val))
+            raise TypeError(
+                "argument value should be str or int, "
+                "got {} -> [{}] {!r}".format(key, type(val), val)
+            )
         parts[key] = val
 
     url = app.router[__route_name].url_for(**parts)
@@ -53,15 +55,16 @@ def static_url(context: Dict[str, Any], static_file_path: str) -> str:
     Usage: {{ static('styles.css') }} might become
     "/static/styles.css" or "http://mycdn.example.com/styles.css"
     """
-    app = context['app']
+    app = context["app"]
     try:
-        static_url = app['static_root_url']
+        static_url = app["static_root_url"]
     except KeyError:
         raise RuntimeError(
             "app does not define a static root url "
             "'static_root_url', you need to set the url root "
-            "with app['static_root_url'] = '<static root>'.") from None
-    return '{}/{}'.format(static_url.rstrip('/'), static_file_path.lstrip('/'))
+            "with app['static_root_url'] = '<static root>'."
+        ) from None
+    return "{}/{}".format(static_url.rstrip("/"), static_file_path.lstrip("/"))
 
 
 GLOBAL_HELPERS = dict(

aiohttp_jinja2/py.typed

@@ -1 +1 @@
-# marker
+# marker

aiohttp_jinja2/typedefs.py

@@ -1,4 +1,4 @@
-from typing import Callable, Union, Iterable, Tuple, Mapping
+from typing import Callable, Iterable, Mapping, Tuple, Union
 
 Filter = Callable[..., str]
 Filters = Union[Iterable[Tuple[str, Filter]], Mapping[str, Filter]]

docs/api.rst

@@ -131,4 +131,3 @@ Assuming the initialization from the example above has been done::
       return response
 
    app.router.add_get('/tmpl', handler)
-