heatmap_cli 0.29.3__tar.gz → 0.29.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {heatmap_cli-0.29.3/src/heatmap_cli.egg-info → heatmap_cli-0.29.4}/PKG-INFO +1 -1
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/pyproject.toml +1 -1
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli/__init__.py +21 -102
- heatmap_cli-0.29.4/src/heatmap_cli/actions.py +92 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli/cli.py +7 -22
- heatmap_cli-0.29.4/src/heatmap_cli/config.py +159 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli/heatmap.py +29 -82
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4/src/heatmap_cli.egg-info}/PKG-INFO +1 -1
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli.egg-info/SOURCES.txt +2 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_errors.py +1 -1
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_style_option.py +22 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/LICENSE.md +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/README.md +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/setup.cfg +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli/__main__.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli/py.typed +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli.egg-info/dependency_links.txt +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli.egg-info/entry_points.txt +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli.egg-info/requires.txt +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/src/heatmap_cli.egg-info/top_level.txt +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_agg_backend.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_animate_by_week.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_animate_future_day.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_animate_no_frames.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_animate_open.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_annotate_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_annotation_truncation.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_cbar_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_cmap_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_cmax_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_cmin_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_configure_cbar.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_debug_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_demo_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_end_date_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_env_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_direct.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_open.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_utils.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_heatmap_wrapper.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_help_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_iso_53_week_year.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_main.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_no_annotate.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_open_heatmap.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_output_dir_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_purge_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_quiet_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_refresh_output_dir.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_setup_logging.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_start_date_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_supported_formats.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_title_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_version_flag.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_week_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_year_option.py +0 -0
- {heatmap_cli-0.29.3 → heatmap_cli-0.29.4}/tests/test_yes_flag.py +0 -0
|
@@ -28,7 +28,7 @@ classifiers = [
|
|
|
28
28
|
"Programming Language :: Python",
|
|
29
29
|
"Topic :: Scientific/Engineering :: Visualization",
|
|
30
30
|
]
|
|
31
|
-
version = "0.29.
|
|
31
|
+
version = "0.29.4"
|
|
32
32
|
keywords = ["heatmap", "cli", "visualization", "calendar", "data-viz"]
|
|
33
33
|
dependencies = [
|
|
34
34
|
"matplotlib",
|
|
@@ -19,54 +19,35 @@ from __future__ import annotations
|
|
|
19
19
|
|
|
20
20
|
import argparse
|
|
21
21
|
import logging
|
|
22
|
-
import platform
|
|
23
22
|
import random
|
|
24
|
-
import sys
|
|
25
|
-
from importlib import metadata
|
|
26
23
|
from pathlib import Path
|
|
27
|
-
from typing import Any, cast
|
|
28
24
|
|
|
29
|
-
import matplotlib as mpl
|
|
30
25
|
import pandas as pd
|
|
31
|
-
import seaborn as sns
|
|
32
26
|
|
|
27
|
+
from heatmap_cli.actions import DemoAction, EnvironmentAction
|
|
28
|
+
from heatmap_cli.config import (
|
|
29
|
+
CMAPS,
|
|
30
|
+
DEFAULT_DEMO_SEED,
|
|
31
|
+
DEMO_MAX_COUNT,
|
|
32
|
+
DEMO_SAMPLE_FILENAME,
|
|
33
|
+
FALLBACK_VERSION,
|
|
34
|
+
__version__,
|
|
35
|
+
_resolve_version,
|
|
36
|
+
)
|
|
33
37
|
from heatmap_cli.heatmap import _get_output_dir
|
|
34
38
|
from heatmap_cli.heatmap import run as generate_heatmaps
|
|
35
39
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
""
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
"""
|
|
48
|
-
try:
|
|
49
|
-
return metadata.version("heatmap_cli")
|
|
50
|
-
except metadata.PackageNotFoundError:
|
|
51
|
-
return FALLBACK_VERSION
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
__version__ = _resolve_version()
|
|
55
|
-
|
|
56
|
-
# Max value for demo heatmap count
|
|
57
|
-
DEMO_MAX_COUNT = 12000
|
|
58
|
-
|
|
59
|
-
# Fixed default seed so --demo output is deterministic for docs and tests.
|
|
60
|
-
DEFAULT_DEMO_SEED = 42
|
|
61
|
-
|
|
62
|
-
# The demo sample CSV uses a dedicated, unlikely-to-collide name so --demo
|
|
63
|
-
# does not silently overwrite a user's file in the output directory.
|
|
64
|
-
DEMO_SAMPLE_FILENAME = "heatmap_demo_sample.csv"
|
|
65
|
-
|
|
66
|
-
# Sort colormaps in a case-insensitive manner.
|
|
67
|
-
# The colormap registry is read from matplotlib directly, not pyplot, so that
|
|
68
|
-
# importing the package never pulls in the pyplot backend machinery.
|
|
69
|
-
CMAPS = sorted(mpl.colormaps, key=str.casefold)
|
|
40
|
+
__all__ = [
|
|
41
|
+
"CMAPS",
|
|
42
|
+
"DEFAULT_DEMO_SEED",
|
|
43
|
+
"DEMO_MAX_COUNT",
|
|
44
|
+
"DEMO_SAMPLE_FILENAME",
|
|
45
|
+
"FALLBACK_VERSION",
|
|
46
|
+
"DemoAction",
|
|
47
|
+
"EnvironmentAction",
|
|
48
|
+
"__version__",
|
|
49
|
+
"_resolve_version",
|
|
50
|
+
]
|
|
70
51
|
|
|
71
52
|
logger = logging.getLogger(__name__)
|
|
72
53
|
|
|
@@ -118,33 +99,6 @@ def setup_logging(config: argparse.Namespace) -> None:
|
|
|
118
99
|
)
|
|
119
100
|
|
|
120
101
|
|
|
121
|
-
class DemoAction(argparse.Action):
|
|
122
|
-
"""Mark the demo flag and its required namespace values."""
|
|
123
|
-
|
|
124
|
-
def __init__(self, *nargs: object, **kwargs: object) -> None:
|
|
125
|
-
"""Overwrite class method."""
|
|
126
|
-
kwargs.update({"nargs": "?"})
|
|
127
|
-
super().__init__(*cast("Any", nargs), **cast("Any", kwargs))
|
|
128
|
-
|
|
129
|
-
def __call__(
|
|
130
|
-
self,
|
|
131
|
-
_parser: argparse.ArgumentParser,
|
|
132
|
-
namespace: argparse.Namespace,
|
|
133
|
-
values: object,
|
|
134
|
-
_option_string: str | None = None,
|
|
135
|
-
) -> None:
|
|
136
|
-
"""Record how many demo heatmaps to generate.
|
|
137
|
-
|
|
138
|
-
Only ``namespace.demo`` is set here. The demo flow's year, week,
|
|
139
|
-
colourbar and colormap defaults are applied once parsing has
|
|
140
|
-
finished (see `heatmap_cli.cli._apply_demo_overrides`), so that the
|
|
141
|
-
position of ``--demo`` on the command line cannot change the
|
|
142
|
-
outcome.
|
|
143
|
-
"""
|
|
144
|
-
demo_count = min(cast("int", values), len(CMAPS))
|
|
145
|
-
namespace.demo = max(demo_count, 1)
|
|
146
|
-
|
|
147
|
-
|
|
148
102
|
def generate_demo(config: argparse.Namespace) -> None:
|
|
149
103
|
"""Generate demo heatmaps with deterministic random state.
|
|
150
104
|
|
|
@@ -190,38 +144,3 @@ def _generate_sample_csv(config: argparse.Namespace) -> Path:
|
|
|
190
144
|
df_dates.to_csv(csv_filename, sep=",", index=False, header=False)
|
|
191
145
|
logger.debug("Generate sample CSV file: %s", csv_filename)
|
|
192
146
|
return csv_filename
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
class EnvironmentAction(argparse.Action):
|
|
196
|
-
"""Show environment details action."""
|
|
197
|
-
|
|
198
|
-
def __init__(self, *nargs: object, **kwargs: object) -> None:
|
|
199
|
-
"""Overwrite class method."""
|
|
200
|
-
kwargs["nargs"] = 0
|
|
201
|
-
super().__init__(*cast("Any", nargs), **cast("Any", kwargs))
|
|
202
|
-
|
|
203
|
-
def __call__(
|
|
204
|
-
self,
|
|
205
|
-
parser: argparse.ArgumentParser,
|
|
206
|
-
_namespace: argparse.Namespace,
|
|
207
|
-
_values: object,
|
|
208
|
-
_option_string: str | None = None,
|
|
209
|
-
) -> None:
|
|
210
|
-
"""Overwrite class method."""
|
|
211
|
-
sys_version = sys.version.replace("\n", "")
|
|
212
|
-
dependency_lines = "\n".join(
|
|
213
|
-
f"{name}: {version}"
|
|
214
|
-
for name, version in (
|
|
215
|
-
("matplotlib", mpl.__version__),
|
|
216
|
-
("pandas", pd.__version__),
|
|
217
|
-
("pillow", metadata.version("pillow")),
|
|
218
|
-
("seaborn", sns.__version__),
|
|
219
|
-
)
|
|
220
|
-
)
|
|
221
|
-
env = (
|
|
222
|
-
f"heatmap: {__version__}\n"
|
|
223
|
-
f"python: {sys_version}\n"
|
|
224
|
-
f"platform: {platform.platform()}\n"
|
|
225
|
-
f"{dependency_lines}\n"
|
|
226
|
-
)
|
|
227
|
-
parser.exit(message=env)
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Copyright (C) 2023,2024,2025,2026 Kian-Meng Ang
|
|
2
|
+
#
|
|
3
|
+
# This program is free software: you can redistribute it and/or modify it under
|
|
4
|
+
# the terms of the GNU Affero General Public License as published by the Free
|
|
5
|
+
# Software Foundation, either version 3 of the License, or (at your option) any
|
|
6
|
+
# later version.
|
|
7
|
+
#
|
|
8
|
+
# This program is distributed in the hope that it will be useful, but WITHOUT
|
|
9
|
+
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
10
|
+
# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
11
|
+
# details.
|
|
12
|
+
#
|
|
13
|
+
# You should have received a copy of the GNU Affero General Public License
|
|
14
|
+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
15
|
+
|
|
16
|
+
"""Custom argparse actions for the heatmap CLI."""
|
|
17
|
+
|
|
18
|
+
from __future__ import annotations
|
|
19
|
+
|
|
20
|
+
import argparse
|
|
21
|
+
import platform
|
|
22
|
+
import sys
|
|
23
|
+
from importlib import metadata
|
|
24
|
+
from typing import Any, cast
|
|
25
|
+
|
|
26
|
+
import matplotlib as mpl
|
|
27
|
+
import pandas as pd
|
|
28
|
+
import seaborn as sns
|
|
29
|
+
|
|
30
|
+
from heatmap_cli.config import CMAPS, __version__
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class DemoAction(argparse.Action):
|
|
34
|
+
"""Mark the demo flag and its required namespace values."""
|
|
35
|
+
|
|
36
|
+
def __init__(self, *nargs: object, **kwargs: object) -> None:
|
|
37
|
+
"""Overwrite class method."""
|
|
38
|
+
kwargs.update({"nargs": "?"})
|
|
39
|
+
super().__init__(*cast("Any", nargs), **cast("Any", kwargs))
|
|
40
|
+
|
|
41
|
+
def __call__(
|
|
42
|
+
self,
|
|
43
|
+
_parser: argparse.ArgumentParser,
|
|
44
|
+
namespace: argparse.Namespace,
|
|
45
|
+
values: object,
|
|
46
|
+
_option_string: str | None = None,
|
|
47
|
+
) -> None:
|
|
48
|
+
"""Record how many demo heatmaps to generate.
|
|
49
|
+
|
|
50
|
+
Only ``namespace.demo`` is set here. The demo flow's year, week,
|
|
51
|
+
colourbar and colormap defaults are applied once parsing has
|
|
52
|
+
finished (see `heatmap_cli.cli._apply_demo_overrides`), so that the
|
|
53
|
+
position of ``--demo`` on the command line cannot change the
|
|
54
|
+
outcome.
|
|
55
|
+
"""
|
|
56
|
+
demo_count = min(cast("int", values), len(CMAPS))
|
|
57
|
+
namespace.demo = max(demo_count, 1)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class EnvironmentAction(argparse.Action):
|
|
61
|
+
"""Show environment details action."""
|
|
62
|
+
|
|
63
|
+
def __init__(self, *nargs: object, **kwargs: object) -> None:
|
|
64
|
+
"""Overwrite class method."""
|
|
65
|
+
kwargs["nargs"] = 0
|
|
66
|
+
super().__init__(*cast("Any", nargs), **cast("Any", kwargs))
|
|
67
|
+
|
|
68
|
+
def __call__(
|
|
69
|
+
self,
|
|
70
|
+
parser: argparse.ArgumentParser,
|
|
71
|
+
_namespace: argparse.Namespace,
|
|
72
|
+
_values: object,
|
|
73
|
+
_option_string: str | None = None,
|
|
74
|
+
) -> None:
|
|
75
|
+
"""Overwrite class method."""
|
|
76
|
+
sys_version = sys.version.replace("\n", "")
|
|
77
|
+
dependency_lines = "\n".join(
|
|
78
|
+
f"{name}: {version}"
|
|
79
|
+
for name, version in (
|
|
80
|
+
("matplotlib", mpl.__version__),
|
|
81
|
+
("pandas", pd.__version__),
|
|
82
|
+
("pillow", metadata.version("pillow")),
|
|
83
|
+
("seaborn", sns.__version__),
|
|
84
|
+
)
|
|
85
|
+
)
|
|
86
|
+
env = (
|
|
87
|
+
f"heatmap: {__version__}\n"
|
|
88
|
+
f"python: {sys_version}\n"
|
|
89
|
+
f"platform: {platform.platform()}\n"
|
|
90
|
+
f"{dependency_lines}\n"
|
|
91
|
+
)
|
|
92
|
+
parser.exit(message=env)
|
|
@@ -34,13 +34,15 @@ if TYPE_CHECKING:
|
|
|
34
34
|
|
|
35
35
|
from matplotlib.backends.backend_agg import FigureCanvasAgg
|
|
36
36
|
|
|
37
|
-
from heatmap_cli import
|
|
37
|
+
from heatmap_cli import generate_demo, setup_logging
|
|
38
|
+
from heatmap_cli.actions import DemoAction, EnvironmentAction
|
|
39
|
+
from heatmap_cli.config import (
|
|
40
|
+
CMAP_ITEMS_PER_ROW,
|
|
38
41
|
CMAPS,
|
|
39
|
-
|
|
40
|
-
|
|
42
|
+
DEFAULT_CMAP,
|
|
43
|
+
DEMO_IGNORED_OPTIONS,
|
|
44
|
+
MAX_ISO_WEEK,
|
|
41
45
|
__version__,
|
|
42
|
-
generate_demo,
|
|
43
|
-
setup_logging,
|
|
44
46
|
)
|
|
45
47
|
from heatmap_cli.heatmap import (
|
|
46
48
|
_sanitize_string_for_filename,
|
|
@@ -75,23 +77,6 @@ IMAGE_FORMATS = _get_supported_formats()
|
|
|
75
77
|
|
|
76
78
|
logger = logging.getLogger(__name__)
|
|
77
79
|
|
|
78
|
-
DEFAULT_CMAP = "RdYlGn_r"
|
|
79
|
-
CMAP_ITEMS_PER_ROW = 6
|
|
80
|
-
MAX_ISO_WEEK = 53
|
|
81
|
-
|
|
82
|
-
# Options that --demo overrides. --demo synthesises its own sample data for
|
|
83
|
-
# the current ISO year, so the options that select or restyle *that* data have
|
|
84
|
-
# nothing left to act on. -b/--cbar is absent on purpose: it is a store_true
|
|
85
|
-
# already defaulted to False, and --demo forces it to True, which is exactly
|
|
86
|
-
# what -b asks for, so there is nothing to report.
|
|
87
|
-
DEMO_IGNORED_OPTIONS = (
|
|
88
|
-
("-y/--year", "year"),
|
|
89
|
-
("-w/--week", "week"),
|
|
90
|
-
("-s/--start-date", "start_date"),
|
|
91
|
-
("-e/--end-date", "end_date"),
|
|
92
|
-
("-c/--cmap", "cmap"),
|
|
93
|
-
)
|
|
94
|
-
|
|
95
80
|
|
|
96
81
|
def _valid_date(s: str) -> datetime.date:
|
|
97
82
|
"""Validate date format.
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Copyright (C) 2023,2024,2025,2026 Kian-Meng Ang
|
|
2
|
+
#
|
|
3
|
+
# This program is free software: you can redistribute it and/or modify it under
|
|
4
|
+
# the terms of the GNU Affero General Public License as published by the Free
|
|
5
|
+
# Software Foundation, either version 3 of the License, or (at your option) any
|
|
6
|
+
# later version.
|
|
7
|
+
#
|
|
8
|
+
# This program is distributed in the hope that it will be useful, but WITHOUT
|
|
9
|
+
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
10
|
+
# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
11
|
+
# details.
|
|
12
|
+
#
|
|
13
|
+
# You should have received a copy of the GNU Affero General Public License
|
|
14
|
+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
15
|
+
|
|
16
|
+
"""Shared constants and distribution metadata for the heatmap CLI.
|
|
17
|
+
|
|
18
|
+
Keeping figure, colourbar, annotation, filename and CLI defaults in one module
|
|
19
|
+
makes them easy to find and change without hunting through the plotting and
|
|
20
|
+
argument-parsing code.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
from __future__ import annotations
|
|
24
|
+
|
|
25
|
+
from importlib import metadata
|
|
26
|
+
|
|
27
|
+
import matplotlib as mpl
|
|
28
|
+
|
|
29
|
+
# Reported when the distribution metadata is unavailable, so that a source
|
|
30
|
+
# checkout which was never installed still runs instead of failing to import.
|
|
31
|
+
FALLBACK_VERSION = "0.0.0+unknown"
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def _resolve_version() -> str:
|
|
35
|
+
"""Return the version from the installed distribution metadata.
|
|
36
|
+
|
|
37
|
+
Returns:
|
|
38
|
+
str: The installed version, or ``FALLBACK_VERSION`` when the
|
|
39
|
+
package is not installed.
|
|
40
|
+
"""
|
|
41
|
+
try:
|
|
42
|
+
return metadata.version("heatmap_cli")
|
|
43
|
+
except metadata.PackageNotFoundError:
|
|
44
|
+
return FALLBACK_VERSION
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
__version__ = _resolve_version()
|
|
48
|
+
|
|
49
|
+
# Sort colormaps in a case-insensitive manner.
|
|
50
|
+
# The colormap registry is read from matplotlib directly, not pyplot, so that
|
|
51
|
+
# importing the package never pulls in the pyplot backend machinery.
|
|
52
|
+
CMAPS = sorted(mpl.colormaps, key=str.casefold)
|
|
53
|
+
|
|
54
|
+
# Demo settings
|
|
55
|
+
DEMO_MAX_COUNT = 12000
|
|
56
|
+
DEFAULT_DEMO_SEED = 42
|
|
57
|
+
DEMO_SAMPLE_FILENAME = "heatmap_demo_sample.csv"
|
|
58
|
+
|
|
59
|
+
# CLI defaults
|
|
60
|
+
DEFAULT_CMAP = "RdYlGn_r"
|
|
61
|
+
CMAP_ITEMS_PER_ROW = 6
|
|
62
|
+
MAX_ISO_WEEK = 53
|
|
63
|
+
|
|
64
|
+
# Options that --demo overrides. --demo synthesises its own sample data for
|
|
65
|
+
# the current ISO year, so the options that select or restyle *that* data have
|
|
66
|
+
# nothing left to act on. -b/--cbar is absent on purpose: it is a store_true
|
|
67
|
+
# already defaulted to False, and --demo forces it to True, which is exactly
|
|
68
|
+
# what -b asks for, so there is nothing to report.
|
|
69
|
+
DEMO_IGNORED_OPTIONS = (
|
|
70
|
+
("-y/--year", "year"),
|
|
71
|
+
("-w/--week", "week"),
|
|
72
|
+
("-s/--start-date", "start_date"),
|
|
73
|
+
("-e/--end-date", "end_date"),
|
|
74
|
+
("-c/--cmap", "cmap"),
|
|
75
|
+
)
|
|
76
|
+
|
|
77
|
+
# Define constants for figure and image settings
|
|
78
|
+
DEFAULT_FIGURE_SIZE = (8, 5)
|
|
79
|
+
DEFAULT_DPI = 76
|
|
80
|
+
|
|
81
|
+
# Define constants for GIF animation settings
|
|
82
|
+
GIF_DURATION_MS = 1000
|
|
83
|
+
GIF_LOOP_COUNT = 0
|
|
84
|
+
|
|
85
|
+
# Define constants for font sizes
|
|
86
|
+
DEFAULT_TICK_LABEL_FONTSIZE = 9
|
|
87
|
+
ANNOTATION_FONTSIZE = 8
|
|
88
|
+
TITLE_FONTSIZE = 11
|
|
89
|
+
GRADE_LEGEND_FONTSIZE = 9
|
|
90
|
+
|
|
91
|
+
# Define constants for colorbar settings
|
|
92
|
+
COLORBAR_PAD = 0.10
|
|
93
|
+
COLORBAR_ASPECT = 60
|
|
94
|
+
|
|
95
|
+
# Define constant for filename sanitization
|
|
96
|
+
MAX_FILENAME_LENGTH = 100
|
|
97
|
+
|
|
98
|
+
WEEKS_IN_YEAR = 52
|
|
99
|
+
|
|
100
|
+
# Define constants for annotation thresholds
|
|
101
|
+
ANNOTATION_THRESHOLD = 100
|
|
102
|
+
|
|
103
|
+
# Letter grade scale for --heatmap-style grade: X (10k+), A (7.5k-10k),
|
|
104
|
+
# B (5k-7.5k), C (2.5k-5k), D (1k-2.5k), E (<1k), and a dot for a day
|
|
105
|
+
# without steps. Counts are in the truncated annotation units (hundreds
|
|
106
|
+
# of steps), so 100 is 10,000 steps.
|
|
107
|
+
GRADE_THRESHOLDS = (
|
|
108
|
+
(100, "X"),
|
|
109
|
+
(75, "A"),
|
|
110
|
+
(50, "B"),
|
|
111
|
+
(25, "C"),
|
|
112
|
+
(10, "D"),
|
|
113
|
+
)
|
|
114
|
+
GRADE_FALLBACK = "E"
|
|
115
|
+
GRADE_ZERO = "."
|
|
116
|
+
|
|
117
|
+
# Grade scale legend shown below a heatmap with graded annotations. Each
|
|
118
|
+
# entry is the grade letter, its step range label, and a representative
|
|
119
|
+
# count in the truncated annotation units, used to sample the heatmap
|
|
120
|
+
# color that the letter is drawn in.
|
|
121
|
+
GRADE_LEGEND_LABEL = "Legend:"
|
|
122
|
+
GRADE_LEGEND_ENTRIES = (
|
|
123
|
+
("X", "10k+", 110),
|
|
124
|
+
("A", "7.5-10k", 87),
|
|
125
|
+
("B", "5-7.5k", 62),
|
|
126
|
+
("C", "2.5-5k", 37),
|
|
127
|
+
("D", "1-2.5k", 17),
|
|
128
|
+
("E", "<1k", 5),
|
|
129
|
+
(GRADE_ZERO, "0", 0),
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
# Vertical distance in points between the axes bottom and the top of the
|
|
133
|
+
# grade legend block.
|
|
134
|
+
GRADE_LEGEND_OFFSET = -18
|
|
135
|
+
|
|
136
|
+
# Vertical spacing in points between the week label and the grade legend
|
|
137
|
+
# below it.
|
|
138
|
+
WEEK_LEGEND_GAP = 4
|
|
139
|
+
|
|
140
|
+
# Vertical spacing in points between the grade legend row and the
|
|
141
|
+
# "Generated by" row below it.
|
|
142
|
+
LEGEND_GENERATED_GAP = 2
|
|
143
|
+
|
|
144
|
+
# Define constants for default title strings
|
|
145
|
+
DEFAULT_TITLE_PREFIX = "Year {config.year}: Total Daily Walking Steps"
|
|
146
|
+
DEFAULT_TITLE_WEEK_SUFFIX = " Through Week {config.week:02d}"
|
|
147
|
+
|
|
148
|
+
# Define constants for colorbar labels
|
|
149
|
+
COLORBAR_BASE_LABEL = (
|
|
150
|
+
"Generated by: pypi.org/project/heatmap_cli, colormap: {cmap}"
|
|
151
|
+
)
|
|
152
|
+
COLORBAR_ANNOTATION_SUFFIX = ", count: nearest hundred"
|
|
153
|
+
|
|
154
|
+
# Define constants for count truncation
|
|
155
|
+
TRUNCATE_DIVISOR = 100
|
|
156
|
+
|
|
157
|
+
# Define constants for week ranges
|
|
158
|
+
ALL_WEEKS_RANGE = range(1, 54)
|
|
159
|
+
ALL_WEEKDAYS_RANGE = range(1, 8)
|
|
@@ -46,89 +46,36 @@ from matplotlib.figure import Figure
|
|
|
46
46
|
from matplotlib.offsetbox import AnnotationBbox, HPacker, TextArea, VPacker
|
|
47
47
|
from PIL import Image
|
|
48
48
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
# of steps), so 100 is 10,000 steps.
|
|
79
|
-
GRADE_THRESHOLDS = (
|
|
80
|
-
(100, "X"),
|
|
81
|
-
(75, "A"),
|
|
82
|
-
(50, "B"),
|
|
83
|
-
(25, "C"),
|
|
84
|
-
(10, "D"),
|
|
49
|
+
from heatmap_cli.config import (
|
|
50
|
+
ALL_WEEKDAYS_RANGE,
|
|
51
|
+
ALL_WEEKS_RANGE,
|
|
52
|
+
ANNOTATION_FONTSIZE,
|
|
53
|
+
ANNOTATION_THRESHOLD,
|
|
54
|
+
COLORBAR_ANNOTATION_SUFFIX,
|
|
55
|
+
COLORBAR_ASPECT,
|
|
56
|
+
COLORBAR_BASE_LABEL,
|
|
57
|
+
COLORBAR_PAD,
|
|
58
|
+
DEFAULT_DPI,
|
|
59
|
+
DEFAULT_FIGURE_SIZE,
|
|
60
|
+
DEFAULT_TICK_LABEL_FONTSIZE,
|
|
61
|
+
DEFAULT_TITLE_PREFIX,
|
|
62
|
+
DEFAULT_TITLE_WEEK_SUFFIX,
|
|
63
|
+
GIF_DURATION_MS,
|
|
64
|
+
GIF_LOOP_COUNT,
|
|
65
|
+
GRADE_FALLBACK,
|
|
66
|
+
GRADE_LEGEND_ENTRIES,
|
|
67
|
+
GRADE_LEGEND_FONTSIZE,
|
|
68
|
+
GRADE_LEGEND_LABEL,
|
|
69
|
+
GRADE_LEGEND_OFFSET,
|
|
70
|
+
GRADE_THRESHOLDS,
|
|
71
|
+
GRADE_ZERO,
|
|
72
|
+
LEGEND_GENERATED_GAP,
|
|
73
|
+
MAX_FILENAME_LENGTH,
|
|
74
|
+
TITLE_FONTSIZE,
|
|
75
|
+
TRUNCATE_DIVISOR,
|
|
76
|
+
WEEK_LEGEND_GAP,
|
|
77
|
+
WEEKS_IN_YEAR,
|
|
85
78
|
)
|
|
86
|
-
GRADE_FALLBACK = "E"
|
|
87
|
-
GRADE_ZERO = "."
|
|
88
|
-
|
|
89
|
-
# Grade scale legend shown below a heatmap with graded annotations. Each
|
|
90
|
-
# entry is the grade letter, its step range label, and a representative
|
|
91
|
-
# count in the truncated annotation units, used to sample the heatmap
|
|
92
|
-
# color that the letter is drawn in.
|
|
93
|
-
GRADE_LEGEND_LABEL = "Legend:"
|
|
94
|
-
GRADE_LEGEND_ENTRIES = (
|
|
95
|
-
("X", "10k+", 110),
|
|
96
|
-
("A", "7.5-10k", 87),
|
|
97
|
-
("B", "5-7.5k", 62),
|
|
98
|
-
("C", "2.5-5k", 37),
|
|
99
|
-
("D", "1-2.5k", 17),
|
|
100
|
-
("E", "<1k", 5),
|
|
101
|
-
(GRADE_ZERO, "0", 0),
|
|
102
|
-
)
|
|
103
|
-
|
|
104
|
-
# Vertical distance in points between the axes bottom and the top of the
|
|
105
|
-
# grade legend block.
|
|
106
|
-
GRADE_LEGEND_OFFSET = -18
|
|
107
|
-
|
|
108
|
-
# Vertical spacing in points between the week label and the grade legend
|
|
109
|
-
# below it.
|
|
110
|
-
WEEK_LEGEND_GAP = 4
|
|
111
|
-
|
|
112
|
-
# Vertical spacing in points between the grade legend row and the
|
|
113
|
-
# "Generated by" row below it.
|
|
114
|
-
LEGEND_GENERATED_GAP = 2
|
|
115
|
-
|
|
116
|
-
# Define constants for default title strings
|
|
117
|
-
DEFAULT_TITLE_PREFIX = "Year {config.year}: Total Daily Walking Steps"
|
|
118
|
-
DEFAULT_TITLE_WEEK_SUFFIX = " Through Week {config.week:02d}"
|
|
119
|
-
|
|
120
|
-
# Define constants for colorbar labels
|
|
121
|
-
COLORBAR_BASE_LABEL = (
|
|
122
|
-
"Generated by: pypi.org/project/heatmap_cli, colormap: {cmap}"
|
|
123
|
-
)
|
|
124
|
-
COLORBAR_ANNOTATION_SUFFIX = ", count: nearest hundred"
|
|
125
|
-
|
|
126
|
-
# Define constants for count truncation
|
|
127
|
-
TRUNCATE_DIVISOR = 100
|
|
128
|
-
|
|
129
|
-
# Define constants for week ranges
|
|
130
|
-
ALL_WEEKS_RANGE = range(1, 54)
|
|
131
|
-
ALL_WEEKDAYS_RANGE = range(1, 8)
|
|
132
79
|
|
|
133
80
|
logger = logging.getLogger(__name__)
|
|
134
81
|
|
|
@@ -141,7 +141,7 @@ def test_invalid_count_error_omits_line_when_unlocatable(tmpdir):
|
|
|
141
141
|
|
|
142
142
|
|
|
143
143
|
def test_find_invalid_count_line_returns_none_if_file_cannot_be_opened(tmpdir):
|
|
144
|
-
csv_path = _write_csv(tmpdir, "
|
|
144
|
+
csv_path = _write_csv(tmpdir, "invalid.csv", ["2023-01-01,abc"])
|
|
145
145
|
|
|
146
146
|
with patch.object(Path, "open", side_effect=OSError("boom")):
|
|
147
147
|
assert _find_invalid_count_line(csv_path) is None
|
|
@@ -143,6 +143,28 @@ def test_heatmap_style_grade_ignores_colorbar(csv_file):
|
|
|
143
143
|
_assert_legend_rows(axis)
|
|
144
144
|
|
|
145
145
|
|
|
146
|
+
def test_heatmap_style_grade_without_xlabel(csv_file):
|
|
147
|
+
"""The grade legend omits the week row when the axis has no xlabel."""
|
|
148
|
+
csv = csv_file("sample.csv")
|
|
149
|
+
parser = build_parser()
|
|
150
|
+
parsed_args = parser.parse_args([str(csv), "--heatmap-style", "grade"])
|
|
151
|
+
config = _process_args(parser, parsed_args)
|
|
152
|
+
|
|
153
|
+
dataframe = pd.DataFrame(
|
|
154
|
+
GRADE_DATA,
|
|
155
|
+
index=[1, 2],
|
|
156
|
+
columns=["01", "02", "03", "04"],
|
|
157
|
+
)
|
|
158
|
+
dataframe.index.name = "weekday"
|
|
159
|
+
_fig, axis = _setup_plot_artists("vlag", config, dataframe)
|
|
160
|
+
|
|
161
|
+
areas = _legend_areas(axis)
|
|
162
|
+
texts = [area.get_text() for area in areas]
|
|
163
|
+
assert texts[0] == GRADE_LEGEND_LABEL
|
|
164
|
+
assert "".join(texts[:-1]) == _expected_legend_line()
|
|
165
|
+
assert texts[-1] == GENERATED_BY
|
|
166
|
+
|
|
167
|
+
|
|
146
168
|
def test_heatmap_style_number_keeps_colorbar_without_legend(csv_file):
|
|
147
169
|
"""The number style keeps the colorbar and draws no grade legend."""
|
|
148
170
|
csv = csv_file("sample.csv")
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|