1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>inspect_string.Foo | My Python Project</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-12 m-col-m-none">
<li><a href="modules.html">Modules</a></li>
<li><a href="classes.html">Classes</a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="inspect_string.html">inspect_string</a>.<wbr/></span>Foo <span class="m-thin">class</span>
</h1>
<p>The foo class</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#classes">Classes</a></li>
<li><a href="#enums">Enums</a></li>
<li><a href="#classmethods">Class methods</a></li>
<li><a href="#staticmethods">Static methods</a></li>
<li><a href="#methods">Methods</a></li>
<li><a href="#properties">Properties</a></li>
<li><a href="#data">Data</a></li>
</ul>
</li>
</ul>
</nav>
<section id="classes">
<h2><a href="#classes">Classes</a></h2>
<dl class="m-doc">
<dt>class <a href="inspect_string.Foo.Subclass.html" class="m-doc">Subclass</a></dt>
<dd>A subclass of Foo</dd>
</dl>
</section>
<section id="enums">
<h2><a href="#enums">Enums</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">class <a href="#InnerEnum" class="m-doc">InnerEnum</a>(enum.Enum): </span><span class="m-doc-wrap"><a href="#InnerEnum-VALUE" class="m-doc">VALUE</a> = 0
<a href="#InnerEnum-ANOTHER" class="m-doc">ANOTHER</a> = 1
<a href="#InnerEnum-YAY" class="m-doc">YAY</a> = 2</span>
</dt>
<dd>Inner enum</dd>
<dt id="UndocumentedInnerEnum">
<span class="m-doc-wrap-bumper">class <a href="#UndocumentedInnerEnum" class="m-doc-self">UndocumentedInnerEnum</a>(enum.IntFlag): </span><span class="m-doc-wrap"><a href="#UndocumentedInnerEnum-FLAG_ONE" class="m-doc-self" id="UndocumentedInnerEnum-FLAG_ONE">FLAG_ONE</a> = 1
<a href="#UndocumentedInnerEnum-FLAG_SEVENTEEN" class="m-doc-self" id="UndocumentedInnerEnum-FLAG_SEVENTEEN">FLAG_SEVENTEEN</a> = 17</span>
</dt>
<dd></dd>
</dl>
</section>
<section id="classmethods">
<h2><a href="#classmethods">Class methods</a></h2>
<dl class="m-doc">
<dt id="func_on_class">
<span class="m-doc-wrap-bumper">def <a href="#func_on_class" class="m-doc-self">func_on_class</a>(</span><span class="m-doc-wrap">a)</span>
</dt>
<dd>A class method</dd>
</dl>
</section>
<section id="staticmethods">
<h2><a href="#staticmethods">Static methods</a></h2>
<dl class="m-doc">
<dt id="static_func">
<span class="m-doc-wrap-bumper">def <a href="#static_func" class="m-doc-self">static_func</a>(</span><span class="m-doc-wrap">a)</span>
</dt>
<dd>A static method</dd>
</dl>
</section>
<section id="methods">
<h2><a href="#methods">Methods</a></h2>
<dl class="m-doc">
<dt id="func">
<span class="m-doc-wrap-bumper">def <a href="#func" class="m-doc-self">func</a>(</span><span class="m-doc-wrap">self, a, b)</span>
</dt>
<dd>A method</dd>
</dl>
</section>
<section id="properties">
<h2><a href="#properties">Properties</a></h2>
<dl class="m-doc">
<dt id="a_property">
<a href="#a_property" class="m-doc-self">a_property</a> <span class="m-label m-flat m-warning">get</span>
</dt>
<dd>A property</dd>
<dt id="deletable_property">
<a href="#deletable_property" class="m-doc-self">deletable_property</a> <span class="m-label m-flat m-warning">get del</span>
</dt>
<dd>Deletable property</dd>
<dt id="writable_property">
<a href="#writable_property" class="m-doc-self">writable_property</a> <span class="m-label m-flat m-success">get set</span>
</dt>
<dd>Writable property</dd>
<dt id="writeonly_property">
<a href="#writeonly_property" class="m-doc-self">writeonly_property</a> <span class="m-label m-flat m-danger">set</span>
</dt>
<dd>Write-only property</dd>
</dl>
</section>
<section id="data">
<h2><a href="#data">Data</a></h2>
<dl class="m-doc">
<dt id="A_DATA">
<a href="#A_DATA" class="m-doc-self">A_DATA</a> = 'BOO'
</dt>
<dd></dd>
<dt id="DATA_DECLARATION">
<a href="#DATA_DECLARATION" class="m-doc-self">DATA_DECLARATION</a>: int = None
</dt>
<dd></dd>
</dl>
</section>
<section>
<h2>Enum documentation</h2>
<section class="m-doc-details" id="InnerEnum"><div>
<h3>
class inspect_string.<wbr />Foo.<wbr /><a href="#InnerEnum" class="m-doc-self">InnerEnum</a>(enum.Enum)
</h3>
<p>Inner enum</p>
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
<tr>
<td><a href="#InnerEnum-VALUE" id="InnerEnum-VALUE" class="m-doc-self">VALUE</a></td>
<td>
<p>A value</p>
</td>
</tr>
<tr>
<td><a href="#InnerEnum-ANOTHER" id="InnerEnum-ANOTHER" class="m-doc-self">ANOTHER</a></td>
<td>
<p>Another value</p>
</td>
</tr>
<tr>
<td><a href="#InnerEnum-YAY" id="InnerEnum-YAY" class="m-doc-self">YAY</a></td>
<td>
</td>
</tr>
</tbody>
</table>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
</body>
</html>
|
