core: fix GridSpec deprecation warning

[pjonsson]

Reason for this pull request

GridSpec is only used for type
checking, so only import it for
type checking to avoid triggering
deprecation warnings.

Refs #1716

Proposed changes

• Closes #xxxx

• Tests added / passed

• Fully documented, including docs/about/whats_new.rst for all changes

---

📚 Documentation preview 📚: https://datacube-core--1745.org.readthedocs.build/en/1745/

[codecov]

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 85.44%. Comparing base (99e36dc) to head (b05b839).
Report is 477 commits behind head on develop.

Files with missing lines	Patch %	Lines
datacube/api/core.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1745      +/-   ##
===========================================
- Coverage    85.45%   85.44%   -0.01%     
===========================================
  Files          148      148              
  Lines        15513    15516       +3     
===========================================
+ Hits         13256    13258       +2     
- Misses        2257     2258       +1     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[pjonsson]

The failing lint is fixed by #1744, no idea why readthedocs fails on this one.

[omad]

This works... however a tidier fix would be importing from odc-geo. That way there won't be anything to change when we do remove GridSpec from datacube-core.

from odc.geo.gridspec import GridSpec

[omad]

The deprecation warning should give more explicit instructions, rather than vaguely pointing at odc-geo.

[pjonsson]

This works... however a tidier fix would be importing from odc-geo. That way there won't be anything to change when we do remove GridSpec from datacube-core.

That changes the interface in this file from expecting a GridSpec from this package to expecting a GridSpec from odc-geo.

I'm not against modernizing the API, but that kind of change (which could break type checking of datacube-core users) feels like something that should have been a part of 1.9.0, not something that appears in 1.9.3.

[omad]

After creation the two different GridSpec classes are compatible. Maybe even identical.

I don't see it as changing an interface. It's updating the documentation of the interface, which I think is fine to do in a minor release.

That said, this will work fine as well and can be updated when GridSpec is removed here.

[pjonsson]

After creation the two different GridSpec classes are compatible. Maybe even identical.

How hard would it be to make the datacube-core class into a thin wrapper over the odc-geo class? That would save nearly 200 lines of code in this package, and reduce the risk that the classes are different in any major ways.

Why is the deprecation message for Product.grid_spec() talking about the "Grid workflow"? Even if the GridSpec class in datacube is deprecated, I don't see a reason the grid_spec method couldn't return a odc-geo GridSpec like the deprecation message suggests, but doing that isn't going to be useful if all users have migrated away from using the grid_spec method after switching to 1.9 and getting deprecation messages about it.