Type annotate the temporal module

[mfisher87]

Important

To be merged only after merging #598 and then rebasing

Annotating this module was pretty quick! No typeguards or ignores needed.

[github-actions]

👈 Launch a binder notebook on this branch for commit 7f92261

I will automatically update this comment whenever this PR is modified

👈 Launch a binder notebook on this branch for commit e805f01

👈 Launch a binder notebook on this branch for commit 7b57037

👈 Launch a binder notebook on this branch for commit 224ca75

👈 Launch a binder notebook on this branch for commit df965c2

👈 Launch a binder notebook on this branch for commit 7751e26

👈 Launch a binder notebook on this branch for commit d037e11

👈 Launch a binder notebook on this branch for commit 094d3f0

👈 Launch a binder notebook on this branch for commit 97a5544

👈 Launch a binder notebook on this branch for commit b0eb2b9

👈 Launch a binder notebook on this branch for commit af907f3

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.79%. Comparing base (b7e07bf) to head (af907f3).
Report is 1 commits behind head on development.

Additional details and impacted files

@@               Coverage Diff               @@
##           development     #604      +/-   ##
===============================================
- Coverage        71.78%   66.79%   -4.99%     
===============================================
  Files               38       36       -2     
  Lines             3133     3078      -55     
  Branches           599      593       -6     
===============================================
- Hits              2249     2056     -193     
- Misses             773      933     +160     
+ Partials           111       89      -22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[JessicaS11]

Suggested change

	date_range: dict[str, dt.datetime],
	date_range: dict[str, dt.datetime, dt.date],

[mfisher87]

Good catch! I see what you're going for, the correct way to write that would be dict[str, Union[dt.datetime, dt.date]], which means "a dict with str keys, and values which can be either dt.datetime or dt.date."

Dates and datetimes are related, so I think we can equivalently annotate dict[str, dt.date]:

>>> import datetime as dt
>>> datetime = dt.datetime.now()
>>> date = dt.datetime.now().date()
>>> datetime
datetime.datetime(2024, 9, 25, 12, 47, 38, 861853)
>>> date
datetime.date(2024, 9, 25)
>>> isinstance(datetime, dt.date)
True
>>> isinstance(datetime, dt.datetime)
True
>>> isinstance(date, dt.date)
True
>>> isinstance(date, dt.datetime)
False

[mfisher87]

d037e11

[JessicaS11]

Based on your description, it should be:
dict[str, Union[str, dt.date]] since str is also a valid input for the values.

[mfisher87]

I see, thank you!

[mfisher87]

97a5544 - I should have read the doctests more closely 🔔

[JessicaS11]

https://github.com/icesat2py/icepyx/pull/604/files#r1777677428

[JessicaS11]

thanks for adding types to this module, @mfisher87!

[mfisher87]

Thanks for the thorough review 🙇

I don't understand why the unit tests aren't running here. Re-opening PR to trigger.

[JessicaS11]

I don't understand why the unit tests aren't running here. Re-opening PR to trigger.

#618