v6.0.0

Author: Ronny Vedrilla

.gitlab-ci.yml

@@ -15,7 +15,16 @@ variables:
 services:
   - docker:18.09-dind
 
-lint:
+black and isort:
+  image: python:3.9-slim
+  stage: lint
+  tags:
+    - normal-load
+  script:
+    - pip install black isort typing-extensions
+    - black --check --diff --color . && isort . --profile black --check --diff
+
+flake8:
   image: python:3.9-slim
   stage: lint
   tags:

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# you find the full pre-commit-tools docu under:
+# https://pre-commit.com/
+
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        args: [ --check, --diff, --config, ./pyproject.toml ]
+        language_version: python3.10
+        stages: [ push ]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort
+        args: [ --profile, black, --check, --diff ]
+        language_version: python3.10
+        stages: [ push ]
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies: [ pep8-naming ]
+        args: [ --config=./setup.cfg, -v, --count ]
+        language_version: python3.10
+        stages: [ push ]

README.md

@@ -49,6 +49,31 @@ This package contains various useful helper functions. You can read up on all th
   pytest
   ````
 
+## Git hooks (via pre-commit)
+
+We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in
+vain.
+
+To enable the configured pre-push hooks, you need to [install](https://pre-commit.com/) pre-commit and run once:
+
+    pre-commit install -t pre-push -t pre-commit --install-hooks
+
+This will permanently install the git hooks for both, frontend and backend, in your local
+[`.git/hooks`](./.git/hooks) folder.
+The hooks are configured in the [`.pre-commit-config.yaml`](.pre-commit-config.yaml).
+
+You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
+
+    pre-commit run [hook-id] [options]
+
+Example: run single hook
+
+    pre-commit run flake8 --all-files --hook-stage push
+
+Example: run all hooks of pre-push stage
+
+    pre-commit run --all-files --hook-stage push
+
 ## Update documentation
 
 - To generate new auto-docs for new modules run: `sphinx-apidoc -o ./docs/modules/ ./ai_django_core/` (in the current

ai_django_core/__init__.py

@@ -1,3 +1,3 @@
 """Ambient toolbox - Lots of helper functions and useful widgets"""
 
-__version__ = '5.14.1'
+__version__ = '6.0.0'

ai_django_core/admin/model_admins/classes.py

@@ -9,8 +9,9 @@ class ReadOnlyAdmin(admin.ModelAdmin):
 
     def get_readonly_fields(self, request, obj=None):
         if obj:
-            self.readonly_fields = [field.name for field in self.opts.local_fields] + \
-                                   [field.name for field in self.opts.local_many_to_many]
+            self.readonly_fields = [field.name for field in self.opts.local_fields] + [
+                field.name for field in self.opts.local_many_to_many
+            ]
         return self.readonly_fields
 
     def changeform_view(self, request, object_id=None, form_url='', extra_context=None):

ai_django_core/admin/model_admins/inlines.py

@@ -6,6 +6,7 @@ class ReadOnlyTabularInline(admin.TabularInline):
     Class for being extended by TabularInline-classes.
     Disables all create, delete or edit functionality in the tabular inline admin.
     """
+
     can_delete = False
 
     def has_add_permission(self, *args, **kwargs):
@@ -18,9 +19,11 @@ def has_delete_permission(self, *args, **kwargs):
         return False
 
     def get_readonly_fields(self, request, obj=None):
-        result = list(set(
-            [field.name for field in self.opts.local_fields] +
-            [field.name for field in self.opts.local_many_to_many]
-        ))
+        result = list(
+            set(
+                [field.name for field in self.opts.local_fields]
+                + [field.name for field in self.opts.local_many_to_many]
+            )
+        )
         result.remove('id')
         return result

ai_django_core/admin/model_admins/mixins.py

@@ -7,6 +7,7 @@ class AdminCreateFormMixin:
     Mixin to easily use a different form for the create case (in comparison to "edit") in the django admin
     Logic copied from `django.contrib.auth.admin.UserAdmin`
     """
+
     add_form = None
 
     def get_form(self, request, obj=None, **kwargs):
@@ -44,6 +45,7 @@ class FetchParentObjectInlineMixin:
     Fetches the parent object via the URL resolver and makes it available throughout the entire class.
     Attention: Use only in inline admin classes.
     """
+
     parent_object = None
 
     @staticmethod
@@ -81,8 +83,12 @@ class CommonInfoAdminMixin:
     """
 
     def get_readonly_fields(self, request, obj=None):
-        return super().get_readonly_fields(request, obj) + ('created_by', 'lastmodified_by', 'created_at',
-                                                            'lastmodified_at')
+        return super().get_readonly_fields(request, obj) + (
+            'created_by',
+            'lastmodified_by',
+            'created_at',
+            'lastmodified_at',
+        )
 
     def save_form(self, request, form, change):
         if form.instance and request.user:
@@ -97,6 +103,7 @@ class DeactivatableChangeViewAdminMixin:
     """
     Mixin to be used in model admins to disable the detail page / change view.
     """
+
     enable_change_view = True
 
     def can_see_change_view(self, request) -> bool:
@@ -124,8 +131,10 @@ def change_view(self, request, *args, **kwargs):
             return super().change_view(request, *args, **kwargs)
         else:
             opts = self.model._meta
-            url = reverse('admin:{app}_{model}_changelist'.format(
-                app=opts.app_label,
-                model=opts.model_name,
-            ))
+            url = reverse(
+                'admin:{app}_{model}_changelist'.format(
+                    app=opts.app_label,
+                    model=opts.model_name,
+                )
+            )
             return HttpResponseRedirect(url)

ai_django_core/admin/views/forms.py

@@ -1,5 +1,5 @@
 from crispy_forms.helper import FormHelper
-from crispy_forms.layout import Submit, Layout, Div, Fieldset, HTML
+from crispy_forms.layout import HTML, Div, Fieldset, Layout, Submit
 from django import forms
 from django.utils.translation import gettext_lazy as _
 
@@ -8,6 +8,7 @@ class AdminCrispyForm(forms.Form):
     """
     Base crispy form to be used in custom views within the django admin.
     """
+
     section_title = _('No title defined')
     button_label = _('Save')
 
@@ -25,10 +26,7 @@ def __init__(self, *args, **kwargs):
         self.helper.add_input(Submit('submit', self.button_label, css_class="button btn-primary"))
         self.helper.layout = Layout(
             Div(
-                Div(
-                    HTML(f'<h2>{self.section_title}</h2>'),
-                    Fieldset(*fieldset_list),
-                    css_class='module aligned'
-                ), css_class='custom-form'
+                Div(HTML(f'<h2>{self.section_title}</h2>'), Fieldset(*fieldset_list), css_class='module aligned'),
+                css_class='custom-form',
             ),
         )

ai_django_core/admin/views/mixins.py

@@ -6,6 +6,7 @@ class AdminViewMixin:
     """
     Mixin to provide a custom view with all the attributes it needs to look like a regular django admin page.
     """
+
     model = None
     admin_page_title = ''
 
@@ -36,23 +37,25 @@ def get_admin_site(self):
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         admin_site = self.get_admin_site()
-        context.update({
-            'site_header': admin_site.site_header,
-            'site_title': admin_site.site_title,
-            'title': self.admin_page_title,
-            'name': self.admin_page_title,
-            'original': self.admin_page_title,
-            'is_nav_sidebar_enabled': True,
-            'available_apps': admin.site.get_app_list(self.request),
-            'opts': {
-                'app_label': self.model._meta.app_label,
-                'verbose_name': self.model._meta.verbose_name,
-                'verbose_name_plural': self.model._meta.verbose_name_plural,
-                'model_name': self.model._meta.model_name,
-                'app_config': {
-                    'verbose_name': self.model._meta.app_config.verbose_name,
-                }
-            },
-            'has_permission': admin_site.has_permission(request=self.request),
-        })
+        context.update(
+            {
+                'site_header': admin_site.site_header,
+                'site_title': admin_site.site_title,
+                'title': self.admin_page_title,
+                'name': self.admin_page_title,
+                'original': self.admin_page_title,
+                'is_nav_sidebar_enabled': True,
+                'available_apps': admin.site.get_app_list(self.request),
+                'opts': {
+                    'app_label': self.model._meta.app_label,
+                    'verbose_name': self.model._meta.verbose_name,
+                    'verbose_name_plural': self.model._meta.verbose_name_plural,
+                    'model_name': self.model._meta.model_name,
+                    'app_config': {
+                        'verbose_name': self.model._meta.app_config.verbose_name,
+                    },
+                },
+                'has_permission': admin_site.has_permission(request=self.request),
+            }
+        )
         return context

ai_django_core/drf/serializers.py

@@ -2,7 +2,6 @@
 
 
 class BaseModelSerializer(ModelSerializer):
-
     def validate(self, data):
         """
         Call Model's clean() method to ensure model-level-validation

ai_django_core/drf/tests.py

@@ -9,6 +9,7 @@ class BaseViewSetTestMixin:
     """
     Base test mixin to lower the pain of testing API calls. Focuses on ViewSets.
     """
+
     default_api_user = None
     view_class = None
 
@@ -35,15 +36,22 @@ def validate_authentication_required(self, *, url: str, method: str, view: str):
         """
         Helper method to quickly ensure that a given view needs authorisation.
         """
-        response = self.execute_request(
-            method=method,
-            url=url,
-            viewset_kwargs={method: view})
+        response = self.execute_request(method=method, url=url, viewset_kwargs={method: view})
 
         self.assertIn(response.status_code, [status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN])
 
-    def execute_request(self, *, url, view_kwargs=None, method='get', data=None, view_class=None, user=None,
-                        viewset_kwargs=None, data_format='json') -> Response:
+    def execute_request(
+        self,
+        *,
+        url,
+        view_kwargs=None,
+        method='get',
+        data=None,
+        view_class=None,
+        user=None,
+        viewset_kwargs=None,
+        data_format='json',
+    ) -> Response:
         """
         Helper method which wraps all relevant setup to execute a request to the backends api
 

ai_django_core/graphql/forms/mutations.py

@@ -2,7 +2,7 @@
 from graphene_django.forms.mutation import DjangoModelFormMutation
 from graphql import GraphQLError
 from graphql_jwt.decorators import login_required
-from promise import is_thenable, Promise
+from promise import Promise, is_thenable
 
 
 class DjangoValidatedModelFormMutation(DjangoModelFormMutation):
@@ -24,11 +24,7 @@ def on_resolve(payload):
             try:
                 payload.client_mutation_id = input.get("client_mutation_id")
             except Exception:
-                raise Exception(
-                    "Cannot set client_mutation_id in the payload object {}".format(
-                        repr(payload)
-                    )
-                )
+                raise Exception("Cannot set client_mutation_id in the payload object {}".format(repr(payload)))
             return payload
 
         result = cls.mutate_and_get_payload(root, info, **input)
@@ -51,5 +47,6 @@ class LoginRequiredDjangoModelFormMutation(DjangoValidatedModelFormMutation):
     """
     Ensures that you need to be logged in with GraphQL JWT (json web token) authentication
     """
+
     class Meta:
         abstract = True

ai_django_core/graphql/schemes/mutations.py

@@ -8,6 +8,7 @@ class DeleteMutation(graphene.ClientIDMutation):
     """
     Provides a mutation for handling common delete cases. Exposes methods for custom validation and queryset filtering.
     """
+
     success = graphene.Boolean()
     model = None
 
@@ -63,5 +64,6 @@ class LoginRequiredDeleteMutation(DeleteMutation):
     Deletes an object from the database.
     Ensures user is authenticated with GraphQL-JWT
     """
+
     class Meta:
         abstract = True

ai_django_core/graphql/sentry/views.py

@@ -15,6 +15,7 @@ class SentryGraphQLView(GraphQLView):
         * sentry_sdk >= 0.13.0
         * graphene_django >=2.9.1, <3.0
     """
+
     def execute_graphql_request(self, *args, **kwargs):
         """Extract any exceptions and send them to Sentry"""
         result = super().execute_graphql_request(*args, **kwargs)

ai_django_core/graphql/tests/base_test.py

@@ -1,12 +1,13 @@
 import json
 
-from django.test import TestCase, Client
+from django.test import Client, TestCase
 
 
 class GraphQLTestCase(TestCase):
     """
     Provides a best-practice wrapper for easily testing GraphQL endpoints.
     """
+
     # URL to graphql endpoint
     GRAPHQL_URL = '/graphql/'
     # Here you need to set your graphql schema for the tests
@@ -36,8 +37,7 @@ def query(self, query: str, op_name: str = None, input_data: dict = None):
         if input_data:
             body['variables'] = {'input': input_data}
 
-        resp = self._client.post(self.GRAPHQL_URL, json.dumps(body),
-                                 content_type='application/json')
+        resp = self._client.post(self.GRAPHQL_URL, json.dumps(body), content_type='application/json')
         return resp
 
     def assertResponseNoErrors(self, resp):

ai_django_core/mail/backends/whitelist_smtp.py

@@ -31,8 +31,9 @@ def get_email_regex():
         Getter for configuration variable from the settings.
         Will return a RegEX to match email whitelisted domains.
         """
-        return r'^[\w\-\.]+@(%s)$' % '|'.join(x for x in
-                                              WhitelistEmailBackend.get_domain_whitelist()).replace('.', r'\.')
+        return r'^[\w\-\.]+@(%s)$' % '|'.join(x for x in WhitelistEmailBackend.get_domain_whitelist()).replace(
+            '.', r'\.'
+        )
 
     @staticmethod
     def get_backend_redirect_address() -> str: