clear-skies 2.0.5__py3-none-any.whl → 2.0.6__py3-none-any.whl

clearskies/contexts/wsgi_ref.py

@@ -0,0 +1,82 @@
+import datetime
+from types import ModuleType
+from typing import Any, Callable
+from wsgiref.simple_server import make_server
+from wsgiref.util import setup_testing_defaults
+
+import clearskies.endpoint
+import clearskies.endpoint_group
+from clearskies.contexts.context import Context
+from clearskies.di import AdditionalConfig
+from clearskies.input_outputs import Wsgi as WsgiInputOutput
+
+
+class WsgiRef(Context):
+    """
+    Use a built in WSGI server (for development purposes only).
+
+    This context will launch a built-in HTTP server for you, so you can run applications locally
+    without having to install extra dependencies.  Note that this server is not intended for production
+    usage, so this is best used for simple tests/demonstration purposes.  Unlike the WSGI context, where
+    you define the application handler and invoke the context from inside of it (passing along the
+    environment and start_response variables), in this case you simply directly invoke the context to
+    launch the server.  The default port is 8080:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def hello_world(name):
+        return f"Hello {name}!"
+
+    wsgi = clearskies.contexts.WsgiRef(
+        clearskies.endpoints.Callable(
+            hello_world,
+            url="/hello/:name",
+        )
+    )
+    wsgi()
+    ```
+
+    And to invoke it:
+
+    ```
+    curl 'http://localhost:8080/hello/Friend'
+    ```
+    """
+
+    port: int = 8080
+
+    def __init__(
+        self,
+        application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup,
+        port: int = 8080,
+        classes: type | list[type] = [],
+        modules: ModuleType | list[ModuleType] = [],
+        bindings: dict[str, Any] = {},
+        additional_configs: AdditionalConfig | list[AdditionalConfig] = [],
+        class_overrides: dict[type, type] = {},
+        overrides: dict[str, type] = {},
+        now: datetime.datetime | None = None,
+        utcnow: datetime.datetime | None = None,
+    ):
+        super().__init__(
+            application,
+            classes=classes,
+            modules=modules,
+            bindings=bindings,
+            additional_configs=additional_configs,
+            class_overrides=class_overrides,
+            overrides=overrides,
+            now=now,
+            utcnow=utcnow,
+        )
+        self.port = port
+
+    def __call__(self):  # type: ignore
+        with make_server("", self.port, self.handler) as httpd:
+            print(f"Starting WSGI server on port {self.port}.  This is NOT intended for production usage.")
+            httpd.serve_forever()
+
+    def handler(self, environment, start_response):
+        return self.execute_application(WsgiInputOutput(environment, start_response))

clearskies/decorators.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import inspect
+
+import wrapt  # type: ignore
+
+
+@wrapt.decorator
+def parameters_to_properties(wrapped, instance, args, kwargs):
+    if not instance:
+        raise ValueError(
+            "The parameters_to_properties decorator only works for methods in classes, not plain functions"
+        )
+
+    if args:
+        wrapped_args = inspect.getfullargspec(wrapped)
+        for key, value in zip(wrapped_args.args[1:], args):
+            # if it's a dictionary or a list then copy it to avoid linking data
+            if isinstance(value, dict):
+                value = {**value}
+            if isinstance(value, list):
+                value = [*value]
+            setattr(instance, key, value)
+
+    for key, value in kwargs.items():
+        # if it's a dictionary or a list then copy it to avoid linking data
+        if isinstance(value, dict):
+            value = {**value}
+        if isinstance(value, list):
+            value = [*value]
+        setattr(instance, key, value)
+
+    wrapped(*args, **kwargs)

clearskies/di/__init__.py

@@ -0,0 +1,14 @@
+import clearskies.di.inject as inject
+from clearskies.di.additional_config import AdditionalConfig
+from clearskies.di.additional_config_auto_import import AdditionalConfigAutoImport
+from clearskies.di.di import Di
+from clearskies.di.injectable import Injectable
+from clearskies.di.injectable_properties import InjectableProperties
+
+__all__ = [
+    "AdditionalConfig",
+    "AdditionalConfigAutoImport",
+    "Di",
+    "InjectableProperties",
+    "injectInjectable",
+]

clearskies/di/additional_config.py

@@ -0,0 +1,130 @@
+from typing import Any
+
+
+class AdditionalConfig:
+    """
+    This class allows you to add additional names to the Di container.
+
+    The idea here is that you extend the AdditonalConfig class and attach as many
+    `provide_*` methods to the class as you want.  This allows the developer to declare a number of
+    dependencies and easily attach them to the Di container in one go - helpful for modules that
+    come with a variety of things that they want to make available to developers.
+
+    When an AdditionalConfig instance is attached to the Di container, the container (in essence) finds all the
+    `provide_*` methods in the class and registers the corresponding name in the Di container - e.g. if you have
+    a method called `provide_widget` then when a class or function requests an argument named `widget`
+    from the Di container, the container will call the `provide_widget` method on your instance and pass along
+    the return value to the thing that requested a `widget`. The `provide_*` methods can declare their own
+    dependencies, including ones declared in the same `AdditionalConfig` class (they just can't be circular, of course).
+
+    As always, keep in mind the priority of dependency injection names (see the `clearskies.di.Di` class for full
+    details).  If two `AdditionalConfig` objects declare a `provide_*` method with the same name, then the Di
+    system will call the method for the `AdditionalConfig` object that was added last.
+
+    By default the Di system caches all values.  If you have a dependency that shouldn't be cached, you can
+    extend the `can_cache` method and have it return True/False depending on the name and context.
+
+    Example:
+    ```python
+    from clearskies.di import Di, AdditionalConfig
+
+
+    class MyAdditionalConfig(AdditionalConfig):
+        def provide_inner_dependency(self):
+            return 5
+
+        def provide_important_thing(self, inner_dependency):
+            return inner_dependency * 10
+
+
+    class AnotherAdditionalConfig(AdditionalConfig):
+        def provide_inner_dependency(self):
+            return 10
+
+
+    di = Di(additional_configs=[MyAdditionalConfig(), AnotherAdditionalConfig()])
+    # Equivalent:
+    # di = Di()
+    # di.add_addtional_configs([MyAdditionalConfig(), AnotherAdditionalConfig()])
+
+
+    def my_function(important_thing):
+        print(important_thing)  # prints 100
+    ```
+    """
+
+    def can_cache(self, name: str, di, context: str) -> bool:
+        """
+        Cache control.
+
+        The Di container caches values by default, but this method allows you to override that.
+        After fetching an object from the AdditionalConfig class, the Di container will call this method to
+        determine whether or not to cache  it.  `name` will be the name of the Di value that was built, and
+        context will be the name of the class that the value was built for.  You then return True/False.
+
+        Note that this controls whether or not to cache the returned value, not whether or not to check the
+        cache for a value.  The importance is that, once there is a value in the cache, that will be reused
+        for all future requests for that name.  Example:
+
+        ```python
+        from clearskies.di import Di, AdditionalConfig
+        import secrets
+
+
+        class MyAdditionalConfig(AdditionalConfig):
+            def provide_random_number_not_cached(self):
+                return secrets.randbelow(100)
+
+            def provide_random_number_cached(self):
+                return secrets.randbelow(100)
+
+            def can_cache(self, name, context=None):
+                return name == "random_number_not_cached"
+
+
+        di = Di(additional_configs=MyAdditionalConfig())
+
+
+        def my_function(random_number_cached, random_number_not_cached):
+            print(random_number_cached)
+            print(random_number_not_cached)
+
+
+        di.call_function(my_function)
+        di.call_function(my_function)
+        di.call_function(my_function)
+        di.call_function(my_function)
+
+        # This prints something like:
+        # 58
+        # 12
+        # 58
+        # 14
+        # 58
+        # 41
+        ```
+        """
+        return True
+
+    def can_build(self, name):
+        return hasattr(self, f"provide_{name}")
+
+    def build(self, name, di, context=None):
+        if not hasattr(self, f"provide_{name}"):
+            raise KeyError(
+                f"AdditionalConfig class '{self.__class__.__name__}' cannot build requested dependency, '{name}'"
+            )
+
+        return di.call_function(getattr(self, f"provide_{name}"))
+
+    def can_build_class(self, class_to_check: type) -> bool:
+        """Return True/False to denote if this AdditionalConfig class can provide a given class."""
+        return False
+
+    def build_class(self, class_to_provide: type, argument_name: str, di, context: str = "") -> Any:
+        """Return the desired instance of a given class."""
+        pass
+
+    def can_cache_class(self, class_to_build: type, di, context: str) -> bool:
+        """Control whether or not the Di container caches the instance after building a class."""
+        return False

clearskies/di/additional_config_auto_import.py

@@ -0,0 +1,17 @@
+from .additional_config import AdditionalConfig
+
+
+class AdditionalConfigAutoImport(AdditionalConfig):
+    """
+    AdditionalConfig, but now with auto import.
+
+    This works exactly like the AdditionalConfig class, but will be automatically imported into the Di
+    container if found in a module being imported into the Di container.  This just provides a way for
+    modules to easily inject names into the Di system.  In order to be found, an imported module
+    just needs to make sure that it imports the class that extends the AdditionalConfigAutoImport class.
+
+    Note that automatically-imported AdditionalConfig classes automatically have lower priority than
+    any AdditionalConfig classes added explicitly to the Di container.
+    """
+
+    pass