clear-skies 2.0.7__py3-none-any.whl → 2.0.9__py3-none-any.whl

clearskies/endpoints/restful_api.py

@@ -1,27 +1,19 @@
 from __future__ import annotations
 
 import inspect
-from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable
 
-import clearskies.configs
-import clearskies.decorators
-import clearskies.exceptions
-from clearskies import authentication, autodoc, typing
+from clearskies import configs, decorators
 from clearskies.authentication import Authentication, Authorization, Public
-from clearskies.endpoint import Endpoint
 from clearskies.endpoint_group import EndpointGroup
 from clearskies.endpoints.create import Create
 from clearskies.endpoints.delete import Delete
 from clearskies.endpoints.get import Get
 from clearskies.endpoints.simple_search import SimpleSearch
 from clearskies.endpoints.update import Update
-from clearskies.functional import string
-from clearskies.input_outputs import InputOutput
 
 if TYPE_CHECKING:
-    from clearskies import SecurityHeader
-    from clearskies.model import Column, Model, Schema
+    from clearskies import Column, Endpoint, Model, Schema, SecurityHeader
 
 
 class RestfulApi(EndpointGroup):
@@ -190,7 +182,7 @@ class RestfulApi(EndpointGroup):
     This defaults to `clearskies.endpoints.Create`.  To disable the create operation all together,
     set this to None.
     """
-    create_endpoint = clearskies.configs.Endpoint(default=Create)
+    create_endpoint = configs.Endpoint(default=Create)
 
     """
     The endpoint class to use for managing the delete operation.
@@ -198,7 +190,7 @@ class RestfulApi(EndpointGroup):
     This defaults to `clearskies.endpoints.Delete`.  To disable the delete operation all together,
     set this to None.
     """
-    delete_endpoint = clearskies.configs.Endpoint(default=Delete)
+    delete_endpoint = configs.Endpoint(default=Delete)
 
     """
     The endpoint class to use for managing the update operation.
@@ -206,7 +198,7 @@ class RestfulApi(EndpointGroup):
     This defaults to `clearskies.endpoints.Update`.  To disable the update operation all together,
     set this to None.
     """
-    update_endpoint = clearskies.configs.Endpoint(default=Update)
+    update_endpoint = configs.Endpoint(default=Update)
 
     """
     The endpoint class to use to fetch individual records.
@@ -214,7 +206,7 @@ class RestfulApi(EndpointGroup):
     This defaults to `clearskies.endpoints.Get`.  To disable the get operation all together,
     set this to None.
     """
-    get_endpoint = clearskies.configs.Endpoint(default=Get)
+    get_endpoint = configs.Endpoint(default=Get)
 
     """
     The endpoint class to use to list records.
@@ -222,78 +214,76 @@ class RestfulApi(EndpointGroup):
     This defaults to `clearskies.endpoints.SimpleSearch`.  To disable the list operation all together,
     set this to None.
     """
-    list_endpoint = clearskies.configs.Endpoint(default=SimpleSearch)
+    list_endpoint = configs.Endpoint(default=SimpleSearch)
 
     """
     The request method(s) to use to route to the create operation.  Default is ["POST"].
     """
-    create_request_methods = clearskies.configs.SelectList(
+    create_request_methods = configs.SelectList(
         allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH"], default=["POST"]
     )
 
     """
     The request method(s) to use to route to the update operation.  Default is ["PATCH"].
     """
-    update_request_methods = clearskies.configs.SelectList(
+    update_request_methods = configs.SelectList(
         allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH"], default=["PATCH"]
     )
 
     """
     The request method(s) to use to route to the delete operation.  Default is ["DELETE"].
     """
-    delete_request_methods = clearskies.configs.SelectList(
+    delete_request_methods = configs.SelectList(
         allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH"], default=["DELETE"]
     )
 
     """
     The request method(s) to use to route to the get operation.  Default is ["GET"].
     """
-    get_request_methods = clearskies.configs.SelectList(
-        allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH"], default=["GET"]
-    )
+    get_request_methods = configs.SelectList(allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH"], default=["GET"])
 
     """
     The request method(s) to use to route to the create operation.  Default is ["GET"].
     """
-    list_request_methods = clearskies.configs.SelectList(
+    list_request_methods = configs.SelectList(
         allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH", "QUERY"], default=["GET", "POST", "QUERY"]
     )
 
     """
     The request method(s) to use to route to the create operation.  Default is ["POST"].
     """
-    id_column_name = clearskies.configs.ModelColumn("model_class", default=None)
+    id_column_name = configs.ModelColumn("model_class", default=None)
 
     """
     The base URL to be used for all the endpoints.
     """
-    url = clearskies.configs.String(default="")
-
-    authentication = clearskies.configs.Authentication(default=Public())
-    authorization = clearskies.configs.Authorization(default=Authorization())
-    output_map = clearskies.configs.Callable(default=None)
-    output_schema = clearskies.configs.Schema(default=None)
-    model_class = clearskies.configs.ModelClass(default=None)
-    readable_column_names = clearskies.configs.ReadableModelColumns("model_class", default=[])
-    writeable_column_names = clearskies.configs.WriteableModelColumns("model_class", default=[])
-    searchable_column_names = clearskies.configs.SearchableModelColumns("model_class", default=[])
-    sortable_column_names = clearskies.configs.ReadableModelColumns("model_class", default=[])
-    default_sort_column_name = clearskies.configs.ModelColumn("model_class", required=True)
-    default_sort_direction = clearskies.configs.Select(["ASC", "DESC"], default="ASC")
-    default_limit = clearskies.configs.Integer(default=50)
-    maximum_limit = clearskies.configs.Integer(default=200)
-    group_by_column_name = clearskies.configs.ModelColumn("model_class")
-    input_validation_callable = clearskies.configs.Callable(default=None)
-    include_routing_data_in_request_data = clearskies.configs.Boolean(default=False)
-    column_overrides = clearskies.configs.Columns(default={})
-    internal_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
-    external_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
-    security_headers = clearskies.configs.SecurityHeaders(default=[])
-    description = clearskies.configs.String(default="")
-    where = clearskies.configs.Conditions(default=[])
+    url = configs.String(default="")
+
+    authentication = configs.Authentication(default=Public())
+    authorization = configs.Authorization(default=Authorization())
+    output_map = configs.Callable(default=None)
+    output_schema = configs.Schema(default=None)
+    model_class = configs.ModelClass(default=None)
+    readable_column_names = configs.ReadableModelColumns("model_class", default=[])
+    writeable_column_names = configs.WriteableModelColumns("model_class", default=[])
+    searchable_column_names = configs.SearchableModelColumns("model_class", default=[])
+    sortable_column_names = configs.ReadableModelColumns("model_class", default=[])
+    default_sort_column_name = configs.ModelColumn("model_class", required=True)
+    default_sort_direction = configs.Select(["ASC", "DESC"], default="ASC")
+    default_limit = configs.Integer(default=50)
+    maximum_limit = configs.Integer(default=200)
+    group_by_column_name = configs.ModelColumn("model_class")
+    input_validation_callable = configs.Callable(default=None)
+    include_routing_data_in_request_data = configs.Boolean(default=False)
+    column_overrides = configs.Columns(default={})
+    internal_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    external_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    security_headers = configs.SecurityHeaders(default=[])
+    description = configs.String(default="")
+    where = configs.Conditions(default=[])
     _descriptor_config_map = None
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],
@@ -303,11 +293,11 @@ class RestfulApi(EndpointGroup):
         sortable_column_names: list[str],
         default_sort_column_name: str,
         read_only: bool = False,
-        create_endpoint: Endpoint | None = Create,
-        delete_endpoint: Endpoint | None = Delete,
-        update_endpoint: Endpoint | None = Update,
-        get_endpoint: Endpoint | None = Get,
-        list_endpoint: Endpoint | None = SimpleSearch,
+        create_endpoint: type[Endpoint] | None = Create,
+        delete_endpoint: type[Endpoint] | None = Delete,
+        update_endpoint: type[Endpoint] | None = Update,
+        get_endpoint: type[Endpoint] | None = Get,
+        list_endpoint: type[Endpoint] | None = SimpleSearch,
         create_request_methods: list[str] = ["POST"],
         update_request_methods: list[str] = ["PATCH"],
         delete_request_methods: list[str] = ["DELETE"],

clearskies/endpoints/schema.py

@@ -1,25 +1,19 @@
 from __future__ import annotations
 
-import inspect
-from collections import OrderedDict
-from typing import TYPE_CHECKING, Any, Callable, Type
-
-import clearskies.autodoc
-import clearskies.configs
-import clearskies.exceptions
-from clearskies import authentication, autodoc, typing
-from clearskies.authentication import Authentication, Authorization
+from typing import TYPE_CHECKING, Any, Callable
+
+from clearskies import authentication, autodoc, configs, decorators
 from clearskies.endpoint import Endpoint
-from clearskies.input_outputs import InputOutput
 
 if TYPE_CHECKING:
-    from clearskies import Column, SecurityHeader
-    from clearskies.model import Model
+    from clearskies import SecurityHeader
+    from clearskies.authentication import Authentication
+    from clearskies.input_outputs import InputOutput
 
 
 class Schema(Endpoint):
     """
-    An endpoint that automatically creates a swagger doc for the application
+    An endpoint that automatically creates a swagger doc for the application.
 
     The schema endpoint must always be attached to an endpoint group.  It will document all endpoints
     attached to its parent endpoint group.
@@ -74,11 +68,12 @@ class Schema(Endpoint):
                 sortable_column_names=readable_column_names,
                 searchable_column_names=readable_column_names,
                 default_sort_column_name="name",
-            )
+            ),
         ],
         url="/users",
     )
 
+
     class SomeThing(clearskies.Model):
         id_column_name = "id"
         backend = clearskies.backends.MemoryBackend()
@@ -87,6 +82,7 @@ class Schema(Endpoint):
         thing_1 = clearskies.columns.String(validators=[Required()])
         thing_2 = clearskies.columns.String(validators=[Unique()])
 
+
     more_endpoints = clearskies.EndpointGroup(
         [
             clearskies.endpoints.HealthCheck(url="health"),
@@ -130,7 +126,7 @@ class Schema(Endpoint):
     """
     The doc builder class/format to use
     """
-    schema_format = clearskies.configs.Any(default=clearskies.autodoc.formats.oai3_json.Oai3Json)
+    schema_format = configs.Any(default=autodoc.formats.oai3_json.Oai3Json)
 
     """
     Addiional data to inject into the schema doc.
@@ -138,13 +134,13 @@ class Schema(Endpoint):
     This is typically used for setting info/server settings in the resultant swagger doc.  Anything
     in this dictionary is injected into the "root" of the generated documentation file.
     """
-    schema_configuration = clearskies.configs.AnyDict(default={})
+    schema_configuration = configs.AnyDict(default={})
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         url: str,
-        schema_format=clearskies.autodoc.formats.oai3_json.Oai3Json,
+        schema_format=autodoc.formats.oai3_json.Oai3Json,
         request_methods: list[str] = ["GET"],
         response_headers: list[str | Callable[..., list[str]]] = [],
         security_headers: list[SecurityHeader] = [],

clearskies/endpoints/simple_search.py

@@ -1,19 +1,12 @@
 from __future__ import annotations
 
-import inspect
-from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable
 
-import clearskies.configs
-import clearskies.exceptions
-from clearskies import authentication, autodoc, typing
+from clearskies import authentication, autodoc, decorators, exceptions
 from clearskies.endpoints.list import List
-from clearskies.functional import string
-from clearskies.input_outputs import InputOutput
 
 if TYPE_CHECKING:
-    from clearskies import Column, Schema, SecurityHeader
-    from clearskies.model import Model
+    from clearskies import Column, Model, Schema, SecurityHeader, typing
 
 
 class SimpleSearch(List):
@@ -194,7 +187,7 @@ class SimpleSearch(List):
     ```
     """
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],
@@ -233,7 +226,7 @@ class SimpleSearch(List):
                 if column_name in self.allowed_request_keys and column_name not in self.searchable_column_names:
                     continue
                 if column_name not in self.searchable_column_names:
-                    raise clearskies.exceptions.ClientError(
+                    raise exceptions.ClientError(
                         f"Invalid request parameter found in {input_source_label}: '{column_name}'"
                     )
                 [relationship_column_name, final_column_name] = self.unpack_column_name_with_relationship(column_name)
@@ -242,7 +235,7 @@ class SimpleSearch(List):
                     value, relationship_reference=final_column_name
                 )
                 if value_error:
-                    raise clearskies.exceptions.InputErrors({column_name: value_error})
+                    raise exceptions.InputErrors({column_name: value_error})
 
     def configure_model_from_request_data(
         self,

clearskies/endpoints/update.py

@@ -1,19 +1,14 @@
 from __future__ import annotations
 
-import inspect
-from collections import OrderedDict
-from typing import TYPE_CHECKING, Any, Callable, Type
+from typing import TYPE_CHECKING, Any, Callable
 
-import clearskies.configs
-import clearskies.exceptions
-from clearskies import authentication, autodoc, typing
+from clearskies import authentication, autodoc, decorators, exceptions
 from clearskies.endpoints.get import Get
-from clearskies.functional import routing, string
+from clearskies.functional import string
 from clearskies.input_outputs import InputOutput
 
 if TYPE_CHECKING:
-    from clearskies import SecurityHeader
-    from clearskies.model import Column, Model, Schema
+    from clearskies import Column, Model, Schema, SecurityHeader, typing
 
 
 class Update(Get):
@@ -90,7 +85,7 @@ class Update(Get):
     }
     """
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         model_class: type[Model],
@@ -124,7 +119,7 @@ class Update(Get):
     def handle(self, input_output: InputOutput) -> Any:
         request_data = self.get_request_data(input_output)
         if not request_data and input_output.has_body():
-            raise clearskies.exceptions.ClientError("Request body was not valid JSON")
+            raise exceptions.ClientError("Request body was not valid JSON")
         model = self.fetch_model(input_output)
         self.validate_input_against_schema(request_data, input_output, model)
         model.save(request_data)

clearskies/environment.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os.path
 from typing import Any
 

clearskies/input_outputs/cli.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 import sys
 from os import isatty

clearskies/input_outputs/headers.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 

clearskies/input_outputs/input_output.py

@@ -1,38 +1,38 @@
+from __future__ import annotations
+
 import json
 from abc import ABC, abstractmethod
-from typing import Any
+from typing import TYPE_CHECKING, Any
 from urllib.parse import parse_qs
 
-import clearskies.configurable
-import clearskies.typing
-from clearskies.configs import AnyDict, StringDict
-from clearskies.exceptions import ClientError
+from clearskies import configs, configurable, input_outputs
 
-from .headers import Headers
+if TYPE_CHECKING:
+    from clearskies import typing
 
 
-class InputOutput(ABC, clearskies.configurable.Configurable):
+class InputOutput(ABC, configurable.Configurable):
     """Manage the request and response to the client."""
 
-    response_headers: Headers = None  # type: ignore
-    request_headers: Headers = None  # type: ignore
-    query_parameters = clearskies.configs.AnyDict(default={})
-    routing_data = clearskies.configs.StringDict(default={})
-    authorization_data = clearskies.configs.AnyDict(default={})
+    response_headers: input_outputs.Headers = None  # type: ignore
+    request_headers: input_outputs.Headers = None  # type: ignore
+    query_parameters = configs.AnyDict(default={})
+    routing_data = configs.StringDict(default={})
+    authorization_data = configs.AnyDict(default={})
 
     _body_as_json: dict[str, Any] | list[Any] | None = {}
     _body_loaded_as_json = False
 
     def __init__(self):
-        self.response_headers = Headers()
-        self.request_headers = Headers(self.get_request_headers())
+        self.response_headers = input_outputs.Headers()
+        self.request_headers = input_outputs.Headers(self.get_request_headers())
         self.query_parameters = {key: val[0] for (key, val) in parse_qs(self.get_query_string()).items()}
         self.authorization_data = {}
         self.routing_data = {}
         self.finalize_and_validate_configuration()
 
     @abstractmethod
-    def respond(self, body: clearskies.typing.response, status_code: int = 200) -> Any:
+    def respond(self, body: typing.response, status_code: int = 200) -> Any:
         """
         Pass along a response to the client.
 

clearskies/input_outputs/programmatic.py

@@ -1,9 +1,9 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.input_outputs.input_output import InputOutput
 
-from .headers import Headers
-
 
 class Programmatic(InputOutput):
     _body: str | dict[str, Any] | list[Any] = ""

clearskies/input_outputs/wsgi.py

@@ -1,6 +1,6 @@
+from __future__ import annotations
+
 import json
-import urllib
-import urllib.parse
 from typing import Callable
 
 from .input_output import InputOutput