This commit is contained in:
@@ -1320,15 +1320,14 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Local filesystem–based credential persistence for Mail Intake.</p>
|
||||
<hr />
|
||||
<h4 id="mail_intake.credentials.pickle--summary">Summary</h4>
|
||||
<h3 id="mail_intake.credentials.pickle--summary">Summary</h3>
|
||||
<p>Local filesystem–based credential persistence for Mail Intake.</p>
|
||||
<p>This module provides a file-backed implementation of the
|
||||
<code>CredentialStore</code> abstraction using Python's <code>pickle</code> module.</p>
|
||||
<p>The pickle-based credential store is intended for local development,
|
||||
<p>The <code>pickle</code>-based credential store is intended for local development,
|
||||
single-node deployments, and controlled environments where credentials
|
||||
do not need to be shared across processes or machines.</p>
|
||||
<p>Due to the security and portability risks associated with pickle-based
|
||||
<p>Due to the security and portability risks associated with <code>pickle</code>-based
|
||||
serialization, this implementation is not suitable for distributed or
|
||||
untrusted environments.</p>
|
||||
|
||||
@@ -1357,7 +1356,7 @@ untrusted environments.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="mail_intake.credentials.store.CredentialStore" href="../../mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore">CredentialStore</a>[<span title="mail_intake.credentials.pickle.T">T</span>]</code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="mail_intake.credentials.store.CredentialStore" href="../store/#mail_intake.credentials.store.CredentialStore">CredentialStore</a>[<span title="mail_intake.credentials.pickle.T">T</span>]</code></p>
|
||||
|
||||
|
||||
<p>Filesystem-backed credential store using pickle serialization.</p>
|
||||
@@ -1371,12 +1370,14 @@ development, testing, and single-process execution contexts.</p>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Stores credentials on the local filesystem
|
||||
- Uses pickle for serialization and deserialization
|
||||
- Does not provide encryption, locking, or concurrency guarantees
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Stores credentials on the local filesystem.
|
||||
- Uses `pickle` for serialization and deserialization.
|
||||
- Does not provide encryption, locking, or concurrency guarantees.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<p><strong>Constraints:</strong></p>
|
||||
<div class="language-text 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>- Credential lifecycle management, validation, and refresh logic are explicitly out of scope for this class
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Credential lifecycle management, validation, and refresh logic are
|
||||
explicitly out of scope for this class.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Initialize a pickle-backed credential store.</p>
|
||||
@@ -1495,8 +1496,12 @@ successfully deserialized; otherwise <code>None</code>.</p>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- If the credential file does not exist or cannot be successfully deserialized, this method returns ``None``
|
||||
- The store does not attempt to validate or interpret the returned credentials
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- If the credential file does not exist or cannot be successfully
|
||||
deserialized, this method returns `None`.
|
||||
- The store does not attempt to validate or interpret the
|
||||
returned credentials.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user