pyplotutil 2.0.0__py3-none-any.whl

pyplotutil/__init__.py

@@ -0,0 +1,70 @@
+"""Plotting and data handling utility package."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+from pyplotutil.datautil import BaseData, Data, Dataset, TaggedData
+from pyplotutil.loggingutil import (
+    FakeLogger,
+    check_level,
+    event_logger,
+    evlog,
+    get_event_logger_filename,
+    get_logging_level_from_verbose_count,
+    start_event_logging,
+    start_logging,
+)
+from pyplotutil.plotutil import (
+    apply_ieee_style,
+    apply_nature_style,
+    apply_notebook_style,
+    apply_science_style,
+    apply_style,
+    calculate_mean_err,
+    compatible_filename,
+    extract_common_path,
+    fill_between_err,
+    get_limits,
+    get_tlim_mask,
+    make_figure_paths,
+    plot_mean_err,
+    plot_multi_timeseries,
+    save_figure,
+)
+
+try:
+    __version__ = version("pyplotutil")
+except PackageNotFoundError:  # pragma: no cover -- only when the package is not installed
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "BaseData",
+    "Data",
+    "Dataset",
+    "FakeLogger",
+    "TaggedData",
+    "__version__",
+    "apply_ieee_style",
+    "apply_nature_style",
+    "apply_notebook_style",
+    "apply_science_style",
+    "apply_style",
+    "calculate_mean_err",
+    "check_level",
+    "compatible_filename",
+    "event_logger",
+    "evlog",
+    "extract_common_path",
+    "fill_between_err",
+    "get_event_logger_filename",
+    "get_limits",
+    "get_logging_level_from_verbose_count",
+    "get_tlim_mask",
+    "make_figure_paths",
+    "plot_mean_err",
+    "plot_multi_timeseries",
+    "save_figure",
+    "start_event_logging",
+    "start_logging",
+]

pyplotutil/_typing.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from enum import Enum, auto
+from io import StringIO
+from pathlib import Path
+from typing import Any, Final, Literal, TypeAlias, TypeVar
+
+import numpy as np
+import polars as pl
+
+Unknown: TypeAlias = Any
+FilePath: TypeAlias = str | Path
+DataSourceType: TypeAlias = FilePath | StringIO | pl.DataFrame | pl.Series
+NumericType: TypeAlias = int | float | complex | np.number
+NumericTypeVar = TypeVar("NumericTypeVar", bound=NumericType)
+
+SingleIndexSelector: TypeAlias = int
+MultiIndexSelector: TypeAlias = slice | range | Sequence[int] | pl.Series | np.ndarray
+SingleNameSelector: TypeAlias = str
+MultiNameSelector: TypeAlias = slice | Sequence[str] | pl.Series | np.ndarray
+BooleanMask: TypeAlias = Sequence[bool] | pl.Series | np.ndarray
+SingleColSelector: TypeAlias = SingleIndexSelector | SingleNameSelector
+MultiColSelector: TypeAlias = MultiIndexSelector | MultiNameSelector | BooleanMask
+
+
+class _NoDefault(Enum):
+    """Enum to represent the absence of a default value in method parameters."""
+
+    no_default = auto()
+
+
+no_default: Final = _NoDefault.no_default
+NoDefault: TypeAlias = Literal[_NoDefault.no_default]
+
+# Local Variables:
+# jinx-local-words: "Enum"
+# End: