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

clearskies/columns/category_tree_children.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies import configs
 from clearskies.column import Column
 from clearskies.columns import CategoryTree
@@ -36,7 +36,7 @@ class CategoryTreeChildren(Column):
     is_searchable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         category_tree_column_name: str,

clearskies/columns/created.py

@@ -3,9 +3,10 @@ from __future__ import annotations
 import datetime
 from typing import TYPE_CHECKING, Any
 
+import clearskies.decorators
 import clearskies.di
 import clearskies.typing
-from clearskies import configs, parameters_to_properties  # type: ignore
+from clearskies import configs
 from clearskies.columns.datetime import Datetime
 
 if TYPE_CHECKING:
@@ -67,7 +68,7 @@ class Created(Datetime):
 
     now = clearskies.di.inject.Now()
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         date_format: str = "%Y-%m-%d %H:%M:%S",

clearskies/columns/created_by_authorization_data.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.string import String
@@ -100,7 +100,7 @@ class CreatedByAuthorizationData(String):
 
     _allowed_search_operators = ["=", "in", "is not null", "is null", "like"]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         authorization_data_key_name: str,

clearskies/columns/created_by_header.py

@@ -1,4 +1,4 @@
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.string import String
@@ -83,7 +83,7 @@ class CreatedByHeader(String):
 
     _allowed_search_operators = ["=", "in", "is not null", "is null", "like"]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         header_name: str,

clearskies/columns/created_by_ip.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.string import String
@@ -70,7 +70,7 @@ class CreatedByIp(String):
 
     _allowed_search_operators = ["=", "in", "is not null", "is null", "like"]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         is_readable: bool = True,

clearskies/columns/created_by_routing_data.py

@@ -1,5 +1,6 @@
+import clearskies.decorators
 import clearskies.typing
-from clearskies import configs, parameters_to_properties
+from clearskies import configs
 from clearskies.columns.string import String
 
 
@@ -80,7 +81,7 @@ class CreatedByRoutingData(String):
 
     _allowed_search_operators = ["=", "in", "is not null", "is null", "like"]
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         routing_path_name: str,

clearskies/columns/created_by_user_agent.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import datetime
 from typing import TYPE_CHECKING, Any
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.string import String
@@ -70,7 +70,7 @@ class CreatedByUserAgent(String):
 
     _allowed_search_operators = ["=", "in", "is not null", "is null", "like"]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         is_readable: bool = True,

clearskies/columns/date.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
 import dateparser  # type: ignore
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Datetime as AutoDocDatetime
@@ -102,7 +102,7 @@ class Date(Datetime):
     auto_doc_class: type[AutoDocSchema] = AutoDocDatetime
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         date_format: str = "%Y-%m-%d",
@@ -162,6 +162,10 @@ class Date(Datetime):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: datetime.datetime | datetime.date) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def equals(self, value: str | datetime.datetime | datetime.date) -> Condition:

clearskies/columns/datetime.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
 import dateparser  # type: ignore
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Datetime as AutoDocDatetime
@@ -127,7 +127,7 @@ class Datetime(Column):
     auto_doc_class: type[AutoDocSchema] = AutoDocDatetime
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         date_format: str = "%Y-%m-%d %H:%M:%S",
@@ -204,6 +204,10 @@ class Datetime(Column):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: datetime.datetime) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def equals(self, value: str | datetime.datetime) -> Condition:

clearskies/columns/float.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Number as AutoDocNumber
@@ -75,7 +75,7 @@ class Float(Column):
     auto_doc_class: type[AutoDocSchema] = AutoDocNumber
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         default: float | None = None,
@@ -106,6 +106,10 @@ class Float(Column):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: float) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = float(value)
 
     def from_backend(self, value) -> float:

clearskies/columns/has_many.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Array as AutoDocArray
@@ -382,7 +382,7 @@ class HasMany(Column):
 
     input_output = InputOutput()
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         child_model_class,

clearskies/columns/has_many_self.py

@@ -1,5 +1,5 @@
+import clearskies.decorators
 import clearskies.typing
-from clearskies import parameters_to_properties
 from clearskies.columns.has_many import HasMany
 
 
@@ -20,7 +20,7 @@ class HasManySelf(HasMany):
 
     _descriptor_config_map = None
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         foreign_column_name: str | None = None,

clearskies/columns/integer.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Integer as AutoDocInteger
@@ -77,7 +77,7 @@ class Integer(Column):
 
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         default: int | None = None,
@@ -113,6 +113,10 @@ class Integer(Column):
         return None if value is None else int(value)
 
     def __set__(self, instance, value: int) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def from_backend(self, value) -> int | None:

clearskies/columns/json.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import json
 from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.column import Column
@@ -72,7 +72,7 @@ class Json(Column):
     is_searchable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         default: dict[str, Any] | None = None,
@@ -102,6 +102,10 @@ class Json(Column):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: dict[str, Any]) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def from_backend(self, value) -> dict[str, Any] | list[Any] | None:

clearskies/columns/many_to_many_ids.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Array as AutoDocArray
@@ -173,7 +173,7 @@ class ManyToManyIds(Column):
     is_searchable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         related_model_class,
@@ -258,6 +258,10 @@ class ManyToManyIds(Column):
         return [getattr(model, related_id_column_name) for model in self.get_related_models(instance)]
 
     def __set__(self, instance, value: list[str | int]) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def get_related_models(self, model: Model) -> Model:

clearskies/columns/many_to_many_ids_with_data.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.many_to_many_ids import ManyToManyIds
@@ -149,7 +149,7 @@ class ManyToManyIdsWithData(ManyToManyIds):
     setable = configs.ListAnyDictOrCallable(default=None)  #  type: ignore
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         related_model_class,
@@ -187,6 +187,10 @@ class ManyToManyIdsWithData(ManyToManyIds):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: list[dict[str, Any]]) -> None:  # type: ignore
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def post_save(self, data, model, id):

clearskies/columns/many_to_many_models.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.autodoc.schema import Array as AutoDocArray
@@ -30,7 +30,7 @@ class ManyToManyModels(Column):
     is_searchable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         many_to_many_column_name,
@@ -87,6 +87,10 @@ class ManyToManyModels(Column):
         return self.many_to_many_column.get_related_models(instance)  # type: ignore
 
     def __set__(self, instance, value: Model | list[Model] | list[dict[str, Any]]) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         # we allow a list of models or a model, but if it's a model it may represent a single record or a query.
         # if it's a single record then we want to wrap it in a list so we can iterate over it.
         if hasattr(value, "_data") and value._data:

clearskies/columns/many_to_many_pivots.py

@@ -3,8 +3,9 @@ from __future__ import annotations
 from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, Callable, Self, overload
 
+import clearskies.decorators
 import clearskies.typing
-from clearskies import configs, parameters_to_properties  # type: ignore
+from clearskies import configs
 from clearskies.autodoc.schema import Array as AutoDocArray
 from clearskies.autodoc.schema import Object as AutoDocObject
 from clearskies.column import Column
@@ -30,7 +31,7 @@ class ManyToManyPivots(Column):
     is_searchable = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         many_to_many_column_name,

clearskies/columns/phone.py

@@ -1,8 +1,9 @@
 import re
 from typing import Any, Callable
 
+import clearskies.decorators
 import clearskies.typing
-from clearskies import configs, parameters_to_properties
+from clearskies import configs
 from clearskies.columns.string import String
 
 
@@ -98,7 +99,7 @@ class Phone(String):
     usa_only = configs.Boolean(default=True)
     _descriptor_config_map = None
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         usa_only: bool = True,

clearskies/columns/select.py

@@ -1,7 +1,8 @@
 from typing import Callable
 
+import clearskies.decorators
 import clearskies.typing
-from clearskies import configs, parameters_to_properties
+from clearskies import configs
 from clearskies.columns.string import String
 
 
@@ -67,7 +68,7 @@ class Select(String):
     allowed_values = configs.StringList(required=True)
     _descriptor_config_map = None
 
-    @parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         allowed_values: list[str],

clearskies/columns/string.py

@@ -92,6 +92,10 @@ class String(Column):
         return instance._transformed_data[self.name]
 
     def __set__(self, instance: Model, value: str) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def input_error_for_value(self, value: str, operator: str | None = None) -> str:

clearskies/columns/timestamp.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import datetime
 from typing import TYPE_CHECKING, Any, Callable, Self, Type, overload
 
-import clearskies.parameters_to_properties
+import clearskies.decorators
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.datetime import Datetime
@@ -76,7 +76,7 @@ class Timestamp(Datetime):
     include_microseconds = configs.Boolean(default=False)
     _descriptor_config_map = None
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         include_microseconds: bool = False,
@@ -148,6 +148,10 @@ class Timestamp(Datetime):
         return super().__get__(instance, cls)
 
     def __set__(self, instance, value: datetime.datetime) -> None:
+        # this makes sure we're initialized
+        if "name" not in self._config:  # type: ignore
+            instance.get_columns()
+
         instance._next_data[self.name] = value
 
     def input_error_for_value(self, value: str, operator: str | None = None) -> str:

clearskies/columns/updated.py

@@ -3,8 +3,8 @@ from __future__ import annotations
 import datetime
 from typing import TYPE_CHECKING, Any
 
+import clearskies.decorators
 import clearskies.di
-import clearskies.parameters_to_properties
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.datetime import Datetime
@@ -85,7 +85,7 @@ class Updated(Datetime):
 
     now = clearskies.di.inject.Now()
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         in_utc: bool = True,

clearskies/columns/uuid.py

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
+import clearskies.decorators
 import clearskies.di
-import clearskies.parameters_to_properties
 import clearskies.typing
 from clearskies import configs
 from clearskies.columns.string import String
@@ -65,7 +65,7 @@ class Uuid(String):
 
     uuid = clearskies.di.inject.Uuid()
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         is_readable: bool = True,

clearskies/configs/__init__.py

@@ -56,7 +56,7 @@ class MyConfigurableClass(configs.Configurable):
     age = configs.Integer(required=True)
     property_with_default = configs.String(default="some value")
 
-    @clearskies.parameters_to_properties()
+    @clearskies.decorators()
     def __init__(self, name: str, age: int, optional: string = None):
         self.finalize_and_validate_configuration()
 ```
@@ -80,6 +80,7 @@ from .config import Config
 from .datetime import Datetime
 from .datetime_or_callable import DatetimeOrCallable
 from .endpoint import Endpoint
+from .endpoint_list import EndpointList
 from .float import Float
 from .float_or_callable import FloatOrCallable
 from .integer import Integer
@@ -126,6 +127,8 @@ __all__ = [
     "Config",
     "Datetime",
     "DatetimeOrCallable",
+    "Endpoint",
+    "EndpointList",
     "Float",
     "FloatOrCallable",
     "Joins",

clearskies/configs/config.py

@@ -1,5 +1,8 @@
+from typing import Any
+
+
 class Config:
-    def __init__(self, required=False, default=None):
+    def __init__(self, required: bool = False, default: Any = None):
         self.required = required
         self.default = default
 

clearskies/configs/endpoint_list.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from clearskies.configs import config
+
+if TYPE_CHECKING:
+    from clearskies.endpoint import Endpoint as EndpointBase
+
+
+class EndpointList(config.Config):
+    def __set__(self, instance, value: list[EndpointBase]):
+        if not isinstance(value, list):
+            raise TypeError(
+                f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a parameter that requries a list of endpoints."
+            )
+        for index, item in enumerate(value):
+            if not hasattr(item, "top_level_authentication_and_authorization"):
+                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} when all items in the list should be instances of clearskies.End."
+                )
+        instance._set_config(self, value)
+
+    def __get__(self, instance, parent) -> list[EndpointBase]:
+        if not instance:
+            return self  # type: ignore
+        return instance._get_config(self)

clearskies/contexts/cli.py

@@ -3,5 +3,9 @@ from clearskies.input_outputs import Cli as CliInputOutput
 
 
 class Cli(Context):
+    """
+    Run an application via a CLI command
+    """
+
     def __call__(self):  # type: ignore
         return self.execute_application(CliInputOutput())

clearskies/contexts/context.py

@@ -15,8 +15,21 @@ if TYPE_CHECKING:
 
 
 class Context:
+    """
+    Context: a flexible way to connect applications to hosting strategies.
+    """
+
     di: Di = None  # type: ignore
 
+    """
+    The application to execute.
+
+    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.
+    """
+    application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup = None  # type: ignore
+
     def __init__(
         self,
         application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup,

clearskies/contexts/wsgi.py

@@ -12,5 +12,9 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class Wsgi(Context):
+    """
+    Connect your application to a WSGI server.
+    """
+
     def __call__(self, env, start_response):  # type: ignore
         return self.execute_application(WsgiInputOutput(env, start_response))

clearskies/contexts/wsgi_ref.py

@@ -12,6 +12,10 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class WsgiRef(Context):
+    """
+    Use a built in WSGI server (for development purposes only).
+    """
+
     port: int = 8080
 
     def __init__(

clearskies/{parameters_to_properties.py → decorators.py}

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import inspect
 
 import wrapt  # type: ignore