feat: bkpaas-auth supports django 5.x (#251)

Author: piglei

.github/workflows/bkpaas-auth.yml

@@ -38,7 +38,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12"]
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:

sdks/bkpaas-auth/CHANGES.md

@@ -1,5 +1,9 @@
 # 版本历史
 
+## 3.2.0
+
+- 增加对 Django 5.x 版本的支持，并移除对 Python 3.9 版本的支持
+
 ## 3.1.3
 - feat: 用户模型增加时区支持，新增 time_zone 属性，由认证服务返回时区
 

sdks/bkpaas-auth/noxfile.py

@@ -2,8 +2,9 @@
 import tempfile
 
 import nox
+from nox.command import CommandFailed
 
-ALL_PYTHON = ["3.9", "3.10", "3.11"]
+ALL_PYTHON = ["3.10", "3.11", "3.12"]
 
 
 # ref: https://stackoverflow.com/questions/59768651/how-to-use-nox-with-poetry
@@ -49,8 +50,20 @@ def tests(session):
     install_with_constraints(
         session,
         "pytest",
-        "django",
         "pytest-django",
         "pytest-mock",
     )
-    session.run("pytest", *session.posargs)
+    # Install the SQLite driver manually because some environment's sqlite3 version is too old
+    # to meet the Django requirement.
+    try:
+        session.install("pysqlite3-binary")
+    except CommandFailed:
+        print("pysqlite3-binary installation failed, continuing...")
+
+    django_versions = [
+        ">=4.2,<5",
+        ">=5.0,<6",
+    ]
+    for django in django_versions:
+        session.install(f"django{django}")
+        session.run("pytest", *session.posargs)

sdks/bkpaas-auth/poetry.lock

@@ -5,15 +5,15 @@ classifiers = ["License :: OSI Approved :: MIT License"]
 # PEP 621 project metadata
 # See https://www.python.org/dev/peps/pep-0621/
 name = "bkpaas-auth"
-version = "3.1.3"
+version = "3.2.0"
 description = "User authentication django app for blueking internal projects"
 readme = "README.md"
 authors = [{ name = "blueking", email = "blueking@tencent.com" }]
 license = "MIT"
 # classifiers is dynamic because we want to create Python classifiers automatically
 dynamic = ["classifiers"]
-requires-python = '>=3.9,<4.0'
-dependencies = ['django (>=4.2,<5.0)', 'requests', 'six']
+requires-python = '>=3.10,<4.0'
+dependencies = ['django (>=4.2,<6.0)', 'requests', 'six']
 
 [project.urls]
 Homepage = "https://github.com/TencentBlueKing/bkpaas-python-sdk/"

sdks/bkpaas-auth/pyproject.toml

@@ -1,18 +1,38 @@
 # -*- coding: utf-8 -*-
 import logging
+import sqlite3
 import sys
 
 import pytest
 
 
+def _ensure_sqlite_min_version() -> None:
+    """Ensure that the sqlite3 module meets the minimum version requirement."""
+    minimum_version = (3, 31, 0)
+    if sqlite3.sqlite_version_info >= minimum_version:
+        return
+
+    try:
+        import pysqlite3
+    except ImportError:
+        return
+
+    # Replace sqlite3 module so Django picks up the newer SQLite implementation.
+    sys.modules["sqlite3"] = pysqlite3
+    sys.modules["sqlite3.dbapi2"] = pysqlite3.dbapi2
+
+
+_ensure_sqlite_min_version()
+
+
 def setup_root_logger(level):
     """Set up the root logger, make it to write messages to stdout"""
     root = logging.getLogger()
     root.setLevel(level)
 
     handler = logging.StreamHandler(sys.stdout)
     handler.setLevel(level)
-    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
     handler.setFormatter(formatter)
     root.addHandler(handler)
 
@@ -23,36 +43,36 @@ def pytest_configure():
     settings.configure(
         DEBUG_PROPAGATE_EXCEPTIONS=True,
         DATABASES={
-            'default': {
-                'ENGINE': 'django.db.backends.sqlite3',
-                'NAME': ':memory:',
+            "default": {
+                "ENGINE": "django.db.backends.sqlite3",
+                "NAME": ":memory:",
             }
         },
-        SECRET_KEY='not very secret in tests',
+        SECRET_KEY="not very secret in tests",
         TEMPLATES=[
             {
-                'BACKEND': 'django.template.backends.django.DjangoTemplates',
-                'APP_DIRS': True,
+                "BACKEND": "django.template.backends.django.DjangoTemplates",
+                "APP_DIRS": True,
             },
         ],
         USE_TZ=True,
-        TIME_ZONE='Asia/Shanghai',
+        TIME_ZONE="Asia/Shanghai",
         MIDDLEWARE=[],
         MIDDLEWARE_CLASSES=[],
         INSTALLED_APPS=(
-            'django.contrib.auth',
-            'django.contrib.contenttypes',
-            'django.contrib.sessions',
-            'tests',
+            "django.contrib.auth",
+            "django.contrib.contenttypes",
+            "django.contrib.sessions",
+            "tests",
         ),
         # bkauth settings
-        BKAUTH_BACKEND_TYPE='bk_token',
-        BKAUTH_TOKEN_APP_CODE='mock_app_code',
-        BKAUTH_TOKEN_SECRET_KEY='mock_app_key',
-        BKAUTH_TOKEN_GRANT_ENDPOINT='',
-        USER_ID='0221dbef87cd',
-        USER_NAME='user1',
-        USER_NICKNAME='user1中文名',
+        BKAUTH_BACKEND_TYPE="bk_token",
+        BKAUTH_TOKEN_APP_CODE="mock_app_code",
+        BKAUTH_TOKEN_SECRET_KEY="mock_app_key",
+        BKAUTH_TOKEN_GRANT_ENDPOINT="",
+        USER_ID="0221dbef87cd",
+        USER_NAME="user1",
+        USER_NICKNAME="user1中文名",
         AUTHENTICATION_BACKENDS=["bkpaas_auth.backends.UniversalAuthBackend"],
     )