Deployed 000d1a1 to dev with MkDocs 1.5.2 and mike 1.1.2

pdm-project · Mar 21, 2024 · ea25c21 · ea25c21
1 parent 05ce7d8
commit ea25c21
Show file tree

Hide file tree

Showing 7 changed files with 143 additions and 14 deletions.
diff --git a/dev/dev/fixtures/index.html b/dev/dev/fixtures/index.html
@@ -742,8 +742,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#pdm.pytest.LocalFileAdapter" class="md-nav__link">
-    LocalFileAdapter
+  <a href="#pdm.pytest.LocalIndexTransport" class="md-nav__link">
+    LocalIndexTransport
   </a>
 
 </li>
@@ -1055,8 +1055,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#pdm.pytest.LocalFileAdapter" class="md-nav__link">
-    LocalFileAdapter
+  <a href="#pdm.pytest.LocalIndexTransport" class="md-nav__link">
+    LocalIndexTransport
   </a>
 
 </li>
@@ -1327,7 +1327,7 @@ <h2 id="pdm.pytest.IndexMap" class="doc doc-heading">
 
 
 <h2 id="pdm.pytest.IndexOverrides" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">IndexOverrides</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span></code>
+<code class="highlight language-python"><span class="n">IndexOverrides</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">]</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
@@ -1407,19 +1407,19 @@ <h2 id="pdm.pytest.Distribution" class="doc doc-heading">
 
 
 
-<h2 id="pdm.pytest.LocalFileAdapter" class="doc doc-heading">
-        <code>LocalFileAdapter</code>
+<h2 id="pdm.pytest.LocalIndexTransport" class="doc doc-heading">
+        <code>LocalIndexTransport</code>
 
 
-<a href="#pdm.pytest.LocalFileAdapter" class="headerlink" title="Permanent link">#</a></h2>
+<a href="#pdm.pytest.LocalIndexTransport" class="headerlink" title="Permanent link">#</a></h2>
 
 
   <div class="doc doc-contents ">
       <p class="doc doc-class-bases">
-        Bases: <code>requests.<span title="requests.adapters">adapters</span>.<span title="requests.adapters.BaseAdapter">BaseAdapter</span></code></p>
+        Bases: <code>httpx.<span title="httpx.BaseTransport">BaseTransport</span></code></p>
 
 
-      <p>A local file adapter for request.</p>
+      <p>A local file transport for HTTPX.</p>
 <p>Allows to mock some HTTP requests with some local files</p>
 
 
@@ -2062,7 +2062,7 @@ <h2 id="pdm.pytest.project" class="doc doc-heading">
 
 
 <h2 id="pdm.pytest.project_no_init" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">project_no_init</span><span class="p">(</span><span class="n">tmp_path</span><span class="p">,</span> <span class="n">mocker</span><span class="p">,</span> <span class="n">core</span><span class="p">,</span> <span class="n">pdm_session</span><span class="p">,</span> <span class="n">monkeypatch</span><span class="p">,</span> <span class="n">build_env</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">project_no_init</span><span class="p">(</span><span class="n">tmp_path</span><span class="p">,</span> <span class="n">mocker</span><span class="p">,</span> <span class="n">core</span><span class="p">,</span> <span class="n">build_test_session</span><span class="p">,</span> <span class="n">monkeypatch</span><span class="p">,</span> <span class="n">build_env</span><span class="p">)</span></code>
 
 <a href="#pdm.pytest.project_no_init" class="headerlink" title="Permanent link">#</a></h2>
 

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/reference/api/index.html b/dev/reference/api/index.html
@@ -658,6 +658,13 @@
     <nav class="md-nav" aria-label="Core">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#pdm.core.Core.state" class="md-nav__link">
+    state
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#pdm.core.Core.add_config" class="md-nav__link">
     add_config()
@@ -691,6 +698,13 @@
     main()
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#pdm.core.Core.push_state" class="md-nav__link">
+    push_state()
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -1082,6 +1096,13 @@
     <nav class="md-nav" aria-label="Core">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#pdm.core.Core.state" class="md-nav__link">
+    state
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#pdm.core.Core.add_config" class="md-nav__link">
     add_config()
@@ -1115,6 +1136,13 @@
     main()
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#pdm.core.Core.push_state" class="md-nav__link">
+    push_state()
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -1386,6 +1414,27 @@ <h2 id="pdm.core.Core" class="doc doc-heading">
 
 
 
+<div class="doc doc-object doc-attribute">
+
+
+
+<h3 id="pdm.core.Core.state" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">state</span><span class="p">:</span> <span class="n">State</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-property"><code>property</code></small>
+  </span>
+
+<a href="#pdm.core.Core.state" class="headerlink" title="Permanent link">#</a></h3>
+
+
+  <div class="doc doc-contents ">
+
+      <p>Get the current state object.</p>
+  </div>
+
+</div>
+
 
 
 <div class="doc doc-object doc-function">
@@ -1590,6 +1639,58 @@ <h3 id="pdm.core.Core.main" class="doc doc-heading">
 
 
 
+<h3 id="pdm.core.Core.push_state" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">push_state</span><span class="p">(</span><span class="n">__empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
+
+<a href="#pdm.core.Core.push_state" class="headerlink" title="Permanent link">#</a></h3>
+
+
+  <div class="doc doc-contents ">
+
+      <p>Push a new state object to the stack.</p>
+
+  <p><strong>Parameters:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+        <th>Default</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td><code>__empty</code></td>
+          <td>
+                <code>bool</code>
+          </td>
+          <td><p>Whether to make an empty state.</p></td>
+          <td>
+                <code>False</code>
+          </td>
+        </tr>
+        <tr>
+          <td><code>**kwargs</code></td>
+          <td>
+                <code><span title="typing.Any">Any</span></code>
+          </td>
+          <td><p>The new attributes to set to the state object.</p></td>
+          <td>
+                <code>{}</code>
+          </td>
+        </tr>
+    </tbody>
+  </table>
+
+  </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
 <h3 id="pdm.core.Core.register_command" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">register_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
 
@@ -1738,8 +1839,8 @@ <h3 id="pdm.project.core.Project.config" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">config</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span></code>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-property"><code>property</code></small>
       <small class="doc doc-label doc-label-cached"><code>cached</code></small>
+      <small class="doc doc-label doc-label-property"><code>property</code></small>
   </span>
 
 <a href="#pdm.project.core.Project.config" class="headerlink" title="Permanent link">#</a></h3>
@@ -1781,8 +1882,8 @@ <h3 id="pdm.project.core.Project.project_config" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">project_config</span><span class="p">:</span> <span class="n">Config</span></code>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-property"><code>property</code></small>
       <small class="doc doc-label doc-label-cached"><code>cached</code></small>
+      <small class="doc doc-label doc-label-property"><code>property</code></small>
   </span>
 
 <a href="#pdm.project.core.Project.project_config" class="headerlink" title="Permanent link">#</a></h3>

diff --git a/dev/reference/cli/index.html b/dev/reference/cli/index.html
@@ -1487,6 +1487,7 @@ <h1 id="cli-reference">CLI Reference<a class="headerlink" href="#cli-reference"
 <li><code>-c</code>, <code>--config</code>: Specify another config file path [env var: <code>PDM_CONFIG_FILE</code>] </li>
 <li><code>-v</code>, <code>--verbose</code>: Use <code>-v</code> for detailed output and <code>-vv</code> for more detailed</li>
 <li><code>-q</code>, <code>--quiet</code>: Suppress output</li>
+<li><code>--no-cache</code>: Disable the cache for the current command. [env var: <code>PDM_NO_CACHE</code>]</li>
 <li><code>-I</code>, <code>--ignore-python</code>: Ignore the Python path saved in<code>.pdm-python</code>. [env var: <code>PDM_IGNORE_SAVED_PYTHON</code>]</li>
 <li><code>--pep582</code> <code>SHELL</code>: Print the command line to be eval'd by the shell</li>
 </ul>
@@ -1841,6 +1842,7 @@ <h3 id="lock">lock<a class="headerlink" href="#lock" title="Permanent link">#</a
 <li><code>--check</code>: Check if the lock file is up to date and quit</li>
 <li><code>--update-reuse</code>: Reuse pinned versions already present in lock file if possible (default: <code>all</code>)</li>
 <li><code>--update-reuse-installed</code>: Reuse installed packages if possible</li>
+<li><code>--exclude-newer</code>: Exclude packages newer than the given UTC date in format <code>YYYY-MM-DD[THH:MM:SSZ]</code></li>
 </ul>
 <p>Lock Strategy:</p>
 <ul>

diff --git a/dev/search/search_index.json b/dev/search/search_index.json
diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz
diff --git a/dev/usage/dependency/index.html b/dev/usage/dependency/index.html
@@ -591,6 +591,13 @@
     Inherit the metadata from parents
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#exclude-packages-newer-than-specific-date" class="md-nav__link">
+    Exclude packages newer than specific date
+  </a>
+
 </li>
 
       </ul>
@@ -1210,6 +1217,13 @@
     Inherit the metadata from parents
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#exclude-packages-newer-than-specific-date" class="md-nav__link">
+    Exclude packages newer than specific date
+  </a>
+
 </li>
 
       </ul>
@@ -1706,6 +1720,18 @@ <h3 id="inherit-the-metadata-from-parents">Inherit the metadata from parents<a c
 </div>
 <p>Previously, the <code>pdm lock</code> command would record package metadata as it is. When installing, PDM would start from the top requirements and traverse down to the leaf node of the dependency tree. It would then evaluate any marker it encounters against the current environment. If a marker is not satisfied, the package would be discarded. In other words, we need an additional "resolution" step in installation.</p>
 <p>When the <code>inherit_metadata</code> strategy is enabled, PDM will inherit and merge environment markers from a package's ancestors. These markers are then encoded in the lockfile during locking, resulting in faster installations. This has been enabled by default from version <code>2.11.0</code>, to disable this strategy in the config, use <code>pdm config strategy.inherit_metadata false</code>.</p>
+<h3 id="exclude-packages-newer-than-specific-date">Exclude packages newer than specific date<a class="headerlink" href="#exclude-packages-newer-than-specific-date" title="Permanent link">#</a></h3>
+<div class="admonition tip">
+<p class="admonition-title">Added in version 2.13.0</p>
+</div>
+<p>You can exclude packages that are newer than a specified date by passing the <code>--exclude-newer</code> option to <code>pdm lock</code>. This is useful when you want to lock the dependencies to a specific date, for example, to ensure reproducibility of the build.</p>
+<p>The date may be specified as a RFC 3339 timestamp (e.g., <code>2006-12-02T02:07:43Z</code>) or UTC date in the same format (e.g., <code>2006-12-02</code>).</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>pdm<span class="w"> </span>lock<span class="w"> </span>--exclude-newer<span class="w"> </span><span class="m">2024</span>-01-01
+</code></pre></div></td></tr></table></div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The package index must support the <code>upload-time</code> field as specified in <a href="https://peps.python.org/pep-0700/">PEP 700</a>. If the field is not present for a given distribution, the distribution will be treated as unavailable.</p>
+</div>
 <h2 id="show-what-packages-are-installed">Show what packages are installed<a class="headerlink" href="#show-what-packages-are-installed" title="Permanent link">#</a></h2>
 <p>Similar to <code>pip list</code>, you can list all packages installed in the packages directory:</p>
 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>pdm<span class="w"> </span>list