Skip to content

Commit

Permalink
Merge pull request #457 from bsipocz/doc_fix_dal_doctest_failure
Browse files Browse the repository at this point in the history 
DOC: fix dal doctest failure
  • Loading branch information
@bsipocz
bsipocz authored Jul 6, 2023
2 parents 52ae511 + 7c2ee03 commit 9e8f602
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 27 deletions.
52 changes: 26 additions & 26 deletions docs/dal/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ mean G-band magnitude between 19 - 20:
>>> import pyvo as vo
>>> tap_service = vo.dal.TAPService("http://dc.g-vo.org/tap")
>>> ex_query = """
... SELECT TOP 5
... source_id, ra, dec, phot_g_mean_mag
... SELECT TOP 5
... source_id, ra, dec, phot_g_mean_mag
... FROM gaia.dr3lite
... WHERE phot_g_mean_mag BETWEEN 19 AND 20
... ORDER BY phot_g_mean_mag
Expand All @@ -162,22 +162,22 @@ mean G-band magnitude between 19 - 20:
>>> print(result)
<Table length=5>
source_id ra dec phot_g_mean_mag
deg deg mag
int64 float64 float64 float32
deg deg mag
int64 float64 float64 float32
------------------- ------------------ ------------------ ---------------
2162809607452221440 315.96596187101636 45.945474015208106 19.0
2000273643933171456 337.1829026565382 50.7218533537033 19.0
2171530448339798784 323.9151025188806 51.27690705826792 19.0
2171810342771336704 323.25913736080776 51.94305655940998 19.0
2180349528028140800 310.5233961869657 50.3486391034819 19.0

To explore more query examples, you can try either the ``description``
attribute for some services. For other services like this one, try
To explore more query examples, you can try either the ``description``
attribute for some services. For other services like this one, try
the ``examples`` attribute.

.. doctest-remote-data::

>>> print(tap_service.examples[0]['QUERY'])
>>> print(tap_service.examples[0]['QUERY'])
SELECT TOP 50 l.id, l.pmra as lpmra, l.pmde as lpmde,
g.source_id, g.pmra as gpmra, g.pmdec as gpmde
FROM
Expand All @@ -197,11 +197,11 @@ Furthermore, one can find the names of the tables using:

.. doctest-remote-data::

>>> print([tab_name for tab_name in tap_service.tables.keys()]) # doctest: +ELLIPSIS, +IGNORE_WARNINGS
['amanda.nucand', 'annisred.main', 'antares.data', ..., 'wfpdb.main', 'wise.main', 'zcosmos.data']

>>> print([tab_name for tab_name in tap_service.tables.keys()]) # doctest: +IGNORE_WARNINGS
['amanda.nucand', 'annisred.main', 'antares.data', ..., 'wise.main', 'xpparams.main', 'zcosmos.data']

And also the names of the columns from a known table, for instance

And also the names of the columns from a known table, for instance
the first three columns:

.. doctest-remote-data::
Expand All @@ -210,12 +210,12 @@ the first three columns:
<TableColumns names=('source_id','ra','dec')>

If you know a TAP service's access URL, you can directly pass it to
:py:class:`~pyvo.dal.TAPService` to obtain a service object.
:py:class:`~pyvo.dal.TAPService` to obtain a service object.
Sometimes, such URLs are published in papers or passed around through
other channels. Most commonly, you will discover them in the VO
other channels. Most commonly, you will discover them in the VO
registry (cf. :ref:`pyvo.registry<pyvo-registry>`).

To perform a query using ADQL, the ``search()`` method is used.
To perform a query using ADQL, the ``search()`` method is used.
TAPService instances have several methods to inspect the metadata
of the service - in particular, what tables with what columns are
available - discussed below.
Expand All @@ -224,7 +224,7 @@ To get an idea of how to write queries in ADQL, have a look at
`GAVO's ADQL course`_; it is basically a standardised subset of SQL
with some extensions to make it work better for astronomy.

.. _GAVO's ADQL course: https://docs.g-vo.org/adql
.. _GAVO's ADQL course: https://docs.g-vo.org/adql

Synchronous vs. asynchronous query
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -234,7 +234,7 @@ entire runtime of the query, and query processing generally starts
when the request is submitted. This is convenient but becomes
brittle as queries have runtimes of the order of minutes, when you
may encounter query timeouts. Also, many data providers impose
rather strict limits on the runtime alotted to sync queries.
rather strict limits on the runtime alotted to sync queries.

In asynchronous (“async”) mode, on the other hand, the client just
submits a query and receives a URL that let us inspect the
Expand All @@ -244,25 +244,25 @@ robust of long-running queries. It also supports queuing queries,
which allows service operators to be a lot more generous with
resource limits.

To specify the query mode, you can use either ``run_sync()`` for
To specify the query mode, you can use either ``run_sync()`` for
synchronous query or ``run_async()`` for asynchronous query.

.. doctest-remote-data::

>>> job = tap_service.submit_job(ex_query)

To learn more details from the asynchronous query, let's look at the
``submit_job()`` method. This submits an asynchronous query without
To learn more details from the asynchronous query, let's look at the
``submit_job()`` method. This submits an asynchronous query without
starting it, it creates a new object :py:class:`~pyvo.dal.AsyncTAPJob`.

.. doctest-remote-data::

>>> job.url # doctest: +ELLIPSIS
'http://dc.zah.uni-heidelberg.de/__system__/tap/run/async/...'

The job URL mentioned before is available in the ``url`` attribute.
Clicking on the URL leads you to the query itself, where you can check
the status(phase) of the query and decide to run, modify or delete
The job URL mentioned before is available in the ``url`` attribute.
Clicking on the URL leads you to the query itself, where you can check
the status(phase) of the query and decide to run, modify or delete
the job. You can also do it via various attributes:

.. doctest-remote-data::
Expand Down Expand Up @@ -323,11 +323,11 @@ that you can change if you need to) is reached.

>>> job.delete()

For more attributes please read the description for the job object
:py:class:`~pyvo.dal.AsyncTAPJob`.
For more attributes please read the description for the job object
:py:class:`~pyvo.dal.AsyncTAPJob`.

With ``run_async()`` you basically submit an asynchronous query and
return its result. It is like running ``submit_job()`` first and then
With ``run_async()`` you basically submit an asynchronous query and
return its result. It is like running ``submit_job()`` first and then
run the query manually.

Query limit
Expand Down
3 changes: 2 additions & 1 deletion setup.cfg
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ testpaths = "pyvo" "docs"
astropy_header = true
doctest_plus = enabled
text_file_format = rst
addopts = --doctest-rst
addopts = --doctest-rst --doctest-continue-on-failure
remote_data_strict = true
filterwarnings =
error
Expand Down Expand Up @@ -52,6 +52,7 @@ python_requires = >=3.8
all =
pillow
test =
pytest-doctestplus>=0.13
pytest-astropy
requests-mock
docs =
Expand Down

0 comments on commit 9e8f602

Please sign in to comment.