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

clearskies/columns/uuid.py

@@ -2,14 +2,11 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
-import clearskies.decorators
-import clearskies.di
-import clearskies.typing
-from clearskies import configs
+from clearskies import configs, decorators, di
 from clearskies.columns.string import String
 
 if TYPE_CHECKING:
-    from clearskies import Model
+    from clearskies import Model, typing
 
 
 class Uuid(String):
@@ -63,17 +60,17 @@ class Uuid(String):
     is_writeable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    uuid = clearskies.di.inject.Uuid()
+    uuid = di.inject.Uuid()
 
-    @clearskies.decorators.parameters_to_properties
+    @decorators.parameters_to_properties
     def __init__(
         self,
         is_readable: bool = True,
         is_searchable: bool = True,
         is_temporary: bool = False,
-        on_change_pre_save: clearskies.typing.action | list[clearskies.typing.action] = [],
-        on_change_post_save: clearskies.typing.action | list[clearskies.typing.action] = [],
-        on_change_save_finished: clearskies.typing.action | list[clearskies.typing.action] = [],
+        on_change_pre_save: typing.action | list[typing.action] = [],
+        on_change_post_save: typing.action | list[typing.action] = [],
+        on_change_save_finished: typing.action | list[typing.action] = [],
     ):
         pass
 

clearskies/configs/__init__.py

@@ -79,6 +79,10 @@ from .conditions import Conditions
 from .config import Config
 from .datetime import Datetime
 from .datetime_or_callable import DatetimeOrCallable
+from .email import Email
+from .email_list import EmailList
+from .email_list_or_callable import EmailListOrCallable
+from .email_or_email_list_or_callable import EmailOrEmailListOrCallable
 from .endpoint import Endpoint
 from .endpoint_list import EndpointList
 from .float import Float
@@ -127,6 +131,10 @@ __all__ = [
     "Config",
     "Datetime",
     "DatetimeOrCallable",
+    "Email",
+    "EmailList",
+    "EmailListOrCallable",
+    "EmailOrEmailListOrCallable",
     "Endpoint",
     "EndpointList",
     "Float",

clearskies/configs/any.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any as AnyType
 
 from clearskies.configs import config

clearskies/configs/any_dict.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.configs import config

clearskies/configs/any_dict_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any, Callable
 
 from clearskies.configs import config

clearskies/configs/boolean.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import config
 
 

clearskies/configs/boolean_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Callable
 
 from clearskies.configs import config

clearskies/configs/callable_config.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Callable as CallableType
 
 from clearskies.configs import config

clearskies/configs/config.py

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

clearskies/configs/datetime.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 
 from clearskies.configs import config

clearskies/configs/datetime_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 from typing import Callable
 

clearskies/configs/email.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from clearskies.configs import string
+
+
+class Email(string.String):
+    def __init__(
+        self, required=False, default=None, regexp: str = r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)"
+    ):
+        super().__init__(required=required, default=default, regexp=regexp)

clearskies/configs/email_list.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from clearskies.configs import string_list
+
+
+class EmailList(string_list.StringList):
+    """
+    This is for a configuration that should be a list of strings in email format.
+
+    This is different than StringList, which also accepts a list of strings, but
+    validates that all of those values match the required format.
+    """
+
+    def __init__(
+        self, required=False, default=None, regexp: str = r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)"
+    ):
+        super().__init__(required=required, default=default, regexp=regexp)

clearskies/configs/email_list_or_callable.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from typing import Callable
+
+from clearskies.configs import string_list_or_callable
+
+
+class EmailListOrCallable(string_list_or_callable.StringListOrCallable):
+    """
+    This is for a configuration that should be a list of emails or a callable that returns a list of emails.
+
+    This is different than StringList, which also accepts a list of strings, but
+    validates that all of those values match the email format.
+    """
+
+    def __init__(
+        self, required=False, default=None, regexp: str = r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)"
+    ):
+        super().__init__(required=required, default=default, regexp=regexp)

clearskies/configs/email_or_email_list_or_callable.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from typing import Callable
+
+from clearskies.configs import config
+
+
+class EmailOrEmailListOrCallable(config.Config):
+    """
+    This is for a configuration that should be an email or a list of emails or a callable that returns a list of emails.
+
+    This is a combination of Email and EmailListOrCallable.
+    """
+
+    def __init__(
+        self, required=False, default=None, regexp: str = r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)"
+    ):
+        self.required = required
+        self.default = default
+        self.regexp = regexp
+
+    def __set__(self, instance, value: str | list[str] | Callable[..., list[str]]):
+        if value is None:
+            return
+        if self.regexp:
+            import re
+        if isinstance(value, str):
+            if self.regexp and not re.match(self.regexp, value):
+                error_prefix = self._error_prefix(instance)
+                raise ValueError(
+                    f"{error_prefix} attempt to set a value of '{value}' but this does not match the required regexp: '{self.regexp}'."
+                )
+            value = [value]
+        elif not isinstance(value, list) and not callable(value):
+            error_prefix = self._error_prefix(instance)
+            raise TypeError(
+                f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a parameter that should be a list or a callable"
+            )
+        if isinstance(value, list):
+            if self.regexp:
+                import re
+
+            for index, item in enumerate(value):
+                if not isinstance(item, str):
+                    error_prefix = self._error_prefix(instance)
+                    raise TypeError(
+                        f"{error_prefix} attempt to set a value of type '{item.__class__.__name__}' for item #{index + 1}.  A string was expected."
+                    )
+                if not re.match(self.regexp, item):
+                    error_prefix = self._error_prefix(instance)
+                    raise ValueError(
+                        f"{error_prefix} attempt to set a value of '{item}' for item #{index + 1} but this does not match the required regexp: '{self.regexp}'."
+                    )
+        instance._set_config(self, value)
+
+    def __get__(self, instance, parent) -> list[str] | Callable[..., list[str]]:
+        if not instance:
+            return self  # type: ignore
+        return instance._get_config(self)

clearskies/configs/float.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import config
 
 

clearskies/configs/float_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Callable
 
 from clearskies.configs import config

clearskies/configs/integer.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import config
 
 

clearskies/configs/integer_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Callable
 
 from clearskies.configs import config

clearskies/configs/list_any_dict.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.configs import config

clearskies/configs/list_any_dict_or_callable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any, Callable
 
 from clearskies.configs import config

clearskies/configs/model_column.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import select
 
 

clearskies/configs/model_columns.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import select_list
 
 

clearskies/configs/model_destination_name.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
+
 from clearskies.configs.string import String
-from clearskies.functional import string
 
 
 class ModelDestinationName(String):

clearskies/configs/model_to_id_column.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_column
 from clearskies.functional import string
 

clearskies/configs/readable_model_column.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_column
 
 

clearskies/configs/readable_model_columns.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_columns
 
 

clearskies/configs/searchable_model_columns.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_columns
 
 

clearskies/configs/select.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import string
 
 

clearskies/configs/select_list.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import config
 
 

clearskies/configs/string.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+import re
+
 from clearskies.configs import config
 
 
@@ -14,8 +18,6 @@ class String(config.Config):
                 f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a parameter that requires a string."
             )
         if self.regexp:
-            import re
-
             if not re.match(self.regexp, value):
                 error_prefix = self._error_prefix(instance)
                 raise ValueError(

clearskies/configs/string_dict.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import config
 
 

clearskies/configs/string_list.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+import re
+
 from clearskies.configs import config
 
 
@@ -9,6 +13,11 @@ class StringList(config.Config):
     valdiates that all of those values match against an allow list.
     """
 
+    def __init__(self, required=False, default=None, regexp: str = ""):
+        self.required = required
+        self.default = default
+        self.regexp = regexp
+
     def __set__(self, instance, value: list[str]):
         if value is None:
             return
@@ -16,13 +25,19 @@ class StringList(config.Config):
         if not isinstance(value, list):
             error_prefix = self._error_prefix(instance)
             raise TypeError(
-                f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a list parameter"
+                f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a list of strings parameter."
             )
+
         for index, item in enumerate(value):
             if not isinstance(item, str):
                 error_prefix = self._error_prefix(instance)
                 raise TypeError(
-                    f"{error_prefix} attempt to set a value of type '{item.__class__.__name__}' for item #{index + 1}.  A string was expected."
+                    f"{error_prefix} attempt to set a value of type '{item.__class__.__name__}' for item #{index + 1}. A string was expected."
+                )
+            if self.regexp and not re.match(self.regexp, item):
+                error_prefix = self._error_prefix(instance)
+                raise ValueError(
+                    f"{error_prefix} attempt to set a value of '{item}' for item #{index + 1} but this does not match the required regexp: '{self.regexp}'."
                 )
         instance._set_config(self, value)
 

clearskies/configs/string_list_or_callable.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+import re
 from typing import Callable
 
 from clearskies.configs import config
@@ -11,6 +14,11 @@ class StringListOrCallable(config.Config):
     valdiates that all of those values match against an allow list.
     """
 
+    def __init__(self, required=False, default=None, regexp: str = ""):
+        self.required = required
+        self.default = default
+        self.regexp = regexp
+
     def __set__(self, instance, value: list[str] | Callable[..., list[str]]):
         if value is None:
             return
@@ -27,6 +35,11 @@ class StringListOrCallable(config.Config):
                     raise TypeError(
                         f"{error_prefix} attempt to set a value of type '{item.__class__.__name__}' for item #{index + 1}.  A string was expected."
                     )
+                if self.regexp and not re.match(self.regexp, item):
+                    error_prefix = self._error_prefix(instance)
+                    raise ValueError(
+                        f"{error_prefix} attempt to set a value of '{item}' for item #{index + 1} but this does not match the required regexp: '{self.regexp}'."
+                    )
         instance._set_config(self, value)
 
     def __get__(self, instance, parent) -> list[str] | Callable[..., list[str]]:

clearskies/configs/timedelta.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 
 from clearskies.configs import config

clearskies/configs/timezone.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 
 from clearskies.configs import config

clearskies/configs/url.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import string
 from clearskies.functional import routing
 

clearskies/configs/writeable_model_column.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_column
 
 

clearskies/configs/writeable_model_columns.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from clearskies.configs import model_columns
 
 

clearskies/configurable.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from clearskies.configs import config

clearskies/contexts/cli.py

@@ -4,7 +4,7 @@ from clearskies.input_outputs import Cli as CliInputOutput
 
 class Cli(Context):
     """
-    Run an application via a CLI command
+    Run an application via a CLI command.
 
     This context converts a clearskies application into a CLI command.  Here's a simple example:
 
@@ -12,9 +12,11 @@ class Cli(Context):
     #!/usr/bin/env python
     import clearskies
 
+
     def my_function():
         return "Hello World!"
 
+
     cli = clearskies.contexts.Cli(my_function)
     cli()
     ```
@@ -32,9 +34,11 @@ class Cli(Context):
     #!/usr/bin/env python
     import clearskies
 
+
     def my_function(name):
         return f"Hello {name}!"
 
+
     cli = clearskies.contexts.Cli(
         clearskies.endpoints.Callable(
             my_function,
@@ -59,9 +63,11 @@ class Cli(Context):
     #!/usr/bin/env python
     import clearskies
 
+
     def my_function(name):
         return f"Hello {name}!"
 
+
     cli = clearskies.contexts.Cli(
         clearskies.endpoints.Callable(
             my_function,
@@ -87,9 +93,11 @@ class Cli(Context):
     #!/usr/bin/env python
     import clearskies
 
+
     def my_function(request_data):
         return request_data
 
+
     cli = clearskies.contexts.Cli(
         clearskies.endpoints.Callable(
             my_function,

clearskies/contexts/context.py

@@ -4,20 +4,19 @@ import datetime
 from types import ModuleType
 from typing import TYPE_CHECKING, Any, Callable
 
-import clearskies.endpoint
-import clearskies.endpoint_group
+from clearskies import exceptions
 from clearskies.di import Di
 from clearskies.di.additional_config import AdditionalConfig
 from clearskies.input_outputs import Programmatic
 
 if TYPE_CHECKING:
+    from clearskies.endpoint import Endpoint
+    from clearskies.endpoint_group import EndpointGroup
     from clearskies.input_outputs import InputOutput
 
 
 class Context:
-    """
-    Context: a flexible way to connect applications to hosting strategies.
-    """
+    """Context: a flexible way to connect applications to hosting strategies."""
 
     di: Di = None  # type: ignore
 
@@ -26,13 +25,13 @@ class Context:
 
     This can be a callable, an endpoint, or an endpoint group.  If passed a callable, the callable can request any
     standard or defined dependencies and should return the desired response.  It can also raise any exception from
-    clearskies.exceptions.
+    exceptions.
     """
-    application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup = None  # type: ignore
+    application: Callable | Endpoint | EndpointGroup = None  # type: ignore
 
     def __init__(
         self,
-        application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup,
+        application: Callable | Endpoint | EndpointGroup,
         classes: type | list[type] = [],
         modules: ModuleType | list[ModuleType] = [],
         bindings: dict[str, Any] = {},
@@ -63,17 +62,17 @@ class Context:
                 return input_output.respond(
                     self.di.call_function(self.application, **input_output.get_context_for_callables())
                 )
-            except clearskies.exceptions.ClientError as e:
+            except exceptions.ClientError as e:
                 return input_output.respond(str(e), 400)
-            except clearskies.exceptions.Authentication as e:
+            except exceptions.Authentication as e:
                 return input_output.respond(str(e), 401)
-            except clearskies.exceptions.Authorization as e:
+            except exceptions.Authorization as e:
                 return input_output.respond(str(e), 403)
-            except clearskies.exceptions.NotFound as e:
+            except exceptions.NotFound as e:
                 return input_output.respond(str(e), 404)
-            except clearskies.exceptions.MovedPermanently as e:
+            except exceptions.MovedPermanently as e:
                 return input_output.respond(str(e), 302)
-            except clearskies.exceptions.MovedTemporarily as e:
+            except exceptions.MovedTemporarily as e:
                 return input_output.respond(str(e), 307)
 
     def __call__(

clearskies/contexts/wsgi.py

@@ -1,14 +1,11 @@
-import datetime
-from types import ModuleType
-from typing import Any, Callable
-from wsgiref.simple_server import make_server
-from wsgiref.util import setup_testing_defaults
-
-import clearskies.endpoint
-import clearskies.endpoint_group
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from clearskies.contexts.context import Context
-from clearskies.di import AdditionalConfig
-from clearskies.input_outputs import Wsgi as WsgiInputOutput
+
+if TYPE_CHECKING:
+    from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class Wsgi(Context):
@@ -24,11 +21,14 @@ class Wsgi(Context):
     ```
     import clearskies
 
+
     def hello_world():
         return "Hello World!"
 
+
     wsgi = clearskies.contexts.Wsgi(hello_world)
 
+
     def application(environment, start_response):
         return wsgi(environment, start_response)
     ```
@@ -52,9 +52,11 @@ class Wsgi(Context):
     ```
     import clearskies
 
+
     def hello_world():
         return "Hello World!"
 
+
     def application(environment, start_response):
         wsgi = clearskies.contexts.Wsgi(hello_world)
         return wsgi(environment, start_response)