detquantlib 5.9.2__tar.gz → 5.10.1__tar.gz

{detquantlib-5.9.2 → detquantlib-5.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detquantlib
-Version: 5.9.2
+Version: 5.10.1
 Summary: An internal library containing functions and classes that can be used across Quant models.
 License-File: LICENSE.txt
 Author: Dynamic Energy Trading

{detquantlib-5.9.2 → detquantlib-5.10.1}/detquantlib/data/databases/snowflake_client.py

@@ -33,6 +33,7 @@ class SnowflakeConfig:
 
     Exactly one authentication method is used, chosen in this order of precedence:
     - ``private_key_path`` (i.e. key-pair)
+    - ``token`` (i.e. programmatic access token)
     - ``authenticator`` (e.g. SSO)
     - ``password``
 
@@ -40,6 +41,7 @@ class SnowflakeConfig:
         account: Snowflake account identifier, e.g. ``"xy12345.eu-west-1"``.
         user: Login name of the Snowflake user.
         password: Password for password authentication.
+        token: Programmatic access token (PAT) for token authentication.
         warehouse: Default virtual warehouse for the session.
         database: Default database for the session.
         schema: Default schema for the session.
@@ -53,6 +55,7 @@ class SnowflakeConfig:
     account: Optional[str] = None
     user: Optional[str] = None
     password: Optional[str] = None
+    token: Optional[str] = None
     warehouse: Optional[str] = None
     database: Optional[str] = None
     schema: Optional[str] = None
@@ -68,10 +71,10 @@ class SnowflakeConfig:
         Builds a config from environment variables.
 
         Reads variables named ``<prefix><FIELD>``, e.g. ``SNOWFLAKE_ACCOUNT``, ``SNOWFLAKE_USER``,
-        ``SNOWFLAKE_PASSWORD``, ``SNOWFLAKE_WAREHOUSE``, ``SNOWFLAKE_DATABASE``,
-        ``SNOWFLAKE_SCHEMA``, ``SNOWFLAKE_ROLE``, ``SNOWFLAKE_AUTHENTICATOR``,
-        ``SNOWFLAKE_PRIVATE_KEY_PATH`` and ``SNOWFLAKE_PRIVATE_KEY_PASSPHRASE``. Unset variables
-        become ``None``.
+        ``SNOWFLAKE_PASSWORD``, ``SNOWFLAKE_TOKEN``, ``SNOWFLAKE_WAREHOUSE``,
+        ``SNOWFLAKE_DATABASE``, ``SNOWFLAKE_SCHEMA``, ``SNOWFLAKE_ROLE``,
+        ``SNOWFLAKE_AUTHENTICATOR``, ``SNOWFLAKE_PRIVATE_KEY_PATH`` and
+        ``SNOWFLAKE_PRIVATE_KEY_PASSPHRASE``. Unset variables become ``None``.
 
         Args:
             prefix: Prefix prepended to each variable name.
@@ -84,6 +87,7 @@ class SnowflakeConfig:
             account=g("ACCOUNT"),
             user=g("USER"),
             password=g("PASSWORD"),
+            token=g("TOKEN"),
             warehouse=g("WAREHOUSE"),
             database=g("DATABASE"),
             schema=g("SCHEMA"),
@@ -147,8 +151,8 @@ class SnowflakeClient:
         """
         Builds the keyword arguments for ``snowflake.connector.connect``.
 
-        Selects a single authentication method (key-pair, authenticator or password, in that order)
-        and drops any parameters that are ``None``.
+        Selects a single authentication method (key-pair, programmatic access token, authenticator
+        or password, in that order) and drops any parameters that are ``None``.
 
         Returns:
             A dict of connection parameters.
@@ -174,13 +178,16 @@ class SnowflakeClient:
             params["private_key"] = self._load_private_key(
                 c.private_key_path, c.private_key_passphrase
             )
+        elif c.token:
+            params["authenticator"] = "PROGRAMMATIC_ACCESS_TOKEN"
+            params["token"] = c.token
         elif c.authenticator:
             params["authenticator"] = c.authenticator
         elif c.password:
             params["password"] = c.password
         else:
             raise ValueError(
-                "No credentials provided: set password, private_key_path, or authenticator."
+                "No credentials provided: set password, token, private_key_path, or authenticator."
             )
 
         return {k: v for k, v in params.items() if v is not None}
@@ -279,7 +286,9 @@ class SnowflakeClient:
         Args:
             sql: The SQL statement to execute.
             params: Values bound to the placeholders in ``sql``: a sequence for positional ``%s``
-                placeholders, or a dict for named ``%(name)s`` placeholders.
+                placeholders, or a dict for named ``%(name)s`` placeholders. pandas Timestamps
+                are converted to Python datetimes (and ``NaT`` to ``None``), since the connector
+                cannot bind them.
             lowercase_columns: If ``True``, column names in the result are converted to lowercase
                 (Snowflake returns them uppercase by default).
 
@@ -292,7 +301,7 @@ class SnowflakeClient:
         conn = self.connect()
         try:
             with conn.cursor() as cur:
-                cur.execute(sql, params)
+                cur.execute(sql, self._prepare_params(params))
                 df = cur.fetch_pandas_all()
         except SnowflakeError as e:
             logger.error("Query failed: %s", e)
@@ -322,7 +331,7 @@ class SnowflakeClient:
         """
         conn = self.connect()
         with conn.cursor() as cur:
-            cur.execute(sql, params)
+            cur.execute(sql, self._prepare_params(params))
             for batch in cur.fetch_pandas_batches():
                 yield batch
 
@@ -485,7 +494,7 @@ class SnowflakeClient:
         conn = self.connect()
         try:
             with conn.cursor() as cur:
-                cur.execute(sql, params)
+                cur.execute(sql, self._prepare_params(params))
                 rowcount = cur.rowcount
         except SnowflakeError as e:
             logger.error("Statement failed: %s", e)
@@ -493,6 +502,39 @@ class SnowflakeClient:
         logger.info("Statement affected %s rows", rowcount)
         return rowcount
 
+    @staticmethod
+    def _prepare_params(
+        params: Optional[Union[Sequence[Any], dict[str, Any]]],
+    ) -> Optional[Union[tuple[Any, ...], dict[str, Any]]]:
+        """
+        Converts parameter values that the Snowflake connector cannot bind.
+
+        The connector picks a converter by type name, so it rejects pandas Timestamps even though
+        they are datetime subclasses. They are converted to Python datetimes, and ``NaT`` to
+        ``None``. Note that Python datetimes only have microsecond precision, so nanoseconds are
+        dropped (pandas warns when this happens). Other values are passed through unchanged.
+
+        Args:
+            params: Values bound to the placeholders of a query, as in ``query()``.
+
+        Returns:
+            The converted values, as a dict for named placeholders or a tuple for positional
+            ones, or ``None`` if ``params`` is ``None``.
+        """
+        if params is None:
+            return None
+
+        def convert(value: Any) -> Any:
+            if value is pd.NaT:
+                return None
+            if isinstance(value, pd.Timestamp):
+                return value.to_pydatetime()
+            return value
+
+        if isinstance(params, dict):
+            return {k: convert(v) for k, v in params.items()}
+        return tuple(convert(v) for v in params)
+
     @staticmethod
     def _check_identifier(name: str) -> str:
         """

{detquantlib-5.9.2 → detquantlib-5.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "detquantlib"
-version = "5.9.2"
+version = "5.10.1"
 description = "An internal library containing functions and classes that can be used across Quant models."
 authors = ["Dynamic Energy Trading"]
 readme = "README.md"