switch-api 0.6.30__tar.gz → 0.6.33__tar.gz

{switch_api-0.6.30 → switch_api-0.6.33}/HISTORY.md

@@ -1,5 +1,41 @@
 # History
 
+#0.6.33
+
+### Fixed
+
+In the `integration` module:
+
+- Fixed `unknown type object` errors in carbon calculations by converting numeric object and pandas extension arrays into NumPy arrays supported by `numexpr`. Existing NumPy numeric dtypes and original input values are preserved.
+
+### Added
+
+In the `_compute` module:
+
+- Added HTTP status, response elapsed time, content type, and exception type to carbon-expression JSON parsing failure logs. Response bodies and exception messages are omitted. The existing empty-result fallback is retained.
+
+#0.6.32
+
+### Changed
+
+In the `integration` module:
+
+- Changed the default `retries` for `get_device_sensors()` from `0` to `5`, enabling the existing retry policy for each page request by default. Callers can override the retry count, including `retries=0` to disable retries.
+- Changed the default `retries` for `get_data()` from `0` to `5` to match its documented default. Callers can still override the retry count.
+
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.30
+Version: 0.6.33
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,42 @@ pip install switch_api
 
 # History
 
+#0.6.33
+
+### Fixed
+
+In the `integration` module:
+
+- Fixed `unknown type object` errors in carbon calculations by converting numeric object and pandas extension arrays into NumPy arrays supported by `numexpr`. Existing NumPy numeric dtypes and original input values are preserved.
+
+### Added
+
+In the `_compute` module:
+
+- Added HTTP status, response elapsed time, content type, and exception type to carbon-expression JSON parsing failure logs. Response bodies and exception messages are omitted. The existing empty-result fallback is retained.
+
+#0.6.32
+
+### Changed
+
+In the `integration` module:
+
+- Changed the default `retries` for `get_device_sensors()` from `0` to `5`, enabling the existing retry policy for each page request by default. Callers can override the retry count, including `retries=0` to disable retries.
+- Changed the default `retries` for `get_data()` from `0` to `5` to match its documented default. Callers can still override the retry count.
+
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.33}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.30",
+    version="0.6.33",
     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.30 → switch_api-0.6.33}/switch_api/__init__.py

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

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api/_compute/_compute.py

@@ -78,7 +78,14 @@ def get_carbon_calculation_expression(df: pd.DataFrame, api_inputs: ApiInputs) -
         logger.info('Successfully retrieved %d carbon calculation expressions.', len(carbon_calculations_df))
         return carbon_calculations_df
     except ValueError as e:
-        logger.error("Failed to parse JSON for carbon calculations: %s", e)
+        logger.error(
+            "Failed to parse JSON for carbon calculations. exception_type=%s; "
+            "HTTP status=%s; elapsed_seconds=%.3f; content_type=%r",
+            type(e).__name__,
+            response_carbon.status_code,
+            response_carbon.elapsed.total_seconds(),
+            response_carbon.headers.get('Content-Type', ''),
+        )
         return pd.DataFrame()
 
 def _execute_iot_sql_query(api_inputs: ApiInputs, query: str) -> requests.Response:

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api/integration/helpers.py

@@ -268,7 +268,7 @@ def get_sites(api_inputs: ApiInputs, include_tag_groups: Union[list, bool] = Fal
 
 def get_device_sensors(api_inputs: ApiInputs, include_tag_groups: Union[list, bool] = False,
                        include_metadata_keys: Union[list, bool] = False, sql_where_clause: str = None,
-                       top_count: int = None, retries: int = 0, backoff_factor: Union[int, float] = 0.3):
+                       top_count: int = None, retries: int = 5, backoff_factor: Union[int, float] = 0.3):
     """Retrieve device and sensor information.
 
     Optionally include all or a subset of tag groups and/or metadata keys depending on the configuration of the
@@ -436,7 +436,7 @@ def get_device_sensors(api_inputs: ApiInputs, include_tag_groups: Union[list, bo
 
 
 def get_data(query_text, api_inputs: ApiInputs, query_language: QUERY_LANGUAGE = "kql",
-             response_type: RESPONSE_TYPE = 'dataframe', retries: int = 0, backoff_factor: Union[int, float] = 2):
+             response_type: RESPONSE_TYPE = 'dataframe', retries: int = 5, backoff_factor: Union[int, float] = 2):
     """Retrieve data.
 
     Parameters

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api/integration/integration.py

@@ -1901,9 +1901,18 @@ def upsert_timeseries(df: pandas.DataFrame, api_inputs: ApiInputs, is_local_time
             for expr in unique_expressions:
                 expr_mask = valid_carbon_calcs["CarbonExpression"] == expr
                 numexpr_expression = expr.replace("[Value]", "Value")
+                value_series = valid_carbon_calcs.loc[expr_mask, "Value"]
+                values = value_series.values
+                # Preserve existing NumPy dtypes and their evaluation behavior.
+                # Only normalize object or pandas extension arrays for numexpr.
+                if not isinstance(values, np.ndarray) or values.dtype.kind == "O":
+                    numeric_values = pd.to_numeric(value_series, errors="raise")
+                    values = numeric_values.to_numpy()
+                    if values.dtype.kind == "O":
+                        values = numeric_values.to_numpy(dtype=np.float64, na_value=np.nan)
                 valid_carbon_calcs.loc[expr_mask, "Carbon"] = numexpr.evaluate(
                     numexpr_expression,
-                    local_dict={"Value": valid_carbon_calcs.loc[expr_mask, "Value"].values}
+                    local_dict={"Value": values}
                 )
 
             df = df.merge(

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api/pipeline/automation.py

@@ -1366,7 +1366,9 @@ class Automation:
                         cron_schedule: str, queue_name: QUEUE_NAME = "task", settings: dict = None,
                         schedule_timezone: SCHEDULE_TIMEZONE = 'Local', timezone_offset_minutes: int = None,
                         data_feed_name: str = None, task_priority: TASK_PRIORITY = 'standard',
-                        task_framework: TASK_FRAMEWORK = 'TaskInsightsEngine'):
+                        task_framework: TASK_FRAMEWORK = 'TaskInsightsEngine',
+                        email: dict = None, ftp: dict = None, upload: dict = None,
+                        webhook: dict = None):
         """Deploy driver to run on timer.
 
         Parameters
@@ -1403,6 +1405,11 @@ class Automation:
             'PythonScriptFramework' for the old task runner engine.
             'TaskInsightsEngine' for the new task running in container apps.
 
+        email, ftp, upload, webhook : dict, optional
+            Independent delivery settings using API camelCase field names; each defaults to None.
+            Timer updates replace all four: None or an empty object clears the corresponding setting.
+            Upload requires a nonempty uploadUrl or ingestUrl; the server generates the actual URLs.
+
         Returns
         -------
         pandas.Dataframe
@@ -1505,6 +1512,10 @@ class Automation:
                 "timezoneOffsetMinutes": timezone_offset_minutes,
                 "scheduleTimezone": schedule_timezone
             },
+            "email": email,
+            "ftp": ftp,
+            "upload": upload,
+            "webhook": webhook,
             "settings": settings
         }
 

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.30
+Version: 0.6.33
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,42 @@ pip install switch_api
 
 # History
 
+#0.6.33
+
+### Fixed
+
+In the `integration` module:
+
+- Fixed `unknown type object` errors in carbon calculations by converting numeric object and pandas extension arrays into NumPy arrays supported by `numexpr`. Existing NumPy numeric dtypes and original input values are preserved.
+
+### Added
+
+In the `_compute` module:
+
+- Added HTTP status, response elapsed time, content type, and exception type to carbon-expression JSON parsing failure logs. Response bodies and exception messages are omitted. The existing empty-result fallback is retained.
+
+#0.6.32
+
+### Changed
+
+In the `integration` module:
+
+- Changed the default `retries` for `get_device_sensors()` from `0` to `5`, enabling the existing retry policy for each page request by default. Callers can override the retry count, including `retries=0` to disable retries.
+- Changed the default `retries` for `get_data()` from `0` to `5` to match its documented default. Callers can still override the retry count.
+
+#0.6.31
+
+### Added
+
+In the `pipeline` module:
+
+- Added optional `email`, `ftp`, `upload`, and `webhook` delivery settings to `Automation.deploy_on_timer()`, allowing scheduled data feeds to retain additional delivery methods.
+
+### Changed
+
+- Timer deployment requests include all four delivery settings while retaining `sourceType: Timer`. Omitted settings, `None`, or empty dictionaries clear the corresponding stored configuration; resupply each setting that should remain enabled.
+- Existing positional arguments and driver `settings` retain their meaning.
+
 #0.6.30
 
 ### Added

{switch_api-0.6.30 → switch_api-0.6.33}/switch_api.egg-info/SOURCES.txt

@@ -70,9 +70,12 @@ switch_api/realtime/_mqtt.py
 switch_api/realtime/_redis.py
 switch_api/realtime/realtime.py
 tests/test_authentication.py
+tests/test_carbon_calculation.py
+tests/test_carbon_response_diagnostics.py
 tests/test_controls.py
 tests/test_dataset.py
 tests/test_error_handlers.py
 tests/test_initialize.py
 tests/test_integration.py
-tests/test_pipeline.py
+tests/test_pipeline.py
+tests/test_timer_deployment.py

switch_api-0.6.33/tests/test_carbon_calculation.py

@@ -0,0 +1,91 @@
+"""Offline regression tests for the nested carbon calculation helper."""
+
+import ast
+from decimal import Decimal
+import logging
+from pathlib import Path
+import unittest
+from unittest.mock import patch
+
+import numexpr
+import numpy as np
+import pandas as pd
+
+
+def load_carbon_helper():
+    # Isolate the nested helper without initializing API clients or ingesting data.
+    source = Path(__file__).parents[1] / "switch_api/integration/integration.py"
+    tree = ast.parse(source.read_text(encoding="utf-8"))
+    upsert = next(node for node in tree.body
+                  if isinstance(node, ast.FunctionDef) and node.name == "upsert_timeseries")
+    helper = next(node for node in upsert.body
+                  if isinstance(node, ast.FunctionDef) and node.name == "add_carbon_column")
+    namespace = {"pd": pd, "np": np, "numexpr": numexpr,
+                 "logger": logging.getLogger(__name__)}
+    exec(compile(ast.Module(body=[helper], type_ignores=[]), str(source), "exec"), namespace)
+    return namespace["add_carbon_column"]
+
+
+class CarbonCalculationTests(unittest.TestCase):
+    def calculate(self, values, expression="[Value] * 0.5"):
+        frame = pd.DataFrame({
+            "ObjectPropertyId": ["SENSOR"] * len(values),
+            "TimestampLocal": pd.to_datetime(["2026-06-01"] * len(values)),
+            "Value": values,
+        })
+        original = frame.copy(deep=True)
+        calculations = pd.DataFrame({
+            "ObjectPropertyID": ["sensor", "sensor"],
+            "CarbonExpression": ["[Value] * 9", expression],
+            "FromDate": ["2026-01-01"] * 2,
+            "ToDate": ["2026-12-31"] * 2,
+            "ObjectPropertyTemplateID": [None, "template"],
+        })
+        result = load_carbon_helper()(frame, calculations)
+        pd.testing.assert_frame_equal(frame, original)
+        pd.testing.assert_series_equal(result["Value"], original["Value"])
+        self.assertEqual(len(result), len(frame))
+        self.assertNotIn("__row_id", result)
+        return result["Carbon"].to_numpy()
+
+    def test_numeric_input_representations(self):
+        for values in ([2.0, 4.0], [2, 4], ["2", "4"],
+                       [Decimal("2"), Decimal("4")],
+                       pd.Series([2, 4], dtype=object),
+                       pd.Series([2, 4], dtype="Float64")):
+            with self.subTest(values=repr(values)):
+                np.testing.assert_allclose(self.calculate(values), [1, 2])
+
+    def test_missing_values_preserve_existing_zero_carbon_fallback(self):
+        for values in (["2", None], pd.Series([2, pd.NA], dtype="Float64"),
+                       pd.Series([2, pd.NA], dtype="Int64")):
+            with self.subTest(values=repr(values)):
+                np.testing.assert_allclose(self.calculate(values), [1, 0])
+
+    def test_invalid_text_is_rejected(self):
+        with self.assertRaises(ValueError):
+            self.calculate(["invalid", "2"])
+
+    def test_existing_numpy_numeric_dtypes_are_preserved(self):
+        for dtype in (np.int32, np.int64, np.float32, np.float64):
+            with self.subTest(dtype=dtype), patch.object(
+                numexpr, "evaluate", wraps=numexpr.evaluate
+            ) as evaluate:
+                self.calculate(np.array([2, 4], dtype=dtype))
+                supplied = evaluate.call_args.kwargs["local_dict"]["Value"]
+                self.assertEqual(supplied.dtype, np.dtype(dtype))
+
+    def test_large_integer_precision_is_preserved_during_evaluation(self):
+        values = np.array([2**53 + 1, 2**53 + 3], dtype=np.int64)
+        np.testing.assert_array_equal(
+            self.calculate(values, "[Value] - 9007199254740992"), [1, 3]
+        )
+
+    def test_integer_only_expression_still_works(self):
+        np.testing.assert_array_equal(
+            self.calculate(np.array([2, 4], dtype=np.int64), "[Value] << 1"), [4, 8]
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()

switch_api-0.6.33/tests/test_carbon_response_diagnostics.py

@@ -0,0 +1,74 @@
+"""Offline tests of carbon response diagnostics; no API initialization required."""
+
+import ast
+from datetime import timedelta
+import logging
+from pathlib import Path
+import unittest
+from unittest.mock import Mock
+
+import pandas as pd
+import requests
+
+
+class CarbonResponseDiagnosticsTests(unittest.TestCase):
+    def setUp(self):
+        source = Path(__file__).parents[1] / 'switch_api/_compute/_compute.py'
+        tree = ast.parse(source.read_text(encoding='utf-8'))
+        functions = [node for node in tree.body if isinstance(node, ast.FunctionDef)
+                     and node.name == 'get_carbon_calculation_expression']
+        self.logger = logging.getLogger('carbon_response_test')
+        self.response = requests.Response()
+        self.response.status_code = 200
+        self.response.elapsed = timedelta(seconds=10.125)
+        self.response.headers['Content-Type'] = 'application/json'
+        self.namespace = dict(pd=pd, ApiInputs=object,
+                              logger=self.logger,
+                              COMMAND_CARBON_CALCULATION_EXPRESSION=Mock(return_value='query'),
+                              _execute_iot_sql_query=Mock(return_value=self.response))
+        exec(compile(ast.Module(body=functions, type_ignores=[]), str(source), 'exec'), self.namespace)
+
+    def retrieve(self, body):
+        self.response._content = body.encode('utf-8')
+        frame = pd.DataFrame({'ObjectPropertyId': ['sensor'],
+                              'TimestampLocal': pd.to_datetime(['2026-06-01'])})
+        return self.namespace['get_carbon_calculation_expression'](frame, object())
+
+    def test_scalar_error_response_logs_diagnostics_and_keeps_fallback(self):
+        with self.assertLogs(self.logger, level='ERROR') as captured:
+            result = self.retrieve('{"error":"SQL timeout", "access_token":"private-token"}')
+        self.assertTrue(result.empty)
+        log = ' '.join(captured.output)
+        for expected in ('HTTP status=200', 'elapsed_seconds=10.125', 'application/json',
+                         'exception_type=ValueError'):
+            self.assertIn(expected, log)
+        self.assertNotIn('private-token', log)
+
+    def test_malformed_response_content_is_not_logged(self):
+        for body in ('{"password":"private-password",',
+                     '{"api_key":"private-api-key",',
+                     '<html>password=private-password</html>'):
+            with self.subTest(body=body), self.assertLogs(self.logger, level='ERROR') as captured:
+                result = self.retrieve(body)
+            self.assertTrue(result.empty)
+            log = ' '.join(captured.output)
+            self.assertNotIn('private-', log)
+            self.assertNotIn('response_body=', log)
+
+    def test_exception_message_is_not_logged(self):
+        from unittest.mock import patch
+        with patch.object(pd, 'read_json', side_effect=ValueError('private-payload')):
+            with self.assertLogs(self.logger, level='ERROR') as captured:
+                self.assertTrue(self.retrieve('invalid').empty)
+        self.assertNotIn('private-payload', ' '.join(captured.output))
+
+    def test_empty_and_valid_responses_do_not_log_parse_failures(self):
+        for body in ('', '[]', '[{"CarbonExpression":"[Value] * 0.5"}]'):
+            with self.subTest(body=body), self.assertLogs(self.logger, level='INFO') as captured:
+                result = self.retrieve(body)
+            self.assertFalse(any('Failed to parse' in entry for entry in captured.output))
+            self.assertEqual(result.empty, body in ('', '[]'))
+
+
+if __name__ == '__main__':
+    unittest.main()

switch_api-0.6.33/tests/test_timer_deployment.py

@@ -0,0 +1,62 @@
+"""Offline payload regression tests for both Timer deployment helpers."""
+import ast
+import itertools
+import json
+import logging
+from pathlib import Path
+from types import SimpleNamespace
+import unittest
+from unittest.mock import Mock
+import uuid
+
+
+class TimerDeploymentTests(unittest.TestCase):
+    def test_delivery_settings(self):
+        root = Path(__file__).resolve().parents[1]
+        for relative, is_api in (
+            ('switch_api/pipeline/automation.py', True),
+            ('switch_guides/switch_guides/pipeline/automation.py', False),
+        ):
+            # Execute the actual helper in isolation from unrelated Azure/task imports.
+            tree = ast.parse((root / relative).read_text(encoding='utf-8'))
+            owner = next(n for n in tree.body if isinstance(n, ast.ClassDef) and n.name == 'Automation') if is_api else tree
+            function = next(n for n in owner.body if isinstance(n, ast.FunctionDef) and n.name == 'deploy_on_timer')
+            function.decorator_list = []
+            function.returns = None
+            for argument in function.args.args:
+                argument.annotation = None
+            requests = SimpleNamespace(post=Mock(return_value=SimpleNamespace(status_code=200, reason='OK', text='', request=SimpleNamespace(url='https://example.invalid'))))
+            namespace = dict(uuid=uuid, logger=logging.getLogger(__name__), requests=requests,
+                             pandas=SimpleNamespace(DataFrame=lambda: None))
+            for name, values in dict(EXPECTED_DELIVERY=('Daily',), SCHEDULE_TIMEZONE=('Local',),
+                                     QUEUE_NAME=('task',), TASK_FRAMEWORK=('TaskInsightsEngine',),
+                                     TASK_PRIORITY=('standard',)).items():
+                namespace[name] = SimpleNamespace(__args__=values)
+            exec(compile(ast.fix_missing_locations(ast.Module(body=[function], type_ignores=[])), relative, 'exec'), namespace)
+            deploy = namespace['deploy_on_timer']
+            inputs = SimpleNamespace(api_base_url='https://example.invalid', bearer_token='test',
+                                     api_headers=SimpleNamespace(default={}), api_projects_endpoint='https://example.invalid/projects',
+                                     api_project_id=str(uuid.uuid4()))
+            task = SimpleNamespace(id=uuid.uuid4(), mapping_entities=['Readings']) if is_api else str(uuid.uuid4())
+            args = (task, inputs, uuid.uuid4(), 'Daily', '0 * * * *')
+            configurations = dict(email={'emailAddressDomain': 'example.invalid'},
+                                  ftp={'ftpUserName': 'test-user', 'ftpPassword': 'test-only'},
+                                  upload={'uploadUrl': 'enabled'},
+                                  webhook={'clientSigningSecret': 'test-only'})
+            for enabled in itertools.product((False, True), repeat=4):
+                optional = {key: value for (key, value), include in zip(configurations.items(), enabled) if include}
+                with self.subTest(helper=relative, enabled=enabled):
+                    deploy(*args, settings={'custom': 'value'}, **optional)
+                    payload = json.loads(json.dumps(requests.post.call_args.kwargs['json']))
+                    self.assertEqual(payload['sourceType'], 'Timer')
+                    self.assertEqual(payload['timer'], dict(cronSchedule='0 * * * *', timezoneOffsetMinutes=0, scheduleTimezone='Local'))
+                    self.assertEqual(payload['settings'], {'custom': 'value'})
+                    for key in configurations:
+                        self.assertEqual(payload[key], optional.get(key))
+            deploy(*args, **dict.fromkeys(configurations, {}))
+            for key in configurations:
+                self.assertEqual(requests.post.call_args.kwargs['json'][key], {})
+
+
+if __name__ == '__main__':
+    unittest.main()