ka-uts-com 1.0.1.250131__py3-none-any.whl → 2.1.0.250408__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- build/lib/dist/ka_uts_com-2.0.0.250407-py3-none-any.whl +0 -0
- build/lib/dist/ka_uts_com-2.0.0.250407.tar.gz +0 -0
- build/lib/ka_uts_com/__version__.py +1 -1
- build/lib/ka_uts_com/base/app_.py +10 -11
- build/lib/ka_uts_com/base/cfg_.py +14 -5
- build/lib/ka_uts_com/base/log_.py +66 -50
- build/lib/ka_uts_com/com.py +54 -11
- build/lib/ka_uts_com/data/log.std.yml +47 -26
- build/lib/ka_uts_com/data/log.usr.yml +46 -25
- build/lib/ka_uts_com/ioc/jinja2_.py +1 -1
- build/lib/ka_uts_com/ioc/yaml_.py +2 -1
- build/lib/ka_uts_com/log.py +23 -12
- build/lib/ka_uts_com/timer.py +10 -6
- build/lib/ka_uts_com/utils/aoeqstmt.py +0 -2
- build/lib/ka_uts_com/utils/doeq.py +7 -7
- build/lib/ka_uts_com/utils/pac.py +35 -0
- build/lib/ka_uts_com/utils/pacmod.py +74 -72
- dist/ka_uts_com-2.0.0.250407-py3-none-any.whl +0 -0
- dist/ka_uts_com-2.0.0.250407.tar.gz +0 -0
- ka_uts_com/__version__.py +1 -1
- ka_uts_com/base/app_.py +10 -11
- ka_uts_com/base/cfg_.py +14 -5
- ka_uts_com/base/log_.py +66 -50
- ka_uts_com/com.py +54 -11
- ka_uts_com/data/log.std.yml +47 -26
- ka_uts_com/data/log.usr.yml +46 -25
- ka_uts_com/ioc/jinja2_.py +1 -1
- ka_uts_com/ioc/yaml_.py +2 -1
- ka_uts_com/log.py +23 -12
- ka_uts_com/timer.py +10 -6
- ka_uts_com/utils/aoeqstmt.py +0 -2
- ka_uts_com/utils/doeq.py +7 -7
- ka_uts_com/utils/pac.py +35 -0
- ka_uts_com/utils/pacmod.py +74 -72
- {ka_uts_com-1.0.1.250131.dist-info → ka_uts_com-2.1.0.250408.dist-info}/METADATA +389 -406
- ka_uts_com-2.1.0.250408.dist-info/RECORD +55 -0
- {ka_uts_com-1.0.1.250131.dist-info → ka_uts_com-2.1.0.250408.dist-info}/licenses/LICENSE.txt +1 -2
- build/lib/dist/ka_uts_com-1.0.1.250131-py3-none-any.whl +0 -0
- build/lib/dist/ka_uts_com-1.0.1.250131.tar.gz +0 -0
- build/lib/ka_uts_com/utils/py.typed +0 -0
- dist/ka_uts_com-1.0.1.250131-py3-none-any.whl +0 -0
- dist/ka_uts_com-1.0.1.250131.tar.gz +0 -0
- ka_uts_com/utils/py.typed +0 -0
- ka_uts_com-1.0.1.250131.dist-info/RECORD +0 -55
- {ka_uts_com-1.0.1.250131.dist-info → ka_uts_com-2.1.0.250408.dist-info}/WHEEL +0 -0
- {ka_uts_com-1.0.1.250131.dist-info → ka_uts_com-2.1.0.250408.dist-info}/top_level.txt +0 -0
@@ -1,18 +1,17 @@
|
|
1
1
|
Metadata-Version: 2.4
|
2
2
|
Name: ka_uts_com
|
3
|
-
Version: 1.0.
|
3
|
+
Version: 2.1.0.250408
|
4
4
|
Summary: Communication Class Utilities
|
5
|
-
Author-email: Bernd Stroehle <bernd.stroehle@
|
6
|
-
Maintainer-email: Bernd Stroehle <bernd.stroehle@
|
5
|
+
Author-email: Bernd Stroehle <bernd.stroehle@gmail.com>
|
6
|
+
Maintainer-email: Bernd Stroehle <bernd.stroehle@gmail.com>
|
7
|
+
License-Expression: GPL-3.0-only WITH Classpath-exception-2.0 OR BSD-3-Clause
|
7
8
|
Project-URL: Source Code, https://github.com/bs29/ka_uts_com/tree/master
|
8
9
|
Project-URL: Homepage, https://kosakya.de/
|
9
10
|
Project-URL: Documentation, https://ka-com.readthedocs.io/en/latest
|
10
|
-
Project-URL: Apache-2.0 License, https://apache.org/licenses/LICENSE-2.0
|
11
11
|
Classifier: Development Status :: 5 - Production/Stable
|
12
12
|
Classifier: Intended Audience :: Developers
|
13
|
-
Classifier: License :: OSI Approved :: Apache Software License
|
14
13
|
Classifier: Operating System :: OS Independent
|
15
|
-
Classifier: Programming Language :: Python :: 3.
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
16
15
|
Classifier: Natural Language :: English
|
17
16
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
18
17
|
Requires-Python: >=3.10
|
@@ -22,8 +21,6 @@ Requires-Dist: Jinja2>=3.1.6
|
|
22
21
|
Requires-Dist: orjson>=3.10.16
|
23
22
|
Requires-Dist: psutil>=7.0.0
|
24
23
|
Requires-Dist: PyYAML>=6.0.2
|
25
|
-
Requires-Dist: PyYAML>=6.0.2
|
26
|
-
Requires-Dist: setuptools>=76.1.0
|
27
24
|
Requires-Dist: simplejson>=3.20.1
|
28
25
|
Dynamic: license-file
|
29
26
|
|
@@ -61,12 +58,6 @@ To install with ``conda``:
|
|
61
58
|
|
62
59
|
.. end installation
|
63
60
|
|
64
|
-
This requires that the ``readme`` extra is installed:
|
65
|
-
|
66
|
-
.. code-block:: bash
|
67
|
-
|
68
|
-
$ python -m pip install ka_uts_com[readme]
|
69
|
-
|
70
61
|
Package logging
|
71
62
|
***************
|
72
63
|
|
@@ -74,47 +65,52 @@ Standard or user specific Package logging of application package is defined
|
|
74
65
|
in the static logging class **Log_** of Base module log\_.py of the Communication
|
75
66
|
Package **ka_uts_com**.
|
76
67
|
The default Logging configuration is defined by the yaml files **log.std.yml**
|
77
|
-
for standard Logging or **log.
|
68
|
+
for standard Logging or **log.usr.yml** for user Logging in the data directory
|
78
69
|
**/ka_uts_com/data** of the Communication package.
|
79
70
|
The Logging configuration could be overriden by yaml files with the same names in the
|
80
71
|
data directory **<application>/data** of the application packages.
|
81
72
|
|
82
73
|
Logging defines log file paths for the following log message types: .
|
83
74
|
|
84
|
-
#. *debug*
|
85
75
|
#. *error*
|
76
|
+
#. *warning*
|
86
77
|
#. *info*
|
87
78
|
#. *log*
|
79
|
+
#. *debug*
|
88
80
|
|
89
81
|
.. Naming-conventions-for-logging-files-label:
|
90
82
|
.. table:: *Naming conventions for logging file*
|
91
83
|
|
92
|
-
|
93
|
-
|Type
|
94
|
-
|
95
|
-
|
|
96
|
-
|
97
|
-
|
|
98
|
-
|
99
|
-
|info
|
100
|
-
|
101
|
-
|log
|
102
|
-
|
84
|
+
+-------+--------------------------------------------+-------------------+
|
85
|
+
|Type |Directory |File |
|
86
|
+
+=======+============================================+===================+
|
87
|
+
|error |/data/<tenant>/RUN/<package>/<function>/errs|errs_<pid>_<ts>.log|
|
88
|
+
+-------+--------------------------------------------+-------------------+
|
89
|
+
|wnrning|/data/<tenant>/RUN/<package>/<function>/wrns|wrns_<pid>_<ts>.log|
|
90
|
+
+-------+--------------------------------------------+-------------------+
|
91
|
+
|info |/data/<tenant>/RUN/<package>/<function>/infs|infs_<pid>_<ts>.log|
|
92
|
+
+-------+--------------------------------------------+-------------------+
|
93
|
+
|log |/data/<tenant>/RUN/<package>/<function>/logs|logs_<pid>_<ts>.log|
|
94
|
+
+-------+--------------------------------------------+-------------------+
|
95
|
+
|debug |/data/<tenant>/RUN/<package>/<function>/debs|debs_<pid>_<ts>.log|
|
96
|
+
+-------+--------------------------------------------+-------------------+
|
103
97
|
|
104
98
|
.. Naming examples-of-logging-files-label:
|
105
99
|
.. table:: *Naming examples of logging file*
|
106
100
|
|
107
|
-
|
108
|
-
|Type
|
109
|
-
|
110
|
-
|
|
111
|
-
|
112
|
-
|
|
113
|
-
|
114
|
-
|info
|
115
|
-
|
116
|
-
|log
|
117
|
-
|
101
|
+
+-------+-------------------------------+------------------------+
|
102
|
+
|Type |Directory |File |
|
103
|
+
+=======+===============================+========================+
|
104
|
+
|error |/data/umh/RUN/umh_otec/srr/errs|errs_9470_1737118199.log|
|
105
|
+
+-------+-------------------------------+------------------------+
|
106
|
+
|warning|/data/umh/RUN/umh_otec/srr/wrns|wrns_9470_1737118199.log|
|
107
|
+
+-------+-------------------------------+------------------------+
|
108
|
+
|info |/data/umh/RUN/umh_otec/srr/infs|infs_9470_1737118199.log|
|
109
|
+
+-------+-------------------------------+------------------------+
|
110
|
+
|log |/data/umh/RUN/umh_otec/srr/logs|logs_9470_1737118199.log|
|
111
|
+
+-------+-------------------------------+------------------------+
|
112
|
+
|debug |/data/umh/RUN/umh_otec/srr/debs|debs_9470_1737118199.log|
|
113
|
+
+-------+-------------------------------+------------------------+
|
118
114
|
|
119
115
|
Package files
|
120
116
|
*************
|
@@ -127,8 +123,8 @@ The Files of Package ``ka_uts_com`` could be classified into the follwing file t
|
|
127
123
|
#. *Special files*
|
128
124
|
#. *Dunder modules*
|
129
125
|
#. *Decorator modules*
|
130
|
-
#. *Data files*
|
131
126
|
#. *Package modules*
|
127
|
+
#. *Data files*
|
132
128
|
|
133
129
|
Special files
|
134
130
|
*************
|
@@ -136,15 +132,14 @@ Special files
|
|
136
132
|
.. Special-file-label:
|
137
133
|
.. table:: *Special-file*
|
138
134
|
|
139
|
-
|
140
|
-
|Name |Type |Description
|
141
|
-
|
142
|
-
|py.typed|Type |The py.typed file is a marker file used in Python
|
143
|
-
| |checking|
|
144
|
-
| |marker |
|
145
|
-
| |file |
|
146
|
-
|
147
|
-
+--------+--------+---------------------------------------------------+
|
135
|
+
+--------+--------+-------------------------------------------------------------+
|
136
|
+
|Name |Type |Description |
|
137
|
+
+========+========+=============================================================+
|
138
|
+
|py.typed|Type |The py.typed file is a marker file used in Python packages to|
|
139
|
+
| |checking|indicate that the package supports type checking. This is a |
|
140
|
+
| |marker |part of the PEP 561 standard, which provides a standardized |
|
141
|
+
| |file |way to package and distribute type information in Python. |
|
142
|
+
+--------+--------+-------------------------------------------------------------+
|
148
143
|
|
149
144
|
Dunder Modules
|
150
145
|
**************
|
@@ -171,7 +166,7 @@ Overview
|
|
171
166
|
========
|
172
167
|
|
173
168
|
.. Decorator Modules-label:
|
174
|
-
.. table::
|
169
|
+
.. table:: *Decorator Modules*
|
175
170
|
|
176
171
|
+------+-----------------+
|
177
172
|
|Name |Decription |
|
@@ -182,8 +177,11 @@ Overview
|
|
182
177
|
Data Files
|
183
178
|
**********
|
184
179
|
|
180
|
+
Overview
|
181
|
+
========
|
182
|
+
|
185
183
|
.. Data-Files-label:
|
186
|
-
.. table::
|
184
|
+
.. table:: *Data Files*
|
187
185
|
|
188
186
|
+-----------+-----------------------------------------+
|
189
187
|
|Name |Description |
|
@@ -193,8 +191,8 @@ Data Files
|
|
193
191
|
|log.usr.yml|Yaml definition file for user logging |
|
194
192
|
+-----------+-----------------------------------------+
|
195
193
|
|
196
|
-
Package
|
197
|
-
|
194
|
+
Package Files
|
195
|
+
*************
|
198
196
|
|
199
197
|
Classification
|
200
198
|
==============
|
@@ -213,7 +211,7 @@ Overview
|
|
213
211
|
--------
|
214
212
|
|
215
213
|
.. Communication Modules-label:
|
216
|
-
.. table::
|
214
|
+
.. table:: *Communication Modules*
|
217
215
|
|
218
216
|
+--------+-----------------------------+
|
219
217
|
|Name |Decription |
|
@@ -227,21 +225,21 @@ Overview
|
|
227
225
|
|timer.py|Timer management module |
|
228
226
|
+--------+-----------------------------+
|
229
227
|
|
230
|
-
Communication module
|
231
|
-
|
228
|
+
Communication module com.py
|
229
|
+
===========================
|
232
230
|
|
233
|
-
The Communication
|
231
|
+
The Communication Module ``com.py`` contains the single static class ``Com``.
|
234
232
|
|
235
|
-
Com
|
236
|
-
|
233
|
+
Class Com
|
234
|
+
---------
|
237
235
|
|
238
236
|
The static Class ``Com`` contains the subsequent variables and methods.
|
239
237
|
|
240
|
-
|
241
|
-
|
238
|
+
Variables
|
239
|
+
^^^^^^^^^
|
242
240
|
|
243
241
|
.. Variables-of-class-Com-label:
|
244
|
-
.. table::
|
242
|
+
.. table:: *Variables of class Com*
|
245
243
|
|
246
244
|
+--------+-----------+-------+-----------------------------------+
|
247
245
|
|Name |Type |Default|Description |
|
@@ -271,28 +269,28 @@ Com Variables
|
|
271
269
|
|Exit |TyAny |False |Exit class |
|
272
270
|
+--------+-----------+-------+-----------------------------------+
|
273
271
|
|
274
|
-
|
275
|
-
|
272
|
+
Methods
|
273
|
+
^^^^^^^
|
276
274
|
|
277
275
|
.. Methods-of-class-Com-label:
|
278
|
-
.. table::
|
276
|
+
.. table:: *Methods-of-class-Com*
|
279
277
|
|
280
278
|
+---------+-------------------------------------------------------+
|
281
279
|
|Name |Description |
|
282
280
|
+=========+=======================================================+
|
283
|
-
|init |
|
281
|
+
|init |Initialise static variables if they are not initialized|
|
284
282
|
+---------+-------------------------------------------------------+
|
285
|
-
|sh_kwargs|
|
283
|
+
|sh_kwargs|Show keyword arguments |
|
286
284
|
+---------+-------------------------------------------------------+
|
287
285
|
|
288
|
-
|
289
|
-
|
286
|
+
Method init
|
287
|
+
^^^^^^^^^^^
|
290
288
|
|
291
289
|
Parameter
|
292
290
|
"""""""""
|
293
291
|
|
294
|
-
.. Parameter-of-
|
295
|
-
.. table::
|
292
|
+
.. Parameter-of-method-init-label:
|
293
|
+
.. table:: *Parameter-of-method-init*
|
296
294
|
|
297
295
|
+---------+-----+-----------------+
|
298
296
|
|Name |Type |Description |
|
@@ -302,14 +300,14 @@ Parameter
|
|
302
300
|
|\**kwargs|TyAny|keyword arguments|
|
303
301
|
+---------+-----+-----------------+
|
304
302
|
|
305
|
-
|
306
|
-
|
303
|
+
Method sh_kwargs
|
304
|
+
^^^^^^^^^^^^^^^^
|
307
305
|
|
308
306
|
Parameter
|
309
307
|
"""""""""
|
310
308
|
|
311
|
-
..
|
312
|
-
.. table::
|
309
|
+
.. Parameter-of-method-sh_kwargs-label:
|
310
|
+
.. table:: *Parameter of method sh_kwargs*
|
313
311
|
|
314
312
|
+--------+-----+--------------------+
|
315
313
|
|Name |Type |Description |
|
@@ -323,42 +321,42 @@ Parameter
|
|
323
321
|
|\*args |list |arguments array |
|
324
322
|
+--------+-----+--------------------+
|
325
323
|
|
326
|
-
Function Module
|
327
|
-
|
324
|
+
Function Module fnc.py
|
325
|
+
======================
|
328
326
|
|
329
|
-
The Module ``fnc.py`` contains
|
327
|
+
The Module ``fnc.py`` contains the static class ``Fnc`` with I/O Control methods for log files;
|
330
328
|
|
331
|
-
|
332
|
-
|
329
|
+
Class Fnc
|
330
|
+
---------
|
333
331
|
|
334
332
|
The static Class ``Fnc`` contains the subsequent methods
|
335
333
|
|
336
|
-
|
337
|
-
|
334
|
+
Methods
|
335
|
+
^^^^^^^
|
338
336
|
|
339
|
-
.. Methods-of-Fnc-
|
340
|
-
.. table:: Methods of Fnc
|
341
|
-
|
342
|
-
|
343
|
-
|Name |Type |Description
|
344
|
-
|
345
|
-
|identity|static|Identity function for objects
|
346
|
-
|
347
|
-
|sh |static|Show function localised in the given dictionary of
|
348
|
-
| | |by the given key
|
349
|
-
|
350
|
-
|ex |class |Execute the function localised by the show function of
|
351
|
-
| | |Fnc using the given key and dictionary of functions
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
337
|
+
.. Methods-of-class-Fnc-label:
|
338
|
+
.. table:: *Methods of class Fnc*
|
339
|
+
|
340
|
+
+--------+------+---------------------------------------------------------+
|
341
|
+
|Name |Type |Description |
|
342
|
+
+========+======+=========================================================+
|
343
|
+
|identity|static|Identity function for objects |
|
344
|
+
+--------+------+---------------------------------------------------------+
|
345
|
+
|sh |static|Show function localised in the given dictionary of |
|
346
|
+
| | |functions by the given key |
|
347
|
+
+--------+------+---------------------------------------------------------+
|
348
|
+
|ex |class |Execute the function localised by the show function of |
|
349
|
+
| | |class Fnc using the given key and dictionary of functions|
|
350
|
+
+--------+------+---------------------------------------------------------+
|
351
|
+
|
352
|
+
Method identity
|
353
|
+
^^^^^^^^^^^^^^^
|
356
354
|
|
357
355
|
Parameter
|
358
356
|
"""""""""
|
359
357
|
|
360
|
-
.. Parameter-of-identity-
|
361
|
-
.. table:: Parameter of identity
|
358
|
+
.. Parameter-of-method-identity-label:
|
359
|
+
.. table:: *Parameter of method identity*
|
362
360
|
|
363
361
|
+----+-----+-----------+
|
364
362
|
|Name|Type |Description|
|
@@ -369,8 +367,8 @@ Parameter
|
|
369
367
|
Return Value
|
370
368
|
""""""""""""
|
371
369
|
|
372
|
-
.. Return
|
373
|
-
.. table::
|
370
|
+
.. Return-values-of-method-identity-label:
|
371
|
+
.. table:: *Return values of method identity*
|
374
372
|
|
375
373
|
+----+-----+-----------+
|
376
374
|
|Name|Type |Description|
|
@@ -378,14 +376,14 @@ Return Value
|
|
378
376
|
|obj |TyAny|object |
|
379
377
|
+----+-----+-----------+
|
380
378
|
|
381
|
-
|
382
|
-
|
379
|
+
Method ex
|
380
|
+
^^^^^^^^^
|
383
381
|
|
384
382
|
Parameter
|
385
383
|
"""""""""
|
386
384
|
|
387
|
-
.. Parameter-of-ex-
|
388
|
-
.. table:: Parameter of ex
|
385
|
+
.. Parameter-of-method-ex-label:
|
386
|
+
.. table:: *Parameter of method ex*
|
389
387
|
|
390
388
|
+-----------+--------+------------------------------+
|
391
389
|
|Name |Type |Description |
|
@@ -402,8 +400,8 @@ Parameter
|
|
402
400
|
Return Value
|
403
401
|
""""""""""""
|
404
402
|
|
405
|
-
.. Return
|
406
|
-
.. table:: *Return value of ex
|
403
|
+
.. Return-value-of-method-ex-label:
|
404
|
+
.. table:: *Return value of method ex*
|
407
405
|
|
408
406
|
+----+----------+------------------------------------------+
|
409
407
|
|Name|Type |Description |
|
@@ -411,14 +409,14 @@ Return Value
|
|
411
409
|
| |TyCallable|Value of Function for argument args_kwargs|
|
412
410
|
+----+----------+------------------------------------------+
|
413
411
|
|
414
|
-
|
415
|
-
|
412
|
+
Method sh
|
413
|
+
^^^^^^^^^
|
416
414
|
|
417
415
|
Parameter
|
418
416
|
"""""""""
|
419
417
|
|
420
|
-
.. Parameter-of-sh-
|
421
|
-
.. table:: Parameter of sh
|
418
|
+
.. Parameter-of-method-sh-label:
|
419
|
+
.. table:: *Parameter of method sh*
|
422
420
|
|
423
421
|
+----+-----+------------------------------+
|
424
422
|
|Name|Type |Description |
|
@@ -433,8 +431,8 @@ Parameter
|
|
433
431
|
Return Value
|
434
432
|
""""""""""""
|
435
433
|
|
436
|
-
.. Return
|
437
|
-
.. table:: *Return value of sh
|
434
|
+
.. Return-value-of-method-sh-label:
|
435
|
+
.. table:: *Return value of method sh*
|
438
436
|
|
439
437
|
+----+----------+-----------+
|
440
438
|
|Name|Type |Description|
|
@@ -445,20 +443,20 @@ Return Value
|
|
445
443
|
Communicstion Module: log.py
|
446
444
|
============================
|
447
445
|
|
448
|
-
The Module ``log.py`` contains
|
446
|
+
The Module ``log.py`` contains the static class ``Log`` with I/O Control methods for log files;
|
449
447
|
|
450
|
-
|
451
|
-
|
448
|
+
Class Log
|
449
|
+
---------
|
452
450
|
|
453
451
|
The static Class ``Log`` contains the subsequent sub classes and methods
|
454
452
|
|
455
453
|
Sub-Classes
|
456
454
|
^^^^^^^^^^^
|
457
455
|
|
458
|
-
The Class ``Log`` contains the following
|
456
|
+
The Class ``Log`` contains the following sub-classes.
|
459
457
|
|
460
|
-
.. Static-
|
461
|
-
.. table:: *Static
|
458
|
+
.. Static-sub-classes-of-class-Log-label:
|
459
|
+
.. table:: *Static sub classes of class Log label*
|
462
460
|
|
463
461
|
+----+----------------------------------------------------+
|
464
462
|
|Name|Description |
|
@@ -468,38 +466,34 @@ The Class ``Log`` contains the following static sub-classes.
|
|
468
466
|
|Dic |Log generated Equate messages for dictionary entries|
|
469
467
|
+----+----------------------------------------------------+
|
470
468
|
|
471
|
-
|
472
|
-
|
469
|
+
Sub class Eq
|
470
|
+
^^^^^^^^^^^^
|
473
471
|
|
474
|
-
|
475
|
-
"""""""
|
476
|
-
|
477
|
-
.. Methods-of-
|
478
|
-
.. table:: *Methods
|
479
|
-
|
480
|
-
|
481
|
-
|Name |Description
|
482
|
-
|
483
|
-
|debug|Log generated equate message "<key> = <value>"|
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
|
488
|
-
|
489
|
-
|
|
490
|
-
|
491
|
-
+-----+----------------------------------------------+
|
492
|
-
|debug|Log generated equate message "<key> = <value>"|
|
493
|
-
| |to the warning destination |
|
494
|
-
+-----+----------------------------------------------+
|
472
|
+
Methods
|
473
|
+
"""""""
|
474
|
+
|
475
|
+
.. Methods-of-sub-class-Eq-label:
|
476
|
+
.. table:: *Methods-of-sub-class-Eq-label*
|
477
|
+
|
478
|
+
+-----+-----------------------------------------------------------------------+
|
479
|
+
|Name |Description |
|
480
|
+
+=====+=======================================================================+
|
481
|
+
|debug|Log generated equate message "<key> = <value>" to the debug destination|
|
482
|
+
+-----+-----------------------------------------------------------------------+
|
483
|
+
|error|Log generated equate message "<key> = <value>" to the error destination|
|
484
|
+
+-----+-----------------------------------------------------------------------+
|
485
|
+
|info |Log generated equate message "<key> = <value>" to the info destination |
|
486
|
+
+-----+-----------------------------------------------------------------------+
|
487
|
+
|debug|Log generated equate message "<key> = <value>" to the log destination |
|
488
|
+
+-----+-----------------------------------------------------------------------+
|
495
489
|
|
496
490
|
All Methods use the following Parameter:
|
497
491
|
|
498
492
|
Parameter
|
499
493
|
"""""""""
|
500
494
|
|
501
|
-
.. Parameter-of-
|
502
|
-
.. table:: *Parameter of
|
495
|
+
.. Parameter-of-Methods-of-sub-class-Eq-label:
|
496
|
+
.. table:: *Parameter of Methods of sub class Eq*
|
503
497
|
|
504
498
|
+-----+-----+-------------+
|
505
499
|
|Name |Type |Description |
|
@@ -511,38 +505,34 @@ Parameter
|
|
511
505
|
|value|TyAny|Value |
|
512
506
|
+-----+-----+-------------+
|
513
507
|
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
"""""""
|
519
|
-
|
520
|
-
.. Methods-of-
|
521
|
-
.. table:: *Methods of
|
522
|
-
|
523
|
-
|
524
|
-
|Name
|
525
|
-
|
526
|
-
|debug
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
|
531
|
-
|
532
|
-
|
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
| |entries to the warning destination |
|
537
|
-
+-------+------------------------------------------------+
|
538
|
-
|
539
|
-
All Log-Dic Methods use the following Parameters:
|
508
|
+
Sub class Dic
|
509
|
+
^^^^^^^^^^^^^
|
510
|
+
|
511
|
+
Methods
|
512
|
+
"""""""
|
513
|
+
|
514
|
+
.. Methods-of-Sub-class-Dic-of-class-Log-label:
|
515
|
+
.. table:: *Methods of Sub class Dic of class Log*
|
516
|
+
|
517
|
+
+-----+---------------------------------------------------------------------------------+
|
518
|
+
|Name |Description |
|
519
|
+
+=====+=================================================================================+
|
520
|
+
|debug|Log generated equate messages for all dictionary entries to the debug destination|
|
521
|
+
+-----+---------------------------------------------------------------------------------+
|
522
|
+
|error|Log generated equate messages for all dictionary entries to the error destination|
|
523
|
+
+-----+---------------------------------------------------------------------------------+
|
524
|
+
|info |Log generated equate messages for all dictionary entries to the info destination |
|
525
|
+
+-----+---------------------------------------------------------------------------------+
|
526
|
+
|log |Log generated equate messages for all dictionary entries to the log destination |
|
527
|
+
+-----+---------------------------------------------------------------------------------+
|
528
|
+
|
529
|
+
All Methods of Sub class Dic of class Log use the following Parameters:
|
540
530
|
|
541
531
|
Parameter
|
542
532
|
"""""""""
|
543
533
|
|
544
|
-
.. Parameter-of-
|
545
|
-
.. table:: *Parameter of
|
534
|
+
.. Methods-Parameter-of-Sub-class-Dic-of-class-Log-label:
|
535
|
+
.. table:: *Methods Parameter of Sub class Dic of class-Log*
|
546
536
|
|
547
537
|
+----+-----+-------------+
|
548
538
|
|Name|Type |Description |
|
@@ -555,8 +545,8 @@ Parameter
|
|
555
545
|
Methods
|
556
546
|
^^^^^^^
|
557
547
|
|
558
|
-
.. Methods-of-
|
559
|
-
.. table:: *Methods of
|
548
|
+
.. Methods-of-Sub-class-Dic-of-class-Log-label:
|
549
|
+
.. table:: *Methods of Sub class Dic of class Log*
|
560
550
|
|
561
551
|
+-------+-----------------------------------------------------------+
|
562
552
|
|Name |Description |
|
@@ -570,68 +560,63 @@ Methods
|
|
570
560
|
|warning|Setup stacklevel and log message to the warning destination|
|
571
561
|
+-------+-----------------------------------------------------------+
|
572
562
|
|
573
|
-
|
574
|
-
|
563
|
+
Time management Module timer.py
|
564
|
+
===============================
|
575
565
|
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
+----+-----+-------------+
|
580
|
-
|Name|Type |Description |
|
581
|
-
+====+=====+=============+
|
582
|
-
|cls |class|current class|
|
583
|
-
+----+-----+-------------+
|
584
|
-
|dic |TyDic|Dictionary |
|
585
|
-
+----+-----+-------------+
|
586
|
-
|
587
|
-
timer.py
|
588
|
-
========
|
589
|
-
|
590
|
-
Static classes
|
591
|
-
--------------
|
566
|
+
Classes
|
567
|
+
-------
|
592
568
|
|
593
569
|
The Module ``timer.py`` contains the following classes
|
594
570
|
|
595
571
|
|
596
|
-
.. Static-classes-of-module-timer-label:
|
572
|
+
.. Static-classes-of-module-timer.py-label:
|
597
573
|
.. table:: *Static classes of module timer.py*
|
598
574
|
|
599
|
-
|
600
|
-
|Name |Description |
|
601
|
-
|
602
|
-
|Timestamp|Timestamp class|
|
603
|
-
|
604
|
-
|Timer |Timer class |
|
605
|
-
|
575
|
+
+---------+------+---------------+
|
576
|
+
|Name |Type |Description |
|
577
|
+
+=========+======+===============+
|
578
|
+
|Timestamp|static|Timestamp class|
|
579
|
+
+---------+------+---------------+
|
580
|
+
|Timer |static|Timer class |
|
581
|
+
+---------+------+---------------+
|
606
582
|
|
607
583
|
|
608
|
-
|
609
|
-
|
584
|
+
Class Timer
|
585
|
+
-----------
|
610
586
|
|
611
|
-
|
612
|
-
|
587
|
+
Methods
|
588
|
+
^^^^^^^
|
613
589
|
|
614
|
-
.. Methods-of-Timer-label:
|
615
|
-
.. table:: *Methods of Timer*
|
590
|
+
.. Methods-of-class-Timer-label:
|
591
|
+
.. table:: *Methods of class Timer*
|
616
592
|
|
617
|
-
|
618
|
-
|Name |Description
|
619
|
-
|
620
|
-
|sh_task_id|
|
621
|
-
|
622
|
-
|start |
|
623
|
-
|
624
|
-
|end |
|
625
|
-
|
593
|
+
+----------+------------------------------------+
|
594
|
+
|Name |Description |
|
595
|
+
+==========+====================================+
|
596
|
+
|sh_task_id|Show task id |
|
597
|
+
+----------+------------------------------------+
|
598
|
+
|start |Start Timer |
|
599
|
+
+----------+------------------------------------+
|
600
|
+
|end |End Timer and Log Timer info message|
|
601
|
+
+----------+------------------------------------+
|
626
602
|
|
627
|
-
|
628
|
-
|
603
|
+
Method sh_task_id
|
604
|
+
^^^^^^^^^^^^^^^^^
|
605
|
+
|
606
|
+
Show task id, which is created by the concatination of the following items if they are defined:
|
607
|
+
#. package,
|
608
|
+
#. module,
|
609
|
+
#. class_name,
|
610
|
+
#. parms
|
611
|
+
The items package and module are get from the package-module directory;
|
612
|
+
The item class_name is the class_id if its a string, otherwise the attribute
|
613
|
+
__qualname__ is used.
|
629
614
|
|
630
615
|
Parameter
|
631
616
|
"""""""""
|
632
617
|
|
633
|
-
.. Parameter-of-
|
634
|
-
.. table:: *Parameter
|
618
|
+
.. Parameter-of-method-sh_task_id-label:
|
619
|
+
.. table:: *Parameter-of-method-sh_task_id*
|
635
620
|
|
636
621
|
+--------+-----+-----------------+
|
637
622
|
|Name |Type |Description |
|
@@ -640,7 +625,7 @@ Parameter
|
|
640
625
|
+--------+-----+-----------------+
|
641
626
|
|class_id|TyAny|Class Id |
|
642
627
|
+--------+-----+-----------------+
|
643
|
-
|parms |TnAny|
|
628
|
+
|parms |TnAny|Parameters |
|
644
629
|
+--------+-----+-----------------+
|
645
630
|
|sep |TyStr|Separator |
|
646
631
|
+--------+-----+-----------------+
|
@@ -648,8 +633,8 @@ Parameter
|
|
648
633
|
Return Value
|
649
634
|
""""""""""""
|
650
635
|
|
651
|
-
.. Return
|
652
|
-
.. table:: *Return
|
636
|
+
.. Return-value-of-method-sh_task_id-label:
|
637
|
+
.. table:: *Return value of method sh_task_id*
|
653
638
|
|
654
639
|
+----+-----+-----------+
|
655
640
|
|Name|Type |Description|
|
@@ -657,14 +642,14 @@ Return Value
|
|
657
642
|
| |TyStr|Task Id |
|
658
643
|
+----+-----+-----------+
|
659
644
|
|
660
|
-
|
661
|
-
|
645
|
+
Method start
|
646
|
+
^^^^^^^^^^^^
|
662
647
|
|
663
648
|
Parameter
|
664
649
|
"""""""""
|
665
650
|
|
666
|
-
.. Parameter-of-start-
|
667
|
-
.. table:: *Parameter of start
|
651
|
+
.. Parameter-of-method-start-label:
|
652
|
+
.. table:: *Parameter of method start*
|
668
653
|
|
669
654
|
+--------+-----+-------------+
|
670
655
|
|Name |Type |Description |
|
@@ -678,8 +663,8 @@ Parameter
|
|
678
663
|
|sep |TyStr|Separator |
|
679
664
|
+--------+-----+-------------+
|
680
665
|
|
681
|
-
|
682
|
-
|
666
|
+
Method: end
|
667
|
+
^^^^^^^^^^^
|
683
668
|
|
684
669
|
Parameter
|
685
670
|
"""""""""
|
@@ -725,16 +710,16 @@ Application setup module: app\_.py
|
|
725
710
|
|
726
711
|
The Module ``app.py`` contains a single static class ``App_``.
|
727
712
|
|
728
|
-
|
729
|
-
|
713
|
+
Class: App\_
|
714
|
+
------------
|
730
715
|
|
731
716
|
The static class ``App_`` contains the subsequent static variables and methods
|
732
717
|
|
733
|
-
|
734
|
-
|
718
|
+
Static Variables
|
719
|
+
^^^^^^^^^^^^^^^^
|
735
720
|
|
736
|
-
.. Static-variables-of-App_-label:
|
737
|
-
.. table:: *Static Variables of App_*
|
721
|
+
.. Static-variables-of-class-App_-label:
|
722
|
+
.. table:: *Static Variables of class App_*
|
738
723
|
|
739
724
|
+---------------+-------+-------+---------------------+
|
740
725
|
|Name |Type |Default|Description |
|
@@ -752,14 +737,14 @@ Appl\_ Static Variables
|
|
752
737
|
|app |TyDic |None |Appliction dictionary|
|
753
738
|
+---------------+-------+-------+---------------------+
|
754
739
|
|
755
|
-
|
756
|
-
|
740
|
+
Methods
|
741
|
+
^^^^^^^
|
757
742
|
|
758
|
-
.. Methods-of-App_-label:
|
759
|
-
.. table:: *Methods of App_*
|
743
|
+
.. Methods-of-class-App_-label:
|
744
|
+
.. table:: *Methods of class App_*
|
760
745
|
|
761
746
|
+----+------+------------------------------------+
|
762
|
-
|Name|
|
747
|
+
|Name|Type |Description |
|
763
748
|
+====+======+====================================+
|
764
749
|
|init|class |initialise static variables of class|
|
765
750
|
| | |if they are not allready initialized|
|
@@ -767,14 +752,14 @@ Appl\_ Methods
|
|
767
752
|
|sh |class |show (return) class |
|
768
753
|
+----+------+------------------------------------+
|
769
754
|
|
770
|
-
|
771
|
-
|
755
|
+
Method: init
|
756
|
+
^^^^^^^^^^^^
|
772
757
|
|
773
758
|
Parameter
|
774
759
|
"""""""""
|
775
760
|
|
776
|
-
.. Parameter-of-init-label:
|
777
|
-
.. table:: *Parameter of init*
|
761
|
+
.. Parameter-of-method-init-label:
|
762
|
+
.. table:: *Parameter of method init*
|
778
763
|
|
779
764
|
+---------+-----+-----------------+
|
780
765
|
|Name |Type |Description |
|
@@ -784,11 +769,11 @@ Parameter
|
|
784
769
|
|\**kwargs|TyAny|Keyword arguments|
|
785
770
|
+---------+-----+-----------------+
|
786
771
|
|
787
|
-
|
788
|
-
|
772
|
+
Method: sh
|
773
|
+
^^^^^^^^^^
|
789
774
|
|
790
|
-
.. Parameter-of-sh-label:
|
791
|
-
.. table:: *Parameter of sh*
|
775
|
+
.. Parameter-of-method-sh-label:
|
776
|
+
.. table:: *Parameter of method sh*
|
792
777
|
|
793
778
|
+---------+-----+-----------------+
|
794
779
|
|Name |Type |Description |
|
@@ -801,8 +786,8 @@ Appl\_ Method: sh
|
|
801
786
|
Return Value
|
802
787
|
""""""""""""
|
803
788
|
|
804
|
-
.. Return-values-
|
805
|
-
.. table:: *Return values of sh*
|
789
|
+
.. Return-values-of-method-sh-label:
|
790
|
+
.. table:: *Return values of method sh*
|
806
791
|
|
807
792
|
+----+--------+-----------+
|
808
793
|
|Name|Type |Description|
|
@@ -815,8 +800,8 @@ cfg\_.py
|
|
815
800
|
|
816
801
|
The Base module cfg\_.py contains a single static class ``Cfg_``.
|
817
802
|
|
818
|
-
Cfg\_
|
819
|
-
|
803
|
+
Class Cfg\_
|
804
|
+
-----------
|
820
805
|
|
821
806
|
The static class ``Cfg_`` contains the subsequent static variables and methods
|
822
807
|
|
@@ -832,27 +817,27 @@ Static Variables
|
|
832
817
|
|cfg |TyDic|None |Configuration object|
|
833
818
|
+----+-----+-------+--------------------+
|
834
819
|
|
835
|
-
|
836
|
-
|
820
|
+
Methods
|
821
|
+
^^^^^^^
|
837
822
|
|
838
|
-
.. Methods-of-Cfg_-label:
|
839
|
-
.. table:: *Methods of Cfg_*
|
823
|
+
.. Methods-of-class-Cfg_-label:
|
824
|
+
.. table:: *Methods of class Cfg_*
|
840
825
|
|
841
826
|
+----+------+-----------------------------------+
|
842
|
-
|Name|
|
827
|
+
|Name|Type |Description |
|
843
828
|
+====+======+===================================+
|
844
829
|
|sh |class |read pacmod yaml file into class |
|
845
830
|
| | |variable cls.dic and return cls.cfg|
|
846
831
|
+----+------+-----------------------------------+
|
847
832
|
|
848
|
-
|
849
|
-
|
833
|
+
Method: sh
|
834
|
+
^^^^^^^^^^
|
850
835
|
|
851
836
|
Parameter
|
852
837
|
"""""""""
|
853
838
|
|
854
|
-
.. Parameter-of-init-label:
|
855
|
-
.. table:: *Parameter of sh*
|
839
|
+
.. Parameter-of-method-init-label:
|
840
|
+
.. table:: *Parameter of method sh*
|
856
841
|
|
857
842
|
+--------+--------+-----------------+
|
858
843
|
|Name |Type |Description |
|
@@ -867,8 +852,8 @@ Parameter
|
|
867
852
|
Return Value
|
868
853
|
""""""""""""
|
869
854
|
|
870
|
-
.. Return-values-of-sh-label:
|
871
|
-
.. table:: *Return values of sh*
|
855
|
+
.. Return-values-of-method-sh-label:
|
856
|
+
.. table:: *Return values of method sh*
|
872
857
|
|
873
858
|
+-------+-----+-----------+
|
874
859
|
|Name |Type |Description|
|
@@ -876,21 +861,21 @@ Return Value
|
|
876
861
|
|cls.cfg|TyDic| |
|
877
862
|
+-------+-----+-----------+
|
878
863
|
|
879
|
-
exit\_.py
|
880
|
-
|
864
|
+
Base Modul exit\_.py
|
865
|
+
====================
|
881
866
|
|
882
867
|
The Base module exit\_.py contains a single static class ``Exit_``.
|
883
868
|
|
884
|
-
|
885
|
-
|
869
|
+
class Exit\_
|
870
|
+
------------
|
886
871
|
|
887
872
|
The static Class ``Exit_`` contains the subsequent static variables and methods.
|
888
873
|
|
889
|
-
|
890
|
-
|
874
|
+
Static Variables
|
875
|
+
^^^^^^^^^^^^^^^^
|
891
876
|
|
892
|
-
..
|
893
|
-
.. table:: *
|
877
|
+
.. Static variables-of-class-Exit_-label:
|
878
|
+
.. table:: *Static variables of class Exit_*
|
894
879
|
|
895
880
|
+--------------+------+-------+---------------------+
|
896
881
|
|Name |Type |Default|Description |
|
@@ -904,11 +889,11 @@ Exit\_ Static Variables
|
|
904
889
|
|sw_interactive|TyBool|False |interactive switch |
|
905
890
|
+--------------+------+-------+---------------------+
|
906
891
|
|
907
|
-
|
908
|
-
|
892
|
+
Methods
|
893
|
+
^^^^^^^
|
909
894
|
|
910
|
-
.. Exit_-
|
911
|
-
.. table:: *Exit_
|
895
|
+
.. Methods-of-class-Exit_-label:
|
896
|
+
.. table:: *Methods of class Exit_*
|
912
897
|
|
913
898
|
+----+------+------------------------------------+
|
914
899
|
|Name|Method|Description |
|
@@ -919,14 +904,14 @@ Exit\_ Methods
|
|
919
904
|
|sh |class |show (return) class |
|
920
905
|
+----+------+------------------------------------+
|
921
906
|
|
922
|
-
|
923
|
-
|
907
|
+
Method: init
|
908
|
+
^^^^^^^^^^^^
|
924
909
|
|
925
910
|
Parameter
|
926
911
|
"""""""""
|
927
912
|
|
928
|
-
.. Parameter-of-init-label:
|
929
|
-
.. table:: *Parameter of init*
|
913
|
+
.. Parameter-of-method-init-label:
|
914
|
+
.. table:: *Parameter of method init*
|
930
915
|
|
931
916
|
+---------+-----+-----------------+
|
932
917
|
|Name |Type |Description |
|
@@ -936,14 +921,14 @@ Parameter
|
|
936
921
|
|\**kwargs|TyAny|Keyword arguments|
|
937
922
|
+---------+-----+-----------------+
|
938
923
|
|
939
|
-
|
940
|
-
|
924
|
+
Method: sh
|
925
|
+
^^^^^^^^^^
|
941
926
|
|
942
927
|
Parameter
|
943
928
|
"""""""""
|
944
929
|
|
945
|
-
.. Parameter-of-sh-label:
|
946
|
-
.. table:: *Parameter of sh*
|
930
|
+
.. Parameter-of-method-sh-label:
|
931
|
+
.. table:: *Parameter of method sh*
|
947
932
|
|
948
933
|
+---------+-----+-----------------+
|
949
934
|
|Name |Type |Description |
|
@@ -956,8 +941,8 @@ Parameter
|
|
956
941
|
Return Value
|
957
942
|
""""""""""""
|
958
943
|
|
959
|
-
.. Return-values-of-sh-label:
|
960
|
-
.. table:: *Return values of sh*
|
944
|
+
.. Return-values-of-method-sh-label:
|
945
|
+
.. table:: *Return values of method sh*
|
961
946
|
|
962
947
|
+----+-----+-------------+
|
963
948
|
|Name|Type |Description |
|
@@ -965,21 +950,21 @@ Return Value
|
|
965
950
|
|cls |class|Current class|
|
966
951
|
+----+-----+-------------+
|
967
952
|
|
968
|
-
log\_.py
|
969
|
-
|
953
|
+
Module log\_.py
|
954
|
+
===============
|
970
955
|
|
971
956
|
The Base module log\_.py contains a single static class ``Log_``.
|
972
957
|
|
973
|
-
Log\_
|
974
|
-
|
958
|
+
Class Log\_
|
959
|
+
-----------
|
975
960
|
|
976
961
|
The static Class ``Log_`` contains the subsequent static variables and methods.
|
977
962
|
|
978
|
-
|
979
|
-
|
963
|
+
Static Variables
|
964
|
+
^^^^^^^^^^^^^^^^
|
980
965
|
|
981
|
-
.. Static
|
982
|
-
.. table:: *Static variables of Log_*
|
966
|
+
.. Static-variables-of-class-Log_-label:
|
967
|
+
.. table:: *Static variables of class Log_*
|
983
968
|
|
984
969
|
+--------+--------+---------------------------------+---------------------+
|
985
970
|
|Name |Type |Default |Description |
|
@@ -991,8 +976,8 @@ Log\_ Static Variables
|
|
991
976
|
|username|TyStr |psutil.Process().username() |current username |
|
992
977
|
+--------+--------+---------------------------------+---------------------+
|
993
978
|
|
994
|
-
|
995
|
-
|
979
|
+
Methods
|
980
|
+
^^^^^^^
|
996
981
|
|
997
982
|
.. Methods-of-class-Log_-label:
|
998
983
|
.. table:: *Methods of class Log_*
|
@@ -1010,14 +995,14 @@ Log\_ Methods
|
|
1010
995
|
|sh |class |show (return) current class |
|
1011
996
|
+------+------+-------------------------------------+
|
1012
997
|
|
1013
|
-
|
1014
|
-
|
998
|
+
Method: init
|
999
|
+
^^^^^^^^^^^^
|
1015
1000
|
|
1016
1001
|
Parameter
|
1017
1002
|
"""""""""
|
1018
1003
|
|
1019
|
-
.. Parameter-of-init-label:
|
1020
|
-
.. table:: *Parameter of init*
|
1004
|
+
.. Parameter-of-method-init-label:
|
1005
|
+
.. table:: *Parameter of method init*
|
1021
1006
|
|
1022
1007
|
+---------+-----+-------------------+
|
1023
1008
|
|Name |Type |Description |
|
@@ -1029,14 +1014,14 @@ Parameter
|
|
1029
1014
|
|\**kwargs|TyAny|Keyword arguments |
|
1030
1015
|
+---------+-----+-------------------+
|
1031
1016
|
|
1032
|
-
|
1033
|
-
|
1017
|
+
Method sh_cfg
|
1018
|
+
^^^^^^^^^^^^^
|
1034
1019
|
|
1035
1020
|
Parameter
|
1036
1021
|
"""""""""
|
1037
1022
|
|
1038
|
-
.. Parameter-of-sh_cfg-label:
|
1039
|
-
.. table:: *Parameter of sh_cfg*
|
1023
|
+
.. Parameter-of-method-sh_cfg-label:
|
1024
|
+
.. table:: *Parameter of method sh_cfg*
|
1040
1025
|
|
1041
1026
|
+---------+-----+-------------------+
|
1042
1027
|
|Name |Type |Description |
|
@@ -1051,8 +1036,8 @@ Parameter
|
|
1051
1036
|
Return Value
|
1052
1037
|
""""""""""""
|
1053
1038
|
|
1054
|
-
.. Return-values-of-sh-label:
|
1055
|
-
.. table:: *Return values of sh*
|
1039
|
+
.. Return-values-of-method-sh-label:
|
1040
|
+
.. table:: *Return values of method sh*
|
1056
1041
|
|
1057
1042
|
+----+-----+-------------+
|
1058
1043
|
|Name|Type |Description |
|
@@ -1066,8 +1051,8 @@ sh (Method of class Log\_)
|
|
1066
1051
|
Parameter
|
1067
1052
|
"""""""""
|
1068
1053
|
|
1069
|
-
.. Parameter-of-sh-label:
|
1070
|
-
.. table:: *Parameter of sh*
|
1054
|
+
.. Parameter-of-method-sh-label:
|
1055
|
+
.. table:: *Parameter of method sh*
|
1071
1056
|
|
1072
1057
|
+---------+-----+-----------------+
|
1073
1058
|
|Name |Type |Description |
|
@@ -1080,8 +1065,8 @@ Parameter
|
|
1080
1065
|
Return Value
|
1081
1066
|
""""""""""""
|
1082
1067
|
|
1083
|
-
.. Return-values-of-sh-label:
|
1084
|
-
.. table:: *Return values of sh*
|
1068
|
+
.. Return-values-of-method-sh-label:
|
1069
|
+
.. table:: *Return values of method sh*
|
1085
1070
|
|
1086
1071
|
+----+-----+-------------+
|
1087
1072
|
|Name|Type |Description |
|
@@ -1114,14 +1099,14 @@ Overview
|
|
1114
1099
|
|str.py |Manage strings |
|
1115
1100
|
+-----------+--------------------------------+
|
1116
1101
|
|
1117
|
-
aoeqstmt.py
|
1118
|
-
|
1102
|
+
Module aoeqstmt.py
|
1103
|
+
==================
|
1119
1104
|
|
1120
|
-
|
1121
|
-
|
1105
|
+
Classes
|
1106
|
+
-------
|
1122
1107
|
|
1123
|
-
..
|
1124
|
-
.. table:: *
|
1108
|
+
.. Classes-of-module-aoeqstmt.py-label:
|
1109
|
+
.. table:: *Classes of Module aoeqstmt.py*
|
1125
1110
|
|
1126
1111
|
+-------------------------------------------------------+
|
1127
1112
|
|Static Class |
|
@@ -1131,16 +1116,16 @@ Static classes
|
|
1131
1116
|
|AoEqStmt |Manage Commandline Arguments as Equate String|
|
1132
1117
|
+---------+---------------------------------------------+
|
1133
1118
|
|
1134
|
-
|
1135
|
-
|
1119
|
+
Class AoEqStmt
|
1120
|
+
--------------
|
1136
1121
|
|
1137
1122
|
The static Class ``AoEqStmt`` contains the subsequent variables and methods
|
1138
1123
|
|
1139
|
-
|
1140
|
-
|
1124
|
+
Variables
|
1125
|
+
^^^^^^^^^
|
1141
1126
|
|
1142
|
-
.. Variables-of-AoEqStmt-
|
1143
|
-
.. table:: *Variables of AoEqStmt
|
1127
|
+
.. Variables-of-class-AoEqStmt-label:
|
1128
|
+
.. table:: *Variables of class AoEqStmt*
|
1144
1129
|
|
1145
1130
|
+----------------------------------------------------+
|
1146
1131
|
|Static Variables |
|
@@ -1160,11 +1145,11 @@ AoEqStmt Variables
|
|
1160
1145
|
|app |TyDic |None |Appliction dictionary|
|
1161
1146
|
+---------------+------+-------+---------------------+
|
1162
1147
|
|
1163
|
-
|
1164
|
-
|
1148
|
+
Methods
|
1149
|
+
^^^^^^^
|
1165
1150
|
|
1166
|
-
.. Methods-of-AoEqStmt-
|
1167
|
-
.. table:: *Methods of AoEqStmt
|
1151
|
+
.. Methods-of-class-AoEqStmt-label:
|
1152
|
+
.. table:: *Methods of class AoEqStmt*
|
1168
1153
|
|
1169
1154
|
+--------------+---------------------------------------------------------+
|
1170
1155
|
|Name |Description |
|
@@ -1176,8 +1161,8 @@ AoEqStmt Methods
|
|
1176
1161
|
|sh |set and show (return) equate dictionary |
|
1177
1162
|
+--------------+---------------------------------------------------------+
|
1178
1163
|
|
1179
|
-
|
1180
|
-
|
1164
|
+
Method _set_pacmod_curr
|
1165
|
+
^^^^^^^^^^^^^^^^^^^^^^^
|
1181
1166
|
|
1182
1167
|
Description
|
1183
1168
|
"""""""""""
|
@@ -1187,8 +1172,8 @@ Set item "pacmod_curr" of equate dictionary using item "tenant".
|
|
1187
1172
|
Parameter
|
1188
1173
|
"""""""""
|
1189
1174
|
|
1190
|
-
.. Parameter-of-
|
1191
|
-
.. table:: *Parameter
|
1175
|
+
.. Parameter-of-method-set_pacmod_curr-label:
|
1176
|
+
.. table:: *Parameter of method set_pacmod_curr*
|
1192
1177
|
|
1193
1178
|
+--------+-----+---------------------+
|
1194
1179
|
|Name |Type |Description |
|
@@ -1198,8 +1183,8 @@ Parameter
|
|
1198
1183
|
|root_cls|class|Root Class |
|
1199
1184
|
+--------+-----+---------------------+
|
1200
1185
|
|
1201
|
-
|
1202
|
-
|
1186
|
+
Method _set_sh_prof
|
1187
|
+
^^^^^^^^^^^^^^^^^^^
|
1203
1188
|
|
1204
1189
|
Description
|
1205
1190
|
"""""""""""
|
@@ -1209,8 +1194,8 @@ Set item "sh_prof" of equate dictionary using profile initialiation function.
|
|
1209
1194
|
Parameter
|
1210
1195
|
"""""""""
|
1211
1196
|
|
1212
|
-
.. Parameter-of-
|
1213
|
-
.. table:: *Parameter
|
1197
|
+
.. Parameter-of-Method-set_sh_prof-label:
|
1198
|
+
.. table:: *Parameter of method set_sh_prof*
|
1214
1199
|
|
1215
1200
|
+-------+------+-------------------------------+
|
1216
1201
|
|Name |Type |Description |
|
@@ -1220,8 +1205,8 @@ Parameter
|
|
1220
1205
|
|sh_prof|TyCall|Profile initialisation function|
|
1221
1206
|
+-------+------+-------------------------------+
|
1222
1207
|
|
1223
|
-
|
1224
|
-
|
1208
|
+
Method: sh
|
1209
|
+
^^^^^^^^^^
|
1225
1210
|
|
1226
1211
|
Description
|
1227
1212
|
"""""""""""
|
@@ -1231,8 +1216,8 @@ Set and show (return) equate dictionary
|
|
1231
1216
|
Parameter
|
1232
1217
|
"""""""""
|
1233
1218
|
|
1234
|
-
.. Parameter-of-
|
1235
|
-
.. table:: *Parameter
|
1219
|
+
.. Parameter-of-method-sh-label:
|
1220
|
+
.. table:: *Parameter of method sh*
|
1236
1221
|
|
1237
1222
|
+-------+------+-------------------------------+
|
1238
1223
|
|Name |Type |Description |
|
@@ -1247,16 +1232,16 @@ doeq.py
|
|
1247
1232
|
|
1248
1233
|
The Module ``doeq.py`` contains a single static class ``DoEq``.
|
1249
1234
|
|
1250
|
-
|
1251
|
-
|
1235
|
+
Module doeq.py
|
1236
|
+
--------------
|
1252
1237
|
|
1253
1238
|
The static class ``DoEq`` is used to manage Commandline Arguments of Equate Strings.
|
1254
1239
|
|
1255
|
-
|
1256
|
-
|
1240
|
+
Methods
|
1241
|
+
^^^^^^^
|
1257
1242
|
|
1258
|
-
.. Methods-of-
|
1259
|
-
.. table:: *Methods of
|
1243
|
+
.. Methods-of-class-DoEq-label:
|
1244
|
+
.. table:: *Methods of class DoEq*
|
1260
1245
|
|
1261
1246
|
+--------+--------------------------------------------------+
|
1262
1247
|
|Name |Description |
|
@@ -1268,14 +1253,14 @@ DoEq Methods
|
|
1268
1253
|
| |strings provided by commandline arguments |
|
1269
1254
|
+--------+--------------------------------------------------+
|
1270
1255
|
|
1271
|
-
|
1272
|
-
|
1256
|
+
Method: sh_value
|
1257
|
+
^^^^^^^^^^^^^^^^
|
1273
1258
|
|
1274
1259
|
Parameter
|
1275
1260
|
"""""""""
|
1276
1261
|
|
1277
|
-
.. Parameter-of-sh_value-
|
1278
|
-
.. table:: *Parameter of sh_value
|
1262
|
+
.. Parameter-of-method-sh_value-label:
|
1263
|
+
.. table:: *Parameter of method sh_value*
|
1279
1264
|
|
1280
1265
|
+-------------+-----+-------------------------------------+
|
1281
1266
|
|Name |Type |Description |
|
@@ -1298,8 +1283,8 @@ Parameter
|
|
1298
1283
|
Return Values
|
1299
1284
|
"""""""""""""
|
1300
1285
|
|
1301
|
-
.. Return-values-of-sh_value-
|
1302
|
-
.. table:: *Return values of sh_value
|
1286
|
+
.. Return-values-of-method-sh_value-label:
|
1287
|
+
.. table:: *Return values of method sh_value*
|
1303
1288
|
|
1304
1289
|
+-----+-----+----------------------+
|
1305
1290
|
|Name |Type |Description |
|
@@ -1318,14 +1303,14 @@ Utility Module: pacmod.py
|
|
1318
1303
|
|
1319
1304
|
The Utility module pacmod.py contains a single static class ``PacMod``.
|
1320
1305
|
|
1321
|
-
|
1322
|
-
|
1306
|
+
Class PaMmod
|
1307
|
+
-------------
|
1323
1308
|
|
1324
|
-
|
1325
|
-
|
1309
|
+
Methods
|
1310
|
+
^^^^^^^
|
1326
1311
|
|
1327
|
-
..
|
1328
|
-
.. table:: *
|
1312
|
+
.. Methods-of-class-Pacmod-label:
|
1313
|
+
.. table:: *Methods of class Pacmod*
|
1329
1314
|
|
1330
1315
|
+-----------------+-------------------------------------------------+
|
1331
1316
|
|Name |Description |
|
@@ -1351,8 +1336,8 @@ PacMod Methods
|
|
1351
1336
|
|sh_d_pacmod |show pacmod dictionary |
|
1352
1337
|
+-----------------+-------------------------------------------------+
|
1353
1338
|
|
1354
|
-
|
1355
|
-
|
1339
|
+
Method: sh_d_pacmod
|
1340
|
+
^^^^^^^^^^^^^^^^^^^
|
1356
1341
|
|
1357
1342
|
Parameter
|
1358
1343
|
"""""""""
|
@@ -1368,13 +1353,13 @@ Parameter
|
|
1368
1353
|
|tenant |Any | |
|
1369
1354
|
+--------+-----+-----------------+
|
1370
1355
|
|
1371
|
-
|
1372
|
-
|
1356
|
+
Method: sh_path_cfg_yaml
|
1357
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1373
1358
|
|
1374
1359
|
Parameter
|
1375
1360
|
"""""""""
|
1376
1361
|
|
1377
|
-
.. Parameter-of-module-sh_path_cfg_yaml-label:
|
1362
|
+
.. Parameter-of-module-sh_path_cfg_yaml-of-class-Pacmod-label:
|
1378
1363
|
.. table:: *Parameter of method sh_path_cfg_yaml*
|
1379
1364
|
|
1380
1365
|
+------+-----+-----------------+
|
@@ -1383,14 +1368,12 @@ Parameter
|
|
1383
1368
|
|pacmod|TyDic| |
|
1384
1369
|
+------+-----+-----------------+
|
1385
1370
|
|
1386
|
-
|
1387
|
-
|
1371
|
+
Method: sh_path_cfg_yaml
|
1372
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1388
1373
|
|
1389
1374
|
Parameter
|
1390
1375
|
"""""""""
|
1391
1376
|
|
1392
|
-
.. Parameter-of-module-sh_path_cfg_yaml-label:
|
1393
|
-
.. table:: *Parameter of method sh_path_cfg_yaml*
|
1394
1377
|
|
1395
1378
|
+------+-----+-----------------+
|
1396
1379
|
|Name |Type |Description |
|
@@ -1400,8 +1383,8 @@ Parameter
|
|
1400
1383
|
|type\_|Tystr| |
|
1401
1384
|
+------+-----+-----------------+
|
1402
1385
|
|
1403
|
-
|
1404
|
-
|
1386
|
+
Method: sh_path_cfg_yaml
|
1387
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1405
1388
|
|
1406
1389
|
Parameter
|
1407
1390
|
"""""""""
|
@@ -1417,8 +1400,8 @@ Parameter
|
|
1417
1400
|
|type\_|str | |
|
1418
1401
|
+------+-----+-----------------+
|
1419
1402
|
|
1420
|
-
|
1421
|
-
|
1403
|
+
Method: sh_path_cfg_yaml
|
1404
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1422
1405
|
|
1423
1406
|
Parameter
|
1424
1407
|
"""""""""
|
@@ -1444,8 +1427,8 @@ Parameter
|
|
1444
1427
|
|\**kwargs|TyAny|keyword arguments|
|
1445
1428
|
+---------+-----+-----------------+
|
1446
1429
|
|
1447
|
-
|
1448
|
-
|
1430
|
+
Method: sh_path_cfg_yaml
|
1431
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1449
1432
|
|
1450
1433
|
Parameter
|
1451
1434
|
"""""""""
|
@@ -1465,8 +1448,8 @@ Parameter
|
|
1465
1448
|
|\**kwargs|TyAny|keyword arguments|
|
1466
1449
|
+---------+-----+-----------------+
|
1467
1450
|
|
1468
|
-
|
1469
|
-
|
1451
|
+
Method: sh_path_cfg_yaml
|
1452
|
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
1470
1453
|
|
1471
1454
|
Parameter
|
1472
1455
|
"""""""""
|
@@ -1482,8 +1465,8 @@ Parameter
|
|
1482
1465
|
|filename|TyStr| |
|
1483
1466
|
+--------+-----+-----------------+
|
1484
1467
|
|
1485
|
-
|
1486
|
-
|
1468
|
+
Method: sh_d_pacmod
|
1469
|
+
^^^^^^^^^^^^^^^^^^^
|
1487
1470
|
|
1488
1471
|
Parameter
|
1489
1472
|
"""""""""
|
@@ -1502,22 +1485,22 @@ Parameter
|
|
1502
1485
|
I/O Control Modules
|
1503
1486
|
*******************
|
1504
1487
|
|
1505
|
-
jinja2\_.py
|
1506
|
-
|
1488
|
+
Module jinja2\_.py
|
1489
|
+
==================
|
1507
1490
|
|
1508
1491
|
The Module ``jinja2_.py`` contains the single static class Jinja2
|
1509
1492
|
|
1510
|
-
|
1511
|
-
|
1493
|
+
Class: Jinja2
|
1494
|
+
-------------
|
1512
1495
|
|
1513
1496
|
The static Class ``Jinja2`` provides I/O Control methods for Jinja2 files;
|
1514
1497
|
it contains the subsequent methods.
|
1515
1498
|
|
1516
|
-
|
1517
|
-
|
1499
|
+
Methods
|
1500
|
+
^^^^^^^
|
1518
1501
|
|
1519
|
-
.. Methods-of-
|
1520
|
-
.. table:: *Methods of
|
1502
|
+
.. Methods-of-class-Jinja2-label:
|
1503
|
+
.. table:: *Methods of class Jinja2*
|
1521
1504
|
|
1522
1505
|
+-------------+------------------------------+
|
1523
1506
|
|Name |Description |
|
@@ -1527,14 +1510,14 @@ Jinja2 Methods
|
|
1527
1510
|
|read_template|Read log file path with jinja2|
|
1528
1511
|
+-------------+------------------------------+
|
1529
1512
|
|
1530
|
-
|
1531
|
-
|
1513
|
+
Method: read
|
1514
|
+
^^^^^^^^^^^^
|
1532
1515
|
|
1533
1516
|
Parameter
|
1534
1517
|
"""""""""
|
1535
1518
|
|
1536
|
-
.. Parameter-of-
|
1537
|
-
.. table:: *Parameter
|
1519
|
+
.. Parameter-of-method-read-label:
|
1520
|
+
.. table:: *Parameter of method read*
|
1538
1521
|
|
1539
1522
|
+--------+-----+---------------+
|
1540
1523
|
|Name |Type |Description |
|
@@ -1544,14 +1527,14 @@ Parameter
|
|
1544
1527
|
|filename|str | |
|
1545
1528
|
+--------+-----+---------------+
|
1546
1529
|
|
1547
|
-
|
1548
|
-
|
1530
|
+
Method read_template
|
1531
|
+
^^^^^^^^^^^^^^^^^^^^
|
1549
1532
|
|
1550
1533
|
Parameter
|
1551
1534
|
"""""""""
|
1552
1535
|
|
1553
|
-
.. Parameter-of-
|
1554
|
-
.. table:: *Parameter
|
1536
|
+
.. Parameter-of-method-read-template-label:
|
1537
|
+
.. table:: *Parameter of method read template*
|
1555
1538
|
|
1556
1539
|
+--------+-----+---------------+
|
1557
1540
|
|Name |Type |Description |
|
@@ -1561,22 +1544,22 @@ Parameter
|
|
1561
1544
|
|filename|TnAny| |
|
1562
1545
|
+--------+-----+---------------+
|
1563
1546
|
|
1564
|
-
yaml\_.py
|
1565
|
-
|
1547
|
+
Module yaml\_.py
|
1548
|
+
================
|
1566
1549
|
|
1567
1550
|
The Module ``yaml_.py`` contains one static class ``Yaml``
|
1568
1551
|
|
1569
|
-
|
1570
|
-
|
1552
|
+
Class Yaml
|
1553
|
+
----------
|
1571
1554
|
|
1572
1555
|
The static Class ``Yaml`` provides I/O Control functions for Yaml files;
|
1573
1556
|
it contains the subsequent methods
|
1574
1557
|
|
1575
|
-
|
1576
|
-
|
1558
|
+
Methods
|
1559
|
+
^^^^^^^
|
1577
1560
|
|
1578
|
-
.. Yaml-
|
1579
|
-
.. table:: *Yaml
|
1561
|
+
.. Methods-of-class-Yaml-label:
|
1562
|
+
.. table:: *Methods of class Yaml*
|
1580
1563
|
|
1581
1564
|
+----+------------------------------------------------------+
|
1582
1565
|
|Name|Description |
|
@@ -1588,14 +1571,14 @@ Yaml Methods
|
|
1588
1571
|
| |Default loader is yaml.safeloader |
|
1589
1572
|
+----+------------------------------------------------------+
|
1590
1573
|
|
1591
|
-
|
1592
|
-
|
1574
|
+
Method load
|
1575
|
+
^^^^^^^^^^^
|
1593
1576
|
|
1594
1577
|
Parameter
|
1595
1578
|
"""""""""
|
1596
1579
|
|
1597
|
-
.. Parameter-of-
|
1598
|
-
.. table:: *Parameter
|
1580
|
+
.. Parameter-of-method-load-label:
|
1581
|
+
.. table:: *Parameter of method load*
|
1599
1582
|
|
1600
1583
|
+------+-----+--------------+
|
1601
1584
|
|Name |Type |Description |
|
@@ -1605,14 +1588,14 @@ Parameter
|
|
1605
1588
|
|loader|TyStr| |
|
1606
1589
|
+------+-----+--------------+
|
1607
1590
|
|
1608
|
-
|
1609
|
-
|
1591
|
+
Method read
|
1592
|
+
^^^^^^^^^^^
|
1610
1593
|
|
1611
1594
|
Parameter
|
1612
1595
|
"""""""""
|
1613
1596
|
|
1614
|
-
.. Parameter-of-
|
1615
|
-
.. table:: *Parameter
|
1597
|
+
.. Parameter-of-method-read-label:
|
1598
|
+
.. table:: *Parameter of method read*
|
1616
1599
|
|
1617
1600
|
+------+-----+--------------+
|
1618
1601
|
|Name |Type |Description |
|