micantis 1.2.1__tar.gz → 1.2.2__tar.gz

{micantis-1.2.1 → micantis-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: micantis
-Version: 1.2.1
+Version: 1.2.2
 Summary: Package to simplify Micantis API usage
 Author-email: Mykela DeLuca <mykela.deluca@micantis.io>
 License-Expression: MIT

{micantis-1.2.1 → micantis-1.2.2}/micantis/api_wrapper.py

@@ -2026,6 +2026,110 @@ class MicantisAPI:
                                cycle, step_kind, step_index)
         return action
 
+    @staticmethod
+    def rename_column(source_column_index, new_name, name=None):
+        """Build a rename-column action for clean_data (MetadataEdit mode).
+
+        Rename a column's display Name — what graphs, tables, and reports look up
+        by YAxisName. Targets the ORIGINAL source column index; action order does
+        not shift index meaning.
+
+        Parameters
+        ----------
+        source_column_index : int
+            0-based index into the ORIGINAL source column list.
+        new_name : str
+            New display name. Preserve exact spacing / punctuation expected by
+            downstream lookups (e.g. "Temp  1 (C)" with two spaces).
+        name : str, optional
+            Descriptive name for this action.
+        """
+        action = {"$type": "rename",
+                  "sourceColumnIndex": int(source_column_index),
+                  "newName": new_name}
+        if name is not None:
+            action["name"] = name
+        return action
+
+    @staticmethod
+    def change_column_kind(source_column_index, new_kind, name=None):
+        """Build a change-column-kind action for clean_data (MetadataEdit mode).
+
+        Change a column's YAxisKind (cycle-tester aux) or ImportItemKind (logger)
+        — controls which kind-based lookups match the column. Targets the ORIGINAL
+        source column index.
+
+        Parameters
+        ----------
+        source_column_index : int
+            0-based index into the ORIGINAL source column list.
+        new_kind : str
+            Exact enum value name (e.g. 'Voltage', 'AuxTemperature').
+        name : str, optional
+            Descriptive name for this action.
+        """
+        action = {"$type": "kind",
+                  "sourceColumnIndex": int(source_column_index),
+                  "newKind": new_kind}
+        if name is not None:
+            action["name"] = name
+        return action
+
+    @staticmethod
+    def reorder_columns(source_column_indices, name=None):
+        """Build a reorder-columns action for clean_data (MetadataEdit mode).
+
+        Declarative final column layout: source columns appear in the cleaned
+        output in the order listed; any source index not listed is dropped.
+        Combines drop + reorder in one action. At most one per definition.
+
+        Parameters
+        ----------
+        source_column_indices : list[int]
+            Ordered list of 0-based source column indices to keep. Omit an index
+            to drop that column. Example: [0, 1, 3, 4, 5] drops source column 2.
+        name : str, optional
+            Descriptive name for this action.
+        """
+        action = {"$type": "reorderColumns",
+                  "sourceColumnIndices": [int(i) for i in source_column_indices]}
+        if name is not None:
+            action["name"] = name
+        return action
+
+    @staticmethod
+    def edit_logger_step(line=None, lines=None, columns=None, name=None):
+        """Build an edit-logger-timestep action for clean_data (logger-data analog of modify_step/bulk_modify).
+
+        Edit Column1..Column10 values by 0-based column index on rows matched by
+        ``line`` and/or ``lines`` (union). Use on DataLoggerData sources only; for
+        cycle-tester data use modify_step / bulk_modify.
+
+        Parameters
+        ----------
+        line : int, optional
+            Single line number to edit.
+        lines : list of (int, int) tuples, optional
+            Line number ranges to edit, e.g. [(100, 200)]. End may be None for open-ended.
+        columns : dict of {int: float}
+            Column edits as {column_index: value}. Column index is 0-based (0-9).
+        name : str, optional
+            Descriptive name for this action.
+        """
+        if line is None and not lines:
+            raise ValueError("edit_logger_step requires either line or lines.")
+        if not columns:
+            raise ValueError("edit_logger_step requires columns.")
+        action = {"$type": "editLogger"}
+        if name is not None:
+            action["name"] = name
+        if line is not None:
+            action["lineNumber"] = line
+        if lines:
+            action["lineNumberRanges"] = _ranges(lines)
+        action["columns"] = [{"columnIndex": int(k), "value": float(v)} for k, v in columns.items()]
+        return action
+
     def clean_data(self,
                    source_ids: list,
                    mode: str = 'CycleAutoFixup',
@@ -2044,14 +2148,19 @@ class MicantisAPI:
         source_ids : list of str
             List of cell data IDs (GUIDs) to clean.
         mode : str, optional
-            Cleaning mode. One of 'CycleAutoFixup', 'FilterCycles', 'Parametric'.
-            Default: 'CycleAutoFixup'. Auto-set to 'Parametric' when actions is provided.
+            Cleaning mode. One of 'CycleAutoFixup', 'FilterCycles', 'Parametric', 'MetadataEdit'.
+            Default: 'CycleAutoFixup'. When ``actions`` is provided and mode is still the default,
+            it auto-sets to 'Parametric'. For 'MetadataEdit', pass mode explicitly.
         filter_cycles_definition : dict, optional
             Required when mode is 'FilterCycles'. Definition for filtering cycles.
         actions : list, optional
-            List of action dicts built with api.remove_steps(),
-            api.modify_step(), and/or api.bulk_modify().
-            Auto-sets mode to 'Parametric'. Example::
+            For Parametric mode: list of dicts from api.remove_steps(), api.modify_step(),
+            api.bulk_modify(), api.edit_logger_step().
+            For MetadataEdit mode: list of dicts from api.rename_column(),
+            api.change_column_kind(), api.reorder_columns().
+            Actions are applied in the order given.
+
+            Parametric example (cycle-tester)::
 
                 api.clean_data(
                     source_ids=[id],
@@ -2061,6 +2170,29 @@ class MicantisAPI:
                         api.bulk_modify(lines=[(100, 5000)], cycle=1),
                     ]
                 )
+
+            Parametric example (DataLoggerData)::
+
+                api.clean_data(
+                    source_ids=[logger_id],
+                    actions=[
+                        api.remove_steps(lines=[(1, 3)]),
+                        api.edit_logger_step(line=10, columns={0: 1.5}),
+                    ]
+                )
+
+            MetadataEdit example (rename + drop — works on both CT and logger)::
+
+                api.clean_data(
+                    source_ids=[id],
+                    mode='MetadataEdit',
+                    actions=[
+                        api.rename_column(source_column_index=3, new_name='Temp  1 (C)'),
+                        api.rename_column(source_column_index=4, new_name='Temp  2 (C)'),
+                        api.rename_column(source_column_index=5, new_name='Temp  3 (C)'),
+                        api.reorder_columns([0, 1, 3, 4, 5]),  # drops source column 2
+                    ]
+                )
         allow_async : bool, optional
             If True, runs asynchronously and returns job ID. Default: False.
         timeout : int, optional
@@ -2073,7 +2205,8 @@ class MicantisAPI:
             If allow_async is True: {'job_id': str}
             Returns None if an error occurs.
         """
-        if actions is not None:
+        # Auto-set mode only if the caller left the default; preserves explicit 'MetadataEdit' etc.
+        if actions is not None and mode == 'CycleAutoFixup':
             mode = 'Parametric'
 
         try:
@@ -2104,8 +2237,10 @@ class MicantisAPI:
 
         if mode == 'Parametric' and not actions:
             raise ValueError("actions is required when mode is 'Parametric'.")
+        if mode == 'MetadataEdit' and not actions:
+            raise ValueError("actions is required when mode is 'MetadataEdit'.")
 
-        _mode_map = {'CycleAutoFixup': 1, 'Parametric': 2, 'FilterCycles': 4}
+        _mode_map = {'CycleAutoFixup': 1, 'Parametric': 2, 'FilterCycles': 4, 'MetadataEdit': 5}
         if mode not in _mode_map:
             raise ValueError(f"mode must be one of {list(_mode_map)}, got '{mode}'")
 
@@ -2117,7 +2252,10 @@ class MicantisAPI:
         if filter_cycles_definition is not None:
             payload["filterCyclesDefinition"] = filter_cycles_definition
         if actions is not None:
-            payload["parametricDefinition"] = {"actions": actions}
+            if mode == 'MetadataEdit':
+                payload["metadataEditDefinition"] = {"actions": actions}
+            else:
+                payload["parametricDefinition"] = {"actions": actions}
 
         url = f"{self.service_url}/publicapi/v1/data/clean"
         if allow_async:

{micantis-1.2.1 → micantis-1.2.2}/micantis.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: micantis
-Version: 1.2.1
+Version: 1.2.2
 Summary: Package to simplify Micantis API usage
 Author-email: Mykela DeLuca <mykela.deluca@micantis.io>
 License-Expression: MIT

{micantis-1.2.1 → micantis-1.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "micantis"
-version = "1.2.1"
+version = "1.2.2"
 description = "Package to simplify Micantis API usage"
 authors = [
     { name = "Mykela DeLuca", email = "mykela.deluca@micantis.io" }