neuroglia-python 0.0.23__tar.gz → 0.1.1__tar.gz

neuroglia_python-0.1.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: neuroglia-python
+Version: 0.1.1
+Summary: Port from .NET to Python of the Neuroglia Framework
+License: Apache
+Author: Charles d'Avernas
+Author-email: charles.davernas@neuroglia.io
+Requires-Python: >=3.12,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: annotated-types (>=0.6.0,<0.7.0)
+Requires-Dist: classy-fastapi (>=0.6.1,<0.7.0)
+Requires-Dist: esdbclient (>=1.0.17,<2.0.0)
+Requires-Dist: fastapi (>=0.109.2,<0.110.0)
+Requires-Dist: grpcio (>=1.60.1,<2.0.0)
+Requires-Dist: httpx (>=0.26.0,<0.27.0)
+Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
+Requires-Dist: mkdocs-material (>=9.5.46,<10.0.0)
+Requires-Dist: multipledispatch (>=1.0.0,<2.0.0)
+Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
+Requires-Dist: pymongo (>=4.6.1,<5.0.0)
+Requires-Dist: pytest (>=8.1.1,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: rx (>=3.2.0,<4.0.0)
+Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
+Requires-Dist: uvicorn (>=0.27.1,<0.28.0)
+Description-Content-Type: text/markdown
+
+# Neuroglia Python Framework
+
+A framework of libraries used to build modern Python V3 applications
+
+## Disclaimer
+
+This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
+
+## Packaging
+
+```sh
+# Set the version tag in pyproject.toml
+# Commit changes
+
+poetry build
+
+poetry publish --repository gitlab -u <token-username> -p <token-password>
+
+```
+

neuroglia_python-0.1.1/README.md

@@ -0,0 +1,19 @@
+# Neuroglia Python Framework
+
+A framework of libraries used to build modern Python V3 applications
+
+## Disclaimer
+
+This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
+
+## Packaging
+
+```sh
+# Set the version tag in pyproject.toml
+# Commit changes
+
+poetry build
+
+poetry publish --repository gitlab -u <token-username> -p <token-password>
+
+```

{neuroglia_python-0.0.23 → neuroglia_python-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "neuroglia-python"
-version = "0.0.23"
+version = "0.1.1"
 description = "Port from .NET to Python of the Neuroglia Framework"
 authors = ["Charles d'Avernas <charles.davernas@neuroglia.io>"]
 license = "Apache"
@@ -25,6 +25,8 @@ rx = "^3.2.0"
 uvicorn = "^0.27.1"
 typing-extensions = "^4.9.0"
 pytest = "^8.1.1"
+mkdocs = "^1.6.1"
+mkdocs-material = "^9.5.46"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.1"

{neuroglia_python-0.0.23 → neuroglia_python-0.1.1}/src/neuroglia/data/infrastructure/event_sourcing/abstractions.py

@@ -2,7 +2,7 @@ from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
-from typing import Any, List, Optional, Type
+from typing import Any, Callable, List, Optional, Type
 from neuroglia.data.abstractions import AggregateRoot
 
 
@@ -69,6 +69,23 @@ class EventRecord:
     ''' Gets a boolean indicating whether or not the recorded event is being replayed to its consumer/consumer group '''
 
 
+@dataclass
+class AckableEventRecord(EventRecord):
+    ''' Represents an ackable recorded event '''
+    
+    _ack_delegate : Callable = None
+
+    _nack_delegate : Callable= None
+
+    async def ack_async(self) -> None:
+        ''' Acks the event record '''
+        self._ack_delegate()
+
+    async def nack_async(self) -> None:
+        ''' Nacks the event record'''
+        self._nack_delegate()
+        
+
 class StreamReadDirection(Enum):
     ''' Enumerates all directions in which a event sourcing stream can be read '''
     FORWARDS = 0,
@@ -82,6 +99,9 @@ class EventStoreOptions:
 
     database_name: str
     ''' Gets/sets the name of the database to use, if any '''
+    
+    consumer_group: str
+    ''' Gets/sets the name of the consumer group to use, if any '''
 
 
 class EventStore(ABC):

{neuroglia_python-0.0.23 → neuroglia_python-0.1.1}/src/neuroglia/data/infrastructure/event_sourcing/event_store/event_store.py

@@ -3,10 +3,11 @@ import logging
 import sys
 import threading
 from typing import Dict, List, Optional
+from esdbclient.persistent import PersistentSubscription
 import rx
 from rx.disposable.disposable import Disposable
 from neuroglia.data.abstractions import DomainEvent
-from neuroglia.data.infrastructure.event_sourcing.abstractions import Aggregator, EventDescriptor, EventRecord, EventStore, EventStoreOptions, StreamDescriptor, StreamReadDirection
+from neuroglia.data.infrastructure.event_sourcing.abstractions import AckableEventRecord, Aggregator, EventDescriptor, EventRecord, EventStore, EventStoreOptions, StreamDescriptor, StreamReadDirection
 from neuroglia.hosting.abstractions import ApplicationBuilderBase
 from neuroglia.serialization.json import JsonSerializer
 from esdbclient import EventStoreDBClient, NewEvent, StreamState, RecordedEvent
@@ -98,8 +99,14 @@ class ESEventStore(EventStore):
         else:
             try:
                 self._eventstore_client.create_subscription_to_stream(stream_name=stream_name, resolve_links=True)  # todo: persistence
+                # self._eventstore_client.create_subscription_to_stream(group_name = consumer_group, stream_name = stream_name, resolve_links = True, consumer_strategy = 'RoundRobin', min_checkpoint_count=1, max_checkpoint_count=1)
             except AlreadyExists:
                 pass
+          # subscription = self._eventstore_client.read_subscription_to_stream(group_name = consumer_group, stream_name = stream_name)
+
+            try : self._eventstore_client.create_subscription_to_stream(group_name = consumer_group, stream_name = stream_name, resolve_links = True, consumer_strategy = 'RoundRobin', min_checkpoint_count=1, max_checkpoint_count=1)
+            except AlreadyExists: pass
+
         subject = Subject()
         thread = threading.Thread(target=self._consume_events_async, kwargs={'stream_id': stream_id, 'subject': subject, 'subscription': subscription})
         thread.start()
@@ -144,7 +151,7 @@ class ESEventStore(EventStore):
             e: RecordedEvent
             for e in subscription:
                 try:
-                    decoded_event = self._decode_recorded_event(stream_id, e)
+                    decoded_event = self._decode_recorded_event(stream_id, e, subscription)
                 except Exception as ex:
                     logging.error(f"An exception occured while decoding event with offset '{e.stream_position}' from stream '{e.stream_name}': {ex}")
                     raise

{neuroglia_python-0.0.23 → neuroglia_python-0.1.1}/src/neuroglia/data/infrastructure/event_sourcing/read_model_reconciliator.py

@@ -2,7 +2,7 @@ import asyncio
 from dataclasses import dataclass
 import logging
 from rx.core.typing import Disposable
-from neuroglia.data.infrastructure.event_sourcing.abstractions import EventRecord, EventStore, EventStoreOptions
+from neuroglia.data.infrastructure.event_sourcing.abstractions import AckableEventRecord, EventRecord, EventStore, EventStoreOptions
 from neuroglia.dependency_injection.service_provider import ServiceProviderBase
 from neuroglia.hosting.abstractions import HostedService
 from neuroglia.mediation.mediator import Mediator
@@ -46,7 +46,7 @@ class ReadModelReconciliator(HostedService):
         self._subscription.dispose()
 
     async def subscribe_async(self):
-        observable = await self._event_store.observe_async(f'$ce-{self._event_store_options.database_name}')
+        observable = await self._event_store.observe_async(f'$ce-{self._event_store_options.database_name}', self._event_store_options.consumer_group)
         self._subscription = AsyncRx.subscribe(observable, lambda e: asyncio.run(self.on_event_record_stream_next_async(e)))
 
     async def on_event_record_stream_next_async(self, e: EventRecord):

{neuroglia_python-0.0.23 → neuroglia_python-0.1.1}/src/neuroglia/eventing/cloud_events/cloud_event.py

@@ -1,6 +1,6 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from datetime import datetime
-from typing import Any, Optional
+from typing import Any, Dict, Optional
 
 
 class CloudEventSpecVersion:
@@ -26,7 +26,7 @@ class CloudEvent:
         dataschema (Optional[str]): An URI that references the versioned schema of the event's data.
         data (Optional[Any]): The event's data, if any. Only used if the event has been formatted using the structured mode.
         data_base64 (Optional[str]): The event's binary data, encoded in base 64. Used if the event has been formatted using the binary mode.
-        extensionAttributes (Optional[Dict[str, Any]]): A mapping containing the event's extension attributes.
+        **extensions: Keyword arguments representing extension attributes.
     '''
 
     id: str
@@ -65,8 +65,31 @@ class CloudEvent:
     data_base64: Optional[str] = None
     ''' Gets/sets the event's binary data, encoded in base 64. Used if the event has been formatted using the binary mode. '''
 
+    extensions: Dict[str, Any] = field(default_factory=dict)  # Store extensions in a dict
+    ''' Gets/sets a mapping containing the event's extension attributes. '''
+
+    def __post_init__(self, *args, **kwargs):
+        # Capture any additional keyword arguments as extension attributes
+        for key, value in kwargs.items():
+            # only add them if they are not already defined fields
+            if key not in self.__dataclass_fields__:
+                self.extensions[key] = value
+
+    def __getattr__(self, name):
+        # Allow access to extensions as attributes
+        if name in self.extensions:
+            return self.extensions[name]
+        raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")
+
+    def __setattr__(self, name, value):
+        # Allow setting of extensions as attributes if it is an extension or not a predefined field.
+        if name in self.extensions or name not in self.__dataclass_fields__:
+            self.extensions[name] = value
+        else:
+            super().__setattr__(name, value)  # Use default setting for standard attributes
+
     def get_attribute(self, name: str) -> Optional[Any]:
         ''' Gets the value of the attribute with the specified name, if any '''
         if not name:
             raise ValueError("Attribute name cannot be empty or None.")
-        self.__dict__[name] if name in self.__dict__.keys() else None
+        return getattr(self, name, None)  # Use getattr to check both standard and extension attributes

neuroglia_python-0.0.23/PKG-INFO

@@ -1,127 +0,0 @@
-Metadata-Version: 2.1
-Name: neuroglia-python
-Version: 0.0.23
-Summary: Port from .NET to Python of the Neuroglia Framework
-License: Apache
-Author: Charles d'Avernas
-Author-email: charles.davernas@neuroglia.io
-Requires-Python: >=3.12,<4.0
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: annotated-types (>=0.6.0,<0.7.0)
-Requires-Dist: classy-fastapi (>=0.6.1,<0.7.0)
-Requires-Dist: esdbclient (>=1.0.17,<2.0.0)
-Requires-Dist: fastapi (>=0.109.2,<0.110.0)
-Requires-Dist: grpcio (>=1.60.1,<2.0.0)
-Requires-Dist: httpx (>=0.26.0,<0.27.0)
-Requires-Dist: multipledispatch (>=1.0.0,<2.0.0)
-Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
-Requires-Dist: pymongo (>=4.6.1,<5.0.0)
-Requires-Dist: pytest (>=8.1.1,<9.0.0)
-Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
-Requires-Dist: rx (>=3.2.0,<4.0.0)
-Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Requires-Dist: uvicorn (>=0.27.1,<0.28.0)
-Description-Content-Type: text/markdown
-
-# Neuroglia Python Framework
-
-A framework of libraries used to build modern Python V3 applications
-
-## Disclaimer
-
-This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
-
-## Packaging
-
-```sh
-# Set the version tag in pyproject.toml
-# Commit changes
-
-poetry build
-
-poetry publish --repository gitlab -u <token-username> -p <token-password>
-
-```
-
----
-
-_DRAFT_
-
-## Developer Guide Structure
-
-### Introduction
-
-Briefly describe your framework, its purpose, and its target audience.
-Highlight key features and benefits.
-
-#### Installation:
-
-Provide clear and step-by-step instructions on how to install your framework, including:
-Prerequisites (e.g., Python version, dependencies)
-Installation methods (e.g., pip install <framework_name>, source code compilation)
-Virtual environment recommendations (for isolation and dependency management)
-
-#### Getting Started:
-
-Offer a simple "Hello, World!" or similar example to demonstrate basic usage and familiarize users with your framework's syntax and structure.
-Include code snippets and explanations where necessary.
-
-#### Core Concepts:
-
-Dedicate this section to in-depth explanations of the fundamental building blocks and functionalities of your framework. This might include:
-Key objects and classes within the framework
-Data structures and design patterns employed
-Architectural overview (e.g., MVC, MVVM) if applicable
-
-#### Tutorials and Examples:
-
-Provide a collection of well-structured, step-by-step tutorials that showcase how to accomplish common tasks using your framework.
-Consider varying the difficulty levels (beginner, intermediate, advanced) to cater to a wide range of users.
-Include code examples, explanations, and screenshots as needed.
-
-#### API Reference:
-
-Create a comprehensive reference for all available classes, functions, and modules within your framework.
-Use a consistent format that includes the following information for each API element:
-Name
-Description
-Arguments (with data types and descriptions)
-Return values (with data types and descriptions)
-Usage examples
-
-#### Testing and Debugging:
-
-Explain how to effectively test code written using your framework.
-Recommend testing frameworks and tools.
-Provide practical guidance on common debugging techniques and strategies.
-
-#### Contributing:
-
-Outline how developers can contribute to your framework's development.
-Include information on:
-Issue tracking system (e.g., GitHub issues)
-Pull request guidelines
-Coding style and conventions
-Testing requirements
-
-#### Community and Support:
-
-Specify available resources for users to seek help and engage with the community. This could include:
-Official channels (e.g., discussion forums, mailing lists)
-Third-party resources (e.g., Stack Overflow tags, community blogs)
-
-#### License:
-
-Clearly state the license under which your framework is distributed.
-
-#### Additional Tips:
-
-Maintain a clear and concise writing style, using easy-to-understand language.
-Ensure proper formatting and structure for readability.
-Provide code snippets in a visually appealing format, using code blocks and syntax highlighting.
-Consider adding screenshots or diagrams to illustrate complex concepts.
-Regularly update the guide with new features, bug fixes, and best practices.
-

neuroglia_python-0.0.23/README.md

@@ -1,98 +0,0 @@
-# Neuroglia Python Framework
-
-A framework of libraries used to build modern Python V3 applications
-
-## Disclaimer
-
-This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
-
-## Packaging
-
-```sh
-# Set the version tag in pyproject.toml
-# Commit changes
-
-poetry build
-
-poetry publish --repository gitlab -u <token-username> -p <token-password>
-
-```
-
----
-
-_DRAFT_
-
-## Developer Guide Structure
-
-### Introduction
-
-Briefly describe your framework, its purpose, and its target audience.
-Highlight key features and benefits.
-
-#### Installation:
-
-Provide clear and step-by-step instructions on how to install your framework, including:
-Prerequisites (e.g., Python version, dependencies)
-Installation methods (e.g., pip install <framework_name>, source code compilation)
-Virtual environment recommendations (for isolation and dependency management)
-
-#### Getting Started:
-
-Offer a simple "Hello, World!" or similar example to demonstrate basic usage and familiarize users with your framework's syntax and structure.
-Include code snippets and explanations where necessary.
-
-#### Core Concepts:
-
-Dedicate this section to in-depth explanations of the fundamental building blocks and functionalities of your framework. This might include:
-Key objects and classes within the framework
-Data structures and design patterns employed
-Architectural overview (e.g., MVC, MVVM) if applicable
-
-#### Tutorials and Examples:
-
-Provide a collection of well-structured, step-by-step tutorials that showcase how to accomplish common tasks using your framework.
-Consider varying the difficulty levels (beginner, intermediate, advanced) to cater to a wide range of users.
-Include code examples, explanations, and screenshots as needed.
-
-#### API Reference:
-
-Create a comprehensive reference for all available classes, functions, and modules within your framework.
-Use a consistent format that includes the following information for each API element:
-Name
-Description
-Arguments (with data types and descriptions)
-Return values (with data types and descriptions)
-Usage examples
-
-#### Testing and Debugging:
-
-Explain how to effectively test code written using your framework.
-Recommend testing frameworks and tools.
-Provide practical guidance on common debugging techniques and strategies.
-
-#### Contributing:
-
-Outline how developers can contribute to your framework's development.
-Include information on:
-Issue tracking system (e.g., GitHub issues)
-Pull request guidelines
-Coding style and conventions
-Testing requirements
-
-#### Community and Support:
-
-Specify available resources for users to seek help and engage with the community. This could include:
-Official channels (e.g., discussion forums, mailing lists)
-Third-party resources (e.g., Stack Overflow tags, community blogs)
-
-#### License:
-
-Clearly state the license under which your framework is distributed.
-
-#### Additional Tips:
-
-Maintain a clear and concise writing style, using easy-to-understand language.
-Ensure proper formatting and structure for readability.
-Provide code snippets in a visually appealing format, using code blocks and syntax highlighting.
-Consider adding screenshots or diagrams to illustrate complex concepts.
-Regularly update the guide with new features, bug fixes, and best practices.