clear-skies 1.20.3__tar.gz → 1.21.1__tar.gz

{clear_skies-1.20.3 → clear_skies-1.21.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clear-skies
-Version: 1.20.3
+Version: 1.21.1
 Summary: A framework for building backends in the cloud
 Home-page: https://github.com/cmancone/clearskies
 License: MIT
@@ -25,6 +25,7 @@ Requires-Dist: jose (>=1.0.0,<2.0.0) ; extra == "jose"
 Requires-Dist: jwcrypto (>=1.5.6,<2.0.0) ; extra == "jwcrypto"
 Requires-Dist: pymysql (>=1.1.0,<2.0.0) ; extra == "mysql"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: typing-extensions (>=4.12.0,<5.0.0) ; python_version >= "3.10" and python_version < "3.11"
 Project-URL: Repository, https://github.com/cmancone/clearskies
 Description-Content-Type: text/markdown
 

{clear_skies-1.20.3 → clear_skies-1.21.1}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [tool.poetry]
 name = "clear-skies"
-version = "1.20.3"
+version = "1.21.1"
 description = "A framework for building backends in the cloud"
 authors = [
     "Conor Mancone <cmancone@gmail.com>",
@@ -34,6 +34,7 @@ akeyless-cloud-id = {version = "^0.2.3", optional = true}
 pymysql = {version = "^1.1.0", optional = true}
 jose = {version = "^1.0.0", optional = true}
 jwcrypto = {version = "^1.5.6", optional = true}
+typing-extensions = {version = "^4.12.0", python = ">=3.10,<3.11"}
 
 [[tool.poetry.source]]
 name = "PyPI"

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/created.py

@@ -8,8 +8,8 @@ class Created(DateTime):
         "utc",
     ]
 
-    def __init__(self, di, datetime):
-        super().__init__(di)
+    def __init__(self, di, datetime, timezone):
+        super().__init__(di, timezone)
         self.datetime = datetime
 
     @property
@@ -22,5 +22,5 @@ class Created(DateTime):
         if self.config("utc", silent=True):
             now = self.datetime.datetime.now(self.datetime.timezone.utc)
         else:
-            now = self.datetime.datetime.now()
+            now = self.datetime.datetime.now(self._timezone)
         return {**data, self.name: now}

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/created_micro.py

@@ -8,8 +8,8 @@ class CreatedMicro(DateTimeMicro):
         "utc",
     ]
 
-    def __init__(self, di, datetime):
-        super().__init__(di)
+    def __init__(self, di, datetime, timezone):
+        super().__init__(di, timezone)
         self.datetime = datetime
 
     @property
@@ -22,5 +22,5 @@ class CreatedMicro(DateTimeMicro):
         if self.config("utc", silent=True):
             now = self.datetime.datetime.now(self.datetime.timezone.utc)
         else:
-            now = self.datetime.datetime.now()
+            now = self.datetime.datetime.now(self._timezone)
         return {**data, self.name: now}

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/datetime.py

@@ -3,7 +3,6 @@ from datetime import datetime, timezone
 import dateparser
 from ..autodoc.schema import DateTime as AutoDocDateTime
 
-
 class DateTime(Column):
     _auto_doc_class = AutoDocDateTime
     _date_format = "%Y-%m-%d %H:%M:%S"
@@ -14,8 +13,9 @@ class DateTime(Column):
         "default_date",
     ]
 
-    def __init__(self, di):
+    def __init__(self, di, timezone: datetime.tzinfo):
         super().__init__(di)
+        self._timezone = timezone
 
     def _finalize_configuration(self, configuration):
         return {
@@ -33,7 +33,7 @@ class DateTime(Column):
             date = dateparser.parse(value)
         else:
             date = value
-        return date.replace(tzinfo=timezone.utc) if date else None
+        return date.replace(tzinfo=self._timezone) if date else None
 
     def to_backend(self, data):
         if not self.name in data or type(data[self.name]) == str or data[self.name] == None:
@@ -47,7 +47,7 @@ class DateTime(Column):
         return {self.name: datetime.isoformat() if datetime else None}
 
     def build_condition(self, value, operator=None, column_prefix=""):
-        date = dateparser.parse(value).astimezone(timezone.utc).strftime(self.config("date_format"))
+        date = dateparser.parse(value).astimezone(self._timezone).strftime(self.config("date_format"))
         if not operator:
             operator = "="
         return f"{column_prefix}{self.name}{operator}{date}"

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/datetime_micro.py

@@ -1,3 +1,4 @@
+from re import T
 from .datetime import DateTime
 from datetime import datetime, timezone
 import dateparser
@@ -8,5 +9,5 @@ class DateTimeMicro(DateTime):
     _date_format = "%Y-%m-%d %H:%M:%S.%f"
     _default_date = "0000-00-00 00:00:00.000000"
 
-    def __init__(self, di):
-        super().__init__(di)
+    def __init__(self, di, timezone: datetime.tzinfo):
+        super().__init__(di, timezone)

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/timestamp.py

@@ -1,3 +1,4 @@
+import time
 from .datetime import DateTime
 from datetime import datetime, timezone
 import dateparser
@@ -28,16 +29,16 @@ class Timestamp(DateTime):
                 raise ValueError(
                     f"Invalid data was found in the backend for model {self.model_class.__name__} and column {self.name}: a string value was found that is not a timestamp.  It was '{value}'"
                 )
-            date = datetime.fromtimestamp(int(value) / mult)
+            date = datetime.fromtimestamp(int(value) / mult, self._timezone)
         elif isinstance(value, int):
-            date = datetime.fromtimestamp(value / mult)
+            date = datetime.fromtimestamp(value / mult, self._timezone)
         else:
             if not isinstance(value, datetime):
                 raise ValueError(
                     f"Invalid data was found in the backend for model {self.model_class.__name__} and column {self.name}: the value was neither an integer, a string, nor a datetime object"
                 )
             date = value
-        return date.replace(tzinfo=timezone.utc) if date else None
+        return date.replace(tzinfo=self._timezone) if date else None
 
     def to_backend(self, data):
         if not self.name in data or isinstance(data[self.name], int) or data[self.name] == None:

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/updated.py

@@ -1,3 +1,5 @@
+import datetime
+
 from .datetime import DateTime
 
 
@@ -8,8 +10,8 @@ class Updated(DateTime):
         "utc",
     ]
 
-    def __init__(self, di, datetime):
-        super().__init__(di)
+    def __init__(self, di, datetime, timezone: datetime.tzinfo):
+        super().__init__(di, timezone)
         self.datetime = datetime
 
     @property
@@ -20,5 +22,5 @@ class Updated(DateTime):
         if self.config("utc", silent=True):
             now = self.datetime.datetime.now(self.datetime.timezone.utc)
         else:
-            now = self.datetime.datetime.now()
+            now = self.datetime.datetime.now(self._timezone)
         return {**data, self.name: now}

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/column_types/updated_micro.py

@@ -1,3 +1,5 @@
+import datetime
+
 from .datetime_micro import DateTimeMicro
 
 
@@ -8,8 +10,8 @@ class UpdatedMicro(DateTimeMicro):
         "utc",
     ]
 
-    def __init__(self, di, datetime):
-        super().__init__(di)
+    def __init__(self, di, datetime, timezone: datetime.tzinfo):
+        super().__init__(di, timezone)
         self.datetime = datetime
 
     @property
@@ -20,5 +22,5 @@ class UpdatedMicro(DateTimeMicro):
         if self.config("utc", silent=True):
             now = self.datetime.datetime.now(self.datetime.timezone.utc)
         else:
-            now = self.datetime.datetime.now()
+            now = self.datetime.datetime.now(self._timezone)
         return {**data, self.name: now}

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/di/standard_dependencies.py

@@ -138,3 +138,8 @@ class StandardDependencies(DI):
 
     def provide_uuid(self):
         return uuid
+  
+    def provide_timezone(self):
+        """Set the default timezone."""
+        import datetime
+        return datetime.UTC

{clear_skies-1.20.3 → clear_skies-1.21.1}/src/clearskies/model.py

@@ -5,6 +5,10 @@ from .functional import string
 import re
 from .models import Models
 
+try:
+    from typing_extensions import Self
+except ModuleNotFoundError:
+    from typing import Self
 
 class Model(Models):
     _configured_columns = None
@@ -14,14 +18,14 @@ class Model(Models):
     _transformed = None
     id_column_name = "id"
 
-    def __init__(self, backend, columns):
+    def __init__(self: Self, backend, columns):
         super().__init__(backend, columns)
         self._transformed = {}
         self._data = {}
         self._previous_data = None
         self._touched_columns = None
 
-    def model_class(self):
+    def model_class(self: Self) -> type[Self]:
         """
         Return the model class that this models object will find/return instances of
 
@@ -30,7 +34,7 @@ class Model(Models):
         return self.__class__
 
     @classmethod
-    def table_name(cls):
+    def table_name(cls: type[Self]) -> str:
         """Return the name of the table that the model uses for data storage"""
         singular = string.camel_case_to_snake_case(cls.__name__)
         if singular[-1] == "y":
@@ -40,16 +44,16 @@ class Model(Models):
         return f"{singular}s"
 
     @abstractmethod
-    def columns_configuration(self):
+    def columns_configuration(self: Self):
         """Returns an ordered dictionary with the configuration for the columns"""
         pass
 
-    def all_columns(self):
+    def all_columns(self: Self):
         default = OrderedDict([(self.id_column_name, {"class": UUID})])
         default.update(self.columns_configuration())
         return default
 
-    def columns(self, overrides=None):
+    def columns(self: Self, overrides=None):
         # no caching if we have overrides
         if overrides is not None:
             return self._columns.configure(self.all_columns(), self.__class__, overrides=overrides)
@@ -58,13 +62,13 @@ class Model(Models):
             self._configured_columns = self._columns.configure(self.all_columns(), self.__class__)
         return self._configured_columns
 
-    def supports_n_plus_one(self):
+    def supports_n_plus_one(self: Self):
         return self._backend.supports_n_plus_one
 
-    def __getitem__(self, column_name):
+    def __getitem__(self: Self, column_name):
         return self.__getattr__(column_name)
 
-    def __getattr__(self, column_name):
+    def __getattr__(self: Self, column_name):
         # this should be adjusted to only return None for empty records if the column name corresponds
         # to an actual column in the table.
         if not self.exists:
@@ -72,13 +76,13 @@ class Model(Models):
 
         return self.get_transformed_from_data(column_name, self._data)
 
-    def get(self, column_name, silent=False):
+    def get(self: Self, column_name, silent=False):
         if not self.exists:
             return None
 
         return self.get_transformed_from_data(column_name, self._data, silent=silent)
 
-    def get_transformed_from_data(self, column_name, data, cache=True, check_providers=True, silent=False):
+    def get_transformed_from_data(self: Self, column_name, data, cache=True, check_providers=True, silent=False):
         if cache and column_name in self._transformed:
             return self._transformed[column_name]
 
@@ -111,18 +115,18 @@ class Model(Models):
         return value
 
     @property
-    def exists(self):
+    def exists(self: Self) -> bool:
         return True if (self.id_column_name in self._data and self._data[self.id_column_name]) else False
 
     @property
-    def data(self):
+    def data(self: Self):
         return self._data
 
     @data.setter
-    def data(self, data):
+    def data(self: Self, data) -> None:
         self._data = {} if data is None else data
 
-    def save(self, data, columns=None):
+    def save(self: Self, data, columns=None) -> bool:
         """
         Save data to the database and update the model!
 
@@ -168,7 +172,7 @@ class Model(Models):
 
         return True
 
-    def is_changing(self, key, data):
+    def is_changing(self: Self, key, data) -> bool:
         """
         Returns True/False to denote if the given column is being modified by the active save operation
 
@@ -184,7 +188,7 @@ class Model(Models):
 
         return self.__getattr__(key) != data[key]
 
-    def latest(self, key, data):
+    def latest(self: Self, key, data):
         """
         Returns the 'latest' value for a column during the save operation
 
@@ -198,7 +202,7 @@ class Model(Models):
             return data[key]
         return self.__getattr__(key)
 
-    def was_changed(self, key):
+    def was_changed(self: Self, key) -> bool: 
         """Returns True/False to denote if a column was changed in the last save"""
         if self._previous_data is None:
             raise ValueError("was_changed was called before a save was finished - you must save something first")
@@ -221,10 +225,10 @@ class Model(Models):
             return old_value != new_value
         return not columns[key].values_match(old_value, new_value)
 
-    def previous_value(self, key):
+    def previous_value(self: Self, key):
         return self.get_transformed_from_data(key, self._previous_data, cache=False, check_providers=False, silent=True)
 
-    def delete(self, except_if_not_exists=True):
+    def delete(self: Self, except_if_not_exists=True) -> bool:
         if not self.exists:
             if except_if_not_exists:
                 raise ValueError("Cannot delete model that already exists")
@@ -240,7 +244,7 @@ class Model(Models):
         self.post_delete()
         return True
 
-    def columns_pre_save(self, data, columns):
+    def columns_pre_save(self: Self, data, columns):
         """Uses the column information present in the model to make any necessary changes before saving"""
         for column in columns.values():
             data = column.pre_save(data, self)
@@ -258,7 +262,7 @@ class Model(Models):
         """
         return data
 
-    def columns_to_backend(self, data, columns):
+    def columns_to_backend(self: Self, data, columns):
         backend_data = {**data}
         temporary_data = {}
         for column in columns.values():
@@ -275,10 +279,10 @@ class Model(Models):
 
         return [backend_data, temporary_data]
 
-    def to_backend(self, data, columns):
+    def to_backend(self: Self, data, columns):
         return data
 
-    def columns_post_save(self, data, id, columns):
+    def columns_post_save(self: Self, data, id, columns):
         """Uses the column information present in the model to make additional changes as needed after saving"""
         for column in columns.values():
             data = column.post_save(data, self, id)
@@ -288,12 +292,12 @@ class Model(Models):
                 )
         return data
 
-    def columns_save_finished(self, columns):
+    def columns_save_finished(self: Self, columns):
         """Calls the save_finished method on all of our columns"""
         for column in columns.values():
             column.save_finished(self)
 
-    def post_save(self, data, id):
+    def post_save(self: Self, data, id):
         """
         A hook to extend so you can provide additional pre-save logic as needed
 
@@ -302,7 +306,7 @@ class Model(Models):
         """
         pass
 
-    def pre_save(self, data):
+    def pre_save(self: Self, data):
         """
         A hook to extend so you can provide additional pre-save logic as needed
 
@@ -310,7 +314,7 @@ class Model(Models):
         """
         return data
 
-    def save_finished(self):
+    def save_finished(self: Self):
         """
         A hook to extend so you can provide additional logic after a save operation has fully completed
 
@@ -320,29 +324,29 @@ class Model(Models):
         """
         pass
 
-    def columns_pre_delete(self, columns):
+    def columns_pre_delete(self: Self, columns):
         """Uses the column information present in the model to make any necessary changes before deleting"""
         for column in columns.values():
             column.pre_delete(self)
 
-    def pre_delete(self):
+    def pre_delete(self: Self):
         """
         A hook to extend so you can provide additional pre-delete logic as needed
         """
         pass
 
-    def columns_post_delete(self, columns):
+    def columns_post_delete(self: Self, columns):
         """Uses the column information present in the model to make any necessary changes after deleting"""
         for column in columns.values():
             column.post_delete(self)
 
-    def post_delete(self):
+    def post_delete(self: Self):
         """
         A hook to extend so you can provide additional post-delete logic as needed
         """
         pass
 
-    def where_for_request(self, models, routing_data, authorization_data, input_output, overrides=None):
+    def where_for_request(self: Self, models, routing_data, authorization_data, input_output, overrides=None):
         """
         A hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler.
         """