GeneralManager 0.5.1__py3-none-any.whl → 0.6.0__py3-none-any.whl

general_manager/interface/readOnlyInterface.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+import json
+
+from typing import Type, Any, Callable, TYPE_CHECKING
+from django.db import models, transaction
+from general_manager.interface.databaseBasedInterface import (
+    DBBasedInterface,
+    GeneralManagerModel,
+    classPreCreationMethod,
+    classPostCreationMethod,
+)
+
+if TYPE_CHECKING:
+    from general_manager.manager.generalManager import GeneralManager
+    from general_manager.manager.meta import GeneralManagerMeta
+
+
+class ReadOnlyInterface(DBBasedInterface):
+    _interface_type = "readonly"
+
+    @classmethod
+    def sync_data(cls) -> None:
+        """
+        Synchronizes the database model with JSON data, ensuring exact correspondence.
+
+        This method parses JSON data from the parent class and updates the associated Django model so that its records exactly match the JSON content. It creates or updates instances based on unique fields and deletes any database entries not present in the JSON data. Raises a ValueError if required attributes are missing or if the JSON data is invalid.
+        """
+        model: Type[models.Model] | None = getattr(cls, "_model", None)
+        parent_class = getattr(cls, "_parent_class", None)
+        if model is None or parent_class is None:
+            raise ValueError("Attribute '_model' and '_parent_class' must be set.")
+        json_data = getattr(parent_class, "_json_data", None)
+        if not json_data:
+            raise ValueError(
+                f"For ReadOnlyInterface '{parent_class.__name__}' must be set '_json_data'"
+            )
+
+        # JSON-Daten parsen
+        if isinstance(json_data, str):
+            data_list = json.loads(json_data)
+        elif isinstance(json_data, list):
+            data_list: list[Any] = json_data
+        else:
+            raise ValueError(
+                "_json_data must be a JSON string or a list of dictionaries"
+            )
+
+        unique_fields = getattr(parent_class, "_unique_fields", [])
+        if not unique_fields:
+            raise ValueError(
+                f"For ReadOnlyInterface '{parent_class.__name__}' must be defined '_unique_fields'"
+            )
+
+        with transaction.atomic():
+            json_unique_values: set[Any] = set()
+
+            # Daten synchronisieren
+            for data in data_list:
+                lookup = {field: data[field] for field in unique_fields}
+                unique_identifier = tuple(lookup[field] for field in unique_fields)
+                json_unique_values.add(unique_identifier)
+
+                instance, _ = model.objects.get_or_create(**lookup)
+                updated = False
+                for field_name, value in data.items():
+                    if getattr(instance, field_name, None) != value:
+                        setattr(instance, field_name, value)
+                        updated = True
+                if updated:
+                    instance.save()
+
+            # Existierende Einträge abrufen und löschen, wenn nicht im JSON vorhanden
+            existing_instances = model.objects.all()
+            for instance in existing_instances:
+                lookup = {field: getattr(instance, field) for field in unique_fields}
+                unique_identifier = tuple(lookup[field] for field in unique_fields)
+                if unique_identifier not in json_unique_values:
+                    instance.delete()
+
+    @staticmethod
+    def readOnlyPostCreate(func: Callable[..., Any]) -> Callable[..., Any]:
+        """
+        Decorator for post-creation hooks that registers the interface class as read-only.
+
+        Wraps a function to be called after a class creation event, then appends the interface
+        class to the meta-class's `read_only_classes` list.
+        """
+
+        def wrapper(
+            mcs: Type[GeneralManagerMeta],
+            new_class: Type[GeneralManager],
+            interface_cls: Type[ReadOnlyInterface],
+            model: Type[GeneralManagerModel],
+        ):
+            func(mcs, new_class, interface_cls, model)
+            mcs.read_only_classes.append(interface_cls)
+
+        return wrapper
+
+    @classmethod
+    def handleInterface(cls) -> tuple[classPreCreationMethod, classPostCreationMethod]:
+        """
+        Returns pre- and post-creation methods for integrating the interface with a GeneralManager.
+
+        The pre-creation method modifies keyword arguments before a GeneralManager instance is created. The post-creation method, wrapped with a decorator, modifies the instance after creation to add additional data. These methods are intended for use by the GeneralManagerMeta class during the manager's lifecycle.
+        """
+        return cls._preCreate, cls.readOnlyPostCreate(cls._postCreate)

general_manager/manager/generalManager.py

@@ -1,17 +1,18 @@
 from __future__ import annotations
-from typing import Generic, Type, Any, TYPE_CHECKING
+from typing import Generic, Type, Any, TYPE_CHECKING, TypeVar
 from general_manager.manager.meta import GeneralManagerMeta
-from general_manager.interface.baseInterface import (
-    InterfaceBase,
-    Bucket,
-    GeneralManagerType,
-)
+
 from general_manager.api.property import GraphQLProperty
 from general_manager.cache.cacheTracker import DependencyTracker
 from general_manager.cache.signals import dataChange
+from general_manager.bucket.baseBucket import Bucket
 
 if TYPE_CHECKING:
     from general_manager.permission.basePermission import BasePermission
+    from general_manager.interface.baseInterface import (
+        InterfaceBase,
+    )
+GeneralManagerType = TypeVar("GeneralManagerType", bound="GeneralManager")
 
 
 class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
@@ -129,15 +130,15 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
     @staticmethod
     def __parse_identification(kwargs: dict[str, Any]) -> dict[str, Any] | None:
         """
-        Converts a dictionary of keyword arguments by replacing any GeneralManager instances with their identifications.
+        Processes a dictionary by replacing GeneralManager instances with their identifications.
         
-        For each key-value pair, if the value is a GeneralManager, it is replaced with its identification. Lists and tuples are processed recursively, replacing contained GeneralManager instances with their identifications. Returns a new dictionary with the processed values, or None if the result is empty.
+        For each key-value pair, replaces any GeneralManager instance with its identification. Lists and tuples are processed recursively, substituting contained GeneralManager instances with their identifications. Returns None if the resulting dictionary is empty.
         
         Args:
-            kwargs: Dictionary of keyword arguments to process.
+            kwargs: Dictionary to process.
         
         Returns:
-            A new dictionary with GeneralManager instances replaced by their identifications, or None if the dictionary is empty.
+            A new dictionary with GeneralManager instances replaced by their identifications, or None if empty.
         """
         output = {}
         for key, value in kwargs.items():

general_manager/manager/groupManager.py

@@ -1,204 +1,21 @@
 from __future__ import annotations
 from typing import (
     Type,
-    Generator,
     Any,
     Generic,
     get_args,
     cast,
 )
-import json
 from datetime import datetime, date, time
 from general_manager.api.graphql import GraphQLProperty
 from general_manager.measurement import Measurement
 from general_manager.manager.generalManager import GeneralManager
-from general_manager.interface.baseInterface import (
+from general_manager.bucket.baseBucket import (
     Bucket,
     GeneralManagerType,
 )
 
 
-class GroupBucket(Bucket[GeneralManagerType]):
-
-    def __init__(
-        self,
-        manager_class: Type[GeneralManagerType],
-        group_by_keys: tuple[str, ...],
-        data: Bucket[GeneralManagerType],
-    ):
-        super().__init__(manager_class)
-        self.__checkGroupByArguments(group_by_keys)
-        self._group_by_keys = group_by_keys
-        self._data = self.__buildGroupedManager(data)
-        self._basis_data = data
-
-    def __eq__(self, other: object) -> bool:
-        if not isinstance(other, self.__class__):
-            return False
-        return (
-            self._data == other._data
-            and self._manager_class == other._manager_class
-            and self._group_by_keys == other._group_by_keys
-        )
-
-    def __checkGroupByArguments(self, group_by_keys: tuple[str, ...]) -> None:
-        """
-        This method checks if the given arguments are valid for the groupBy method.
-        It raises a TypeError if the arguments are not valid.
-        """
-        if not all(isinstance(arg, str) for arg in group_by_keys):
-            raise TypeError("groupBy() argument must be a string")
-        if not all(
-            arg in self._manager_class.Interface.getAttributes().keys()
-            for arg in group_by_keys
-        ):
-            raise TypeError(
-                f"groupBy() argument must be a valid attribute of {self._manager_class.__name__}"
-            )
-
-    def __buildGroupedManager(
-        self,
-        data: Bucket[GeneralManagerType],
-    ) -> list[GroupManager[GeneralManagerType]]:
-        """
-        This method builds the grouped manager.
-        It returns a GroupBucket with the grouped data.
-        """
-        group_by_values = set()
-        for entry in data:
-            group_by_value = {}
-            for arg in self._group_by_keys:
-                group_by_value[arg] = getattr(entry, arg)
-            group_by_values.add(json.dumps(group_by_value))
-
-        groups = []
-        for group_by_value in sorted(group_by_values):
-            group_by_value = json.loads(group_by_value)
-            grouped_manager_objects = data.filter(**group_by_value)
-            groups.append(
-                GroupManager(
-                    self._manager_class, group_by_value, grouped_manager_objects
-                )
-            )
-        return groups
-
-    def __or__(self, other: object) -> GroupBucket[GeneralManagerType]:
-        if not isinstance(other, self.__class__):
-            raise ValueError("Cannot combine different bucket types")
-        if self._manager_class != other._manager_class:
-            raise ValueError("Cannot combine different manager classes")
-        return GroupBucket(
-            self._manager_class,
-            self._group_by_keys,
-            self._basis_data | other._basis_data,
-        )
-
-    def __iter__(self) -> Generator[GroupManager[GeneralManagerType]]:
-        for grouped_manager in self._data:
-            yield grouped_manager
-
-    def filter(self, **kwargs: Any) -> GroupBucket[GeneralManagerType]:
-        new_basis_data = self._basis_data.filter(**kwargs)
-        return GroupBucket(
-            self._manager_class,
-            self._group_by_keys,
-            new_basis_data,
-        )
-
-    def exclude(self, **kwargs: Any) -> GroupBucket[GeneralManagerType]:
-        new_basis_data = self._basis_data.exclude(**kwargs)
-        return GroupBucket(
-            self._manager_class,
-            self._group_by_keys,
-            new_basis_data,
-        )
-
-    def first(self) -> GroupManager[GeneralManagerType] | None:
-        try:
-            return next(iter(self))
-        except StopIteration:
-            return None
-
-    def last(self) -> GroupManager[GeneralManagerType] | None:
-        items = list(self)
-        if items:
-            return items[-1]
-        return None
-
-    def count(self) -> int:
-        return sum(1 for _ in self)
-
-    def all(self) -> Bucket[GeneralManagerType]:
-        return self
-
-    def get(self, **kwargs: Any) -> GroupManager[GeneralManagerType]:
-        first_value = self.filter(**kwargs).first()
-        if first_value is None:
-            raise ValueError(
-                f"Cannot find {self._manager_class.__name__} with {kwargs}"
-            )
-        return first_value
-
-    def __getitem__(
-        self, item: int | slice
-    ) -> GroupManager[GeneralManagerType] | GroupBucket[GeneralManagerType]:
-        if isinstance(item, int):
-            return self._data[item]
-        elif isinstance(item, slice):
-            new_data = self._data[item]
-            new_base_data = None
-            for manager in new_data:
-                if new_base_data is None:
-                    new_base_data = manager._data
-                else:
-                    new_base_data = new_base_data | manager._data
-            if new_base_data is None:
-                raise ValueError("Cannot slice an empty GroupBucket")
-            return GroupBucket(self._manager_class, self._group_by_keys, new_base_data)
-        raise TypeError(f"Invalid argument type: {type(item)}. Expected int or slice.")
-
-    def __len__(self) -> int:
-        return self.count()
-
-    def __contains__(self, item: GeneralManagerType) -> bool:
-        return item in self._basis_data
-
-    def sort(
-        self,
-        key: tuple[str] | str,
-        reverse: bool = False,
-    ) -> Bucket[GeneralManagerType]:
-        if isinstance(key, str):
-            key = (key,)
-        if reverse:
-            sorted_data = sorted(
-                self._data,
-                key=lambda x: tuple(getattr(x, k) for k in key),
-                reverse=True,
-            )
-        else:
-            sorted_data = sorted(
-                self._data, key=lambda x: tuple(getattr(x, k) for k in key)
-            )
-
-        new_bucket = GroupBucket(
-            self._manager_class, self._group_by_keys, self._basis_data
-        )
-        new_bucket._data = sorted_data
-        return new_bucket
-
-    def group_by(self, *group_by_keys: str) -> GroupBucket[GeneralManagerType]:
-        """
-        This method groups the data by the given arguments.
-        It returns a GroupBucket with the grouped data.
-        """
-        return GroupBucket(
-            self._manager_class,
-            tuple([*self._group_by_keys, *group_by_keys]),
-            self._basis_data,
-        )
-
-
 class GroupManager(Generic[GeneralManagerType]):
     """
     This class is used to group the data of a GeneralManager.
@@ -216,13 +33,21 @@ class GroupManager(Generic[GeneralManagerType]):
         self._data = data
         self._grouped_data: dict[str, Any] = {}
 
+    def __hash__(self) -> int:
+        return hash(
+            (
+                self._manager_class,
+                tuple(self._group_by_value.items()),
+                frozenset(self._data),
+            )
+        )
+
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, self.__class__):
-            return False
         return (
-            self._data == other._data
+            isinstance(other, self.__class__)
             and self._manager_class == other._manager_class
             and self._group_by_value == other._group_by_value
+            and frozenset(self._data) == frozenset(other._data)
         )
 
     def __repr__(self) -> str:

general_manager/manager/meta.py

@@ -1,14 +1,14 @@
 from __future__ import annotations
-from general_manager.interface.baseInterface import (
-    InterfaceBase,
-)
+
 from django.conf import settings
 from typing import Any, Type, TYPE_CHECKING, Generic, TypeVar, Iterable
+from general_manager.interface.baseInterface import InterfaceBase
 
 if TYPE_CHECKING:
-    from general_manager.interface.databaseInterface import ReadOnlyInterface
+    from general_manager.interface.readOnlyInterface import ReadOnlyInterface
     from general_manager.manager.generalManager import GeneralManager
 
+
 GeneralManagerType = TypeVar("GeneralManagerType", bound="GeneralManager")
 
 
@@ -24,6 +24,20 @@ class GeneralManagerMeta(type):
     Interface: type[InterfaceBase]
 
     def __new__(mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]) -> type:
+
+        """
+        Creates a new class, handling interface integration and registration for the general manager framework.
+        
+        If an 'Interface' attribute is present in the class definition, validates and processes it using the interface's pre- and post-creation hooks, then registers the resulting class for attribute initialization and tracking. If the 'AUTOCREATE_GRAPHQL' setting is enabled, also registers the class for pending GraphQL interface creation.
+        
+        Args:
+            name: The name of the class being created.
+            bases: Base classes for the new class.
+            attrs: Attribute dictionary for the new class.
+        
+        Returns:
+            The newly created class, possibly augmented with interface and registration logic.
+        """
         def createNewGeneralManagerClass(
             mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]
         ) -> Type[GeneralManager]:
@@ -33,7 +47,7 @@ class GeneralManagerMeta(type):
             interface = attrs.pop("Interface")
             if not issubclass(interface, InterfaceBase):
                 raise TypeError(
-                    f"Interface must be a subclass of {InterfaceBase.__name__}"
+                    f"{interface.__name__} must be a subclass of InterfaceBase"
                 )
             preCreation, postCreation = interface.handleInterface()
             attrs, interface_cls, model = preCreation(name, attrs, interface)

general_manager/permission/basePermission.py

@@ -6,12 +6,10 @@ from general_manager.permission.permissionChecks import (
     permission_filter,
 )
 
+from django.contrib.auth.models import AnonymousUser, AbstractUser
+from general_manager.permission.permissionDataManager import PermissionDataManager
 
 if TYPE_CHECKING:
-    from django.contrib.auth.models import AbstractUser, AnonymousUser
-    from general_manager.permission.permissionDataManager import (
-        PermissionDataManager,
-    )
     from general_manager.manager.generalManager import GeneralManager
     from general_manager.manager.meta import GeneralManagerMeta
 
@@ -66,7 +64,7 @@ class BasePermission(ABC):
         request_user = cls.getUserWithId(request_user)
 
         errors = []
-        permission_data = PermissionDataManager[GeneralManager].forUpdate(
+        permission_data = PermissionDataManager.forUpdate(
             base_data=old_manager_instance, update_data=data
         )
         Permission = cls(permission_data, request_user)
@@ -90,7 +88,7 @@ class BasePermission(ABC):
         request_user = cls.getUserWithId(request_user)
 
         errors = []
-        permission_data = PermissionDataManager[GeneralManager](manager_instance)
+        permission_data = PermissionDataManager(manager_instance)
         Permission = cls(permission_data, request_user)
         for key in manager_instance.__dict__.keys():
             is_allowed = Permission.checkPermission("delete", key)

{generalmanager-0.5.1.dist-info → generalmanager-0.6.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.5.1
-Summary: Kurzbeschreibung deines Pakets
+Version: 0.6.0
+Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License-Expression: MIT
 Requires-Python: >=3.12
@@ -37,51 +37,51 @@ Dynamic: license-file
 
 # GeneralManager
 
-## Überblick
+## Overview
 
-Das GeneralManager-Modul ist ein leistungsstarkes und flexibles Framework, das speziell für die Verwaltung und Verarbeitung von Daten entwickelt wurde. Es bietet eine modulare Struktur, die es Entwicklern ermöglicht, komplexe Geschäftslogiken effizient zu implementieren und zu verwalten. Das Modul ist vollständig in Python geschrieben und nutzt Django als Backend-Framework.
+GeneralManager is a powerful and flexible framework designed for managing and processing data. It provides a modular structure that enables developers to implement complex business logic efficiently. The module is written entirely in Python and uses Django as the backend framework.
 
-## Hauptfunktionen
+## Key Features
 
-### 1. **Datenmanagement**
-- **Flexibilität**: Unterstützt die Verwaltung aller Arten von Daten, nicht nur Projekte und Derivate.
-- **Datenbank-Integration**: Nahtlose Integration mit dem Django ORM für Datenbankoperationen.
-- **Externe Schnittstellen**: Unterstützung für Schnittstellen zu anderen Programmen, wie z. B. Excel-Interfaces.
+### 1. **Data Management**
+- **Flexibility**: Supports managing all kinds of data, not just projects and derivatives.
+- **Database Integration**: Seamless integration with the Django ORM for database operations.
+- **External Interfaces**: Support for interfaces to other programs, such as Excel.
 
-### 2. **Datenmodellierung**
-- **Django-Modelle**: Die Datenstruktur basiert auf Django-Modellen, die durch benutzerdefinierte Felder wie `MeasurementField` erweitert werden.
-- **Regeln und Validierungen**: Definieren Sie Regeln für Datenvalidierungen, z. B. dass das Startdatum eines Projekts vor dem Enddatum liegen muss.
+### 2. **Data Modeling**
+- **Django Models**: The data structure is based on Django models, extended by custom fields like `MeasurementField`.
+- **Rules and Validations**: Define rules for data validation, e.g., ensuring that a project's start date is before its end date.
 
-### 3. **GraphQL-Integration**
-- Automatische Generierung von GraphQL-Schnittstellen für alle Modelle.
-- Unterstützung für benutzerdefinierte Abfragen und Mutationen.
+### 3. **GraphQL Integration**
+- Automatic generation of GraphQL interfaces for all models.
+- Support for custom queries and mutations.
 
-### 4. **Berechtigungssystem**
-- **ManagerBasedPermission**: Ein flexibles Berechtigungssystem, das auf Benutzerrollen und Attributen basiert.
-- Unterstützung für CRUD-Berechtigungen auf Attributebene.
+### 4. **Permission System**
+- **ManagerBasedPermission**: A flexible permission system based on user roles and attributes.
+- Attribute-level CRUD permissions.
 
 ### 5. **Interfaces**
-- **CalculationInterface**: Ermöglicht die Implementierung von Berechnungslogiken.
-- **DatabaseInterface**: Bietet eine standardisierte Schnittstelle für Datenbankoperationen.
-- **ReadOnlyInterface**: Für schreibgeschützte Datenzugriffe.
+- **CalculationInterface**: Allows the implementation of calculation logic.
+- **DatabaseInterface**: Provides a standardized interface for database operations.
+- **ReadOnlyInterface**: For read-only data access.
 
-### 6. **Datenverteilung und Berechnung**
-- **Volumenverteilung**: Automatische Berechnung und Verteilung von Volumen über mehrere Jahre.
-- **Kommerzielle Berechnungen**: Berechnung von Gesamtvolumen, Versandkosten und Einnahmen für Projekte.
+### 6. **Data Distribution and Calculations**
+- **Volume Distribution**: Automatically calculates and distributes volume over multiple years.
+- **Commercial Calculations**: Calculates total volume, shipping costs, and revenue for projects.
 
-## Anwendung
+## Usage
 
 ### Installation
 
-Installieren Sie das Modul über `pip`:
+Install the module via `pip`:
 
 ```bash
 pip install GeneralManager
 ```
 
-### Beispielcode
+### Example Code
 
-Hier ist ein Beispiel, wie Sie einen GeneralManager erstellen und Testdaten (in diesem Fall 10 Projekte) generieren können:
+The following example demonstrates how to create a GeneralManager and generate sample data (in this case 10 projects):
 
 ```python
 from general_manager import GeneralManager
@@ -134,11 +134,11 @@ class Project(GeneralManager):
 Project.Factory.createBatch(10)
 ```
 
-### GraphQL-Integration
+### GraphQL Integration
 
-Das Modul generiert automatisch GraphQL-Schnittstellen für alle Modelle. Sie können Abfragen und Mutationen über die GraphQL-URL ausführen, die in den Django-Einstellungen definiert ist.
+The module automatically generates GraphQL endpoints for all models. You can run queries and mutations through the GraphQL URL defined in your Django settings.
 
-Beispiel für eine GraphQL-Abfrage:
+Example of a GraphQL query:
 
 ```graphql
 query {
@@ -154,26 +154,26 @@ query {
 }
 ```
 
-## Vorteile
+## Benefits
 
-- **Modularität**: Einfach erweiterbar und anpassbar.
-- **Flexibilität**: Unterstützt komplexe Geschäftslogiken und Berechnungen.
-- **Integration**: Nahtlose Integration mit Django und GraphQL.
-- **Berechtigungen**: Fein abgestimmte Berechtigungen für Benutzer und Attribute.
-- **Datenvalidierung**: Automatische Validierung von Daten durch Regeln und Constraints.
-- **Caching**: Automatische Cache-Generierung mit @cached Decorator, um die Leistung zu verbessern.
+- **Modularity**: Easy to extend and adapt.
+- **Flexibility**: Supports complex business logic and calculations.
+- **Integration**: Seamless integration with Django and GraphQL.
+- **Permissions**: Fine-grained permissions for users and attributes.
+- **Data Validation**: Automatic validation of data through rules and constraints.
+- **Caching**: Automatic cache generation with the `@cached` decorator to improve performance.
 
-## Anforderungen
+## Requirements
 
 - Python >= 3.12
 - Django >= 5.2
-- Zusätzliche Abhängigkeiten (siehe `requirements.txt`):
+- Additional dependencies (see `requirements.txt`):
   - `graphene`
   - `numpy`
   - `Pint`
   - `factory_boy`
-  - uvm.
+  - and more.
 
-## Lizenz
+## License
 
-Dieses Projekt steht unter der **Non-Commercial MIT License**. Es darf nur für nicht-kommerzielle Zwecke verwendet werden. Weitere Details finden Sie in der [LICENSE](./LICENSE).
+This project is distributed under the **Non-Commercial MIT License**. It may only be used for non-commercial purposes. For further details see the [LICENSE](./LICENSE) file.