Skip to content

Commit 46ed4e2

Browse files
thodson-usgsthodson-usgs
committed
Deploying to gh-pages from @ c450c40 🚀
1 parent 78563f9 commit 46ed4e2

66 files changed

Lines changed: 1866 additions & 1820 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: e7f35e7cd22fd735308b3c45d645061d
3+
config: e4c1eedbc8ce9d0357ff0c1ea356752d
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_images/examples_WaterData_demo_36_0.png‎

-614 Bytes
Loading

‎_images/examples_WaterData_demo_40_0.png‎

-888 Bytes
Loading

‎_modules/dataretrieval/nadp.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>dataretrieval.nadp &mdash; dataretrieval 0.1.dev1+g51bdc6fe4 documentation</title>
8+
<title>dataretrieval.nadp &mdash; dataretrieval 0.1.dev1+gc450c404d documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=1351cf97"></script>
15+
<script src="../../_static/documentation_options.js?v=bb319b34"></script>
1616
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1818
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -110,7 +110,9 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
110110
<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
111111
<span class="kn">import</span><span class="w"> </span><span class="nn">zipfile</span>
112112

113-
<span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
113+
<span class="kn">import</span><span class="w"> </span><span class="nn">httpx</span>
114+
115+
<span class="kn">from</span><span class="w"> </span><span class="nn">dataretrieval.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPX_DEFAULTS</span>
114116

115117
<span class="n">_DEPRECATION_MESSAGE</span> <span class="o">=</span> <span class="p">(</span>
116118
<span class="s2">&quot;The `nadp` module is deprecated and will be removed from `dataretrieval` &quot;</span>
@@ -306,7 +308,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
306308
<span class="sd"> &quot;&quot;&quot;</span>
307309
<span class="n">_warn_deprecated</span><span class="p">()</span>
308310

309-
<span class="n">req</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span> <span class="o">+</span> <span class="n">filename</span><span class="p">)</span>
311+
<span class="n">req</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span> <span class="o">+</span> <span class="n">filename</span><span class="p">,</span> <span class="o">**</span><span class="n">HTTPX_DEFAULTS</span><span class="p">)</span>
310312
<span class="n">req</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
311313

312314
<span class="c1"># z = zipfile.ZipFile(io.BytesIO(req.content))</span>

‎_modules/dataretrieval/nldi.html‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>dataretrieval.nldi &mdash; dataretrieval 0.1.dev1+g51bdc6fe4 documentation</title>
8+
<title>dataretrieval.nldi &mdash; dataretrieval 0.1.dev1+gc450c404d documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=1351cf97"></script>
15+
<script src="../../_static/documentation_options.js?v=bb319b34"></script>
1616
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1818
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -96,7 +96,7 @@ <h1>Source code for dataretrieval.nldi</h1><div class="highlight"><pre>
9696
<span class="c1"># A helper function to query the NLDI API</span>
9797
<span class="n">response</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="n">query_params</span><span class="p">)</span>
9898
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span>
99-
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">error_message</span><span class="si">}</span><span class="s2">. Error reason: </span><span class="si">{</span><span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
99+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">error_message</span><span class="si">}</span><span class="s2">. Error reason: </span><span class="si">{</span><span class="n">response</span><span class="o">.</span><span class="n">reason_phrase</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
100100

101101
<span class="n">response_data</span> <span class="o">=</span> <span class="p">{}</span>
102102
<span class="k">try</span><span class="p">:</span>
@@ -544,6 +544,14 @@ <h1>Source code for dataretrieval.nldi</h1><div class="highlight"><pre>
544544
<span class="n">available_data_sources</span> <span class="o">=</span> <span class="n">_query_nldi</span><span class="p">(</span>
545545
<span class="n">url</span><span class="p">,</span> <span class="p">{},</span> <span class="s2">&quot;Error getting available data sources&quot;</span>
546546
<span class="p">)</span>
547+
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">available_data_sources</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span>
548+
<span class="nb">isinstance</span><span class="p">(</span><span class="n">ds</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="ow">and</span> <span class="s2">&quot;source&quot;</span> <span class="ow">in</span> <span class="n">ds</span> <span class="k">for</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">available_data_sources</span>
549+
<span class="p">):</span>
550+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
551+
<span class="s2">&quot;NLDI data-source catalog returned an unexpected shape; &quot;</span>
552+
<span class="s2">&quot;expected a list of {&#39;source&#39;: ..., ...} objects, got: &quot;</span>
553+
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">available_data_sources</span><span class="si">!r}</span><span class="s2">&quot;</span>
554+
<span class="p">)</span>
547555
<span class="n">_AVAILABLE_DATA_SOURCES</span> <span class="o">=</span> <span class="p">[</span><span class="n">ds</span><span class="p">[</span><span class="s2">&quot;source&quot;</span><span class="p">]</span> <span class="k">for</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">available_data_sources</span><span class="p">]</span>
548556

549557
<span class="k">if</span> <span class="n">data_source</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_AVAILABLE_DATA_SOURCES</span><span class="p">:</span>

‎_modules/dataretrieval/nwis.html‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>dataretrieval.nwis &mdash; dataretrieval 0.1.dev1+g51bdc6fe4 documentation</title>
8+
<title>dataretrieval.nwis &mdash; dataretrieval 0.1.dev1+gc450c404d documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=1351cf97"></script>
15+
<script src="../../_static/documentation_options.js?v=bb319b34"></script>
1616
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1818
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -87,8 +87,8 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
8787
<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
8888
<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">JSONDecodeError</span>
8989

90+
<span class="kn">import</span><span class="w"> </span><span class="nn">httpx</span>
9091
<span class="kn">import</span><span class="w"> </span><span class="nn">pandas</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pd</span>
91-
<span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
9292

9393
<span class="kn">from</span><span class="w"> </span><span class="nn">dataretrieval.rdb</span><span class="w"> </span><span class="kn">import</span> <span class="n">read_rdb</span>
9494
<span class="kn">from</span><span class="w"> </span><span class="nn">dataretrieval.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseMetadata</span>
@@ -194,7 +194,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
194194

195195
<div class="viewcode-block" id="_parse_json_or_raise">
196196
<a class="viewcode-back" href="../../reference/nwis.html#dataretrieval.nwis._parse_json_or_raise">[docs]</a>
197-
<span class="k">def</span><span class="w"> </span><span class="nf">_parse_json_or_raise</span><span class="p">(</span><span class="n">response</span><span class="p">:</span> <span class="n">requests</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
197+
<span class="k">def</span><span class="w"> </span><span class="nf">_parse_json_or_raise</span><span class="p">(</span><span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
198198
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parse a JSON NWIS response, raising a helpful error on HTML responses.&quot;&quot;&quot;</span>
199199
<span class="k">try</span><span class="p">:</span>
200200
<span class="k">return</span> <span class="n">_read_json</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
@@ -472,9 +472,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
472472
<div class="viewcode-block" id="query_waterdata">
473473
<a class="viewcode-back" href="../../reference/nwis.html#dataretrieval.nwis.query_waterdata">[docs]</a>
474474
<span class="nd">@_deprecated</span>
475-
<span class="k">def</span><span class="w"> </span><span class="nf">query_waterdata</span><span class="p">(</span>
476-
<span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ssl_check</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
477-
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">requests</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">Response</span><span class="p">:</span>
475+
<span class="k">def</span><span class="w"> </span><span class="nf">query_waterdata</span><span class="p">(</span><span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ssl_check</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">:</span>
478476
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
479477
<span class="sd"> Queries waterdata.</span>
480478

@@ -490,7 +488,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
490488

491489
<span class="sd"> Returns</span>
492490
<span class="sd"> -------</span>
493-
<span class="sd"> request: ``requests.models.Response``</span>
491+
<span class="sd"> request: ``httpx.Response``</span>
494492
<span class="sd"> The response object from the API request to the web service</span>
495493
<span class="sd"> &quot;&quot;&quot;</span>
496494
<span class="n">major_params</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;site_no&quot;</span><span class="p">,</span> <span class="s2">&quot;state_cd&quot;</span><span class="p">]</span>
@@ -523,7 +521,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
523521
<span class="nd">@_deprecated</span>
524522
<span class="k">def</span><span class="w"> </span><span class="nf">query_waterservices</span><span class="p">(</span>
525523
<span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ssl_check</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
526-
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">requests</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">Response</span><span class="p">:</span>
524+
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">:</span>
527525
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
528526
<span class="sd"> Queries waterservices.usgs.gov</span>
529527

@@ -562,7 +560,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
562560

563561
<span class="sd"> Returns</span>
564562
<span class="sd"> -------</span>
565-
<span class="sd"> request: ``requests.models.Response``</span>
563+
<span class="sd"> request: ``httpx.Response``</span>
566564
<span class="sd"> The response object from the API request to the web service</span>
567565

568566
<span class="sd"> &quot;&quot;&quot;</span>
@@ -1267,7 +1265,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
12671265
<span class="sd"> Response url</span>
12681266
<span class="sd"> query_time: datetme.timedelta</span>
12691267
<span class="sd"> Response elapsed time</span>
1270-
<span class="sd"> header: requests.structures.CaseInsensitiveDict</span>
1268+
<span class="sd"> header: httpx.Headers</span>
12711269
<span class="sd"> Response headers</span>
12721270
<span class="sd"> comments: str | None</span>
12731271
<span class="sd"> Metadata comments, if any</span>
@@ -1289,7 +1287,7 @@ <h1>Source code for dataretrieval.nwis</h1><div class="highlight"><pre>
12891287
<span class="sd"> Parameters</span>
12901288
<span class="sd"> ----------</span>
12911289
<span class="sd"> response: Response</span>
1292-
<span class="sd"> Response object from requests module</span>
1290+
<span class="sd"> Response object from httpx module</span>
12931291
<span class="sd"> parameters: unpacked dictionary</span>
12941292
<span class="sd"> Unpacked dictionary of the parameters supplied in the request</span>
12951293

0 commit comments

Comments
 (0)