mergeron_extra 2024.739148.6__tar.gz → 2024.739148.7__tar.gz

{mergeron_extra-2024.739148.6 → mergeron_extra-2024.739148.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mergeron_extra
-Version: 2024.739148.6
+Version: 2024.739148.7
 Summary: Tools for users of the mergeron package.
 License: MIT
 Author: Murthy Kambhampaty

{mergeron_extra-2024.739148.6 → mergeron_extra-2024.739148.7}/pyproject.toml

@@ -4,7 +4,7 @@ description = "Tools for users of the mergeron package."
 authors = ["Murthy Kambhampaty <smk@capeconomics.com>"]
 license = "MIT"
 readme = "README.rst"
-version = "2024.739148.6"
+version = "2024.739148.7"
 
 classifiers = [
     "Development Status :: 4 - Beta",

{mergeron_extra-2024.739148.6 → mergeron_extra-2024.739148.7}/src/mergeron_extra/__init__.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import numpy as np
 from numpy.typing import NDArray
 
-VERSION = "2024.739148.6"
+VERSION = "2024.739148.7"
 
 __version__ = VERSION
 

{mergeron_extra-2024.739148.6 → mergeron_extra-2024.739148.7}/src/mergeron_extra/xlsxw_helper.py

@@ -25,7 +25,7 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from types import MappingProxyType
-from typing import Any, ClassVar, Literal, TypeAlias, TypedDict
+from typing import Any, ClassVar, Literal, TypeAlias, TypedDict, overload
 
 import numpy as np
 from aenum import Enum, extend_enum, unique  # type: ignore
@@ -261,7 +261,7 @@ class CFmt(Enum):  # type: ignore
     def xl_fmt(
         cls,
         _xl_book: Workbook,
-        _cell_fmt: Sequence[CFmt | Sequence[CFmt]] | CFmt | None,
+        _cell_format: Sequence[CFmt | Sequence[CFmt]] | CFmt | None,
         /,
     ) -> Format:
         """
@@ -272,7 +272,7 @@ class CFmt(Enum):  # type: ignore
         _xl_book
             :code:`xlsxwriter.Workbook` object
 
-        _cell_fmt
+        _cell_format
             :class:`CFmt` enum object, or tuple thereof
 
         Raises
@@ -287,26 +287,26 @@ class CFmt(Enum):  # type: ignore
 
         """
 
-        if isinstance(_cell_fmt, Format):
-            return _cell_fmt
-        elif _cell_fmt is None:
+        if isinstance(_cell_format, Format):
+            return _cell_format
+        elif _cell_format is None:
             return _xl_book.add_format(CFmt.XL_DEFAULT.value)
 
-        _cell_fmt_dict: CFmtVal = {}
-        if isinstance(_cell_fmt, Sequence):
-            cls.ensure_cell_format_spec_tuple(_cell_fmt)
-            for _cf in _cell_fmt:
+        _cell_format_dict: CFmtVal = {}
+        if isinstance(_cell_format, Sequence):
+            cls.ensure_cell_format_spec_tuple(_cell_format)
+            for _cf in _cell_format:
                 if isinstance(_cf, Sequence):
                     for _cfi in _cf:
-                        _cell_fmt_dict |= _cfi.value
+                        _cell_format_dict |= _cfi.value
                 else:
-                    _cell_fmt_dict |= _cf.value
-        elif isinstance(_cell_fmt, CFmt):
-            _cell_fmt_dict = _cell_fmt.value
+                    _cell_format_dict |= _cf.value
+        elif isinstance(_cell_format, CFmt):
+            _cell_format_dict = _cell_format.value
         else:
             raise ValueError("Improperly specified format specification.")
 
-        return _xl_book.add_format(_cell_fmt_dict)
+        return _xl_book.add_format(_cell_format_dict)
 
 
 def write_header(
@@ -550,29 +550,57 @@ def array_to_sheet(
     return _bottom_row_id, _right_column_id
 
 
+@overload
+def scalar_to_sheet(
+    _xl_book: Workbook,
+    _xl_sheet: Worksheet,
+    _address0: str,
+    _value: Any,
+    _format: CFmt | Sequence[CFmt | Sequence[CFmt]] | None,
+    /,
+) -> None: ...
+
+
+@overload
 def scalar_to_sheet(
     _xl_book: Workbook,
     _xl_sheet: Worksheet,
+    _address0: int,
+    _address1: int,
+    _value: Any,
+    _format: CFmt | Sequence[CFmt | Sequence[CFmt]] | None,
     /,
-    *_s2s_args: tuple[str, Any, CFmt | Sequence[CFmt | Sequence[CFmt]] | None]
-    | tuple[int, int, Any, CFmt | Sequence[CFmt | Sequence[CFmt]] | None],
+) -> None: ...
+
+
+def scalar_to_sheet(
+    _xl_book: Workbook, _xl_sheet: Worksheet, /, *_s2s_args: Any
 ) -> None:
     """
     Write to a single cell in a worksheet.
 
     Parameters
     ----------
+    _xl_book
+        Workbook object for defining formats, and writing data
+
     _xl_sheet
-        Worksheet object to which to write the give array
+        Worksheet object to which to write the given scalar
+
+    _cell_addr
+        An Excel cell address string in 'A1' format
+
+    _address0
+        Index-0 row number of destintaion cell
+
+    _address1
+        Index-0 column number of destintaion cell
 
-    _cell_addr_0
-        First element of a cell address, which may be the entire address
-        in 'A1' format or the row-part in 'Row-column' format
+    _value
+        Value to write
 
-    _s2s_args
-        Other arguments, which may be just the cell value to be written and the
-        cell format, or the column-part of the 'Row-column' address along with
-        cell value and cell format.
+    _format
+        Member of :class:`CFmt`, or tuple thereof
 
     Raises
     ------
@@ -592,39 +620,42 @@ def scalar_to_sheet(
 
     """
 
-    _cell_addr: tuple[str] | tuple[int, int]
-    _cell_val: Any
-    _cell_fmt: CFmt | Sequence[CFmt | Sequence[CFmt]] | None
+    _address: tuple[str] | tuple[int, int]
+    _value: Any
+    _format: CFmt | Sequence[CFmt | Sequence[CFmt]] | None
 
     if isinstance(_s2s_args[0], str):
         if len(_s2s_args) not in (2, 3):
             raise ValueError("Incorrect number of arguments.")
-        _cell_addr = (_s2s_args[0],)
-        _cell_val = _s2s_args[0]
-        _cell_fmt = _s2s_args[1] if len(_s2s_args) == 2 else None
+        _address = (_s2s_args[0],)
+        _value = _s2s_args[1]
+        _format = _s2s_args[2] if len(_s2s_args) == 3 else None
     elif isinstance(_s2s_args[0], int):
         if not isinstance(_s2s_args[1], int) or len(_s2s_args) not in (3, 4):
             print(repr(_s2s_args))
             raise ValueError("Incorrect/incomplete specification for Excel cell data.")
-        _cell_addr = _s2s_args[:2]
-        _cell_val = _s2s_args[2]
-        _cell_fmt = _s2s_args[3] if len(_s2s_args) == 3 else None
+        _address = _s2s_args[:2]
+        _value = _s2s_args[2]
+        _format = _s2s_args[3] if len(_s2s_args) == 4 else None
     else:
         raise ValueError("Incorrect/incomplete specification for Excel cell data.")
 
     _write_args = (
-        (*_cell_addr, repr(_cell_val))
-        if np.ndim(_cell_val) or _cell_val in (np.inf, -np.inf, np.nan)
-        else (*_cell_addr, _cell_val)
+        *_address,
+        (
+            repr(_value)
+            if np.ndim(_value) or _value in (np.inf, -np.inf, np.nan)
+            else _value
+        ),
     )
-    _write_args += (CFmt.xl_fmt(_xl_book, _cell_fmt),) if _cell_fmt else ()
+    _write_args += (CFmt.xl_fmt(_xl_book, _format),) if _format else ()
 
-    if _cell_val is None or _cell_val == "":
+    if _value is None or _value == "":
         _xl_sheet.write_blank(*_write_args)
     elif (
-        isinstance(_cell_val, str)
-        or np.ndim(_cell_val)
-        or _cell_val in (np.inf, -np.inf, np.nan)
+        isinstance(_value, str)
+        or np.ndim(_value)
+        or _value in (np.inf, -np.inf, np.nan)
     ):
         _xl_sheet.write_string(*_write_args)
     else: