Partially typecheck APIformatting module

[mfisher87]

Add type annotations and some refactors to the APIformatting module.

[github-actions]

👈 Launch a binder notebook on this branch for commit 79fccf1

I will automatically update this comment whenever this PR is modified

👈 Launch a binder notebook on this branch for commit ca3f553

👈 Launch a binder notebook on this branch for commit 3da94ef

👈 Launch a binder notebook on this branch for commit ea4a0c5

👈 Launch a binder notebook on this branch for commit b90a10e

[codecov]

Codecov Report

Attention: Patch coverage is 60.71429% with 11 lines in your changes missing coverage. Please review.

Project coverage is 65.47%. Comparing base (1606dd0) to head (b90a10e).
Report is 1 commits behind head on development.

Files with missing lines	Patch %	Lines
icepyx/core/APIformatting.py	56.52%	5 Missing and 5 partials ⚠️
icepyx/core/exceptions.py	80.00%	1 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff               @@
##           development     #598      +/-   ##
===============================================
- Coverage        65.66%   65.47%   -0.19%     
===============================================
  Files               38       38              
  Lines             3122     3134      +12     
  Branches           599      601       +2     
===============================================
+ Hits              2050     2052       +2     
- Misses             984      991       +7     
- Partials            88       91       +3     

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

[mfisher87]

This logic (is key "time" or "temporal"?) is repeated just below, so I moved the error statement into that conditional.

In general, assertions should not be used in "the code" (use only in the tests) unless you specifically want the assertions to be controllable at runtime. python -O will disable all assertions like -W disables warnings. So when I moved this logic I also changed it to raise a RuntimeError.

[mfisher87]

This property returns static data, from what I can tell, so I simplified it down, and removed _poss_keys attribute.

[JessicaS11]

I think I had it this way because (1) I'd learned about properties and was probably overusing them; (2) I wanted it to be private enough the user understood they could look but shouldn't touch (so an invalid parameter wasn't submitted). Overall a fan of the simplification though.

[mfisher87]

(1) I'd learned about properties and was probably overusing them;

Who can blame you, properties are awesome!

(2) I wanted it to be private enough the user understood they could look but shouldn't touch

Do you mean "can't set it" by "shouldn't touch"?

[JessicaS11]

Do you mean "can't set it" by "shouldn't touch"?

I suppose so.

[mfisher87]

Gotcha. That's already covered by the @property decorator :)

>>> class Foo:
...   @property
...   def foo(self):
...     return "foo"
... 
>>> Foo().foo
'foo'
>>> Foo().foo = "bar"
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: can't set attribute 'foo'

[mfisher87]

Integration tests: https://github.com/icesat2py/icepyx/actions/runs/11041992788

[mfisher87]

Not passing. #598 fixes bug introduced on development branch from my last-merged PR.

[mfisher87]

In the interest of time, I'm going to merge this PR with failing integration tests, having tested the solution locally and gotten this branch to pass. This will simplify #616 into a one-step change and reduce the amount of review cycles. Apologies if this is objectionable! Please let me know if so and I will avoid a repeat in the future.