heatmap_cli 0.25.2__tar.gz → 0.25.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: heatmap_cli
-Version: 0.25.2
+Version: 0.25.3
 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.2 → heatmap_cli-0.25.3}/pyproject.toml

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

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

@@ -33,6 +33,7 @@ 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
 
 __version__ = metadata.version("heatmap_cli")
@@ -135,7 +136,9 @@ def generate_demo(config: argparse.Namespace) -> None:
     """
     random.seed(config.seed if config.seed is not None else DEFAULT_DEMO_SEED)
     config.cmap = random.sample(CMAPS, config.demo)
-    config.input_filename = str(_generate_sample_csv(config))
+    config.input_filename = str(
+        Path(config.output_dir) / DEMO_SAMPLE_FILENAME,
+    )
     generate_heatmaps(config)
 
 
@@ -162,7 +165,7 @@ def _generate_sample_csv(config: argparse.Namespace) -> Path:
     )
     df_dates["count"] = random.sample(range(DEMO_MAX_COUNT), len(df_dates))
 
-    csv_filename = Path(config.output_dir) / DEMO_SAMPLE_FILENAME
+    csv_filename = _get_output_dir(config) / DEMO_SAMPLE_FILENAME
     csv_filename.parent.mkdir(parents=True, exist_ok=True)
     df_dates.to_csv(csv_filename, sep=",", index=False, header=False)
     logger.debug("Generate sample CSV file: %s", csv_filename)

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

@@ -27,7 +27,7 @@ import shutil
 import webbrowser
 from datetime import date, datetime, timedelta, timezone
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, cast
 
 if TYPE_CHECKING:
     import argparse
@@ -106,6 +106,13 @@ def run(config: argparse.Namespace) -> None:
 
     _refresh_output_dir(config)
 
+    # For a demo the sample CSV is generated after the output directory is
+    # refreshed, so that --purge does not delete the freshly written data file.
+    if config.demo:
+        from heatmap_cli import _generate_sample_csv  # noqa: PLC0415
+
+        config.input_filename = str(_generate_sample_csv(config))
+
     base_dataframe = _read_and_prepare_data(config)
 
     for year in config.year:
@@ -183,7 +190,7 @@ def _generate_animated_heatmap(
     start_of_week = _week_start_date(config.year, config.week)
     dates_in_week = [start_of_week + timedelta(days=i) for i in range(7)]
 
-    frames = []
+    frames: list[Image.Image] = []
     for seq, day in enumerate(dates_in_week, 1):
         frame_pivoted_df = final_pivoted_df.copy()
 
@@ -210,7 +217,7 @@ def _generate_animated_heatmap(
             return_image=True,
         )
         if frame:
-            frames.append(frame)
+            frames.append(cast("Image.Image", frame))
 
     if not frames:
         logger.warning("no frames generated to create GIF animation.")
@@ -278,7 +285,14 @@ def _generate_static_heatmaps(
         initializer=_init_worker_logging,
         initargs=(config,),
     ) as pool:
-        pool.starmap(_generate_heatmap_wrapper, args)
+        generated_files = pool.starmap(_generate_heatmap_wrapper, args)
+
+    # Workers never open browsers; open the finished heatmaps from the main
+    # process instead, so -o does not spawn a tab per background worker.
+    if config.open:
+        for img_filename in generated_files:
+            if img_filename:
+                _open_heatmap(img_filename)
 
 
 def _generate_heatmap_wrapper(
@@ -286,7 +300,7 @@ def _generate_heatmap_wrapper(
     cmap: str,
     config: argparse.Namespace,
     dataframe: pd.DataFrame,
-) -> Image.Image | None:
+) -> Image.Image | Path | None:
     """Wrapper for _generate_heatmap to handle args in Pool."""
     return _generate_heatmap(
         seq,
@@ -400,10 +414,15 @@ def _filter_and_pivot_data(
 
     logger.debug("Last date in filtered data: %s", max(steps["date"]).date())
 
-    # the start date of the year may span across two years
-    # for example, the first monday of 2026 week 1 is 2025-12-29
+    # The ISO year spans from the Monday of its first week, which may fall in
+    # the previous calendar year, through the Sunday before week 1 of the next
+    # ISO year. Using these boundaries keeps every date inside a single ISO
+    # year, so each (weekday, week) cell maps to exactly one date. Late
+    # December days that already belong to next year's ISO week 1 are excluded,
+    # otherwise they would be averaged with the real count in the same cell and
+    # silently halve it (pivot_table default aggfunc is "mean").
     start_date = _week_start_date(config.year, 1)
-    end_date = pd.to_datetime(f"{config.year}-12-31")
+    end_date = _week_start_date(config.year + 1, 1) - timedelta(days=1)
     logger.debug("start date: %s", start_date)
     logger.debug("end date: %s", end_date)
     full_year_dates = pd.date_range(start=start_date, end=end_date, freq="D")
@@ -507,7 +526,7 @@ def _generate_heatmap(
     dataframe: pd.DataFrame,
     *,
     return_image: bool = False,
-) -> Image.Image | None:
+) -> Image.Image | Path | None:
     """Generate a heatmap.
 
     Args:
@@ -520,8 +539,8 @@ def _generate_heatmap(
         saving to disk.
 
     Returns:
-        Optional[Image.Image]: The PIL Image object if return_image is True,
-        otherwise None.
+        Optional[Image.Image | Path]: The PIL Image object if return_image is
+            True, otherwise the Path of the saved heatmap file.
     """
     fig, axis = _setup_plot_artists(cmap, config, dataframe)
 
@@ -534,10 +553,7 @@ def _generate_heatmap(
     img_filename = _save_heatmap_figure(fig, config, seq, cmap, title)
     logger.info("generate heatmap: %s", img_filename)
 
-    if config.open:
-        _open_heatmap(img_filename)
-
-    return None
+    return img_filename
 
 
 def _configure_heatmap_options(

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: heatmap_cli
-Version: 0.25.2
+Version: 0.25.3
 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.2 → heatmap_cli-0.25.3}/tests/test_demo_option.py

@@ -100,3 +100,23 @@ def test_demo_does_not_clobber_user_sample(tmpdir, cli_runner):
 
     assert user_sample.read_text() == "user,data\n"
     assert (output_dir / DEMO_SAMPLE_FILENAME).exists()
+
+
+def test_demo_with_purge_survives(cli_runner):
+    """--demo --purge must not delete the sample CSV it just generated."""
+    ret = cli_runner("--demo", 1, "-p", "-Y", expect_error=False)
+    assert ret.returncode == 0
+    assert "Input file not found" 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")
+    home.mkdir()
+    monkeypatch.setenv("HOME", str(home))
+
+    ret = cli_runner("--demo", 1, "-O", "~/demoout", expect_error=False)
+
+    assert ret.returncode == 0
+    assert (home / "demoout" / DEMO_SAMPLE_FILENAME).exists()
+    assert not Path("~/demoout").is_dir()

heatmap_cli-0.25.3/tests/test_heatmap_open.py

@@ -0,0 +1,83 @@
+# Copyright (C) 2026 Kian-Meng Ang
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import argparse
+from pathlib import Path
+from unittest.mock import patch
+
+import pandas as pd
+
+from heatmap_cli.heatmap import _generate_heatmap, _generate_static_heatmaps
+
+
+def make_heatmap_config(tmpdir, *, should_open: bool):
+    return argparse.Namespace(
+        annotate=False,
+        cbar=False,
+        cmap_min=None,
+        cmap_max=None,
+        author="Test Author",
+        title="Test Title",
+        output_dir=str(tmpdir),
+        format="png",
+        open=should_open,
+    )
+
+
+def test_generate_heatmap_returns_saved_path(tmpdir):
+    config = make_heatmap_config(tmpdir, should_open=True)
+
+    df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
+
+    result = _generate_heatmap(1, "vlag", config, df)
+    assert isinstance(result, Path)
+    assert result.exists()
+
+    output_files = list(Path(str(tmpdir)).glob("*.png"))
+    assert len(output_files) >= 1
+
+
+def test_generate_heatmap_does_not_open(tmpdir):
+    """Opening is the caller's job, so _generate_heatmap never opens."""
+    config = make_heatmap_config(tmpdir, should_open=True)
+
+    df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
+
+    with patch("heatmap_cli.heatmap._open_heatmap") as mocked_open:
+        _generate_heatmap(1, "vlag", config, df)
+        mocked_open.assert_not_called()
+
+
+def test_static_heatmaps_open_once_after_pool(tmpdir):
+    """-o opens the finished heatmaps from the main process after the pool."""
+    config = argparse.Namespace(
+        annotate=False,
+        cbar=False,
+        cmap_min=None,
+        cmap_max=None,
+        author="Test Author",
+        title="Test Title",
+        output_dir=str(tmpdir),
+        format="png",
+        open=True,
+        cmap=["vlag"],
+    )
+
+    df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
+
+    with patch("heatmap_cli.heatmap._open_heatmap") as mocked_open:
+        _generate_static_heatmaps(df, config)
+        assert mocked_open.call_count == 1
+        assert mocked_open.call_args.args[0].exists()

{heatmap_cli-0.25.2 → heatmap_cli-0.25.3}/tests/test_heatmap_wrapper.py

@@ -21,8 +21,8 @@ import pandas as pd
 from heatmap_cli.heatmap import _generate_heatmap_wrapper
 
 
-def test_generate_heatmap_wrapper(tmpdir):
-    config = argparse.Namespace(
+def _make_config(tmpdir, *, should_open: bool):
+    return argparse.Namespace(
         annotate=False,
         cbar=False,
         cmap_min=None,
@@ -31,13 +31,29 @@ def test_generate_heatmap_wrapper(tmpdir):
         title="Test Title",
         output_dir=str(tmpdir),
         format="png",
-        open=False,
+        open=should_open,
     )
 
+
+def test_generate_heatmap_wrapper(tmpdir):
+    config = _make_config(tmpdir, should_open=False)
+
     df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
 
     result = _generate_heatmap_wrapper(1, "vlag", config, df)
-    assert result is None
+    assert isinstance(result, Path)
+    assert result.exists()
 
     output_files = list(Path(str(tmpdir)).glob("*.png"))
     assert len(output_files) >= 1
+
+
+def test_wrapper_uses_opened_heatmap_path(tmpdir):
+    """The pool wrapper returns the saved filename for the caller to open."""
+    config = _make_config(tmpdir, should_open=True)
+
+    df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
+
+    result = _generate_heatmap_wrapper(1, "vlag", config, df)
+    assert isinstance(result, Path)
+    assert result.exists()

{heatmap_cli-0.25.2 → heatmap_cli-0.25.3}/tests/test_iso_53_week_year.py

@@ -81,3 +81,30 @@ def test_week_53_dropped_when_partial_year_requested():
     pivoted = _filter_and_pivot_data(df, config)
 
     assert pivoted["53"].sum() == 0
+
+
+def test_iso_year_start_counts_kept_intact():
+    """Late December days of the prior ISO week 1 must not halve counts."""
+    # ISO year 2025 runs from 2024-12-30 through 2025-12-28. The Monday of
+    # ISO week 1 (2024-12-30) used to be averaged with 2025-12-29, which
+    # already belongs to ISO 2026 week 1 and landed in the same cell as an
+    # implied zero, halving the real count.
+    df = _base_dataframe(
+        [
+            ("2024-12-30", 5000),
+            ("2025-01-06", 4000),
+            ("2025-12-28", 3000),
+        ],
+    )
+    config = argparse.Namespace(
+        year=2025,
+        week=WEEKS_IN_YEAR,
+        start_date=None,
+        end_date=None,
+    )
+
+    pivoted = _filter_and_pivot_data(df, config)
+
+    assert pivoted.loc[1, "01"] == 5000
+    assert pivoted.loc[1, "02"] == 4000
+    assert pivoted.loc[7, "52"] == 3000

heatmap_cli-0.25.2/tests/test_heatmap_open.py

@@ -1,46 +0,0 @@
-# Copyright (C) 2026 Kian-Meng Ang
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-import argparse
-from pathlib import Path
-from unittest.mock import patch
-
-import pandas as pd
-
-from heatmap_cli.heatmap import _generate_heatmap
-
-
-def test_generate_heatmap_with_open(tmpdir):
-    config = argparse.Namespace(
-        annotate=False,
-        cbar=False,
-        cmap_min=None,
-        cmap_max=None,
-        author="Test Author",
-        title="Test Title",
-        output_dir=str(tmpdir),
-        format="png",
-        open=True,
-    )
-
-    df = pd.DataFrame([[10, 20], [30, 40]], index=[1, 2], columns=["01", "02"])
-
-    with patch("heatmap_cli.heatmap._open_heatmap") as mocked_open:
-        result = _generate_heatmap(1, "vlag", config, df)
-        assert result is None
-        mocked_open.assert_called_once()
-
-    output_files = list(Path(str(tmpdir)).glob("*.png"))
-    assert len(output_files) >= 1