feat: add intersect modes for registry.Spatial constraint

[ManonMarchand]

Hello pyvo,

What the PR does

It adds intersect modes for the constraint registry.Spatial.

• 'covers' that keeps the previous behavior,
• 'enclosed' is for services covering the given region,
• 'overlaps' returns services intersecting with the region

In practice, if I give the allsky MOC, it looks like this:

(former behavior, now default. Returns any service that contains allsky)

>>> from astroquery.pyvo import registry
>>> result = registry.search(registry.Spatial("0/0-11"))
>>> len(result)
1147

(new behavior, returns any service overlapping with allsky)

>>> from astroquery.pyvo import registry
>>> result = registry.search(registry.Spatial("0/0-11", intersect="overlaps"))
>>> len(result)
18938

Why this API

I copied the SIA one

pyvo/pyvo/dal/sia.py

Line 74 in ad84a0e

intersect : str

but there might be better options ?

[msdemlei]

For the record, I like this as-is (added value: it's a nice demo of why we want constraint classes rather than simple keywords). Thanks!

Let me know when you'd like a review.

[ManonMarchand]

Thanks, I'm ready for the review, but the failing test is not something I changed. Maybe linked to this PR in astropy?

If I can give feedback on the constraints, I like that they are classes a lot, however their names are a bit confusing (registry.Spatial does not scream constraint to me and I'd have preferred something along registry.SpatialConstraint) but once I found them, they are nice to use.

[msdemlei]

Looks good to me (and the changelog failure indeed seems unrelated).

Thanks!

[bsipocz]

Indeed, I haven't yet follow-ed up those astropy changes in pyvo. Opening a separate PR for it.

[bsipocz]

fyi: the changelog check was failed as the milestone wasn't yet set. I'll think about a solution of how to make that check more flexible.

[codecov]

Codecov Report

Merging #495 (87f1ff3) into main (ad84a0e) will increase coverage by 0.00%.
Report is 5 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head 87f1ff3 differs from pull request most recent head 6636d13. Consider uploading reports for the commit 6636d13 to get more accurate results

@@           Coverage Diff           @@
##             main     #495   +/-   ##
=======================================
  Coverage   80.07%   80.08%           
=======================================
  Files          52       52           
  Lines        6059     6071   +12     
=======================================
+ Hits         4852     4862   +10     
- Misses       1207     1209    +2     

Files	Coverage Δ
pyvo/registry/rtcons.py	97.45% <100.00%> (-0.38%)	⬇️

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[bsipocz]

Thank you @ManonMarchand!

[bsipocz]

This added an unnoticed backward incompatible API change. I'll open a PR to remedy this before rolling out v1.5, and ultimately #507 will address any similar future issues.

[ManonMarchand]

Oops sorry

[bsipocz]

I'm sorry, this should be something to spot during the review. But again, a prime example of why I'm pushing for #507 as we shouldn't really be catering for the sole usage of positional arguments for everything.