wagtail 6.1.2__py3-none-any.whl → 6.2__py3-none-any.whl

wagtail/users/views/users.py

@@ -2,7 +2,10 @@ from warnings import warn
 
 import django_filters
 from django.conf import settings
-from django.contrib.auth import get_user_model, update_session_auth_hash
+from django.contrib.auth import (
+    get_user_model,
+    update_session_auth_hash,
+)
 from django.contrib.auth.models import Group
 from django.core.exceptions import FieldDoesNotExist, PermissionDenied
 from django.db.models import Q
@@ -14,6 +17,7 @@ from django.utils.translation import gettext_lazy
 
 from wagtail import hooks
 from wagtail.admin.filters import DateRangePickerWidget, WagtailFilterSet
+from wagtail.admin.search import SearchArea
 from wagtail.admin.ui.tables import (
     BulkActionsCheckboxColumn,
     Column,
@@ -22,8 +26,7 @@ from wagtail.admin.ui.tables import (
     TitleColumn,
 )
 from wagtail.admin.utils import get_user_display_name
-from wagtail.admin.views.generic import CreateView, DeleteView, EditView, IndexView
-from wagtail.admin.views.generic.history import HistoryView
+from wagtail.admin.views import generic
 from wagtail.admin.viewsets.model import ModelViewSet
 from wagtail.admin.widgets.boolean_radio_select import BooleanRadioSelect
 from wagtail.admin.widgets.button import (
@@ -41,7 +44,8 @@ User = get_user_model()
 
 # Typically we would check the permission 'auth.change_user' (and 'auth.add_user' /
 # 'auth.delete_user') for user management actions, but this may vary according to
-# the AUTH_USER_MODEL setting
+# the AUTH_USER_MODEL setting. These are no longer used in the codebase in favour
+# of ModelPermissionPolicy, but are kept here for backwards compatibility.
 add_user_perm = f"{AUTH_USER_APP_LABEL}.add_{AUTH_USER_MODEL_NAME.lower()}"
 change_user_perm = "{}.change_{}".format(
     AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME.lower()
@@ -54,6 +58,11 @@ delete_user_perm = "{}.delete_{}".format(
 def get_user_creation_form():
     form_setting = "WAGTAIL_USER_CREATION_FORM"
     if hasattr(settings, form_setting):
+        warn(
+            "The `WAGTAIL_USER_CREATION_FORM` setting is deprecated. Use a custom "
+            "`UserViewSet` subclass and override `get_form_class()` instead.",
+            RemovedInWagtail70Warning,
+        )
         return get_custom_form(form_setting)
     else:
         return UserCreationForm
@@ -62,6 +71,11 @@ def get_user_creation_form():
 def get_user_edit_form():
     form_setting = "WAGTAIL_USER_EDIT_FORM"
     if hasattr(settings, form_setting):
+        warn(
+            "The `WAGTAIL_USER_EDIT_FORM` setting is deprecated. Use a custom "
+            "`UserViewSet` subclass and override `get_form_class()` instead.",
+            RemovedInWagtail70Warning,
+        )
         return get_custom_form(form_setting)
     else:
         return UserEditForm
@@ -125,7 +139,7 @@ class UserFilterSet(WagtailFilterSet):
         fields = []
 
 
-class Index(IndexView):
+class IndexView(generic.IndexView):
     """
     Lists the users for management within the admin.
     """
@@ -257,7 +271,7 @@ class Index(IndexView):
         return queryset
 
 
-class Create(CreateView):
+class CreateView(generic.CreateView):
     """
     Provide the ability to create a user within the admin.
     """
@@ -279,7 +293,7 @@ class Create(CreateView):
         )
 
 
-class Edit(EditView):
+class EditView(generic.EditView):
     """
     Provide the ability to edit a user within the admin.
     """
@@ -333,7 +347,7 @@ class Edit(EditView):
         return context
 
 
-class Delete(DeleteView):
+class DeleteView(generic.DeleteView):
     """
     Provide the ability to delete a user within the admin.
     """
@@ -363,7 +377,7 @@ class Delete(DeleteView):
         )
 
 
-class History(HistoryView):
+class HistoryView(generic.HistoryView):
     def get_page_subtitle(self):
         return get_user_display_name(self.object)
 
@@ -374,12 +388,16 @@ class UserViewSet(ModelViewSet):
     ordering = "name"
     add_to_reference_index = False
     filterset_class = UserFilterSet
+    menu_name = "users"
+    menu_label = gettext_lazy("Users")
+    menu_order = 600
+    add_to_settings_menu = True
 
-    index_view_class = Index
-    add_view_class = Create
-    edit_view_class = Edit
-    delete_view_class = Delete
-    history_view_class = History
+    index_view_class = IndexView
+    add_view_class = CreateView
+    edit_view_class = EditView
+    delete_view_class = DeleteView
+    history_view_class = HistoryView
 
     template_prefix = "wagtailusers/users/"
 
@@ -395,3 +413,29 @@ class UserViewSet(ModelViewSet):
         if for_update:
             return get_user_edit_form()
         return get_user_creation_form()
+
+    @cached_property
+    def search_area_class(self):
+        class UsersSearchArea(SearchArea):
+            def is_shown(search_area, request):
+                return self.permission_policy.user_has_any_permission(
+                    request.user, {"add", "change", "delete"}
+                )
+
+        return UsersSearchArea
+
+    def get_search_area(self):
+        return self.search_area_class(
+            gettext_lazy("Users"),
+            self.get_url_name("index"),
+            name="users",
+            icon_name="user",
+            order=600,
+        )
+
+    def register_search_area(self):
+        hooks.register("register_admin_search_area", self.get_search_area)
+
+    def on_register(self):
+        super().on_register()
+        self.register_search_area()

wagtail/users/wagtail_hooks.py

@@ -1,151 +1,35 @@
 from django.apps import apps
-from django.contrib.auth import get_user_model
-from django.contrib.auth.models import Permission
 from django.core.exceptions import ImproperlyConfigured
-from django.db.models import Q
-from django.urls import reverse
 from django.utils.module_loading import import_string
-from django.utils.translation import gettext_lazy as _
 
 from wagtail import hooks
-from wagtail.admin.admin_url_finder import (
-    ModelAdminURLFinder,
-    register_admin_url_finder,
-)
-from wagtail.admin.menu import MenuItem
-from wagtail.admin.search import SearchArea
-from wagtail.compat import AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME
-from wagtail.permission_policies import ModelPermissionPolicy
 from wagtail.users.views.bulk_actions import (
     AssignRoleBulkAction,
     DeleteBulkAction,
     SetActiveStateBulkAction,
 )
-from wagtail.users.views.users import UserViewSet
 
 
-def get_group_viewset_cls(app_config):
+def get_viewset_cls(app_config, viewset_name):
     try:
-        group_viewset_cls = import_string(app_config.group_viewset)
+        viewset_cls = import_string(getattr(app_config, viewset_name))
     except (AttributeError, ImportError) as e:
         raise ImproperlyConfigured(
-            "Invalid setting for {appconfig}.group_viewset: {message}".format(
-                appconfig=app_config.__class__.__name__, message=e
-            )
+            f"Invalid setting for {app_config.__class__.__name__}.{viewset_name}: {e}"
         )
-    return group_viewset_cls
+    return viewset_cls
 
 
 @hooks.register("register_admin_viewset")
 def register_viewset():
     app_config = apps.get_app_config("wagtailusers")
-    group_viewset_cls = get_group_viewset_cls(app_config)
+    user_viewset_cls = get_viewset_cls(app_config, "user_viewset")
+    group_viewset_cls = get_viewset_cls(app_config, "group_viewset")
     return [
-        UserViewSet("wagtailusers_users", url_prefix="users"),
+        user_viewset_cls("wagtailusers_users", url_prefix="users"),
         group_viewset_cls("wagtailusers_groups", url_prefix="groups"),
     ]
 
 
-# Typically we would check the permission 'auth.change_user' (and 'auth.add_user' /
-# 'auth.delete_user') for user management actions, but this may vary according to
-# the AUTH_USER_MODEL setting
-add_user_perm = f"{AUTH_USER_APP_LABEL}.add_{AUTH_USER_MODEL_NAME.lower()}"
-change_user_perm = "{}.change_{}".format(
-    AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME.lower()
-)
-delete_user_perm = "{}.delete_{}".format(
-    AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME.lower()
-)
-
-
-class UsersMenuItem(MenuItem):
-    def is_shown(self, request):
-        return (
-            request.user.has_perm(add_user_perm)
-            or request.user.has_perm(change_user_perm)
-            or request.user.has_perm(delete_user_perm)
-        )
-
-
-@hooks.register("register_settings_menu_item")
-def register_users_menu_item():
-    return UsersMenuItem(
-        _("Users"),
-        reverse("wagtailusers_users:index"),
-        name="users",
-        icon_name="user",
-        order=600,
-    )
-
-
-class GroupsMenuItem(MenuItem):
-    def is_shown(self, request):
-        return (
-            request.user.has_perm("auth.add_group")
-            or request.user.has_perm("auth.change_group")
-            or request.user.has_perm("auth.delete_group")
-        )
-
-
-@hooks.register("register_settings_menu_item")
-def register_groups_menu_item():
-    return GroupsMenuItem(
-        _("Groups"),
-        reverse("wagtailusers_groups:index"),
-        name="groups",
-        icon_name="group",
-        order=601,
-    )
-
-
-@hooks.register("register_permissions")
-def register_permissions():
-    user_permissions = Q(
-        content_type__app_label=AUTH_USER_APP_LABEL,
-        codename__in=[
-            "add_%s" % AUTH_USER_MODEL_NAME.lower(),
-            "change_%s" % AUTH_USER_MODEL_NAME.lower(),
-            "delete_%s" % AUTH_USER_MODEL_NAME.lower(),
-        ],
-    )
-    group_permissions = Q(
-        content_type__app_label="auth",
-        codename__in=["add_group", "change_group", "delete_group"],
-    )
-
-    return Permission.objects.filter(user_permissions | group_permissions)
-
-
-class UsersSearchArea(SearchArea):
-    def is_shown(self, request):
-        return (
-            request.user.has_perm(add_user_perm)
-            or request.user.has_perm(change_user_perm)
-            or request.user.has_perm(delete_user_perm)
-        )
-
-
-@hooks.register("register_admin_search_area")
-def register_users_search_area():
-    return UsersSearchArea(
-        _("Users"),
-        reverse("wagtailusers_users:index"),
-        name="users",
-        icon_name="user",
-        order=600,
-    )
-
-
-User = get_user_model()
-
-
-class UserAdminURLFinder(ModelAdminURLFinder):
-    edit_url_name = "wagtailusers_users:edit"
-    permission_policy = ModelPermissionPolicy(User)
-
-
-register_admin_url_finder(User, UserAdminURLFinder)
-
-
 for action_class in [AssignRoleBulkAction, DeleteBulkAction, SetActiveStateBulkAction]:
     hooks.register("register_bulk_action", action_class)

wagtail/utils/utils.py

@@ -13,3 +13,30 @@ def deep_update(source, overrides):
         else:
             source[key] = overrides[key]
     return source
+
+
+def flatten_choices(choices):
+    """
+    Convert potentially grouped choices into a flat dict of choices.
+
+    flatten_choices([(1, '1st'), (2, '2nd')]) -> {1: '1st', 2: '2nd'}
+    flatten_choices([('Group', [(1, '1st'), (2, '2nd')])]) -> {1: '1st', 2: '2nd'}
+    flatten_choices({'Group': {'1': '1st', '2': '2nd'}}) -> {'1': '1st', '2': '2nd'}
+    """
+    ret = {}
+
+    to_unpack = choices.items() if isinstance(choices, dict) else choices
+
+    for key, value in to_unpack:
+        if isinstance(value, (list, tuple)):
+            # grouped choices (category, sub choices)
+            for sub_key, sub_value in value:
+                ret[str(sub_key)] = sub_value
+        elif isinstance(value, (dict)):
+            # grouped choices using dict (category, sub choices)
+            for sub_key, sub_value in value.items():
+                ret[str(sub_key)] = sub_value
+        else:
+            # choice (key, display value)
+            ret[str(key)] = value
+    return ret

wagtail/utils/version.py

@@ -20,10 +20,13 @@ def get_version(version):
     return main + sub
 
 
-def get_main_version(version=None):
+def get_main_version(version=None, include_patch=True):
     """Return main version (X.Y[.Z]) from VERSION."""
     version = get_complete_version(version)
-    parts = 2 if version[2] == 0 else 3
+    if include_patch:
+        parts = 2 if version[2] == 0 else 3
+    else:
+        parts = 2
     return ".".join(str(x) for x in version[:parts])
 
 

wagtail-6.2.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: wagtail
+Version: 6.2
+Summary: A Django content management system.
+Home-page: https://wagtail.org/
+Author: Wagtail core team + contributors
+Author-email: hello@wagtail.org
+License: BSD
+Project-URL: Changelog, https://github.com/wagtail/wagtail/blob/main/CHANGELOG.txt
+Project-URL: Documentation, https://docs.wagtail.org
+Project-URL: Source, https://github.com/wagtail/wagtail
+Project-URL: Tracker, https://github.com/wagtail/wagtail/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Wagtail
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: Django (<6.0,>=4.2)
+Requires-Dist: django-modelcluster (<7.0,>=6.2.1)
+Requires-Dist: django-permissionedforms (<1.0,>=0.1)
+Requires-Dist: django-taggit (<5.1,>=5.0)
+Requires-Dist: django-treebeard (<5.0,>=4.5.1)
+Requires-Dist: djangorestframework (<4.0,>=3.15.1)
+Requires-Dist: django-filter (<25,>=23.3)
+Requires-Dist: draftjs-exporter (<6.0,>=2.1.5)
+Requires-Dist: Pillow (<11.0.0,>=9.1.0)
+Requires-Dist: beautifulsoup4 (<4.13,>=4.8)
+Requires-Dist: Willow[heif] (<2,>=1.8.0)
+Requires-Dist: requests (<3.0,>=2.11.1)
+Requires-Dist: l18n (>=2018.5)
+Requires-Dist: openpyxl (<4.0,>=3.0.10)
+Requires-Dist: anyascii (>=0.1.5)
+Requires-Dist: telepath (<1,>=0.3.1)
+Requires-Dist: laces (<0.2,>=0.1)
+Provides-Extra: docs
+Requires-Dist: pyenchant (<4,>=3.1.1) ; extra == 'docs'
+Requires-Dist: sphinxcontrib-spelling (<8,>=7) ; extra == 'docs'
+Requires-Dist: Sphinx (>=7.0) ; extra == 'docs'
+Requires-Dist: sphinx-autobuild (>=0.6.0) ; extra == 'docs'
+Requires-Dist: sphinx-wagtail-theme (==6.3.0) ; extra == 'docs'
+Requires-Dist: myst-parser (==2.0.0) ; extra == 'docs'
+Requires-Dist: sphinx-copybutton (<1.0,>=0.5) ; extra == 'docs'
+Provides-Extra: testing
+Requires-Dist: python-dateutil (>=2.7) ; extra == 'testing'
+Requires-Dist: pytz (>=2014.7) ; extra == 'testing'
+Requires-Dist: Jinja2 (<3.2,>=3.0) ; extra == 'testing'
+Requires-Dist: boto3 (<2,>=1.28) ; extra == 'testing'
+Requires-Dist: freezegun (>=0.3.8) ; extra == 'testing'
+Requires-Dist: azure-mgmt-cdn (<13.0,>=12.0) ; extra == 'testing'
+Requires-Dist: azure-mgmt-frontdoor (<1.1,>=1.0) ; extra == 'testing'
+Requires-Dist: django-pattern-library (>=0.7) ; extra == 'testing'
+Requires-Dist: coverage (>=3.7.0) ; extra == 'testing'
+Requires-Dist: doc8 (==0.8.1) ; extra == 'testing'
+Requires-Dist: ruff (==0.1.5) ; extra == 'testing'
+Requires-Dist: semgrep (==1.40.0) ; extra == 'testing'
+Requires-Dist: curlylint (==0.13.1) ; extra == 'testing'
+Requires-Dist: djhtml (==3.0.6) ; extra == 'testing'
+Requires-Dist: polib (<2.0,>=1.1) ; extra == 'testing'
+Requires-Dist: factory-boy (>=3.2) ; extra == 'testing'
+Requires-Dist: tblib (<3.0,>=2.0) ; extra == 'testing'
+
+Wagtail is an open source content management system built on Django, with a strong community and commercial support. It’s focused on user experience, and offers precise control for designers and developers.
+
+For more details, see https://wagtail.org, https://docs.wagtail.org and https://github.com/wagtail/wagtail/.