FlexMeasures / flexmeasures / 40675623441

87%

push

github

Chore/CLI move timezone field to more general times schemas & fix show beliefs (#2695)

* chore: move TimezoneField to more general place data/schemas/times.py, not automations

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* use TimezoneField in the show beliefs command and fix a bug which overwrote explicitly set timezones

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* cli: prefer export-timezone for belief CSVs

Context: The timezone option affects CSV exports but not the terminal plot.

Change: Prefer --export-timezone and retain --timezone as a deprecated alias.

* docs/cli: announce export-timezone option

Context: The former timezone name implies it changes the terminal plot.

Change: Record the preferred export-specific option and its compatible alias.

* add changelog entry

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* cli/data_show: plot beliefs with UTC timestamps without a timezone

Context:
- Since the timezone fix, the index handed to uniplot is timezone-aware by default,
  and numpy then warns "no explicit representation of timezones available for np.datetime64", 12 times per run.

Change:
- Pass uniplot the index in UTC without a timezone, which is what it showed anyway,
  and what it got by default before the fix.

Signed-off-by: Ahmad-Wahid <ahmedwahid16101@gmail.com>

* cli/data_show: warn that --export-timezone needs --to-file

Context:
- The export timezone only applies to the CSV file, so without --to-file it silently does nothing.

Change:
- Warn when it is given without --to-file, and say in its help that the terminal plot always shows UTC.
- Choose the export timezone in a helper, get_export_timezone, as one more branch would make plot_beliefs too complex for flake8.

Signed-off-by: Ahmad-Wahid <ahmedwahid16101@gmail.com>

* cli/data_show: import the time fields in one statement

Context:
- Moving TimezoneField to the times schemas left data_show.py importing from that module twice.

Change:
- Import TimezoneF... (continued)

22 of 22 new or added lines in 5 files covered. (100.0%)

22419 of 25776 relevant lines covered (86.98%)

0.87 hits per line