From 0373778f06f8935413210b812690329df78131a5 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Wed, 4 Sep 2024 16:01:39 +0100 Subject: [PATCH 01/14] Bump and align .pre-commit-config.yaml repos --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a32918b..c1d3e48 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,7 +3,7 @@ exclude: tests/etc/user-* repos: - repo: https://github.com/PyCQA/bandit - rev: 1.7.7 + rev: 1.7.8 hooks: - id: bandit args: @@ -13,7 +13,7 @@ repos: rev: 24.2.0 hooks: - id: black - language_version: python3.11 + language_version: python3.12 - repo: https://github.com/pycqa/flake8 rev: 7.0.0 From f1d3b3c7bcc1a407819d9562351990835b91ef0d Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Wed, 4 Sep 2024 16:18:51 +0100 Subject: [PATCH 02/14] Bump and align .pre-commit-config.yaml repos src: edc-qareports --- .pre-commit-config.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c1d3e48..c3fd69a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,20 +3,20 @@ exclude: tests/etc/user-* repos: - repo: https://github.com/PyCQA/bandit - rev: 1.7.8 + rev: 1.7.9 hooks: - id: bandit args: - "-x *test*.py" - repo: https://github.com/psf/black - rev: 24.2.0 + rev: 24.8.0 hooks: - id: black language_version: python3.12 - repo: https://github.com/pycqa/flake8 - rev: 7.0.0 + rev: 7.1.1 hooks: - id: flake8 args: @@ -28,7 +28,7 @@ repos: - id: isort - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v4.6.0 hooks: - id: requirements-txt-fixer files: requirements/.*\.txt$ @@ -42,7 +42,7 @@ repos: - id: detect-private-key - repo: https://github.com/adrienverge/yamllint - rev: v1.34.0 + rev: v1.35.1 hooks: - id: yamllint args: From 6d31b78bd65b953ee1843ef19fc7d4e9f0d21e70 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Wed, 4 Sep 2024 16:47:47 +0100 Subject: [PATCH 03/14] Add check-toml hook (pre-commit-hooks) --- .pre-commit-config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c3fd69a..892b227 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -38,6 +38,7 @@ repos: - id: check-docstring-first - id: check-executables-have-shebangs - id: check-merge-conflict + - id: check-toml - id: debug-statements - id: detect-private-key From 1d69fae0b89a6df571c223d46d6599818d7c231c Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Wed, 4 Sep 2024 17:08:30 +0100 Subject: [PATCH 04/14] Sort hooks by id (pre-commit-hooks) --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 892b227..78a9907 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,17 +30,17 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 hooks: - - id: requirements-txt-fixer - files: requirements/.*\.txt$ - - id: trailing-whitespace - id: check-added-large-files - - id: fix-byte-order-marker - id: check-docstring-first - id: check-executables-have-shebangs - id: check-merge-conflict - id: check-toml - id: debug-statements - id: detect-private-key + - id: fix-byte-order-marker + - id: requirements-txt-fixer + files: requirements/.*\.txt$ + - id: trailing-whitespace - repo: https://github.com/adrienverge/yamllint rev: v1.35.1 From e62ce6998d7725baa2df6f46f8d75e4420507e99 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Thu, 5 Sep 2024 17:15:16 +0100 Subject: [PATCH 05/14] Align Tox, GH Actions, setup.cfg (py312,dj42,dj51) Includes: - align pyproject.toml files - align build.yml files - align setup.cfg (somewhat) - add Python 3.12 support - add Django 5.1 support, tests - drop Python 3.11 support - drop Django 5.0 support - fix (some) typos --- .github/workflows/build.yml | 4 ++-- pyproject.toml | 18 ++++++++---------- setup.cfg | 6 +++--- 3 files changed, 13 insertions(+), 15 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 60620ab..dd67298 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,8 +13,9 @@ jobs: fail-fast: false matrix: python-version: ['3.12'] - django-version: ['4.2', '5.0', '5.1', 'dev'] + django-version: ['4.2', '5.1', 'dev'] database-engine: ["mysql", "postgres"] + services: mysql: image: mysql:latest @@ -68,7 +69,6 @@ jobs: python -m pip install --upgrade pip python -m pip install -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/tox.txt - - name: Tox tests run: | tox -v diff --git a/pyproject.toml b/pyproject.toml index cd9712f..ec61418 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,12 +6,12 @@ version_file="_version.py" [tool.black] line-length = 95 -target-version = ["py311"] +target-version = ["py312"] extend-exclude = '''^(.*\/)*\b(migrations)\b($|\/.*$)''' [tool.isort] profile = "black" -py_version = "311" +py_version = "312" skip = [".tox", ".eggs", "migrations"] [tool.coverage.run] @@ -35,22 +35,20 @@ exclude_lines = [ legacy_tox_ini = """ [tox] envlist = - py{311}-dj{42,50,dev}, - py{312}-dj{50}, + py{312}-dj{42,51,dev}, lint isolated_build = true [gh-actions] python = - 3.11: py311, lint - 3.12: py312 + 3.12: py312, lint [gh-actions:env] DJANGO = - 4.2: dj42, lint - 5.0: dj50 - dev: djdev + 4.2: dj42 + 5.1: dj51 + dev: djdev, lint [testenv] deps = @@ -59,7 +57,7 @@ deps = -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/edc.txt -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/third_party_dev.txt dj42: Django>=4.2,<5.0 - dj50: Django>=5.0 + dj51: Django>=5.1,<5.2 djdev: https://github.com/django/django/tarball/main commands = diff --git a/setup.cfg b/setup.cfg index 66ae399..c6d6d6b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -13,15 +13,15 @@ classifiers= Environment :: Web Environment Framework :: Django Framework :: Django :: 4.2 + Framework :: Django :: 5.1 Intended Audience :: Developers Intended Audience :: Science/Research Operating System :: OS Independent - Programming Language :: Python :: 3.11 + Programming Language :: Python :: 3.12 License :: OSI Approved :: GNU General Public License v3 (GPLv3) - [options] -python_requires = >=3.11 +python_requires = >=3.12 zip_safe = False include_package_data = True packages = find: From 499fd9e52a85fe19bac08e63099c432cb644aed4 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Fri, 6 Sep 2024 15:34:53 +0100 Subject: [PATCH 06/14] Remove explicit update of `coverage[toml]` Latest version is already installed as part of: https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/tox.txt --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index ec61418..2e21834 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,7 +61,7 @@ deps = djdev: https://github.com/django/django/tarball/main commands = - pip install -U pip coverage[toml] + pip install -U pip pip --version pip freeze coverage run -a runtests.py From 9c1039cb1529b8ffd31980ea585dc3c5bc8bbb5a Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Thu, 10 Oct 2024 17:36:49 +0100 Subject: [PATCH 07/14] Bump pre-commit repos (bandit, black and pre-commit-hooks) --- .pre-commit-config.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 78a9907..6718a49 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,14 +3,14 @@ exclude: tests/etc/user-* repos: - repo: https://github.com/PyCQA/bandit - rev: 1.7.9 + rev: 1.7.10 hooks: - id: bandit args: - "-x *test*.py" - repo: https://github.com/psf/black - rev: 24.8.0 + rev: 24.10.0 hooks: - id: black language_version: python3.12 @@ -28,7 +28,7 @@ repos: - id: isort - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.6.0 + rev: v5.0.0 hooks: - id: check-added-large-files - id: check-docstring-first From e1929c92969b5e324d35958189dda219eb003747 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Fri, 11 Oct 2024 13:07:55 +0100 Subject: [PATCH 08/14] Add Python 3.13, remove Django 4.2 tox/GH actions test runners --- .github/workflows/build.yml | 4 ++-- pyproject.toml | 8 ++++---- setup.cfg | 1 - 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index dd67298..950e9aa 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,8 +12,8 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.12'] - django-version: ['4.2', '5.1', 'dev'] + python-version: ['3.12', '3.13'] + django-version: ['5.1', 'dev'] database-engine: ["mysql", "postgres"] services: diff --git a/pyproject.toml b/pyproject.toml index 2e21834..b0eadfa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,18 +35,18 @@ exclude_lines = [ legacy_tox_ini = """ [tox] envlist = - py{312}-dj{42,51,dev}, + py{312,313}-dj{51,dev}, lint isolated_build = true [gh-actions] python = - 3.12: py312, lint + 3.12: py312 + 3.13: py313, lint [gh-actions:env] DJANGO = - 4.2: dj42 5.1: dj51 dev: djdev, lint @@ -56,12 +56,12 @@ deps = -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/test_utils.txt -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/edc.txt -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/third_party_dev.txt - dj42: Django>=4.2,<5.0 dj51: Django>=5.1,<5.2 djdev: https://github.com/django/django/tarball/main commands = pip install -U pip + python --version pip --version pip freeze coverage run -a runtests.py diff --git a/setup.cfg b/setup.cfg index c6d6d6b..1517c3a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -12,7 +12,6 @@ keywords = django Edc sites, clinicedc, clinical trials classifiers= Environment :: Web Environment Framework :: Django - Framework :: Django :: 4.2 Framework :: Django :: 5.1 Intended Audience :: Developers Intended Audience :: Science/Research From 9a20a37a7151c93aa0b7451e79d445bdce593e87 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Fri, 11 Oct 2024 20:23:29 +0100 Subject: [PATCH 09/14] Align, add `build-backend` to pyproject.toml --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index b0eadfa..b6ef263 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,9 @@ [build-system] requires = ["setuptools>=60", "setuptools-scm>=8.0"] +build-backend = "setuptools.build_meta" [tool.setuptools_scm] -version_file="_version.py" +version_file = "_version.py" [tool.black] line-length = 95 From 986dd195bae95decbdb6635ab489fa1f9b3f87e5 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Mon, 18 Nov 2024 14:19:37 +0000 Subject: [PATCH 10/14] pre-commit: add `check-yaml` hook --- .pre-commit-config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6718a49..c4ac7ed 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -35,6 +35,7 @@ repos: - id: check-executables-have-shebangs - id: check-merge-conflict - id: check-toml + - id: check-yaml - id: debug-statements - id: detect-private-key - id: fix-byte-order-marker From d6e45e0db97b46ffc2be384e6247f64e91ca860c Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Mon, 18 Nov 2024 16:25:19 +0000 Subject: [PATCH 11/14] pre-commit: add `end-of-file-fixer` hook, and run on all files --- .coveragerc | 2 +- .pre-commit-config.yaml | 1 + AUTHORS | 2 +- CHANGES | 1 - README.rst | 1 - 5 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.coveragerc b/.coveragerc index 5d18877..00d6b92 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,4 +1,4 @@ [run] include = edc_sites/* omit = edc_sites/tests/*,edc_sites/migrations/* -branch = 1 \ No newline at end of file +branch = 1 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c4ac7ed..bace820 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -38,6 +38,7 @@ repos: - id: check-yaml - id: debug-statements - id: detect-private-key + - id: end-of-file-fixer - id: fix-byte-order-marker - id: requirements-txt-fixer files: requirements/.*\.txt$ diff --git a/AUTHORS b/AUTHORS index 3bc0afa..eb5e7d3 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1 +1 @@ -Erik van Widenfelt \ No newline at end of file +Erik van Widenfelt diff --git a/CHANGES b/CHANGES index f2f7429..aae0dc1 100644 --- a/CHANGES +++ b/CHANGES @@ -5,4 +5,3 @@ - feature to limit to related site in FK and M2M - filter queryset by site - check for site attr - diff --git a/README.rst b/README.rst index 14b5256..01919bc 100644 --- a/README.rst +++ b/README.rst @@ -226,4 +226,3 @@ For example: .. _sites_framework: https://docs.djangoproject.com/en/dev/ref/contrib/sites/ __ sites_framework_ - From 32740402c2463471e8bf99a46ba6b76ccfa3c0f7 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Tue, 19 Nov 2024 12:43:43 +0000 Subject: [PATCH 12/14] Remove `third_party_dev.txt` deps (already referenced in `edc.txt`) --- pyproject.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index b6ef263..da8104c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,7 +56,6 @@ deps = -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/tox.txt -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/test_utils.txt -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/edc.txt - -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/third_party_dev.txt dj51: Django>=5.1,<5.2 djdev: https://github.com/django/django/tarball/main From 6abe59fa62934bd02158b84747f74efdb83c87e6 Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Tue, 19 Nov 2024 16:10:36 +0000 Subject: [PATCH 13/14] Add pre-commit env/runner to Tox/GH Actions --- pyproject.toml | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index da8104c..6a581d8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,18 +38,19 @@ legacy_tox_ini = """ envlist = py{312,313}-dj{51,dev}, lint + pre-commit isolated_build = true [gh-actions] python = - 3.12: py312 - 3.13: py313, lint + 3.12: py312, lint, pre-commit + 3.13: py313 [gh-actions:env] DJANGO = 5.1: dj51 - dev: djdev, lint + dev: djdev, lint, pre-commit [testenv] deps = @@ -70,7 +71,19 @@ commands = [testenv:lint] deps = -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/lint.txt commands = + python --version + pip --version + pip freeze isort --profile=black --check --diff . black --check --diff . flake8 . + +[testenv:pre-commit] +deps = pre-commit +commands = + python --version + pip --version + pip freeze + pre-commit autoupdate + pre-commit run --all-files """ From b64cda786934918ece7e41e4d75840be07b0070a Mon Sep 17 00:00:00 2001 From: Jonathan Willitts Date: Wed, 20 Nov 2024 15:17:45 +0000 Subject: [PATCH 14/14] Refactor imports to happen when methods called (fixes intecomm-form-validators tests failing to run) --- edc_sites/modelform_mixins.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/edc_sites/modelform_mixins.py b/edc_sites/modelform_mixins.py index 6e296c3..92bab53 100644 --- a/edc_sites/modelform_mixins.py +++ b/edc_sites/modelform_mixins.py @@ -1,7 +1,12 @@ from __future__ import annotations +from typing import TYPE_CHECKING, Type + from django import forms -from django.contrib.sites.models import Site +from django.apps import apps as django_apps + +if TYPE_CHECKING: + from django.contrib.sites.models import Site __all__ = ["SiteModelFormMixin"] @@ -26,12 +31,18 @@ def clean(self) -> dict: self.validate_with_current_site() return cleaned_data + @property + def site_model_cls(self) -> Type[Site]: + return django_apps.get_model("sites.site") + @property def site(self) -> Site: if related_visit := getattr(self, "related_visit", None): return related_visit.site return ( - self.cleaned_data.get("site") or self.instance.site or Site.objects.get_current() + self.cleaned_data.get("site") + or self.instance.site + or self.site_model_cls.objects.get_current() ) def validate_with_current_site(self) -> None: