django-api-versioning 0.3.3__tar.gz → 0.3.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/CHANGELOG.md +21 -0
  2. {django_api_versioning-0.3.3/django_api_versioning.egg-info → django_api_versioning-0.3.4}/PKG-INFO +7 -2
  3. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/README.md +6 -1
  4. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/lifecycle.py +29 -4
  5. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4/django_api_versioning.egg-info}/PKG-INFO +7 -2
  6. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/pyproject.toml +1 -1
  7. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_lifecycle.py +203 -0
  8. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/LICENSE +0 -0
  9. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/MANIFEST.in +0 -0
  10. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/__init__.py +0 -0
  11. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/channels.py +0 -0
  12. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/decorators.py +0 -0
  13. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/exceptions.py +0 -0
  14. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/management/__init__.py +0 -0
  15. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/management/commands/__init__.py +0 -0
  16. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/management/commands/check_versions.py +0 -0
  17. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/management/commands/migrate_endpoints.py +0 -0
  18. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/registry.py +0 -0
  19. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/reverse.py +0 -0
  20. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/settings.py +0 -0
  21. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/testing.py +0 -0
  22. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning/urls.py +0 -0
  23. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning.egg-info/SOURCES.txt +0 -0
  24. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning.egg-info/dependency_links.txt +0 -0
  25. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning.egg-info/requires.txt +0 -0
  26. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/django_api_versioning.egg-info/top_level.txt +0 -0
  27. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/pytest.ini +0 -0
  28. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/requirements-dev.txt +0 -0
  29. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/requirements.txt +0 -0
  30. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/setup.cfg +0 -0
  31. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/__init__.py +0 -0
  32. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/conftest.py +0 -0
  33. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/settings.py +0 -0
  34. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_channels.py +0 -0
  35. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_channels_extra.py +0 -0
  36. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_decorators.py +0 -0
  37. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_exceptions.py +0 -0
  38. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_management_commands.py +0 -0
  39. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_registry.py +0 -0
  40. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_reverse.py +0 -0
  41. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_segment_model.py +0 -0
  42. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_settings.py +0 -0
  43. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_testing_utils.py +0 -0
  44. {django_api_versioning-0.3.3 → django_api_versioning-0.3.4}/tests/test_urls.py +0 -0
@@ -8,6 +8,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
 
9
9
  ## [Unreleased]
10
10
 
11
+ ## [0.3.4] - 2026-11-11
12
+
13
+ ### Fixed
14
+
15
+ - **LifecycleMiddleware ignoring `override_settings`:** Fixed critical bug where `LifecycleMiddleware` and version extraction functions read from a globally cached settings object initialized at module import time. Now reads `API_VERSION_LIFECYCLE` and `API_BASE_PATH` from `django.conf.settings` at request time, allowing `override_settings` in tests and runtime configuration changes to work correctly. Maintains backward compatibility with existing monkeypatch-based tests by falling back to cached settings when needed.
16
+
17
+ ### Added
18
+
19
+ - **Comprehensive override_settings regression tests:** Added 13 focused tests covering lifecycle status enforcement, version extraction, and settings scope behavior with `override_settings`: deprecated versions with headers, retired versions returning 410, active versions with no headers, custom API_BASE_PATH patterns, extraction precedence preservation, and settings applied/removed within same test session.
20
+
21
+ ### Verified
22
+
23
+ - ✅ All 131 tests passing (22 existing lifecycle tests + 13 new override_settings tests + 96 other tests)
24
+ - ✅ Lifecycle status enforcement with override_settings (active, deprecated, retired)
25
+ - ✅ Version extraction with overridden API_BASE_PATH patterns
26
+ - ✅ Settings scope behavior (within/outside override_settings context)
27
+ - ✅ Backward compatibility with monkeypatch-based tests
28
+ - ✅ Version extraction precedence maintained
29
+ - ✅ Package builds successfully (wheel + sdist)
30
+ - ✅ Imports work correctly
31
+
11
32
  ## [0.3.3] - 2026-11-10
12
33
 
13
34
  ### Fixed
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: django-api-versioning
3
- Version: 0.3.3
3
+ Version: 0.3.4
4
4
  Summary: Django API versioning for Django and Django REST Framework (DRF), with decorator-based endpoint versioning, automatic URL registration, backward compatibility, and segment-based forward inheritance.
5
5
  Author-email: Mojtaba Arvin <ArvinDevDay@gmail.com>
6
6
  License: MIT
@@ -470,7 +470,12 @@ Every /api/v1/* request returns:
470
470
  HTTP/1.1 410 Gone
471
471
  ```
472
472
 
473
- The middleware reads request.version (set by DRF) or `resolver_match.kwargs["version"]`. Path-based versioning is fully supported.
473
+ The middleware extracts the version using this priority:
474
+ 1. `request.version` (set by DRF)
475
+ 2. `resolver_match.kwargs["version"]` (from URL parameters)
476
+ 3. Static URL path (version extracted from the actual request URL path)
477
+
478
+ This fallback approach ensures Deprecation/Sunset headers and retired version enforcement work correctly even when the version isn't explicitly set in the request or route parameters.
474
479
 
475
480
  ## Configuration reference
476
481
 
@@ -421,7 +421,12 @@ Every /api/v1/* request returns:
421
421
  HTTP/1.1 410 Gone
422
422
  ```
423
423
 
424
- The middleware reads request.version (set by DRF) or `resolver_match.kwargs["version"]`. Path-based versioning is fully supported.
424
+ The middleware extracts the version using this priority:
425
+ 1. `request.version` (set by DRF)
426
+ 2. `resolver_match.kwargs["version"]` (from URL parameters)
427
+ 3. Static URL path (version extracted from the actual request URL path)
428
+
429
+ This fallback approach ensures Deprecation/Sunset headers and retired version enforcement work correctly even when the version isn't explicitly set in the request or route parameters.
425
430
 
426
431
  ## Configuration reference
427
432
 
@@ -1,15 +1,39 @@
1
1
  import logging
2
2
  import re
3
3
  from datetime import datetime, timezone
4
- from typing import Callable
4
+ from typing import Any, Callable
5
5
 
6
+ from django.conf import settings as django_settings
6
7
  from django.http import HttpRequest, HttpResponse, HttpResponseGone
7
8
 
8
- from .settings import api_settings as settings
9
+ from .settings import api_settings
9
10
 
10
11
  logger = logging.getLogger(__name__)
11
12
 
12
13
 
14
+ def _get_api_setting(name: str, default: Any = None) -> Any:
15
+ """
16
+ Get API setting from django.conf.settings at request time.
17
+
18
+ This ensures that override_settings in tests affects middleware behavior.
19
+ For backward compatibility with monkeypatch-based tests, also checks
20
+ the cached api_settings object if the setting is not found in django.conf.settings.
21
+
22
+ Falls back to default if setting is not configured in either location.
23
+ """
24
+ # First, check if the setting exists in django.conf.settings
25
+ # This handles override_settings() and other dynamic setting changes
26
+ if hasattr(django_settings, name):
27
+ return getattr(django_settings, name)
28
+
29
+ # Fall back to cached api_settings for backward compatibility with tests
30
+ # that use monkeypatch to modify api_settings directly
31
+ if hasattr(api_settings, name):
32
+ return getattr(api_settings, name)
33
+
34
+ return default
35
+
36
+
13
37
  class LifecycleMiddleware:
14
38
  """
15
39
  Inject ``Deprecation`` / ``Sunset`` headers and enforce sunset.
@@ -31,7 +55,8 @@ class LifecycleMiddleware:
31
55
  if version is None:
32
56
  return self.get_response(request)
33
57
 
34
- meta = settings.API_VERSION_LIFECYCLE.get(version)
58
+ lifecycle = _get_api_setting("API_VERSION_LIFECYCLE", {})
59
+ meta = lifecycle.get(version)
35
60
  if not meta:
36
61
  return self.get_response(request)
37
62
 
@@ -79,7 +104,7 @@ def _extract_version_from_path(request: HttpRequest) -> int | None:
79
104
 
80
105
  Returns None if no valid version is found.
81
106
  """
82
- api_base_path = settings.API_BASE_PATH
107
+ api_base_path = _get_api_setting("API_BASE_PATH", "api/v{version}/")
83
108
  if not api_base_path or "{version}" not in api_base_path:
84
109
  return None
85
110
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: django-api-versioning
3
- Version: 0.3.3
3
+ Version: 0.3.4
4
4
  Summary: Django API versioning for Django and Django REST Framework (DRF), with decorator-based endpoint versioning, automatic URL registration, backward compatibility, and segment-based forward inheritance.
5
5
  Author-email: Mojtaba Arvin <ArvinDevDay@gmail.com>
6
6
  License: MIT
@@ -470,7 +470,12 @@ Every /api/v1/* request returns:
470
470
  HTTP/1.1 410 Gone
471
471
  ```
472
472
 
473
- The middleware reads request.version (set by DRF) or `resolver_match.kwargs["version"]`. Path-based versioning is fully supported.
473
+ The middleware extracts the version using this priority:
474
+ 1. `request.version` (set by DRF)
475
+ 2. `resolver_match.kwargs["version"]` (from URL parameters)
476
+ 3. Static URL path (version extracted from the actual request URL path)
477
+
478
+ This fallback approach ensures Deprecation/Sunset headers and retired version enforcement work correctly even when the version isn't explicitly set in the request or route parameters.
474
479
 
475
480
  ## Configuration reference
476
481
 
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "django-api-versioning"
7
- version = "0.3.3"
7
+ version = "0.3.4"
8
8
  description = "Django API versioning for Django and Django REST Framework (DRF), with decorator-based endpoint versioning, automatic URL registration, backward compatibility, and segment-based forward inheritance."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
@@ -265,3 +265,206 @@ class TestVersionExtraction:
265
265
  request.resolver_match.kwargs = {}
266
266
  version = _extract_version(request)
267
267
  assert version == 1
268
+
269
+
270
+ # Tests for override_settings compatibility
271
+ class TestOverrideSettingsCompatibility:
272
+ """Regression tests for override_settings compatibility (Bug: LifecycleMiddleware ignores override_settings)."""
273
+
274
+ def test_override_settings_lifecycle_active_version(self):
275
+ """override_settings(API_VERSION_LIFECYCLE) should affect middleware behavior."""
276
+ from django.test import override_settings
277
+
278
+ with override_settings(API_VERSION_LIFECYCLE={1: {"status": "active"}}):
279
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
280
+ response = middleware(_request("1"))
281
+
282
+ assert response.status_code == 200
283
+ assert "Deprecation" not in response
284
+
285
+ def test_override_settings_lifecycle_deprecated_version(self):
286
+ """override_settings should apply deprecated status and Sunset header."""
287
+ from django.test import override_settings
288
+
289
+ with override_settings(
290
+ API_VERSION_LIFECYCLE={2: {"status": "deprecated", "sunset": FUTURE}}
291
+ ):
292
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
293
+ response = middleware(_request("2"))
294
+
295
+ assert response.status_code == 200
296
+ assert response["Deprecation"] == "true"
297
+ assert "Sunset" in response
298
+
299
+ def test_override_settings_lifecycle_retired_past_sunset(self):
300
+ """override_settings with past sunset should return 410."""
301
+ from django.test import override_settings
302
+
303
+ with override_settings(
304
+ API_VERSION_LIFECYCLE={1: {"status": "retired", "sunset": PAST}}
305
+ ):
306
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
307
+ response = middleware(_request("1"))
308
+
309
+ assert response.status_code == 410
310
+
311
+ def test_override_settings_lifecycle_retired_future_sunset(self):
312
+ """override_settings with future sunset should serve normally."""
313
+ from django.test import override_settings
314
+
315
+ with override_settings(
316
+ API_VERSION_LIFECYCLE={1: {"status": "retired", "sunset": FUTURE}}
317
+ ):
318
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
319
+ response = middleware(_request("1"))
320
+
321
+ assert response.status_code == 200
322
+ assert "Deprecation" not in response
323
+
324
+ def test_override_settings_lifecycle_empty_dict(self):
325
+ """override_settings with empty lifecycle should pass through."""
326
+ from django.test import override_settings
327
+
328
+ with override_settings(API_VERSION_LIFECYCLE={}):
329
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
330
+ response = middleware(_request("1"))
331
+
332
+ assert response.status_code == 200
333
+ assert "Deprecation" not in response
334
+
335
+ def test_override_settings_lifecycle_removed(self):
336
+ """After override_settings context ends, behavior should revert."""
337
+ from django.test import override_settings
338
+
339
+ # First, with override_settings: version 1 is retired
340
+ with override_settings(
341
+ API_VERSION_LIFECYCLE={1: {"status": "retired", "sunset": PAST}}
342
+ ):
343
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
344
+ response = middleware(_request("1"))
345
+ assert response.status_code == 410
346
+
347
+ # Then, outside context: version 1 uses cached settings (no lifecycle entry)
348
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
349
+ response = middleware(_request("1"))
350
+ assert response.status_code == 200
351
+ assert "Deprecation" not in response
352
+
353
+ def test_override_settings_base_path_extraction(self):
354
+ """override_settings(API_BASE_PATH) should affect version extraction."""
355
+ from django.test import override_settings
356
+ from django_api_versioning.lifecycle import _extract_version_from_path
357
+
358
+ with override_settings(API_BASE_PATH="svc/v{version}/"):
359
+ request = RequestFactory().get("/svc/v2/things/")
360
+ request.version = None
361
+ version = _extract_version_from_path(request)
362
+ assert version == 2
363
+
364
+ def test_override_settings_base_path_extraction_custom_format(self):
365
+ """override_settings with custom base path format should work."""
366
+ from django.test import override_settings
367
+ from django_api_versioning.lifecycle import _extract_version_from_path
368
+
369
+ with override_settings(API_BASE_PATH="api/version-{version}/"):
370
+ request = RequestFactory().get("/api/version-3/users/")
371
+ request.version = None
372
+ version = _extract_version_from_path(request)
373
+ assert version == 3
374
+
375
+ def test_override_settings_base_path_unchanged_outside_context(self):
376
+ """Version extraction should revert after override_settings context."""
377
+ from django.test import override_settings
378
+ from django_api_versioning.lifecycle import _extract_version_from_path
379
+
380
+ # With override_settings, custom path works
381
+ with override_settings(API_BASE_PATH="svc/v{version}/"):
382
+ request = RequestFactory().get("/svc/v2/things/")
383
+ request.version = None
384
+ version = _extract_version_from_path(request)
385
+ assert version == 2
386
+
387
+ # Outside override_settings, custom path doesn't match
388
+ request = RequestFactory().get("/svc/v2/things/")
389
+ request.version = None
390
+ version = _extract_version_from_path(request)
391
+ assert version is None # Uses default api/v{version}/, doesn't match svc/
392
+
393
+ def test_override_settings_lifecycle_multiple_versions(self):
394
+ """override_settings with multiple lifecycle entries should work."""
395
+ from django.test import override_settings
396
+
397
+ with override_settings(
398
+ API_VERSION_LIFECYCLE={
399
+ 1: {"status": "retired", "sunset": PAST},
400
+ 2: {"status": "deprecated", "sunset": FUTURE},
401
+ 3: {"status": "active"},
402
+ }
403
+ ):
404
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
405
+
406
+ # Version 1: retired with past sunset -> 410
407
+ response = middleware(_request("1"))
408
+ assert response.status_code == 410
409
+
410
+ # Version 2: deprecated with future sunset -> 200 with headers
411
+ response = middleware(_request("2"))
412
+ assert response.status_code == 200
413
+ assert response["Deprecation"] == "true"
414
+
415
+ # Version 3: active -> 200 with no headers
416
+ response = middleware(_request("3"))
417
+ assert response.status_code == 200
418
+ assert "Deprecation" not in response
419
+
420
+ def test_override_settings_with_extract_version_precedence(self):
421
+ """Version extraction precedence should work with override_settings."""
422
+ from django.test import override_settings
423
+ from django_api_versioning.lifecycle import _extract_version
424
+ from unittest.mock import Mock
425
+
426
+ with override_settings(API_BASE_PATH="custom/v{version}/"):
427
+ # request.version takes precedence even with custom base path
428
+ request = RequestFactory().get("/custom/v1/things/")
429
+ request.version = "5"
430
+ request.resolver_match = None
431
+ version = _extract_version(request)
432
+ assert version == 5
433
+
434
+ # Falls back to custom path when request.version is None
435
+ request.version = None
436
+ version = _extract_version(request)
437
+ assert version == 1
438
+
439
+ def test_override_settings_deprecated_without_sunset(self):
440
+ """override_settings with deprecated status but no sunset."""
441
+ from django.test import override_settings
442
+
443
+ with override_settings(API_VERSION_LIFECYCLE={2: {"status": "deprecated"}}):
444
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
445
+ response = middleware(_request("2"))
446
+
447
+ assert response.status_code == 200
448
+ assert response["Deprecation"] == "true"
449
+ assert "Sunset" not in response
450
+
451
+ def test_override_settings_lifecycle_and_base_path_together(self):
452
+ """override_settings with both lifecycle and base path changes."""
453
+ from django.test import override_settings
454
+ from django_api_versioning.lifecycle import _extract_version
455
+
456
+ with override_settings(
457
+ API_BASE_PATH="svc/v{version}/",
458
+ API_VERSION_LIFECYCLE={2: {"status": "retired", "sunset": PAST}},
459
+ ):
460
+ middleware = LifecycleMiddleware(lambda req: HttpResponse("ok"))
461
+
462
+ # Extract version from overridden base path
463
+ request = RequestFactory().get("/svc/v2/things/")
464
+ request.version = None
465
+ version = _extract_version(request)
466
+ assert version == 2
467
+
468
+ # Check lifecycle with extracted version
469
+ response = middleware(request)
470
+ assert response.status_code == 410