astropy / astropy/astroquery

Add `get_query_payload` consistently to all methods

Open
#2,040 5 comments 0 reactions 0 assignees View on GitHub
enhancement package-novice
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

This is super valuable for debugging issues, e.g. I'm having troubles to catch the typo in a `Simbad.query_criteria()` call, and it doesn't have this kwarg.

Addressing the whole issue can be long, but the task is a package novice one, basically breakpoints needed to be added to return the payload strings rather than sending them to the server (and plenty of examples are available).

I'm adding the list of all modules here for easier tracking. We should either tick the boxes when the kwarg added, or cross out the module name if this is not applicable:

- [ ] alfalfa
- [ ] alma
- [ ] astrometry_net
- [ ] atomic
- [ ] besancon
- [ ] cadc
- [ ] casda
- [ ] cds
- [ ] cosmosim
- [ ] dace
- [ ] esa
- [ ] esasky
- [ ] eso
- [ ] exoplanet_orbit_database
- [ ] fermi
- [ ] gaia
- [ ] gama
- [ ] gemini
- [ ] heasarc
- [ ] hips2fits
- [ ] hitran
- [ ] ibe
- [ ] image_cutouts
- [ ] imcce
- [ ] irsa
- [ ] irsa_dust
- [ ] jplhorizons
- [ ] jplsbdb
- [ ] jplspec
- [ ] lamda
- [ ] lcogt
- [ ] magpis
- [ ] mast
- [ ] mpc
- [ ] nasa_ads
- [ ] nasa_exoplanet_archive
- [ ] ned
- [ ] nist
- [ ] noirlab
- [ ] nrao
- [ ] nvas
- [ ] oac
- [ ] ogle
- [ ] open_exoplanet_catalogue
- [ ] sdss
- [ ] sha
- [ ] simbad
- [ ] skyview
- [ ] solarsystem
- [ ] splatalogue
- [ ] svo_fps
- [ ] template_module
- [ ] ukidss
- [ ] utils
- [ ] vamdc
- [ ] vizier
- [ ] vo_conesearch
- [ ] vsa
- [ ] wfau
- [ ] xmatch

Contributor guide

Open the contributing guide

Research direction

Review existing get_query_payload implementations and examples, then compare the methods across the listed astroquery modules, starting with the Simbad query_criteria case. Done means every applicable method accepts the kwarg and returns its payload string instead of sending it, with the module checklist updated; mark modules as not applicable where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.