Merge pull request #7 from runemalm/feature/next-release

Release version v1.0.0-alpha.9

Author: runemalm

README.md

@@ -4,7 +4,7 @@
 
 # py-dependency-injection
 
-A prototypical dependency injection library for Python.
+A dependency injection library for Python.
 
 ## Features
 
@@ -83,46 +83,52 @@ You can find the source code for `py-dependency-injection` on [GitHub](https://g
 
 ## Release Notes
 
+### [1.0.0-alpha.9](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.9) (2024-08-08)
+
+- **Breaking Change**: Removed constructor injection when resolving dataclasses.
+- **Enhancement**: Added dependency container getter and setter for registrations. Also added new `RegistrationSerializer` class for for serializing and deserializing them. These additions provide a more flexible way to interact with the container's registrations.
+
 ### [1.0.0-alpha.8](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.8) (2024-06-07)
 
-- Bug Fix: Fixed an issue in the dependency resolution logic where registered constructor arguments were not properly merged with automatically injected dependencies. This ensures that constructor arguments specified during registration are correctly combined with dependencies resolved by the container.
+- **Bug Fix**: Fixed an issue in the dependency resolution logic where registered constructor arguments were not properly merged with automatically injected dependencies. This ensures that constructor arguments specified during registration are correctly combined with dependencies resolved by the container.
+- **Documentation Update**: The documentation structure has been updated for better organization and ease of understanding.
 
 ### [1.0.0-alpha.7](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.7) (2024-03-24)
 
-- Documentation Update: Updated the documentation to provide clearer instructions and more comprehensive examples.
-- Preparing for Beta Release: Made necessary adjustments and refinements in preparation for the upcoming first beta release.
+- **Documentation Update**: Updated the documentation to provide clearer instructions and more comprehensive examples.
+- **Preparing for Beta Release**: Made necessary adjustments and refinements in preparation for the upcoming first beta release.
 
 ### [1.0.0-alpha.6](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.6) (2024-03-23)
 
-- Factory Registration: Added support for registering dependencies using factory functions for dynamic instantiation.
-- Instance Registration: Enabled registering existing instances as dependencies.
-- Tag-based Registration and Resolution: Introduced the ability to register and resolve dependencies using tags for flexible dependency management.
+- **Factory Registration**: Added support for registering dependencies using factory functions for dynamic instantiation.
+- **Instance Registration**: Enabled registering existing instances as dependencies.
+- **Tag-based Registration and Resolution**: Introduced the ability to register and resolve dependencies using tags for flexible dependency management.
 
 ### [1.0.0-alpha.5](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.5) (2024-03-03)
 
 - **Critical Package Integrity Fix**: This release addresses a critical issue that affected the packaging of the Python library in all previous alpha releases (1.0.0-alpha.1 to 1.0.0-alpha.4). The problem involved missing source files in the distribution, rendering the library incomplete and non-functional. Users are strongly advised to upgrade to version 1.0.0-alpha.5 to ensure the correct functioning of the library. All previous alpha releases are affected by this issue.
 
 ### [1.0.0-alpha.4](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.4) (2024-03-02)
 
-- Constructor Arguments: Support for constructor arguments added to dependency registration.
+- **Constructor Arguments**: Support for constructor arguments added to dependency registration.
 
 ### [1.0.0-alpha.3](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.3) (2024-03-02)
 
 - **Breaking Change**: Starting from this version, the `@inject` decorator can only be used on static class methods and class methods. It can't be used on instance methods anymore.
-- Documentation Update: The documentation has been updated to reflect the new restriction on the usage of the decorator.
+- **Documentation Update**: The documentation has been updated to reflect the new restriction on the usage of the decorator.
 
 ### [1.0.0-alpha.2](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.2) (2024-02-27)
 
-- Python Version Support: Added support for Python versions 3.7, 3.9, 3.10, 3.11, and 3.12.
-- New Feature: Method Injection with Decorator: Introduced a new feature allowing method injection using the @inject decorator. Dependencies can now be injected into an instance method, providing more flexibility in managing dependencies within class instance methods.
-- New Feature: Multiple Containers: Enhanced the library to support multiple containers. Users can now create and manage multiple dependency containers, enabling better organization and separation of dependencies for different components or modules.
-- Documentation Update: Expanded and improved the documentation to include details about the newly added method injection feature and additional usage examples. Users can refer to the latest documentation at readthedocs for comprehensive guidance.
+- **Python Version Support**: Added support for Python versions 3.7, 3.9, 3.10, 3.11, and 3.12.
+- **New Feature**: Method Injection with Decorator: Introduced a new feature allowing method injection using the @inject decorator. Dependencies can now be injected into an instance method, providing more flexibility in managing dependencies within class instance methods.
+- **New Feature**: Multiple Containers: Enhanced the library to support multiple containers. Users can now create and manage multiple dependency containers, enabling better organization and separation of dependencies for different components or modules.
+- **Documentation Update**: Expanded and improved the documentation to include details about the newly added method injection feature and additional usage examples. Users can refer to the latest documentation at readthedocs for comprehensive guidance.
 
 ### [1.0.0-alpha.1](https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.1) (2024-02-25)
 
-- Initial alpha release.
-- Added Dependency Container: The library includes a dependency container for managing object dependencies.
-- Added Constructor Injection: Users can leverage constructor injection for cleaner and more modular code.
-- Added Dependency Scopes: Define and manage the lifecycle of dependencies with support for different scopes.
-- Basic Documentation: An initial set of documentation is provided, giving users an introduction to the library.
-- License: Released under the GPL 3 license.
+- **Initial alpha release**.
+- **Added Dependency Container**: The library includes a dependency container for managing object dependencies.
+- **Added Constructor Injection**: Users can leverage constructor injection for cleaner and more modular code.
+- **Added Dependency Scopes**: Define and manage the lifecycle of dependencies with support for different scopes.
+- **Basic Documentation**: An initial set of documentation is provided, giving users an introduction to the library.
+- **License**: Released under the GPL 3 license.

docs/conf.py

@@ -35,7 +35,7 @@
 version = "1.0"
 
 # The full version, including alpha/beta/rc tags
-release = "1.0.0-alpha.8"
+release = "1.0.0-alpha.9"
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -5,7 +5,7 @@
 py-dependency-injection
 =======================
 
-A prototypical dependency injection library for Python.
+A dependency injection library for Python.
 
 Purpose
 -------

docs/releases.rst

@@ -6,24 +6,32 @@
 Version History
 ###############
 
+**1.0.0-alpha.9 (2024-08-08)**
+
+- **Breaking Change**: Removed constructor injection when resolving dataclasses.
+- **Enhancement**: Added dependency container getter and setter for registrations. Also added new `RegistrationSerializer` class for for serializing and deserializing them. These additions provide a more flexible way to interact with the container's registrations.
+
+`View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.9>`_
+
 **1.0.0-alpha.8 (2024-06-07)**
 
 - **Bug Fix**: Fixed an issue in the dependency resolution logic where registered constructor arguments were not properly merged with automatically injected dependencies. This ensures that constructor arguments specified during registration are correctly combined with dependencies resolved by the container.
+- **Documentation Update**: The documentation structure has been updated for better organization and ease of understanding.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.8>`_
 
 **1.0.0-alpha.7 (2024-03-24)**
 
-- Documentation Update: Updated the documentation to provide clearer instructions and more comprehensive examples.
-- Preparing for Beta Release: Made necessary adjustments and refinements in preparation for the upcoming first beta release.
+- **Documentation Update**: Updated the documentation to provide clearer instructions and more comprehensive examples.
+- **Preparing for Beta Release**: Made necessary adjustments and refinements in preparation for the upcoming first beta release.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.7>`_
 
 **1.0.0-alpha.6 (2024-03-23)**
 
-- Factory Registration: Added support for registering dependencies using factory functions for dynamic instantiation.
-- Instance Registration: Enabled registering existing instances as dependencies.
-- Tag-based Registration and Resolution: Introduced the ability to register and resolve dependencies using tags for flexible dependency management.
+- **Factory Registration**: Added support for registering dependencies using factory functions for dynamic instantiation.
+- **Instance Registration**: Enabled registering existing instances as dependencies.
+- **Tag-based Registration and Resolution**: Introduced the ability to register and resolve dependencies using tags for flexible dependency management.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.6>`_
 
@@ -35,33 +43,33 @@ Version History
 
 **1.0.0-alpha.4 (2024-03-02)**
 
-- Constructor Arguments: Support for constructor arguments added to dependency registration.
+- **Constructor Arguments**: Support for constructor arguments added to dependency registration.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.4>`_
 
 **1.0.0-alpha.3 (2024-03-02)**
 
 - **Breaking Change**: Starting from this version, the `@inject` decorator can only be used on static class methods and class methods. It can't be used on instance methods anymore.
-- Documentation Update: The documentation has been updated to reflect the new restriction on the usage of the decorator.
+- **Documentation Update**: The documentation has been updated to reflect the new restriction on the usage of the decorator.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.3>`_
 
 **1.0.0-alpha.2 (2024-02-27)**
 
-- Python Version Support: Added support for Python versions 3.7, 3.9, 3.10, 3.11, and 3.12.
-- New Feature: Method Injection with Decorator: Introduced a new feature allowing method injection using the @inject decorator. Dependencies can now be injected into an instance method, providing more flexibility in managing dependencies within class instance methods.
-- New Feature: Multiple Containers: Enhanced the library to support multiple containers. Users can now create and manage multiple dependency containers, enabling better organization and separation of dependencies for different components or modules.
-- Documentation Update: Expanded and improved the documentation to include details about the newly added method injection feature and additional usage examples. Users can refer to the latest documentation at readthedocs for comprehensive guidance.
+- **Python Version Support**: Added support for Python versions 3.7, 3.9, 3.10, 3.11, and 3.12.
+- **New Feature**: Method Injection with Decorator: Introduced a new feature allowing method injection using the @inject decorator. Dependencies can now be injected into an instance method, providing more flexibility in managing dependencies within class instance methods.
+- **New Feature**: Multiple Containers: Enhanced the library to support multiple containers. Users can now create and manage multiple dependency containers, enabling better organization and separation of dependencies for different components or modules.
+- **Documentation Update**: Expanded and improved the documentation to include details about the newly added method injection feature and additional usage examples. Users can refer to the latest documentation at readthedocs for comprehensive guidance.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.2>`_
 
 **1.0.0-alpha.1 (2024-02-25)**
 
-- Initial alpha release.
-- Added Dependency Container: The library includes a dependency container for managing object dependencies.
-- Added Constructor Injection: Users can leverage constructor injection for cleaner and more modular code.
-- Added Dependency Scopes: Define and manage the lifecycle of dependencies with support for different scopes.
-- Basic Documentation: An initial set of documentation is provided, giving users an introduction to the library.
-- License: Released under the GPL 3 license.
+- **Initial alpha release**.
+- **Added Dependency Container**: The library includes a dependency container for managing object dependencies.
+- **Added Constructor Injection**: Users can leverage constructor injection for cleaner and more modular code.
+- **Added Dependency Scopes**: Define and manage the lifecycle of dependencies with support for different scopes.
+- **Basic Documentation**: An initial set of documentation is provided, giving users an introduction to the library.
+- **License**: Released under the GPL 3 license.
 
 `View release on GitHub <https://github.com/runemalm/py-dependency-injection/releases/tag/v1.0.0-alpha.1>`_

setup.py

@@ -6,10 +6,10 @@
 
 setup(
     name="py-dependency-injection",
-    version="1.0.0-alpha.8",
+    version="1.0.0-alpha.9",
     author="David Runemalm, 2024",
     author_email="david.runemalm@gmail.com",
-    description="A prototypical dependency injection library for Python.",
+    description="A dependency injection library for Python.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/runemalm/py-dependency-injection",

src/dependency_injection/container.py

@@ -1,4 +1,5 @@
 import inspect
+from dataclasses import is_dataclass
 
 from typing import Any, Callable, Dict, List, Optional, TypeVar, Type
 
@@ -18,6 +19,7 @@ def __init__(self, name: str = None):
         self._registrations = {}
         self._singleton_instances = {}
         self._scoped_instances = {}
+        self._has_resolved = False
 
     @classmethod
     def get_instance(cls, name: str = None) -> Self:
@@ -29,6 +31,16 @@ def get_instance(cls, name: str = None) -> Self:
 
         return cls._instances[(cls, name)]
 
+    def get_registrations(self) -> Dict[Type, Registration]:
+        return self._registrations
+
+    def set_registrations(self, registrations) -> None:
+        if self._has_resolved:
+            raise Exception(
+                "You can't set registrations after a dependency has been resolved."
+            )
+        self._registrations = registrations
+
     def register_transient(
         self,
         dependency: Type,
@@ -98,6 +110,8 @@ def register_instance(
         self._singleton_instances[dependency] = instance
 
     def resolve(self, dependency: Type, scope_name: str = DEFAULT_SCOPE_NAME) -> Type:
+        self._has_resolved = True
+
         if scope_name not in self._scoped_instances:
             self._scoped_instances[scope_name] = {}
 
@@ -176,6 +190,9 @@ def _inject_dependencies(
         scope_name: str = None,
         constructor_args: Optional[Dict[str, Any]] = None,
     ) -> Type:
+        if is_dataclass(implementation):
+            return implementation()  # Do not inject into dataclasses
+
         constructor = inspect.signature(implementation.__init__)
         params = constructor.parameters
 

src/dependency_injection/serialization.py

@@ -0,0 +1,15 @@
+import pickle
+
+from typing import Dict, Type
+
+from dependency_injection.registration import Registration
+
+
+class RegistrationSerializer:
+    @staticmethod
+    def serialize(registrations) -> bytes:
+        return pickle.dumps(registrations)
+
+    @staticmethod
+    def deserialize(serialized_state) -> Dict[Type, Registration]:
+        return pickle.loads(serialized_state)

tests/unit_test/container/register/test_get_registrations.py

@@ -0,0 +1,32 @@
+from dependency_injection.container import DependencyContainer
+from dependency_injection.scope import Scope
+from unit_test.unit_test_case import UnitTestCase
+
+
+class TestGetRegistrations(UnitTestCase):
+    def test_get_registrations_returns_empty_dict_initially(self):
+        # arrange
+        dependency_container = DependencyContainer.get_instance()
+
+        # act
+        registrations = dependency_container.get_registrations()
+
+        # assert
+        self.assertEqual(registrations, {})
+
+    def test_get_registrations_returns_correct_registrations(self):
+        # arrange
+        class Vehicle:
+            pass
+
+        dependency_container = DependencyContainer.get_instance()
+        dependency_container.register_transient(Vehicle)
+
+        # act
+        registrations = dependency_container.get_registrations()
+
+        # assert
+        self.assertIn(Vehicle, registrations)
+        self.assertEqual(registrations[Vehicle].dependency, Vehicle)
+        self.assertEqual(registrations[Vehicle].implementation, Vehicle)
+        self.assertEqual(registrations[Vehicle].scope, Scope.TRANSIENT)

tests/unit_test/container/register/test_set_registrations.py

@@ -0,0 +1,43 @@
+from dependency_injection.container import DependencyContainer
+from unit_test.unit_test_case import UnitTestCase
+
+
+class TestSetRegistrations(UnitTestCase):
+    def test_set_registrations_before_first_resolution(self):
+        # arrange
+        class Vehicle:
+            pass
+
+        dummy_container = DependencyContainer.get_instance("dummy_container")
+        dummy_container.register_transient(Vehicle)
+        new_registrations = dummy_container.get_registrations()
+
+        container = DependencyContainer.get_instance()
+
+        # act
+        container.set_registrations(new_registrations)  # no exception
+
+    def test_not_allowed_to_set_registrations_after_first_resolution(self):
+        # arrange
+        class Vehicle:
+            pass
+
+        class Fruit:
+            pass
+
+        dummy_container = DependencyContainer.get_instance("dummy_container")
+        dummy_container.register_transient(Vehicle)
+        new_registrations = dummy_container.get_registrations()
+
+        container = DependencyContainer.get_instance()
+        container.register_transient(Fruit)
+        container.resolve(Fruit)
+
+        # act & assert
+        with self.assertRaises(Exception) as context:
+            container.set_registrations(new_registrations)
+
+        self.assertIn(
+            "You can't set registrations after a dependency has been resolved.",
+            str(context.exception),
+        )

tests/unit_test/container/resolve/vehicle.py renamed to tests/unit_test/container/resolve/test_data/vehicle.py

@@ -2,8 +2,8 @@
 
 from unit_test.unit_test_case import UnitTestCase
 
-from unit_test.container.resolve.vehicle import Vehicle
-from unit_test.container.resolve.vehicle import Vehicle as VehicleAlias
+from unit_test.container.resolve.test_data.vehicle import Vehicle
+from unit_test.container.resolve.test_data.vehicle import Vehicle as VehicleAlias
 
 
 class TestResolveWithAlias(UnitTestCase):