detquantlib 5.0.1__tar.gz → 5.1.1__tar.gz

{detquantlib-5.0.1 → detquantlib-5.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detquantlib
-Version: 5.0.1
+Version: 5.1.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.0.1 → detquantlib-5.1.1}/detquantlib/data/databases/detdatabase.py

@@ -35,26 +35,32 @@ class DetDatabase:
                 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()
+        skip_db_name = db_name is not None
+        DetDatabase.check_environment_variables(skip_db_name)
 
+        self.db_name = db_name if db_name else os.environ["DET_DB_NAME"]
         self.driver = driver
         self.engine = engine if engine is not None else self.initialize_engine()
 
     @staticmethod
-    def check_environment_variables():
+    def check_environment_variables(skip_db_name: bool):
         """
         Checks if environment variables needed by the class are defined.
 
+        Args:
+            skip_db_name: If true, does not check if the environment variable containing the
+                database name is defined
+
         Raises:
             ConnectionError: Raises an error if environment variables are not defined.
         """
-        required_env_vars = [
-            dict(name="DET_DB_NAME", value=None, description="Database name"),
+        required_env_vars = (
+            []
+            if skip_db_name
+            else [dict(name="DET_DB_NAME", value=None, description="Database name")]
+        )
+        required_env_vars += [
             dict(name="DET_DB_SERVER", value=None, description="Server name"),
             dict(name="DET_DB_USERNAME", value=None, description="Username"),
             dict(name="DET_DB_PASSWORD", value=None, description="Password"),
@@ -81,7 +87,7 @@ class DetDatabase:
         connection_str = (
             f"DRIVER={self.driver};"
             f"SERVER={os.getenv('DET_DB_SERVER')};"
-            f"DATABASE={os.getenv('DET_DB_NAME')};"
+            f"DATABASE={self.db_name};"
             f"UID={os.getenv('DET_DB_USERNAME')};"
             f"PWD={quote_plus(os.getenv('DET_DB_PASSWORD'))}"
         )
@@ -93,12 +99,15 @@ class DetDatabase:
         """Disconnects the SQLAlchemy engine and releases all underlying resources."""
         self.engine.dispose()
 
-    def query_db(self, query: str) -> pd.DataFrame:
+    def query_db(self, query: str, params: dict = None) -> pd.DataFrame:
         """
         Short utility method to make an SQL query to the database.
 
         Args:
             query: SQL query
+            params: Dict of query parameters. Example:
+                >> query = text('''SELECT * FROM MyTable WHERE start_date > :start_date''')
+                >> df = obj.query_db(query, params={"start_date": start_date})
 
         Returns:
             Dataframe containing the queried data
@@ -107,7 +116,7 @@ class DetDatabase:
             Exception: Raises an error if the SQL query fails.
         """
         try:
-            df = pd.read_sql_query(query, con=self.engine)
+            df = pd.read_sql_query(query, params=params, con=self.engine)
         except Exception:
             # If query fails, close connection before raising the error
             self.terminate_engine()

{detquantlib-5.0.1 → detquantlib-5.1.1}/pyproject.toml

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