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

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

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

@@ -1,4 +1,4 @@
-cardo_python_utils-0.5.dev48.dist-info/licenses/LICENSE,sha256=N-YtxDy8n5A1Mo7JKKItNIlboiK_pMOZ48ojx76jo3g,1046
+cardo_python_utils-0.5.dev50.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=J6zy05R4DC43gYFF9_fYz7T9zxDmFn7IkYh5OByePRY,6213
+python_utils/django/README.md,sha256=1_I6P3sB2_nBZ9hb0kUrTI4W4pDOxRAkfSO1iekfEVE,6750
 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
@@ -30,7 +30,7 @@ python_utils/django/api/utils.py,sha256=ycpSnTtGcfdGP1_Hk0P2c8ZNId70xOYtjx1m0nAU
 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=pKKuLczhI-1N5-ccFPeB1YV-n8Uu8LVOAvPVrB1zHeU,1316
+python_utils/django/celery/tenant_aware_task.py,sha256=RS-6etWP16vYka0nlY1UbEdriqF8ouW5OML05fBF-LA,2944
 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
@@ -39,6 +39,7 @@ python_utils/django/db/utils.py,sha256=DMrFHTjXOkeDsUTdYOCAnZOU_PHKh0zvx-WXsyn7Z
 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/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
@@ -62,7 +63,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.dev48.dist-info/METADATA,sha256=EimWDluEjRNS_-U--n2S4C4jBu3Vx2nWS6PPnWeo3Ls,3007
-cardo_python_utils-0.5.dev48.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-cardo_python_utils-0.5.dev48.dist-info/top_level.txt,sha256=zAx6OfEsjJs8BEW3okSiG_j9gpkI69xWShzum6oBgKI,13
-cardo_python_utils-0.5.dev48.dist-info/RECORD,,
+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,,

python_utils/django/README.md

@@ -155,6 +155,30 @@ admin.site.has_permission = has_admin_site_permission
 
 If using `django-ninja`, apart from the settings configured above, auth utils are provided in the django/api/ninja.py module.
 
+## Atomic Transactions
+
+Django's `transaction.atomic` uses the default database. To make it tenant-aware, use `tenant_atomic`
+
+```python3
+from python_utils.django.db.transaction import tenant_atomic
+
+@tenant_atomic
+def my_function():
+    ...
+```
+
+## Django Shell
+
+This library overrides the shell command of Django, so that it requires the `tenant` arg. 
+This way, the shell is automatically initialized with the context set to the tenant. 
+
+```bash
+./manage.py shell --tenant=tenant1
+
+Starting shell for tenant: -tenant=tenant
+>>>
+```
+
 ## Testing
 
 In order for tests to work, create the following autouse fixtures:

python_utils/django/celery/tenant_aware_task.py

@@ -1,10 +1,22 @@
+from copy import deepcopy
+
 from celery import Task
 
 from ..settings import TENANT_KEY
 from ..tenant_context import TenantContext
 
+try:
+    # If celery_once is installed, use QueueOnce as the base class for TenantAwareTask.
+    from celery_once.tasks import QueueOnce
+
+    TaskClass = QueueOnce
+    USE_QUEUE_ONCE = True
+except ImportError:
+    TaskClass = Task
+    USE_QUEUE_ONCE = False
 
-class TenantAwareTask(Task):
+
+class TenantAwareTask(TaskClass):
     #: Enable argument checking.
     #: You can set this to false if you don't want the signature to be
     #: checked when calling the task.
@@ -13,12 +25,17 @@ class TenantAwareTask(Task):
     #: Defaults to :attr:`app.strict_typing <@Celery.strict_typing>`.
     typing = False
 
+    once = {"graceful": True, "unlock_before_run": False}
+
     def __call__(self, *args, **kwargs):
         """Override the __call__ method to set the tenant name in the thread namespace."""
 
-        # Celery backend_cleanup doesn't need a tenant and cannot be configured to pass the tenant kwarg
-        # because it is dynamically generated at @connect_on_app_finalize by celery itself
-        # ref: celery/app/builtins.py def add_backend_cleanup_task
+        # Only clear the lock before the task's execution if the
+        # "unlock_before_run" option is True
+        if USE_QUEUE_ONCE and self.unlock_before_run():
+            key = self.get_key(args, kwargs)
+            self.once_backend.clear_lock(key)
+
         if self.name != "celery.backend_cleanup":
             tenant = kwargs.pop(TENANT_KEY)
             TenantContext.set(tenant)
@@ -29,3 +46,28 @@ class TenantAwareTask(Task):
         """Clear the tenant from the thread namespace after the task has returned."""
         TenantContext.clear()
         super().after_return(status, retval, task_id, args, kwargs, einfo)
+
+    def _get_call_args(self, args, kwargs):
+        """This method is used by QueueOnce, to create the key for the lock."""
+
+        # Celery backend_cleanup doesn't need a tenant and cannot be configured to pass the tenant kwarg
+        # because it is dynamically generated at @connect_on_app_finalize by celery itself
+        # ref: celery/app/builtins.py def add_backend_cleanup_task
+        if self.name == "celery.backend_cleanup":
+            return super()._get_call_args(args, kwargs)
+
+        # QueueOnce._get_call_args validates the args and kwargs
+        # by binding them to the task signature.
+        # Since the TENANT_KEY kwarg is not part of the signature,
+        # we need to remove it from the kwargs before passing them
+        # to QueueOnce._get_call_args.
+        # Copy the kwargs so that we don't modify the original kwargs.
+        _kwargs = deepcopy(kwargs)
+        tenant = _kwargs.pop(TENANT_KEY)
+        tenant_kwarg = {TENANT_KEY: tenant}
+        task_call_args = super()._get_call_args(args, _kwargs)
+
+        # 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/management/commands/shell.py

@@ -0,0 +1,32 @@
+from django.core.management.commands.shell import Command as ShellCommand
+
+from ...settings import TENANT_DATABASES
+from ...tenant_context import TenantContext
+
+
+class Command(ShellCommand):
+    help = "Runs a Python interactive interpreter 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 run the shell for.",
+            required=True,
+            type=str,
+        )
+
+    def handle(self, **options):
+        tenant = options["tenant"]
+
+        if tenant not in TENANT_DATABASES:
+            self.stdout.write(self.style.ERROR(f"Tenant '{tenant}' not found in DATABASES settings."))
+            return
+
+        self.stdout.write(self.style.SUCCESS(f"Starting shell for tenant: {tenant}"))
+
+        with TenantContext(tenant):
+            super().handle(**options)