Commit 50af407d43d0ccd1d0cf8eb7c67219d391c4b537
1 parent
97a4003f
Exists in
dev
new my_package1.my_module1
Showing
1 changed file
with
200 additions
and
3 deletions
Show diff stats
doc/code_style/my_package1/html/my_package1.my_module1.html
@@ -178,7 +178,7 @@ | @@ -178,7 +178,7 @@ | ||
178 | <dt class="field-odd">Parameters</dt> | 178 | <dt class="field-odd">Parameters</dt> |
179 | <dd class="field-odd"><ul class="simple"> | 179 | <dd class="field-odd"><ul class="simple"> |
180 | <li><p><strong>arg_a</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – the path of the file to wrap</p></li> | 180 | <li><p><strong>arg_a</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – the path of the file to wrap</p></li> |
181 | -<li><p><strong>arg_b</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – instance to wrap</p></li> | 181 | +<li><p><strong>arg_b</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – instance to wrap (in Python 3.10 we will be able to use ‘str | int | float’ instead)</p></li> |
182 | <li><p><strong>arg_c</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – toto</p></li> | 182 | <li><p><strong>arg_c</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – toto</p></li> |
183 | <li><p><strong>arg_d</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not to delete the file when the File instance is destructed</p></li> | 183 | <li><p><strong>arg_d</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not to delete the file when the File instance is destructed</p></li> |
184 | </ul> | 184 | </ul> |
@@ -212,11 +212,207 @@ | @@ -212,11 +212,207 @@ | ||
212 | </ul> | 212 | </ul> |
213 | </dd> | 213 | </dd> |
214 | <dt class="field-even">Return type</dt> | 214 | <dt class="field-even">Return type</dt> |
215 | -<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p> | 215 | +<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p> |
216 | </dd> | 216 | </dd> |
217 | </dl> | 217 | </dl> |
218 | </dd></dl> | 218 | </dd></dl> |
219 | 219 | ||
220 | +<dl class="py function"> | ||
221 | +<dt class="sig sig-object py" id="my_package1.my_module1.square"> | ||
222 | +<span class="sig-name descname"><span class="pre">square</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elems</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#square"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.square" title="Permalink to this definition">¶</a></dt> | ||
223 | +<dd><p>function that takes a Sequence (either List of Tuple) as input, and send a List as output</p> | ||
224 | +<p>Usage:</p> | ||
225 | +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">square</span><span class="p">(</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]</span> <span class="p">)</span> | ||
226 | +<span class="go">[1, 4, 9]</span> | ||
227 | +<span class="gp">>>> </span><span class="n">square</span><span class="p">(</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">)</span> <span class="p">)</span> | ||
228 | +<span class="go">[1, 4, 9]</span> | ||
229 | +</pre></div> | ||
230 | +</div> | ||
231 | +<dl class="field-list simple"> | ||
232 | +<dt class="field-odd">Return type</dt> | ||
233 | +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]</p> | ||
234 | +</dd> | ||
235 | +<dt class="field-even">Parameters</dt> | ||
236 | +<dd class="field-even"><p><strong>elems</strong> (<em>Sequence</em><em>[</em><em>float</em><em>]</em>) – </p> | ||
237 | +</dd> | ||
238 | +</dl> | ||
239 | +</dd></dl> | ||
240 | + | ||
241 | +<dl class="py function"> | ||
242 | +<dt class="sig sig-object py" id="my_package1.my_module1.create_deck_without_alias"> | ||
243 | +<span class="sig-name descname"><span class="pre">create_deck_without_alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shuffle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#create_deck_without_alias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.create_deck_without_alias" title="Permalink to this definition">¶</a></dt> | ||
244 | +<dd><p>Create a new deck of 52 cards</p> | ||
245 | +<dl class="field-list simple"> | ||
246 | +<dt class="field-odd">Return type</dt> | ||
247 | +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]</p> | ||
248 | +</dd> | ||
249 | +<dt class="field-even">Parameters</dt> | ||
250 | +<dd class="field-even"><p><strong>shuffle</strong> (<em>bool</em>) – </p> | ||
251 | +</dd> | ||
252 | +</dl> | ||
253 | +</dd></dl> | ||
254 | + | ||
255 | +<dl class="py function"> | ||
256 | +<dt class="sig sig-object py" id="my_package1.my_module1.create_deck_with_alias"> | ||
257 | +<span class="sig-name descname"><span class="pre">create_deck_with_alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shuffle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#create_deck_with_alias"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.create_deck_with_alias" title="Permalink to this definition">¶</a></dt> | ||
258 | +<dd><p>Create a new deck of 52 cards</p> | ||
259 | +<p>Card = Tuple[str, str]</p> | ||
260 | +<p>Deck = List[Card]</p> | ||
261 | +<p>Return Deck</p> | ||
262 | +<dl class="field-list simple"> | ||
263 | +<dt class="field-odd">Return type</dt> | ||
264 | +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]</p> | ||
265 | +</dd> | ||
266 | +<dt class="field-even">Parameters</dt> | ||
267 | +<dd class="field-even"><p><strong>shuffle</strong> (<em>bool</em>) – </p> | ||
268 | +</dd> | ||
269 | +</dl> | ||
270 | +</dd></dl> | ||
271 | + | ||
272 | +<dl class="py function"> | ||
273 | +<dt class="sig sig-object py" id="my_package1.my_module1.choose_from_list_of_Any_returns_a_Any"> | ||
274 | +<span class="sig-name descname"><span class="pre">choose_from_list_of_Any_returns_a_Any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#choose_from_list_of_Any_returns_a_Any"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.choose_from_list_of_Any_returns_a_Any" title="Permalink to this definition">¶</a></dt> | ||
275 | +<dd><p>Option1 (BAD) : avoid using ‘Any’ because too general</p> | ||
276 | +<dl class="field-list simple"> | ||
277 | +<dt class="field-odd">Return type</dt> | ||
278 | +<dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></p> | ||
279 | +</dd> | ||
280 | +<dt class="field-even">Parameters</dt> | ||
281 | +<dd class="field-even"><p><strong>items</strong> (<em>Sequence</em><em>[</em><em>Any</em><em>]</em>) – </p> | ||
282 | +</dd> | ||
283 | +</dl> | ||
284 | +</dd></dl> | ||
285 | + | ||
286 | +<dl class="py function"> | ||
287 | +<dt class="sig sig-object py" id="my_package1.my_module1.choose_from_list_of_a_specific_type_returns_same_type"> | ||
288 | +<span class="sig-name descname"><span class="pre">choose_from_list_of_a_specific_type_returns_same_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#choose_from_list_of_a_specific_type_returns_same_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.choose_from_list_of_a_specific_type_returns_same_type" title="Permalink to this definition">¶</a></dt> | ||
289 | +<dd><p>Option2 (BETTER) : prefer ‘TypeVar’ instead of ‘Any’</p> | ||
290 | +<p>T = TypeVar(“T”)</p> | ||
291 | +<dl class="field-list simple"> | ||
292 | +<dt class="field-odd">Return type</dt> | ||
293 | +<dd class="field-odd"><p>~T</p> | ||
294 | +</dd> | ||
295 | +<dt class="field-even">Parameters</dt> | ||
296 | +<dd class="field-even"><p><strong>items</strong> (<em>Sequence</em><em>[</em><em>my_package1.my_module1.T</em><em>]</em>) – </p> | ||
297 | +</dd> | ||
298 | +</dl> | ||
299 | +</dd></dl> | ||
300 | + | ||
301 | +<dl class="py function"> | ||
302 | +<dt class="sig sig-object py" id="my_package1.my_module1.choose_from_list_of_a_specific_constrained_type_returns_same_type"> | ||
303 | +<span class="sig-name descname"><span class="pre">choose_from_list_of_a_specific_constrained_type_returns_same_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#choose_from_list_of_a_specific_constrained_type_returns_same_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.choose_from_list_of_a_specific_constrained_type_returns_same_type" title="Permalink to this definition">¶</a></dt> | ||
304 | +<dd><p>Option3 (still BETTER) : use a ‘constrained TypeVar’</p> | ||
305 | +<p>T = TypeVar(“T”, str, float)</p> | ||
306 | +<p>(you could name ‘T’ as you want, for example, ‘Choosable’…)</p> | ||
307 | +<p>=> the function accepts only sequence of str or float:</p> | ||
308 | +<ul class="simple"> | ||
309 | +<li><p>if str: return str</p></li> | ||
310 | +<li><p>if float: return float</p></li> | ||
311 | +</ul> | ||
312 | +<p>Usage:</p> | ||
313 | +<p>choose([“Guido”, “Jukka”, “Ivan”]) => str, OK</p> | ||
314 | +<p>choose([1, 2, 3]) => float, OK (car int subtype of float)</p> | ||
315 | +<p>choose([True, 42, 3.14]) => float, OK (car bool subtype of int which is subtype of float)</p> | ||
316 | +<p>choose([“Python”, 3, 7]) => object, KO (rejected)</p> | ||
317 | +<dl class="field-list simple"> | ||
318 | +<dt class="field-odd">Return type</dt> | ||
319 | +<dd class="field-odd"><p>~T</p> | ||
320 | +</dd> | ||
321 | +<dt class="field-even">Parameters</dt> | ||
322 | +<dd class="field-even"><p><strong>items</strong> (<em>Sequence</em><em>[</em><em>my_package1.my_module1.T</em><em>]</em>) – </p> | ||
323 | +</dd> | ||
324 | +</dl> | ||
325 | +</dd></dl> | ||
326 | + | ||
327 | +<dl class="py function"> | ||
328 | +<dt class="sig sig-object py" id="my_package1.my_module1.create_greeting"> | ||
329 | +<span class="sig-name descname"><span class="pre">create_greeting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">congrat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nb</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#create_greeting"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.create_greeting" title="Permalink to this definition">¶</a></dt> | ||
330 | +<dd><dl class="field-list simple"> | ||
331 | +<dt class="field-odd">Return type</dt> | ||
332 | +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> | ||
333 | +</dd> | ||
334 | +<dt class="field-even">Parameters</dt> | ||
335 | +<dd class="field-even"><ul class="simple"> | ||
336 | +<li><p><strong>congrat</strong> (<em>str</em>) – </p></li> | ||
337 | +<li><p><strong>name</strong> (<em>str</em>) – </p></li> | ||
338 | +<li><p><strong>nb</strong> (<em>int</em>) – </p></li> | ||
339 | +</ul> | ||
340 | +</dd> | ||
341 | +</dl> | ||
342 | +</dd></dl> | ||
343 | + | ||
344 | +<dl class="py function"> | ||
345 | +<dt class="sig sig-object py" id="my_package1.my_module1.do_twice"> | ||
346 | +<span class="sig-name descname"><span class="pre">do_twice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg3</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#do_twice"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.do_twice" title="Permalink to this definition">¶</a></dt> | ||
347 | +<dd><p>Usage:</p> | ||
348 | +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">do_twice</span><span class="p">(</span><span class="n">create_greeting</span><span class="p">,</span> <span class="s2">"Hello"</span><span class="p">,</span> <span class="s2">"Jekyll"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> | ||
349 | +<span class="go">Hello Jekyll 1</span> | ||
350 | +<span class="go">Hello Jekyll 1</span> | ||
351 | +</pre></div> | ||
352 | +</div> | ||
353 | +<dl class="field-list simple"> | ||
354 | +<dt class="field-odd">Return type</dt> | ||
355 | +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> | ||
356 | +</dd> | ||
357 | +<dt class="field-even">Parameters</dt> | ||
358 | +<dd class="field-even"><ul class="simple"> | ||
359 | +<li><p><strong>func</strong> (<em>Callable</em><em>[</em><em>[</em><em>str</em><em>, </em><em>str</em><em>, </em><em>int</em><em>]</em><em>, </em><em>str</em><em>]</em>) – </p></li> | ||
360 | +<li><p><strong>arg1</strong> (<em>str</em>) – </p></li> | ||
361 | +<li><p><strong>arg2</strong> (<em>str</em>) – </p></li> | ||
362 | +<li><p><strong>arg3</strong> (<em>int</em>) – </p></li> | ||
363 | +</ul> | ||
364 | +</dd> | ||
365 | +</dl> | ||
366 | +</dd></dl> | ||
367 | + | ||
368 | +<dl class="py exception"> | ||
369 | +<dt class="sig sig-object py" id="my_package1.my_module1.DCCNotFoundException"> | ||
370 | +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DCCNotFoundException</span></span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#DCCNotFoundException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.DCCNotFoundException" title="Permalink to this definition">¶</a></dt> | ||
371 | +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> | ||
372 | +<p>Raised when a specific DCC is not available</p> | ||
373 | +</dd></dl> | ||
374 | + | ||
375 | +<dl class="py exception"> | ||
376 | +<dt class="sig sig-object py" id="my_package1.my_module1.UnknownGenericCmdArgException"> | ||
377 | +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UnknownGenericCmdArgException</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#UnknownGenericCmdArgException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.UnknownGenericCmdArgException" title="Permalink to this definition">¶</a></dt> | ||
378 | +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> | ||
379 | +<p>Raised when a GENERIC cmd argument is not recognized by the controller (no native cmd available for the generic cmd)</p> | ||
380 | +<dl class="field-list simple"> | ||
381 | +<dt class="field-odd">Parameters</dt> | ||
382 | +<dd class="field-odd"><ul class="simple"> | ||
383 | +<li><p><strong>name</strong> (<em>str</em>) – </p></li> | ||
384 | +<li><p><strong>arg</strong> (<em>str</em>) – </p></li> | ||
385 | +</ul> | ||
386 | +</dd> | ||
387 | +</dl> | ||
388 | +<dl class="py method"> | ||
389 | +<dt class="sig sig-object py" id="my_package1.my_module1.UnknownGenericCmdArgException.__str__"> | ||
390 | +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#UnknownGenericCmdArgException.__str__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.UnknownGenericCmdArgException.__str__" title="Permalink to this definition">¶</a></dt> | ||
391 | +<dd><p>Return str(self).</p> | ||
392 | +</dd></dl> | ||
393 | + | ||
394 | +</dd></dl> | ||
395 | + | ||
396 | +<dl class="py exception"> | ||
397 | +<dt class="sig sig-object py" id="my_package1.my_module1.UnknownNativeCmdException"> | ||
398 | +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UnknownNativeCmdException</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#UnknownNativeCmdException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.UnknownNativeCmdException" title="Permalink to this definition">¶</a></dt> | ||
399 | +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> | ||
400 | +<p>Raised when a NATIVE command name is not recognized by the controller</p> | ||
401 | +</dd></dl> | ||
402 | + | ||
403 | +<dl class="py exception"> | ||
404 | +<dt class="sig sig-object py" id="my_package1.my_module1.UnimplementedGenericCmdException"> | ||
405 | +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UnimplementedGenericCmdException</span></span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#UnimplementedGenericCmdException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.UnimplementedGenericCmdException" title="Permalink to this definition">¶</a></dt> | ||
406 | +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> | ||
407 | +<p>Raised when a GENERIC cmd has no implementation in the controller (no native cmd available for the generic cmd)</p> | ||
408 | +<dl class="py method"> | ||
409 | +<dt class="sig sig-object py" id="my_package1.my_module1.UnimplementedGenericCmdException.__str__"> | ||
410 | +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#UnimplementedGenericCmdException.__str__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.UnimplementedGenericCmdException.__str__" title="Permalink to this definition">¶</a></dt> | ||
411 | +<dd><p>Return str(self).</p> | ||
412 | +</dd></dl> | ||
413 | + | ||
414 | +</dd></dl> | ||
415 | + | ||
220 | <dl class="py class"> | 416 | <dl class="py class"> |
221 | <dt class="sig sig-object py" id="my_package1.my_module1.MySuperClass1"> | 417 | <dt class="sig sig-object py" id="my_package1.my_module1.MySuperClass1"> |
222 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MySuperClass1</span></span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#MySuperClass1"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.MySuperClass1" title="Permalink to this definition">¶</a></dt> | 418 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MySuperClass1</span></span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#MySuperClass1"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.MySuperClass1" title="Permalink to this definition">¶</a></dt> |
@@ -362,7 +558,8 @@ | @@ -362,7 +558,8 @@ | ||
362 | <dl class="py method"> | 558 | <dl class="py method"> |
363 | <dt class="sig sig-object py" id="my_package1.my_module1.Person.fromBirthYear"> | 559 | <dt class="sig sig-object py" id="my_package1.my_module1.Person.fromBirthYear"> |
364 | <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fromBirthYear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#Person.fromBirthYear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.Person.fromBirthYear" title="Permalink to this definition">¶</a></dt> | 560 | <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fromBirthYear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="file:///Users/epallier/_PROJ/_W/GFT/SOFT/PROJ_PYROS/PYROS_DOCK_Django3/doc/sourcecode/build/html/_modules/my_package1/my_module1.html#Person.fromBirthYear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#my_package1.my_module1.Person.fromBirthYear" title="Permalink to this definition">¶</a></dt> |
365 | -<dd><dl class="field-list simple"> | 561 | +<dd><p>NB : return type ‘Person’ is possible because of: ‘from __future__ import annotations’</p> |
562 | +<dl class="field-list simple"> | ||
366 | <dt class="field-odd">Return type</dt> | 563 | <dt class="field-odd">Return type</dt> |
367 | <dd class="field-odd"><p><a class="reference internal" href="#my_package1.my_module1.Person" title="my_package1.my_module1.Person"><code class="xref py py-class docutils literal notranslate"><span class="pre">Person</span></code></a></p> | 564 | <dd class="field-odd"><p><a class="reference internal" href="#my_package1.my_module1.Person" title="my_package1.my_module1.Person"><code class="xref py py-class docutils literal notranslate"><span class="pre">Person</span></code></a></p> |
368 | </dd> | 565 | </dd> |