everysk-lib 1.10.0__cp312-cp312-macosx_11_0_arm64.whl → 1.10.1__cp312-cp312-macosx_11_0_arm64.whl

everysk/core/undefined.py

@@ -10,13 +10,15 @@
 from typing import Any, Self
 
 
-###############################################################################
-#   UndefinedType Class Implementation
-###############################################################################
-#   Do not use this class, use the constant Undefined.
-###############################################################################
+## Do not use this class, use the constant Undefined that is already defined in the python builtins. ##
 class UndefinedType:
-    """ The undefined type, to be used as value for attributes and params and be different from None."""
+    """
+    The UndefinedType class is used to represent an undefined value in the Everysk framework.
+    This class is designed to be immutable and to always represent the same undefined value.
+    We use it as default values for function parameters and class attributes to indicate that
+    the value is not set and to differentiate it from None or other possible values.
+    """
+
     default_error_message = 'This object is immutable.'
     default_parse_string = '__UNDEFINED_VALUE__'
     default_repr_string = '<Undefined value>'
@@ -26,49 +28,43 @@ class UndefinedType:
         if self.block:
             raise NotImplementedError('Do not use this class, use the constant Undefined.')
 
-    def __bool__(self):
-        """ This object is always False """
+    def __bool__(self) -> bool:
+        """Undefined object is always False"""
         return False
 
     def __copy__(self) -> Self:
-        """
-        To keep consistence, this object will always be the same.
-        """
+        """To keep consistence, this object will always be the same."""
         return self
 
-    def __delattr__(self, __name: str) -> None:
-        """ We could not delete attributes from this object. """
+    def __delattr__(self, name: str) -> None:
+        """We could not delete attributes from this object."""
         raise AttributeError(self.default_error_message)
 
-    def __deepcopy__(self, memo: dict = None) -> Self:
-        """
-        To keep consistence, this object will always be the same.
-        """
+    def __deepcopy__(self, memo: dict | None = None) -> Self:
+        """To keep consistence, this object will always be the same."""
         return self
 
-    def __eq__(self, __value: object) -> bool:
-        """
-        For an object created from the UndefinedType class to be equal to another, the classes must be equal.
-        """
-        return isinstance(__value, type(self))
+    def __eq__(self, value: object) -> bool:
+        """For an object created from the UndefinedType class to be equal to another, the classes must be equal."""
+        return isinstance(value, type(self))
 
-    def __getattr__(self, __name: str) -> Any:
-        """ This object don't have attributes. """
+    def __getattr__(self, name: str) -> Any:
+        """Undefined object don't have attributes."""
         raise AttributeError(self.default_error_message)
 
     def __hash__(self) -> int:
-        """ This must return an int that is used as hash for this object. """
+        """Must return an int that is used as hash for this object."""
         return id(self)
 
     def __repr__(self) -> str:
-        """ Fixed to be the same every time. """
+        """Fixed to be the same every time."""
         return self.default_repr_string
 
-    def __setattr__(self, __name: str, __value: Any) -> None:
-        """ We can't set any attribute to this object. """
+    def __setattr__(self, name: str, value: Any) -> None:
+        """We can't set any attribute to this object."""
         if self.block:
             raise AttributeError(self.default_error_message)
 
     def __str__(self) -> str:
-        """ Fixed to be the same every time. """
+        """Fixed to be the same every time."""
         return self.default_repr_string

everysk/sdk/entities/worker_execution/settings.py

@@ -24,7 +24,8 @@ WORKER_EXECUTION_STATUS_COMPLETED = StrField(default='COMPLETED', readonly=True)
 WORKER_EXECUTION_STATUS_FAILED = StrField(default='FAILED', readonly=True)
 WORKER_EXECUTION_STATUS_PREPARING = StrField(default='PREPARING', readonly=True)
 WORKER_EXECUTION_STATUS_RUNNING = StrField(default='RUNNING', readonly=True)
-WORKER_EXECUTION_STATUS_LIST = ListField(default=['COMPLETED', 'FAILED', 'PREPARING', 'RUNNING'], readonly=True)
+WORKER_EXECUTION_STATUS_TIMEOUT = StrField(default='TIMEOUT', readonly=True)
+WORKER_EXECUTION_STATUS_LIST = ListField(default=['COMPLETED', 'FAILED', 'PREPARING', 'RUNNING', 'TIMEOUT'], readonly=True)
 
 WORKER_EXECUTION_INTEGRATION_EVENT_TYPE = StrField(default='INTEGRATION_EVENT', readonly=True)
 WORKER_EXECUTION_SCHEDULER_EVENT_TYPE = StrField(default='SCHEDULER_EVENT', readonly=True)

everysk/sql/connection.py

@@ -45,6 +45,18 @@ class ConnectionPool(_ConnectionPool):
 
 
 class Transaction:
+    """
+    Context manager for PostgreSQL transactions.
+
+    Usage:
+
+        >>> from everysk.sql.connection import Transaction, execute
+        >>> with Transaction():
+        ...     result = execute("SELECT * FROM my_table WHERE id = %s", params={"id": 1})
+        ...     # Perform other database operations within the transaction
+
+    """
+
     ## Private attributes
     _connection: Connection
     _pool: ConnectionPool
@@ -88,6 +100,13 @@ def make_connection_dsn(
     Create a PostgreSQL connection DSN from settings.
     Supports both TCP and Unix socket connections.
     If parameters are provided, they override the settings.
+
+    Args:
+        host (str | None): The database host. If None, uses the setting.
+        port (int | None): The database port. If None, uses the setting.
+        user (str | None): The database user. If None, uses the setting.
+        password (str | None): The database password. If None, uses the setting.
+        database (str | None): The database name. If None, uses the setting.
     """
     options: dict[str, str | int] = {
         'host': host or settings.POSTGRESQL_CONNECTION_HOST,

{everysk_lib-1.10.0.dist-info → everysk_lib-1.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: everysk-lib
-Version: 1.10.0
+Version: 1.10.1
 Summary: Generic lib to share python code on Everysk.
 License-Expression: LicenseRef-Proprietary
 Project-URL: Homepage, https://everysk.com/
@@ -104,9 +104,9 @@ Requires-Dist: httpx==0.28.1; extra == "httpx"
 Provides-Extra: paramiko
 Requires-Dist: bcrypt==4.2.0; extra == "paramiko"
 Requires-Dist: pycparser==2.22; extra == "paramiko"
-Requires-Dist: cffi==1.17.1; extra == "paramiko"
+Requires-Dist: cffi==2.0.0; extra == "paramiko"
 Requires-Dist: cryptography==44.0.1; extra == "paramiko"
-Requires-Dist: pynacl==1.5.0; extra == "paramiko"
+Requires-Dist: pynacl==1.6.2; extra == "paramiko"
 Requires-Dist: paramiko==3.5.0; extra == "paramiko"
 Provides-Extra: everysk-orjson
 Requires-Dist: everysk-orjson==3.11.3; extra == "everysk-orjson"

{everysk_lib-1.10.0.dist-info → everysk_lib-1.10.1.dist-info}/RECORD

@@ -18,7 +18,7 @@ everysk/core/threads.py,sha256=CcL4Nv2Zzdxt1xjo0CbLSttSU29xHgSRiWF_JXr3GAA,7167
 everysk/core/redis.py,sha256=HrG58dc_3EHnti2sBaijcyN8Hq4u3p1zst6-CSK9ySQ,36664
 everysk/core/compress.py,sha256=TRk-ME_UYfD5OQyhISYvwAZLT7IYfjbqWHYEgOuyaFU,10858
 everysk/core/http.py,sha256=9aKkh-M3Sfsg0tZLK_BWnmyZ7AuBdACq4pgy_qZSrXI,27171
-everysk/core/undefined.py,sha256=sNvP9qJJi3TINPSJiIWjqKz4o5DNBBYparoTRrDtJ_0,2757
+everysk/core/undefined.py,sha256=RrL9QbUjxdDSmVIq08WG5uiY00DQE_n8yEuGaNp2tOU,2745
 everysk/core/exceptions.py,sha256=HTMKauc7vSeP77UqgPGw6rmwhEqWAKcGS0wk4oofgEY,14275
 everysk/core/sftp.py,sha256=01_iDxqhcAO3FFKUp-8myV7qtf3I-Mi_cLZ6KrAfsGw,15600
 everysk/core/string.py,sha256=K1BRlRNuhqlI7gdqOi40hjTHuxm1fF-RLqIAwm74eHc,5456
@@ -79,7 +79,7 @@ everysk/sdk/entities/script.py,sha256=_yYsqHgSnEzcmmB9CUJDHPcnlSz8Lgur7I35laqMDI
 everysk/sdk/entities/base.py,sha256=p0oiWs2cUwzop84sE7fuQ5z-ONsuHfkKLj7uZy3LzFs,29298
 everysk/sdk/entities/workflow_execution/settings.py,sha256=Acefis-m7TJmDKxP2OL7B_oZ5qVH-ij2T_XKmfaAwhk,1807
 everysk/sdk/entities/workflow_execution/base.py,sha256=aY0Vzv2KkfHCLO6GTBLnj-iM2wlVwawYAQpvMD59xDw,4065
-everysk/sdk/entities/worker_execution/settings.py,sha256=qDEwWBFpmBamIA_imPZlNPTbYK87cLUoedyuGT4VheE,2933
+everysk/sdk/entities/worker_execution/settings.py,sha256=c0FoAcWes4ZuNE16RutKeMQ4GgaTKA-mapL9zDwMx_M,3021
 everysk/sdk/entities/worker_execution/base.py,sha256=j8xVyDe3ncHRxXcsCnTJeJPZBPtYtH7Jg-W0sF4Cm3w,11059
 everysk/sdk/entities/file/settings.py,sha256=gDTLsbAvVoVdRLoQD1gkDYIJuKZUCdgS0AQv1pilEXM,2198
 everysk/sdk/entities/file/base.py,sha256=gInM4XUvW1qxopVf7iDek76pGeo9on4U1gEo_JpGZSw,7951
@@ -126,12 +126,12 @@ everysk/sql/row_factory.py,sha256=FEtB4d12ACT3Bp6g2k_Ty2p2HpTkPoVqODUS1_kSXys,19
 everysk/sql/query.py,sha256=yO2EoGoUoGace_9BNKN8jeyFV30yCrAhefAvGHqIFE4,14174
 everysk/sql/__init__.py,sha256=lXZAWXrI2tlzw9uvJyThaWnksZqdbemQ2tqe-e7wUiU,413
 everysk/sql/model.py,sha256=syHHTTS4JRTj_2Mu9ugmMu4b6qUY12t3VgfE3hSxYIc,14559
-everysk/sql/connection.py,sha256=PujKm1i5gAvxU_FVT7IDuMb38D52dII52Gk8RI0vC_0,7928
+everysk/sql/connection.py,sha256=l_ksPciTBcj_SOpv4CAxbLDQOJ0CZqqrljWNKOGUj_U,8662
 everysk/sql/utils.py,sha256=Hbk9INEcz12FoBeDvHh9qh0dTSmTCWAn_S1anJOJb1o,4327
 everysk/sql/settings.py,sha256=g5ZVm4Y3fhWGeXgTW6D309waGRBx2S6Ima4nY6ByTZw,2103
-everysk_lib-1.10.0.dist-info/RECORD,,
-everysk_lib-1.10.0.dist-info/WHEEL,sha256=V1loQ6TpxABu1APUg0MoTRBOzSKT5xVc3skizX-ovCU,136
-everysk_lib-1.10.0.dist-info/.gitignore,sha256=0A1r9HzLhR7IQ1rGPjbaW5HC6oIQ7xzVYZ1z1ZaVfmw,183
-everysk_lib-1.10.0.dist-info/top_level.txt,sha256=1s1Lfhd4gXolqzkh-ay3yy-EZKPiKnJfbZwx2fybxyk,14
-everysk_lib-1.10.0.dist-info/METADATA,sha256=3RpbivKO8Wqlqgq4RdNPdHLCy_k-7Iv-b4clbVSWhK8,13081
-everysk_lib-1.10.0.dist-info/licenses/LICENSE.txt,sha256=Q5YxWA62m0TsmpEmHeoRHg4oPu_8ektkZ3FWWm1pQWo,311
+everysk_lib-1.10.1.dist-info/RECORD,,
+everysk_lib-1.10.1.dist-info/WHEEL,sha256=djZycr7yArlwOmjQLxViKzHM1dAcWIH-Lipj4ykTWEE,137
+everysk_lib-1.10.1.dist-info/.gitignore,sha256=0A1r9HzLhR7IQ1rGPjbaW5HC6oIQ7xzVYZ1z1ZaVfmw,183
+everysk_lib-1.10.1.dist-info/top_level.txt,sha256=1s1Lfhd4gXolqzkh-ay3yy-EZKPiKnJfbZwx2fybxyk,14
+everysk_lib-1.10.1.dist-info/METADATA,sha256=zVK_B7vyzT6MjtepROMORkd84Fb7v-VnSwSttB_fVmQ,13080
+everysk_lib-1.10.1.dist-info/licenses/LICENSE.txt,sha256=Q5YxWA62m0TsmpEmHeoRHg4oPu_8ektkZ3FWWm1pQWo,311

{everysk_lib-1.10.0.dist-info → everysk_lib-1.10.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: false
 Tag: cp312-cp312-macosx_11_0_arm64
 Generator: delocate 0.13.0