clear-skies 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

clearskies/di/di.py

@@ -23,7 +23,7 @@ class Di:
     Build a dependency injection object.
 
     The dependency injection (DI) container is a key part of clearskies, so understanding how to both configure
-    them and get dependencies for your classes is important.  Note however that there you don't often have
+    them and get dependencies for your classes is important.  Note however that you don't often have
     to interact with the dependency injection container directly.  All of the configuration options for
     the DI container are also available to all the contexts, which is typically how you will build clearskies
     applications.  So, while you can create a DI container and use it directly, typically you'll just follow
@@ -648,7 +648,7 @@ class Di:
         its name and type-hint.
         """
         built_value = self.build_class_from_type_hint(argument_name, type_hint, context=context, cache=True)
-        if built_value:
+        if built_value is not None:
             return built_value
         return self.build_from_name(argument_name, context=context, cache=True)
 

clearskies/di/injectable_properties.py

@@ -44,7 +44,7 @@ class InjectableProperties:
     ```python
     import clearskies
     import time
-    from clearskies import parameters_to_properties
+    import clearskies.decorators
 
 
     class MyOtherThing(clearskies.di.InjectableProperties):
@@ -56,7 +56,7 @@ class InjectableProperties:
         some_number = clearskies.di.inject.ByName("some_number")
         my_other_thing = clearskies.di.inject.ByClass(MyOtherThing)
 
-        @parameters_to_properties
+        @clearskies.decorators.parameters_to_properties
         def __init__(self, my_int: int):
             self.finalize_and_validate_configuration()
 

clearskies/endpoint.py

@@ -8,9 +8,9 @@ from typing import TYPE_CHECKING, Any, Callable
 import clearskies.column
 import clearskies.configs
 import clearskies.configurable
+import clearskies.decorators
 import clearskies.di
 import clearskies.end
-import clearskies.parameters_to_properties
 import clearskies.typing
 from clearskies import autodoc, exceptions
 from clearskies.authentication import Authentication, Authorization, Public
@@ -32,15 +32,16 @@ class Endpoint(
     clearskies.di.InjectableProperties,
 ):
     """
-    Endpoints - the clearskies workhorse.
+    Automating drudgery!
 
     With clearskies, endpoints exist to offload some drudgery and make your life easier, but they can also
     get out of your way when you don't need them.  Think of them as pre-built endpoints that can execute
     common functionality needed for web applications/APIs.  Instead of defining a function that fetches
     records from your backend and returns them to the end user, you can let the list endpoint do this for you
     with a minimal amount of configuration.  Instead of making an endpoint that creates records, just deploy
-    a create endpoint.  Each endpoint has their own configuration settings, but there are some configuration
-    settings that are common to all endpoints, which are listed below:
+    a create endpoint.  While this gives clearskies some helpful capabiltiies for automation, it also has
+    the Callable endpoint which simply calls a developer-defined function, and therefore allows clearskies to
+    act like a much more typical framework.
     """
 
     """
@@ -342,7 +343,7 @@ class Endpoint(
     """
     The model class used by this endpoint.
 
-    The majority of endpoints require a model class that tells the endpoint where to get/save its data.
+    The endpoint will use this to fetch/save/validate incoming data as needed.
     """
     model_class = clearskies.configs.ModelClass(default=None)
 
@@ -878,7 +879,7 @@ class Endpoint(
     _sortable_columns: dict[str, clearskies.column.Column] = None  # type: ignore
     _as_json_map: dict[str, clearskies.column.Column] = None  # type: ignore
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         url: str = "",

clearskies/endpoint_group.py

@@ -217,16 +217,29 @@ class EndpointGroup(
     The dependency injection container
     """
     di = clearskies.di.inject.Di()
+
+    """
+    The base URL for the endpoint group.
+
+    This URL is added as a prefix to all endpoints attached to the group.  This includes any named URL parameters:
+    """
     url = clearskies.configs.String(default="")
+
+    """
+    The list of endpoints connected to this endpoint group
+    """
+    endpoints = clearskies.configs.EndpointList()
+
     response_headers = clearskies.configs.StringListOrCallable(default=[])
     authentication = clearskies.configs.Authentication(default=Public())
     authorization = clearskies.configs.Authorization(default=Authorization())
     security_headers = clearskies.configs.SecurityHeaders(default=[])
+
     cors_header: SecurityHeader = None  # type: ignore
     has_cors: bool = False
     endpoints_initialized = False
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         endpoints: list[Endpoint | Self],

clearskies/endpoints/callable.py

@@ -23,13 +23,13 @@ class Callable(Endpoint):
     """
     An endpoint that executes a user-defined function.
 
-    The Callable endpoint does exactly that - you provide a function that will be called when the endpoin is invoked.  Like
-    all callables invoked by clearskies, you can request any defined depenndency that can be provided by the clearskies
+    The Callable endpoint does exactly that - you provide a function that will be called when the endpoint is invoked.  Like
+    all callables invoked by clearskies, you can request any defined dependency that can be provided by the clearskies
     framework.
 
     Whatever you return will be returned to the client.  By default, the return value is sent along in the `data` parameter
     of the standard clearskies response.  To suppress this behavior, set `return_standard_response` to `False`.  You can also
-    return an model instance, a model query, or a list of model instances and the callable endpoint will automatically return
+    return a model instance, a model query, or a list of model instances and the callable endpoint will automatically return
     the columns specified in `readable_column_names` to the client.
 
     Here's a basic working example:
@@ -239,7 +239,7 @@ class Callable(Endpoint):
     """
     return_records = clearskies.configs.Boolean(default=False)
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         to_call: CallableType,
@@ -300,6 +300,7 @@ class Callable(Endpoint):
                     converted_models,
                     number_results=len(response) if response.backend.can_count else None,
                     next_page=response.next_page_data(),
+                    limit=response.get_query().limit,
                 )
 
         # or did they return a list of models?

clearskies/endpoints/create.py

@@ -102,7 +102,7 @@ class Create(Endpoint):
      5. We provided an extra column (`not_a_column`) that wasn't in the list of allowed columns.
     """
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/delete.py

@@ -73,7 +73,7 @@ class Delete(Get):
     ```
     """
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/get.py

@@ -159,7 +159,7 @@ class Get(Endpoint):
     """
     record_lookup_column_name = clearskies.configs.ReadableModelColumn("model_class", default=None)
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/health_check.py

@@ -130,7 +130,7 @@ class HealthCheck(Endpoint):
     """
     callables = clearskies.configs.Any(default=[])
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         dependency_injection_names: list[str] = [],

clearskies/endpoints/list.py

@@ -182,7 +182,7 @@ class List(Endpoint):
         "model_class", allow_relationship_references=True
     )
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/restful_api.py

@@ -5,8 +5,8 @@ from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable
 
 import clearskies.configs
+import clearskies.decorators
 import clearskies.exceptions
-import clearskies.parameters_to_properties
 from clearskies import authentication, autodoc, typing
 from clearskies.authentication import Authentication, Authorization, Public
 from clearskies.endpoint import Endpoint
@@ -293,7 +293,7 @@ class RestfulApi(EndpointGroup):
     where = clearskies.configs.Conditions(default=[])
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/simple_search.py

@@ -194,7 +194,7 @@ class SimpleSearch(List):
     ```
     """
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],

clearskies/endpoints/update.py

@@ -90,7 +90,7 @@ class Update(Get):
     }
     """
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],