ka-uts-com 1.0.0.240823__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.
Files changed (41) hide show
  1. build/lib/dist/ka_uts_com-1.0.0.240823-py3-none-any.whl +0 -0
  2. build/lib/dist/ka_uts_com-1.0.0.240823.tar.gz +0 -0
  3. build/lib/ka_uts_com/__init__.py +0 -0
  4. build/lib/ka_uts_com/__version__.py +10 -0
  5. build/lib/ka_uts_com/aeq.py +87 -0
  6. build/lib/ka_uts_com/argv.py +49 -0
  7. build/lib/ka_uts_com/com.py +222 -0
  8. build/lib/ka_uts_com/data/__init__.py +0 -0
  9. build/lib/ka_uts_com/data/log.personal.yml +93 -0
  10. build/lib/ka_uts_com/data/log.standard.yml +86 -0
  11. build/lib/ka_uts_com/date.py +15 -0
  12. build/lib/ka_uts_com/fnc.py +37 -0
  13. build/lib/ka_uts_com/ioc.py +57 -0
  14. build/lib/ka_uts_com/log.py +63 -0
  15. build/lib/ka_uts_com/pacmod.py +111 -0
  16. build/lib/ka_uts_com/py.typed +0 -0
  17. build/lib/ka_uts_com/str.py +268 -0
  18. build/lib/ka_uts_com/timer.py +72 -0
  19. dist/ka_uts_com-1.0.0.240823-py3-none-any.whl +0 -0
  20. dist/ka_uts_com-1.0.0.240823.tar.gz +0 -0
  21. ka_uts_com/__init__.py +0 -0
  22. ka_uts_com/__version__.py +10 -0
  23. ka_uts_com/aeq.py +87 -0
  24. ka_uts_com/argv.py +49 -0
  25. ka_uts_com/com.py +222 -0
  26. ka_uts_com/data/__init__.py +0 -0
  27. ka_uts_com/data/log.personal.yml +93 -0
  28. ka_uts_com/data/log.standard.yml +86 -0
  29. ka_uts_com/date.py +15 -0
  30. ka_uts_com/fnc.py +37 -0
  31. ka_uts_com/ioc.py +57 -0
  32. ka_uts_com/log.py +63 -0
  33. ka_uts_com/pacmod.py +111 -0
  34. ka_uts_com/py.typed +0 -0
  35. ka_uts_com/str.py +268 -0
  36. ka_uts_com/timer.py +72 -0
  37. ka_uts_com-1.0.0.240823.dist-info/LICENSE.txt +19 -0
  38. ka_uts_com-1.0.0.240823.dist-info/METADATA +943 -0
  39. ka_uts_com-1.0.0.240823.dist-info/RECORD +41 -0
  40. ka_uts_com-1.0.0.240823.dist-info/WHEEL +5 -0
  41. ka_uts_com-1.0.0.240823.dist-info/top_level.txt +4 -0
ka_uts_com-1.0.0.240823.dist-info/METADATA ADDED
@@ -0,0 +1,943 @@
1
+ Metadata-Version: 2.1
2
+ Name: ka_uts_com
3
+ Version: 1.0.0.240823
4
+ Summary: Communication Class Utilities
5
+ Author-email: Bernd Stroehle <bernd.stroehle@bs29.com>
6
+ Maintainer-email: Bernd Stroehle <bernd.stroehle@bs29.com>
7
+ Project-URL: Source Code, https://github.com/bs29/ka_uts_com/tree/master
8
+ Project-URL: Homepage, https://kosakya.de/
9
+ 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
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Natural Language :: English
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Requires-Python: >=3.10
19
+ Description-Content-Type: text/x-rst
20
+ License-File: LICENSE.txt
21
+ Requires-Dist: Jinja2>=3.1.4
22
+ Requires-Dist: orjson>=3.10.12
23
+ Requires-Dist: PyYAML>=6.0.2
24
+ Requires-Dist: setuptools>=75.4.0
25
+ Requires-Dist: simplejson>=3.19.3
26
+
27
+ ##########
28
+ ka_uts_com
29
+ ##########
30
+
31
+ Overview
32
+ ********
33
+
34
+ .. start short_desc
35
+
36
+ **Communication Utilities**
37
+
38
+ .. end short_desc
39
+
40
+ Installation
41
+ ************
42
+ .. start installation
43
+
44
+ The package ``ka_uts_com`` can be installed from PyPI or Anaconda.
45
+
46
+ To install with ``pip``:
47
+
48
+ .. code-block:: shell
49
+
50
+ $ python -m pip install ka_uts_com
51
+
52
+ To install with ``conda``:
53
+
54
+ .. code-block:: shell
55
+
56
+ $ conda install -c conda-forge ka_uts_com
57
+
58
+ .. end installation
59
+
60
+ This requires that the ``readme`` extra is installed:
61
+
62
+ .. code-block:: bash
63
+
64
+ $ python -m pip install ka_uts_com[readme]
65
+
66
+ Configuration
67
+ *************
68
+
69
+ The Configuration of standard or personal (tenant specific) Package logging can be defined in Yaml Configuration Files in the data directory <Package Name>/data of the Package.
70
+
71
+ .. logging-configuration-files-label:
72
+ .. table:: *Logging Configuration Files*
73
+
74
+ +--------+----------------+---------------+-----------------------------------------------+
75
+ |Type |Name |Directory |Description |
76
+ +========+================+=========+=====+===============================================+
77
+ |standard|log.standard.yml|ka_uts_com/data|the Python Logger compatible stabdard Yaml |
78
+ | | | |config. file is used to define standard logging|
79
+ +--------+----------------+ +-----------------------------------------------+
80
+ |personal|log.personal.yml| |the Python Logger compatible personal Yaml |
81
+ | | | |config. file is used to define personal logging|
82
+ +--------+----------------+---------------+-----------------------------------------------+
83
+
84
+ Modules
85
+ *******
86
+
87
+ Classification
88
+ ==============
89
+
90
+ The Modules of Package ``ka_uts_com`` could be classified into the follwing module types:
91
+
92
+ .. Module-classification-types-label:
93
+ .. table:: *Modules-classification-types*
94
+
95
+ +-------------------------------------------------------------+
96
+ |Module |
97
+ +--------------+---------------+------------------------------+
98
+ |Name |Type |Functionality |
99
+ +==============+===============+==============================+
100
+ |aeq.py |Data Utility |Equate array processing |
101
+ +--------------+---------------+------------------------------+
102
+ |argv.py |Data Utility |Argument value processing |
103
+ +--------------+---------------+------------------------------+
104
+ |date.py |Data Utility |Date processing |
105
+ +--------------+---------------+------------------------------+
106
+ |str.py |Data utility |String processing |
107
+ +--------------+---------------+------------------------------+
108
+ |com.py |Base |Communication management |
109
+ +--------------+---------------+------------------------------+
110
+ |fnc.py |Function |Function processing |
111
+ +--------------+---------------+------------------------------+
112
+ |ioc.py |I/O |I/O management |
113
+ +--------------+---------------+------------------------------+
114
+ |log.py |Log |Log management |
115
+ +--------------+---------------+------------------------------+
116
+ |pacmod.py |Package/Module |Package and module management |
117
+ +--------------+---------------+------------------------------+
118
+ |timer.py |Timer |Timer management |
119
+ +--------------+---------------+------------------------------+
120
+ |__init__.py |Special |Package directory marker |
121
+ +--------------+---------------+------------------------------+
122
+ |__version__.py|Special |Version handling |
123
+ +--------------+---------------+------------------------------+
124
+
125
+ Special Modules
126
+ ===============
127
+
128
+ .. Special-modules-label:
129
+ .. table:: *Special Modules*
130
+
131
+ +--------------+---------+----------------------------------------------+
132
+ |Name |Type |Statements |
133
+ +==============+=========+==============================================+
134
+ |__init__.py |Package |Module with no Statements. |
135
+ | |directory|The module is used to mark the directory it |
136
+ | |marker |contains as a package. A dummy Module enforces|
137
+ | | |explicit imports and thus clear namesoace use |
138
+ | | |and call them with the dotnotation. |
139
+ +--------------+---------+----------------------------------------------+
140
+ |__version__.py|Version |Assignment Statements for Version System |
141
+ | | |Variables. |
142
+ +--------------+---------+----------------------------------------------+
143
+
144
+ Special Module: __version__.py
145
+ ------------------------------
146
+
147
+ Variables
148
+ ^^^^^^^^^
149
+
150
+ The Module ``__version__.py`` contains no classes, but assignment statements for
151
+ system variables used by versioning.
152
+
153
+ .. Variables-of-module-__version__-label:
154
+ .. table:: *Variables of module __version__*
155
+
156
+ +---------------------------------------------------------+
157
+ |Variable |
158
+ +---------------+-----------------------------------------+
159
+ |Name |Example |
160
+ +===============+=========================================+
161
+ |__title__ |'ka_uts_com' |
162
+ +---------------+-----------------------------------------+
163
+ |__description__|'Communication Area Utilities.' |
164
+ +---------------+-----------------------------------------+
165
+ |__url__ |'https://ka-com.readthedocs.io/en/latest'|
166
+ +---------------+-----------------------------------------+
167
+ |__version___ |'2023.2.2' |
168
+ +---------------+-----------------------------------------+
169
+ |__build__ |0x022200 |
170
+ +---------------+-----------------------------------------+
171
+ |__author_email_|'Bernd Stroehle' |
172
+ +---------------+-----------------------------------------+
173
+ |__license__ |'Apache-2.0' |
174
+ +---------------+-----------------------------------------+
175
+ |__copyright__ |'Copyright 2023 bs29' |
176
+ +---------------+-----------------------------------------+
177
+ |__cake__ |u'\u2728 \U0001f370 \u2728' |
178
+ +---------------+-----------------------------------------+
179
+
180
+ Data Utility Module: aeq.py
181
+ ===========================
182
+
183
+ Static classes
184
+ --------------
185
+
186
+ The Module ``aeq.py`` contains the subsequent static class.
187
+
188
+ .. Static-class-of-module-awq-label:
189
+ .. table:: *Static class of Module aeq*
190
+
191
+ +---------------------------------------------------+
192
+ |Static Class |
193
+ +-----+---------------------------------------------+
194
+ |Name |Description |
195
+ +=====+=============================================+
196
+ |Aeq |Manage Commandline Arguments as Equate String|
197
+ +-----+---------------------------------------------+
198
+
199
+ static Class: Aeq
200
+ -----------------
201
+
202
+ The static Class ``Aeq`` contains the subsequent methods.
203
+
204
+ Methods
205
+ ^^^^^^^
206
+
207
+ .. Methods-of-class-Aeq-label:
208
+ .. table:: *Methods of class Aeq*
209
+
210
+ +------------------------------+-----------------------------------------------+
211
+ |Method |Parameter / Return Value |
212
+ +--------+---------------------+-------------+------+---+----------------------+
213
+ |Name | |Name |Type |P/R|Description |
214
+ +========+=====================+=============+======+===+======================+
215
+ |sh_value|Show value of equate |cls |class |P |current class |
216
+ | |string provided by +-------------+------+---+----------------------+
217
+ | |single command line |key |str |P |Key of equate string |
218
+ | |argument +-------------+------+---+----------------------+
219
+ | | |value |Any |P |Value of equate string|
220
+ | | +-------------+------+---+----------------------+
221
+ | | |d_valid_parms|TN_Dic|P |Dictionary of valid |
222
+ | | | | | |keys (parameters) |
223
+ | | +-------------+------+---+----------------------+
224
+ | | |value |Any |RV |converted Value of the|
225
+ | | | | | |equate-string |
226
+ | | | | | |according Value type |
227
+ | | | | | |d_valid_parms |
228
+ +--------+---------------------+-------------+------+---+----------------------+
229
+ |sh_d_eq |Show Dictionary creat|cls |class |P |current class |
230
+ | |created by parsing +-------------+------+---+----------------------+
231
+ | |array of equate |a_s_eq |T_Arr |P |array of equate |
232
+ | |strings provided by | | | |strings |
233
+ | |commandline arguments+-------------+------+---+----------------------+
234
+ | | |d_valid_parms|TN_Dic|P |Dictionary of valid |
235
+ | | | | | |parameter-keys |
236
+ | | +-------------+------+---+----------------------+
237
+ | | |d_eq |TN_Dic|RV |Dictiony of parameter |
238
+ | | | | | |key, values |
239
+ +--------+---------------------+-------------+------+---+----------------------+
240
+
241
+ Data Utility Module: argv.py
242
+ ============================
243
+
244
+ Static classes
245
+ --------------
246
+
247
+ The Module ``argv.py`` contains the subsequent static class.
248
+
249
+ .. Static-class-of-module-argv-label:
250
+ .. table:: *Static class of Module argv*
251
+
252
+ +---------------------------------------------------+
253
+ |Static Class |
254
+ +-----+---------------------------------------------+
255
+ |Name |Description |
256
+ +=====+=============================================+
257
+ |Argv |Manage Commandline Arguments as Equate String|
258
+ +-----+---------------------------------------------+
259
+
260
+ Static Class: Argv
261
+ ------------------
262
+
263
+ The static Class ``Argv`` contains the subsequent variables and methods
264
+
265
+ Variables
266
+ ^^^^^^^^^
267
+
268
+ .. Static-variables-of-class-Argv-label:
269
+ .. table:: *Static variables of class Argv*
270
+
271
+ +------------------------------------------------------------------+
272
+ |Static Variable |
273
+ +---------------+--------+-------+---------------------------------+
274
+ |Name |Type |Default|Description |
275
+ +===============+========+=======+=================================+
276
+ |sw_init |T_Bool |False |initialisation switch |
277
+ +---------------+--------+-------+---------------------------------+
278
+ |httpmod |T_Dic |None |http modus |
279
+ +---------------+--------+-------+---------------------------------+
280
+ |sw_replace_keys|TN_Bool |False |replace keys switch |
281
+ +---------------+--------+-------+---------------------------------+
282
+ |keys |TN_Arr |None |Keys array |
283
+ +---------------+--------+-------+---------------------------------+
284
+ |reqs |T_Dic |None |Requests dictionary |
285
+ +---------------+--------+-------+---------------------------------+
286
+ |app |T_Dic |None |Appliction dictionary |
287
+ +---------------+--------+-------+---------------------------------+
288
+
289
+ Methods
290
+ ^^^^^^^
291
+
292
+ .. Methods-of-class-Argv-label:
293
+ .. table:: *Methods of class Argv*
294
+
295
+ +--------------------------------+-------------------------------------+
296
+ |Method |Parameter / Return Value |
297
+ +-------------+------------------+---------+--------+----+-------------+
298
+ |Name |Description |Name |Type |P/RV|Description |
299
+ +=============+==================+=========+========+====+=============+
300
+ |set_by_pacmod|set current pacmod|d_eq |T_Dic |P |Dictionary of|
301
+ | |dictionary | | | |equates |
302
+ | | +---------+--------+----+-------------+
303
+ | | |root_cls |Class |P |Root Class |
304
+ +-------------+------------------+---------+--------+----+-------------+
305
+ |set_d_eq |set current pacmod|d_eq |T_Dic |P |Dictionary of|
306
+ | |dictionary | | | |equates |
307
+ | | +---------+--------+----+-------------+
308
+ | | |root_cls |Class |P |Root Class |
309
+ +-------------+------------------+---------+--------+----+-------------+
310
+
311
+ Base Module: com
312
+ ================
313
+
314
+ static Classes
315
+ --------------
316
+
317
+ .. Static-classes-of-base-modul-com-label:
318
+ .. table:: *Static classes of base modul com*
319
+
320
+ +------------------------------------------------+
321
+ |Static Classes |
322
+ +-----------+------------------------------------+
323
+ |Name |Description |
324
+ +===========+====================================+
325
+ |App |Application management class |
326
+ +-----------+------------------------------------+
327
+ |Cfg |Configuration class |
328
+ +-----------+------------------------------------+
329
+ |Com |Communication management class |
330
+ +-----------+------------------------------------+
331
+ |Exit |Exit processing class |
332
+ +-----------+------------------------------------+
333
+ |LogPersonal|Personal logging class |
334
+ +-----------+------------------------------------+
335
+ |LogStandard|Standard logging class |
336
+ +-----------+------------------------------------+
337
+ |Mgo |Mongo DB class |
338
+ +-----------+------------------------------------+
339
+
340
+ static Class: App
341
+ -----------------
342
+
343
+ The static Class ``App`` contains the subsequent static variables and methods
344
+
345
+ Variables
346
+ ^^^^^^^^^
347
+
348
+ .. Variables-of-static-class-App-label:
349
+ .. table:: *Variables of static class App*
350
+
351
+ +-----------------------------------------------------+
352
+ |Static Variable |
353
+ +---------------+-------+-------+---------------------+
354
+ |Name |Type |Default|Description |
355
+ +===============+=======+=======+=====================+
356
+ |sw_init |T_Bool |False |initialisation switch|
357
+ +---------------+-------+-------+---------------------+
358
+ |httpmod |T_Dic |None |http modus |
359
+ +---------------+-------+-------+---------------------+
360
+ |sw_replace_keys|TN_Bool|False |replace keys switch |
361
+ +---------------+-------+-------+---------------------+
362
+ |keys |TN_Arr |None |Keys array |
363
+ +---------------+-------+-------+---------------------+
364
+ |reqs |T_Dic |None |Requests dictionary |
365
+ +---------------+-------+-------+---------------------+
366
+ |app |T_Dic |None |Appliction dictionary|
367
+ +---------------+-------+-------+---------------------+
368
+
369
+ Methods
370
+ ^^^^^^^
371
+
372
+ .. Methods-of-static-class-App-label:
373
+ .. table:: *Methods of static class App*
374
+
375
+ +--------------------------------+--------------------------------------+
376
+ |Method |Parameter / Return Value |
377
+ +----+---------------------------+---------+------+---+-----------------+
378
+ |Name|Description |Name |Type |P/R|Description |
379
+ +====+===========================+=========+======+===+=================+
380
+ |init|initialise static variables|cls |class |P |current class |
381
+ | |of class if they are not +---------+------+---+-----------------+
382
+ | |allready initialized |\**kwargs|list |P |Keyword arguments|
383
+ +----+---------------------------+---------+------+---+-----------------+
384
+ |sh |show (return) class |cls |class |P |current class |
385
+ | | +---------+------+---+-----------------+
386
+ | | |\**kwargs|list |P |Keyword arguments|
387
+ | | +---------+------+---+-----------------+
388
+ | | |log |Logger|R | |
389
+ +----+---------------------------+---------+------+---+-----------------+
390
+
391
+ static Class: Cfg
392
+ -----------------
393
+
394
+ The static Class ``Cfg`` contains the subsequent methods.
395
+
396
+ Methods
397
+ ^^^^^^^
398
+
399
+ .. Methods-of-static-class-Cfg-label:
400
+ .. table:: *Methods of static class Cfg*
401
+
402
+ +-----------------------------------+--------------------------------+
403
+ |Method |Parameter / Return Value |
404
+ +----+------------------------------+------+------+----+-------------+
405
+ |Name|Description |Name |Type |P/RV|Description |
406
+ +====+==============================+======+======+====+=============+
407
+ |init|read pacmod yaml file into |cls |class |P |current class|
408
+ | |dictionary variable _dic and +------+------+----+-------------+
409
+ | |return _dic |pacmod|T_Dic |P |pacmod |
410
+ | | | | | |dictionary |
411
+ | | +------+------+----+-------------+
412
+ | | |_dic |TN_Dic|RV | |
413
+ +----+------------------------------+------+------+----+-------------+
414
+
415
+ static Class: Exit
416
+ ------------------
417
+
418
+ .. Variables-of-static-class-Exit-label:
419
+ .. table:: *Static Variables of class Exit*
420
+
421
+ +----------------------------------------------------------------+
422
+ |Variable |
423
+ +--------------+-------+-------+---------------------------------+
424
+ |Name |Type |Default|Description |
425
+ +==============+=======+=======+=================================+
426
+ |sw_critical |T_Bool |False |critical switch |
427
+ +--------------+-------+-------+---------------------------------+
428
+ |sw_stop |T_Bool |False |stop switch |
429
+ +--------------+-------+-------+---------------------------------+
430
+ |sw_interactive|T_Bool |False |interactive switch |
431
+ +--------------+-------+-------+---------------------------------+
432
+
433
+ static Class: Com
434
+ -----------------
435
+
436
+ The static Class ``Com`` contains the subsequent variables and methods
437
+
438
+ Variables
439
+ ^^^^^^^^^
440
+
441
+ .. Variables-of-static-class-Com-label:
442
+ .. table:: *Variables of static class Com*
443
+
444
+ +-----------------------------------------------+
445
+ |Variable |
446
+ +-------+------+-------+------------------------+
447
+ |Name |Type |Default|Description |
448
+ +=======+======+=======+========================+
449
+ |cfg |T_Dic |None |Configuration dictionary|
450
+ +-------+------+-------+------------------------+
451
+ |log |Logger|None |logging Method |
452
+ +-------+------+-------+------------------------+
453
+ |sw_init|T_Bool|False |initialisation switch |
454
+ +-------+------+-------+------------------------+
455
+
456
+ Methods
457
+ ^^^^^^^
458
+
459
+ .. Methods-of-static-class-Com-label:
460
+ .. table:: *Methods of static class Com*
461
+
462
+ +-----------------------------------+--------------------------------------+
463
+ |Method |Parameter / Return Value |
464
+ +----+------------------------------+---------+-----+----+-----------------+
465
+ |Name|Description |Name |Type |P/RV|Description |
466
+ +====+==============================+=========+=====+====+=================+
467
+ |init|initialise static variables |cls |class|P |current class |
468
+ | |if they are not allready +---------+-----+----+-----------------+
469
+ | |initialized |\**kwargs|list |P |keyword arguments|
470
+ +----+------------------------------+---------+-----+----+-----------------+
471
+
472
+ static Class: LogPersonal
473
+ -------------------------
474
+
475
+ The static Class ``LogPersonal`` contains the subsequent static variables and methods.
476
+
477
+ Variables
478
+ ^^^^^^^^^
479
+
480
+ .. Variables-of-ststic-class-LogPersonal-label:
481
+ .. table:: *Variables of static class LogPersonal*
482
+
483
+ +--------------------------------------------------------+
484
+ |Static Variable |
485
+ +-------+------+-------+---------------------------------+
486
+ |Name |Type |Default|Description |
487
+ +=======+======+=======+=================================+
488
+ |sw_init|T_Bool|False |initialisation switch |
489
+ +-------+------+-------+---------------------------------+
490
+ |cfg |T_Dic |None |Configuration dictionary |
491
+ +-------+------+-------+---------------------------------+
492
+ |log |Logger|None |logging function |
493
+ +-------+------+-------+---------------------------------+
494
+ |logfile|str |None |Logfile name |
495
+ +-------+------+-------+---------------------------------+
496
+
497
+ Methods
498
+ ^^^^^^^
499
+
500
+ .. Methods-of-ststic-class-LogPersonal-label:
501
+ .. table:: *Methods of static class LogPersonal*
502
+
503
+ +----------------------------------+-----------------------------------------+
504
+ |Method |Parameter / Return Value |
505
+ +---------+------------------------+---------+--------+----+-----------------+
506
+ |Name |Description |Name |Type |P/RV|Description |
507
+ +=========+========================+=========+========+====+=================+
508
+ |init |Initialize static class |cls |class |P |current class |
509
+ | |variables if they are +---------+--------+----+-----------------+
510
+ | |not allready initialized|\**kwargs| |P |keywords |
511
+ +---------+------------------------+---------+--------+----+-----------------+
512
+ |read | |pacmod |T_Dic |P |pacmod dictionary|
513
+ | | +---------+--------+----+-----------------+
514
+ | | |filename |str |P | |
515
+ | | +---------+--------+----+-----------------+
516
+ | | |log_main |str |RV | |
517
+ +---------+------------------------+---------+--------+----+-----------------+
518
+ |set_level|set static variable log |sw_debug |bool |P |debug switch |
519
+ | |level in log | | | | |
520
+ | |configuration handlers | | | | |
521
+ +---------+------------------------+---------+--------+----+-----------------+
522
+ |sh |show static Logger |cls |class |P |current class |
523
+ | |variable log +---------+--------+----+-----------------+
524
+ | | |\**kwargs| |P |keyword arguments|
525
+ | | +---------+--------+----+-----------------+
526
+ | | |log |Logger |P | |
527
+ +---------+------------------------+---------+--------+----+-----------------+
528
+
529
+ Static class: LogStandard
530
+ -------------------------
531
+
532
+ The static Class ``LogStandard`` contains the subsequent variables and methods
533
+
534
+ Variables
535
+ ^^^^^^^^^
536
+
537
+ .. Variables-of-static-class-LogStandard-label:
538
+ .. table:: *Variables of static class LogStandard*
539
+
540
+ +---------------------------------------------------------+
541
+ |Variable |
542
+ +-------+-------+-------+---------------------------------+
543
+ |Name |Type |Default|Description |
544
+ +=======+=======+=======+=================================+
545
+ |sw_init|T_Bool |False |initialisation switch |
546
+ +-------+-------+-------+---------------------------------+
547
+ |cfg |T_Dic |None |Configuration dictionary |
548
+ +-------+-------+-------+---------------------------------+
549
+ |log |Logger |None |logging function |
550
+ +-------+-------+-------+---------------------------------+
551
+ |logfile|T_Str |None |Logfile name |
552
+ +-------+-------+-------+---------------------------------+
553
+
554
+ Methods
555
+ ^^^^^^^
556
+
557
+ .. Methods-of-static-class-LogStandard-label:
558
+ .. table:: *Methods of static class LogStandard*
559
+
560
+ +-----------------------------------+-------------------------------------+
561
+ |Method |Parameter / Return Value |
562
+ +---------+-------------------------+---------+--------+----+-------------+
563
+ |Name |Description |Name |Type |P/RV|Description |
564
+ +=========+=========================+=========+========+====+=============+
565
+ |read |Read log file path with |pacmod |T_Dic |P | |
566
+ | |jinja2 I/O utility +---------+--------+----+-------------+
567
+ | | |filename |str |P | |
568
+ | | +---------+--------+----+-------------+
569
+ | | |log_main |str |RV | |
570
+ +---------+-------------------------+---------+--------+----+-------------+
571
+ |set_level|Set static variable log |sw_debug |bool |P | |
572
+ | |level in log | | | | |
573
+ | |configuration handlers | | | | |
574
+ +---------+-------------------------+---------+--------+----+-------------+
575
+ |init |initialise static |cls |class |P |current class|
576
+ | |variables of class if +---------+--------+----+-------------+
577
+ | |if they are not allready |\**kwargs| |P | |
578
+ | |initialized | | | | |
579
+ +---------+-------------------------+---------+--------+----+-------------+
580
+ |sh |show static Logger |cls |class |P |current class|
581
+ | |variable +---------+--------+----+-------------+
582
+ | | |\**kwargs| |P |Keywords |
583
+ | | +---------+--------+----+-------------+
584
+ | | |log |Logger |RV | |
585
+ +---------+-------------------------+---------+--------+----+-------------+
586
+
587
+ Utility module: ioc.py
588
+ ======================
589
+
590
+ The Module ``ioc.py`` provides Classes with I/O Control methods for files;
591
+ it contains the subsequent classes classified by the supported file type.
592
+
593
+ Static Classes
594
+ --------------
595
+
596
+ .. Static-classes-of-utility-module-ioc-label:
597
+ .. table:: *Static classes of utility module ioc*
598
+
599
+ +--------------------------------------------+
600
+ |Static Classes |
601
+ +-------+------------------------------------+
602
+ |Name |Description |
603
+ +=======+====================================+
604
+ |Jinja2 |I/O Control for Jinja2 files |
605
+ +-------+------------------------------------+
606
+ |Yaml |I/O Control for Yaml files |
607
+ +-------+------------------------------------+
608
+
609
+ static Class: Jinja2
610
+ --------------------
611
+
612
+ The static Class ``Jinja2`` provides I/O Control methods for Jinja2 files;
613
+ it contains the subsequent methods.
614
+
615
+ Methods
616
+ ^^^^^^^
617
+
618
+ .. Methods-of-static-class-Jinja2-label:
619
+ .. table:: *Methods of static class Jinja2*
620
+
621
+ +--------------------------------+------------------------------------+
622
+ |Method |Parameter / Return Value |
623
+ +-------------+------------------+---------+------+---+---------------+
624
+ |Name |Description |Name |Type |P/R|Description |
625
+ +=============+==================+=========+======+===+===============+
626
+ |read |Read log file path|pacmod |TN_Dic|P | |
627
+ | |with jinja +---------+------+---+---------------+
628
+ | | |filename |str |P | |
629
+ | | +---------+------+---+---------------+
630
+ | | | |TN_Any|RV |no return value|
631
+ +-------------+------------------+---------+------+---+---------------+
632
+ |read_template|Read log file path|pacmod |TN_Dic|P | |
633
+ | |with jinja2 +---------+------+---+---------------+
634
+ | | |filename |TN_Any|P | |
635
+ | | +---------+------+---+---------------+
636
+ | | | |TN_Any|RV |no return value|
637
+ +-------------+------------------+---------+------+---+---------------+
638
+
639
+ static Class: Yaml
640
+ ------------------
641
+
642
+ The static Class ``Yaml`` provides I/O Control methods for Yaml files;
643
+ it contains the subsequent variables and methods
644
+
645
+ Methods
646
+ ^^^^^^^
647
+
648
+ .. Methods-of-static-class-Yaml-label:
649
+ .. table:: methods of static class Yaml*
650
+
651
+ +-------------------------------+-------------------------------------+
652
+ |Method |Parameter / Return Value |
653
+ +----+--------------------------+---------+------+----+---------------+
654
+ |Name|Description |Name |Type |P/RV|Description |
655
+ +====+==========================+=========+======+====+===============+
656
+ |load|Load yaml string into any |string |str |P | |
657
+ | |object using yaml loader; +---------+------+----+---------------+
658
+ | |default is yaml.safeloader|loader |str |P | |
659
+ | | +---------+------+----+---------------+
660
+ | | | |TN_Any|RV |no return value|
661
+ +----+--------------------------+---------+------+----+---------------+
662
+ |read|Read yaml file path into |path |str |P | |
663
+ | |any object using yaml +---------+------+----+---------------+
664
+ | |loader; default loader is |loader |str |P | |
665
+ | |yaml.safeloader +---------+------+----+---------------+
666
+ | | | |TN_Any|RV |no return value|
667
+ +----+--------------------------+---------+------+----+---------------+
668
+
669
+ Utility Module: log.py
670
+ ======================
671
+
672
+ The Module ``log`` provides Classes with I/O Control methods for log files;
673
+ it contains the following static classes.
674
+
675
+
676
+ .. Static-classes-of-utility-module-log-label:
677
+ .. table:: Static classes of utility module log*
678
+
679
+ +------------------------------------------+
680
+ |Static Classes |
681
+ +-----+------------------------------------+
682
+ |Name |Description |
683
+ +=====+====================================+
684
+ |Log |Log Management |
685
+ +-----+------------------------------------+
686
+
687
+ Static Class: Log
688
+ -----------------
689
+
690
+ Variables
691
+ ^^^^^^^^^
692
+
693
+ .. Variables-of-static-class-Log-label:
694
+ .. table:: Variables of static class Log*
695
+
696
+ +-------+------+-------+---------------------------------+
697
+ |Name |Type |Default|Description |
698
+ +=======+======+=======+=================================+
699
+ |sw_init|T_Bool|False |initialisation switch |
700
+ +-------+------+-------+---------------------------------+
701
+ |cfg |T_Dic |None |Configuration dictionary |
702
+ +-------+------+-------+---------------------------------+
703
+ |log |Logger|None |logging function |
704
+ +-------+------+-------+---------------------------------+
705
+
706
+ Sub-Classes
707
+ ^^^^^^^^^^^
708
+
709
+ The Class ``Log`` contains the following static sub-classes.
710
+
711
+ .. Static-sub-classes-of-static-class-Log-label:
712
+ .. table:: Static sub-classes of static class Log*
713
+
714
+ +---------------------------------------+
715
+ |Sub-class |
716
+ +----+----------------------------------+
717
+ |Name|Description |
718
+ +====+==================================+
719
+ |Eq |Log Management for Equate Messages|
720
+ +----+----------------------------------+
721
+
722
+ Methods
723
+ """""""
724
+
725
+ .. Methods-of-static-class-Log-label:
726
+ .. table:: Methods of static class Log*
727
+
728
+ +---------------------------+---------------------------------------+
729
+ |Method |Parameter / Return Value |
730
+ +-------+-------------------+---------+--------+----+---------------+
731
+ |Name |Description |Name |Type |P/RV|Description |
732
+ +=======+===================+=========+========+====+===============+
733
+ |debug |Log debug message |cls |class |P |current class |
734
+ | | +---------+--------+----+---------------+
735
+ | | |key |Any |P | |
736
+ | | +---------+--------+----+---------------+
737
+ | | |value |Any |P | |
738
+ +-------+-------------------+---------+--------+----+---------------+
739
+ |error |Log error message |cls |class |P |current class |
740
+ | | +---------+--------+----+---------------+
741
+ | | |key |Any |P | |
742
+ | | +---------+--------+----+---------------+
743
+ | | |value |Any |P | |
744
+ +-------+-------------------+---------+--------+----+---------------+
745
+ |info |Log info message |cls |class |P |current class |
746
+ | | +---------+--------+----+---------------+
747
+ | | |key |Any |P | |
748
+ | | +---------+--------+----+---------------+
749
+ | | |value |Any |P | |
750
+ +-------+-------------------+---------+--------+----+---------------+
751
+ |warning|Log warning message|cls |class |P |current class |
752
+ | | +---------+--------+----+---------------+
753
+ | | |key |Any |P | |
754
+ | | +---------+--------+----+---------------+
755
+ | | |value |Any |P | |
756
+ +-------+-------------------+---------+--------+----+---------------+
757
+ |sh |show equate message|key |Any |P | |
758
+ | | +---------+--------+----+---------------+
759
+ | | |value |Any |P | |
760
+ | | +---------+--------+----+---------------+
761
+ | | | |str |RV |no return value|
762
+ +-------+-------------------+---------+--------+----+---------------+
763
+
764
+ Utility Module: pacmod.py
765
+ =========================
766
+
767
+ Static Classes
768
+ --------------
769
+
770
+ The utility module ``pacmod`` contains the following static classes.
771
+
772
+ .. Static-classes-of-utility-module-pacmod.py-label:
773
+ .. table:: Static classes of utility module pacmod.py*
774
+
775
+ +-------------------------------------------+
776
+ |Static Classes |
777
+ +------+------------------------------------+
778
+ |Name |Description |
779
+ +======+====================================+
780
+ |Pacmod|Package Module Management |
781
+ +------+------------------------------------+
782
+
783
+ Static Class: Pacmod
784
+ --------------------
785
+
786
+ Methods
787
+ ^^^^^^^
788
+
789
+ .. Methods-of-static-class-Pacmod-label:
790
+ .. table:: *Metods of static class Pacmod*
791
+
792
+ +--------------------------------------------+---------------------------------------+
793
+ |Method |Parameter / Return Value |
794
+ +-----------------+--------------------------+---------+------+----+-----------------+
795
+ |Name |Description |Name |Type |P/RV|Description |
796
+ +=================+==========================+=========+======+====+=================+
797
+ |sh_d_pacmod |create and show (return) |root_cls |class |P |root class |
798
+ | |pacmod dictionary +---------+------+----+-----------------+
799
+ | | |tenant |Any |P | |
800
+ | | +---------+------+----+-----------------+
801
+ | | | |T_Dic |RV |no return value |
802
+ +-----------------+--------------------------+---------+------+----+-----------------+
803
+ |sh_path_cfg_yaml |show pacmod file path of |pacmod |T_Dic |P | |
804
+ | |the yaml file +---------+------+----+-----------------+
805
+ | |<pacmod module>.yaml | |str |RV |no return value |
806
+ | |in the data directory of | | | | |
807
+ | |the current module of the | | | | |
808
+ | |current package | | | | |
809
+ +-----------------+--------------------------+---------+------+----+-----------------+
810
+ |sh_path_keys_yaml|show pacmod file path type|pacmod |T_Dic |P | |
811
+ | |for the yaml file keys.yml+---------+------+----+-----------------+
812
+ | |keys.yml in the data |type\_ |str |P | |
813
+ | |directory of the current +---------+------+----+-----------------+
814
+ | |module of the current | |str |RV |no return value |
815
+ +-----------------+--------------------------+---------+------+----+-----------------+
816
+ |sh_pacmod_type |show pacmod type directory|pacmod |T_Dic |P | |
817
+ | |path +---------+------+----+-----------------+
818
+ | | |type\_ |str |P | |
819
+ | | +---------+------+----+-----------------+
820
+ | | | |str |RV |no return value |
821
+ +-----------------+--------------------------+---------+------+----+-----------------+
822
+ |sh_file_path |show pacmod file path |cls |class |P |current class |
823
+ | | +---------+------+----+-----------------+
824
+ | | |pacmod |T_Dic |P | |
825
+ | | +---------+------+----+-----------------+
826
+ | | |type\_ |str |P | |
827
+ | | +---------+------+----+-----------------+
828
+ | | |suffix |str |P | |
829
+ | | +---------+------+----+-----------------+
830
+ | | |pid |Any |P | |
831
+ | | +---------+------+----+-----------------+
832
+ | | |ts |Any |P | |
833
+ | | +---------+------+----+-----------------+
834
+ | | |\**kwargs| |P |keyword arguments|
835
+ | | +---------+------+----+-----------------+
836
+ | | | |str |RV |no return value |
837
+ +-----------------+--------------------------+---------+------+----+-----------------+
838
+ |sh_pattern |show pacmod file path |pacmod |T_Dic |P | |
839
+ | |pattern +---------+------+----+-----------------+
840
+ | | |type\_ |str |P | |
841
+ | | +---------+------+----+-----------------+
842
+ | | |suffix |str |P | |
843
+ | | +---------+------+----+-----------------+
844
+ | | |\**kwargs| |P |keyword arguments|
845
+ | | +---------+------+----+-----------------+
846
+ | | | |str |RV |no return value |
847
+ +-----------------+--------------------------+---------+------+----+-----------------+
848
+ |sh_path_cfg_log |show file path of log |pacmod |TN_Dic|P | |
849
+ | |configuration file +---------+------+----+-----------------+
850
+ | | |filename |str |P | |
851
+ | | +---------+------+----+-----------------+
852
+ | | | |str |RV |no return value |
853
+ +-----------------+--------------------------+---------+------+----+-----------------+
854
+ |sh_d_pacmod |show pacmod dictionary |cls |class |P |current class |
855
+ | | +---------+------+----+-----------------+
856
+ | | |\**kwargs| |P |keyword arguments|
857
+ +-----------------+--------------------------+---------+------+----+-----------------+
858
+
859
+ Utility Module: timer.py
860
+ ========================
861
+
862
+ Static classes
863
+ --------------
864
+
865
+ The Module ``timer.py`` contains the following static classes.
866
+
867
+ .. Static-classes-of-utility-module-timer.py-label:
868
+ .. table:: *Static classes of utility module timer.py*
869
+
870
+ +----------------------------------------------+
871
+ |Static Classes |
872
+ +---------+------------------------------------+
873
+ |Name |Description |
874
+ +=========+====================================+
875
+ |Timestamp|Timestamop class |
876
+ +---------+------------------------------------+
877
+ |Timer |Timer class |
878
+ +---------+------------------------------------+
879
+
880
+ Static class: Timer
881
+ -------------------
882
+
883
+ Variables
884
+ ^^^^^^^^^
885
+
886
+ .. Variables-of-static-class-Timer-label:
887
+ .. table:: *Variables of static class Timer*
888
+
889
+ +---------------------------------------------------------+
890
+ |Variable |
891
+ +-------+-------+-------+---------------------------------+
892
+ |Name |Type |Default|Description |
893
+ +=======+=======+=======+=================================+
894
+ |sw_init|T_Bool |False |initialisation switch |
895
+ +-------+-------+-------+---------------------------------+
896
+ |cfg |T_Dic |None |Configuration dictionary |
897
+ +-------+-------+-------+---------------------------------+
898
+ |log |Logger |None |logging function |
899
+ +-------+-------+-------+---------------------------------+
900
+
901
+ Methods
902
+ ^^^^^^^
903
+
904
+ .. Methods-of-static-class-Timer-label:
905
+ .. table:: *Methods of static class Timer*
906
+
907
+ +---------------------------------------+--------------------------------------+
908
+ |Method |Parameter / Return Value |
909
+ +---------+-----------------------------+---------+-----+----+-----------------+
910
+ |Name |Description |Name |Type |P/RV|Description |
911
+ +=========+=============================+=========+=====+====+=================+
912
+ |read |Read log file path with |pacmod |T_Dic|P | |
913
+ | |jinja2 +---------+-----+----+-----------------+
914
+ | | |filename |str |P | |
915
+ | | +---------+-----+----+-----------------+
916
+ | | |log_main |str |RV | |
917
+ +---------+-----------------------------+---------+-----+----+-----------------+
918
+ |set_level|Set static variable log level|sw_debug |bool |P | |
919
+ | |in log configuration handlers| | | | |
920
+ +---------+-----------------------------+---------+-----+----+-----------------+
921
+ |init |initialise static variables |cls |class|P |current class |
922
+ | |if they are not allready +---------+-----+----+-----------------+
923
+ | |initialized |\**kwargs| |P |keyword arguments|
924
+ +---------+-----------------------------+---------+-----+----+-----------------+
925
+ |sh |show static variable log |cls |class|P | |
926
+ | | +---------+-----+----+-----------------+
927
+ | | |\**kwargs| |P |keyword arguments|
928
+ +---------+-----------------------------+---------+-----+----+-----------------+
929
+
930
+ Module Data
931
+ ===========
932
+
933
+ +-------------------+-------------------------------------+
934
+ |Name |Description |
935
+ +===================+=====================================+
936
+ |log.main.tenant.yml|'ka_uts_com' |
937
+ |__copyright__ |'Copyright 2023 bs29' |
938
+ +-------------------+-------------------------------------+
939
+
940
+ Appendix
941
+ ========
942
+
943
+ .. contents:: **Table of Content**