cardo-python-utils 0.5.dev35__tar.gz → 0.5.dev37__tar.gz

{cardo_python_utils-0.5.dev35/cardo_python_utils.egg-info → cardo_python_utils-0.5.dev37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.5.dev35
+Version: 0.5.dev37
 Summary: Python library enhanced with a wide range of functions for different scenarios.
 Author-email: CardoAI <hello@cardoai.com>
 License: MIT

{cardo_python_utils-0.5.dev35 → cardo_python_utils-0.5.dev37/cardo_python_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.5.dev35
+Version: 0.5.dev37
 Summary: Python library enhanced with a wide range of functions for different scenarios.
 Author-email: CardoAI <hello@cardoai.com>
 License: MIT

{cardo_python_utils-0.5.dev35 → cardo_python_utils-0.5.dev37}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cardo-python-utils"
-version = "0.5.dev35"
+version = "0.5.dev37"
 description = "Python library enhanced with a wide range of functions for different scenarios."
 readme = "README.rst"
 requires-python = ">=3.8"

{cardo_python_utils-0.5.dev35 → cardo_python_utils-0.5.dev37}/python_utils/django/README.md

@@ -35,20 +35,24 @@ MIDDLEWARE = [
 
 # Include the database configuration for each tenant in the DATABASES setting.
 # You can use the get_database_configs() function from python_utils.django.db.utils as a helper.
-DATABASES = {
-    'tenant1': { ... },
-    'tenant2': { ... },
-    ...
-}
+from python_utils.django.db.utils import get_database_configs
+
+for tenant, tenant_db_config in get_database_configs().items():
+    DATABASES[tenant] = {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": tenant_db_config["name"],
+        "USER": tenant_db_config["user"],
+        "PASSWORD": tenant_db_config["password"],
+        "HOST": tenant_db_config["host"],
+        "PORT": tenant_db_config.get("port", 5432),
+    }
 
 # If you want to override the database alias to use for local development (when DEBUG is True).
 # By default, the first database defined in DATABASES is used.
 DEVELOPMENT_TENANT = "development"
 
 # This is required to use the tenant context when routing database queries
-DATABASE_ROUTERS = [
-    "python_utils.django.db.routers.TenantAwareRouter"
-]
+DATABASE_ROUTERS = ["python_utils.django.db.routers.TenantAwareRouter"]
 
 # If using celery, set the task class to TenantAwareTask:
 CELERY_TASK_CLS = "python_utils.django.celery.TenantAwareTask"
@@ -143,3 +147,38 @@ admin.site.has_permission = has_admin_site_permission
 ## With django-ninja
 
 If using `django-ninja`, apart from the settings configured above, auth utils are provided in the django/api/ninja.py module.
+
+## Testing
+
+In order for tests to work, create the following autouse fixtures:
+
+```python3
+import pytest
+
+from python_utils.django.tenant_context import TenantContext
+
+# Add this, if the test utils of the package are needed
+pytest_plugins = ["python_utils.django.tests"]
+
+
+@pytest.fixture(scope="session", autouse=True)
+def test_database() -> str:
+    return "default"
+
+
+@pytest.fixture(scope="session", autouse=True)
+def set_tenant_context_session(test_database):
+    """Set tenant context for the entire test session."""
+    TenantContext.set(test_database)
+    yield
+    TenantContext.clear()
+
+
+@pytest.fixture(autouse=True)
+def set_tenant_context(set_tenant_context_session, test_database):
+    """Ensure tenant context is set for each test (depends on session fixture)."""
+    # Re-set in case it was cleared between tests
+    if not TenantContext.is_set():
+        TenantContext.set(test_database)
+    yield
+```

{cardo_python_utils-0.5.dev35 → cardo_python_utils-0.5.dev37}/python_utils/django/tenant_context.py

@@ -1,22 +1,27 @@
 import logging
 import sys
 from contextlib import ContextDecorator
-from threading import local
+from contextvars import ContextVar
 from typing import Optional
 
 from .settings import DATABASES
 
 logger = logging.getLogger(__name__)
-thread_namespace = local()
+
+# ContextVar propagates automatically to async threads via sync_to_async
+_tenant_var: ContextVar[Optional[str]] = ContextVar('tenant', default=None)
 
 
 class TenantContext(ContextDecorator):
     """
     Context manager that sets the current tenant.
     This class can be used in several ways:
-    1. As a context manager:
+    1. As a context manager (sync and async):
         with TenantContext('tenant'):
             # do something
+        
+        async with TenantContext('tenant'):
+            # do something async
 
     2. As a decorator:
         @TenantContext('tenant')
@@ -33,23 +38,32 @@ class TenantContext(ContextDecorator):
 
     def __init__(self, tenant: str):
         self.tenant = tenant
+        self._token = None
 
     def __enter__(self):
-        TenantContext.set(self.tenant)
+        self._token = TenantContext.set(self.tenant)
+        return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        TenantContext.clear()
+        TenantContext.clear(self._token)
+
+    async def __aenter__(self):
+        self._token = TenantContext.set(self.tenant)
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        TenantContext.clear(self._token)
 
     @staticmethod
     def is_set() -> bool:
-        return hasattr(thread_namespace, TenantContext.field_name)
+        return _tenant_var.get() is not None
 
     @staticmethod
     def get() -> Optional[str]:
-        try:
-            return getattr(thread_namespace, TenantContext.field_name)
-        except AttributeError as e:
-            raise RuntimeError("Tenant context is not set.") from e
+        tenant = _tenant_var.get()
+        if tenant is None:
+            raise RuntimeError("Tenant context is not set.")
+        return tenant
 
     @staticmethod
     def set(tenant):
@@ -66,24 +80,23 @@ class TenantContext(ContextDecorator):
                 logger.error("ERROR: TENANT CONTEXT ALREADY SET")
                 logger.error(f"Current tenant: {TenantContext.get()}, new tenant: {tenant}")
                 return sys.exit(1)
-
             else:
-                # Normally in a request-response cycle, or a single task, the
-                # tenant context is set only once. But there is an exception
-                # for the migrate command, which sets the tenant context
-                # multiple times to the same value.
-                logger.info("Tenant context already set to %s", tenant)
-                return
-        
+                # If the tenant is already set to the same value, we do nothing and return None.
+                return None
+
         if tenant not in DATABASES:
             logger.error(f"Tenant '{tenant}' not found in DATABASES settings.")
             return sys.exit(1)
 
-        setattr(thread_namespace, TenantContext.field_name, tenant)
+        token = _tenant_var.set(tenant)
         logger.info(f"Tenant context set to {tenant}")
+        return token
 
     @staticmethod
-    def clear():
+    def clear(token=None):
         if TenantContext.is_set():
-            delattr(thread_namespace, TenantContext.field_name)
-            logger.info("Tenant context cleared")
+            if token is not None:
+                _tenant_var.reset(token)
+            else:
+                _tenant_var.set(None)
+            logger.info("Tenant context cleared")

{cardo_python_utils-0.5.dev35 → cardo_python_utils-0.5.dev37}/python_utils/django/tests/conftest.py

@@ -80,7 +80,7 @@ def mock_verify_scopes_ninja():
     Patches AuthBearer._verify_scopes, so that no real scope checking is done during tests.
     This is done because scope checking uses route resolution, which the test client does not support.
     """
-    with patch("python_utils.keycloak.django.api.ninja.AuthBearer._verify_scopes") as mock_verify:
+    with patch("python_utils.django.api.ninja.AuthBearer._verify_scopes") as mock_verify:
         mock_verify.return_value = None
         yield mock_verify