Merge remote-tracking branch 'upstream/master'

Author: fsbraun

.github/workflows/test.yml

@@ -8,16 +8,30 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
         requirements-file: [
           django-4.2.txt,
           django-5.0.txt,
+          django-5.1.txt,
           django-main.txt,
         ]
         custom-image-model: [false, true]
         os: [
           ubuntu-20.04,
         ]
+        exclude:
+          - requirements-file: django-5.0.txt
+            python-version: 3.8
+          - requirements-file: django-5.0.txt
+            python-version: 3.9
+          - requirements-file: django-5.1.txt
+            python-version: 3.8
+          - requirements-file: django-5.1.txt
+            python-version: 3.9
+          - requirements-file: django-main.txt
+            python-version: 3.8
+          - requirements-file: django-main.txt
+            python-version: 3.9
 
     steps:
     - uses: actions/checkout@v1
@@ -34,11 +48,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r tests/requirements/${{ matrix.requirements-file }}
-        python setup.py install
+        pip install -e .
     - name: Enable the custom image model
       run: echo "CUSTOM_IMAGE=custom_image.Image" >> $GITHUB_ENV
       if: ${{ matrix.custom-image-model }}
     - name: Run coverage
-      run: coverage run tests/settings.py
+      run: coverage run ./tests/settings.py 
     - name: Upload Coverage to Codecov
       uses: codecov/codecov-action@v1

CHANGELOG.rst

@@ -2,6 +2,16 @@
 CHANGELOG
 =========
 
+3.2.2 (2024-09-09)
+==================
+
+* fix: Remove version pin to Django<5.1
+
+3.2.1 (2024-09-05)
+==================
+
+* fix: Restore python 3.8 and python 3.9 compatibility
+
 3.2.0 (2024-08-23)
 ==================
 
@@ -734,7 +744,7 @@ CHANGELOG
 
 
 0.5.4a1
-=======
+========
 
 * Adds description field.
 

README.rst

@@ -54,7 +54,7 @@ for all the details on how to install, configure and use django-filer.
     :target: http://badge.fury.io/py/django-filer
 .. |coverage| image:: https://codecov.io/gh/django-cms/django-filer/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/django-cms/django-filer
-.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg
+.. |python| image:: https://img.shields.io/badge/python-3.10+-blue.svg
     :target: https://pypi.org/project/django-filer/
 .. |django| image:: https://img.shields.io/badge/django-3.2+-blue.svg
     :target: https://www.djangoproject.com/

filer/__init__.py

@@ -13,4 +13,4 @@
  8. Publish the release and it will automatically release to pypi
 """
 
-__version__ = '3.2.0'
+__version__ = '3.2.2'

filer/cache.py

@@ -1,13 +1,13 @@
 import typing
 
-from django.contrib.auth import get_user_model
+from django.db.models import Model
 from django.core.cache import cache
 
 
-User = get_user_model()
+UserModel = typing.TypeVar('UserModel', bound=Model)
 
 
-def get_folder_perm_cache_key(user: User, permission: str) -> str:
+def get_folder_perm_cache_key(user: UserModel, permission: str) -> str:
     """
     Generates a unique cache key for a given user and permission.
 
@@ -18,7 +18,9 @@ def get_folder_perm_cache_key(user: User, permission: str) -> str:
     for far more than 1,000 admin users to make the cached unit require less memory.
 
     Parameters:
-    user (User): The user for whom the cache key is being generated.
+    user (UserModel): The user for whom the cache key is being generated.
+        The `user` can be an instance of the default `django.contrib.auth.models.User`
+        or any custom user model specified by `AUTH_USER_MODEL` in the settings.
     permission (str): The permission for which the cache key is being generated.
 
     Returns:
@@ -27,15 +29,17 @@ def get_folder_perm_cache_key(user: User, permission: str) -> str:
     return f"filer:perm:{permission}"
 
 
-def get_folder_permission_cache(user: User, permission: str) -> typing.Optional[dict]:
+def get_folder_permission_cache(user: UserModel, permission: str) -> typing.Optional[dict]:
     """
     Retrieves the cached folder permissions for a given user and permission.
 
     If the cache value exists, it returns the permissions for the user.
     If the cache value does not exist, it returns None.
 
     Parameters:
-    user (User): The user for whom the permissions are being retrieved.
+    user (UserModel): The user for whom the permissions are being retrieved.
+        The `user` can be an instance of the default `django.contrib.auth.models.User`
+        or any custom user model specified by `AUTH_USER_MODEL` in the settings.
     permission (str): The permission for which the permissions are being retrieved.
 
     Returns:
@@ -47,15 +51,17 @@ def get_folder_permission_cache(user: User, permission: str) -> typing.Optional[
     return None
 
 
-def clear_folder_permission_cache(user: User, permission: typing.Optional[str] = None) -> None:
+def clear_folder_permission_cache(user: UserModel, permission: typing.Optional[str] = None) -> None:
     """
     Clears the cached folder permissions for a given user.
 
     If a specific permission is provided, it clears the cache for that permission only.
     If no specific permission is provided, it clears the cache for all permissions.
 
     Parameters:
-    user (User): The user for whom the permissions are being cleared.
+    user (UserModel): The user for whom the permissions are being cleared.
+        The `user` can be an instance of the default `django.contrib.auth.models.User`
+        or any custom user model specified by `AUTH_USER_MODEL` in the settings.
     permission (str, optional): The specific permission to clear. Defaults to None.
     """
     if permission is None:
@@ -65,7 +71,7 @@ def clear_folder_permission_cache(user: User, permission: typing.Optional[str] =
         cache.delete(get_folder_perm_cache_key(user, permission))
 
 
-def update_folder_permission_cache(user: User, permission: str, id_list: list[int]) -> None:
+def update_folder_permission_cache(user: UserModel, permission: str, id_list: typing.List[int]) -> None:
     """
     Updates the cached folder permissions for a given user and permission.
 
@@ -74,7 +80,9 @@ def update_folder_permission_cache(user: User, permission: str, id_list: list[in
     Finally, it sets the updated permissions back into the cache.
 
     Parameters:
-    user (User): The user for whom the permissions are being updated.
+    user (UserModel): The user for whom the permissions are being updated.
+        The `user` can be an instance of the default `django.contrib.auth.models.User`
+        or any custom user model specified by `AUTH_USER_MODEL` in the settings.
     permission (str): The permission to update.
     id_list (list): The list of IDs to set as the new permissions.
     """

setup.py

@@ -5,7 +5,7 @@
 
 
 REQUIREMENTS = [
-    'django>=3.2,<5.1',
+    'django>=3.2',
     'django-polymorphic',
     'easy-thumbnails[svg]',
 ]
@@ -30,11 +30,14 @@
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
     'Framework :: Django',
     'Framework :: Django :: 3.2',
     'Framework :: Django :: 4.0',
     'Framework :: Django :: 4.1',
     'Framework :: Django :: 4.2',
+    'Framework :: Django :: 5.0',
+    'Framework :: Django :: 5.1',
     'Framework :: Django CMS',
     'Framework :: Django CMS :: 3.8',
     'Framework :: Django CMS :: 3.9',

tests/requirements/django-5.1.txt

@@ -0,0 +1,4 @@
+-r base.txt
+
+django>=5.1a1,<5.2
+django_polymorphic>=3.1