detquantlib 3.13.0__tar.gz → 3.14.1__tar.gz

{detquantlib-3.13.0 → detquantlib-3.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detquantlib
-Version: 3.13.0
+Version: 3.14.1
 Summary: An internal library containing functions and classes that can be used across Quant models.
 License-File: LICENSE.txt
 Author: DET
@@ -21,7 +21,6 @@ Requires-Dist: pyodbc (>=5.2.0,<6.0.0)
 Requires-Dist: python-dotenv (>=1.1.0,<2.0.0)
 Requires-Dist: scipy (>=1.15.2,<2.0.0)
 Requires-Dist: sqlalchemy (>=2.0.43,<3.0.0)
-Project-URL: Repository, https://github.com/Dynamic-Energy-Trading/detquantlib
 Description-Content-Type: text/markdown
 
 # DET Quant Library

{detquantlib-3.13.0 → detquantlib-3.14.1}/detquantlib/data/databases/detdatabase.py

@@ -9,21 +9,36 @@ import pandas as pd
 from dateutil.relativedelta import *
 from sqlalchemy import Engine, create_engine, text
 
+# Internal modules
+from detquantlib.converters import convert_energy
+from detquantlib.data.databases.helpers import list_to_sql_columns, list_to_sql_set
+from detquantlib.utils import list_to_str
+
 
 class DetDatabase:
     """
     A class to easily interact with the DET database, including fetching and processing data.
     """
 
-    def __init__(self, engine: Engine = None, driver: str = "ODBC Driver 18 for SQL Server"):
+    def __init__(
+        self,
+        db_name: str = None,
+        engine: Engine = None,
+        driver: str = "ODBC Driver 18 for SQL Server",
+    ):
         """
         Constructor method.
 
         Args:
+            db_name: Database name. If None, the name is fetched from environment variables.
             engine: Instance of SQLAlchemy engine. If None, the instance is automatically
                 initialized.
             driver: ODBC driver
         """
+        # Store database name if it is provided
+        if db_name:
+            os.environ["DET_DB_NAME"] = db_name
+
         # Only allow object creation if mandatory environment variables exist
         DetDatabase.check_environment_variables()
 
@@ -48,7 +63,7 @@ class DetDatabase:
         for d in required_env_vars:
             if d["name"] not in available_env_vars:
                 required_env_vars_names = [x["name"] for x in required_env_vars]
-                required_env_vars_str = ", ".join(f"'{x}'" for x in required_env_vars_names)
+                required_env_vars_str = list_to_str(required_env_vars_names)
                 raise EnvironmentError(
                     f"The DetDatabase class requires the following environment variables: "
                     f"{required_env_vars_str}. Environment variable '{d['name']}' "
@@ -93,7 +108,7 @@ class DetDatabase:
         """
         try:
             df = pd.read_sql_query(query, con=self.engine)
-        except Exception as e:
+        except Exception:
             # If query fails, close connection before raising the error
             self.terminate_engine()
             raise
@@ -198,10 +213,7 @@ class DetDatabase:
             columns.append("DateTime(UTC)")
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Get commodity information (map code and local timezone)
         # Note: The local timezone is important because ENTSOE provides all prices in the UTC
@@ -415,10 +427,7 @@ class DetDatabase:
             columns.append("DateTime(UTC)")
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Get commodity information (map code and local timezone)
         # Note: The local timezone is important because ENTSOE provides all prices in the UTC
@@ -567,13 +576,10 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Convert tenors from list to string
-        tenors_str = f"({' ,'.join([repr(item) for item in tenors])})"
+        tenors_str = list_to_sql_set(tenors)
 
         # Convert dates from datetime to string
         start_trading_date_str = start_trading_date.strftime("%Y-%m-%d")
@@ -639,10 +645,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Query db
         table = DetDatabase.get_table_name("commodity")
@@ -679,7 +682,7 @@ class DetDatabase:
 
         elif commodity_info.shape[0] == 0:
             available_values = self.load_commodities(columns=[filter_column])
-            available_values_str = ", ".join(f"'{x}'" for x in available_values[filter_column])
+            available_values_str = list_to_str(available_values[filter_column])
             raise ValueError(
                 f"Value {filter_value} not found in column '{filter_column}'. Available values: "
                 f"{available_values_str}."
@@ -713,10 +716,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Convert dates from datetime to string
         end_trading_date = pd.Timestamp(end_trading_date).floor("D") + relativedelta(days=1)
@@ -769,13 +769,10 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Convert tenors from list to string
-        identifiers_str = ", ".join(f"'{i}'" for i in identifiers)
+        identifiers_str = list_to_sql_set(identifiers)
 
         # Query db
         table = DetDatabase.get_table_name("instrument")
@@ -819,10 +816,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = f"[{columns[0]}]"
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Convert dates from datetime to string
         start_trading_date_str = start_trading_date.strftime("%Y-%m-%d")
@@ -922,10 +916,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Convert dates from datetime to string
         forecast_date_str = forecast_date.strftime("%Y-%m-%d")
@@ -975,10 +966,11 @@ class DetDatabase:
                     df[c] = df[c].dt.tz_localize(None)
 
         # Rescale column values
-        df["kWh"] = df["kWh"] / 1000
+        df["Volume(MWh)"] = convert_energy(df["kWh"], unit_in="kWh", unit_out="MWh")
+        df.drop(columns="kWh", inplace=True)
 
         # Rename columns
-        df = df.rename(columns={"kWh": "Volume(MWh)", "Datetime": "DeliveryStart"})
+        df = df.rename(columns={"Datetime": "DeliveryStart"})
 
         return df
 
@@ -1026,10 +1018,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Query db
         table = DetDatabase.get_table_name("client_day_ahead_auction_bids")
@@ -1093,10 +1082,7 @@ class DetDatabase:
             columns = ["*"]
 
         # Convert columns from list to string
-        if len(columns) == 1:
-            columns_str = str(columns[0])
-        else:
-            columns_str = f"[{'], ['.join(columns)}]"
+        columns_str = list_to_sql_columns(columns)
 
         # Query db
         table = DetDatabase.get_table_name("client")
@@ -1131,7 +1117,7 @@ class DetDatabase:
 
         elif client_info.shape[0] == 0:
             available_values = self.load_clients(columns=[filter_column])
-            available_values_str = ", ".join(f"'{x}'" for x in available_values[filter_column])
+            available_values_str = list_to_str(available_values[filter_column])
             raise ValueError(
                 f"Value {filter_value} not found in column '{filter_column}'. Available values: "
                 f"{available_values_str}."

{detquantlib-3.13.0 → detquantlib-3.14.1}/pyproject.toml

@@ -1,10 +1,9 @@
 [tool.poetry]
 name = "detquantlib"
-version = "3.13.0"
+version = "3.14.1"
 description = "An internal library containing functions and classes that can be used across Quant models."
 authors = ["DET"]
 readme = "README.md"
-repository = "https://github.com/Dynamic-Energy-Trading/detquantlib"
 packages = [
     { include = "detquantlib" }, # Specifies the location of the package
 ]
@@ -30,6 +29,7 @@ pytest-cov = "^7.0.0"
 black = "^25.9.0"
 darglint = "^1.8.1"
 isort = "^6.1.0"
+ruff = "^0.15.4"
 colorama = "^0.4.6"
 pymarkdownlnt = "^0.9.32"
 md-toc = "^9.0.0"
@@ -53,6 +53,10 @@ known_third_party = ["invoke"]
 [tool.black]
 line-length = 99
 
+[tool.ruff.lint]
+select = ["B", "F"]  # "B"=flake8-bugbear, "F"=Pyflakes
+ignore = ["F403", "F405"]
+
 [tool.pymarkdown]
 plugins.md013.enabled = false # Disable line length requirements
 plugins.md040.enabled = false # Disable fenced code blocks language requirements