heatmap_cli 0.25.3__tar.gz → 0.25.4__tar.gz

{heatmap_cli-0.25.3/src/heatmap_cli.egg-info → heatmap_cli-0.25.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: heatmap_cli
-Version: 0.25.3
+Version: 0.25.4
 Summary: A console program that generates a yearly calendar heatmap.
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
 License-Expression: AGPL-3.0-or-later

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/pyproject.toml

@@ -25,7 +25,7 @@ classifiers = [
     "Programming Language :: Python",
     "Topic :: Scientific/Engineering :: Visualization",
 ]
-version = "0.25.3"
+version = "0.25.4"
 keywords = ["heatmap", "cli", "visualization", "calendar", "data-viz"]
 dependencies = [
     "matplotlib",

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/src/heatmap_cli/__init__.py

@@ -31,7 +31,6 @@ import matplotlib as mpl
 import matplotlib.pyplot as plt
 import pandas as pd
 import seaborn as sns
-from PIL import Image
 
 from heatmap_cli.heatmap import _get_output_dir
 from heatmap_cli.heatmap import run as generate_heatmaps
@@ -194,7 +193,7 @@ class EnvironmentAction(argparse.Action):
             for name, version in (
                 ("matplotlib", mpl.__version__),
                 ("pandas", pd.__version__),
-                ("pillow", Image.__version__),
+                ("pillow", metadata.version("pillow")),
                 ("seaborn", sns.__version__),
             )
         )

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/src/heatmap_cli/cli.py

@@ -43,6 +43,7 @@ from heatmap_cli import (
     setup_logging,
 )
 from heatmap_cli.heatmap import (
+    _sanitize_string_for_filename,
     _weeks_in_iso_year,
 )
 from heatmap_cli.heatmap import (
@@ -208,8 +209,8 @@ def build_parser() -> argparse.ArgumentParser:
         type=_valid_date,
         default=None,
         help=(
-            "filter from the date of the year from the CSV file "
-            "(default: %(default)s)"
+            "filter from the date of the year from the CSV file and "
+            "this will overwrite -y and -w option (default: %(default)s)"
         ),
         metavar="START_DATE",
     )
@@ -424,6 +425,49 @@ def _generate_cmap_help() -> str:
     return cmap_help + cmap_default + "\n" + cmap_choices.rstrip()
 
 
+def _resolve_date_filter_overrides(
+    parsed_args: argparse.Namespace,
+) -> None:
+    """Apply --start-date/--end-date overrides to the year and week filters.
+
+    A --start-date/--end-date pair defines a self-contained calendar date
+    range that overrides the -y/--year and -w/--week cutoff, avoiding a
+    double filter between the ISO-week year column and the raw date column.
+    When only one endpoint is given it derives a partial-year view; when
+    both are given --end-date wins for the year/week since it caps the range.
+
+    Args:
+        parsed_args (argparse.Namespace): The newly parsed arguments.
+
+    Returns:
+        None
+    """
+    # Capture the user-supplied filters before --end-date/--start-date clobber
+    # them, so the overriding of -y/-w is reported instead of happening
+    # silently.
+    explicit_year = parsed_args.year
+    explicit_week = parsed_args.week
+
+    if parsed_args.end_date:
+        (year, week, _day) = parsed_args.end_date.isocalendar()
+        parsed_args.year = [year]
+        parsed_args.week = week
+    elif parsed_args.start_date:
+        if explicit_year is not None:
+            logger.warning(
+                "argument --start-date: --year is ignored when "
+                "--start-date is used.",
+            )
+        if explicit_week is not None:
+            logger.warning(
+                "argument --start-date: --week is ignored when "
+                "--start-date is used.",
+            )
+        (year, _week, _day) = parsed_args.start_date.isocalendar()
+        parsed_args.year = [year]
+        parsed_args.week = _weeks_in_iso_year(year)
+
+
 def _process_args(
     parser: argparse.ArgumentParser,
     parsed_args: argparse.Namespace,
@@ -445,14 +489,7 @@ def _process_args(
     # double filter between the ISO-week year column and the raw date column.
     # When only one endpoint is given it derives a partial-year view; when
     # both are given --end-date wins for the year/week since it caps the range.
-    if parsed_args.end_date:
-        (year, week, _day) = parsed_args.end_date.isocalendar()
-        parsed_args.year = [year]
-        parsed_args.week = week
-    elif parsed_args.start_date:
-        (year, _week, _day) = parsed_args.start_date.isocalendar()
-        parsed_args.year = [year]
-        parsed_args.week = _weeks_in_iso_year(year)
+    _resolve_date_filter_overrides(parsed_args)
 
     if (
         parsed_args.start_date
@@ -479,6 +516,10 @@ def _process_args(
     if parsed_args.cmap is None:
         parsed_args.cmap = [DEFAULT_CMAP]
 
+    # Reject titles that sanitize to an empty string, which would otherwise
+    # yield a degenerate filename like 001__<cmap>.png.
+    _validate_title(parser, parsed_args.title)
+
     # A GIF output is only ever produced by the animation path, so asking for
     # gif implies --animate-by-week; otherwise fig.savefig(format="gif") would
     # emit a single-frame still instead of an animation.
@@ -488,6 +529,23 @@ def _process_args(
     return parsed_args
 
 
+def _validate_title(
+    parser: argparse.ArgumentParser,
+    title: str | None,
+) -> None:
+    """Reject titles that would produce a degenerate filename.
+
+    Args:
+        parser (argparse.ArgumentParser): The argument parser instance.
+        title (str | None): The title value from the command line.
+
+    Returns:
+        None
+    """
+    if title is not None and not _sanitize_string_for_filename(title):
+        parser.error("argument --title: cannot be empty or symbolic only.")
+
+
 def main(args: Sequence[str] | None = None) -> None:
     """Run the main program flow.
 
@@ -510,6 +568,8 @@ def main(args: Sequence[str] | None = None) -> None:
 
         processed_args = _process_args(parser, parsed_args)
         setup_logging(processed_args)
+        if processed_args.seed is not None and not processed_args.demo:
+            logger.warning("--seed is ignored unless --demo is used")
         if processed_args.demo:
             generate_demo(processed_args)
             return

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/src/heatmap_cli/heatmap.py

@@ -300,14 +300,21 @@ def _generate_heatmap_wrapper(
     cmap: str,
     config: argparse.Namespace,
     dataframe: pd.DataFrame,
-) -> Image.Image | Path | None:
-    """Wrapper for _generate_heatmap to handle args in Pool."""
-    return _generate_heatmap(
-        seq,
-        cmap,
-        config,
-        dataframe,
-        return_image=False,
+) -> Path | None:
+    """Wrapper for _generate_heatmap to handle args in Pool.
+
+    Workers always save to disk (``return_image=False``), so the result is a
+    file Path, never an in-memory image.
+    """
+    return cast(
+        "Path | None",
+        _generate_heatmap(
+            seq,
+            cmap,
+            config,
+            dataframe,
+            return_image=False,
+        ),
     )
 
 

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4/src/heatmap_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: heatmap_cli
-Version: 0.25.3
+Version: 0.25.4
 Summary: A console program that generates a yearly calendar heatmap.
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
 License-Expression: AGPL-3.0-or-later

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/tests/test_demo_option.py

@@ -109,6 +109,28 @@ def test_demo_with_purge_survives(cli_runner):
     assert "Input file not found" not in ret.stderr
 
 
+def test_seed_without_demo_warns(cli_runner, csv_file):
+    csv = csv_file("sample.csv")
+    ret = cli_runner(
+        csv,
+        "-y",
+        "2024",
+        "-w",
+        "52",
+        "--seed",
+        "42",
+        expect_error=False,
+    )
+    assert ret.returncode == 0
+    assert "--seed is ignored unless --demo is used" in ret.stderr
+
+
+def test_seed_with_demo_no_warning(cli_runner):
+    ret = cli_runner("--demo", 1, "--seed", "42", expect_error=False)
+    assert ret.returncode == 0
+    assert "--seed is ignored unless --demo is used" not in ret.stderr
+
+
 def test_demo_with_tilde_output_dir(cli_runner, monkeypatch, tmpdir):
     """--demo must expand ~ in --output-dir like the rest of the pipeline."""
     home = Path(tmpdir, "home")

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/tests/test_start_date_option.py

@@ -76,3 +76,25 @@ def test_start_date_overrides_year_cutoff(cli_runner, csv_file):
     csv = csv_file("sample.csv")
     ret = cli_runner(csv, "-d", "-s", "2023-06-01", "--year", "2024")
     assert "year=[2023]" in ret.stderr
+
+
+def test_start_date_warns_when_year_overridden(cli_runner, csv_file):
+    """Passing -y with --start-date must warn that -y is ignored."""
+    csv = csv_file("sample.csv")
+    ret = cli_runner(csv, "-s", "2023-06-01", "--year", "2024")
+    assert "argument --start-date: --year is ignored when" in ret.stderr
+
+
+@pytest.mark.parametrize("option", ["-w", "--week"])
+def test_start_date_warns_when_week_overridden(cli_runner, csv_file, option):
+    """Passing -w with --start-date must warn that -w is ignored."""
+    csv = csv_file("sample.csv")
+    ret = cli_runner(csv, "-s", "2023-06-01", option, "20")
+    assert "argument --start-date: --week is ignored when" in ret.stderr
+
+
+def test_start_date_alone_no_override_warning(cli_runner, csv_file):
+    """--start-date used alone must not emit an override warning."""
+    csv = csv_file("sample.csv")
+    ret = cli_runner(csv, "-s", "2023-06-01")
+    assert "is ignored when --start-date" not in ret.stderr

{heatmap_cli-0.25.3 → heatmap_cli-0.25.4}/tests/test_title_option.py

@@ -25,6 +25,20 @@ def test_debug_logs(cli_runner, csv_file, option):
     assert "my title is foobar" in ret.stderr
 
 
+@pytest.mark.parametrize("option", ["-t", "--title"])
+def test_empty_title_rejected(cli_runner, csv_file, option):
+    csv = csv_file("sample.csv")
+    ret = cli_runner(csv, "-y", "2024", option, "")
+    assert "argument --title: cannot be empty or symbolic only." in ret.stderr
+
+
+@pytest.mark.parametrize("option", ["-t", "--title"])
+def test_symbols_only_title_rejected(cli_runner, csv_file, option):
+    csv = csv_file("sample.csv")
+    ret = cli_runner(csv, "-y", "2024", option, "!!!")
+    assert "argument --title: cannot be empty or symbolic only." in ret.stderr
+
+
 def test_default_title(cli_runner, csv_file):
     csv = csv_file("sample.csv")
     ret = cli_runner(csv, "-y", "2024", "-d", "-w", "42")