Skip to content

Commit 8fa8cf9

Browse files
committed
Regenerating documentation for 1.0.4
1 parent fdda80f commit 8fa8cf9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+480
-211
lines changed

docs/build/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 79eb4f6d749f8afd0854dfaf20582dd7
3+
config: 0e250b469303f551736a785b66f0d36c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_modules/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Overview: module code &#8212; PythonForWindows 1.0.3 documentation</title>
7+
<title>Overview: module code &#8212; PythonForWindows 1.0.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=def86cc0" />
1010
<link rel="stylesheet" type="text/css" href="../_static/css/mbasic.css?v=957880af" />
1111

12-
<script src="../_static/documentation_options.js?v=baaebd52"></script>
12+
<script src="../_static/documentation_options.js?v=71272d9f"></script>
1313
<script src="../_static/doctools.js?v=9a2dae69"></script>
1414
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1515

@@ -25,7 +25,7 @@ <h3>Navigation</h3>
2525
<li class="right" >
2626
<a href="../py-modindex.html" title="Python Module Index"
2727
>modules</a> |</li>
28-
<li class="nav-item nav-item-0"><a href="../index.html">PythonForWindows 1.0.3 documentation</a> &#187;</li>
28+
<li class="nav-item nav-item-0"><a href="../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
2929
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
3030
</ul>
3131
</div>
@@ -115,7 +115,7 @@ <h3>Navigation</h3>
115115
<li class="right" >
116116
<a href="../py-modindex.html" title="Python Module Index"
117117
>modules</a> |</li>
118-
<li class="nav-item nav-item-0"><a href="../index.html">PythonForWindows 1.0.3 documentation</a> &#187;</li>
118+
<li class="nav-item nav-item-0"><a href="../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
119119
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
120120
</ul>
121121
</div>

docs/build/html/_modules/windows/crypto/certificate.html

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>windows.crypto.certificate &#8212; PythonForWindows 1.0.3 documentation</title>
7+
<title>windows.crypto.certificate &#8212; PythonForWindows 1.0.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../../../_static/classic.css?v=def86cc0" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/mbasic.css?v=957880af" />
1111

12-
<script src="../../../_static/documentation_options.js?v=baaebd52"></script>
12+
<script src="../../../_static/documentation_options.js?v=71272d9f"></script>
1313
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
1414
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1515

@@ -25,7 +25,7 @@ <h3>Navigation</h3>
2525
<li class="right" >
2626
<a href="../../../py-modindex.html" title="Python Module Index"
2727
>modules</a> |</li>
28-
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.3 documentation</a> &#187;</li>
28+
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
2929
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
3030
<li class="nav-item nav-item-this"><a href="">windows.crypto.certificate</a></li>
3131
</ul>
@@ -45,7 +45,7 @@ <h1>Source code for windows.crypto.certificate</h1><div class="highlight"><pre>
4545
<span class="kn">import</span> <span class="nn">windows.generated_def</span> <span class="k">as</span> <span class="nn">gdef</span>
4646

4747
<span class="kn">from</span> <span class="nn">windows.crypto</span> <span class="kn">import</span> <span class="n">DEFAULT_ENCODING</span>
48-
<span class="kn">from</span> <span class="nn">windows.pycompat</span> <span class="kn">import</span> <span class="n">urepr_encode</span>
48+
<span class="kn">from</span> <span class="nn">windows.pycompat</span> <span class="kn">import</span> <span class="n">urepr_encode</span><span class="p">,</span> <span class="n">unicode_type</span>
4949

5050
<span class="kn">import</span> <span class="nn">windows.crypto.cryptmsg</span>
5151

@@ -99,7 +99,8 @@ <h1>Source code for windows.crypto.certificate</h1><div class="highlight"><pre>
9999
<span class="n">gdef</span><span class="o">.</span><span class="n">LPWSTR</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span>
100100
<span class="c1"># filename,</span>
101101
<span class="n">content_type</span><span class="p">,</span>
102-
<span class="n">gdef</span><span class="o">.</span><span class="n">CERT_QUERY_FORMAT_FLAG_BINARY</span><span class="p">,</span>
102+
<span class="c1"># gdef.CERT_QUERY_FORMAT_FLAG_BINARY,</span>
103+
<span class="n">gdef</span><span class="o">.</span><span class="n">CERT_QUERY_FORMAT_FLAG_ALL</span><span class="p">,</span>
103104
<span class="mi">0</span><span class="p">,</span>
104105
<span class="n">dwEncoding</span><span class="p">,</span>
105106
<span class="n">dwContentType</span><span class="p">,</span>
@@ -201,7 +202,9 @@ <h1>Source code for windows.crypto.certificate</h1><div class="highlight"><pre>
201202
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a new :class:`CertificateStore` from system store ``store_name``</span>
202203
<span class="sd"> (see `System Store Locations &lt;https://msdn.microsoft.com/en-us/library/windows/desktop/aa388136(v=vs.85).aspx&gt;`_)</span>
203204
<span class="sd"> &quot;&quot;&quot;</span>
204-
<span class="n">res</span> <span class="o">=</span> <span class="n">winproxy</span><span class="o">.</span><span class="n">CertOpenStore</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_PROV_SYSTEM_A</span><span class="p">,</span> <span class="n">DEFAULT_ENCODING</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_SYSTEM_STORE_LOCAL_MACHINE</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_READONLY_FLAG</span><span class="p">,</span> <span class="n">store_name</span><span class="p">)</span>
205+
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">store_name</span><span class="p">,</span> <span class="n">unicode_type</span><span class="p">):</span>
206+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;store_name should be an unicode string not </span><span class="si">{0}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">store_name</span><span class="p">)))</span>
207+
<span class="n">res</span> <span class="o">=</span> <span class="n">winproxy</span><span class="o">.</span><span class="n">CertOpenStore</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_PROV_SYSTEM_W</span><span class="p">,</span> <span class="n">DEFAULT_ENCODING</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_SYSTEM_STORE_LOCAL_MACHINE</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_READONLY_FLAG</span><span class="p">,</span> <span class="n">store_name</span><span class="p">)</span>
205208
<span class="k">return</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span></div>
206209

207210

@@ -212,7 +215,9 @@ <h1>Source code for windows.crypto.certificate</h1><div class="highlight"><pre>
212215
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a new :class:`CertificateStore` from system store ``store_name``</span>
213216
<span class="sd"> (see `System Store Locations &lt;https://msdn.microsoft.com/en-us/library/windows/desktop/aa388136(v=vs.85).aspx&gt;`_)</span>
214217
<span class="sd"> &quot;&quot;&quot;</span>
215-
<span class="n">res</span> <span class="o">=</span> <span class="n">winproxy</span><span class="o">.</span><span class="n">CertOpenStore</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_PROV_SYSTEM_A</span><span class="p">,</span> <span class="n">DEFAULT_ENCODING</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_SYSTEM_STORE_CURRENT_USER</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_READONLY_FLAG</span><span class="p">,</span> <span class="n">store_name</span><span class="p">)</span>
218+
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">store_name</span><span class="p">,</span> <span class="n">unicode_type</span><span class="p">):</span>
219+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;store_name should be an unicode string not </span><span class="si">{0}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">store_name</span><span class="p">)))</span>
220+
<span class="n">res</span> <span class="o">=</span> <span class="n">winproxy</span><span class="o">.</span><span class="n">CertOpenStore</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_PROV_SYSTEM_W</span><span class="p">,</span> <span class="n">DEFAULT_ENCODING</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_SYSTEM_STORE_CURRENT_USER</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CERT_STORE_READONLY_FLAG</span><span class="p">,</span> <span class="n">store_name</span><span class="p">)</span>
216221
<span class="k">return</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span></div>
217222

218223

@@ -519,6 +524,22 @@ <h1>Source code for windows.crypto.certificate</h1><div class="highlight"><pre>
519524
<span class="k">return</span> <span class="nb">bytearray</span><span class="p">(</span><span class="n">buf</span><span class="p">)</span></div>
520525

521526

527+
<div class="viewcode-block" id="Certificate.get_private_key">
528+
<a class="viewcode-back" href="../../../crypto.html#windows.crypto.Certificate.get_private_key">[docs]</a>
529+
<span class="k">def</span> <span class="nf">get_private_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flags</span><span class="p">):</span>
530+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Tmp API: return value will change&quot;&quot;&quot;</span>
531+
<span class="n">keyhandle</span> <span class="o">=</span> <span class="n">gdef</span><span class="o">.</span><span class="n">HCRYPTPROV_OR_NCRYPT_KEY_HANDLE</span><span class="p">()</span>
532+
<span class="n">keyspec</span> <span class="o">=</span> <span class="n">gdef</span><span class="o">.</span><span class="n">DWORD</span><span class="p">()</span>
533+
<span class="n">must_free_handle</span> <span class="o">=</span> <span class="n">gdef</span><span class="o">.</span><span class="n">BOOL</span><span class="p">()</span>
534+
<span class="n">windows</span><span class="o">.</span><span class="n">winproxy</span><span class="o">.</span><span class="n">CryptAcquireCertificatePrivateKey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">keyhandle</span><span class="p">,</span> <span class="n">keyspec</span><span class="p">,</span> <span class="n">must_free_handle</span><span class="p">)</span>
535+
<span class="k">return</span> <span class="p">(</span><span class="n">keyhandle</span><span class="p">,</span> <span class="n">keyspec</span><span class="p">,</span> <span class="n">must_free_handle</span><span class="p">)</span></div>
536+
537+
538+
<span class="nd">@property</span>
539+
<span class="k">def</span> <span class="nf">private_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
540+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Tmp API: return value will change&quot;&quot;&quot;</span>
541+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_private_key</span><span class="p">(</span><span class="n">flags</span><span class="o">=</span><span class="n">gdef</span><span class="o">.</span><span class="n">CRYPT_ACQUIRE_COMPARE_KEY_FLAG</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CRYPT_ACQUIRE_ALLOW_NCRYPT_KEY_FLAG</span> <span class="o">|</span> <span class="n">gdef</span><span class="o">.</span><span class="n">CRYPT_ACQUIRE_USE_PROV_INFO_FLAG</span><span class="p">)</span>
542+
522543

523544
<span class="nd">@property</span>
524545
<span class="k">def</span> <span class="nf">encoded</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -708,7 +729,7 @@ <h3>Navigation</h3>
708729
<li class="right" >
709730
<a href="../../../py-modindex.html" title="Python Module Index"
710731
>modules</a> |</li>
711-
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.3 documentation</a> &#187;</li>
732+
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
712733
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
713734
<li class="nav-item nav-item-this"><a href="">windows.crypto.certificate</a></li>
714735
</ul>

docs/build/html/_modules/windows/crypto/cryptmsg.html

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>windows.crypto.cryptmsg &#8212; PythonForWindows 1.0.2 documentation</title>
7+
<title>windows.crypto.cryptmsg &#8212; PythonForWindows 1.0.4 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../../../_static/classic.css?v=def86cc0" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/mbasic.css?v=957880af" />
1111

12-
<script src="../../../_static/documentation_options.js?v=1ed6394b"></script>
12+
<script src="../../../_static/documentation_options.js?v=71272d9f"></script>
1313
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
1414
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1515

@@ -25,7 +25,7 @@ <h3>Navigation</h3>
2525
<li class="right" >
2626
<a href="../../../py-modindex.html" title="Python Module Index"
2727
>modules</a> |</li>
28-
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.2 documentation</a> &#187;</li>
28+
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
2929
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
3030
<li class="nav-item nav-item-this"><a href="">windows.crypto.cryptmsg</a></li>
3131
</ul>
@@ -156,10 +156,14 @@ <h1>Source code for windows.crypto.cryptmsg</h1><div class="highlight"><pre>
156156
<span class="k">def</span> <span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
157157
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_param</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CMSG_CONTENT_PARAM</span><span class="p">)[:]</span>
158158

159+
<span class="nd">@property</span>
160+
<span class="k">def</span> <span class="nf">bare_content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
161+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_param</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CMSG_BARE_CONTENT_PARAM</span><span class="p">)[:]</span>
162+
159163
<span class="nd">@property</span>
160164
<span class="k">def</span> <span class="nf">content_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
161165
<span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_param</span><span class="p">(</span><span class="n">gdef</span><span class="o">.</span><span class="n">CMSG_INNER_CONTENT_TYPE_PARAM</span><span class="p">)</span>
162-
<span class="k">assert</span> <span class="n">data</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;</span><span class="se">\x00</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;CMSG_INNER_CONTENT_TYPE_PARAM not NULL TERMINATED&quot;</span>
166+
<span class="k">assert</span> <span class="n">data</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">&quot;</span><span class="se">\x00</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;CMSG_INNER_CONTENT_TYPE_PARAM not NULL TERMINATED&quot;</span>
163167
<span class="k">return</span> <span class="n">data</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
164168

165169

@@ -216,7 +220,7 @@ <h3>Navigation</h3>
216220
<li class="right" >
217221
<a href="../../../py-modindex.html" title="Python Module Index"
218222
>modules</a> |</li>
219-
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.2 documentation</a> &#187;</li>
223+
<li class="nav-item nav-item-0"><a href="../../../index.html">PythonForWindows 1.0.4 documentation</a> &#187;</li>
220224
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
221225
<li class="nav-item nav-item-this"><a href="">windows.crypto.cryptmsg</a></li>
222226
</ul>

0 commit comments

Comments
 (0)