feature request: allow specifying temporal extent with single string #421

soxofaan · 2023-05-08T08:03:12Z

Temporal extents have to be specified as a list/tuple with two dates.
Often, when experimenting/exploring, you just need a single year or month, it would be handy if you can just pass temporal_extent="2022" or temporal_extent="2023-04", which would be converted automatically by the client to appropriate date ranges

The text was updated successfully, but these errors were encountered:

soxofaan · 2023-08-24T13:07:59Z

PR #461 was merged but I'd like to iterate a bit further on it:

I don't think that string_to_temporal_extent or even get_temporal_extent should be user-facing helpers (related: split up openeo.util #465). They should just be reusable helpers for actual user-facing methods like Connection.load_collection, DataCube.filter_temporal, ... As such I would not document this feature through the doc strings of these functions, but in the rst docs somewhere (e.g. https://open-eo.github.io/openeo-python-client/data_access.html seems like a good option), which could then be linked to from the docs of Connection.load_collection, DataCube.filter_temporal, ... Make sure to mention that year/month based extent handling is available since version 0.23.0
add some tests of this feature directly with Connection.load_collection, DataCube.filter_temporal
is usage like cube.filter_temporal("2020", "2022") or load_collection(..., temporal_extent=["2021-03", "2022-04"]) also handled: take first day of start date and last day + 1 for end date?
Also I think this feature is worth mentioning in the CHANGELOG

…a year or a month

…can be a year or a month

…n and improve docstrings

…API docs

…ube.filter_temporal

…stead of tuple in load_collection and filter_temporal

…ndling available sinche v0.23.0

- restructure and change header hierarchy a bit - trying to make paragraphs and snippets a bit more compact

Allows taking better normalization decisions

…tency The "round up" end_date feature as originally proposed turned out to conflict too much with existing behavior and openEO spec. Still, the idea can still be provided through single string `extent`: "2022" -> ("2022-01-01", "2023-01-01")

… consistency

… better consistency

… consistency

… better consistency

…a year or a month

…n and improve docstrings

…API docs

…ube.filter_temporal

…stead of tuple in load_collection and filter_temporal

…ndling available sinche v0.23.0

- restructure and change header hierarchy a bit - trying to make paragraphs and snippets a bit more compact

Allows taking better normalization decisions

…tency The "round up" end_date feature as originally proposed turned out to conflict too much with existing behavior and openEO spec. Still, the idea can still be provided through single string `extent`: "2022" -> ("2022-01-01", "2023-01-01")

soxofaan · 2023-09-20T08:30:57Z

done now: merged #468

soxofaan added good first issue feature request usability nice-to-have labels May 8, 2023

soxofaan mentioned this issue May 8, 2023

feature request: specify spatial extent with single string (location name) #422

Open

jdries assigned JohanKJSchreurs Jun 30, 2023

JohanKJSchreurs added a commit that referenced this issue Aug 9, 2023

Issue #421 Add: Specify period with single year or month

6e87e21

JohanKJSchreurs added a commit that referenced this issue Aug 11, 2023

fixup! Issue #421 Add: Specify period with single year or month

54d72ac

JohanKJSchreurs mentioned this issue Aug 11, 2023

Issue421 specifying temporal extent with single string #461

Merged

JohanKJSchreurs added a commit that referenced this issue Aug 16, 2023

Issue #421 Docstring: document param, return type, add doctest examples

56de5ce

JohanKJSchreurs added a commit that referenced this issue Aug 16, 2023

Issue #421 Docstring: fix formatting of example/doctest

ca1d97a

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Allow temporal extent where both the start and end can be …

401c5cb

…a year or a month

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

fixup! Issue #421 Allow temporal extent where both the start and end …

e08ce20

…can be a year or a month

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Make _convert_abbreviated_temporal_extent internal functio…

55c95fc

…n and improve docstrings

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Docs: remove docstring for string_to_temporal_extent from …

ba73d80

…API docs

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Add test coverage via Connection.load_collection and DataC…

a298cfb

…ube.filter_temporal

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Add more test coverage

0df4c19

JohanKJSchreurs added a commit that referenced this issue Sep 6, 2023

Issue #421 Update changelog

4840ef3

JohanKJSchreurs mentioned this issue Sep 6, 2023

Issue421 improvements for specifying temporal extent with single string #468

Closed

JohanKJSchreurs added a commit that referenced this issue Sep 7, 2023

Issue #421 Support temporal_extent and extent with a single string in…

314ac49

…stead of tuple in load_collection and filter_temporal

JohanKJSchreurs added a commit that referenced this issue Sep 7, 2023

Issue #421 Update *.rst documentation about temporal extent

fd88416

JohanKJSchreurs added a commit that referenced this issue Sep 7, 2023

Issue #421 Make docstring more clear

47d7850

JohanKJSchreurs added a commit that referenced this issue Sep 8, 2023

Issue #421 docs: add some references and mention year/month extend ha…

a64e909

…ndling available sinche v0.23.0

JohanKJSchreurs added a commit that referenced this issue Sep 8, 2023

Issue #421 Correct name of test class and remove an unnecessary test

b79570f

JohanKJSchreurs added a commit that referenced this issue Sep 11, 2023

Issue #421 Move temporal extent functions to separate module

f8b4ba9

JohanKJSchreurs added a commit that referenced this issue Sep 11, 2023

Issue #421 Remove unused imports

d9684d3

soxofaan added a commit that referenced this issue Sep 15, 2023

Issue #421/#468 finetuning data_access docs a bit more

7f654a1

- restructure and change header hierarchy a bit - trying to make paragraphs and snippets a bit more compact

soxofaan added a commit that referenced this issue Sep 18, 2023

Issue #421 explicit extentusageDataCube._get_temporal_extent

e1e3835

Allows taking better normalization decisions

soxofaan added a commit that referenced this issue Sep 18, 2023

fixup! Issue #421/#68 drop "round up" feature for end_date for better…

73590e3

… consistency

soxofaan added a commit that referenced this issue Sep 18, 2023

fixup! fixup! Issue #421/#68 drop "round up" feature for end_date for…

02067cb

… better consistency

soxofaan added a commit that referenced this issue Sep 18, 2023

fixup! Issue #421/#68 drop "round up" feature for end_date for better…

7443288

… consistency

soxofaan added a commit that referenced this issue Sep 18, 2023

fixup! fixup! Issue #421/#68 drop "round up" feature for end_date for…

164bd55

… better consistency

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Allow temporal extent where both the start and end can be …

7976bbc

…a year or a month

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Make _convert_abbreviated_temporal_extent internal functio…

fcdf247

…n and improve docstrings

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Docs: remove docstring for string_to_temporal_extent from …

d587f04

…API docs

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Add test coverage via Connection.load_collection and DataC…

28206f4

…ube.filter_temporal

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Add more test coverage

36ff58c

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Update changelog

8c3d02c

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Support temporal_extent and extent with a single string in…

4fc4b33

…stead of tuple in load_collection and filter_temporal

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Update *.rst documentation about temporal extent

d5a5985

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Make docstring more clear

ff6cad4

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 docs: add some references and mention year/month extend ha…

b2e2bb3

…ndling available sinche v0.23.0

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Correct name of test class and remove an unnecessary test

0bd4c32

soxofaan pushed a commit that referenced this issue Sep 20, 2023

Issue #421 Move temporal extent functions to separate module

6a1c463

soxofaan added a commit that referenced this issue Sep 20, 2023

Issue #421/#468 finetuning data_access docs a bit more

05bd17f

- restructure and change header hierarchy a bit - trying to make paragraphs and snippets a bit more compact

soxofaan added a commit that referenced this issue Sep 20, 2023

Issue #421 explicit extentusageDataCube._get_temporal_extent

891d19e

Allows taking better normalization decisions

soxofaan added a commit that referenced this issue Sep 20, 2023

Issue #421 further finetuning of documentation and type annotations

12f0ecd

soxofaan added a commit that referenced this issue Sep 20, 2023

Issue #421 code style cleanup

8156690

soxofaan closed this as completed Sep 20, 2023

soxofaan mentioned this issue Sep 29, 2023

Improved handling temporal extents #349

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature request: allow specifying temporal extent with single string #421

feature request: allow specifying temporal extent with single string #421

soxofaan commented May 8, 2023

soxofaan commented Aug 24, 2023 •

edited

Loading

soxofaan commented Sep 20, 2023

feature request: allow specifying temporal extent with single string #421

feature request: allow specifying temporal extent with single string #421

Comments

soxofaan commented May 8, 2023

soxofaan commented Aug 24, 2023 • edited Loading

soxofaan commented Sep 20, 2023

soxofaan commented Aug 24, 2023 •

edited

Loading