Skip to content

Commit

Permalink
docs: updates from Homebrew/brew
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewTestBot committed Dec 30, 2023
1 parent 23cdf22 commit bc5f23d
Showing 1 changed file with 57 additions and 37 deletions.
94 changes: 57 additions & 37 deletions docs/PyPI.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#pip_report-class_method" title="pip_report (class method)">.<strong>pip_report</strong>(packages) &#x21d2; Object </a>
<a href="#pip_report-class_method" title="pip_report (class method)">.<strong>pip_report</strong>(packages, python_name: &quot;python&quot;) &#x21d2; Object </a>


</span>
Expand Down Expand Up @@ -272,14 +272,14 @@ <h3 class="signature first" id="normalize_python_package-class_method">
<pre class="lines">


345
346
347
348
349</pre>
355
356
357
358
359</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 345</span>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 355</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_normalize_python_package'>normalize_python_package</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='comment'># This normalization is defined in the PyPA packaging specifications;
Expand All @@ -294,7 +294,7 @@ <h3 class="signature first" id="normalize_python_package-class_method">
<div class="method_details ">
<h3 class="signature " id="pip_report-class_method">

.<strong>pip_report</strong>(packages) &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>
.<strong>pip_report</strong>(packages, python_name: &quot;python&quot;) &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>



Expand All @@ -321,29 +321,29 @@ <h3 class="signature " id="pip_report-class_method">
<pre class="lines">


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365</pre>
365
366
367
368
369
370
371
372
373
374
375</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 351</span>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 361</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_packages'>packages</span><span class='rparen'>)</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_packages'>packages</span><span class='comma'>,</span> <span class='label'>python_name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_packages'>packages</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>

<span class='id identifier rubyid_command'>command</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="Formula.html" title="Formula (class)">Formula</a></span></span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python3</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-m</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pip</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>install</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-q</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--dry-run</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_command'>command</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="Formula.html" title="Formula (class)">Formula</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_python_name'>python_name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_libexec'>libexec</span><span class='op'>/</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bin/python</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-m</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pip</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>install</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-q</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--dry-run</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--ignore-installed</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--report=/dev/stdout</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_packages'>packages</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_pip_output'>pip_output</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_popen_read'><span class='object_link'><a href="Utils.html#popen_read-class_method" title="Utils.popen_read (method)">popen_read</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PIP_REQUIRE_VIRTUALENV</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>false</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_command'>command</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='gvar'>$CHILD_STATUS</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
Expand Down Expand Up @@ -390,19 +390,19 @@ <h3 class="signature " id="pip_report_to_packages-class_method">
<pre class="lines">


367
368
369
370
371
372
373
374
375
376</pre>
377
378
379
380
381
382
383
384
385
386</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 367</span>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 377</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pip_report_to_packages'>pip_report_to_packages</span><span class='lparen'>(</span><span class='id identifier rubyid_report'>report</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_report'>report</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
Expand Down Expand Up @@ -804,7 +804,17 @@ <h3 class="signature " id="update_python_resources!-class_method">
340
341
342
343</pre>
343
344
345
346
347
348
349
350
351
352
353</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/pypi.rb', line 205</span>
Expand Down Expand Up @@ -883,15 +893,25 @@ <h3 class="signature " id="update_python_resources!-class_method">
<span class='kw'>end</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_ensure_formula_installed!'>ensure_formula_installed!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_python_deps'>python_deps</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_deps'>deps</span>
<span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_formula</span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python@</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:version</span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_reverse'>reverse</span>
<span class='id identifier rubyid_python_name'>python_name</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_python_deps'>python_deps</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>python</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='lparen'>(</span><span class='id identifier rubyid_python_deps'>python_deps</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:any_version_installed?</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_python_deps'>python_deps</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ensure_formula_installed!'>ensure_formula_installed!</span><span class='lparen'>(</span><span class='id identifier rubyid_python_name'>python_name</span><span class='rparen'>)</span>

<span class='comment'># Resolve the dependency tree of all input packages
</span> <span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Retrieving PyPI dependencies for \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_input_packages'>input_packages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;...</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_print_only'>print_only</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_silent'>silent</span>
<span class='id identifier rubyid_found_packages'>found_packages</span> <span class='op'>=</span> <span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_input_packages'>input_packages</span><span class='rparen'>)</span>
<span class='id identifier rubyid_found_packages'>found_packages</span> <span class='op'>=</span> <span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_input_packages'>input_packages</span><span class='comma'>,</span> <span class='label'>python_name:</span> <span class='id identifier rubyid_python_name'>python_name</span><span class='rparen'>)</span>
<span class='comment'># Resolve the dependency tree of excluded packages to prune the above
</span> <span class='id identifier rubyid_exclude_packages'>exclude_packages</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_package'>package</span><span class='op'>|</span> <span class='id identifier rubyid_found_packages'>found_packages</span><span class='period'>.</span><span class='id identifier rubyid_exclude?'>exclude?</span> <span class='id identifier rubyid_package'>package</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Retrieving PyPI dependencies for excluded \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exclude_packages'>exclude_packages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;...</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_print_only'>print_only</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_silent'>silent</span>
<span class='id identifier rubyid_exclude_packages'>exclude_packages</span> <span class='op'>=</span> <span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_exclude_packages'>exclude_packages</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="PyPI/Package.html" title="PyPI::Package (class)">Package</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PyPI/Package.html#initialize-instance_method" title="PyPI::Package#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_main_package'>main_package</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_exclude_packages'>exclude_packages</span> <span class='op'>=</span> <span class='id identifier rubyid_pip_report'>pip_report</span><span class='lparen'>(</span><span class='id identifier rubyid_exclude_packages'>exclude_packages</span><span class='comma'>,</span> <span class='label'>python_name:</span> <span class='id identifier rubyid_python_name'>python_name</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="PyPI/Package.html" title="PyPI::Package (class)">Package</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PyPI/Package.html#initialize-instance_method" title="PyPI::Package#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_main_package'>main_package</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rbracket'>]</span>

<span class='id identifier rubyid_new_resource_blocks'>new_resource_blocks</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_found_packages'>found_packages</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_package'>package</span><span class='op'>|</span>
Expand Down

0 comments on commit bc5f23d

Please sign in to comment.