|
4 | 4 | <meta name="viewport" content="width=device-width,initial-scale=1"> |
5 | 5 | <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html"><link rel="search" title="Search" href="../../search.html"> |
6 | 6 |
|
7 | | - <!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 --> |
8 | | - <title>compressed_lists.biocframe_list - compressed-lists 0.3.0 documentation</title> |
| 7 | + <!-- Generated with Sphinx 8.2.3 and Furo 2025.12.19 --> |
| 8 | + <title>compressed_lists.biocframe_list - compressed-lists 0.4.0 documentation</title> |
9 | 9 | <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" /> |
10 | | - <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=580074bf" /> |
| 10 | + <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=7bdb33bb" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="../../_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css" /> |
12 | 12 | <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=8dab3a3b" /> |
13 | 13 |
|
|
161 | 161 | </label> |
162 | 162 | </div> |
163 | 163 | <div class="header-center"> |
164 | | - <a href="../../index.html"><div class="brand">compressed-lists 0.3.0 documentation</div></a> |
| 164 | + <a href="../../index.html"><div class="brand">compressed-lists 0.4.0 documentation</div></a> |
165 | 165 | </div> |
166 | 166 | <div class="header-right"> |
167 | 167 | <div class="theme-toggle-container theme-toggle-header"> |
|
182 | 182 |
|
183 | 183 | <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html"> |
184 | 184 |
|
185 | | - <span class="sidebar-brand-text">compressed-lists 0.3.0 documentation</span> |
| 185 | + <span class="sidebar-brand-text">compressed-lists 0.4.0 documentation</span> |
186 | 186 |
|
187 | 187 | </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search"> |
188 | 188 | <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> |
|
235 | 235 | </div> |
236 | 236 | <article role="main" id="furo-main-content"> |
237 | 237 | <h1>Source code for compressed_lists.biocframe_list</h1><div class="highlight"><pre> |
238 | | -<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">Union</span> |
| 238 | +<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span> |
| 239 | + |
| 240 | +<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">Union</span> |
239 | 241 |
|
240 | 242 | <span class="kn">import</span><span class="w"> </span><span class="nn">biocutils</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">ut</span> |
241 | 243 | <span class="kn">from</span><span class="w"> </span><span class="nn">biocframe</span><span class="w"> </span><span class="kn">import</span> <span class="n">BiocFrame</span> |
@@ -263,7 +265,7 @@ <h1>Source code for compressed_lists.biocframe_list</h1><div class="highlight">< |
263 | 265 | <span class="n">unlist_data</span><span class="p">:</span> <span class="n">BiocFrame</span><span class="p">,</span> |
264 | 266 | <span class="n">partitioning</span><span class="p">:</span> <span class="n">Partitioning</span><span class="p">,</span> |
265 | 267 | <span class="n">element_metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
266 | | - <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| 268 | + <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</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> <span class="n">ut</span><span class="o">.</span><span class="n">NamedList</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
267 | 269 | <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> |
268 | 270 | <span class="p">):</span> |
269 | 271 | <span class="w"> </span><span class="sd">"""Initialize a CompressedSplitBiocFrameList.</span> |
@@ -300,7 +302,7 @@ <h1>Source code for compressed_lists.biocframe_list</h1><div class="highlight">< |
300 | 302 | <span class="n">lst</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">BiocFrame</span><span class="p">],</span> |
301 | 303 | <span class="n">names</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ut</span><span class="o">.</span><span class="n">Names</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
302 | 304 | <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
303 | | - <span class="p">)</span> <span class="o">-></span> <span class="s2">"CompressedSplitBiocFrameList"</span><span class="p">:</span> |
| 305 | + <span class="p">)</span> <span class="o">-></span> <span class="n">CompressedSplitBiocFrameList</span><span class="p">:</span> |
304 | 306 | <span class="w"> </span><span class="sd">"""Create a `CompressedSplitBiocFrameList` from a regular list.</span> |
305 | 307 |
|
306 | 308 | <span class="sd"> This concatenates the list of `BiocFrame` objects.</span> |
@@ -465,7 +467,7 @@ <h1>Source code for compressed_lists.biocframe_list</h1><div class="highlight">< |
465 | 467 |
|
466 | 468 | </aside> |
467 | 469 | </div> |
468 | | -</div><script src="../../_static/documentation_options.js?v=e259d695"></script> |
| 470 | +</div><script src="../../_static/documentation_options.js?v=6c02275b"></script> |
469 | 471 | <script src="../../_static/doctools.js?v=9bcbadda"></script> |
470 | 472 | <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> |
471 | 473 | <script src="../../_static/scripts/furo.js?v=46bd48cc"></script> |
|
0 commit comments