codeforlife 0.22.10__tar.gz

codeforlife-0.22.10/LICENSE.md

@@ -0,0 +1,3 @@
+# License
+
+Find our license [here](https://github.com/ocadotechnology/codeforlife-workspace/blob/main/LICENSE.md).

codeforlife-0.22.10/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.1
+Name: codeforlife
+Version: 0.22.10
+Summary: Code for Life's common code.
+Home-page: https://github.com/ocadotechnology/codeforlife-package-python
+Author: Ocado
+Author-email: code-for-life-full-time-xd@ocado.com
+Requires-Python: ==3.12.*
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: asgiref==3.8.1; python_version >= "3.8"
+Requires-Dist: certifi==2024.8.30; python_version >= "3.6"
+Requires-Dist: cfl-common==7.3.5
+Requires-Dist: charset-normalizer==3.4.0; python_full_version >= "3.7.0"
+Requires-Dist: click==8.1.7; python_version >= "3.7"
+Requires-Dist: codeforlife-portal==7.3.5
+Requires-Dist: diff-match-patch==20241021; python_version >= "3.7"
+Requires-Dist: django==3.2.25; python_version >= "3.6"
+Requires-Dist: django-classy-tags==2.0.0
+Requires-Dist: django-cors-headers==4.1.0; python_version >= "3.7"
+Requires-Dist: django-countries==7.3.1
+Requires-Dist: django-csp==3.7
+Requires-Dist: django-filter==23.2; python_version >= "3.7"
+Requires-Dist: django-formtools==2.2
+Requires-Dist: django-import-export==4.0.3; python_version >= "3.8"
+Requires-Dist: django-otp==1.0.2
+Requires-Dist: django-phonenumber-field==6.4.0; python_version >= "3.7"
+Requires-Dist: django-pipeline==2.0.8
+Requires-Dist: django-preventconcurrentlogins==0.8.2
+Requires-Dist: django-ratelimit==3.0.1; python_version >= "3.4"
+Requires-Dist: django-recaptcha==2.0.6
+Requires-Dist: django-reverse-js==0.1.7; python_version >= "3.10"
+Requires-Dist: django-sekizai==2.0.0
+Requires-Dist: django-treebeard==4.3.1
+Requires-Dist: django-two-factor-auth==1.13.2
+Requires-Dist: djangorestframework==3.13.1; python_version >= "3.6"
+Requires-Dist: gunicorn==23.0.0; python_version >= "3.7"
+Requires-Dist: h11==0.14.0; python_version >= "3.7"
+Requires-Dist: idna==3.10; python_version >= "3.6"
+Requires-Dist: importlib-metadata==4.13.0; python_version >= "3.7"
+Requires-Dist: libsass==0.23.0; python_version >= "3.8"
+Requires-Dist: more-itertools==8.7.0; python_version >= "3.5"
+Requires-Dist: numpy==2.1.2; python_version >= "3.10"
+Requires-Dist: packaging==24.1; python_version >= "3.8"
+Requires-Dist: pandas==2.2.3; python_version >= "3.9"
+Requires-Dist: pgeocode==0.4.0; python_version >= "3.8"
+Requires-Dist: phonenumbers==8.12.12
+Requires-Dist: pillow==11.0.0; python_version >= "3.9"
+Requires-Dist: psycopg2-binary==2.9.9; python_version >= "3.7"
+Requires-Dist: pyhamcrest==2.0.2; python_version >= "3.5"
+Requires-Dist: pyjwt==2.6.0; python_version >= "3.7"
+Requires-Dist: pyotp==2.9.0; python_version >= "3.7"
+Requires-Dist: pypng==0.20220715.0
+Requires-Dist: python-dateutil==2.9.0.post0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2"
+Requires-Dist: pytz==2024.2
+Requires-Dist: pyyaml==6.0.2; python_version >= "3.8"
+Requires-Dist: qrcode==7.4.2; python_version >= "3.7"
+Requires-Dist: rapid-router==6.5.3
+Requires-Dist: reportlab==3.6.13; python_version >= "3.7" and python_version < "4"
+Requires-Dist: requests==2.32.2; python_version >= "3.8"
+Requires-Dist: setuptools==74.0.0; python_version >= "3.8"
+Requires-Dist: six==1.16.0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2"
+Requires-Dist: sqlparse==0.5.1; python_version >= "3.8"
+Requires-Dist: tablib==3.5.0; python_version >= "3.8"
+Requires-Dist: typing-extensions==4.12.2; python_version >= "3.8"
+Requires-Dist: tzdata==2024.2; python_version >= "2"
+Requires-Dist: urllib3==2.2.3; python_version >= "3.8"
+Requires-Dist: uvicorn==0.32.0; python_version >= "3.8"
+Requires-Dist: uvicorn-worker==0.2.0; python_version >= "3.8"
+Requires-Dist: zipp==3.20.2; python_version >= "3.8"
+Provides-Extra: dev
+Requires-Dist: asgiref==3.8.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: astroid==3.2.4; python_full_version >= "3.8.0" and extra == "dev"
+Requires-Dist: black==24.8.0; python_version >= "3.8" and extra == "dev"
+Requires-Dist: certifi==2024.8.30; python_version >= "3.6" and extra == "dev"
+Requires-Dist: charset-normalizer==3.4.0; python_full_version >= "3.7.0" and extra == "dev"
+Requires-Dist: click==8.1.7; python_version >= "3.7" and extra == "dev"
+Requires-Dist: coverage[toml]==7.6.4; python_version >= "3.9" and extra == "dev"
+Requires-Dist: dill==0.3.9; python_version >= "3.11" and extra == "dev"
+Requires-Dist: django==3.2.25; python_version >= "3.6" and extra == "dev"
+Requires-Dist: django-extensions==3.2.1; python_version >= "3.6" and extra == "dev"
+Requires-Dist: django-stubs[compatible-mypy]==4.2.6; python_version >= "3.8" and extra == "dev"
+Requires-Dist: django-stubs-ext==5.1.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: django-test-migrations==1.2.0; (python_version >= "3.6" and python_version < "4.0") and extra == "dev"
+Requires-Dist: djangorestframework-stubs[compatible-mypy]==3.14.4; python_version >= "3.8" and extra == "dev"
+Requires-Dist: execnet==2.1.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: idna==3.10; python_version >= "3.6" and extra == "dev"
+Requires-Dist: iniconfig==2.0.0; python_version >= "3.7" and extra == "dev"
+Requires-Dist: isort==5.13.2; python_full_version >= "3.8.0" and extra == "dev"
+Requires-Dist: mccabe==0.7.0; python_version >= "3.6" and extra == "dev"
+Requires-Dist: mypy==1.6.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: mypy-extensions==1.0.0; python_version >= "3.5" and extra == "dev"
+Requires-Dist: packaging==24.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: pathspec==0.12.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: platformdirs==4.3.6; python_version >= "3.8" and extra == "dev"
+Requires-Dist: pluggy==1.5.0; python_version >= "3.8" and extra == "dev"
+Requires-Dist: psutil==6.1.0; extra == "dev"
+Requires-Dist: pydot==1.4.2; (python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3") and extra == "dev"
+Requires-Dist: pylint==3.2.7; python_full_version >= "3.8.0" and extra == "dev"
+Requires-Dist: pylint-django==2.5.5; (python_version >= "3.7" and python_version < "4.0") and extra == "dev"
+Requires-Dist: pylint-plugin-utils==0.8.2; (python_version >= "3.7" and python_version < "4.0") and extra == "dev"
+Requires-Dist: pyparsing==3.0.9; python_full_version >= "3.6.8" and extra == "dev"
+Requires-Dist: pytest==8.3.3; python_version >= "3.8" and extra == "dev"
+Requires-Dist: pytest-cov==5.0.0; python_version >= "3.8" and extra == "dev"
+Requires-Dist: pytest-django==4.5.2; python_version >= "3.5" and extra == "dev"
+Requires-Dist: pytest-env==0.8.1; python_version >= "3.7" and extra == "dev"
+Requires-Dist: pytest-xdist[psutil]==3.5.0; python_version >= "3.7" and extra == "dev"
+Requires-Dist: pytz==2024.2; extra == "dev"
+Requires-Dist: requests==2.32.2; python_version >= "3.8" and extra == "dev"
+Requires-Dist: sqlparse==0.5.1; python_version >= "3.8" and extra == "dev"
+Requires-Dist: tomlkit==0.13.2; python_version >= "3.8" and extra == "dev"
+Requires-Dist: types-pytz==2024.2.0.20241003; python_version >= "3.8" and extra == "dev"
+Requires-Dist: types-pyyaml==6.0.12.20240917; python_version >= "3.8" and extra == "dev"
+Requires-Dist: types-requests==2.32.0.20241016; python_version >= "3.8" and extra == "dev"
+Requires-Dist: typing-extensions==4.12.2; python_version >= "3.8" and extra == "dev"
+Requires-Dist: urllib3==2.2.3; python_version >= "3.8" and extra == "dev"
+
+# codeforlife-package-python
+
+This repo contains CFL's python package. This will be installed into all backend services.
+
+## LICENCE
+In accordance with the [Terms of Use](https://www.codeforlife.education/terms#terms)
+of the Code for Life website, all copyright, trademarks, and other
+intellectual property rights in and relating to Code for Life (including all
+content of the Code for Life website, the Rapid Router application, the
+Kurono application, related software (including any drawn and/or animated
+avatars, whether such avatars have any modifications) and any other games,
+applications or any other content that we make available from time to time) are
+owned by Ocado Innovation Limited.
+
+The source code of the Code for Life portal, the Rapid Router application
+and the Kurono/aimmo application are [licensed under the GNU Affero General
+Public License](https://github.com/ocadotechnology/codeforlife-workspace/blob/main/LICENSE.md).
+All other assets including images, logos, sounds etc., are not covered by
+this licence and no-one may copy, modify, distribute, show in public or
+create any derivative work from these assets.
+
+## Installation
+
+To install this package, do one of the following options.
+
+*Ensure you're installing the package with the required python version. See [setup.py](setup.py).*
+
+*Remember to replace the version number ("0.0.0") with your [desired version](https://github.com/ocadotechnology/codeforlife-package-python/releases).*
+
+**Option 1:** Run `pipenv install` command:
+
+```bash
+pipenv install git+https://github.com/ocadotechnology/codeforlife-package-python.git@v0.0.0#egg=codeforlife
+```
+
+**Option 2:** Add a row to `[packages]` in `Pipfile`:
+
+```toml
+[packages]
+codeforlife = {ref = "v0.0.0", git = "https://github.com/ocadotechnology/codeforlife-package-python.git"}
+```
+
+## Making Changes
+
+To make changes, you must:
+
+1. Branch off of main.
+1. Push your changes on your branch.
+1. Ensure the pipeline runs successfully on your branch.
+1. Have your changes reviewed and approved by a peer.
+1. Merge your branch into the `main` branch.
+1. [Manually trigger](https://github.com/ocadotechnology/codeforlife-package-python/actions/workflows/main.yml)
+the `Main` pipeline for the `main` branch.
+
+### Installing your branch
+
+You may wish to install and integrate your changes into a CFL backend before it's been peer-reviewed.
+
+*Remember to replace the branch name ("my-branch") with your
+[branch](https://github.com/ocadotechnology/codeforlife-package-python/branches)*.
+
+```toml
+[packages]
+codeforlife = {ref = "my-branch", git = "https://github.com/ocadotechnology/codeforlife-package-python.git"}
+```
+
+## Version Release
+
+New versions of this package are automatically created via a GitHub Actions [workflow](.github/workflows/python-package.yml). Versions are determined using the [semantic-release commit message format](https://semantic-release.gitbook.io/semantic-release/#commit-message-format).
+
+A new package may only be released if:
+
+1. there are no formatting errors;
+1. all unit tests pass;
+1. (TODO) test/code coverage is acceptable.

codeforlife-0.22.10/README.md

@@ -0,0 +1,75 @@
+# codeforlife-package-python
+
+This repo contains CFL's python package. This will be installed into all backend services.
+
+## LICENCE
+In accordance with the [Terms of Use](https://www.codeforlife.education/terms#terms)
+of the Code for Life website, all copyright, trademarks, and other
+intellectual property rights in and relating to Code for Life (including all
+content of the Code for Life website, the Rapid Router application, the
+Kurono application, related software (including any drawn and/or animated
+avatars, whether such avatars have any modifications) and any other games,
+applications or any other content that we make available from time to time) are
+owned by Ocado Innovation Limited.
+
+The source code of the Code for Life portal, the Rapid Router application
+and the Kurono/aimmo application are [licensed under the GNU Affero General
+Public License](https://github.com/ocadotechnology/codeforlife-workspace/blob/main/LICENSE.md).
+All other assets including images, logos, sounds etc., are not covered by
+this licence and no-one may copy, modify, distribute, show in public or
+create any derivative work from these assets.
+
+## Installation
+
+To install this package, do one of the following options.
+
+*Ensure you're installing the package with the required python version. See [setup.py](setup.py).*
+
+*Remember to replace the version number ("0.0.0") with your [desired version](https://github.com/ocadotechnology/codeforlife-package-python/releases).*
+
+**Option 1:** Run `pipenv install` command:
+
+```bash
+pipenv install git+https://github.com/ocadotechnology/codeforlife-package-python.git@v0.0.0#egg=codeforlife
+```
+
+**Option 2:** Add a row to `[packages]` in `Pipfile`:
+
+```toml
+[packages]
+codeforlife = {ref = "v0.0.0", git = "https://github.com/ocadotechnology/codeforlife-package-python.git"}
+```
+
+## Making Changes
+
+To make changes, you must:
+
+1. Branch off of main.
+1. Push your changes on your branch.
+1. Ensure the pipeline runs successfully on your branch.
+1. Have your changes reviewed and approved by a peer.
+1. Merge your branch into the `main` branch.
+1. [Manually trigger](https://github.com/ocadotechnology/codeforlife-package-python/actions/workflows/main.yml)
+the `Main` pipeline for the `main` branch.
+
+### Installing your branch
+
+You may wish to install and integrate your changes into a CFL backend before it's been peer-reviewed.
+
+*Remember to replace the branch name ("my-branch") with your
+[branch](https://github.com/ocadotechnology/codeforlife-package-python/branches)*.
+
+```toml
+[packages]
+codeforlife = {ref = "my-branch", git = "https://github.com/ocadotechnology/codeforlife-package-python.git"}
+```
+
+## Version Release
+
+New versions of this package are automatically created via a GitHub Actions [workflow](.github/workflows/python-package.yml). Versions are determined using the [semantic-release commit message format](https://semantic-release.gitbook.io/semantic-release/#commit-message-format).
+
+A new package may only be released if:
+
+1. there are no formatting errors;
+1. all unit tests pass;
+1. (TODO) test/code coverage is acceptable.

codeforlife-0.22.10/codeforlife/__init__.py

@@ -0,0 +1,12 @@
+"""
+© Ocado Group
+Created on 20/02/2024 at 09:28:27(+00:00).
+"""
+
+from pathlib import Path
+
+from .version import __version__
+
+BASE_DIR = Path(__file__).resolve().parent
+DATA_DIR = BASE_DIR.joinpath("data")
+USER_DIR = BASE_DIR.joinpath("user")

codeforlife-0.22.10/codeforlife/_test.py

@@ -0,0 +1,10 @@
+"""
+© Ocado Group
+Created on 12/04/2024 at 14:31:10(+01:00).
+"""
+
+
+def test_import():
+    """Basic test to ensure importing the package does not raise an error."""
+    # pylint: disable-next=unused-import,import-outside-toplevel
+    import codeforlife

codeforlife-0.22.10/codeforlife/app.py

@@ -0,0 +1,44 @@
+"""
+© Ocado Group
+Created on 28/10/2024 at 16:19:47(+00:00).
+"""
+
+import multiprocessing
+import typing as t
+
+from django.core.management import call_command
+from gunicorn.app.base import BaseApplication  # type: ignore[import-untyped]
+
+
+# pylint: disable-next=abstract-method
+class StandaloneApplication(BaseApplication):
+    """A server for an app in a live environment.
+
+    Based off of:
+    https://gist.github.com/Kludex/c98ed6b06f5c0f89fd78dd75ef58b424
+    https://docs.gunicorn.org/en/stable/custom.html
+    """
+
+    def __init__(self, app: t.Callable):
+        call_command("migrate", interactive=False)
+
+        self.options = {
+            "bind": "0.0.0.0:8080",
+            # https://docs.gunicorn.org/en/stable/design.html#how-many-workers
+            "workers": (multiprocessing.cpu_count() * 2) + 1,
+            "worker_class": "uvicorn.workers.UvicornWorker",
+        }
+        self.application = app
+        super().__init__()
+
+    def load_config(self):
+        config = {
+            key: value
+            for key, value in self.options.items()
+            if key in self.cfg.settings and value is not None
+        }
+        for key, value in config.items():
+            self.cfg.set(key.lower(), value)
+
+    def load(self):
+        return self.application

codeforlife-0.22.10/codeforlife/commands/__init__.py

@@ -0,0 +1,7 @@
+"""
+© Ocado Group
+Created on 15/11/2024 at 12:18:24(+00:00).
+"""
+
+from .load_fixtures import LoadFixtures
+from .summarize_fixtures import SummarizeFixtures

codeforlife-0.22.10/codeforlife/commands/load_fixtures.py

@@ -0,0 +1,40 @@
+"""
+© Ocado Group
+Created on 10/06/2024 at 10:44:45(+01:00).
+"""
+
+import os
+import typing as t
+
+from django.apps import apps
+from django.core.management import call_command
+from django.core.management.base import BaseCommand
+
+
+# pylint: disable-next=missing-class-docstring
+class LoadFixtures(BaseCommand):
+    help = "Loads all the fixtures of the specified apps."
+
+    required_app_labels: t.Set[str] = set()
+
+    def add_arguments(self, parser):
+        parser.add_argument("app_labels", nargs="*", type=str)
+
+    def handle(self, *args, **options):
+        fixture_labels: t.List[str] = []
+        for app_label in {*options["app_labels"], *self.required_app_labels}:
+            app_config = apps.app_configs[app_label]
+            fixtures_path = os.path.join(app_config.path, "fixtures")
+
+            self.stdout.write(f"{app_label} fixtures ({fixtures_path}):")
+            for fixture_label in os.listdir(fixtures_path):
+                if fixture_label in fixture_labels:
+                    self.stderr.write(f"Duplicate fixture: {fixture_label}")
+                    return
+
+                self.stdout.write(f"    - {fixture_label}")
+                fixture_labels.append(fixture_label)
+
+            self.stdout.write()
+
+        call_command("loaddata", *fixture_labels)

codeforlife-0.22.10/codeforlife/commands/summarize_fixtures.py

@@ -0,0 +1,86 @@
+"""
+© Ocado Group
+Created on 22/02/2024 at 09:24:27(+00:00).
+"""
+
+import json
+import os
+import typing as t
+from dataclasses import dataclass
+from itertools import groupby
+
+from django.apps import apps
+from django.core.management.base import BaseCommand
+
+from ..types import JsonDict
+
+
+@dataclass(frozen=True)
+class Fixture:
+    """A data model fixture."""
+
+    model: str
+    pk: t.Any
+    fields: JsonDict
+
+
+FixtureDict = t.Dict[str, t.List[Fixture]]
+
+
+# pylint: disable-next=missing-class-docstring
+class SummarizeFixtures(BaseCommand):
+    help = "Summarizes all the listed fixtures."
+
+    required_app_labels: t.Set[str] = set()
+
+    def add_arguments(self, parser):
+        parser.add_argument("app_labels", nargs="*", type=str)
+
+    def _write_pks_per_model(self, fixtures: t.List[Fixture], indents: int = 0):
+        def get_model(fixture: Fixture):
+            return fixture.model.lower()
+
+        fixtures.sort(key=get_model)
+
+        self.stdout.write(f'{"    " * indents}Primary keys per model:')
+
+        for model, group in groupby(fixtures, key=get_model):
+            pks = [fixture.pk for fixture in group]
+            pks.sort()
+
+            self.stdout.write(f'{"    " * (indents + 1)}- {model}: {pks}')
+
+    def write_pks_per_model(self, fixtures: FixtureDict):
+        """Write all the sorted primary keys per model."""
+        self._write_pks_per_model(
+            [
+                fixture
+                for file_fixtures in fixtures.values()
+                for fixture in file_fixtures
+            ]
+        )
+
+    def write_pks_per_file(self, fixtures: FixtureDict):
+        """Write all the sorted primary keys per file, per model."""
+        self.stdout.write("Primary keys per file:")
+
+        for file, file_fixtures in fixtures.items():
+            self.stdout.write(f"    - {file}")
+            self._write_pks_per_model(file_fixtures, indents=2)
+
+    def handle(self, *args, **options):
+        fixtures: FixtureDict = {}
+        for app_label in {*options["app_labels"], *self.required_app_labels}:
+            app_config = apps.app_configs[app_label]
+            fixtures_path = os.path.join(app_config.path, "fixtures")
+
+            for fixture_name in os.listdir(fixtures_path):
+                fixture_path = os.path.join(fixtures_path, fixture_name)
+                with open(fixture_path, "r", encoding="utf-8") as fixture:
+                    fixtures[fixture_path] = [
+                        Fixture(**fixture) for fixture in json.load(fixture)
+                    ]
+
+        self.write_pks_per_model(fixtures)
+        self.stdout.write()
+        self.write_pks_per_file(fixtures)

codeforlife-0.22.10/codeforlife/filters.py

@@ -0,0 +1,33 @@
+"""
+© Ocado Group
+Created on 26/07/2024 at 11:26:14(+01:00).
+"""
+
+from django.db.models.query import QuerySet
+
+# pylint: disable-next=line-too-long
+from django_filters.rest_framework import (  # type: ignore[import-untyped] # isort: skip
+    FilterSet as _FilterSet,
+)
+
+
+class FilterSet(_FilterSet):
+    """Base filter set all other filter sets must inherit."""
+
+    @staticmethod
+    def make_exclude_field_list_method(field: str):
+        """Make a class-method that excludes a list of values for a field.
+
+        Args:
+            field: The field to exclude a list of values for.
+
+        Returns:
+            A class-method.
+        """
+
+        def method(self: FilterSet, queryset: QuerySet, name: str, *args):
+            return queryset.exclude(
+                **{f"{field}__in": self.request.GET.getlist(name)}
+            )
+
+        return method

codeforlife-0.22.10/codeforlife/forms.py

@@ -0,0 +1,81 @@
+"""
+© Ocado Group
+Created on 07/11/2024 at 15:08:33(+00:00).
+"""
+
+import typing as t
+
+from django import forms
+from django.contrib.auth import authenticate
+from django.core.exceptions import ValidationError
+from django.core.handlers.wsgi import WSGIRequest
+
+from .models import AbstractBaseUser
+from .types import get_arg
+
+AnyAbstractBaseUser = t.TypeVar("AnyAbstractBaseUser", bound=AbstractBaseUser)
+
+
+class BaseLoginForm(forms.Form, t.Generic[AnyAbstractBaseUser]):
+    """Base login form that all other login forms must inherit."""
+
+    user: AnyAbstractBaseUser
+
+    @classmethod
+    def get_user_class(cls) -> t.Type[AnyAbstractBaseUser]:
+        """Get the user class."""
+        return get_arg(cls, 0)
+
+    def __init__(self, request: WSGIRequest, *args, **kwargs):
+        self.request = request
+        super().__init__(*args, **kwargs)
+
+    def clean(self):
+        """Authenticates a user.
+
+        Raises:
+            ValidationError: If there are form errors.
+            ValidationError: If the user's credentials were incorrect.
+            ValidationError: If the user's account is deactivated.
+
+        Returns:
+            The cleaned form data.
+        """
+
+        if self.errors:
+            raise ValidationError(
+                "Found form errors. Skipping authentication.",
+                code="form_errors",
+            )
+
+        user = authenticate(
+            self.request,
+            **{key: self.cleaned_data[key] for key in self.fields.keys()}
+        )
+        if user is None:
+            raise ValidationError(
+                self.get_invalid_login_error_message(),
+                code="invalid_login",
+            )
+        if not isinstance(user, self.get_user_class()):
+            raise ValidationError(
+                "Incorrect user class.",
+                code="incorrect_user_class",
+            )
+        if not user.is_active:
+            raise ValidationError(
+                "User is not active",
+                code="user_not_active",
+            )
+
+        self.user = user
+
+        return self.cleaned_data
+
+    def get_invalid_login_error_message(self) -> str:
+        """Returns the error message if the user failed to login.
+
+        Raises:
+            NotImplementedError: If message is not set.
+        """
+        raise NotImplementedError()