clear-skies 1.22.31__py3-none-any.whl → 2.0.1__py3-none-any.whl

clearskies/backends/backend.py

@@ -1,46 +1,56 @@
-from abc import ABC, abstractmethod
 import inspect
-from .. import model
-from typing import Any, Callable, Dict, List, Tuple, Type, Union
+from abc import ABC, abstractmethod
+from typing import Any, Callable, Type
+
+import clearskies.column
+import clearskies.model
+import clearskies.query
+from clearskies.autodoc.schema import Schema as AutoDocSchema
 
 
 class Backend(ABC):
+    """
+    Conecting models to their data since 2020!
+
+    The backend system acts as a flexible layer between models and their data sources.  By changing the backend attached to a model,
+    you change where the model fetches and saves data.  This might be a database, an in-memory data store, a dynamodb table,
+    an API, and more.  This allows you to interact with a variety of data sources with the models acting as a standardized API.
+    Since endpoints also rely on the models for their functionality, this means that you can easily build API endpoints and
+    more for a variety of data sources with a minimal amount of code.
+
+    Of course, not all data sources support all functionality present in the model.  Therefore, you do still need to have
+    a fair understanding of how your data sources work.
+    """
+
     supports_n_plus_one = False
+    can_count = True
 
     @abstractmethod
-    def update(self, id: str, data: Dict[str, Any], model: model.Model) -> Dict[str, Any]:
-        """
-        Updates the record with the given id with the information from the data dictionary
-        """
+    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+        """Update the record with the given id with the information from the data dictionary."""
         pass
 
     @abstractmethod
-    def create(self, data: Dict[str, Any], model: model.Model) -> Dict[str, Any]:
-        """
-        Creates a record with the information from the data dictionary
-        """
+    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+        """Create a record with the information from the data dictionary."""
         pass
 
     @abstractmethod
-    def delete(self, id: str, model: model.Model) -> bool:
-        """
-        Deletes the record with the given id
-        """
+    def delete(self, id: int | str, model: clearskies.model.Model) -> bool:
+        """Delete the record with the given id."""
         pass
 
     @abstractmethod
-    def count(self, configuration: Dict[str, Any], model: model.Model) -> int:
-        """
-        Returns the number of records which match the given query configuration
-        """
+    def count(self, query: clearskies.query.Query) -> int:
+        """Return the number of records which match the given query configuration."""
         pass
 
     @abstractmethod
     def records(
-        self, configuration: Dict[str, Any], model: model.Model, next_page_data: Dict[str, str] = None
-    ) -> List[Dict[str, Any]]:
+        self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
+    ) -> list[dict[str, Any]]:
         """
-        Returns a list of records that match the given query configuration
+        Return a list of records that match the given query configuration.
 
         next_page_data is used to return data to the caller.  Pass in an empty dictionary, and it will be populated
         with the data needed to return the next page of results.  If it is still an empty dictionary when returned,
@@ -49,18 +59,18 @@ class Backend(ABC):
         pass
 
     @abstractmethod
-    def validate_pagination_kwargs(self, kwargs: Dict[str, Any]) -> str:
+    def validate_pagination_data(self, data: dict[str, Any], case_mapping: Callable[[str], str]) -> str:
         """
-        Checks if the given dictionary is valid pagination data for the background.
+        Check if the given dictionary is valid pagination data for the background.
 
-        Returns a string with an error message, or an empty string if the data is valid
+        Return a string with an error message, or an empty string if the data is valid
         """
         pass
 
     @abstractmethod
-    def allowed_pagination_keys(self) -> List[str]:
+    def allowed_pagination_keys(self) -> list[str]:
         """
-        Returns the list of allowed keys in the pagination kwargs for the backend
+        Return the list of allowed keys in the pagination kwargs for the backend.
 
         It must always return keys in snake_case so that the auto casing system can
         adjust on the front-end for consistency.
@@ -68,79 +78,38 @@ class Backend(ABC):
         pass
 
     @abstractmethod
-    def documentation_pagination_next_page_response(self, case_mapping: Callable) -> List[Any]:
+    def documentation_pagination_next_page_response(self, case_mapping: Callable) -> list[Any]:
         """
-        Returns a list of autodoc schema objects describing the contents of the `next_page` dictionary
+        Return a list of autodoc schema objects.
+
+        It will describe the contents of the `next_page` dictionary
         in the pagination section of the response
         """
         pass
 
     @abstractmethod
-    def documentation_pagination_parameters(self, case_mapping: Callable) -> List[Tuple[Any]]:
+    def documentation_pagination_parameters(self, case_mapping: Callable) -> list[tuple[AutoDocSchema, str]]:
         """
-        Returns a list of autodoc schema objects describing the allowed input keys to set pagination.  It should
-        return a list of tuples, with each tuple corresponding to an input key.  The first element in the
-        tuple should be the schema, and the second should be the description.
+        Return a list of autodoc schema objects describing the allowed input keys to set pagination.
+
+        It should return a list of tuples, with each tuple corresponding to an input key.
+        The first element in the tuple should be the schema, and the second should be the description.
         """
         pass
 
     @abstractmethod
-    def documentation_pagination_next_page_example(self, case_mapping: Callable) -> Dict[str, Any]:
+    def documentation_pagination_next_page_example(self, case_mapping: Callable) -> dict[str, Any]:
         """
+        Return an example for next page documentation.
+
         Returns an example (as a simple dictionary) of what the next_page data in the pagination response
         should look like
         """
         pass
 
-    def create_record_with_class(
-        self, model_or_class: Union[model.Model, Type[model.Model]], data: Dict[str, Any]
-    ) -> Dict[str, Any]:
-        """
-        This creates a record but, unlike with self.create, does not require a model - just the model class
-
-        Mainly meant for testing because this cheats badly.
-        """
-        model = self.cheez_model(model_or_class)
-        return self.create(data, model)
-
-    def cheez_model(self, model_or_class: Union[model.Model, Type[model.Model]]) -> model.Model:
-        """
-        Pass in a model or model class, and it returns a (possibly poorly constructed) model
-
-        The backends have some methods mainly meant for testing which accept either a model
-        or model class.  We accept the model class because, especially when testing, this is often much easier
-        to provide (since you need a columns object to build the model).  In all current cases, these backend
-        methods don't actually need a full model - just the table name.  This is quite simple when we have a model,
-        because the model can tell you what the table name is.
-
-        It's tricky when we get a model class because that means we need to build the model, but we don't
-        have access to a generic model builder.  We could ask the dev to provide a model, but being able to provide just
-        a model class will save devs a lot trouble in many cases (especially testing).
-
-        Fortunately, pulling out a table name for the model basically never involves dependencies.  Therefore,
-        we will cheat!  We'll just inject gibberish for the arguments of the constructor and hope nothing
-        breaks.
-
-        NOTE: If you're here because something broke, and your dependencies actually do matter for determining
-        the table name, then you need to do two things:
-
-         1. Consider if you're doing something the wrong way, because that is weird
-         2. Just provide the model instead of the model class.
-        """
-        if inspect.isclass(model_or_class):
-            try:
-                # the list of args will include 'self' which we don't have to provide, so subtract 1
-                nargs = len(inspect.getfullargspec(model_or_class.__init__).args) - 1
-                # generate a list of empty strings with a size of nargs and pass that into the constructor
-                return model_or_class(*([""] * nargs))
-            except AttributeError:
-                # if we get here there is no __init__ defined so we don't need to pass arguments
-                return model_or_class()
-        return model_or_class
-
-    def column_from_backend(self, column, value):
+    def column_from_backend(self, column: clearskies.column.Column, value: Any) -> Any:
         """
-        Manages transformations from the backend
+        Manage transformations from the backend.
 
         The idea with this (and `column_to_backend`) is that the transformations to
         and from the backend are mostly determined by the column type - integer, string,
@@ -152,9 +121,9 @@ class Backend(ABC):
         """
         return column.from_backend(value)
 
-    def column_to_backend(self, column, backend_data):
+    def column_to_backend(self, column: clearskies.column.Column, backend_data: dict[str, Any]) -> dict[str, Any]:
         """
-        Manages transformations to the backend
+        Manage transformations to the backend.
 
         The idea with this (and `column_from_backend`) is that the transformations to
         and from the backend are mostly determined by the column type - integer, string,