Skip to content

Commit a39a58e

Browse files
sbillingesbillinge
committed
deploy: 9d1f9f1 
1 parent 3d41285 commit a39a58e

37 files changed

+1723
-357
lines changed

‎.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 hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2f769eb5ffa478c329f8216e12149640
3+
config: 02835325c5af1e64f6cb12a431a9827b
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_modules/diffpy/utils/parsers/custom_exceptions.html‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../../../../">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>diffpy.utils.parsers.custom_exceptions &mdash; diffpy.utils 3.4.1rc0 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
8+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
9+
10+
11+
<!--[if lt IE 9]>
12+
<script src="../../../../_static/js/html5shiv.min.js"></script>
13+
<![endif]-->
14+
15+
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
16+
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17+
<script src="../../../../_static/documentation_options.js?v=6d4d0801"></script>
18+
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
19+
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
20+
<script src="../../../../_static/js/theme.js"></script>
21+
<link rel="index" title="Index" href="../../../../genindex.html" />
22+
<link rel="search" title="Search" href="../../../../search.html" />
23+
</head>
24+
25+
<body class="wy-body-for-nav">
26+
<div class="wy-grid-for-nav">
27+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
28+
<div class="wy-side-scroll">
29+
<div class="wy-side-nav-search" >
30+
31+
32+
33+
<a href="../../../../index.html" class="icon icon-home">
34+
diffpy.utils
35+
</a>
36+
<div class="version">
37+
3.4.1rc0
38+
</div>
39+
<div role="search">
40+
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
41+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
42+
<input type="hidden" name="check_keywords" value="yes" />
43+
<input type="hidden" name="area" value="default" />
44+
</form>
45+
</div>
46+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
47+
<ul>
48+
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="../../../../release.html">Release Notes</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../../../../utilities/utilities.html">Utilities</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../../../../examples/examples.html">Examples</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../../../../api/diffpy.utils.html">Package API</a></li>
53+
</ul>
54+
55+
</div>
56+
</div>
57+
</nav>
58+
59+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
60+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
61+
<a href="../../../../index.html">diffpy.utils</a>
62+
</nav>
63+
64+
<div class="wy-nav-content">
65+
<div class="rst-content">
66+
<div role="navigation" aria-label="Page navigation">
67+
<ul class="wy-breadcrumbs">
68+
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
69+
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
70+
<li class="breadcrumb-item active">diffpy.utils.parsers.custom_exceptions</li>
71+
<li class="wy-breadcrumbs-aside">
72+
</li>
73+
</ul>
74+
<hr/>
75+
</div>
76+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
77+
<div itemprop="articleBody">
78+
79+
<h1>Source code for diffpy.utils.parsers.custom_exceptions</h1><div class="highlight"><pre>
80+
<span></span><span class="ch">#!/usr/bin/env python</span>
81+
<span class="c1">##############################################################################</span>
82+
<span class="c1">#</span>
83+
<span class="c1"># diffpy.utils by DANSE Diffraction group</span>
84+
<span class="c1"># Simon J. L. Billinge</span>
85+
<span class="c1"># (c) 2010 The Trustees of Columbia University</span>
86+
<span class="c1"># in the City of New York. All rights reserved.</span>
87+
<span class="c1">#</span>
88+
<span class="c1"># File coded by:</span>
89+
<span class="c1">#</span>
90+
<span class="c1"># See AUTHORS.txt for a list of people who contributed.</span>
91+
<span class="c1"># See LICENSE_DANSE.txt for license information.</span>
92+
<span class="c1">#</span>
93+
<span class="c1">##############################################################################</span>
94+
95+
96+
<div class="viewcode-block" id="UnsupportedTypeError">
97+
<a class="viewcode-back" href="../../../../api/diffpy.utils.parsers.html#diffpy.utils.parsers.custom_exceptions.UnsupportedTypeError">[docs]</a>
98+
<span class="k">class</span> <span class="nc">UnsupportedTypeError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
99+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;For file types not supported by our parsers.</span>
100+
101+
<span class="sd"> Parameters</span>
102+
<span class="sd"> ----------</span>
103+
<span class="sd"> file</span>
104+
<span class="sd"> Name of file triggering the error.</span>
105+
<span class="sd"> supported_types: list</span>
106+
<span class="sd"> Supported file types.</span>
107+
<span class="sd"> message: str</span>
108+
<span class="sd"> Overwrites default message.</span>
109+
<span class="sd"> &quot;&quot;&quot;</span>
110+
111+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">supported_types</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
112+
<span class="k">if</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
113+
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;The file </span><span class="si">{</span><span class="n">file</span><span class="si">}</span><span class="s2"> is not supported.&quot;</span>
114+
<span class="k">if</span> <span class="n">supported_types</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
115+
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">+=</span> <span class="s2">&quot; Supported file types include: &quot;</span>
116+
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">supported_types</span><span class="p">:</span>
117+
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">+=</span> <span class="n">t</span> <span class="o">+</span> <span class="s2">&quot;, &quot;</span>
118+
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">+</span> <span class="s2">&quot;.&quot;</span>
119+
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div>
120+
121+
122+
123+
<div class="viewcode-block" id="ImproperSizeError">
124+
<a class="viewcode-back" href="../../../../api/diffpy.utils.parsers.html#diffpy.utils.parsers.custom_exceptions.ImproperSizeError">[docs]</a>
125+
<span class="k">class</span> <span class="nc">ImproperSizeError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
126+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;When the size of an object does not match expectations.</span>
127+
128+
<span class="sd"> Parameters</span>
129+
<span class="sd"> ----------</span>
130+
<span class="sd"> bad_object</span>
131+
<span class="sd"> Object with improper size.</span>
132+
<span class="sd"> message: str</span>
133+
<span class="sd"> Overwrites default message.</span>
134+
<span class="sd"> &quot;&quot;&quot;</span>
135+
136+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bad_object</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
137+
<span class="k">if</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
138+
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;The size of </span><span class="si">{</span><span class="n">bad_object</span><span class="si">}</span><span class="s2"> is different than expected.&quot;</span>
139+
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div>
140+
141+
</pre></div>
142+
143+
</div>
144+
</div>
145+
<footer>
146+
147+
<hr/>
148+
149+
<div role="contentinfo">
150+
<p>&#169; Copyright 2024, The Trustees of Columbia University in the City of New York.</p>
151+
</div>
152+
153+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
154+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
155+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
156+
157+
158+
</footer>
159+
</div>
160+
</div>
161+
</section>
162+
</div>
163+
<script>
164+
jQuery(function () {
165+
SphinxRtdTheme.Navigation.enable(true);
166+
});
167+
</script>
168+
169+
</body>
170+
</html>

‎_modules/diffpy/utils/parsers/loaddata.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>diffpy.utils.parsers.loaddata &mdash; diffpy.utils 3.4.0 documentation</title>
6+
<title>diffpy.utils.parsers.loaddata &mdash; diffpy.utils 3.4.1rc0 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
99

@@ -14,7 +14,7 @@
1414

1515
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../../../../_static/documentation_options.js?v=237dbe43"></script>
17+
<script src="../../../../_static/documentation_options.js?v=6d4d0801"></script>
1818
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../../../../_static/js/theme.js"></script>
@@ -34,7 +34,7 @@
3434
diffpy.utils
3535
</a>
3636
<div class="version">
37-
3.4.0
37+
3.4.1rc0
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -444,7 +444,7 @@ <h1>Source code for diffpy.utils.parsers.loaddata</h1><div class="highlight"><pr
444444
<hr/>
445445

446446
<div role="contentinfo">
447-
<p>&#169; Copyright 2024, Brookhaven National Laboratory.</p>
447+
<p>&#169; Copyright 2024, The Trustees of Columbia University in the City of New York.</p>
448448
</div>
449449

450450
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎_modules/diffpy/utils/parsers/resample.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>diffpy.utils.parsers.resample &mdash; diffpy.utils 3.4.0 documentation</title>
6+
<title>diffpy.utils.parsers.resample &mdash; diffpy.utils 3.4.1rc0 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
99

@@ -14,7 +14,7 @@
1414

1515
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../../../../_static/documentation_options.js?v=237dbe43"></script>
17+
<script src="../../../../_static/documentation_options.js?v=6d4d0801"></script>
1818
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../../../../_static/js/theme.js"></script>
@@ -34,7 +34,7 @@
3434
diffpy.utils
3535
</a>
3636
<div class="version">
37-
3.4.0
37+
3.4.1rc0
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -227,7 +227,7 @@ <h1>Source code for diffpy.utils.parsers.resample</h1><div class="highlight"><pr
227227
<hr/>
228228

229229
<div role="contentinfo">
230-
<p>&#169; Copyright 2024, Brookhaven National Laboratory.</p>
230+
<p>&#169; Copyright 2024, The Trustees of Columbia University in the City of New York.</p>
231231
</div>
232232

233233
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎_modules/diffpy/utils/parsers/serialization.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>diffpy.utils.parsers.serialization &mdash; diffpy.utils 3.4.0 documentation</title>
6+
<title>diffpy.utils.parsers.serialization &mdash; diffpy.utils 3.4.1rc0 documentation</title>
77
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
88
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
99

@@ -14,7 +14,7 @@
1414

1515
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
1616
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17-
<script src="../../../../_static/documentation_options.js?v=237dbe43"></script>
17+
<script src="../../../../_static/documentation_options.js?v=6d4d0801"></script>
1818
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
1919
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="../../../../_static/js/theme.js"></script>
@@ -34,7 +34,7 @@
3434
diffpy.utils
3535
</a>
3636
<div class="version">
37-
3.4.0
37+
3.4.1rc0
3838
</div>
3939
<div role="search">
4040
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -296,7 +296,7 @@ <h1>Source code for diffpy.utils.parsers.serialization</h1><div class="highlight
296296
<hr/>
297297

298298
<div role="contentinfo">
299-
<p>&#169; Copyright 2024, Brookhaven National Laboratory.</p>
299+
<p>&#169; Copyright 2024, The Trustees of Columbia University in the City of New York.</p>
300300
</div>
301301

302302
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

0 commit comments

Comments
 (0)