Merge remote-tracking branch 'origin/fix_documentation' into fix_documentation

Author: quantori-pokidovea

docs/signals_notebook/api.html renamed to docs/api.html

@@ -40,6 +40,7 @@ <h1 class="title">Module <code>signals_notebook.base</code></h1>
     https://github.com/samuelcolvin/pydantic/issues/1577
     Adds ability to use properties with setters
     &#34;&#34;&#34;
+
     @no_type_check
     def __setattr__(self, name, value):
         try:
@@ -84,6 +85,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     https://github.com/samuelcolvin/pydantic/issues/1577
     Adds ability to use properties with setters
     &#34;&#34;&#34;
+
     @no_type_check
     def __setattr__(self, name, value):
         try:

docs/signals_notebook/attributes/attribute.html renamed to docs/attributes/attribute.html

@@ -29,7 +29,7 @@ <h1 class="title">Module <code>signals_notebook.entities.admin_defined_object</c
 <pre><code class="python">import json
 import logging
 from functools import cached_property
-from typing import ClassVar, Literal, Optional
+from typing import Any, ClassVar, List, Literal, Optional
 
 from pydantic import BaseModel, Field
 
@@ -163,12 +163,15 @@ <h1 class="title">Module <code>signals_notebook.entities.admin_defined_object</c
 
         return template.render(data=data)
 
-    def dump(self, base_path: str, fs_handler: FSHandler) -&gt; None:  # type: ignore[override]
+    def dump(
+        self, base_path: str, fs_handler: FSHandler, alias: Optional[List[str]] = None
+    ) -&gt; None:  # type: ignore[override]
         &#34;&#34;&#34;Dump AdminDefinedObject entity
 
         Args:
             base_path: content path where create dump
             fs_handler: FSHandler
+            alias: Backup alias
 
         Returns:
 
@@ -180,12 +183,13 @@ <h1 class="title">Module <code>signals_notebook.entities.admin_defined_object</c
         fs_handler.write(
             fs_handler.join_path(base_path, self.eid, &#39;metadata.json&#39;),
             json.dumps(metadata),
+            base_alias=alias + [self.name, &#39;__Metadata&#39;] if alias else None,
         )
         for child in self.get_children():
             child.dump(fs_handler.join_path(base_path, self.eid), fs_handler)
 
     @classmethod
-    def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:  # type: ignore[override]
+    def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:
         &#34;&#34;&#34;Load AdminDefinedObject entity
 
         Args:
@@ -196,11 +200,15 @@ <h1 class="title">Module <code>signals_notebook.entities.admin_defined_object</c
         Returns:
 
         &#34;&#34;&#34;
+        cls._load(path, fs_handler, notebook)
+
+    @classmethod
+    def _load(cls, path: str, fs_handler: FSHandler, parent: Any) -&gt; None:
         from signals_notebook.item_mapper import ItemMapper
 
         metadata = json.loads(fs_handler.read(fs_handler.join_path(path, &#39;metadata.json&#39;)))
         experiment = cls.create(
-            notebook=notebook,
+            notebook=parent,
             name=metadata[&#39;name&#39;],
             ado_type_name=metadata.get(&#39;ado_name&#39;, CUSTOM_SYSTEM_OBJECT),
             description=metadata[&#39;description&#39;],
@@ -209,7 +217,7 @@ <h1 class="title">Module <code>signals_notebook.entities.admin_defined_object</c
         child_entities_folders = fs_handler.list_subfolders(path)
         for child_entity in child_entities_folders:
             child_entity_type = child_entity.split(&#39;:&#39;)[0]
-            ItemMapper.get_item_class(child_entity_type).load(
+            ItemMapper.get_item_class(child_entity_type)._load(
                 fs_handler.join_path(path, child_entity), fs_handler, experiment
             )</code></pre>
 </details>
@@ -315,12 +323,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         return template.render(data=data)
 
-    def dump(self, base_path: str, fs_handler: FSHandler) -&gt; None:  # type: ignore[override]
+    def dump(
+        self, base_path: str, fs_handler: FSHandler, alias: Optional[List[str]] = None
+    ) -&gt; None:  # type: ignore[override]
         &#34;&#34;&#34;Dump AdminDefinedObject entity
 
         Args:
             base_path: content path where create dump
             fs_handler: FSHandler
+            alias: Backup alias
 
         Returns:
 
@@ -332,12 +343,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         fs_handler.write(
             fs_handler.join_path(base_path, self.eid, &#39;metadata.json&#39;),
             json.dumps(metadata),
+            base_alias=alias + [self.name, &#39;__Metadata&#39;] if alias else None,
         )
         for child in self.get_children():
             child.dump(fs_handler.join_path(base_path, self.eid), fs_handler)
 
     @classmethod
-    def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:  # type: ignore[override]
+    def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:
         &#34;&#34;&#34;Load AdminDefinedObject entity
 
         Args:
@@ -348,11 +360,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         Returns:
 
         &#34;&#34;&#34;
+        cls._load(path, fs_handler, notebook)
+
+    @classmethod
+    def _load(cls, path: str, fs_handler: FSHandler, parent: Any) -&gt; None:
         from signals_notebook.item_mapper import ItemMapper
 
         metadata = json.loads(fs_handler.read(fs_handler.join_path(path, &#39;metadata.json&#39;)))
         experiment = cls.create(
-            notebook=notebook,
+            notebook=parent,
             name=metadata[&#39;name&#39;],
             ado_type_name=metadata.get(&#39;ado_name&#39;, CUSTOM_SYSTEM_OBJECT),
             description=metadata[&#39;description&#39;],
@@ -361,7 +377,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         child_entities_folders = fs_handler.list_subfolders(path)
         for child_entity in child_entities_folders:
             child_entity_type = child_entity.split(&#39;:&#39;)[0]
-            ItemMapper.get_item_class(child_entity_type).load(
+            ItemMapper.get_item_class(child_entity_type)._load(
                 fs_handler.join_path(path, child_entity), fs_handler, experiment
             )</code></pre>
 </details>
@@ -490,7 +506,7 @@ <h2 id="args">Args</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">@classmethod
-def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:  # type: ignore[override]
+def load(cls, path: str, fs_handler: FSHandler, notebook: Notebook) -&gt; None:
     &#34;&#34;&#34;Load AdminDefinedObject entity
 
     Args:
@@ -501,29 +517,14 @@ <h2 id="args">Args</h2>
     Returns:
 
     &#34;&#34;&#34;
-    from signals_notebook.item_mapper import ItemMapper
-
-    metadata = json.loads(fs_handler.read(fs_handler.join_path(path, &#39;metadata.json&#39;)))
-    experiment = cls.create(
-        notebook=notebook,
-        name=metadata[&#39;name&#39;],
-        ado_type_name=metadata.get(&#39;ado_name&#39;, CUSTOM_SYSTEM_OBJECT),
-        description=metadata[&#39;description&#39;],
-        force=True,
-    )
-    child_entities_folders = fs_handler.list_subfolders(path)
-    for child_entity in child_entities_folders:
-        child_entity_type = child_entity.split(&#39;:&#39;)[0]
-        ItemMapper.get_item_class(child_entity_type).load(
-            fs_handler.join_path(path, child_entity), fs_handler, experiment
-        )</code></pre>
+    cls._load(path, fs_handler, notebook)</code></pre>
 </details>
 </dd>
 </dl>
 <h3>Methods</h3>
 <dl>
 <dt id="signals_notebook.entities.admin_defined_object.AdminDefinedObject.dump"><code class="name flex">
-<span>def <span class="ident">dump</span></span>(<span>self, base_path: str, fs_handler: <a title="signals_notebook.utils.fs_handler.FSHandler" href="../utils/fs_handler.html#signals_notebook.utils.fs_handler.FSHandler">FSHandler</a>) ‑> None</span>
+<span>def <span class="ident">dump</span></span>(<span>self, base_path: str, fs_handler: <a title="signals_notebook.utils.fs_handler.FSHandler" href="../utils/fs_handler.html#signals_notebook.utils.fs_handler.FSHandler">FSHandler</a>, alias: Optional[List[str]] = None) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Dump AdminDefinedObject entity</p>
@@ -533,18 +534,23 @@ <h2 id="args">Args</h2>
 <dd>content path where create dump</dd>
 <dt><strong><code>fs_handler</code></strong></dt>
 <dd>FSHandler</dd>
+<dt><strong><code>alias</code></strong></dt>
+<dd>Backup alias</dd>
 </dl>
 <p>Returns:</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def dump(self, base_path: str, fs_handler: FSHandler) -&gt; None:  # type: ignore[override]
+<pre><code class="python">def dump(
+    self, base_path: str, fs_handler: FSHandler, alias: Optional[List[str]] = None
+) -&gt; None:  # type: ignore[override]
     &#34;&#34;&#34;Dump AdminDefinedObject entity
 
     Args:
         base_path: content path where create dump
         fs_handler: FSHandler
+        alias: Backup alias
 
     Returns:
 
@@ -556,6 +562,7 @@ <h2 id="args">Args</h2>
     fs_handler.write(
         fs_handler.join_path(base_path, self.eid, &#39;metadata.json&#39;),
         json.dumps(metadata),
+        base_alias=alias + [self.name, &#39;__Metadata&#39;] if alias else None,
     )
     for child in self.get_children():
         child.dump(fs_handler.join_path(base_path, self.eid), fs_handler)</code></pre>