cardo-python-utils 0.5.dev50__py3-none-any.whl → 0.5.dev53__py3-none-any.whl

{cardo_python_utils-0.5.dev50.dist-info → cardo_python_utils-0.5.dev53.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.5.dev50
+Version: 0.5.dev53
 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.dev50.dist-info → cardo_python_utils-0.5.dev53.dist-info}/RECORD

@@ -1,4 +1,4 @@
-cardo_python_utils-0.5.dev50.dist-info/licenses/LICENSE,sha256=N-YtxDy8n5A1Mo7JKKItNIlboiK_pMOZ48ojx76jo3g,1046
+cardo_python_utils-0.5.dev53.dist-info/licenses/LICENSE,sha256=N-YtxDy8n5A1Mo7JKKItNIlboiK_pMOZ48ojx76jo3g,1046
 python_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 python_utils/choices.py,sha256=_sLNkSnQqhg55gGKNRsOQCJ75W6gnz8J8Q00528MEYk,2548
 python_utils/data_structures.py,sha256=ZqkZYPy20zyGYOVhwb9qst4vF_P7X2A9z5E36rMUC6I,16820
@@ -11,7 +11,7 @@ python_utils/math.py,sha256=p_v8a9nVSe9426nR8H_SM8hOQrkzESVpCnn3gntw7TA,5603
 python_utils/text.py,sha256=pw9CZeM_Lcw-6k4GyR-4D1Wix8A7F_V1u1IIZTIazW4,3792
 python_utils/time.py,sha256=7Wei3uJ02Bk-BFRf-e1axoG418XQOhrXPvTwNZgTdnw,9614
 python_utils/types_hinting.py,sha256=QVWzmXRgNxhvln14tEX_FbQYryuVYhjWJ0dVOnlF6G4,120
-python_utils/django/README.md,sha256=1_I6P3sB2_nBZ9hb0kUrTI4W4pDOxRAkfSO1iekfEVE,6750
+python_utils/django/README.md,sha256=J9CEKaFiMGOnIRsoIpDbQPlno4O6vgymMJLQHmeSnVg,7236
 python_utils/django/__init__.py,sha256=uXyqF-_5gZAlSIKoQkUTedAeBjnUHqh6lR6SzA1DEOM,64
 python_utils/django/apps.py,sha256=vH2Ov8XgavTGKFLSjbH1kvuG7RWQCjeJepw6BSp2o3E,126
 python_utils/django/oidc_settings.py,sha256=JqF-qOfW23JhmmVciN1B7ZV-KI7qrdn5VigTE7E2k_0,4367
@@ -24,22 +24,23 @@ python_utils/django/admin/views.py,sha256=D4Ez-RkZa_c7O8AN1ljosBBJWieSodrY2TAZ7-
 python_utils/django/admin/templates/__init__.py,sha256=LxCKcnJ1Ty48CFDJ8XtAZYTW45xDw5o7H4GLsRo6iQk,53
 python_utils/django/admin/templates/user_groups_changelist.html,sha256=KbO6bsH-nh3DDYCq4UB8j25NdjLP_nh_GuGZ4lYSarM,182
 python_utils/django/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_utils/django/api/drf.py,sha256=a61gp-fSHV760FYfRv_IxnykuB14sSSI6tS1dUB1POk,2957
-python_utils/django/api/ninja.py,sha256=r0-tlS8TlCp_q1_3wdplyZmYMjeUwv8YuzWjRTtijBw,4765
+python_utils/django/api/drf.py,sha256=ar94uAVIaHDxzi3K7ubNSJDuysUWjV_xv0sFXtkJEuc,3101
+python_utils/django/api/ninja.py,sha256=Rz7331hYmKo4jyxtuvEKzOaNUjdmuCpXeHYkWGf0NsA,4863
 python_utils/django/api/utils.py,sha256=ycpSnTtGcfdGP1_Hk0P2c8ZNId70xOYtjx1m0nAUWRM,3465
 python_utils/django/auth/service.py,sha256=9gMURteyVnfjpZLyrvjAvgglfi2NPwrdia2LDVPfxBs,7475
 python_utils/django/celery/__init__.py,sha256=eqKpBqhClH-7oK-kD1SUEpzt4Gqu7VWLWmhFUktee0A,79
 python_utils/django/celery/tenant_aware_database_scheduler.py,sha256=Qcz8mFhfFcX8Opzb75qvuF9jxwuY8Nsn0gxIBKFaU8w,8087
-python_utils/django/celery/tenant_aware_task.py,sha256=RS-6etWP16vYka0nlY1UbEdriqF8ouW5OML05fBF-LA,2944
+python_utils/django/celery/tenant_aware_task.py,sha256=kjcAfAAOUAveOKaoOBe-yJLdhXIT7CMgNKOPOFKjEbQ,4065
 python_utils/django/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 python_utils/django/db/alias.py,sha256=sybxhZsShJdnz13hqEyYLxuaRert9zpRPPi-bAayyM4,574
 python_utils/django/db/routers.py,sha256=Q4YAvr37wgEgL04miPKSREhzFB5LDZrXulqStbqBZeA,252
 python_utils/django/db/transaction.py,sha256=0d4Yn98qxjn1LOJfaOTsd5qpPqB2fCqxsqG16StfcSg,921
-python_utils/django/db/utils.py,sha256=DMrFHTjXOkeDsUTdYOCAnZOU_PHKh0zvx-WXsyn7Z-A,2029
+python_utils/django/db/utils.py,sha256=RtaoaLUQF8bOS0nNBCiFsyoj4zs-iqKstoM65pxWOls,2010
 python_utils/django/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 python_utils/django/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 python_utils/django/management/commands/migrateall.py,sha256=j1AA29FOGr5Rwe6Fjm4RMFA1-qtb66z_zRi4e7ocHV0,783
 python_utils/django/management/commands/shell.py,sha256=fGHJ1i-p-TQ9lFLOz0j4dm_HEH0kgTO4FGmtYMNqqK4,967
+python_utils/django/management/commands/showmigrations.py,sha256=mwNnL2EYAqX3iZ5-YI86X1-9YhbHvmMMG_wX3wNykKc,1260
 python_utils/django/management/commands/tenant_aware_command.py,sha256=MBI7N0BEHZAhK183QmFjjEdDecM060O0nsxg0spH9Mc,2440
 python_utils/django/middleware/__init__.py,sha256=GyhuzaOtaXW13iB9GL0XF7OvEEzKoJzorJzYX597idA,117
 python_utils/django/middleware/tenant_aware_http_middleware.py,sha256=W8U3-nR90b8m_wz5xDJTuImUrPEXvESzYh3VITYMIJU,3825
@@ -63,7 +64,7 @@ python_utils/django/storage/__init__.py,sha256=mNn2YmD7pkXhBLHMM1444BLsCMq78YdYx
 python_utils/django/storage/tenant_aware_storage.py,sha256=5dDes6xLv7_R8hIBbFIzRvPL7HL9K_RM-G6LI8qUSxM,2550
 python_utils/django/tests/__init__.py,sha256=Nkt0a7LEHyjLvuEBZ7113VjjAWJlyZlMy-H-JZ5tNcs,252
 python_utils/django/tests/conftest.py,sha256=KozXmXUWVcDLbkVAb7Aq4sDydGLh2YZkbRa4tkA8Z6U,3167
-cardo_python_utils-0.5.dev50.dist-info/METADATA,sha256=BMJmbLgqqHr5HtaBkeZ-OSFIz-I3o15trwrPqpW71ug,3007
-cardo_python_utils-0.5.dev50.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-cardo_python_utils-0.5.dev50.dist-info/top_level.txt,sha256=zAx6OfEsjJs8BEW3okSiG_j9gpkI69xWShzum6oBgKI,13
-cardo_python_utils-0.5.dev50.dist-info/RECORD,,
+cardo_python_utils-0.5.dev53.dist-info/METADATA,sha256=OQENj0UZFzNZWi0xazB6ZH6qv5wc9GsaapXXXocNJWQ,3007
+cardo_python_utils-0.5.dev53.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+cardo_python_utils-0.5.dev53.dist-info/top_level.txt,sha256=zAx6OfEsjJs8BEW3okSiG_j9gpkI69xWShzum6oBgKI,13
+cardo_python_utils-0.5.dev53.dist-info/RECORD,,

python_utils/django/README.md

@@ -157,14 +157,28 @@ If using `django-ninja`, apart from the settings configured above, auth utils ar
 
 ## Atomic Transactions
 
-Django's `transaction.atomic` uses the default database. To make it tenant-aware, use `tenant_atomic`
+Django's `transaction.atomic` uses the default database. To make it tenant-aware, use `tenant_atomic`.
+If `transaction.on_commit` is used, make sure to pass the tenant as DB alias as well:
 
 ```python3
 from python_utils.django.db.transaction import tenant_atomic
 
 @tenant_atomic
 def my_function():
-    ...
+    # Some logic
+
+    transaction.on_commit(do_smth, using=TenantContext.get())
+```
+
+## Explicit database connection
+
+If using django.db.connection anywhere in the code, you need to change that to get a tenant-aware connection:
+
+```python3
+from python_utils.django.db.utils import get_connection
+from python_utils.django.tenant_context import TenantContext
+
+connection = get_connection(TenantContext.get())
 ```
 
 ## Django Shell

python_utils/django/api/drf.py

@@ -1,8 +1,8 @@
 from django.conf import settings
-from jwt.exceptions import InvalidTokenError, PyJWKClientError
+from jwt.exceptions import ExpiredSignatureError, InvalidTokenError, PyJWKClientError
 
 from rest_framework import authentication
-from rest_framework.exceptions import AuthenticationFailed
+from rest_framework.exceptions import AuthenticationFailed, PermissionDenied
 from rest_framework.permissions import BasePermission
 
 from .utils import create_or_update_user, decode_jwt
@@ -14,13 +14,15 @@ class AuthenticationBackend(authentication.TokenAuthentication):
     def authenticate_credentials(self, token: str):
         try:
             payload = decode_jwt(token, audience=self._get_audience())
+        except ExpiredSignatureError as e:
+            raise AuthenticationFailed("Token has expired.") from e
         except (InvalidTokenError, PyJWKClientError) as e:
-            raise AuthenticationFailed(f"Invalid token: {str(e)}") from e
+            raise PermissionDenied(f"Invalid token: {str(e)}") from e
 
         try:
             username = payload["preferred_username"]
         except KeyError as e:
-            raise AuthenticationFailed(
+            raise PermissionDenied(
                 "Invalid token: preferred_username not present."
             ) from e
 

python_utils/django/api/ninja.py

@@ -1,12 +1,12 @@
 import logging
 from typing import Literal, Optional, Union
 
-from jwt.exceptions import InvalidTokenError, PyJWKClientError
+from jwt.exceptions import ExpiredSignatureError, InvalidTokenError, PyJWKClientError
 
 from django.conf import settings
 from django.http import HttpRequest
 from ninja.security import HttpBearer
-from ninja.errors import AuthenticationError, HttpError
+from ninja.errors import AuthenticationError, AuthorizationError, HttpError
 
 from .utils import (
     acreate_or_update_user,
@@ -42,7 +42,7 @@ class AuthBearer(HttpBearer):
 
     def _get_token(self, request: HttpRequest) -> Optional[str]:
         """
-        This part of the token validation is similar to what 
+        This part of the token validation is similar to what
         django-ninja is doing in HttpBearer.__call__
         """
         headers = request.headers
@@ -61,16 +61,16 @@ class AuthBearer(HttpBearer):
     def _decode_token(self, token: str) -> TokenPayload:
         try:
             return decode_jwt(token)
+        except ExpiredSignatureError as e:
+            raise AuthenticationError("Token has expired.") from e
         except (InvalidTokenError, PyJWKClientError) as e:
-            raise AuthenticationError(f"Invalid token: {str(e)}") from e
+            raise AuthorizationError(f"Invalid token: {str(e)}") from e
 
     def _get_username(self, payload: TokenPayload) -> str:
         try:
             return payload["preferred_username"]
         except KeyError as e:
-            raise AuthenticationError(
-                "Invalid token: 'preferred_username' claim not present."
-            ) from e
+            raise AuthorizationError("Invalid token: 'preferred_username' claim not present.") from e
 
     def _verify_scopes(self, request, token_payload):
         allowed_scopes = self._get_view_allowed_scopes(request)
@@ -106,9 +106,7 @@ class AuthBearer(HttpBearer):
             if operation.methods and method in operation.methods:
                 return operation.view_func
 
-        raise Exception(
-            f"Could not determine the view function for {request.method} {request.path}."
-        )
+        raise Exception(f"Could not determine the view function for {request.method} {request.path}.")
 
 
 class AuthBearerAsync(AuthBearer):

python_utils/django/celery/tenant_aware_task.py

@@ -27,8 +27,49 @@ class TenantAwareTask(TaskClass):
 
     once = {"graceful": True, "unlock_before_run": False}
 
+    def apply(
+        self,
+        args=None,
+        kwargs=None,
+        link=None,
+        link_error=None,
+        task_id=None,
+        retries=None,
+        throw=None,
+        logfile=None,
+        loglevel=None,
+        headers=None,
+        **options,
+    ):
+        """Pass the tenant name from the context in the kwargs."""
+
+        if kwargs is None:
+            kwargs = {}
+
+        if TENANT_KEY not in kwargs:
+            tenant = TenantContext.get()
+            kwargs[TENANT_KEY] = tenant
+
+        return super().apply(
+            args, kwargs, link, link_error, task_id, retries, throw, logfile, loglevel, headers, **options
+        )
+
+    def apply_async(
+        self, args=None, kwargs=None, task_id=None, producer=None, link=None, link_error=None, shadow=None, **options
+    ):
+        """Pass the tenant name from the context in the kwargs."""
+
+        if kwargs is None:
+            kwargs = {}
+
+        if TENANT_KEY not in kwargs:
+            tenant = TenantContext.get()
+            kwargs[TENANT_KEY] = tenant
+
+        return super().apply_async(args, kwargs, task_id, producer, link, link_error, shadow, **options)
+
     def __call__(self, *args, **kwargs):
-        """Override the __call__ method to set the tenant name in the thread namespace."""
+        """Use the tenant name from the kwargs to update the context."""
 
         # Only clear the lock before the task's execution if the
         # "unlock_before_run" option is True
@@ -43,7 +84,8 @@ class TenantAwareTask(TaskClass):
         return self.run(*args, **kwargs)
 
     def after_return(self, status, retval, task_id, args, kwargs, einfo):
-        """Clear the tenant from the thread namespace after the task has returned."""
+        """Clear the tenant from the context after the task has returned."""
+
         TenantContext.clear()
         super().after_return(status, retval, task_id, args, kwargs, einfo)
 
@@ -67,7 +109,7 @@ class TenantAwareTask(TaskClass):
         tenant_kwarg = {TENANT_KEY: tenant}
         task_call_args = super()._get_call_args(args, _kwargs)
 
-        # Add the tenant kwarg back to the return value 
+        # Add the tenant kwarg back to the return value
         # since this value is being used to create the key for the lock.
         # We want to lock the task for the tenant that is running it.
         return task_call_args | tenant_kwarg

python_utils/django/db/utils.py

@@ -1,7 +1,7 @@
 from functools import reduce
 import json
 import os
-from typing import NotRequired, TypedDict
+from typing import TypedDict
 from django.db import connections
 
 
@@ -10,7 +10,7 @@ class DatabaseConfigData(TypedDict):
     name: str
     user: str
     password: str
-    port: NotRequired[int]
+    port: int | None
 
 
 def get_connection(tenant: str = None):

python_utils/django/management/commands/showmigrations.py

@@ -0,0 +1,37 @@
+from django.core.management.commands.showmigrations import Command as ShowMigrationsCommand
+
+from ...settings import TENANT_DATABASES
+from ...tenant_context import TenantContext
+
+
+class Command(ShowMigrationsCommand):
+    help = "Shows all available migrations for a specific tenant."
+
+    def add_arguments(self, parser):
+        super().add_arguments(parser)
+
+        parser.add_argument(
+            "--tenant",
+            action="store",
+            dest="tenant",
+            help="Specify the tenant to show migrations for, either a single tenant name or 'all'.",
+            required=True,
+            type=str,
+        )
+
+    def handle(self, *args, **options):
+        tenant = options["tenant"]
+
+        if tenant.lower() == "all":
+            tenants_to_use = list(TENANT_DATABASES)
+        else:
+            if tenant not in TENANT_DATABASES:
+                self.stdout.write(self.style.ERROR(f"Tenant '{tenant}' not found in DATABASES settings."))
+                return
+            tenants_to_use = [tenant]
+
+        for t in tenants_to_use:
+            self.stdout.write(self.style.MIGRATE_LABEL(f"\n=== Tenant: {t} ==="))
+            options["database"] = t
+            with TenantContext(t):
+                super().handle(*args, **options)