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

clearskies/contexts/wsgi_ref.py

@@ -1,14 +1,18 @@
+from __future__ import annotations
+
 import datetime
 from types import ModuleType
-from typing import Any, Callable
+from typing import TYPE_CHECKING, 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
+
+if TYPE_CHECKING:
+    from clearskies.di import AdditionalConfig
+    from clearskies.endpoint import Endpoint
+    from clearskies.endpoint_group import EndpointGroup
+    from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class WsgiRef(Context):
@@ -26,9 +30,11 @@ class WsgiRef(Context):
     #!/usr/bin/env python
     import clearskies
 
+
     def hello_world(name):
         return f"Hello {name}!"
 
+
     wsgi = clearskies.contexts.WsgiRef(
         clearskies.endpoints.Callable(
             hello_world,
@@ -49,7 +55,7 @@ class WsgiRef(Context):
 
     def __init__(
         self,
-        application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup,
+        application: Callable | Endpoint | EndpointGroup,
         port: int = 8080,
         classes: type | list[type] = [],
         modules: ModuleType | list[ModuleType] = [],

clearskies/decorators.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import inspect
 
-import wrapt  # type: ignore
+import wrapt
 
 
 @wrapt.decorator

clearskies/decorators.pyi

@@ -0,0 +1,10 @@
+# decorators.pyi
+from typing import Any, Callable, TypeVar
+
+# A TypeVar is used to say "whatever kind of function comes in,
+# the same kind of function goes out."
+_F = TypeVar("_F", bound=Callable[..., Any])
+
+# This is the type signature for your decorator.
+# It tells Pylance that it preserves the signature of the function it wraps.
+def parameters_to_properties(wrapped: _F) -> _F: ...

clearskies/di/di.py

@@ -11,7 +11,6 @@ from requests.adapters import HTTPAdapter
 from requests.packages.urllib3.util.retry import Retry  # type: ignore
 
 import clearskies.input_outputs.input_output
-import clearskies.secrets
 from clearskies.di.additional_config import AdditionalConfig
 from clearskies.di.additional_config_auto_import import AdditionalConfigAutoImport
 from clearskies.environment import Environment
@@ -350,9 +349,9 @@ class Di:
         import my_module
 
         di = Di()
-        di.add_modules([
-            my_module
-        ])  # also equivalent: di.add_modules(my_module), or Di(modules=[my_module])
+        di.add_modules(
+            [my_module]
+        )  # also equivalent: di.add_modules(my_module), or Di(modules=[my_module])
 
 
         def my_function(my_class):
@@ -956,6 +955,8 @@ class Di:
         return uuid
 
     def provide_secrets(self):
+        import clearskies.secrets
+
         return clearskies.secrets.Secrets()
 
     def provide_memory_backend_default_data(self):
@@ -964,8 +965,8 @@ class Di:
     def provide_global_table_prefix(self):
         return ""
 
-    def provide_akeyless(self):
-        import akeyless  # type: ignore
+    def provide_akeyles_sdk(self):
+        import akeyless  # type: ignore[import-untyped]
 
         return akeyless
 

clearskies/di/inject/by_class.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/by_name.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/di.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/environment.py

@@ -1,4 +1,4 @@
-import requests
+from __future__ import annotations
 
 from clearskies.di.injectable import Injectable
 from clearskies.environment import Environment as EnvironmentDependency

clearskies/di/inject/now.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/requests.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import requests
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/secrets.py

@@ -1,7 +1,7 @@
-import datetime
+from __future__ import annotations
 
 from clearskies.di.injectable import Injectable
-from clearskies.secrets import Secrets as SecretsHelper
+from clearskies.secrets.secrets import Secrets as SecretsHelper
 
 
 class Secrets(Injectable):

clearskies/di/inject/utcnow.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 
 from clearskies.di.injectable import Injectable

clearskies/di/inject/uuid.py

@@ -1,6 +1,6 @@
-import datetime
+from __future__ import annotations
+
 import types
-import uuid
 
 from clearskies.di.injectable import Injectable
 

clearskies/end.py

@@ -1,17 +1,22 @@
-# type: ignore
 from __future__ import annotations
 
 from abc import ABC
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-    from clearskies.input_output import InputOutput
+    from clearskies import typing
+    from clearskies.input_outputs import InputOutput
 
-from clearskies import exceptions
+from clearskies import configs, configurable, di, exceptions
+from clearskies.authentication import Authorization, Public
 from clearskies.functional import string
 
 
-class End(ABC):
+class End(
+    ABC,
+    configurable.Configurable,
+    di.InjectableProperties,
+):
     """
     DRY for endpoint and endpoint groups.
 
@@ -20,6 +25,24 @@ class End(ABC):
     from the other.
     """
 
+    di = di.inject.Di()
+
+    url = configs.String(required=False, default="")
+
+    authentication = configs.Authentication(default=None)
+
+    authorization = configs.Authorization(default=None)
+
+    internal_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    external_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    response_headers = configs.StringListOrCallable(default=[])
+    authentication = configs.Authentication(default=Public())
+    authorization = configs.Authorization(default=Authorization())
+    security_headers = configs.SecurityHeaders(default=[])
+
+    cors_header: SecurityHeader = None  # type: ignore
+    has_cors: bool = False
+
     def add_url_prefix(self, prefix: str) -> None:
         self.url = (prefix.rstrip("/") + "/" + self.url.lstrip("/")).lstrip("/")
 
@@ -41,7 +64,7 @@ class End(ABC):
                 if not self.authorization.gate(input_output.authorization_data, input_output):
                     raise exceptions.Authorization("Not Authorized")
             except exceptions.ClientError as client_error:
-                raise exception.Authorization(str(client_error))
+                raise exceptions.Authorization(str(client_error))
 
     def __call__(self, input_output: InputOutput) -> Any:
         """
@@ -116,7 +139,7 @@ class End(ABC):
             for index, response_header in enumerate(response_headers):
                 if not isinstance(response_header, str):
                     raise TypeError(
-                        f"Invalid response header in entry #{index + 1}: the header should be a string, but I was given a type of '{header.__class__.__name__}' instead."
+                        f"Invalid response header in entry #{index + 1}: the header should be a string, but I was given a type of '{response_header.__class__.__name__}' instead."
                     )
                 parts = response_header.split(":", 1)
                 if len(parts) != 2:
@@ -127,7 +150,7 @@ class End(ABC):
         for security_header in self.security_headers:
             security_header.set_headers_for_input_output(input_output)
 
-    def respond(self, input_output: InputOutput, response: clearskies.typing.response, status_code: int) -> Any:
+    def respond(self, input_output: InputOutput, response: typing.response, status_code: int) -> Any:
         self.add_response_headers(input_output)
         return input_output.respond(response, status_code)
 
@@ -181,3 +204,18 @@ class End(ABC):
             self.external_casing,
             self.internal_casing,
         )
+
+    def error(self, input_output: InputOutput, message: str, status_code: int) -> Any:
+        """Return a client-side error (e.g. 400)."""
+        return self.respond_json(input_output, {"status": "client_error", "error": message}, status_code)
+
+    def input_errors(self, input_output: InputOutput, errors: dict[str, str], status_code: int = 200) -> Any:
+        """Return input errors to the client."""
+        return self.respond_json(input_output, {"status": "input_errors", "input_errors": errors}, status_code)
+
+    def redirect(self, input_output: InputOutput, location: str, status_code: int) -> Any:
+        """Return a redirect response (e.g. 302)."""
+        return self.respond_json(input_output, {"status": "redirect", "location": location}, status_code)
+
+    def handle(self, input_output: InputOutput) -> Any:
+        raise NotImplementedError()

clearskies/endpoint.py

@@ -3,16 +3,9 @@ from __future__ import annotations
 import inspect
 import urllib.parse
 from collections import OrderedDict
-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.typing
-from clearskies import autodoc, exceptions
+from typing import TYPE_CHECKING, Any, Callable, Optional
+
+from clearskies import autodoc, column, configs, configurable, decorators, di, end, exceptions
 from clearskies.authentication import Authentication, Authorization, Public
 from clearskies.autodoc import schema
 from clearskies.autodoc.request import Parameter, Request
@@ -27,12 +20,12 @@ if TYPE_CHECKING:
 
 
 class Endpoint(
-    clearskies.end.End,  # type: ignore
-    clearskies.configurable.Configurable,
-    clearskies.di.InjectableProperties,
+    end.End,  # type: ignore
+    configurable.Configurable,
+    di.InjectableProperties,
 ):
     """
-    Automating drudgery!
+    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
@@ -47,7 +40,7 @@ class Endpoint(
     """
     The dependency injection container
     """
-    di = clearskies.di.inject.Di()
+    di = di.inject.Di()
 
     """
     Whether or not this endpoint can handle CORS
@@ -57,7 +50,7 @@ class Endpoint(
     """
     The actual CORS header
     """
-    cors_header: Cors | None = None
+    cors_header: Optional[Cors] = None
 
     """
     Set some response headers that should be returned for this endpoint.
@@ -82,7 +75,7 @@ class Endpoint(
     wsgi()
     ```
     """
-    response_headers = clearskies.configs.StringListOrCallable(default=[])
+    response_headers = configs.StringListOrCallable(default=[])
 
     """
     Set the URL for the endpoint
@@ -161,7 +154,7 @@ class Endpoint(
     ```
 
     """
-    url = clearskies.configs.Url(default="")
+    url = configs.Url(default="")
 
     """
     The allowed request methods for this endpoint.
@@ -204,7 +197,7 @@ class Endpoint(
     }
     ```
     """
-    request_methods = clearskies.configs.SelectList(
+    request_methods = configs.SelectList(
         allowed_values=["GET", "POST", "PUT", "DELETE", "PATCH", "QUERY"], default=["GET"]
     )
 
@@ -214,7 +207,7 @@ class Endpoint(
     Use this to attach an instance of `clearskies.authentication.Authentication` to an endpoint, which enforces authentication.
     For more details, see the dedicated documentation section on authentication and authorization. By default, all endpoints are public.
     """
-    authentication = clearskies.configs.Authentication(default=Public())
+    authentication = configs.Authentication(default=Public())
 
     """
     The authorization rules for this endpoint
@@ -222,7 +215,7 @@ class Endpoint(
     Use this to attach an instance of `clearskies.authentication.Authorization` to an endpoint, which enforces authorization.
     For more details, see the dedicated documentation section on authentication and authorization. By default, no authorization is enforced.
     """
-    authorization = clearskies.configs.Authorization(default=Authorization())
+    authorization = configs.Authorization(default=Authorization())
 
     """
     An override of the default model-to-json mapping for endpoints that auto-convert models to json.
@@ -329,7 +322,7 @@ class Endpoint(
     ```
 
     """
-    output_map = clearskies.configs.Callable(default=None)
+    output_map = configs.Callable(default=None)
 
     """
     A schema that describes the expected output to the client.
@@ -338,14 +331,14 @@ class Endpoint(
     Note that this is typically not required - when returning models and relying on clearskies to auto-convert to JSON,
     it will also automatically generate your documentation.
     """
-    output_schema = clearskies.configs.Schema(default=None)
+    output_schema = configs.Schema(default=None)
 
     """
     The model class used by this endpoint.
 
     The endpoint will use this to fetch/save/validate incoming data as needed.
     """
-    model_class = clearskies.configs.ModelClass(default=None)
+    model_class = configs.ModelClass(default=None)
 
     """
     Columns from the model class that should be returned to the client.
@@ -421,7 +414,7 @@ class Endpoint(
 
     ```
     """
-    readable_column_names = clearskies.configs.ReadableModelColumns("model_class", default=[])
+    readable_column_names = configs.ReadableModelColumns("model_class", default=[])
 
     """
     Specifies which columns from a model class can be set by the client.
@@ -486,14 +479,14 @@ class Endpoint(
     ```
 
     """
-    writeable_column_names = clearskies.configs.WriteableModelColumns("model_class", default=[])
+    writeable_column_names = configs.WriteableModelColumns("model_class", default=[])
 
     """
     Columns from the model class that can be searched by the client.
 
     Sets which columns the client is allowed to search (for endpoints that support searching).
     """
-    searchable_column_names = clearskies.configs.SearchableModelColumns("model_class", default=[])
+    searchable_column_names = configs.SearchableModelColumns("model_class", default=[])
 
     """
     A function to call to add custom input validation logic.
@@ -557,7 +550,7 @@ class Endpoint(
     ```
 
     """
-    input_validation_callable = clearskies.configs.Callable(default=None)
+    input_validation_callable = configs.Callable(default=None)
 
     """
     A dictionary with columns that should override columns in the model.
@@ -579,7 +572,7 @@ class Endpoint(
     )
     ```
     """
-    column_overrides = clearskies.configs.Columns(default={})
+    column_overrides = configs.Columns(default={})
 
     """
     Used in conjunction with external_casing to change the casing of the key names in the outputted JSON of the endpoint.
@@ -638,14 +631,14 @@ class Endpoint(
     }
     ```
     """
-    internal_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    internal_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
 
     """
     Used in conjunction with internal_casing to change the casing of the key names in the outputted JSON of the endpoint.
 
     See the docs for `internal_casing` for more details and usage examples.
     """
-    external_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    external_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
 
     """
     Configure standard security headers to be sent along in the response from this endpoint.
@@ -689,19 +682,19 @@ class Endpoint(
     ```
 
     """
-    security_headers = clearskies.configs.SecurityHeaders(default=[])
+    security_headers = configs.SecurityHeaders(default=[])
 
     """
     A description for this endpoint.  This is added to any auto-documentation
     """
-    description = clearskies.configs.String(default="")
+    description = configs.String(default="")
 
     """
     Whether or not the routing data should also be persisted to the model.  Defaults to False.
 
     Note: this is only relevant for handlers that accept request data
     """
-    include_routing_data_in_request_data = clearskies.configs.Boolean(default=False)
+    include_routing_data_in_request_data = configs.Boolean(default=False)
 
     """
     Additional conditions to always add to the results.
@@ -783,7 +776,7 @@ class Endpoint(
     and note that neither Greg nor Ann are returned.  Ann because she doesn't make the grade criteria, and Greg because
     he won't graduate.
     """
-    where = clearskies.configs.Conditions(default=[])
+    where = configs.Conditions(default=[])
 
     """
     Additional joins to always add to the query.
@@ -868,18 +861,18 @@ class Endpoint(
     e.g., the inner join reomves all the students that don't have an entry in the PastRecord model.
 
     """
-    joins = clearskies.configs.Joins(default=[])
+    joins = configs.Joins(default=[])
 
     cors_header: Cors = None  # type: ignore
-    _model: clearskies.model.Model = None  # type: ignore
-    _columns: dict[str, clearskies.column.Column] = None  # type: ignore
-    _readable_columns: dict[str, clearskies.column.Column] = None  # type: ignore
-    _writeable_columns: dict[str, clearskies.column.Column] = None  # type: ignore
-    _searchable_columns: dict[str, clearskies.column.Column] = None  # type: ignore
-    _sortable_columns: dict[str, clearskies.column.Column] = None  # type: ignore
-    _as_json_map: dict[str, clearskies.column.Column] = None  # type: ignore
-
-    @clearskies.decorators.parameters_to_properties
+    _model: Model = None  # type: ignore
+    _columns: dict[str, column.Column] = None  # type: ignore
+    _readable_columns: dict[str, column.Column] = None  # type: ignore
+    _writeable_columns: dict[str, column.Column] = None  # type: ignore
+    _searchable_columns: dict[str, column.Column] = None  # type: ignore
+    _sortable_columns: dict[str, column.Column] = None  # type: ignore
+    _as_json_map: dict[str, column.Column] = None  # type: ignore
+
+    @decorators.parameters_to_properties
     def __init__(
         self,
         url: str = "",
@@ -972,9 +965,6 @@ class Endpoint(
         )
         return self.authorization.filter_model(model, input_output.authorization_data, input_output)
 
-    def handle(self, input_output: InputOutput) -> Any:
-        raise NotImplementedError()
-
     def matches_request(self, input_output: InputOutput, allow_partial=False) -> bool:
         """Whether or not we can handle an incoming request based on URL and request method."""
         # soo..... this excessively duplicates the logic in __call__, but I'm being lazy right now
@@ -1012,20 +1002,14 @@ class Endpoint(
     def failure(self, input_output: InputOutput) -> Any:
         return self.respond_json(input_output, {"status": "failure"}, 500)
 
-    def input_errors(self, input_output: InputOutput, errors: dict[str, str], status_code: int = 200) -> Any:
-        """Return input errors to the client."""
-        return self.respond_json(input_output, {"status": "input_errors", "input_errors": errors}, status_code)
-
-    def error(self, input_output: InputOutput, message: str, status_code: int) -> Any:
-        """Return a client-side error (e.g. 400)."""
-        return self.respond_json(input_output, {"status": "client_error", "error": message}, status_code)
-
     def redirect(self, input_output: InputOutput, location: str, status_code: int) -> Any:
         """Return a redirect."""
         input_output.response_headers.add("content-type", "text/html")
         input_output.response_headers.add("location", location)
         return self.respond(
-            '<meta http-equiv="refresh" content="0; url=' + urllib.parse.quote(location) + '">Redirecting', status_code
+            input_output,
+            '<meta http-equiv="refresh" content="0; url=' + urllib.parse.quote(location) + '">Redirecting',
+            status_code,
         )
 
     def success(
@@ -1053,7 +1037,7 @@ class Endpoint(
 
         return self.respond_json(input_output, response_data, 200)
 
-    def model_as_json(self, model: clearskies.model.Model, input_output: InputOutput) -> dict[str, Any]:
+    def model_as_json(self, model: Model, input_output: InputOutput) -> dict[str, Any]:
         if self.output_map:
             return self.di.call_function(self.output_map, model=model, **input_output.get_context_for_callables())
 
@@ -1070,7 +1054,7 @@ class Endpoint(
                     json[self.auto_case_column_name(key, True)] = value
         return json
 
-    def _build_as_json_map(self, model: clearskies.model.Model) -> dict[str, clearskies.column.Column]:
+    def _build_as_json_map(self, model: Model) -> dict[str, column.Column]:
         conversion_map = {}
         if not self.readable_column_names:
             raise ValueError(

clearskies/endpoint_group.py

@@ -2,10 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Callable, Self
 
-import clearskies.configurable
-import clearskies.di
-import clearskies.end
-from clearskies import exceptions
+from clearskies import configs, configurable, decorators, di, end
 from clearskies.authentication import Authentication, Authorization, Public
 from clearskies.endpoint import Endpoint
 from clearskies.functional import routing
@@ -16,9 +13,9 @@ if TYPE_CHECKING:
 
 
 class EndpointGroup(
-    clearskies.end.End,  # type: ignore
-    clearskies.configurable.Configurable,
-    clearskies.di.InjectableProperties,
+    end.End,  # type: ignore
+    configurable.Configurable,
+    di.InjectableProperties,
 ):
     """
     An endpoint group brings endpoints together: it basically handles routing.
@@ -216,32 +213,32 @@ class EndpointGroup(
     """
     The dependency injection container
     """
-    di = clearskies.di.inject.Di()
+    di = 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="")
+    url = configs.String(default="")
 
     """
     The list of endpoints connected to this endpoint group
     """
-    endpoints = clearskies.configs.EndpointList()
+    endpoints = configs.EndpointList()
 
-    internal_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
-    external_casing = clearskies.configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
-    response_headers = clearskies.configs.StringListOrCallable(default=[])
-    authentication = clearskies.configs.Authentication(default=Public())
-    authorization = clearskies.configs.Authorization(default=Authorization())
-    security_headers = clearskies.configs.SecurityHeaders(default=[])
+    internal_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    external_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="snake_case")
+    response_headers = configs.StringListOrCallable(default=[])
+    authentication = configs.Authentication(default=Public())
+    authorization = configs.Authorization(default=Authorization())
+    security_headers = configs.SecurityHeaders(default=[])
 
     cors_header: SecurityHeader = None  # type: ignore
     has_cors: bool = False
     endpoints_initialized = False
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         endpoints: list[Endpoint | Self],
@@ -325,7 +322,7 @@ class EndpointGroup(
         return self.respond_json(input_output, {"status": "client_error", "error": message}, status_code)
 
     def all_endpoints(self) -> list[Endpoint]:
-        """Returns the full (recursive) list of all endpoints associated with this endpoint group"""
+        """Return the full (recursive) list of all endpoints associated with this endpoint group."""
         all_endpoints: list[Endpoint] = []
         for endpoint in self.endpoints:
             if hasattr(endpoint, "all_endpoints"):