django-request-vars 2.0.0__py3-none-any.whl

django_request_vars-2.0.0.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.5
+Name: django-request-vars
+Version: 2.0.0
+Summary: Stores current request, user and your defined data in thread local variable.
+Project-URL: Homepage, https://github.com/kindlycat/django-request-vars
+Project-URL: Documentation, https://django-request-vars.readthedocs.io
+Project-URL: Repository, https://github.com/kindlycat/django-request-vars.git
+Project-URL: Issues, https://github.com/kindlycat/django-request-vars/issues
+Author-email: Grigory Mishchenko <grishkokot@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: cache,django,middleware,request,thread,user,variable
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: >=3.11
+Requires-Dist: django>=5.2
+Description-Content-Type: text/x-rst
+
+Django request vars
+===================
+.. image:: https://github.com/kindlycat/django-request-vars/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/kindlycat/django-request-vars/actions/workflows/tests.yml
+.. image:: https://codecov.io/gh/kindlycat/django-request-vars/graph/badge.svg
+    :target: https://codecov.io/gh/kindlycat/django-request-vars
+.. image:: https://readthedocs.org/projects/django-request-vars/badge/?version=latest
+    :target: http://django-request-vars.readthedocs.io/en/latest/?badge=latest
+.. image:: https://img.shields.io/pypi/v/django-request-vars.svg
+    :target: https://pypi.org/project/django-request-vars/
+
+Application that stores current request, user and your defined data in thread
+local variable.
+
+Full documentation on `read the docs`_.
+
+Requirements
+------------
+
+**Django:** 5.2, 6.0, 6.1
+**Python:** 3.11+
+
+Installation
+------------
+Install using pip:
+
+.. code-block:: sh
+
+    $ pip install django-request-vars
+
+Add to installed apps if you need template tags:
+
+.. code-block:: python
+
+    INSTALLED_APPS = (
+        ...
+        'request_vars',
+        ...
+    )
+
+Add middleware:
+
+.. code-block:: python
+
+    MIDDLEWARE = [
+        ...
+        'request_vars.middleware.RequestVarsMiddleware',
+        ...
+    ]
+
+
+.. _`read the docs`: https://django-request-vars.readthedocs.io/en/master/

django_request_vars-2.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+request_vars/__init__.py,sha256=YeomI93yTvWPVgmZzBcLBXngJoCY15-lV2oG-sxHwak,135
+request_vars/apps.py,sha256=G3mD6LSPEii5ISMoCYLV2wmqql9sLX9tMk4GLGoxnGE,98
+request_vars/conf.py,sha256=HAn3YtXqTTPdO2hKhwHcPzfkU_rrdeilcGhCb1y2l3s,858
+request_vars/decorators.py,sha256=_oZLPY5sTNaa0_CVp-wu7Tdgkub6tFOOdK90gyF9_jU,622
+request_vars/middleware.py,sha256=xANpk-0ymRyOQ1roCj6XVI0Zt2Xj0iB1y27bcT5zQxE,756
+request_vars/utils.py,sha256=P6ZdZb60rYDrMe9FfWcS1RGzibn1sNgN599hfz19JQA,459
+request_vars/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+request_vars/templatetags/request_vars.py,sha256=9Vk8xKzaOlMG9xqlbTDRBvj_sLAGNCC20kjI-3bcFik,140
+django_request_vars-2.0.0.dist-info/METADATA,sha256=33RJ0iwnhuIy2EB98zpaJ33lw0Jc46Vig3gq-27BVEY,2540
+django_request_vars-2.0.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+django_request_vars-2.0.0.dist-info/licenses/LICENSE,sha256=piSpo3UtvxHSSAuhm9XAMeYWzkZb8E-aWJ-jd82UjNg,1486
+django_request_vars-2.0.0.dist-info/RECORD,,

django_request_vars-2.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

django_request_vars-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,25 @@
+copyright (c) 2018 Grigory Mishchenko and individual contributors.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+ * The names of its contributors may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

request_vars/__init__.py

@@ -0,0 +1,7 @@
+from threading import local
+
+
+__version__ = '2.0.0'
+default_app_config = 'request_vars.apps.RequestVarsConfig'
+
+REQUEST_VARS = local()

request_vars/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class RequestVarsConfig(AppConfig):
+    name = 'request_vars'

request_vars/conf.py

@@ -0,0 +1,30 @@
+from typing import Any
+
+from django.conf import settings as dj_settings
+from django.core.signals import setting_changed
+
+
+DEFAULTS = {'REQUEST_VARS_MIDDLEWARE_CALLBACK': None}
+
+
+class Settings:
+    def __getattr__(self, name) -> Any:
+        if name not in DEFAULTS:  # pragma: no cover
+            msg = "'%s' object has no attribute '%s'"
+            raise AttributeError(msg % (self.__class__.__name__, name))
+        value = getattr(dj_settings, name, DEFAULTS[name])
+        setattr(self, name, value)
+        return value
+
+    def change_setting(self, setting, value, enter, **kwargs) -> None:
+        if setting not in DEFAULTS:  # pragma: no cover
+            return
+
+        if enter:
+            setattr(self, setting, value)
+        else:
+            delattr(self, setting)
+
+
+settings = Settings()
+setting_changed.connect(settings.change_setting)

request_vars/decorators.py

@@ -0,0 +1,24 @@
+from collections.abc import Callable
+from functools import wraps
+from typing import Any
+
+from request_vars.utils import get_variable, set_variable
+
+
+__all__ = ['request_cache']
+
+
+def request_cache(func) -> Callable:
+    @wraps(func)
+    def wrapped(*args, **kwargs) -> Any:
+        name = f'rc_{func.__module__}.{func.__name__}'
+        cached = get_variable(name)
+        if cached:
+            return cached
+        result = func(*args, **kwargs)
+        # Avoid cache forever in tasks, shell or tests.
+        if get_variable('request'):
+            set_variable(name, result)
+        return result
+
+    return wrapped

request_vars/middleware.py

@@ -0,0 +1,23 @@
+from typing import Any
+
+from django.utils.module_loading import import_string
+
+from request_vars.conf import settings
+from request_vars.utils import clear_thread_variable, set_variable
+
+
+class RequestVarsMiddleware:
+    def __init__(self, get_response) -> None:
+        self.get_response = get_response
+
+    def __call__(self, request) -> Any:
+        set_variable('request', request)
+        set_variable('user', request.user)
+        if settings.REQUEST_VARS_MIDDLEWARE_CALLBACK:
+            import_string(settings.REQUEST_VARS_MIDDLEWARE_CALLBACK)(request)
+        response = self.get_response(request)
+        clear_thread_variable()
+        return response
+
+    def process_exception(self, request, exception) -> None:
+        clear_thread_variable()

request_vars/templatetags/request_vars.py

@@ -0,0 +1,8 @@
+from django import template
+
+from request_vars.utils import get_variable
+
+
+register = template.Library()
+
+register.simple_tag(get_variable)

request_vars/utils.py

@@ -0,0 +1,26 @@
+from request_vars import REQUEST_VARS
+
+
+__all__ = [
+    'clear_thread_variable',
+    'del_variable',
+    'get_variable',
+    'set_variable',
+]
+
+
+def set_variable(key, val):
+    setattr(REQUEST_VARS, key, val)
+
+
+def get_variable(key, default=None):
+    return getattr(REQUEST_VARS, key, default)
+
+
+def del_variable(key):
+    if hasattr(REQUEST_VARS, key):
+        del REQUEST_VARS.__dict__[key]
+
+
+def clear_thread_variable():
+    REQUEST_VARS.__dict__.clear()