smartsheet-tools 0.0.2__tar.gz → 0.0.5__tar.gz

{smartsheet_tools-0.0.2/smartsheet_tools.egg-info → smartsheet_tools-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet_tools
-Version: 0.0.2
+Version: 0.0.5
 Summary: A collection of convenience functions to aid with transitioning from simple-smartsheet to the SDK API and common tasks
 Author: Ashton Pooley
 Author-email: Ashton Pooley <ashton@ashi.digital>

{smartsheet_tools-0.0.2 → smartsheet_tools-0.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "smartsheet_tools"                       # from setup.py
-version = "0.0.2"                       # from setup.py
+version = "0.0.5"                       # from setup.py
 description = "A collection of convenience functions to aid with transitioning from simple-smartsheet to the SDK API and common tasks"
 readme = "README.md"
 requires-python = ">=3.9"               # matches classifiers (3.9–3.12)

{smartsheet_tools-0.0.2 → smartsheet_tools-0.0.5}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name="smartsheet_tools",
-    version="0.0.2",
+    version="0.0.5",
     description="A collection of convenience functions to aid with transitioning from simple-smartsheet to the SDK API and common tasks",
     author="Ashton Pooley",
     author_email="Ashton@ashi.digital",

smartsheet_tools-0.0.5/smartsheet_tools/__init__.py

@@ -0,0 +1,176 @@
+from datetime import datetime
+import re
+from smartsheet.models import Cell, Row, Folder, Sheet
+from smartsheet.models import Column
+
+# Cache for column types to minimize API calls when correcting date formats
+_COLUMN_TYPE_CACHE = {}
+_TITLE_TO_ID_CACHE = {}
+_ID_TO_INDEX_CACHE = {}
+
+def norm(v):
+    if v is None:
+        return ""
+    s = str(v).strip().lower()
+    return re.sub(r"\.0+$", "", s)
+
+def disp_or_val(cell):
+    # prefer display_value when Smartsheet provides a formatted value
+    dv = getattr(cell, "display_value", None)
+    return dv if dv not in (None, "") else cell.value
+
+def title_to_index(sheet):
+    # authoritative positions from Smartsheet (not Python enumerate order)
+    if sheet.id not in _TITLE_TO_ID_CACHE:
+        _TITLE_TO_ID_CACHE[sheet.id] = {c.title: c.index for c in sheet.columns}
+    return _TITLE_TO_ID_CACHE[sheet.id]
+
+def index_to_id(sheet):
+    # authoritative positions from Smartsheet (not Python enumerate order)
+    if sheet.id not in _ID_TO_INDEX_CACHE:
+        _ID_TO_INDEX_CACHE[sheet.id] = {c.index: c.id for c in sheet.columns}
+    return _ID_TO_INDEX_CACHE[sheet.id]
+
+def id_to_index(sheet):
+    # authoritative positions from Smartsheet (not Python enumerate order)
+    return {c.id: c.index for c in sheet.columns}
+
+def id_to_title(sheet):
+    return {c.id: c.title for c in sheet.columns}
+
+def title_to_id(sheet):
+    return {c.title: c.id for c in sheet.columns}
+
+def guard_row(row, *idxs):
+    # ensure row has enough cells for all requested positions
+    return max(idxs) < len(row.cells)
+
+def datetime_to_isoformat(dt):
+    if dt is None:
+        return None
+    return dt.replace(microsecond=0).isoformat() + 'Z'
+
+def standard_time_to_isoformat(st):
+    if st is None:
+        return None
+    return datetime_to_isoformat(datetime.strptime(st, "%m/%d/%Y"))
+
+def get_cached_column_type(column_id, sheet_obj):
+    if sheet_obj.id not in _COLUMN_TYPE_CACHE:
+        _COLUMN_TYPE_CACHE[sheet_obj.id] = {}
+        
+    if column_id not in _COLUMN_TYPE_CACHE[sheet_obj.id]:
+        _COLUMN_TYPE_CACHE[sheet_obj.id][column_id] = str(sheet_obj.get_column(column_id).type)
+    
+    return _COLUMN_TYPE_CACHE[sheet_obj.id][column_id]
+
+def get_col_names_of_date_cols(sheet_obj):
+    return [c.title for c in sheet_obj.columns if get_cached_column_type(c.id, sheet_obj) in ("DATE", "DATETIME")]
+
+def brute_force_date_string(s, nonetype_if_fail=False):
+    # attempt to parse a date string in common formats to ISO 8601
+    if isinstance(s, datetime):
+        return datetime_to_isoformat(s)
+    
+    if not isinstance(s, str):
+        return None if nonetype_if_fail else s
+    
+    s = s.split(" ")[0]
+    for fmt in ("%Y-%m-%d", "%m/%d/%Y", "%m/%d/%y"):
+        try:
+            return datetime_to_isoformat(datetime.strptime(s, fmt))
+        except ValueError:
+            continue
+    return None if nonetype_if_fail else s
+
+
+def is_date_col(column_id, sheet_obj):
+    column_type = get_cached_column_type(column_id, sheet_obj)
+    return column_type in ("DATE", "DATETIME")
+
+def correct_date_format(isoformat_datetime, column_id, sheet_obj):
+    if isinstance(isoformat_datetime, datetime):
+        isoformat_datetime = datetime_to_isoformat(isoformat_datetime)
+
+    column_type = get_cached_column_type(column_id, sheet_obj)
+    if column_type == "DATE":
+        return isoformat_datetime.split("T",1)[0]
+    elif column_type == "DATETIME":
+        return isoformat_datetime
+    return None
+
+def new_cell(column_id=None, value=None, strict=False, formula=None):
+    new_cell = Cell()
+    if column_id is not None:
+        new_cell.column_id = column_id
+    if formula is not None:
+        new_cell.formula = formula
+    else:
+        new_cell.value = value
+    new_cell.strict = strict
+    return new_cell
+
+def new_row(cells=None, id=None, parent_id=None, to_top=False, locked=False):
+    new_row = Row()
+    if cells:
+        new_row.cells = cells
+    if id:
+        new_row.id = id
+    if parent_id:
+        new_row.parent_id = parent_id
+    if to_top:
+        new_row.to_top = to_top
+    if locked:
+        new_row.locked = locked
+    return new_row
+
+def walk_folder_for_sheets(smartsheet_client, folder_id):
+    for item in smartsheet_client.Folders.get_folder_children(folder_id).data:
+        if isinstance(item, Folder):
+            yield from walk_folder_for_sheets(smartsheet_client, item.id)
+        elif isinstance(item, Sheet):
+            yield item
+
+def walk_workspace_for_sheets(smartsheet_client, workspace_id):
+    for item in smartsheet_client.Workspaces.get_workspace_children(workspace_id).data:
+        if isinstance(item, Folder):
+            yield from walk_folder_for_sheets(smartsheet_client, item.id)
+        elif isinstance(item, Sheet):
+            yield item
+            
+def walk_folder_for_folders(smartsheet_client, folder_id):
+    for item in smartsheet_client.Folders.get_folder_children(folder_id).data:
+        if isinstance(item, Folder):
+            yield item
+            yield from walk_folder_for_folders(smartsheet_client, item.id)
+            
+def walk_workspace_for_folders(smartsheet_client, workspace_id):
+    for item in smartsheet_client.Workspaces.get_workspace_children(workspace_id).data:
+        if isinstance(item, Folder):
+            yield item
+            yield from walk_folder_for_folders(smartsheet_client, item.id)
+            
+def walk_sheet_names_from_workspace(smartsheet_client, workspace_id):
+    for sheet in walk_workspace_for_sheets(smartsheet_client, workspace_id):
+        yield sheet.name
+        
+def new_column(column_type, title, index=None, id=None, options=None, symbol=None, primary=False, hidden=False, locked=False):
+    new_column = Column()
+    
+    new_column.type = column_type
+    new_column.title = title
+    if index is not None:
+        new_column.index = index
+    if id is not None:
+        new_column.id = id
+    if options is not None and column_type in ("PICKLIST", "MULTI_PICKLIST"):
+        new_column.options = options
+    if symbol is not None and column_type == "CHECKBOX":
+        new_column.symbol = symbol
+    if primary:
+        new_column.primary = True
+    if hidden:
+        new_column.hidden = True
+    if locked:
+        new_column.locked = True
+    return new_column

{smartsheet_tools-0.0.2 → smartsheet_tools-0.0.5/smartsheet_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet_tools
-Version: 0.0.2
+Version: 0.0.5
 Summary: A collection of convenience functions to aid with transitioning from simple-smartsheet to the SDK API and common tasks
 Author: Ashton Pooley
 Author-email: Ashton Pooley <ashton@ashi.digital>

smartsheet_tools-0.0.2/smartsheet_tools/__init__.py

@@ -1,56 +0,0 @@
-import re
-from smartsheet.models import Cell, Row
-
-def norm(v):
-    if v is None:
-        return ""
-    s = str(v).strip().lower()
-    return re.sub(r"\.0+$", "", s)
-
-def disp_or_val(cell):
-    # prefer display_value when Smartsheet provides a formatted value
-    dv = getattr(cell, "display_value", None)
-    return dv if dv not in (None, "") else cell.value
-
-def title_to_index(sheet):
-    # authoritative positions from Smartsheet (not Python enumerate order)
-    return {c.title: c.index for c in sheet.columns}
-
-def index_to_id(sheet):
-    # authoritative positions from Smartsheet (not Python enumerate order)
-    return {c.index: c.id for c in sheet.columns}
-
-def id_to_index(sheet):
-    # authoritative positions from Smartsheet (not Python enumerate order)
-    return {c.id: c.index for c in sheet.columns}
-
-def id_to_title(sheet):
-    return {c.id: c.title for c in sheet.columns}
-
-def title_to_id(sheet):
-    return {c.title: c.id for c in sheet.columns}
-
-def guard_row(row, *idxs):
-    # ensure row has enough cells for all requested positions
-    return max(idxs) < len(row.cells)
-
-def new_cell(column_id, value=None, strict=False, formula=None):
-    new_cell = Cell()
-    new_cell.column_id = column_id
-    if formula is not None:
-        new_cell.formula = formula
-    else:
-        new_cell.value = value
-    if strict:
-        new_cell.strict = True
-    return new_cell
-
-def new_row(cells=None, parent_id=None, to_top=False):
-    new_row = Row()
-    if cells:
-        new_row.cells = cells
-    if parent_id:
-        new_row.parent_id = parent_id
-    if to_top:
-        new_row.to_top = to_top
-    return new_row