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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>pybind_signatures.MyClass | 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>
</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="pybind_signatures.html">pybind_signatures</a>.<wbr/></span>MyClass <span class="m-thin">class</span>
</h1>
<p>My fun class!</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#staticmethods">Static methods</a></li>
<li><a href="#methods">Methods</a></li>
<li><a href="#dunder-methods">Special methods</a></li>
<li><a href="#properties">Properties</a></li>
</ul>
</li>
</ul>
</nav>
<section id="staticmethods">
<h2><a href="#staticmethods">Static methods</a></h2>
<dl class="m-doc">
<dt id="static_function">
<span class="m-doc-wrap-bumper">def <a href="#static_function" class="m-doc-self">static_function</a>(</span><span class="m-doc-wrap">arg0: int,
arg1: float<span class="m-text m-dim">, /</span>) -> <a href="pybind_signatures.MyClass.html" class="m-doc">MyClass</a></span>
</dt>
<dd>Static method with positional-only args</dd>
</dl>
</section>
<section id="methods">
<h2><a href="#methods">Methods</a></h2>
<dl class="m-doc">
<dt id="another">
<span class="m-doc-wrap-bumper">def <a href="#another" class="m-doc-self">another</a>(</span><span class="m-doc-wrap">self<span class="m-text m-dim">, /</span>) -> int</span>
</dt>
<dd>Instance method with no args, 'self' is thus position-only</dd>
<dt id="instance_function">
<span class="m-doc-wrap-bumper">def <a href="#instance_function" class="m-doc-self">instance_function</a>(</span><span class="m-doc-wrap">self,
arg0: int,
arg1: str<span class="m-text m-dim">, /</span>) -> typing.Tuple[float, int]</span>
</dt>
<dd>Instance method with positional-only args</dd>
<dt id="instance_function_kwargs">
<span class="m-doc-wrap-bumper">def <a href="#instance_function_kwargs" class="m-doc-self">instance_function_kwargs</a>(</span><span class="m-doc-wrap">self,
hey: int,
what: str = '<eh?>') -> typing.Tuple[float, int]</span>
</dt>
<dd>Instance method with position or keyword args</dd>
</dl>
</section>
<section id="dunder-methods">
<h2><a href="#dunder-methods">Special methods</a></h2>
<dl class="m-doc">
<dt id="__init__">
<span class="m-doc-wrap-bumper">def <a href="#__init__" class="m-doc-self">__init__</a>(</span><span class="m-doc-wrap">self<span class="m-text m-dim">, /</span>) -> None</span>
</dt>
<dd>Constructor</dd>
</dl>
</section>
<section id="properties">
<h2><a href="#properties">Properties</a></h2>
<dl class="m-doc">
<dt id="bar">
<a href="#bar" class="m-doc-self">bar</a>: float <span class="m-label m-flat m-warning">get</span>
</dt>
<dd>A read-only property</dd>
<dt id="foo">
<a href="#foo" class="m-doc-self">foo</a>: float <span class="m-label m-flat m-success">get set</span>
</dt>
<dd>A read/write property</dd>
</dl>
</section>
</div>
</div>
</div>
</article></main>
</body>
</html>
|
