wbcore 1.59.15__py2.py3-none-any.whl → 1.60.0__py2.py3-none-any.whl

wbcore/menus/menus.py

@@ -10,19 +10,22 @@ from rest_framework.reverse import reverse
 class ItemPermission:
     permissions: List[str] = field(default_factory=list)
     method: Optional[Callable] = None
+    include_superuser: bool = True
 
     def has_permission(self, request: Request) -> bool:
-        if request.user.is_superuser:
+        if self.include_superuser and request.user.is_superuser:
             return True
 
+        has_permission = False
         for permission in self.permissions:
-            if not request.user.has_perm(permission):
-                return False
+            if request.user.has_perm(permission):
+                has_permission = True
+                break
 
         if self.method:
-            return self.method(request=request)
+            has_permission &= self.method(request=request)
 
-        return True
+        return has_permission
 
 
 @dataclass

wbcore/metadata/configs/buttons/view_config.py

@@ -120,8 +120,11 @@ class ButtonViewConfig(WBCoreViewConfig):
         return set(self.CUSTOM_EXTRA_BUTTONS)
 
     def _get_custom_extra_buttons(self):
+        buttons = self.get_custom_extra_buttons()
+        if hasattr(self.view, "add_extra_buttons") and (extra_buttons := self.view.add_extra_buttons(self.request)):
+            buttons.update(extra_buttons)
         yield from self.serialize(
-            self.get_custom_extra_buttons(),
+            buttons,
             add_extra_button.send(
                 self.view.__class__, instance=self.instance, request=self.request, view=self.view, **self.view.kwargs
             ),

wbcore/metadata/configs/display/models.py

@@ -1,12 +1,11 @@
-from django.contrib.auth import get_user_model
 from django.db import models
 
+from wbcore.contrib.authentication.models.users import User
+
 
 class Preset(models.Model):
     title = models.CharField(max_length=64)
-    user = models.ForeignKey(
-        to=get_user_model(), related_name="presets", on_delete=models.CASCADE, null=True, blank=True
-    )
+    user = models.ForeignKey(to=User, related_name="presets", on_delete=models.CASCADE, null=True, blank=True)
     display_identifier = models.CharField(max_length=512)
     display = models.JSONField(null=True, blank=True)
 
@@ -15,7 +14,7 @@ class Preset(models.Model):
 
 
 class AppliedPreset(models.Model):
-    user = models.ForeignKey(to=get_user_model(), related_name="applied_presets", on_delete=models.CASCADE)
+    user = models.ForeignKey(to=User, related_name="applied_presets", on_delete=models.CASCADE)
     display_identifier_path = models.CharField(max_length=1024)
     preset = models.ForeignKey(
         to=Preset, related_name="applied_presets", on_delete=models.SET_NULL, null=True, blank=True

wbcore/metadata/configs/endpoints.py

@@ -71,10 +71,11 @@ class EndpointViewConfig(WBCoreViewConfig):
             return None
 
     def get_delete_endpoint(self, **kwargs):
-        return self.get_endpoint()
+        if not hasattr(self.view, "ONLY_READ_ONLY_ENDPOINT"):
+            return self.get_endpoint()
 
     def _get_delete_endpoint(self, **kwargs):
-        read_only = getattr(self.view, "READ_ONLY", False)
+        read_only = getattr(self.view, "ONLY_READ_ONLY_ENDPOINT", False)
         content_type = self.view.get_content_type()
 
         if content_type is None:
@@ -99,7 +100,7 @@ class EndpointViewConfig(WBCoreViewConfig):
     def _get_create_endpoint(self):
         from wbcore.viewsets import ViewSet
 
-        read_only = getattr(self.view, "READ_ONLY", False)
+        read_only = getattr(self.view, "ONLY_READ_ONLY_ENDPOINT", False)
         if read_only:
             return None
 
@@ -118,10 +119,11 @@ class EndpointViewConfig(WBCoreViewConfig):
         return None
 
     def get_update_endpoint(self, **kwargs):
-        return self.get_instance_endpoint()
+        if not hasattr(self.view, "ONLY_READ_ONLY_ENDPOINT"):
+            return self.get_instance_endpoint()
 
     def _get_update_endpoint(self):
-        if (endpoint := self.get_update_endpoint()) and not getattr(self.view, "READ_ONLY", False):
+        if (endpoint := self.get_update_endpoint()) and not getattr(self.view, "ONLY_READ_ONLY_ENDPOINT", False):
             from wbcore.viewsets import ViewSet
 
             content_type = self.view.get_content_type()

wbcore/migrations/0015_delete_genericmodel.py

@@ -0,0 +1,16 @@
+# Generated by Django 5.2.9 on 2026-01-09 14:54
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wbcore', '0014_biguserobjectpermission_system'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='GenericModel',
+        ),
+    ]

wbcore/models/base.py

@@ -1,4 +1,3 @@
-from contextlib import suppress
 from typing import Any, List, Optional
 
 from celery import shared_task
@@ -172,13 +171,3 @@ class WBModel(models.Model):
         errors = super().check(**kwargs)
         errors.extend(cls._check_model_methods())
         return errors
-
-
-@shared_task(queue=Queue.DEFAULT.value)
-def merge_as_task(content_type_id: int, main_object_id: int, merged_object_id: int):
-    content_type = ContentType.objects.get(id=content_type_id)
-    with suppress(content_type.model_class().DoesNotExist):
-        main_object = content_type.get_object_for_this_type(id=main_object_id)
-        merged_object = content_type.get_object_for_this_type(id=merged_object_id)
-        if hasattr(main_object, "merge") and callable(main_object.merge):
-            main_object.merge(merged_object)

wbcore/release_notes/models.py

@@ -1,7 +1,7 @@
-from django.contrib.auth import get_user_model
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
+from wbcore.contrib.authentication.models.users import User
 from wbcore.release_notes.utils import parse_release_note
 
 
@@ -23,9 +23,7 @@ class ReleaseNote(models.Model):
     module = models.CharField(max_length=255, help_text=_("The workbench module of the release"))
     summary = models.CharField(max_length=512, help_text=_("A brief summary of the release"))
     notes = models.TextField(default="", help_text=_("What's new? What's improved? What's fixed?"))
-    read_by = models.ManyToManyField(
-        to=get_user_model(), related_name="read_patch_notes", db_table="bridger_releasenote_read_by"
-    )
+    read_by = models.ManyToManyField(to=User, related_name="read_patch_notes", db_table="bridger_releasenote_read_by")
 
     @classmethod
     def handle_from_markdown(cls, markdown_content: str) -> "ReleaseNote":

wbcore/serializers/fields/fields.py

@@ -180,9 +180,11 @@ class SlugRelatedField(WBCoreSerializerFieldMixin, serializers.SlugRelatedField)
 
 
 class SerializerMethodField(WBCoreSerializerFieldMixin, serializers.SerializerMethodField):
-    def __init__(self, method_name=None, field_class=StringRelatedField, **kwargs):
+    def __init__(self, method_name=None, field_class=StringRelatedField, percent=None, **kwargs):
         self.field_class = field_class
-        self.initkwargs = kwargs
+        self.initkwargs = kwargs.copy()
+        if percent:
+            self.initkwargs["percent"] = percent
         super().__init__(method_name, **kwargs)
 
     def get_representation(self, request, field_name):

wbcore/serializers/fields/number.py

@@ -86,6 +86,15 @@ class DecimalRangeField(RangeMixin, WBCoreSerializerFieldMixin, serializers.Deci
     field_type = WBCoreType.NUMBERRANGE.value
     internal_field = NumericRange
 
+    def to_representation(self, instance):
+        res = list(super().to_representation(instance))
+        # ensure empty value shows as None
+        if not res[0]:
+            res[0] = "-Infinity"
+        if not res[1]:
+            res[1] = "Infinity"
+        return tuple(res)
+
     def __init__(self, max_digits=None, decimal_places=None, **kwargs):
         if not max_digits:
             max_digits = 3

wbcore/shares/config.py

@@ -1,9 +1,9 @@
-from django.contrib.auth import get_user_model
 from django.utils.translation import gettext_lazy as _
 from rest_framework.reverse import reverse
 
 from wbcore import serializers as wb_serializers
 from wbcore import shares
+from wbcore.contrib.authentication.models.users import User
 from wbcore.contrib.authentication.serializers import UserRepresentationSerializer
 from wbcore.contrib.icons import WBIcon
 from wbcore.metadata.configs.buttons import ActionButton, ButtonConfig
@@ -35,7 +35,7 @@ class DefaultShareSerializer(wb_serializers.Serializer):
     )
     share_recipients = wb_serializers.PrimaryKeyRelatedField(
         many=True,
-        queryset=get_user_model().objects.all(),
+        queryset=User.objects.all(),
         label=_("Recipient"),
         required=False,
         depends_on=[{"field": "share", "options": {}}],

wbcore/signals/merge.py

@@ -2,3 +2,4 @@ from django.db.models.signals import ModelSignal
 
 # Signal fired before merged/obsolete object are deleted during a merge phase
 pre_merge = ModelSignal(use_caching=False)
+post_merge = ModelSignal(use_caching=False)

wbcore/test/utils.py

@@ -104,6 +104,8 @@ def get_data_from_factory(instance, viewset, delete=False, update=False, superus
                 data[key] = document.file.open(mode='rb')
                 """
                 pass  # data[key] = open(value.replace("http://testserver/",""), 'rb')
+            elif isinstance(value, tuple):
+                data[key] = f"{value[0]},{value[1]}"
             else:
                 data[key] = value
             # Related objects with cascading on_delete will be deleted. we create a new related object and override the id of the deleted object
@@ -214,7 +216,7 @@ def get_factory_custom_user():
 
 def format_number(number, is_pourcent=False, decimal=2):
     number = number if number else 0
-    return f'{number:,.{decimal}{"%" if is_pourcent else "f"}}'
+    return f"{number:,.{decimal}{'%' if is_pourcent else 'f'}}"
 
 
 # https://stackoverflow.com/questions/11875770/how-to-overcome-datetime-datetime-not-json-serializable?page=1&tab=votes#tab-top

wbcore/tests/test_permissions/test_backend.py

@@ -1,12 +1,10 @@
 import pytest
-from django.contrib.auth import get_user_model
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from faker import Faker
+from wbcore.contrib.authentication.models.users import User
 from wbcore.permissions.shortcuts import get_internal_users
 
-User = get_user_model()
-
 fake = Faker()
 
 

wbcore/tests/test_something.py

@@ -3,7 +3,7 @@
 # from selenium import webdriver
 # from channels.testing import ChannelsLiveServerTestCase
 
-# from django.contrib.auth import get_user_model, authenticate
+# from wbcore.contrib.authentication.models.users import User, authenticate
 # from .selenium.utils import menu_items_for_user
 
 # def login(url, username, password):
@@ -22,7 +22,7 @@
 
 #     @pytest.mark.parametrize
 #     def test_something1(self):
-#         user = get_user_model().objects.create_superuser(
+#         user = User.objects.create_superuser(
 #             username="root",
 #             email="a@a.de",
 #             password="root"

wbcore/urls.py

@@ -6,10 +6,6 @@ from wbcore.contrib.dynamic_preferences.viewsets import UserPreferencesViewSet
 from wbcore.shares.views import ShareAPIView
 
 from .configs.views import ConfigAPIView
-from .content_type.viewsets import (
-    ContentTypeRepresentationViewSet,
-    DynamicObjectIDRepresentationViewSet,
-)
 from .crontab.viewsets import CrontabScheduleRepresentationViewSet
 from .frontend_user_configuration import FrontendUserConfigurationModelViewSet
 from .markdown.views import (
@@ -44,12 +40,7 @@ router.register(r"revision", RevisionModelViewSet, basename="revision")
 router.register(r"revisionrepresentation", RevisionRepresentationViewSet, basename="revisionrepresentation")
 router.register(r"versionrepresentation", VersionRepresentationViewSet, basename="versionrepresentation")
 router.register(r"releasenote", ReleaseNoteReadOnlyModelViewSet, basename="releasenote")
-router.register(r"contenttyperepresentation", ContentTypeRepresentationViewSet, basename="contenttyperepresentation")
-router.register(
-    r"dynamiccontenttyperepresentation",
-    DynamicObjectIDRepresentationViewSet,
-    basename="dynamiccontenttyperepresentation",
-)
+
 router.register(
     r"crontabschedulerepresentation", CrontabScheduleRepresentationViewSet, basename="crontabschedulerepresentation"
 )
@@ -73,6 +64,10 @@ urlpatterns = [
         "authentication/",
         include(("wbcore.contrib.authentication.urls", "wbcore.contrib.authentication"), namespace="authentication"),
     ),
+    path(
+        "content_type/",
+        include(("wbcore.contrib.content_type.urls", "wbcore.contrib.content_type"), namespace="content_type"),
+    ),
     path(
         "notifications/",
         include(("wbcore.contrib.notifications.urls", "wbcore.contrib.notifications"), namespace="notifications"),

wbcore/utils/models.py

@@ -1,8 +1,10 @@
 from contextlib import suppress
 from typing import Self
 
+from celery import shared_task
+from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import FieldDoesNotExist, FieldError
-from django.db import models
+from django.db import models, transaction
 from django.db.models.signals import post_delete, pre_delete
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
@@ -13,8 +15,10 @@ from wbcore.contrib.color.enums import WBColor
 from wbcore.contrib.color.fields import ColorField
 from wbcore.contrib.icons import WBIcon
 from wbcore.contrib.icons.models import IconField
-from wbcore.signals import post_clone
+from wbcore.signals import post_clone, pre_merge
+from wbcore.signals.merge import post_merge
 from wbcore.utils.enum import ChoiceEnum
+from wbcore.workers import Queue
 
 
 def get_and_update_or_create(model, filter_params, defaults):
@@ -153,8 +157,12 @@ class PrimaryMixin(models.Model):
         if self.can_update_primary_field:
             related_qs = self.get_related_queryset()
             if self.primary:
-                related_qs = related_qs.exclude(id=self.id)  # if self id is None, it will not exclude anything
-                related_qs.update(primary=False)
+                related_qs = related_qs.exclude(id=self.id).filter(
+                    primary=True
+                )  # if self id is None, it will not exclude anything
+                if related_qs.exists():
+                    self.previous_primary_entity = related_qs.first()
+                    related_qs.update(primary=False)
             elif not related_qs.filter(primary=True).exists():
                 self.primary = True
         super().save(*args, **kwargs)
@@ -291,3 +299,64 @@ class CloneMixin(models.Model):
 
     class Meta:
         abstract = True
+
+
+class MergeError(ValueError):
+    pass
+
+
+class MergeMixin(models.Model):
+    """
+    Abstract Django model mixin that provides a standardized interface for merging
+    two model instances of the same type, typically used to consolidate duplicate
+    records (e.g., merging two Instruments, Clients, or Accounts).
+    """
+
+    @property
+    def is_mergeable(self) -> bool:
+        return True
+
+    def get_merge_senders_kwargs(self, merged_object):
+        # Default implementation: return tuple of (sender, main, merged) for signal dispatch.
+        # Subclasses can override to yield multiple entries if related models require updates.
+        # ideal for multi-inheritance
+        yield (self.__class__, merged_object, self)
+
+    def _merge(self, merged_object, **kwargs):
+        # Must be implemented by subclasses. It should define the data
+        # or relationship consolidation logic between self and merged_object.
+        # Example: transfer related foreign key references, update counters, etc.
+        raise NotImplementedError()
+
+    def merge(self, merged_object, dispatch: bool = True, **kwargs):
+        with transaction.atomic():  # We want this to either succeed fully or fail
+            if dispatch:
+                for sender, casted_merged_object, casted_main_object in self.get_merge_senders_kwargs(merged_object):
+                    pre_merge.send(
+                        sender=sender, merged_object=casted_merged_object, main_object=casted_main_object
+                    )  # default signal dispatch for the Instrument class
+                # We refresh the reference in case the underlying signal receivers modify these objects
+                self.refresh_from_db()
+                merged_object.refresh_from_db()
+            self._merge(merged_object, **kwargs)
+            # We delete finally the merged object. All unlikage should have been done in the signal receivers function
+            if isinstance(merged_object, DeleteToDisableMixin):
+                merged_object.delete(no_deletion=False)
+            else:
+                merged_object.delete()
+
+            self.save()
+            post_merge.send(sender=self.__class__, merged_object=merged_object, main_object=self)
+
+    class Meta:
+        abstract = True
+
+
+@shared_task(queue=Queue.DEFAULT.value)
+def merge_as_task(content_type_id: int, main_object_id: int, merged_object_id: int):
+    content_type = ContentType.objects.get(id=content_type_id)
+    with suppress(content_type.model_class().DoesNotExist):
+        main_object = content_type.get_object_for_this_type(id=main_object_id)
+        merged_object = content_type.get_object_for_this_type(id=merged_object_id)
+        if hasattr(main_object, "merge") and callable(main_object.merge):
+            main_object.merge(merged_object)

wbcore/utils/views.py

@@ -1,5 +1,6 @@
 import importlib
 import re
+from contextlib import suppress
 from functools import cached_property
 
 from django.conf import settings
@@ -23,8 +24,9 @@ from wbcore.metadata.configs.display.instance_display import Display
 from wbcore.metadata.configs.display.instance_display.shortcuts import (
     create_simple_display,
 )
-from wbcore.models.base import merge_as_task
 from wbcore.signals.instance_buttons import add_extra_button
+from wbcore.utils.models import MergeMixin as ModelMergeMixin
+from wbcore.utils.models import merge_as_task
 
 
 def parse_query_parameters_list(list_str):
@@ -134,13 +136,8 @@ class MergeMixin:
     def model(self):
         return self.queryset.model
 
-    @cached_property
-    def has_user_merge_permission(self) -> bool:
-        return getattr(self, "MERGE_PERMISSION", f"administrate_{self.model._meta.model_name}")
-
-    @cached_property
-    def can_merge(self):
-        return hasattr(self.queryset.model, "merge") and self.has_user_merge_permission
+    def has_merge_permission(self, user) -> bool:
+        return user.has_perm(f"administrate_{self.model._meta.model_name}")
 
     def get_merged_object_representation_serializer(self):
         """
@@ -157,51 +154,55 @@ class MergeMixin:
         """
         return dict()
 
-    @action(methods=["PATCH"], detail=True)
-    def merge(self, request, pk=None):
-        instance = get_object_or_404(self.queryset.model, pk=pk)
-        merged_instance = get_object_or_404(self.queryset.model, pk=request.POST.get("merged_object", None))
-        try:
-            content_type = ContentType.objects.get_for_model(self.model)
-        except ContentType.DoesNotExist:
-            content_type = None
-        if content_type and self.has_user_merge_permission and hasattr(instance, "merge"):
-            merge_as_task.delay(content_type.id, instance.id, merged_instance.id)
-            return Response({"status": "Merged with success"})
-        return Response({}, status=400)
-
+    def add_extra_buttons(self, request):
+        if self.has_merge_permission(request.user) and (pk := self.kwargs.get("pk")):
+            object = self.get_object()
+            if (
+                isinstance(object, ModelMergeMixin)
+                and object.is_mergeable
+                and (endpoint_basename := object.get_endpoint_basename())
+            ):
+                endpoint = reverse(f"{endpoint_basename}-merge", args=[pk], request=request)
 
-@receiver(add_extra_button)
-def add_merge_extra_button(sender, instance, request, view, pk=None, **kwargs):
-    if instance and pk and issubclass(view.__class__, CloneMixin) and getattr(view, "can_merge", False):
-        object = view.get_object()
-        if getattr(object, "is_mergeable", True) and (endpoint_basename := object.get_endpoint_basename()):
-            endpoint = reverse(f"{endpoint_basename}-merge", args=[pk], request=request)
-            identifier = getattr(view, "IDENTIFIER", "{0.app_label}:{0.model}".format(view.get_content_type()))
+                class MergeSerializer(wb_serializer.ModelSerializer):
+                    merged_object = wb_serializer.PrimaryKeyRelatedField(
+                        queryset=self.model.objects.all(), label="Merged with"
+                    )
+                    _merged_object = self.get_merged_object_representation_serializer()(
+                        source="merged_object",
+                        filter_params=self.get_merged_object_representation_serializer_filter_params(),
+                    )
 
-            class MergeSerializer(wb_serializer.ModelSerializer):
-                merged_object = wb_serializer.PrimaryKeyRelatedField(queryset=view.model.objects.all())
-                _merged_object = view.get_merged_object_representation_serializer()(
-                    source="merged_object",
-                    filter_params=view.get_merged_object_representation_serializer_filter_params(),
-                )
-
-                class Meta:
-                    model = view.model
-                    fields = [
-                        "id",
-                        "merged_object",
-                        "_merged_object",
-                    ]
+                    class Meta:
+                        model = self.model
+                        fields = [
+                            "id",
+                            "merged_object",
+                            "_merged_object",
+                        ]
+
+                return {
+                    bt.ActionButton(
+                        method=RequestType.PATCH,
+                        endpoint=endpoint,
+                        action_label=_("Merge"),
+                        title=_("Merge"),
+                        label=_("Merge"),
+                        icon=WBIcon.MERGE.icon,
+                        serializer=MergeSerializer,
+                        instance_display=create_simple_display([["merged_object"]]),
+                    ),
+                }
 
-            return bt.ActionButton(
-                method=RequestType.PATCH,
-                identifiers=(identifier,),
-                endpoint=endpoint,
-                action_label=_("Merge"),
-                title=_("Merge"),
-                label=_("Merge"),
-                icon=WBIcon.MERGE.icon,
-                serializer=MergeSerializer,
-                instance_display=create_simple_display([["merged_object"]]),
-            )
+    @action(methods=["PATCH"], detail=True)
+    def merge(self, request, pk=None):
+        if self.has_merge_permission(request.user):
+            if pk and hasattr(self.model, "merge"):
+                instance = get_object_or_404(self.queryset.model, pk=pk)
+                merged_instance = get_object_or_404(self.queryset.model, pk=request.POST.get("merged_object", None))
+                with suppress(ContentType.DoesNotExist):
+                    content_type = ContentType.objects.get_for_model(self.model)
+                    merge_as_task.delay(content_type.id, instance.id, merged_instance.id)
+                    return Response({"status": "Merged ongoing"})
+            return Response({}, status=400)
+        return Response({"_detail": "User does not have the permission to merge"}, status=status.HTTP_403_FORBIDDEN)

wbcore/viewsets/mixins.py

@@ -265,7 +265,7 @@ class OrderableMixin:
         order = request.data.get("order")
         if order is None:
             return Response("No order received", status=HTTP_400_BAD_REQUEST)
-        instance.to(order)
+        instance.to(int(order))
         return Response("Reordering Successful", status=HTTP_200_OK)
 
 

wbcore/viewsets/viewsets.py

@@ -60,7 +60,7 @@ class ReadOnlyModelViewSet(
     GenericViewSet,
 ):
     pagination_class = LimitOffsetPagination
-    READ_ONLY = True
+    ONLY_READ_ONLY_ENDPOINT = True
 
 
 class ModelViewSet(

{wbcore-1.59.15.dist-info → wbcore-1.60.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbcore
-Version: 1.59.15
+Version: 1.60.0
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: celery[redis]==5.*
 Requires-Dist: croniter==2.*