switch-api 0.6.13__tar.gz → 0.6.14__tar.gz

{switch_api-0.6.13 → switch_api-0.6.14}/HISTORY.md

@@ -1,5 +1,13 @@
 # History
 
+#0.6.14
+### Modified
+In the `integration` module:
+- Updated `add_carbon_column()` to enforce priority selection of carbon calculation rules.
+- When overlapping date ranges exist for the same `ObjectPropertyId`, the rule with a non-null `ObjectPropertyTemplateID` is now preferred over the default (NULL) rule.
+- Ensured only one carbon calculation is applied per input row to prevent duplicate records.
+- Refactored logic to preserve original row count and avoid row loss during rule matching.
+
 #0.6.13
 ### Added
 In the `controls` module

{switch_api-0.6.13 → switch_api-0.6.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: switch_api
-Version: 0.6.13
+Version: 0.6.14
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Home-page: UNKNOWN
 Author: Switch Automation Pty Ltd.
@@ -38,6 +38,14 @@ pip install switch_api
 
 # History
 
+#0.6.14
+### Modified
+In the `integration` module:
+- Updated `add_carbon_column()` to enforce priority selection of carbon calculation rules.
+- When overlapping date ranges exist for the same `ObjectPropertyId`, the rule with a non-null `ObjectPropertyTemplateID` is now preferred over the default (NULL) rule.
+- Ensured only one carbon calculation is applied per input row to prevent duplicate records.
+- Refactored logic to preserve original row count and avoid row loss during rule matching.
+
 #0.6.13
 ### Added
 In the `controls` module

{switch_api-0.6.13 → switch_api-0.6.14}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.13",
+    version="0.6.14",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 

{switch_api-0.6.13 → switch_api-0.6.14}/switch_api/__init__.py

@@ -42,4 +42,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.13"
+__version__ = "0.6.14"

{switch_api-0.6.13 → switch_api-0.6.14}/switch_api/integration/integration.py

@@ -1855,6 +1855,7 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         df = df.assign(Carbon=0.0)
 
         df = df.copy()
+        df['__row_id'] = np.arange(len(df))
         carbon_calcs_df = carbon_calculations_df.copy()
 
         if 'ObjectPropertyID' in carbon_calcs_df.columns:
@@ -1864,7 +1865,7 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         if not pd.api.types.is_datetime64_any_dtype(df['TimestampLocal']):
             df['TimestampLocal'] = pd.to_datetime(df['TimestampLocal'])
 
-        required_carbon_cols = ['ObjectPropertyId', 'CarbonExpression', 'FromDate', 'ToDate']
+        required_carbon_cols = ['ObjectPropertyId', 'CarbonExpression', 'FromDate', 'ToDate', 'ObjectPropertyTemplateID']
         if not all(col in carbon_calcs_df.columns for col in required_carbon_cols):
             logger.error(f"Missing required columns in carbon calculations DataFrame. Required: {required_carbon_cols}")
             return df.assign(Carbon=0.0)
@@ -1877,29 +1878,47 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
         carbon_calcs_df['ToDate'] = pd.to_datetime(carbon_calcs_df['ToDate'])
 
         merged_df = pd.merge(df, carbon_calcs_df, on='ObjectPropertyId', how='left', indicator=True)
-        no_valid_carbon_calcs = merged_df[merged_df._merge== 'left_only']
 
         matches_mask = (merged_df['TimestampLocal'] >= merged_df['FromDate']) & \
                         (merged_df['TimestampLocal'] <= merged_df['ToDate'])
-        valid_carbon_calcs = merged_df[matches_mask]
 
-        if valid_carbon_calcs.shape[0]>0:
-            unique_expressions = valid_carbon_calcs['CarbonExpression'].unique()
+        valid_carbon_calcs = merged_df[matches_mask].copy()
+
+        if not valid_carbon_calcs.empty:
+            # priority: non-NULL ObjectPropertyTemplateID first
+            valid_carbon_calcs["__tmplt_priority"] = valid_carbon_calcs["ObjectPropertyTemplateID"].notna().astype(int)
+
+            # choose ONE calc row per original df row
+            valid_carbon_calcs = (
+                valid_carbon_calcs
+                .sort_values(["__row_id", "__tmplt_priority"], ascending=[True, False])
+                .drop_duplicates(subset="__row_id", keep="first")
+            )
+
+            unique_expressions = valid_carbon_calcs["CarbonExpression"].dropna().unique()
             for expr in unique_expressions:
-                expr_mask = valid_carbon_calcs['CarbonExpression'] == expr
-                numexpr_expression = expr.replace('[Value]', 'Value')
-                valid_carbon_calcs.loc[expr_mask, 'Carbon'] = numexpr.evaluate(
-                    numexpr_expression, 
-                    local_dict = {'Value': valid_carbon_calcs.loc[expr_mask, 'Value'].values}
+                expr_mask = valid_carbon_calcs["CarbonExpression"] == expr
+                numexpr_expression = expr.replace("[Value]", "Value")
+                valid_carbon_calcs.loc[expr_mask, "Carbon"] = numexpr.evaluate(
+                    numexpr_expression,
+                    local_dict={"Value": valid_carbon_calcs.loc[expr_mask, "Value"].values}
                 )
-        
-        final_df = pd.concat([no_valid_carbon_calcs, valid_carbon_calcs])
-        final_row_count = final_df.shape[0]
 
-        logger.info(f"Original row count = {original_row_count}, final row count = {final_row_count}. Matches = {original_row_count==final_row_count}")
-        final_df = final_df.drop(columns=['CarbonExpression', 'FromDate', 'ToDate', '_merge'])
+            df = df.merge(
+                valid_carbon_calcs[["__row_id", "Carbon"]],
+                on="__row_id",
+                how="left",
+                suffixes=("", "_calc"),
+            )
+            df["Carbon"] = df["Carbon_calc"].fillna(df["Carbon"])
+            df = df.drop(columns=["Carbon_calc"])
+
+        final_row_count = df.shape[0]
+        logger.info(
+            f"Original row count = {original_row_count}, final row count = {final_row_count}. Matches = {original_row_count==final_row_count}"
+        )
 
-        return final_df
+        return df.drop(columns=["__row_id"])
 
     def create_meta_column(df, slice_columns, save_slices, cost_carbon_calculation):
         """Handles creating the 'Meta' column and optionally saves additional columns as slices."""

{switch_api-0.6.13 → switch_api-0.6.14}/switch_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: switch-api
-Version: 0.6.13
+Version: 0.6.14
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Home-page: UNKNOWN
 Author: Switch Automation Pty Ltd.
@@ -38,6 +38,14 @@ pip install switch_api
 
 # History
 
+#0.6.14
+### Modified
+In the `integration` module:
+- Updated `add_carbon_column()` to enforce priority selection of carbon calculation rules.
+- When overlapping date ranges exist for the same `ObjectPropertyId`, the rule with a non-null `ObjectPropertyTemplateID` is now preferred over the default (NULL) rule.
+- Ensured only one carbon calculation is applied per input row to prevent duplicate records.
+- Refactored logic to preserve original row count and avoid row loss during rule matching.
+
 #0.6.13
 ### Added
 In the `controls` module