clear-skies 2.0.1__py3-none-any.whl → 2.0.3__py3-none-any.whl

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()
 ```

clearskies/contexts/cli.py

@@ -5,6 +5,112 @@ from clearskies.input_outputs import Cli as CliInputOutput
 class Cli(Context):
     """
     Run an application via a CLI command
+
+    This context converts a clearskies application into a CLI command.  Here's a simple example:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def my_function():
+        return "Hello World!"
+
+    cli = clearskies.contexts.Cli(my_function)
+    cli()
+    ```
+
+    Which you can then run as expected:
+
+    ```
+    $ ./example.py
+    Hello World!
+    ```
+
+    Routing is still supported, with routes and route parameters becoming CLI args:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def my_function(name):
+        return f"Hello {name}!"
+
+    cli = clearskies.contexts.Cli(
+        clearskies.endpoints.Callable(
+            my_function,
+            url="/hello/:name",
+            return_standard_response=False,
+        )
+    )
+    cli()
+    ```
+
+    With a url of `/hello/:name` you would invoke like so:
+
+    ```
+    ./example.py hello Bob
+    Hello Bob!
+    ```
+
+    If the endpoint expects a request method you can provide it by setting the `-X` or `--request_method=`
+    kwargs.  So for tihs example:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def my_function(name):
+        return f"Hello {name}!"
+
+    cli = clearskies.contexts.Cli(
+        clearskies.endpoints.Callable(
+            my_function,
+            url="/hello/:name",
+            request_methods=["POST"],
+        )
+    )
+    cli()
+    ```
+
+    And then calling it successfully:
+
+    ```
+    ./example.py hello Bob --request_method=POST
+
+    ./example.py hello Bob -X POST
+    ```
+
+    You can pass data as a json string with the -d flag or set individual named arguments.  The following
+    example just reflects the request data back to the client:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def my_function(request_data):
+        return request_data
+
+    cli = clearskies.contexts.Cli(
+        clearskies.endpoints.Callable(
+            my_function,
+        )
+    )
+    cli()
+    ```
+
+    And these three calls are identical:
+
+    ```
+    ./example.py -d '{"hello": "world"}'
+
+    echo '{"hello": "world"}' | ./test.py
+
+    ./test.py --hello=world
+    ```
+
+    Although note that the first two are going to be preferred over the third, simply because with the
+    third there's simply no way to specify the type of a variable.  As a result, you may run into issues
+    with strict type checking on endpoints.
     """
 
     def __call__(self):  # type: ignore

clearskies/contexts/context.py

@@ -48,6 +48,7 @@ class Context:
             bindings=bindings,
             additional_configs=additional_configs,
             class_overrides=class_overrides,
+            overrides=overrides,
             now=now,
             utcnow=utcnow,
         )

clearskies/contexts/wsgi.py

@@ -14,6 +14,62 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 class Wsgi(Context):
     """
     Connect your application to a WSGI server.
+
+    The Wsgi context is used to connect a clearskies application to a WSGI server of your choice.  As with all
+    contexts, you first create it and pass in the application (a callable, endpoint, or endpoint group) as well
+    as any dependency injection parameters.  Then, you call the context from inside of the function invoked by
+    your WSGI server, passing along the `environment` and `start_response` variables, and returning the response
+    from the context.  Here's a simple example:
+
+    ```
+    import clearskies
+
+    def hello_world():
+        return "Hello World!"
+
+    wsgi = clearskies.contexts.Wsgi(hello_world)
+
+    def application(environment, start_response):
+        return wsgi(environment, start_response)
+    ```
+
+    You would then launch your WSGI server.  For instance, here's how to launch it with uwsgi, which automatically
+    looks for a function called `application` and treats that as the WSGI starting point:
+
+    ```
+    uwsgi --http :9090 --wsgi-file test.py
+    ```
+
+    You could then:
+
+    ```
+    curl 'http://localhost:9090'
+    ```
+
+    And see the response from this "hello world" app.  Note than in the above example I create the context outside
+    of the application function.  Of course, you can do the opposite:
+
+    ```
+    import clearskies
+
+    def hello_world():
+        return "Hello World!"
+
+    def application(environment, start_response):
+        wsgi = clearskies.contexts.Wsgi(hello_world)
+        return wsgi(environment, start_response)
+    ```
+
+    The difference is that most wsgi servers will cache any objects created outside of the handler function (e.g. `application`
+    in this case).  When you first create the context clearskies will configure and validate any endpoints attached.
+    Also, it will create an instance of the dependency injection container and cache it.  If the context object is created
+    outside of the handler, and the server caches objects in this csae, then this validation will only happen once and
+    the DI cache will store objects in between HTTP calls.  If you create your context inside the handler function, then
+    you'll end up with an empty cache everytime and you'll have slower responses because of clearskies checking the
+    application configuration everytime.  Note that the DI system for clearskies grants you full cache control, so
+    by and large it's normal and expected that you'll persist the cache between requests by creating the context outside
+    of any handler functions.
+
     """
 
     def __call__(self, env, start_response):  # type: ignore

clearskies/contexts/wsgi_ref.py

@@ -14,6 +14,35 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 class WsgiRef(Context):
     """
     Use a built in WSGI server (for development purposes only).
+
+    This context will launch a built-in HTTP server for you, so you can run applications locally
+    without having to install extra dependencies.  Note that this server is not intended for production
+    usage, so this is best used for simple tests/demonstration purposes.  Unlike the WSGI context, where
+    you define the application handler and invoke the context from inside of it (passing along the
+    environment and start_response variables), in this case you simply directly invoke the context to
+    launch the server.  The default port is 8080:
+
+    ```
+    #!/usr/bin/env python
+    import clearskies
+
+    def hello_world(name):
+        return f"Hello {name}!"
+
+    wsgi = clearskies.contexts.WsgiRef(
+        clearskies.endpoints.Callable(
+            hello_world,
+            url="/hello/:name",
+        )
+    )
+    wsgi()
+    ```
+
+    And to invoke it:
+
+    ```
+    curl 'http://localhost:8080/hello/Friend'
+    ```
     """
 
     port: int = 8080