deploy: 33a569c

Author: Epse

_autosummary/obelisk.asynchronous.core.QueryParams.html

@@ -107,7 +107,9 @@ <h1>obelisk.asynchronous.core.QueryParams<a class="headerlink" href="#obelisk-as
 <dl class="py attribute">
 <dt class="sig sig-object py" id="obelisk.asynchronous.core.QueryParams.filter_">
 <span class="sig-name descname"><span class="pre">filter_</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Annotated" title="(in Python v3.13)"><span class="pre">Annotated</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="obelisk.types.core.Filter.html#obelisk.types.core.Filter" title="obelisk.types.core.Filter"><span class="pre">Filter</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">annotation</span></span><span class="o"><span class="pre">=</span></span><span class="pre">NoneType</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">required</span></span><span class="o"><span class="pre">=</span></span><span class="k"><span class="pre">True</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">alias_priority</span></span><span class="o"><span class="pre">=</span></span><span class="m"><span class="pre">2</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">serialization_alias</span></span><span class="o"><span class="pre">=</span></span><span class="s"><span class="pre">'filter'</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#obelisk.asynchronous.core.QueryParams.filter_" title="Link to this definition">¶</a></dt>
-<dd><p>Filter in <a class="reference external" href="https://obelisk.pages.ilabt.imec.be/obelisk-core/query.html#rsql-format">RSQL format</a> Suffix to avoid collisions.</p>
+<dd><p>Obelisk CORE handles filtering in <a class="reference external" href="https://obelisk.pages.ilabt.imec.be/obelisk-core/query.html#rsql-format">RSQL format</a> ,
+to make it easier to also programatically write these filters, we provide the <code class="xref py py-class docutils literal notranslate"><span class="pre">Filter</span></code> option as well.</p>
+<p>Suffix to avoid collisions.</p>
 </dd></dl>
 
 <dl class="py attribute">

_autosummary/obelisk.asynchronous.core.html

@@ -58,7 +58,7 @@
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="obelisk.asynchronous.core.type_suffix.html#obelisk.asynchronous.core.type_suffix" title="obelisk.asynchronous.core.type_suffix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type_suffix</span></code></a>(metric)</p></td>
-<td><p></p></td>
+<td><p>Extracts the <a class="reference internal" href="obelisk.asynchronous.core.DataType.html#obelisk.asynchronous.core.DataType" title="obelisk.asynchronous.core.DataType"><code class="xref any py py-data docutils literal notranslate"><span class="pre">DataType</span></code></a> from a string metric, useful for the dataType field in queries.</p></td>
 </tr>
 </tbody>
 </table>

_autosummary/obelisk.asynchronous.core.type_suffix.html

@@ -38,7 +38,11 @@ <h1>obelisk.asynchronous.core.type_suffix<a class="headerlink" href="#obelisk-as
 <dl class="py function">
 <dt class="sig sig-object py" id="obelisk.asynchronous.core.type_suffix">
 <span class="sig-prename descclassname"><span class="pre">obelisk.asynchronous.core.</span></span><span class="sig-name descname"><span class="pre">type_suffix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.13)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'number'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'number[]'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'json'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'bool'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'string'</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#type_suffix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.type_suffix" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Extracts the <a class="reference internal" href="obelisk.asynchronous.core.DataType.html#obelisk.asynchronous.core.DataType" title="obelisk.asynchronous.core.DataType"><code class="xref any py py-data docutils literal notranslate"><span class="pre">DataType</span></code></a> from a string metric,
+useful for the dataType field in queries.</p>
+<p>Throws a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if the provided string does not appear to be a typed metric,
+or the found type suffix is not a known one.</p>
+</dd></dl>
 
 </section>
 

_autosummary/obelisk.html

@@ -38,6 +38,7 @@
 <p>Obelisk-py is a client for the Obelisk data platform.
 We support both “classic” Obelisk and HFS,
 each with a synchronous and async API.
+We also support Obelisk CORE, in async only for now.
 The PyPi package name is <code class="docutils literal notranslate"><span class="pre">obelisk-py</span></code>, the Python module is called <code class="docutils literal notranslate"><span class="pre">obelisk</span></code>.</p>
 <p>Your starting point will be one of the Obelisk instances in <a class="reference internal" href="obelisk.sync.html#module-obelisk.sync" title="obelisk.sync"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sync</span></code></a> or <a class="reference internal" href="obelisk.asynchronous.html#module-obelisk.asynchronous" title="obelisk.asynchronous"><code class="xref py py-mod docutils literal notranslate"><span class="pre">asynchronous</span></code></a> depending on your preferred API.</p>
 <p>The Obelisk classes in these modules both implement the same interface,

_autosummary/obelisk.types.core.Comparison.html

@@ -39,6 +39,13 @@ <h1>obelisk.types.core.Comparison<a class="headerlink" href="#obelisk-types-core
 <dt class="sig sig-object py" id="obelisk.types.core.Comparison">
 <em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">obelisk.types.core.</span></span><span class="sig-name descname"><span class="pre">Comparison</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">left</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">right</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">op</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/obelisk/types/core.html#Comparison"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.types.core.Comparison" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Comparisons are the basic items of a <a class="reference internal" href="obelisk.types.core.Filter.html#obelisk.types.core.Filter" title="obelisk.types.core.Filter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Filter</span></code></a>.
+They consist of a field name, operator, and possibly a value on the right.</p>
+<p>It is strongly suggested you create comparisons by using the staticmethods
+on this class, rather than trying to construct them yourselves.</p>
+<p>When serializing to RSQL format,
+each argument is single quoted as to accept any otherwise reserved characters,
+and serialised using <code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code>.</p>
 <dl class="py method">
 <dt class="sig sig-object py">
 <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">left</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">right</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">op</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/obelisk/types/core.html#Comparison.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>

_autosummary/obelisk.types.core.Constraint.html

@@ -39,6 +39,10 @@ <h1>obelisk.types.core.Constraint<a class="headerlink" href="#obelisk-types-core
 <dt class="sig sig-object py" id="obelisk.types.core.Constraint">
 <em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">obelisk.types.core.</span></span><span class="sig-name descname"><span class="pre">Constraint</span></span><a class="reference internal" href="../_modules/obelisk/types/core.html#Constraint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.types.core.Constraint" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p>
+<p>Constraints are simply groups of <a class="reference internal" href="obelisk.types.core.Comparison.html#obelisk.types.core.Comparison" title="obelisk.types.core.Comparison"><code class="xref py py-class docutils literal notranslate"><span class="pre">Comparison</span></code></a>,
+such as <a class="reference internal" href="obelisk.types.core.And.html#obelisk.types.core.And" title="obelisk.types.core.And"><code class="xref py py-class docutils literal notranslate"><span class="pre">And</span></code></a>, or <a class="reference internal" href="obelisk.types.core.Or.html#obelisk.types.core.Or" title="obelisk.types.core.Or"><code class="xref py py-class docutils literal notranslate"><span class="pre">Or</span></code></a>.</p>
+<p>These constraints always enclose their contents in parentheses,
+to avoid confusing precendence situations in serialised format.</p>
 <dl class="py method">
 <dt class="sig sig-object py">
 <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>