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

clearskies/query/query.py

@@ -99,13 +99,13 @@ class Query:
         """Return the properties of this query as a dictionary so it can be used as kwargs when creating another one."""
         return {
             "model_class": self.model_class,
-            "conditions": self.conditions,
-            "joins": self.joins,
-            "sorts": self.sorts,
+            "conditions": [*self.conditions],
+            "joins": [*self.joins],
+            "sorts": [*self.sorts],
             "limit": self.limit,
             "group_by": self.group_by,
             "pagination": self.pagination,
-            "selects": self.selects,
+            "selects": [*self.selects],
             "select_all": self.select_all,
         }
 

clearskies/security_header.py

@@ -2,6 +2,13 @@ from clearskies.configurable import Configurable
 
 
 class SecurityHeader(Configurable):
+    """
+    Attach all the various security headers to endpoints.
+
+    The security header classes can be attached directly to both endpoints and endpoint groups and
+    are used to set all the various security headers.
+    """
+
     is_cors = False
 
     def set_headers_for_input_output(self, input_output):

clearskies/security_headers/cache_control.py

@@ -1,5 +1,5 @@
 import clearskies.configs
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies.security_header import SecurityHeader
 
 
@@ -32,7 +32,7 @@ class CacheControl(SecurityHeader):
         "public",
     ]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         max_age: int | None = None,

clearskies/security_headers/cors.py

@@ -1,5 +1,5 @@
 import clearskies.configs
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies.security_header import SecurityHeader
 
 
@@ -12,7 +12,7 @@ class Cors(SecurityHeader):
     expose_headers = clearskies.configs.StringList(default=[])
     is_cors = True
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         credentials: bool = False,

clearskies/security_headers/csp.py

@@ -1,5 +1,5 @@
 import clearskies.configs
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies.security_header import SecurityHeader
 
 
@@ -51,7 +51,7 @@ class Csp(SecurityHeader):
         "navigate_to",
     ]
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         default_src: str = "",

clearskies/security_headers/hsts.py

@@ -1,5 +1,5 @@
 import clearskies.configs
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies.security_header import SecurityHeader
 
 
@@ -7,7 +7,7 @@ class Hsts(SecurityHeader):
     max_age = clearskies.configs.Integer(default=31536000)
     include_sub_domains = clearskies.configs.Boolean()
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(
         self,
         max_age: int = 31536000,

clearskies/validator.py

@@ -11,6 +11,18 @@ if TYPE_CHECKING:
 
 
 class Validator(ABC, configurable.Configurable):
+    """
+    Attach input validation rules to columns!
+
+    The validators provide a way to attach input validation logic to columns.  The columns themselves already
+    provide basic validation (making sure strings are strings, integers are integers, etc...) but these classes
+    allow for more detailed rules.
+
+    It's important to understand that validators only apply to client input, which means that input validation
+    is only enforced by appropriate endpoints.  If you inject a model into a function of your own and execute
+    a save operation with it, validators will **NOT** be checked.
+    """
+
     is_unique = False
     is_required = False
 

clearskies/validators/after_column.py

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING, Any
 import dateparser
 
 import clearskies.configs
-import clearskies.parameters_to_properties
+import clearskies.decorators
 from clearskies.validator import Validator
 
 if TYPE_CHECKING:
@@ -23,7 +23,7 @@ class AfterColumn(Validator):
     """
     allow_equal = clearskies.configs.Boolean(default=False)
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(self, other_column_name: str, allow_equal: bool = False):
         self.other_column_name = other_column_name
         self.allow_equal = allow_equal

clearskies/validators/in_the_future.py

@@ -7,8 +7,8 @@ from typing import TYPE_CHECKING, Any
 import dateparser
 
 import clearskies.configs
+import clearskies.decorators
 import clearskies.di
-import clearskies.parameters_to_properties
 from clearskies.validator import Validator
 
 if TYPE_CHECKING:

clearskies/validators/in_the_past.py

@@ -7,8 +7,8 @@ from typing import TYPE_CHECKING, Any
 import dateparser
 
 import clearskies.configs
+import clearskies.decorators
 import clearskies.di
-import clearskies.parameters_to_properties
 from clearskies.validator import Validator
 
 if TYPE_CHECKING:

clearskies/validators/required.py

@@ -4,7 +4,6 @@ import datetime
 from typing import TYPE_CHECKING, Any
 
 import clearskies.configs
-from clearskies import parameters_to_properties
 from clearskies.validator import Validator
 
 if TYPE_CHECKING:

clearskies/validators/timedelta.py

@@ -7,8 +7,8 @@ from typing import TYPE_CHECKING, Any
 import dateparser
 
 import clearskies.configs
+import clearskies.decorators
 import clearskies.di
-import clearskies.parameters_to_properties
 from clearskies.validator import Validator
 
 if TYPE_CHECKING:
@@ -20,7 +20,7 @@ class Timedelta(Validator, clearskies.di.InjectableProperties):
 
     utcnow = clearskies.di.inject.Utcnow()
 
-    @clearskies.parameters_to_properties.parameters_to_properties
+    @clearskies.decorators.parameters_to_properties
     def __init__(self, timedelta: datetime.timedelta):
         self.finalize_and_validate_configuration()
 

clearskies/validators/unique.py

@@ -4,7 +4,6 @@ import datetime
 from typing import TYPE_CHECKING, Any
 
 import clearskies.configs
-from clearskies import parameters_to_properties
 from clearskies.validator import Validator
 
 if TYPE_CHECKING: