[go: up one dir, main page]
Menu ▾ ▴

[19eff1]: / docs / ClamInfo.html  Maximize  Restore  History

Download this file

398 lines (295 with data), 22.2 kB 

  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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
<!DOCTYPE html>

<html>



        <head>

            <meta charset="utf-8" />

            <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />

            <title>ClammingPy doc</title>

            <link rel="logo icon" href="./statics/clamming32x32.ico" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/wexa.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/layout.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/book.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/menu.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/code.css" type="text/css" />

            <link rel="stylesheet" href="./statics/clamming.css" type="text/css" />



            <script src="./Whakerexa-1.0/wexa_statics/js/wexa.js" type="module"></script>

            <script src="./Whakerexa-1.0/wexa_statics/js/whakerpy/request.js" type="text/javascript"></script>

            <script src="./Whakerexa-1.0/wexa_statics/js/book.js" type="application/javascript"></script>

            <script type="module">

                window.Wexa.OnLoadManager.addLoadFunction(() => {

                    let book = new Book("main-content");

                    book.fill_table(false);

                });

            </script>

       </head>

       

       <body class="light">

        <header>



            <a role="button" class="skip" href="#main-content" aria-label="Go to main content">

                Go to main content

            </a>

            <nav>

                <ul>

                    <li>

                        <button role="menuitem" class="print-off" onclick="AccessibilityManager.switch_contrast_scheme()" aria-label="Change contrast">

                            <img class="nav-item-img" src="./Whakerexa-1.0/wexa_statics/icons/contrast_switcher.jpg" alt="Contrast" id="img-contrast"/>

                        </button>

                    </li>

                    <li>

                        <button class="print-off" role="menuitem" onclick="AccessibilityManager.switch_color_scheme()" aria-label="Change theme color" >

                            <img class="nav-item-img" src="./Whakerexa-1.0/wexa_statics/icons/theme_switcher.png" alt="Theme" id="img-theme"/>

                        </button>

                    </li>

                </ul>

            </nav>

        

    <h1>ClammingPy 2.0</h1>

        <p><img class="small-logo" src="./statics/clamming.png" alt="Software logo"/></p>

        <p><a class="external-link" href="https://sourceforge.net/projects/clamming/">https://sourceforge.net/projects/clamming/</a></p>

    </header>

    <nav id="nav-book" class="side-nav">

    <h1>ClammingPy 2.0</h1>

    <img class="small-logo center" src="./statics/clamming.png" alt=""/>

        <p><a class="external-link" href="https://sourceforge.net/projects/clamming/">https://sourceforge.net/projects/clamming/</a></p>

    <ul>

<li><a role="button" tabindex="0" aria-disabled="true"> &crarr; Prev. Module</a></li>

<li><a role="button" tabindex="0" href="ClamUtils.html"> &uarr; Prev. Class</a></li>

<li><a role="button" tabindex="0" href="index.html"> &#8962; Index</a></li>

<li><a role="button" tabindex="0" href="ClamInfoMarkdown.html"> &darr; Next Class</a></li>

<li><a role="button" tabindex="0" href="tests.html"> &rdsh; Next Module</a></li>

    </ul>

    <h2>Table of Contents</h2>

    <ul id="toc"></ul>

    <hr>

    <p><small>Automatically created</small></p><p><small>by <a class="external-link" href="https://clamming.sf.net">ClammingPy</a></small></p>

</nav>

    <main id="main-content">

    <section id="#clamming">    <h1>Module clamming</h1>

<section id="#ClamInfo">

<h2>Class ClamInfo</h2>



<section>

<h3 id="#description_ClamInfo">Description</h3>

    <article class="docstring">

<p><em>The information extracted for a function in the documented class.</em></p>



<p>Public members are:</p>



<ul>

<li>name (str): required, the name of the function</li>

<li>args (list of str): optional, the arguments of the function</li>

<li>source (str): optional, the source code of the function, including its definition</li>

<li>docstring (str or None): optional, the docstring of the function</li>

</ul>



<h5>Example</h5>



<div class="highlight"><pre><span></span><code> <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span> <span class="o">=</span> <span class="n">ClamInfo</span><span class="p">(</span><span class="s2">&quot;add&quot;</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="nb">tuple</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;b&quot;</span><span class="p">),</span> <span class="n">source</span><span class="o">=</span><span class="s2">&quot;def add(a, b): return a+b&quot;</span><span class="p">,</span> <span class="n">docstring</span><span class="o">=</span><span class="s2">&quot;Add two args.&quot;</span><span class="p">)</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span><span class="o">.</span><span class="n">name</span>

 <span class="o">&gt;</span> <span class="n">add</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span><span class="o">.</span><span class="n">args</span>

 <span class="o">&gt;</span> <span class="p">[</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;b&quot;</span><span class="p">]</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span><span class="o">.</span><span class="n">source</span>

 <span class="o">&gt;</span> <span class="s2">&quot;def add(a, b): return a+b&quot;</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span><span class="o">.</span><span class="n">docstring</span>

 <span class="o">&gt;</span> <span class="s2">&quot;Add two args.&quot;</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span> <span class="o">=</span> <span class="n">ClamInfo</span><span class="p">(</span><span class="s2">&quot;add&quot;</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="nb">tuple</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;b&quot;</span><span class="p">),</span> <span class="n">source</span><span class="o">=</span><span class="s2">&quot;def add(a, b): return a+b&quot;</span><span class="p">)</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">clam_info</span><span class="o">.</span><span class="n">docstring</span>

 <span class="o">&gt;</span> <span class="kc">None</span>

</code></pre></div>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: if a given argument is not of the expected type.</li>

</ul>



    </article>

</section>

<section>

<h3 id="#constructor_ClamInfo">Constructor</h3>

    <article class="docstring">

<p><em>Create a data class for a documented function.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>name</strong>: (<em>str</em>) Name of the documented function</li>

<li><strong>args</strong>: (<em>list</em>|<em>tuple</em>) List of its arguments</li>

<li><strong>source</strong>: (<em>str</em>) Source code of the function</li>

<li><strong>docstring</strong>: (<em>str</em>) Docstring of the function</li>

</ul>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: Wrong type of one of the given parameters</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span><span class="o">=</span><span class="p">(),</span> <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Create a data class for a documented function.</span>



<span class="sd">    :param name: (str) Name of the documented function</span>

<span class="sd">    :param args: (list|tuple) List of its arguments</span>

<span class="sd">    :param source: (str) Source code of the function</span>

<span class="sd">    :param docstring: (str) Docstring of the function</span>

<span class="sd">    :raises: TypeError: Wrong type of one of the given parameters</span>



<span class="sd">    &quot;&quot;&quot;</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__args</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__source</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__docstring</span> <span class="o">=</span> <span class="kc">None</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">set_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">set_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">set_source</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">set_docstring</span><span class="p">(</span><span class="n">docstring</span><span class="p">)</span>

</code></pre></div>



    </details>





</section>

<section>

<h3 id="#public_fct_ClamInfo">Public functions</h3>

<h4>get_name</h4>



    <article class="docstring">

<p><em>Return the name of the stored class.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the name of the stored class.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__name</span>

</code></pre></div>



    </details>





<h4>set_name</h4>



    <article class="docstring">

<p><em>Set a new name.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>name</strong>: (<em>str</em>) New name of the documented function/class/...</li>

</ul>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: given class_name is not a string</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">set_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">NoReturn</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set a new name.</span>



<span class="sd">        :param name: (str) New name of the documented function/class/...</span>

<span class="sd">        :raises: TypeError: given class_name is not a string</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">))</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Expected a &#39;str&#39; for the ClamInfo.name, got </span><span class="si">{:s}</span><span class="s2"> instead.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">name</span><span class="p">))))</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__name</span> <span class="o">=</span> <span class="n">name</span>

</code></pre></div>



    </details>





<h4>get_args</h4>



    <article class="docstring">

<p><em>Return a copy of the list of arguments.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_args</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return a copy of the list of arguments.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="p">[</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__args</span><span class="p">]</span>

</code></pre></div>



    </details>





<h4>set_args</h4>



    <article class="docstring">

<p><em>Set the list of args.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>args</strong>: (<em>list</em>|<em>tuple</em>) Source code</li>

</ul>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: The given args is not a list or tuple</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">set_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">NoReturn</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set the list of args.</span>



<span class="sd">        :param args: (list|tuple) Source code</span>

<span class="sd">        :raises: TypeError: The given args is not a list or tuple</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">))</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Expected a &#39;list&#39; or &#39;tuple&#39; for the ClamInfo.args. Got </span><span class="si">{:s}</span><span class="s2"> instead.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">args</span><span class="p">))))</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__args</span> <span class="o">=</span> <span class="n">args</span>

</code></pre></div>



    </details>





<h4>get_source</h4>



    <article class="docstring">

<p><em>Return the source code.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_source</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the source code.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__source</span>

</code></pre></div>



    </details>





<h4>set_source</h4>



    <article class="docstring">

<p><em>Set a new source code.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>source</strong>: (<em>str</em>) Source code</li>

</ul>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: The given source code is not a string</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">set_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">NoReturn</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set a new source code.</span>



<span class="sd">        :param source: (str) Source code</span>

<span class="sd">        :raises: TypeError: The given source code is not a string</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Expected a &#39;str&#39; for the ClamInfo.source, got </span><span class="si">{:s}</span><span class="s2"> instead.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">source</span><span class="p">))))</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__source</span> <span class="o">=</span> <span class="n">source</span>

</code></pre></div>



    </details>





<h4>get_docstring</h4>



    <article class="docstring">

<p><em>Return the docstring of the class.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_docstring</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the docstring of the class.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__docstring</span>

</code></pre></div>



    </details>





<h4>set_docstring</h4>



    <article class="docstring">

<p><em>Set a new docstring to the class.</em></p>

<h5>Parameters</h5>



<ul>

<li><strong>docstring</strong></li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">set_docstring</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">NoReturn</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set a new docstring to the class.&quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="n">docstring</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">docstring</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

            <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Expected a &#39;str&#39; for the ClamInfo.docstring. Got </span><span class="si">{:s}</span><span class="s2"> instead.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">docstring</span><span class="p">))))</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__docstring</span> <span class="o">=</span> <span class="n">docstring</span>

</code></pre></div>



    </details>





</section>

</section>    </section>    </main>

    

            <footer>

                <p class="copyright">Copyright (C) 2023-2025 Brigitte Bigi, CNRS, Laboratoire Parole et Langage, Aix-en-Provence, France</p>

            </footer>

        

</body>

</html>