dbca-utils 2.0.3__tar.gz → 2.1.0__tar.gz

{dbca_utils-2.0.3 → dbca_utils-2.1.0}/PKG-INFO

@@ -1,31 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dbca-utils
-Version: 2.0.3
+Version: 2.1.0
 Summary: Utilities for DBCA Django apps
-License: Apache-2.0
-Author: Rocky Chen
-Author-email: rocky.chen@dbca.wa.gov.au
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Web Environment
+Author-email: Rocky Chen <rocky.chen@dbca.wa.gov.au>, Ashley Felton <ashley.felton@dbca.wa.gov.au>
+Project-URL: Homepage, https://github.com/dbca-wa/dbca-utils
+Project-URL: Repository, https://github.com/dbca-wa/dbca-utils.git
+Project-URL: Changelog, https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md
+Project-URL: GitHub, https://github.com/dbca-wa/dbca-utils
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.2
+Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: django (>=3.2,<5.1)
+Requires-Python: <4.0,>=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django<6,>=4
+Dynamic: license-file
 
 # Overview
 
@@ -33,30 +36,43 @@ DBCA Django utility classes and functions.
 
 ## Development
 
-This project for development is using
-[Poetry](https://python-poetry.org/docs/) to install and manage a virtual Python
-environment. With Poetry installed, change into the project directory and run:
+The recommended way to set up this project for development is using
+[uv](https://docs.astral.sh/uv/)
+to install and manage a Python virtual environment.
+With uv installed, install the required Python version (see `pyproject.toml`). Example:
+
+    uv python install 3.12
 
-    poetry install
+Change into the project directory and run:
+
+    uv python pin 3.12
+    uv sync
 
 Activate the virtualenv like so:
 
-    poetry shell
+    source .venv/bin/activate
 
 Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
 
-    pytest -v
+    pytest -sv
     tox -v
 
 ## Releases
 
 Tagged releases are built and pushed to PyPI automatically using a GitHub
 workflow in the project. Update the project version in `pyproject.toml` and
-tag the required commit with the same value to trigger a release.
+tag the required commit with the same value to trigger a release. Packages
+can also be built and uploaded manually, if desired.
+
+Build the project locally using uv, [publish to the PyPI registry](https://docs.astral.sh/uv/guides/publish/#publishing-your-package)
+using the same tool if you require:
+
+    uv build
+    uv publish
 
 ## Installation
 
-1. Install via pip/Poetry/etc.: `pip install dbca-utils`
+1. Install via pip/etc.: `pip install dbca-utils`
 
 ## SSO Login Middleware
 
@@ -89,8 +105,7 @@ MIDDLEWARE = [
 
 `AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
 
-- creator - FK to `AUTH_USER_MODEL`, used to record the object creator
-- modifier - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
-- created - a timestamp that is set on initial object save
-- modified - an auto-updating timestamp (on each object save)
-
+- `creator` - FK to `AUTH_USER_MODEL`, used to record the object creator
+- `modifier` - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- `created` - a timestamp that is set on initial object save
+- `modified` - an auto-updating timestamp (on each object save)

{dbca_utils-2.0.3 → dbca_utils-2.1.0}/README.md

@@ -4,30 +4,43 @@ DBCA Django utility classes and functions.
 
 ## Development
 
-This project for development is using
-[Poetry](https://python-poetry.org/docs/) to install and manage a virtual Python
-environment. With Poetry installed, change into the project directory and run:
+The recommended way to set up this project for development is using
+[uv](https://docs.astral.sh/uv/)
+to install and manage a Python virtual environment.
+With uv installed, install the required Python version (see `pyproject.toml`). Example:
 
-    poetry install
+    uv python install 3.12
+
+Change into the project directory and run:
+
+    uv python pin 3.12
+    uv sync
 
 Activate the virtualenv like so:
 
-    poetry shell
+    source .venv/bin/activate
 
 Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
 
-    pytest -v
+    pytest -sv
     tox -v
 
 ## Releases
 
 Tagged releases are built and pushed to PyPI automatically using a GitHub
 workflow in the project. Update the project version in `pyproject.toml` and
-tag the required commit with the same value to trigger a release.
+tag the required commit with the same value to trigger a release. Packages
+can also be built and uploaded manually, if desired.
+
+Build the project locally using uv, [publish to the PyPI registry](https://docs.astral.sh/uv/guides/publish/#publishing-your-package)
+using the same tool if you require:
+
+    uv build
+    uv publish
 
 ## Installation
 
-1. Install via pip/Poetry/etc.: `pip install dbca-utils`
+1. Install via pip/etc.: `pip install dbca-utils`
 
 ## SSO Login Middleware
 
@@ -60,7 +73,7 @@ MIDDLEWARE = [
 
 `AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
 
-- creator - FK to `AUTH_USER_MODEL`, used to record the object creator
-- modifier - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
-- created - a timestamp that is set on initial object save
-- modified - an auto-updating timestamp (on each object save)
+- `creator` - FK to `AUTH_USER_MODEL`, used to record the object creator
+- `modifier` - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- `created` - a timestamp that is set on initial object save
+- `modified` - an auto-updating timestamp (on each object save)

{dbca_utils-2.0.3 → dbca_utils-2.1.0}/pyproject.toml

@@ -1,51 +1,47 @@
-[tool.poetry]
+[project]
 name = "dbca-utils"
-version = "2.0.3"
+version = "2.1.0"
 description = "Utilities for DBCA Django apps"
 authors = [
-  "Rocky Chen <rocky.chen@dbca.wa.gov.au>",
-  "Ashley Felton <ashley.felton@dbca.wa.gov.au>",
+  { name = "Rocky Chen", email = "rocky.chen@dbca.wa.gov.au" },
+  { name = "Ashley Felton", email = "ashley.felton@dbca.wa.gov.au" },
 ]
-license = "Apache-2.0"
 readme = "README.md"
 classifiers = [
   "Framework :: Django",
-  "Framework :: Django :: 3.2",
   "Framework :: Django :: 4.0",
   "Framework :: Django :: 4.2",
   "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.2",
   "Environment :: Web Environment",
   "Intended Audience :: Developers",
   "Development Status :: 5 - Production/Stable",
   "License :: OSI Approved :: Apache Software License",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Topic :: Software Development :: Libraries",
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-
-
-[tool.poetry.group.dev.dependencies]
-pytest-django = "^4.9.0"
-pytest-sugar = "^1.0.0"
-tox = "^4.23.2"
+requires-python = ">=3.10,<4.0"
+dependencies = ["django>=4,<6"]
 
 [project.urls]
-homepage = "https://github.com/dbca-wa/dbca-utils"
-source = "https://github.com/dbca-wa/dbca-utils.git"
-changelog = "https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md"
+Homepage = "https://github.com/dbca-wa/dbca-utils"
+Repository = "https://github.com/dbca-wa/dbca-utils.git"
+Changelog = "https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md"
+GitHub = "https://github.com/dbca-wa/dbca-utils"
 
-[tool.poetry.dependencies]
-python = "^3.9"
-django = ">=3.2,<5.1"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+[dependency-groups]
+dev = [
+  "pytest-django>=4.11.0",
+  "pytest-sugar>=1.0.0",
+  "tox>=4.25.0",
+  "tox-uv>=1.25.0",
+]
 
 [tool.pytest.ini_options]
 # https://pytest-django.readthedocs.io/en/latest/configuring_django.html#pyproject-toml-settings

dbca_utils-2.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{dbca_utils-2.0.3 → dbca_utils-2.1.0}/src/dbca_utils/middleware.py

@@ -1,10 +1,10 @@
-from django import http, VERSION
+from django import http
 from django.conf import settings
-from django.contrib.auth import login, logout, get_user_model
+from django.contrib.auth import get_user_model, login, logout
+from django.contrib.auth.middleware import AuthenticationMiddleware, get_user
+from django.utils import timezone
 from django.utils.deprecation import MiddlewareMixin
 from django.utils.functional import SimpleLazyObject
-from django.utils import timezone
-from django.contrib.auth.middleware import AuthenticationMiddleware, get_user
 
 from dbca_utils.utils import env
 
@@ -17,10 +17,14 @@ def sync_usergroups(user, groups):
     from django.contrib.auth.models import Group
 
     usergroups = (
-        [Group.objects.get_or_create(name=name)[0] for name in groups.split(",")] if groups else []
+        [Group.objects.get_or_create(name=name)[0] for name in groups.split(",")]
+        if groups
+        else []
     )
     usergroups.sort(key=lambda o: o.id)
-    existing_usergroups = list(user.groups.exclude(name__in=LOCAL_USERGROUPS).order_by("id"))
+    existing_usergroups = list(
+        user.groups.exclude(name__in=LOCAL_USERGROUPS).order_by("id")
+    )
     index1 = 0
     index2 = 0
     len1 = len(usergroups)
@@ -96,7 +100,6 @@ class SSOLoginMiddleware(MiddlewareMixin):
     """
 
     def process_request(self, request):
-
         # Logout headers included with request.
         if (
             (
@@ -118,10 +121,7 @@ class SSOLoginMiddleware(MiddlewareMixin):
             # auth2 not enabled
             return
 
-        if VERSION < (2, 0):
-            user_authenticated = request.user.is_authenticated()
-        else:
-            user_authenticated = request.user.is_authenticated
+        user_authenticated = request.user.is_authenticated
 
         # Auth2 is enabled.
         # Request user is not authenticated.
@@ -158,7 +158,9 @@ class SSOLoginMiddleware(MiddlewareMixin):
                 user = User.objects.filter(email__iexact=attributemap["email"])[0]
             elif (
                 User.__name__ != "EmailUser"
-                and User.objects.filter(username__iexact=attributemap["username"]).exists()
+                and User.objects.filter(
+                    username__iexact=attributemap["username"]
+                ).exists()
             ):
                 user = User.objects.filter(username__iexact=attributemap["username"])[0]
             else:

{dbca_utils-2.0.3 → dbca_utils-2.1.0}/src/dbca_utils/utils.py

@@ -1,15 +1,23 @@
-import ast
 import os
+from ast import literal_eval
 
 
 def env(key, default=None, required=False, value_type=None):
     """
     Retrieves environment variables and returns Python natives. The (optional)
-    default will be returned if the environment variable does not exist.
+    `default` value will be returned if the environment variable does not exist.
+    Setting `required` will cause an Exception to be thrown if the variable does
+    not exist.
+    Setting `value_type` will try to ensure that the returned value is of the
+    nominated type (within reason).
+    Supported Python object types: str, list, tuple, bool, int, float.
     """
+    value = None
+
     try:
         value = os.environ[key]
-        value = ast.literal_eval(value)
+        # Evaluate the environment variable value as a Python object.
+        value = literal_eval(value)
     except (SyntaxError, ValueError):
         pass
     except KeyError:
@@ -17,14 +25,17 @@ def env(key, default=None, required=False, value_type=None):
             return default
         raise Exception(f"Missing required environment variable {key}")
 
-    if value_type is None:
-        if default is not None:
-            value_type = default.__class__
+    if value_type is None and default is not None:
+        # If we've passed a default return value but not set a value_type, use the
+        # default's type.
+        value_type = default.__class__
 
     if value_type is None:
         return value
     elif isinstance(value, value_type):
         return value
+    elif issubclass(value_type, str):
+        return str(value)
     elif issubclass(value_type, list):
         if isinstance(value, tuple):
             return list(value)
@@ -53,7 +64,7 @@ def env(key, default=None, required=False, value_type=None):
             return False
         else:
             raise Exception(
-                f"{key} is a boolean environment variable and only accepts 'true' ,'false' and '' (case-insensitive), but the configured value is '{value}'"
+                f"{key} is a boolean environment variable and only accepts 'true', 'false' or '' (case-insensitive), but the configured value is '{value}'"
             )
     elif issubclass(value_type, int):
         return int(value)
@@ -61,5 +72,5 @@ def env(key, default=None, required=False, value_type=None):
         return float(value)
     else:
         raise Exception(
-            f"{key} is a {value_type} environment variable, but {value_type} is not supported now"
+            f"{key} is a {value_type} environment variable, but {value_type} is not supported"
         )

dbca_utils-2.1.0/src/dbca_utils.egg-info/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: dbca-utils
+Version: 2.1.0
+Summary: Utilities for DBCA Django apps
+Author-email: Rocky Chen <rocky.chen@dbca.wa.gov.au>, Ashley Felton <ashley.felton@dbca.wa.gov.au>
+Project-URL: Homepage, https://github.com/dbca-wa/dbca-utils
+Project-URL: Repository, https://github.com/dbca-wa/dbca-utils.git
+Project-URL: Changelog, https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md
+Project-URL: GitHub, https://github.com/dbca-wa/dbca-utils
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.2
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django<6,>=4
+Dynamic: license-file
+
+# Overview
+
+DBCA Django utility classes and functions.
+
+## Development
+
+The recommended way to set up this project for development is using
+[uv](https://docs.astral.sh/uv/)
+to install and manage a Python virtual environment.
+With uv installed, install the required Python version (see `pyproject.toml`). Example:
+
+    uv python install 3.12
+
+Change into the project directory and run:
+
+    uv python pin 3.12
+    uv sync
+
+Activate the virtualenv like so:
+
+    source .venv/bin/activate
+
+Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
+
+    pytest -sv
+    tox -v
+
+## Releases
+
+Tagged releases are built and pushed to PyPI automatically using a GitHub
+workflow in the project. Update the project version in `pyproject.toml` and
+tag the required commit with the same value to trigger a release. Packages
+can also be built and uploaded manually, if desired.
+
+Build the project locally using uv, [publish to the PyPI registry](https://docs.astral.sh/uv/guides/publish/#publishing-your-package)
+using the same tool if you require:
+
+    uv build
+    uv publish
+
+## Installation
+
+1. Install via pip/etc.: `pip install dbca-utils`
+
+## SSO Login Middleware
+
+This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
+The logout view will redirect to a separate logout page which clears the SSO session.
+
+### Usage
+
+Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
+`django.contrib.sessions.middleware.SessionMiddleware` and
+`django.contrib.auth.middleware.AuthenticationMiddleware`.
+Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
+as this middleware depends on it for retrieving the logged in user for a session.
+Note that the middleware will still work without it, but will reauthenticate the session
+on every request, and `request.user.is_authenticated` won't work properly/will be false.
+
+Example:
+
+```python
+MIDDLEWARE = [
+    ...,
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'dbca_utils.middleware.SSOLoginMiddleware'
+    ...,
+]
+```
+
+## Audit model mixin
+
+`AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
+
+- `creator` - FK to `AUTH_USER_MODEL`, used to record the object creator
+- `modifier` - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- `created` - a timestamp that is set on initial object save
+- `modified` - an auto-updating timestamp (on each object save)

dbca_utils-2.1.0/src/dbca_utils.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+src/dbca_utils/__init__.py
+src/dbca_utils/middleware.py
+src/dbca_utils/models.py
+src/dbca_utils/utils.py
+src/dbca_utils.egg-info/PKG-INFO
+src/dbca_utils.egg-info/SOURCES.txt
+src/dbca_utils.egg-info/dependency_links.txt
+src/dbca_utils.egg-info/requires.txt
+src/dbca_utils.egg-info/top_level.txt
+tests/tests.py

dbca_utils-2.1.0/src/dbca_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dbca_utils-2.1.0/src/dbca_utils.egg-info/requires.txt

@@ -0,0 +1 @@
+django<6,>=4

dbca_utils-2.1.0/src/dbca_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+dbca_utils

dbca_utils-2.1.0/tests/tests.py

@@ -0,0 +1,111 @@
+import os
+import random
+import string
+
+import pytest
+from django.contrib.auth.models import User
+from django.test import TestCase
+from django.test.client import Client
+from django.urls import reverse
+
+from dbca_utils.utils import env
+
+from .models import TestModel
+
+# Define an environment variable for testing.
+letters = string.ascii_letters
+TEST_VAR = "".join(random.choice(letters) for _ in range(128))
+TEST_NAME = "".join(random.choice(letters) for _ in range(128))
+os.environ["TEST_ENVIRONMENT_VAR"] = TEST_VAR
+
+os.environ["TEST_STR"] = "string"
+os.environ["TEST_INT"] = "42"
+os.environ["TEST_FLOAT"] = "3.14159"
+os.environ["TEST_LIST"] = "[1,2,3,4,5]"
+os.environ["TEST_TUPLE"] = "('a', 'b', 'c')"
+os.environ["TEST_BOOL"] = "False"
+
+
+class TestUtils(TestCase):
+    def test_env_returns_str(self):
+        test_str = env("TEST_STR")
+        self.assertTrue(isinstance(test_str, str))
+
+    def test_env_returns_int(self):
+        test_int = env("TEST_INT")
+        self.assertTrue(isinstance(test_int, int))
+
+    def test_env_returns_float(self):
+        test_float = env("TEST_FLOAT")
+        self.assertTrue(isinstance(test_float, float))
+
+    def test_env_returns_list(self):
+        test_list = env("TEST_LIST")
+        self.assertTrue(isinstance(test_list, list))
+
+    def test_env_returns_tuple(self):
+        test_tuple = env("TEST_TUPLE")
+        self.assertTrue(isinstance(test_tuple, tuple))
+
+    def test_env_returns_bool(self):
+        test_bool = env("TEST_BOOL")
+        self.assertTrue(isinstance(test_bool, bool))
+
+    def test_env_returns_default(self):
+        test_str = env("TEST_MISSING", "foo")
+        self.assertTrue(isinstance(test_str, str))
+
+    def test_env_missing_not_required_no_default(self):
+        test_env = env("TEST_MISSING")
+        self.assertIsNone(test_env)
+
+    def test_env_required_throws_exception(self):
+        with pytest.raises(Exception):
+            env("TEST_MISSING_REQUIRED", required=True)
+
+    def test_env_returns_other_as_str(self):
+        test_str = env("TEST_FLOAT", value_type=str)
+        self.assertTrue(isinstance(test_str, str))
+
+
+class TestModelTests(TestCase):
+    client = Client()
+    model = TestModel
+
+    def setUp(self):
+        self.user = User.objects.create_user(
+            username="test", email="test@email.com", password="secret"
+        )
+        self.test_model = TestModel.objects.create(name=TEST_NAME)
+        self.client.login(username="test", password="secret")
+
+    def tearDown(self):
+        self.user.delete()
+
+    def test_model_fields(self):
+        """Test a model inheriting from mixins has the required fields."""
+        self.assertTrue(hasattr(self.test_model, "effective_to"))
+        self.assertTrue(hasattr(self.test_model, "creator"))
+        self.assertTrue(hasattr(self.test_model, "modifier"))
+        self.assertTrue(hasattr(self.test_model, "created"))
+        self.assertTrue(hasattr(self.test_model, "modified"))
+
+    def test_active_mixin(self):
+        """Test the ActiveMixin manager methods."""
+        obj_del = TestModel.objects.create(name="Deleted object")
+        obj_del.delete()
+        all_pks = [i.pk for i in TestModel.objects.all()]
+        current_pks = [i.pk for i in TestModel.objects.current()]
+        del_pks = [i.pk for i in TestModel.objects.deleted()]
+        self.assertTrue(obj_del.pk in all_pks)
+        self.assertFalse(obj_del.pk in current_pks)
+        self.assertTrue(obj_del.pk in del_pks)
+        self.assertFalse(self.test_model.pk in del_pks)
+
+    def test_url_request_returns_view(self):
+        """Test the env() utility method works as expected."""
+        url = reverse("test_model_list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, TEST_VAR)
+        self.assertContains(response, TEST_NAME)