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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
|
Glossary
########
.. glossary::
Abstract Class
A :wiki:`abstract class <Abstract_type>` is a type, that cannot be instantiated directly. An *abstract* class may
provide no implementation or an incomplete implementation.
In pyTooling such a type is assumed, when a class contains at least one :term:`abstract <Abstract Method>` or
:term:`mustoverride <Mustoverride Method>` method and pyToolings meta-class :ref:`META/ExtendedType` was applied.
If an *abstract* class is instantiated, an exception is raised.
Abstract Method
An *abstract* method provides no implementation (no code) and must therefore be implemented by all derived classes.
If an *abstract* method is called, an exception is raised. Also if, an *abstract* method is not overridden, an
exception is raised when instantiating the class, because the :term:`class is abstract <Abstract Class>`.
Ancestor
*Ancestors* are all direct and indirect predecessors of a :term:`node` (:term:`parent node <parent>` and parent
nodes thereof a.k.a. :term:`grandparents <grandparent>`, grand-grandparent, ..., :term:`root` node).
In a tree, a node has only a single parent per node, thus a list of ancestors is a direct line from current node to
the root node.
.. mermaid::
:caption: Ancestors of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R:::mark1 --> A
A:::mark2 --> BL & B & BR
B:::mark2 --> CL & C & CR
C:::mark2 --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6,font-size:smaller;
classDef mark1 fill:#69f,stroke:#37f,color:#eee,font-size:smaller;
classDef mark2 fill:#69f,stroke:#37f,font-size:smaller;
Base-Class
A *base-class* is an ancestor class for other classes derived therefrom.
.. mermaid::
:caption: Base-class in a class hierarchy.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
B(BaseClass)
C(Class)
I1(Instance);I2(Instance)
B:::mark1 --> C:::mark2 -..-> I1 & I2
classDef node font-size:smaller;
classDef mark1 fill:#69f,stroke:#37f,color:#eee,font-size:smaller;
classDef mark2 fill:#69f,stroke:#37f,font-size:smaller;
Child
*Children* are all direct successors of a :term:`node`.
.. mermaid::
:caption: Children of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
EL:::mark2
E:::mark2
ER:::mark2
DR --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
CLIOption
undocumented
CLIParameter
undocumented
CopyLeft
undocumented
Wikipedia: :wiki:`Copyleft <Copyleft>`
Cygwin
:wiki:`Cygwin <Cygwin>` is a :wiki:`POSIX <POSIX>`-compatible programming and runtime environment for Windows.
DAG
A *directed acyclic graph* (DAG) is a :term:`directed graph <DG>` without backward edges and therefore free of cycles.
.. mermaid::
:caption: A directed acyclic graph.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph LR
A(A); B(B); C(C); D(D); E(E); F(F); G(G); H(H); I(I); J(J); K(K)
A --> B & C & D
B --> E & F
C --> E & G
D --> G & F
E --> H
F --> H & I
G --> I
H --> J & K
I --> K & J
classDef node fill:#eee,stroke:#777,font-size:smaller;
DG
A *directed graph* (DG) is a :term:`graph` where all :term:`edges <edge>` have a direction.
.. mermaid::
:caption: A directed graph with cycles (one cycle is denoted by dotted edges).
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph LR
A(A); B(B); C(C); D(D); E(E); F(F) ; G(G); H(H); I(I)
A -.-> B -.-> E
G --> F
A --> C --> G --> H --> D
D -.-> A
D & F --> B
I ---> E -.-> F -.-> D
classDef node fill:#eee,stroke:#777,font-size:smaller;
Decorator
undocumented
Descendant
*Descendants* are all direct and indirect successors of a :term:`node` (:term:`child nodes <child>` and child
nodes thereof a.k.a. :term:`grandchild`, grand-grandchildren, ...).
.. mermaid::
:caption: Descendants of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
EL:::mark2
E:::mark2
ER:::mark2
DR --> ERN1 & ERN2
E --> F1 & F2
F1:::mark2
F2:::mark2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Edge
An *edge* is a relation from :term:`vertex` to vertex in a :term:`graph`.
Executable
undocumented
Exception
undocumented
Graph
A *graph* is a data structure made of :term:`vertices <vertex>` (nodes) and vertex-vertex relations called
:term:`edges <edge>`.
Special forms of graphs are:
* Graphs with directions: :term:`Directed Graph <DG>`
* Directed Graphs without Cycles: :term:`Directed Acyclic Graph <DAG>`
* Directed Acyclic Graph without Side-Edges: :term:`Tree`
.. mermaid::
:caption: A directed graph with backward-edges denoted by dotted vertex relations.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph LR
A(A); B(B); C(C); D(D); E(E); F(F) ; G(G); H(H); I(I)
A --> B --> E
G --> F
A --> C --> G --> H --> D
D -.-> A
D & F -.-> B
I ---> E --> F --> D
classDef node fill:#eee,stroke:#777,font-size:smaller;
Grandchild
*Grandchildren* are direct successors of a node's :term:`children <child>` and therefore indirect successors of a
:term:`node`.
.. mermaid::
:caption: Grandchildren of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR --> ERN1 & ERN2
E --> F1 & F2
F1:::mark2
F2:::mark2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Grandparent
A *grandparent* is direct predecessor of a node's :term:`parent` and therefore indirect predecessor of a
:term:`node`.
.. mermaid::
:caption: Grandparent of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B:::mark2 --> CL & C & CR
C --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Hardlink
undocumented
Meta-Class
A *meta-class* is a class helping to construct classes. Thus, it's the type of a type.
.. mermaid::
:caption: Relation of meta-classes, classes and instances.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
T(type)
ET(MetaClass)
B(BaseClass)
M(MixIn)
C(Class)
I1(Instance);I2(Instance)
T --> T
T:::mark1 --> ET:::mark1 -.class definition.-> B
B:::mark2 --inheritance--> C:::mark2 -.instantiation..-> I1 & I2
M --inheritance--> C
classDef node font-size:smaller;
classDef mark1 fill:#69f,stroke:#37f,color:#eee,font-size:smaller;
classDef mark2 fill:#69f,stroke:#37f,font-size:smaller;
MinGW
Minimalistic GNU for Windows.
Wikipedia: :wiki:`MinGW <Mingw-w64>`
Mixin-Class
A *mixin classes* are classes used as secondary base-classes in multiple inheritance.
MSYS2
undocumented
Wikipedia: :wiki:`MSYS2 <Mingw-w64#MSYS2>`
Mustoverride Method
A *must-override* method provides a partial implementation (incomplete code) and must therefore be fully
implemented by all derived classes.
If a *must-override* method is not overridden, an exception is raised when instantiating the class, because the
:term:`class is abstract <Abstract Class>`.
native
A *native environment* is a platform just with the operating system. There is no additional environment layer like
MSYS2.
Node
undocumented
Overloading
undocumented
Parent
A *parent* is direct predecessor of a :term:`node`.
.. mermaid::
:caption: Parent of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C:::mark2 --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Post-Order
undocumented
Pre-Order
undocumented
Program
undocumented
PyPI
undocumented
Wikipedia: :wiki:`Python Package Index <Python_Package_Index>`
PyPy
undocumented
Wikipedia: :wiki:`PyPy <PyPy>`
Relative
*Relatives* are :term:`siblings <sibling>` and their :term:`descendants <descendant>`.
Left relatives are left siblings and all their descendants, whereas right relatives are right siblings and all
their descendants.
.. mermaid::
:caption: Relatives of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL:::mark2 --> ELN1 & ELN2
ELN1:::mark2
ELN2:::mark2
D:::cur --> EL & E & ER
DR:::mark2 --> ERN1 & ERN2
ERN1:::mark2
ERN2:::mark2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Root
All :term:`nodes <node>` in a :term:`tree` have one common :term:`ancestor` called *root*.
.. mermaid::
:caption: Root of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R:::mark1 --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark1 fill:#69f,stroke:#37f,color:#eee;
Sibling
*Siblings* are all direct :term:`child nodes <child>` of a node's :term:`parent` node except itself.
.. mermaid::
:caption: Siblings of the current node are marked in blue.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
R(Root)
A(...)
BL(Node); B(GrandParent); BR(Node)
CL(Uncle); C(Parent); CR(Aunt)
DL(Sibling); D(Node); DR(Sibling)
ELN1(Niece); ELN2(Nephew)
EL(Child); E(Child); ER(Child);
ERN1(Niece);ERN2(Nephew)
F1(GrandChild); F2(GrandChild)
R --> A
A --> BL & B & BR
B --> CL & C & CR
C --> DL & D & DR
DL:::mark2 --> ELN1 & ELN2
D:::cur --> EL & E & ER
DR:::mark2 --> ERN1 & ERN2
E --> F1 & F2
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark2 fill:#69f,stroke:#37f;
Singleton
The :wiki:`singleton design pattern <Singleton_pattern>` ensures only a single instance of a class to exist. If
another instance is going to be created, a previously cached instance of that class will be returned.
Slots
undocumented
Softlink
undocumented
Tree
A *tree* is a data structure made of :term:`nodes <node>` and parent-child relations. All nodes in a tree share one
common :term:`ancestor` call :term:`root`.
A tree is a special form of a :term:`directed acyclic graph (DAG) <DAG>`.
UCRT
Universal C Runtime
Wikipedia: :wiki:`Microsoft Windows library files: UCRT <Microsoft_Windows_library_files#UCRT>`
URI
Uniform Resource Identifier
Wikipedia: :wiki:`Uniform Resource Identifier <Uniform_Resource_Identifier>`
URL
Uniform Resource Locator
Wikipedia: :wiki:`Uniform Resource Locator <URL>`
URN
Uniform Resource Name
Wikipedia: :wiki:`Uniform Resource Name <Uniform_Resource_Name>`
Vertex
A vertex is a :term:`node` in a graph. Vertexes in a graph are connected using :term:`edges <edge>`.
WSL
Windows System for Linux
Wikipedia: :wiki:`Windows Subsystem for Linux <Windows_Subsystem_for_Linux>`
|
