@@ -4403,7 +4403,8 @@ <h1 id="osw">OSW</h1>
44034403<span class="normal">2096</span>
44044404<span class="normal">2097</span>
44054405<span class="normal">2098</span>
4406- <span class="normal">2099</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">OSW</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
4406+ <span class="normal">2099</span>
4407+ <span class="normal">2100</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">OSW</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
44074408<span class="w"> </span><span class="sd">"""Bundles core functionalities of OpenSemanticWorld (OSW)"""</span>
44084409
44094410 <span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"2ea5b605-c91f-4e5a-9559-3dff79fdd4a5"</span>
@@ -5922,10 +5923,11 @@ <h1 id="osw">OSW</h1>
59225923<span class="sd"> param:</span>
59235924<span class="sd"> StoreEntityParam, the dataclass instance or a list of instances</span>
59245925<span class="sd"> """</span>
5925- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">Entity</span><span class="p">):</span>
5926- <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="p">[</span><span class="n">param</span><span class="p">])</span>
59275926 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
59285927 <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="n">param</span><span class="p">)</span>
5928+ <span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">):</span>
5929+ <span class="c1"># Accept any OswBaseModel / Entity / Controller instance</span>
5930+ <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="p">[</span><span class="n">param</span><span class="p">])</span>
59295931 <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="o">.</span><span class="n">entities</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
59305932 <span class="n">param</span><span class="o">.</span><span class="n">entities</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="o">.</span><span class="n">entities</span><span class="p">]</span>
59315933
@@ -6458,8 +6460,7 @@ <h2 id="osw.core.OSW.ExportJsonLdParams" class="doc doc-heading">
64586460
64596461 <details class="mkdocstrings-source">
64606462 <summary>Source code in <code>src/osw/core.py</code></summary>
6461- <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1974</span>
6462- <span class="normal">1975</span>
6463+ <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1975</span>
64636464<span class="normal">1976</span>
64646465<span class="normal">1977</span>
64656466<span class="normal">1978</span>
@@ -6488,7 +6489,8 @@ <h2 id="osw.core.OSW.ExportJsonLdParams" class="doc doc-heading">
64886489<span class="normal">2001</span>
64896490<span class="normal">2002</span>
64906491<span class="normal">2003</span>
6491- <span class="normal">2004</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">ExportJsonLdParams</span><span class="p">(</span><span class="n">OswBaseModel</span><span class="p">):</span>
6492+ <span class="normal">2004</span>
6493+ <span class="normal">2005</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">ExportJsonLdParams</span><span class="p">(</span><span class="n">OswBaseModel</span><span class="p">):</span>
64926494 <span class="n">context_loader_config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">WtSite</span><span class="o">.</span><span class="n">JsonLdContextLoaderParams</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
64936495<span class="w"> </span><span class="sd">"""The configuration for the JSON-LD context loader."""</span>
64946496 <span class="n">entities</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">OswBaseModel</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">OswBaseModel</span><span class="p">]]</span>
@@ -6800,16 +6802,16 @@ <h2 id="osw.core.OSW.ExportJsonLdResult" class="doc doc-heading">
68006802
68016803 <details class="mkdocstrings-source">
68026804 <summary>Source code in <code>src/osw/core.py</code></summary>
6803- <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">2006</span>
6804- <span class="normal">2007</span>
6805+ <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">2007</span>
68056806<span class="normal">2008</span>
68066807<span class="normal">2009</span>
68076808<span class="normal">2010</span>
68086809<span class="normal">2011</span>
68096810<span class="normal">2012</span>
68106811<span class="normal">2013</span>
68116812<span class="normal">2014</span>
6812- <span class="normal">2015</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">ExportJsonLdResult</span><span class="p">(</span><span class="n">OswBaseModel</span><span class="p">):</span>
6813+ <span class="normal">2015</span>
6814+ <span class="normal">2016</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">ExportJsonLdResult</span><span class="p">(</span><span class="n">OswBaseModel</span><span class="p">):</span>
68136815 <span class="n">documents</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span>
68146816<span class="w"> </span><span class="sd">"""A single JSON-LD document per entity"""</span>
68156817 <span class="n">graph_document</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
@@ -7424,13 +7426,13 @@ <h2 id="osw.core.OSW.JsonLdMode" class="doc doc-heading">
74247426
74257427 <details class="mkdocstrings-source">
74267428 <summary>Source code in <code>src/osw/core.py</code></summary>
7427- <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1966</span>
7428- <span class="normal">1967</span>
7429+ <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1967</span>
74297430<span class="normal">1968</span>
74307431<span class="normal">1969</span>
74317432<span class="normal">1970</span>
74327433<span class="normal">1971</span>
7433- <span class="normal">1972</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">JsonLdMode</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
7434+ <span class="normal">1972</span>
7435+ <span class="normal">1973</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">JsonLdMode</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
74347436<span class="w"> </span><span class="sd">"""enum for jsonld processing mode"""</span>
74357437
74367438 <span class="n">expand</span> <span class="o">=</span> <span class="s2">"expand"</span>
@@ -9148,8 +9150,7 @@ <h2 id="osw.core.OSW.delete_entity" class="doc doc-heading">
91489150
91499151 <details class="mkdocstrings-source">
91509152 <summary>Source code in <code>src/osw/core.py</code></summary>
9151- <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1845</span>
9152- <span class="normal">1846</span>
9153+ <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1846</span>
91539154<span class="normal">1847</span>
91549155<span class="normal">1848</span>
91559156<span class="normal">1849</span>
@@ -9203,7 +9204,8 @@ <h2 id="osw.core.OSW.delete_entity" class="doc doc-heading">
92039204<span class="normal">1897</span>
92049205<span class="normal">1898</span>
92059206<span class="normal">1899</span>
9206- <span class="normal">1900</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">delete_entity</span><span class="p">(</span>
9207+ <span class="normal">1900</span>
9208+ <span class="normal">1901</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">delete_entity</span><span class="p">(</span>
92079209 <span class="bp">self</span><span class="p">,</span>
92089210 <span class="n">entity</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">OswBaseModel</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">OswBaseModel</span><span class="p">],</span> <span class="n">DeleteEntityParam</span><span class="p">],</span>
92099211 <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -9356,8 +9358,7 @@ <h2 id="osw.core.OSW.export_jsonld" class="doc doc-heading">
93569358
93579359 <details class="mkdocstrings-source">
93589360 <summary>Source code in <code>src/osw/core.py</code></summary>
9359- <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">2017</span>
9360- <span class="normal">2018</span>
9361+ <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">2018</span>
93619362<span class="normal">2019</span>
93629363<span class="normal">2020</span>
93639364<span class="normal">2021</span>
@@ -9438,7 +9439,8 @@ <h2 id="osw.core.OSW.export_jsonld" class="doc doc-heading">
94389439<span class="normal">2096</span>
94399440<span class="normal">2097</span>
94409441<span class="normal">2098</span>
9441- <span class="normal">2099</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">export_jsonld</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">ExportJsonLdParams</span><span class="p">)</span> <span class="o">-></span> <span class="n">ExportJsonLdResult</span><span class="p">:</span>
9442+ <span class="normal">2099</span>
9443+ <span class="normal">2100</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">export_jsonld</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">ExportJsonLdParams</span><span class="p">)</span> <span class="o">-></span> <span class="n">ExportJsonLdResult</span><span class="p">:</span>
94429444<span class="w"> </span><span class="sd">"""Exports the given entity/entities as JSON-LD."""</span>
94439445
94449446 <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">resolve_context</span><span class="p">:</span>
@@ -11089,7 +11091,8 @@ <h2 id="osw.core.OSW.store_entity" class="doc doc-heading">
1108911091<span class="normal">1825</span>
1109011092<span class="normal">1826</span>
1109111093<span class="normal">1827</span>
11092- <span class="normal">1828</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">store_entity</span><span class="p">(</span>
11094+ <span class="normal">1828</span>
11095+ <span class="normal">1829</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">store_entity</span><span class="p">(</span>
1109311096 <span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">StoreEntityParam</span><span class="p">,</span> <span class="n">OswBaseModel</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">OswBaseModel</span><span class="p">]]</span>
1109411097<span class="p">)</span> <span class="o">-></span> <span class="n">StoreEntityResult</span><span class="p">:</span>
1109511098<span class="w"> </span><span class="sd">"""stores the given dataclass instance as OSW page by calling BaseModel.json()</span>
@@ -11099,10 +11102,11 @@ <h2 id="osw.core.OSW.store_entity" class="doc doc-heading">
1109911102<span class="sd"> param:</span>
1110011103<span class="sd"> StoreEntityParam, the dataclass instance or a list of instances</span>
1110111104<span class="sd"> """</span>
11102- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">Entity</span><span class="p">):</span>
11103- <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="p">[</span><span class="n">param</span><span class="p">])</span>
1110411105 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
1110511106 <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="n">param</span><span class="p">)</span>
11107+ <span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">):</span>
11108+ <span class="c1"># Accept any OswBaseModel / Entity / Controller instance</span>
11109+ <span class="n">param</span> <span class="o">=</span> <span class="n">OSW</span><span class="o">.</span><span class="n">StoreEntityParam</span><span class="p">(</span><span class="n">entities</span><span class="o">=</span><span class="p">[</span><span class="n">param</span><span class="p">])</span>
1110611110 <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param</span><span class="o">.</span><span class="n">entities</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
1110711111 <span class="n">param</span><span class="o">.</span><span class="n">entities</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="o">.</span><span class="n">entities</span><span class="p">]</span>
1110811112
0 commit comments