mergeron_extra 2024.739099.2__tar.gz → 2024.739099.6__tar.gz

{mergeron_extra-2024.739099.2 → mergeron_extra-2024.739099.6}/PKG-INFO

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

{mergeron_extra-2024.739099.2 → mergeron_extra-2024.739099.6}/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.739099.2"
+version = "2024.739099.6"
 
 classifiers = [
     "Development Status :: 4 - Beta",

{mergeron_extra-2024.739099.2 → mergeron_extra-2024.739099.6}/src/mergeron_extra/__init__.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from pathlib import Path
 
 import numpy as np
+from numpy.typing import NDArray
 
 _PKG_NAME: str = Path(__file__).parent.stem
 
@@ -19,5 +20,11 @@ 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")
 
-np.set_printoptions(precision=18)
+type ArrayBoolean = NDArray[np.bool_]
+type ArrayFloat = NDArray[np.half | np.single | np.double]
+type ArrayINT = NDArray[np.intp]
+
+type ArrayDouble = NDArray[np.double]
+type ArrayBIGINT = NDArray[np.int64]

{mergeron_extra-2024.739099.2 → mergeron_extra-2024.739099.6}/src/mergeron_extra/proportions_tests.py

@@ -9,23 +9,20 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from dataclasses import dataclass
-from typing import Literal, TypeVar
+from typing import Literal
 
 import numpy as np
-from numpy.typing import NBitBase, NDArray
 from scipy.optimize import OptimizeResult, root  # type: ignore
 from scipy.stats import beta, chi2, norm  # type: ignore
 
-from . import TI, VERSION, ArrayDouble, ArrayINT
+from . import VERSION, ArrayDouble, ArrayINT
 
 __version__ = VERSION
 
-TI = TypeVar("TI", bound=NBitBase)
-
 
 def propn_ci(
-    _npos: ArrayINT[TI] | int = 4,
-    _nobs: ArrayINT[TI] | int = 10,
+    _npos: ArrayINT | int = 4,
+    _nobs: ArrayINT | int = 10,
     /,
     *,
     alpha: float = 0.05,
@@ -127,7 +124,7 @@ def propn_ci(
 
 
 def propn_ci_multinomial(
-    _counts: NDArray[np.integer[TI]],
+    _counts: ArrayINT,
     /,
     *,
     alpha: float = 0.05,
@@ -438,7 +435,7 @@ def _propn_diff_chisq_mn(
 
 
 def propn_diff_ci_multinomial(
-    _counts: NDArray[np.integer[TI]], /, *, alpha: float = 0.05
+    _counts: ArrayINT, /, *, alpha: float = 0.05
 ) -> ArrayDouble:
     """Estimate confidence intervals of pair-wise differences in multinomial proportions
 
@@ -480,7 +477,7 @@ class MultinomialPropnsTest:
 
 
 def propn_test_multinomial(
-    _counts: NDArray[np.integer[TI]], /, *, alpha: float = 0.05
+    _counts: ArrayINT, /, *, alpha: float = 0.05
 ) -> MultinomialPropnsTest:
     """Chi-square test for homogeneity of differences in multinomial proportions.
 

{mergeron_extra-2024.739099.2 → mergeron_extra-2024.739099.6}/src/mergeron_extra/xlsxw_helper.py

@@ -27,15 +27,16 @@ from collections.abc import Sequence
 from typing import Any, ClassVar, Literal, TypeAlias, TypedDict
 
 import numpy as np
-import xlsxwriter  # type: ignore
 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 . import VERSION
 
 __version__ = VERSION
 
-Workbook = xlsxwriter.Workbook
 
 XLBorderType: TypeAlias = Literal[
     "none",
@@ -132,7 +133,7 @@ class CFmtVal(TypedDict, total=False):
 
 
 @unique
-class CFmt(dict, Enum):  # type: ignore
+class CFmt(Enum):  # type: ignore
     """
     Cell format enums for xlsxwriter Format objects.
 
@@ -194,7 +195,7 @@ class CFmt(dict, Enum):  # type: ignore
     HDR_BORDER: ClassVar = TOP_BORDER | BOTTOM_BORDER
 
     @classmethod
-    def add_new(self, _fmt_name: str, _xlsx_fmt_dict: CFmtVal, /) -> CFmt:
+    def add_new(cls, _fmt_name: str, _xlsx_fmt_dict: CFmtVal, /) -> CFmt:
         """
         Add new :class:`CFmt` object to instance.
 
@@ -204,9 +205,9 @@ class CFmt(dict, Enum):  # type: ignore
             Name of new member to be added to :class:`CFmt`
         _xlsx_fmt_dict
             Any valid argument to :code:`xlsxwriter.Workbook.add_format()`, or union of
-            same with one or more :class:`CFmt` objects, e.g.,
-            :code:`CFmt.HDR_BORDER | CFmt.HDR_FILL`  or
-            :code:`CFmt.HDR_BORDER | {"pattern": 1, "bg_color": "f2f2f2"}`
+            same with the value of one or more :class:`CFmt` objects, e.g.,
+            :code:`CFmt.HDR_BORDER.value | CFmt.HDR_FILL.value`  or
+            :code:`CFmt.HDR_BORDER.value | {"pattern": 1, "bg_color": "f2f2f2"}`
 
         Returns
         -------
@@ -214,11 +215,11 @@ class CFmt(dict, Enum):  # type: ignore
 
         """
 
-        return extend_enum(self, _fmt_name, _xlsx_fmt_dict)  # type: ignore
+        return extend_enum(cls, _fmt_name, _xlsx_fmt_dict)  # type: ignore
 
     @classmethod
     def ensure_cell_format_spec_tuple(
-        self, _cell_format: Sequence[CFmt | Sequence[CFmt]], /
+        cls, _cell_format: Sequence[CFmt | Sequence[CFmt]], /
     ) -> bool:
         """
         Test that a given format specification is a tuple of :class:`CFmt` enums
@@ -242,7 +243,7 @@ class CFmt(dict, Enum):  # type: ignore
 
         for _cf in _cell_format:
             if isinstance(_cf, tuple):
-                self.ensure_cell_format_spec_tuple(_cf)
+                cls.ensure_cell_format_spec_tuple(_cf)
 
             if not (isinstance(_cf, CFmt),):
                 raise ValueError(
@@ -254,11 +255,11 @@ class CFmt(dict, Enum):  # type: ignore
 
     @classmethod
     def xl_fmt(
-        self,
-        _xl_book: xlsxwriter.Workbook,
+        cls,
+        _xl_book: Workbook,
         _cell_fmt: Sequence[CFmt | Sequence[CFmt]] | CFmt | None,
         /,
-    ) -> xlsxwriter.format.Format:
+    ) -> Format:
         """
         Return :code:`xlsxwriter` :code:`Format` object given a :class:`CFmt` enum, or tuple thereof.
 
@@ -274,7 +275,7 @@ class CFmt(dict, Enum):  # type: ignore
         ------
         ValueError
             If format specification is not one of None, a :class:`CFmt` enum, or
-            a :code:`xlsxwriter.format.Format` object
+            a :code:`Format` object
 
         Returns
         -------
@@ -282,20 +283,20 @@ class CFmt(dict, Enum):  # type: ignore
 
         """
 
-        if isinstance(_cell_fmt, xlsxwriter.format.Format):
+        if isinstance(_cell_fmt, Format):
             return _cell_fmt
         elif _cell_fmt is None:
             return _xl_book.add_format(CFmt.XL_DEFAULT.value)
 
         _cell_fmt_dict: CFmtVal = {}
         if isinstance(_cell_fmt, Sequence):
-            self.ensure_cell_format_spec_tuple(_cell_fmt)
+            cls.ensure_cell_format_spec_tuple(_cell_fmt)
             for _cf in _cell_fmt:
-                _cell_fmt_dict = (
-                    (_cell_fmt_dict | _cfi.value for _cfi in _cf)
-                    if isinstance(_cf, Sequence)
-                    else _cell_fmt_dict | _cf.value
-                )
+                if isinstance(_cf, Sequence):
+                    for _cfi in _cf:
+                        _cell_fmt_dict |= _cfi.value
+                else:
+                    _cell_fmt_dict |= _cf.value
         elif isinstance(_cell_fmt, CFmt):
             _cell_fmt_dict = _cell_fmt.value
         else:
@@ -305,7 +306,7 @@ class CFmt(dict, Enum):  # type: ignore
 
 
 def write_header(
-    _xl_sheet: xlsxwriter.worksheet.Worksheet,
+    _xl_sheet: Worksheet,
     /,
     *,
     center_header: str | None = None,
@@ -348,7 +349,7 @@ def write_header(
 
 
 def write_footer(
-    _xl_sheet: xlsxwriter.worksheet.Worksheet,
+    _xl_sheet: Worksheet,
     /,
     *,
     center_footer: str | None = None,
@@ -392,8 +393,8 @@ def write_footer(
 
 
 def array_to_sheet(
-    _xl_book: xlsxwriter.workbook.Workbook,
-    _xl_sheet: xlsxwriter.worksheet.Worksheet,
+    _xl_book: Workbook,
+    _xl_sheet: Worksheet,
     _data_table: Sequence[Any] | NDArray[Any],
     _row_id: int,
     _col_id: int = 0,
@@ -498,6 +499,7 @@ def array_to_sheet(
     _num_cols = len(_data_table[0])
     _right_column_id = _col_id + _num_cols
 
+    _cell_format: Sequence[CFmt | Sequence[CFmt]]
     if isinstance(cell_format, Sequence):
         if _num_rows > 1 and ragged_flag:
             raise ValueError(
@@ -512,10 +514,11 @@ def array_to_sheet(
     elif isinstance(cell_format, CFmt):
         _cell_format = (cell_format,) * len(_data_table[0])
     else:
-        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])
+        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])  # pyright: ignore
 
     # construct vector of xlslwrter.format.Format objects
     _wbk_formats = tuple(CFmt.xl_fmt(_xl_book, _cf) for _cf in _cell_format)
+    _wbk_formats_greened = _wbk_formats
     if _num_rows > 1:
         _wbk_formats_greened = (
             tuple(
@@ -536,6 +539,7 @@ def array_to_sheet(
         for _ci, _cv in enumerate(_rv):
             _cf = _wbk_fmt_tuple[_ci]
             scalar_to_sheet(
+                _xl_book,
                 _xl_sheet,
                 _row_id + _ri,
                 _col_id + _ci,
@@ -550,7 +554,8 @@ def array_to_sheet(
 
 
 def scalar_to_sheet(
-    _xl_sheet: xlsxwriter.worksheet.Worksheet,
+    _xl_book: Workbook,
+    _xl_sheet: Worksheet,
     _cell_addr_0: str | int = "A1",
     /,
     *_s2s_args: Any,
@@ -591,9 +596,9 @@ def scalar_to_sheet(
 
     """
 
-    _cell_addr: tuple[int | str, ...] = ()
-    _cell_val: Any = None
-    _cell_fmt: xlsxwriter.format.Format = CFmt.XL_DEFAULT
+    _cell_addr: tuple[str] | tuple[int, int]
+    _cell_val: Any
+    _cell_fmt: CFmt | Sequence[CFmt] | None
 
     if isinstance(_cell_addr_0, str):
         if len(_s2s_args) not in (1, 2):
@@ -603,6 +608,7 @@ def scalar_to_sheet(
         _cell_fmt = _s2s_args[1] if len(_s2s_args) == 2 else None
     elif isinstance(_cell_addr_0, int):
         if len(_s2s_args) not in (2, 3) or not isinstance(_s2s_args[0], int):
+            print(repr(_s2s_args))
             raise ValueError("Incorrect/incomplete specification for Excel cell data.")
         _cell_addr = (_cell_addr_0, _s2s_args[0])
         _cell_val = _s2s_args[1]
@@ -615,7 +621,9 @@ def scalar_to_sheet(
         if np.ndim(_cell_val) or _cell_val in (np.inf, -np.inf, np.nan)
         else (*_cell_addr, _cell_val)
     )
-    _write_args = (*_write_args, _cell_fmt) if _cell_fmt else _write_args
+    _write_args = (
+        (*_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 == ""):
         _xl_sheet.write_blank(*_write_args)