mergeron_extra 2024.739148.0__tar.gz → 2024.739148.5__tar.gz

{mergeron_extra-2024.739148.0 → mergeron_extra-2024.739148.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron_extra
-Version: 2024.739148.0
+Version: 2024.739148.5
 Summary: Tools for users of the mergeron package.
 License: MIT
 Author: Murthy Kambhampaty
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: aenum (>=3.1.15,<4.0.0)
 Requires-Dist: certifi (>=2023.11.17)
 Requires-Dist: matplotlib (>=3.8)
-Requires-Dist: numpy (>=1.26)
+Requires-Dist: numpy (>=2.0)
 Requires-Dist: scipy (>=1.12)
 Requires-Dist: xlsxwriter (>=3.1)
 Description-Content-Type: text/x-rst

{mergeron_extra-2024.739148.0 → mergeron_extra-2024.739148.5}/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.0"
+version = "2024.739148.5"
 
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -30,7 +30,7 @@ build-backend = "poetry.core.masonry.api"
 # if poetry dependency resolution appears to hang (read the page at link to the end)
 aenum = "^3.1.15"
 matplotlib = ">=3.8"
-numpy = ">=1.26"
+numpy = ">=2.0"
 python = "^3.12"
 scipy = ">=1.12"
 xlsxwriter = ">=3.1"
@@ -147,6 +147,7 @@ preview = true
 python_version = "3.12"
 ignore_missing_imports = false
 strict = true
+enable_incomplete_feature = ["NewGenericSyntax", "PreciseTupleTypes"]
 
 show_column_numbers = true
 show_error_codes = true
@@ -155,8 +156,6 @@ show_error_context = true
 no_implicit_optional = true
 no_implicit_reexport = true
 
-allow_redefinition = true
-
 plugins = "numpy.typing.mypy_plugin"
 
 [tool.pytest.ini_options]

{mergeron_extra-2024.739148.0 → mergeron_extra-2024.739148.5}/src/mergeron_extra/__init__.py

@@ -1,25 +1,12 @@
 from __future__ import annotations
 
-from pathlib import Path
-
 import numpy as np
 from numpy.typing import NDArray
 
-_PKG_NAME: str = Path(__file__).parent.stem
-
-VERSION = "2024.739097.4"
+VERSION = "2024.739148.5"
 
 __version__ = VERSION
 
-DATA_DIR: Path = Path.home() / _PKG_NAME
-"""
-Defines a subdirectory named for this package in the user's home path.
-
-If the subdirectory doesn't exist, it is created on package invocation.
-"""
-if not DATA_DIR.is_dir():
-    DATA_DIR.mkdir(parents=False)
-
 np.set_printoptions(precision=24, floatmode="fixed")
 
 type ArrayBoolean = NDArray[np.bool_]

{mergeron_extra-2024.739148.0 → mergeron_extra-2024.739148.5}/src/mergeron_extra/tol_colors.py

@@ -9,11 +9,11 @@ All rights reserved.
 License:  Standard 3-clause BSD
 """
 
-__version__ = "2022.10"
+__version__ = "2022.10.p0"
 
 from collections import namedtuple
 from collections.abc import Callable, Sequence
-from typing import Literal
+from typing import Final, Literal, TypeAlias
 
 import numpy as np
 from matplotlib.colors import LinearSegmentedColormap, to_rgba_array
@@ -54,7 +54,7 @@ class TOLcmaps:
         """
         # self.cmap: LinearSegmentedColormap | None = None
         self.cname: str = ""
-        self.namelist: Sequence[str] = (
+        self.namelist: Final = (
             "sunset_discrete",
             "sunset",
             "nightfall_discrete",
@@ -648,9 +648,7 @@ class TOLcmaps:
         return self.cmap
 
 
-def tol_cmap(
-    colormap: str | None = None, lut: int | None = None
-) -> Sequence[str] | LinearSegmentedColormap:
+def tol_cmap(colormap: str, lut: int | None = None) -> LinearSegmentedColormap:
     """
     Continuous and discrete color sets for ordered data.
 
@@ -658,8 +656,6 @@ def tol_cmap(
     Parameter lut is ignored for all colormaps except 'rainbow_discrete'.
     """
     obj = TOLcmaps()
-    if colormap is None:
-        return obj.namelist
     if colormap not in obj.namelist:
         colormap = "rainbow_PuRd"
         print(
@@ -670,6 +666,10 @@ def tol_cmap(
     return obj.get(colormap, lut)
 
 
+TCName: TypeAlias = Literal[
+    "bright", "high-contrast", "vibrant", "muted", "medium-contrast", "light"
+]
+TCNameList: TypeAlias = tuple[TCName, ...]
 Bcset = namedtuple("Bcset", "blue red green yellow cyan purple grey black")
 Hcset = namedtuple("Hcset", "blue yellow red black")
 Vcset = namedtuple("Vcset", "orange blue cyan magenta red teal grey black")
@@ -685,9 +685,19 @@ Lcset = namedtuple(
 )
 
 
+QL_NAME_LIST: TCNameList = (
+    "bright",
+    "high-contrast",
+    "vibrant",
+    "muted",
+    "medium-contrast",
+    "light",
+)
+
+
 def tol_cset(  # noqa: PLR0911
-    colorset: str | None = None,
-) -> Sequence[str] | Bcset | Hcset | Vcset | Muset | Mcset | Lcset:
+    colorset: TCName | None,
+) -> Bcset | Hcset | Vcset | Muset | Mcset | Lcset:
     """
     Discrete color sets for qualitative data.
 
@@ -698,15 +708,6 @@ def tol_cset(  # noqa: PLR0911
     - list(cset) gives a list with all colors
     """
 
-    namelist = (
-        "bright",
-        "high-contrast",
-        "vibrant",
-        "muted",
-        "medium-contrast",
-        "light",
-    )
-
     Bcinst = Bcset(
         "#4477AA",
         "#EE6677",
@@ -718,13 +719,10 @@ def tol_cset(  # noqa: PLR0911
         "#000000",
     )
 
-    if colorset is None:
-        return namelist
-
-    elif colorset == "bright":
+    if colorset == "bright":
         return Bcinst
 
-    elif colorset == "high-contrast":
+    if colorset == "high-contrast":
         return Hcset("#004488", "#DDAA33", "#BB5566", "#000000")
 
     elif colorset == "vibrant":
@@ -776,7 +774,7 @@ def tol_cset(  # noqa: PLR0911
         colorset = "bright"
         print(
             "*** Warning: requested colorset not defined,",
-            "known colorsets are {}.".format(namelist),  # noqa: UP032
+            "known colorsets are {}.".format(QL_NAME_LIST),  # noqa: UP032
             "Using {}.".format(colorset),  # noqa: UP032
         )
         return Bcinst
@@ -790,27 +788,27 @@ def main() -> None:
     #    plt.cm.register_cmap('rainbow_PuRd', tol_cmap('rainbow_PuRd'))
     #    plt.rc('image', cmap='rainbow_PuRd')
     # Show colorsets tol_cset(<scheme>).
-    schemes: Sequence[str] = tol_cset()
-    fig, axes = plt.subplots(ncols=len(schemes), figsize=(9, 3))
+    ql_schemes: TCNameList = QL_NAME_LIST
+    fig, axes = plt.subplots(ncols=len(ql_schemes), figsize=(9, 3))
     fig.subplots_adjust(top=0.9, bottom=0.02, left=0.02, right=0.92)
-    for ax, scheme in zip(axes, schemes):  # type: ignore
-        cset = tol_cset(scheme)
-        names = cset._fields  # type: ignore
+    for ax, ql_scheme in zip(axes, ql_schemes):
+        cset = tol_cset(ql_scheme)
+        names = cset._fields
         colors = list(cset)
         for name, color in zip(names, colors):
             ax.scatter([], [], c=color, s=80, label=name)
         ax.set_axis_off()
         ax.legend(loc=2)
-        ax.set_title(scheme)
+        ax.set_title(ql_scheme)
     plt.show()
 
     # Show colormaps tol_cmap(<scheme>).
-    schemes: Sequence[str] = tol_cmap()  # type: ignore
+    schemes = TOLcmaps().namelist
     gradient = np.linspace(0, 1, 256)
     gradient = np.vstack((gradient, gradient))
     fig, axes = plt.subplots(nrows=len(schemes))
     fig.subplots_adjust(top=0.98, bottom=0.02, left=0.2, right=0.99)
-    for ax, scheme in zip(axes, schemes):  # type: ignore
+    for ax, scheme in zip(axes, schemes):
         pos = list(ax.get_position().bounds)
         ax.set_axis_off()
         ax.imshow(gradient, aspect=4, cmap=tol_cmap(scheme))
@@ -829,7 +827,7 @@ def main() -> None:
     gradient = np.vstack((gradient, gradient))
     fig, axes = plt.subplots(nrows=23)
     fig.subplots_adjust(top=0.98, bottom=0.02, left=0.25, right=0.99)
-    for lut, ax in enumerate(axes, start=1):  # type: ignore
+    for lut, ax in enumerate(axes, start=1):
         pos = list(ax.get_position().bounds)
         ax.set_axis_off()
         ax.imshow(gradient, aspect=4, cmap=tol_cmap("rainbow_discrete", lut))

{mergeron_extra-2024.739148.0 → mergeron_extra-2024.739148.5}/src/mergeron_extra/xlsxw_helper.py

@@ -24,14 +24,15 @@ https://mit-license.org/
 from __future__ import annotations
 
 from collections.abc import Sequence
+from types import MappingProxyType
 from typing import Any, ClassVar, Literal, TypeAlias, TypedDict
 
 import numpy as np
 from aenum import Enum, extend_enum, unique  # type: ignore
 from numpy.typing import NDArray
-from xlsxwriter.format import Format
-from xlsxwriter.workbook import Workbook
-from xlsxwriter.worksheet import Worksheet
+from xlsxwriter.format import Format  # type: ignore
+from xlsxwriter.workbook import Workbook  # type: ignore
+from xlsxwriter.worksheet import Worksheet  # type: ignore
 
 from . import VERSION
 
@@ -150,49 +151,52 @@ class CFmt(Enum):  # type: ignore
 
     """
 
-    XL_DEFAULT: ClassVar = {"font_name": "Calibri", "font_size": 11}
-    XL_DEFAULT_2003: ClassVar = {"font_name": "Arial", "font_size": 10}
-
-    A_CTR: ClassVar = {"align": "center"}
-    A_CTR_ACROSS: ClassVar = {"align": "center_across"}
-    A_LEFT: ClassVar = {"align": "left"}
-    A_RIGHT: ClassVar = {"align": "right"}
-    V_TOP: ClassVar = {"align": "top"}
-    V_BOTTOM: ClassVar = {"align": "bottom"}
-    V_CTR: ClassVar = {"align": "vcenter"}
-
-    TEXT_WRAP: ClassVar = {"text_wrap": True}
-    TEXT_ROTATE: ClassVar = {"rotation": 90}
-    IND_1: ClassVar = {"indent": 1}
-
-    BOLD: ClassVar = {"bold": True}
-    BOLD_ITALIC: ClassVar = {"bold": True, "italic": True}
-    ITALIC: ClassVar = {"italic": True}
-    ULINE: ClassVar = {"underline": "single"}
-    SOUT: ClassVar = {"font_strikeout": True}
+    XL_DEFAULT: ClassVar = MappingProxyType({"font_name": "Calibri", "font_size": 11})
+    XL_DEFAULT_2003: ClassVar = MappingProxyType({
+        "font_name": "Arial",
+        "font_size": 10,
+    })
+
+    A_CTR: ClassVar = MappingProxyType({"align": "center"})
+    A_CTR_ACROSS: ClassVar = MappingProxyType({"align": "center_across"})
+    A_LEFT: ClassVar = MappingProxyType({"align": "left"})
+    A_RIGHT: ClassVar = MappingProxyType({"align": "right"})
+    V_TOP: ClassVar = MappingProxyType({"align": "top"})
+    V_BOTTOM: ClassVar = MappingProxyType({"align": "bottom"})
+    V_CTR: ClassVar = MappingProxyType({"align": "vcenter"})
+
+    TEXT_WRAP: ClassVar = MappingProxyType({"text_wrap": True})
+    TEXT_ROTATE: ClassVar = MappingProxyType({"rotation": 90})
+    IND_1: ClassVar = MappingProxyType({"indent": 1})
+
+    BOLD: ClassVar = MappingProxyType({"bold": True})
+    BOLD_ITALIC: ClassVar = MappingProxyType({"bold": True, "italic": True})
+    ITALIC: ClassVar = MappingProxyType({"italic": True})
+    ULINE: ClassVar = MappingProxyType({"underline": "single"})
+    SOUT: ClassVar = MappingProxyType({"font_strikeout": True})
     # Useful with write_rich_text()
-    SUPERSCRIPT: ClassVar = {"font_script": 1}
-    SUBSCRIPT: ClassVar = {"font_script": 2}
-
-    AREA_NUM: ClassVar = {"num_format": "0.00000000"}
-    DOLLAR_NUM: ClassVar = {"num_format": "[$$-409]#,##0.00"}
-    DT_NUM: ClassVar = {"num_format": "mm/dd/yyyy"}
-    PCT_NUM: ClassVar = {"num_format": "##0%"}
-    PCT2_NUM: ClassVar = {"num_format": "##0.00%"}
-    PCT4_NUM: ClassVar = {"num_format": "##0.0000%"}
-    PCT6_NUM: ClassVar = {"num_format": "##0.000000%"}
-    PCT8_NUM: ClassVar = {"num_format": "##0.00000000%"}
-    QTY_NUM: ClassVar = {"num_format": "#,##0.0"}
-
-    BAR_FILL: ClassVar = {"pattern": 1, "bg_color": "dfeadf"}
-    HDR_FILL: ClassVar = {"pattern": 1, "bg_color": "bfbfbf"}
-
-    FULL_BORDER: ClassVar = {"border": 1, "border_color": "000000"}
-    BOTTOM_BORDER: ClassVar = {"bottom": 1, "bottom_color": "000000"}
-    LEFT_BORDER: ClassVar = {"left": 1, "left_color": "000000"}
-    RIGHT_BORDER: ClassVar = {"right": 1, "right_color": "000000"}
-    TOP_BORDER: ClassVar = {"top": 1, "top_color": "000000"}
-    HDR_BORDER: ClassVar = TOP_BORDER | BOTTOM_BORDER
+    SUPERSCRIPT: ClassVar = MappingProxyType({"font_script": 1})
+    SUBSCRIPT: ClassVar = MappingProxyType({"font_script": 2})
+
+    AREA_NUM: ClassVar = MappingProxyType({"num_format": "0.00000000"})
+    DOLLAR_NUM: ClassVar = MappingProxyType({"num_format": "[$$-409]#,##0.00"})
+    DT_NUM: ClassVar = MappingProxyType({"num_format": "mm/dd/yyyy"})
+    PCT_NUM: ClassVar = MappingProxyType({"num_format": "##0%"})
+    PCT2_NUM: ClassVar = MappingProxyType({"num_format": "##0.00%"})
+    PCT4_NUM: ClassVar = MappingProxyType({"num_format": "##0.0000%"})
+    PCT6_NUM: ClassVar = MappingProxyType({"num_format": "##0.000000%"})
+    PCT8_NUM: ClassVar = MappingProxyType({"num_format": "##0.00000000%"})
+    QTY_NUM: ClassVar = MappingProxyType({"num_format": "#,##0.0"})
+
+    BAR_FILL: ClassVar = MappingProxyType({"pattern": 1, "bg_color": "dfeadf"})
+    HDR_FILL: ClassVar = MappingProxyType({"pattern": 1, "bg_color": "bfbfbf"})
+
+    FULL_BORDER: ClassVar = MappingProxyType({"border": 1, "border_color": "000000"})
+    BOTTOM_BORDER: ClassVar = MappingProxyType({"bottom": 1, "bottom_color": "000000"})
+    LEFT_BORDER: ClassVar = MappingProxyType({"left": 1, "left_color": "000000"})
+    RIGHT_BORDER: ClassVar = MappingProxyType({"right": 1, "right_color": "000000"})
+    TOP_BORDER: ClassVar = MappingProxyType({"top": 1, "top_color": "000000"})
+    HDR_BORDER: ClassVar = MappingProxyType(TOP_BORDER | BOTTOM_BORDER)
 
     @classmethod
     def add_new(cls, _fmt_name: str, _xlsx_fmt_dict: CFmtVal, /) -> CFmt:
@@ -401,7 +405,6 @@ def array_to_sheet(
     /,
     *,
     cell_format: Sequence[CFmt | Sequence[CFmt]] | CFmt | None = None,
-    empty_as_blank: bool = True,
     green_bar_flag: bool = True,
     ragged_flag: bool = True,
 ) -> tuple[int, int]:
@@ -510,11 +513,11 @@ def array_to_sheet(
         elif not len(cell_format) == len(_data_table[0]):
             raise ValueError("Format tuple does not match data in length.")
         CFmt.ensure_cell_format_spec_tuple(cell_format)
-        _cell_format: Sequence[CFmt | Sequence[CFmt]] = cell_format
+        _cell_format = cell_format
     elif isinstance(cell_format, CFmt):
         _cell_format = (cell_format,) * len(_data_table[0])
     else:
-        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])  # pyright: ignore
+        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])
 
     # construct vector of xlslwrter.format.Format objects
     _wbk_formats = tuple(CFmt.xl_fmt(_xl_book, _cf) for _cf in _cell_format)
@@ -538,17 +541,11 @@ def array_to_sheet(
         _wbk_fmt_tuple = _wbk_formats_greened if _ri % 2 else _wbk_formats
         for _ci, _cv in enumerate(_rv):
             _cf = _wbk_fmt_tuple[_ci]
-            scalar_to_sheet(
-                _xl_book,
-                _xl_sheet,
-                _row_id + _ri,
-                _col_id + _ci,
-                _cv,
-                _cf,
-                empty_as_blank=empty_as_blank,
-            )
+            scalar_to_sheet(_xl_book, _xl_sheet, _row_id + _ri, _col_id + _ci, _cv, _cf)
 
-        _right_column_id = _col_id + _ci + 1 if _ci > _num_cols else _right_column_id
+        _right_column_id = (
+            _col_id + len(_rv) if len(_rv) > _num_cols else _right_column_id
+        )
 
     return _bottom_row_id, _right_column_id
 
@@ -559,7 +556,6 @@ def scalar_to_sheet(
     _cell_addr_0: str | int = "A1",
     /,
     *_s2s_args: Any,
-    empty_as_blank: bool = True,
 ) -> None:
     """
     Write to a single cell in a worksheet.
@@ -625,12 +621,10 @@ def scalar_to_sheet(
         (*_write_args, CFmt.xl_fmt(_xl_book, _cell_fmt)) if _cell_fmt else _write_args
     )
 
-    if empty_as_blank and (_cell_val is None or _cell_val == ""):
+    if _cell_val is None or _cell_val == "":
         _xl_sheet.write_blank(*_write_args)
     elif (
-        _cell_val is None
-        or _cell_val == ""
-        or isinstance(_cell_val, str)
+        isinstance(_cell_val, str)
         or np.ndim(_cell_val)
         or _cell_val in (np.inf, -np.inf, np.nan)
     ):