fastapi-startkit 0.1.0__tar.gz

fastapi_startkit-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: fastapi-startkit
+Version: 0.1.0
+Summary: Core Masonite components (Container, Config, Loader)
+Author: Bedram Tamang
+Author-email: tmgbedu@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: dotty-dict (>=1.3.1)
+Requires-Dist: fastapi[standard] (>=0.124.4,<0.125.0)

fastapi_startkit-0.1.0/fastapi_startkit/__init__.py

@@ -0,0 +1,3 @@
+from .application import Application
+
+__all__ = ["Application"]

fastapi_startkit-0.1.0/fastapi_startkit/application.py

@@ -0,0 +1,40 @@
+from dotenv import load_dotenv
+from fastapi import FastAPI
+from .container import Container
+from .environment.environment import LoadEnvironment
+
+
+class Application(Container):
+    def __init__(self, base_path: str = None, providers=None):
+        self.base_path: str = base_path
+        self.providers = providers if providers else []
+
+        self.load_environment()
+        self.register_providers()
+
+        self.fastapi = FastAPI()
+        self.load_providers()
+
+    def register_providers(self):
+        for provider_class in self.providers:
+            provider = provider_class(self)
+            provider.register()
+        return self
+
+    def load_providers(self):
+        for provider in self.providers:
+            self.resolve(provider.boot)
+        return self
+
+    def use_fastapi(self, fastapi: FastAPI):
+        self.fastapi = fastapi
+        return self
+
+    def get(self, path: str):
+        return self.fastapi.get(path)
+
+    def __call__(self):
+        return self.fastapi
+
+    def load_environment(self):
+        LoadEnvironment(base_path=self.base_path)

fastapi_startkit-0.1.0/fastapi_startkit/configuration/Configuration.py

@@ -0,0 +1,80 @@
+from fastapi_startkit_foundation.loader import Loader
+from ..utils.structures import data
+from ..exceptions import InvalidConfigurationLocation, InvalidConfigurationSetup
+
+
+class Configuration:
+    # Foundation configuration keys
+    reserved_keys = [
+        "application",
+        "auth",
+        "broadcast",
+        "cache",
+        "database",
+        "filesystem",
+        "mail",
+        "notification",
+        "providers",
+        "queue",
+        "session",
+    ]
+
+    def __init__(self, application):
+        self.application = application
+        self._config = data()
+
+    def load(self):
+        """At boot load configuration from all files and store them in here."""
+        config_root = self.application.make("config.location")
+        for module_name, module in Loader().get_modules(
+            config_root, raise_exception=True
+        ).items():
+            params = Loader().get_parameters(module)
+            for name, value in params.items():
+                self._config[f"{module_name}.{name.lower()}"] = value
+
+        # check loaded configuration
+        if not self._config.get("application"):
+            raise InvalidConfigurationLocation(
+                f"Config directory {config_root} does not contain required configuration files."
+            )
+
+    def merge_with(self, path, external_config):
+        """Merge external config at key with project config at same key. It's especially
+        useful in Masonite packages in order to merge the configuration default package with
+        the package configuration which can be published in project.
+
+        This functions disallow merging configuration using foundation configuration keys
+        (such as 'application').
+        """
+        if path in self.reserved_keys:
+            raise InvalidConfigurationSetup(
+                f"{path} is a reserved configuration key name. Please use an other key."
+            )
+        if isinstance(external_config, str):
+            # config is a path and should be loaded
+            params = Loader.get_parameters(external_config)
+        else:
+            params = external_config
+        base_config = {name.lower(): value for name, value in params.items()}
+        merged_config = {**base_config, **self.get(path, {})}
+        self.set(path, merged_config)
+
+    def set(self, path, value):
+        self._config[path] = value
+
+    def has(self, path):
+        return path in self._config
+
+    def all(self):
+        return self._config
+
+    def get(self, path, default=None):
+        try:
+            config_at_path = self._config[path]
+            if isinstance(config_at_path, dict):
+                return data(config_at_path)
+            else:
+                return config_at_path
+        except KeyError:
+            return default

fastapi_startkit-0.1.0/fastapi_startkit/configuration/__init__.py

@@ -0,0 +1,2 @@
+from .helpers import config
+from .Configuration import Configuration

fastapi_startkit-0.1.0/fastapi_startkit/configuration/helpers.py

@@ -0,0 +1,5 @@
+from ..facades import Config
+
+
+def config(key, default=None):
+    return Config.get(key, default)

fastapi_startkit-0.1.0/fastapi_startkit/configuration/providers/ConfigurationProvider.py

@@ -0,0 +1,16 @@
+from ...providers import Provider
+
+from ..Configuration import Configuration
+
+
+class ConfigurationProvider(Provider):
+    def __init__(self, application):
+        self.application = application
+
+    def register(self):
+        config = Configuration(self.application)
+        config.load()
+        self.application.bind("config", config)
+
+    def boot(self):
+        pass

fastapi_startkit-0.1.0/fastapi_startkit/configuration/providers/__init__.py

@@ -0,0 +1 @@
+from .ConfigurationProvider import ConfigurationProvider

fastapi_startkit-0.1.0/fastapi_startkit/container/__init__.py

@@ -0,0 +1 @@
+from .container import Container

fastapi_startkit-0.1.0/fastapi_startkit/container/container.py

@@ -0,0 +1,494 @@
+"""Core of the IOC Container."""
+
+import inspect
+
+from ..exceptions import (
+    ContainerError,
+    MissingContainerBindingNotFound,
+    StrictContainerException,
+)
+
+
+class Container:
+    """Core of the Service Container.
+
+    Performs bindings and resolving of objects to and from the container.
+    """
+
+    objects = {}
+    strict = False
+    override = True
+    resolve_parameters = {}
+    remember = False
+    _hooks = {
+        "make": {},
+        "bind": {},
+        "resolve": {},
+    }
+
+    swaps = {}
+    _remembered = {}
+
+    def bind(self, name, class_obj):
+        """Bind classes into the container with a key value pair.
+
+        Arguments:
+            name {string} -- Name of the key you want to bind the object to
+            class_obj {object} -- The object you want to bind
+
+        Returns:
+            self
+        """
+        if inspect.ismodule(class_obj):
+            raise StrictContainerException(
+                "Cannot bind module '{}' with key '{}' into the container".format(
+                    class_obj, name
+                )
+            )
+        if self.strict and name in self.objects:
+            raise StrictContainerException(
+                "You cannot override a key inside a strict container"
+            )
+
+        if self.override or name not in self.objects:
+            self.fire_hook("bind", name, class_obj)
+            self.objects.update({name: class_obj})
+
+        return self
+
+    def unbind(self, name):
+        """Unbind classes from the container from a key.
+
+        Arguments:
+            name {string} -- Name of the key you want to bind the object to
+
+        Returns:
+            self
+        """
+
+        if name not in self.objects:
+            return False
+
+        del self.objects[name]
+
+        return self
+
+    def simple(self, obj):
+        """Easy way to bind classes into the container by using passing the object only.
+
+        Automatically generates the key for the binding process.
+
+        Arguments:
+            class_obj {object} -- The object you want to bind
+
+        Returns:
+            self
+        """
+        self.bind(obj if inspect.isclass(obj) else obj.__class__, obj)
+        return self
+
+    def singleton(self, name, class_obj):
+        """Register a shared binding in the container.
+
+        Arguments:
+            name {string} -- Name of the key you want to bind the object to
+            class_obj {object} -- The object you want to bind
+        """
+        obj = self.resolve(class_obj)
+        self.bind(name, obj)
+
+    def make(self, name, *arguments):
+        """Retrieve a class from the container by key.
+
+        Arguments:
+            name {string} -- Key in the container that you want to get.
+
+        Raises:
+            MissingContainerBindingNotFound -- Raised if the key is not in the container.
+
+        Returns:
+            object -- Returns the object that is fetched.
+        """
+
+        if name in self.objects:
+            obj = self.objects[name]
+            self.fire_hook("make", name, obj)
+            if inspect.isclass(obj):
+                obj = self.resolve(obj, *arguments)
+            return obj
+        elif name in self.swaps:
+            return self.swaps.get(name)
+        elif inspect.isclass(name):
+            try:
+                obj = self._find_obj(name)
+                self.fire_hook("make", name, obj)
+                if inspect.isclass(obj):
+                    obj = self.resolve(obj, *arguments)
+            except MissingContainerBindingNotFound:
+                # If we don't find a bound object already in the container,
+                # we can go ahead and fall back on a simple resolve method.
+                # This allows resolving dependencies without explicit
+                # bindings.
+                obj = self.resolve(name, *arguments)
+            return obj
+
+        raise MissingContainerBindingNotFound(
+            "{0} key was not found in the container".format(name)
+        )
+
+    def has(self, name):
+        """Check if a key exists in the container.
+
+        Arguments:
+            name {string} -- Key you want to check for in the container
+
+        Returns:
+            bool
+        """
+        if isinstance(name, str):
+            return name in self.objects
+        else:
+            try:
+                self._find_obj(name)
+                return True
+            except MissingContainerBindingNotFound:
+                return False
+
+    def helper(self):
+        """Add a helper to create builtin functions.
+
+        Used to more simply return
+        instances of this class when building helpers.
+
+        Returns:
+            self
+        """
+        return self
+
+    def resolve(self, obj, *resolving_arguments):
+        """Takes an object such as a function or class method and resolves it's
+        parameters from objects in the container.
+
+        Arguments:
+            obj {object} -- The object you want to resolve objects from via this container.
+
+        Returns:
+            object -- The object you tried resolving but with the correct dependencies injected.
+        """
+        objects = []
+        passing_arguments = list(resolving_arguments)
+        if self.remember and obj in self._remembered:
+            objects = self._remembered[obj]
+            try:
+                return obj(*objects)
+            except TypeError as e:
+                raise ContainerError(str(e))
+        elif (
+            self.remember
+            and not passing_arguments
+            and inspect.ismethod(obj)
+            and "{}.{}.{}".format(
+                obj.__module__, obj.__self__.__class__.__name__, obj.__name__
+            )
+            in self._remembered
+        ):
+            location = "{}.{}.{}".format(
+                obj.__module__, obj.__self__.__class__.__name__, obj.__name__
+            )
+            objects = self._remembered[location]
+            try:
+                return obj(*objects)
+            except TypeError as e:
+                raise ContainerError(str(e))
+        else:
+            for _, value in self.get_parameters(obj):
+                if type(value.annotation) in (str, int, dict, list, tuple) or value.annotation in (str, int, dict, list, tuple):
+                    # Ignore any times a user is simply type hinting a parameter like (parameter:str or parameter:"str").
+                    # In this case we don't want to resolve anything but we do want
+                    # to insert any passing arguments we passed in
+                    try:
+                        objects.append(passing_arguments.pop(0))
+                    except IndexError:
+                        pass
+
+                    continue
+                if ":" in str(value):
+                    try:
+                        param = self._find_annotated_parameter(value)
+                    except ContainerError:
+                        # This allows resolving dependencies without explicit bindings.
+                        # See `self.make()`.
+                        param = value.annotation
+                    if inspect.isclass(param):
+                        if resolving_arguments:
+                            param = self.resolve(param, *resolving_arguments)
+                        else:
+                            param = self.resolve(param)
+                    objects.append(param)
+                elif "self" in str(value):
+                    objects.append(obj)
+                elif "=" in str(value):
+                    objects.append(value.default)
+                elif "*" in str(value):
+                    continue
+                elif self.resolve_parameters:
+                    objects.append(self._find_parameter(value))
+                elif resolving_arguments:
+                    try:
+                        objects.append(passing_arguments.pop(0))
+                    except IndexError:
+                        raise ContainerError(
+                            "Not enough dependencies passed. Resolving object needs {} dependencies.".format(
+                                len(inspect.signature(obj).parameters)
+                            )
+                        )
+                else:
+                    raise ContainerError(
+                        "This container is not set to resolve parameters. You can set this in the container"
+                        " constructor using the 'resolve_parameters=True' keyword argument."
+                    )
+
+        if self.remember:
+            if not inspect.ismethod(obj):
+                self._remembered[obj] = objects
+            else:
+                signature = "{}.{}.{}".format(
+                    obj.__module__, obj.__self__.__class__.__name__, obj.__name__
+                )
+                self._remembered[signature] = objects
+        return obj(*objects)
+
+    def collect(self, search):
+        """Fetch a dictionary of objects using a search query.
+
+        Arguments:
+            search {string|object} -- The string or object you want to search for.
+
+        Raises:
+            AttributeError -- Thrown if there is no wildcard in the search string
+
+        Returns:
+            dict -- Returns a dictionary of collected objects and their key bindings.
+        """
+        providers = {}
+        if isinstance(search, str):
+            # Search Can Be:
+            #    '*ExceptionHook'
+            #    'Sentry*'
+            #    'Sentry*Hook'
+            for key, value in self.objects.items():
+                if isinstance(key, str):
+                    if search.startswith("*"):
+                        if key.endswith(search.split("*")[1]):
+                            providers.update({key: value})
+                    elif search.endswith("*"):
+                        if key.startswith(search.split("*")[0]):
+                            providers.update({key: value})
+                    elif "*" in search:
+                        split_search = search.split("*")
+                        if key.startswith(split_search[0]) and key.endswith(
+                            split_search[1]
+                        ):
+                            providers.update({key: value})
+                    else:
+                        raise AttributeError(
+                            "There is no '*' in your collection search"
+                        )
+        else:
+            for provider_key, provider_class in self.objects.items():
+                if (
+                    inspect.isclass(provider_class)
+                    and issubclass(provider_class, search)
+                ) or isinstance(provider_class, search):
+                    providers.update({provider_key: provider_class})
+
+        return providers
+
+    def _find_annotated_parameter(self, parameter):
+        """Find a given annotation in the container.
+
+        Arguments:
+            parameter {object} -- The object to find in the container.
+
+        Raises:
+            ContainerError -- Thrown when the dependency is not found in the container.
+
+        Returns:
+            object -- Returns the object found in the container.
+        """
+        if isinstance(parameter.annotation, str):
+            return
+        if parameter.annotation in self.swaps:
+            obj = self.swaps[parameter.annotation]
+            if callable(obj):
+                return self.swaps[parameter.annotation](parameter.annotation, self)
+            return obj
+
+        for _, provider_class in self.objects.items():
+            if (
+                parameter.annotation == provider_class
+                or parameter.annotation == provider_class.__class__
+            ):
+                obj = provider_class
+                self.fire_hook("resolve", parameter, obj)
+
+                return obj
+            elif (
+                inspect.isclass(provider_class)
+                and issubclass(provider_class, parameter.annotation)
+                or issubclass(provider_class.__class__, parameter.annotation)
+            ):
+                obj = provider_class
+                self.fire_hook("resolve", parameter, obj)
+                return obj
+
+        raise ContainerError(
+            "The dependency with the {0} annotation could not be resolved by the container".format(
+                parameter
+            )
+        )
+
+    def get_parameters(self, obj):
+        return inspect.signature(obj).parameters.items()
+
+    def _find_parameter(self, keyword):
+        """Find a parameter in the container.
+
+        Arguments:
+            parameter {inspect.Paramater} -- Parameter to search for.
+
+        Raises:
+            ContainerError -- Thrown when the dependency is not found in the container.
+
+        Returns:
+            object -- Returns the object found in the container
+        """
+        parameter = str(keyword)
+
+        if parameter != "self" and parameter in self.objects:
+            obj = self.objects[parameter]
+            self.fire_hook("resolve", parameter, obj)
+            return obj
+        elif "=" in parameter:
+            return keyword.default
+
+        raise ContainerError(
+            "The parameter dependency with the key of {0} could not be found in the container".format(
+                parameter
+            )
+        )
+
+    def on_bind(self, key, obj):
+        """Set some listeners for when a specific key or class in binded to the container.
+
+        Arguments:
+            key {string|object} -- The key can be a string or an object to listen for
+            obj {object} -- Should be a function or class method
+
+        Returns:
+            self
+        """
+        return self._bind_hook("bind", key, obj)
+
+    def on_make(self, key, obj):
+        """Set some listeners for when a specific key or class is made from the container.
+
+        Arguments:
+            key {string|object} -- The key can be a string or an object to listen for
+            obj {object} -- Should be a function or class method
+
+        Returns:
+            self
+        """
+        return self._bind_hook("make", key, obj)
+
+    def on_resolve(self, key, obj):
+        """Set some listeners for when a specific key or class is resolved from the container.
+
+        Arguments:
+            key {string|object} -- The key can be a string or an object to listen for
+            obj {object} -- Should be a function or class method
+
+        Returns:
+            self
+        """
+        return self._bind_hook("resolve", key, obj)
+
+    def swap(self, obj, callback):
+        self.swaps.update({obj: callback})
+        return self
+
+    def fire_hook(self, action, key, obj):
+        """Fire a specific hook based on a key or object.
+
+        Arguments:
+            action {string} -- Should be the action to fire (bind|make|resolve)
+            key {string|object} -- The key can be a string or an object to listen for
+            obj {object} -- Should be a function or class method
+
+        Returns:
+            None
+        """
+        if (
+            str(key) in self._hooks[action]
+            or inspect.isclass(obj)
+            and obj in self._hooks[action]
+            or obj.__class__ in self._hooks[action]
+        ):
+
+            for _, hook_list in self._hooks[action].items():
+                for hook_obj in hook_list:
+                    hook_obj(obj, self)
+
+    def _bind_hook(self, hook, key, obj):
+        """Internal method used to abstract away the logic for binding an
+        listener to the container hooks.
+
+        Arguments:
+            hook {string} -- The hook you want to listen for (bind|make|resolve)
+            key {string|object} -- The key to save for the listener
+            obj {object} -- Should be a function or class method
+
+        Returns:
+            self
+        """
+        if key in self._hooks[hook]:
+            self._hooks[hook][key].append(obj)
+        else:
+            self._hooks[hook].update({key: [obj]})
+        return self
+
+    def _find_obj(self, obj):
+        """Find an object in the container.
+
+        Arguments:
+            obj {object} -- Any object in the container
+
+        Raises:
+            MissingContainerBindingNotFound -- Raised when the object cannot be found.
+
+        Returns:
+            object -- Returns the object in the container
+        """
+        for _, provider_class in self.objects.items():
+            if obj in (provider_class, provider_class.__class__):
+                return_obj = provider_class
+                self.fire_hook("resolve", obj, return_obj)
+                return return_obj
+            elif (
+                inspect.isclass(provider_class)
+                and issubclass(provider_class, obj)
+                or issubclass(provider_class.__class__, obj)
+            ):
+                return_obj = provider_class
+                self.fire_hook("resolve", obj, return_obj)
+                return return_obj
+
+        raise MissingContainerBindingNotFound(
+            "The dependency with the {0} annotation could not be resolved by the container".format(
+                obj
+            )
+        )
+
+    def __contains__(self, obj):
+        return self.has(obj)