Skip to content

fix drs-pull progress bar display behavior #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfshao merged 3 commits into from
Aug 18, 2026
Merged

fix drs-pull progress bar display behavior #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33ce7da
fix drs-pull progress bar display behavior
mfshao Aug 18, 2026
7d6aa63
Apply automatic documentation changes
mfshao Aug 18, 2026
6720feb
update version
mfshao Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
348 changes: 174 additions & 174 deletions docs/_build/html/_modules/gen3/auth.html
View file
Open in desktop

Large diffs are not rendered by default.

104 changes: 52 additions & 52 deletions docs/_build/html/_modules/gen3/file.html
View file
Open in desktop

Large diffs are not rendered by default.

426 changes: 213 additions & 213 deletions docs/_build/html/_modules/gen3/index.html
View file
Open in desktop

Large diffs are not rendered by default.

120 changes: 60 additions & 60 deletions docs/_build/html/_modules/gen3/jobs.html
View file
Open in desktop

Large diffs are not rendered by default.

428 changes: 214 additions & 214 deletions docs/_build/html/_modules/gen3/metadata.html
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions docs/_build/html/_modules/gen3/object.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h1>Source code for gen3.object</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Gen3Object">
<a class="viewcode-back" href="../../object.html#gen3.object.Gen3Object">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Gen3Object</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;For interacting with Gen3 object level features.</span>
<span class="w"> </span><span class="sd">"""For interacting with Gen3 object level features.</span>

<span class="sd"> A class for interacting with the Gen3 object services.</span>
<span class="sd"> Currently allows creating and deleting of an object from the Gen3 System.</span>
Expand All @@ -54,49 +54,49 @@ <h1>Source code for gen3.object</h1><div class="highlight"><pre>
<span class="sd"> This generates the Gen3Object class pointed at the sandbox commons while</span>
<span class="sd"> using the credentials.json downloaded from the commons profile page.</span>

<span class="sd"> &gt;&gt;&gt; auth = Gen3Auth(refresh_file=&quot;credentials.json&quot;)</span>
<span class="sd"> &gt;&gt;&gt; auth = Gen3Auth(refresh_file="credentials.json")</span>
<span class="sd"> ... object = Gen3Object(auth)</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="sd"> """</span>

<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">auth_provider</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span> <span class="o">=</span> <span class="n">auth_provider</span>
<span class="bp">self</span><span class="o">.</span><span class="n">service_endpoint</span> <span class="o">=</span> <span class="s2">&quot;/mds&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">service_endpoint</span> <span class="o">=</span> <span class="s2">"/mds"</span>

<span class="k">def</span><span class="w"> </span><span class="nf">create_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">authz</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">aliases</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">url</span> <span class="o">=</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">service_endpoint</span>
<span class="o">+</span> <span class="s2">&quot;/objects&quot;</span>
<span class="o">+</span> <span class="s2">"/objects"</span>
<span class="p">)</span>
<span class="n">body</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;file_name&quot;</span><span class="p">:</span> <span class="n">file_name</span><span class="p">,</span>
<span class="s2">&quot;authz&quot;</span><span class="p">:</span> <span class="n">authz</span><span class="p">,</span>
<span class="s2">&quot;metadata&quot;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">,</span>
<span class="s2">&quot;aliases&quot;</span><span class="p">:</span> <span class="n">aliases</span><span class="p">,</span>
<span class="s2">"file_name"</span><span class="p">:</span> <span class="n">file_name</span><span class="p">,</span>
<span class="s2">"authz"</span><span class="p">:</span> <span class="n">authz</span><span class="p">,</span>
<span class="s2">"metadata"</span><span class="p">:</span> <span class="n">metadata</span><span class="p">,</span>
<span class="s2">"aliases"</span><span class="p">:</span> <span class="n">aliases</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">body</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span><span class="p">)</span>
<span class="n">raise_for_status_and_print_error</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<span class="k">return</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;guid&quot;</span><span class="p">],</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;upload_url&quot;</span><span class="p">]</span>
<span class="k">return</span> <span class="n">data</span><span class="p">[</span><span class="s2">"guid"</span><span class="p">],</span> <span class="n">data</span><span class="p">[</span><span class="s2">"upload_url"</span><span class="p">]</span>

<div class="viewcode-block" id="Gen3Object.delete_object">
<a class="viewcode-back" href="../../object.html#gen3.object.Gen3Object.delete_object">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">delete_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">,</span> <span class="n">delete_file_locations</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Delete the object from indexd, metadata service and optionally all storage locations</span>

<span class="sd"> Args:</span>
<span class="sd"> `guid` -- GUID of the object to delete</span>
<span class="sd"> `delete_file_locations` -- if True, removes the object from existing bucket location(s) through fence</span>
<span class="sd"> Returns:</span>
<span class="sd"> Nothing</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">delete_param</span> <span class="o">=</span> <span class="s2">&quot;?delete_file_locations&quot;</span> <span class="k">if</span> <span class="n">delete_file_locations</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="sd"> """</span>
<span class="n">delete_param</span> <span class="o">=</span> <span class="s2">"?delete_file_locations"</span> <span class="k">if</span> <span class="n">delete_file_locations</span> <span class="k">else</span> <span class="s2">""</span>
<span class="n">url</span> <span class="o">=</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_provider</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">service_endpoint</span>
<span class="o">+</span> <span class="s2">&quot;/objects/&quot;</span>
<span class="o">+</span> <span class="s2">"/objects/"</span>
<span class="o">+</span> <span class="n">guid</span>
<span class="o">+</span> <span class="n">delete_param</span>
<span class="p">)</span>
Expand Down
Loading
Loading