ka-uts-com 2.2.2.250430__py3-none-any.whl → 2.2.4.250502__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.
ka_uts_com/__version__.py CHANGED
@@ -1,7 +1,7 @@
1
1
  __title__ = 'ka_uts_com'
2
2
  __description__ = 'Communication Utilities.'
3
3
  __url__ = 'https://ka-ut-com.readthedocs.io/en/latest'
4
- __version__ = '2.2.2.250430'
4
+ __version__ = '2.2.4.250502'
5
5
  __build__ = 0x022200
6
6
  __author__ = 'Bernd Stroehle'
7
7
  __author_email__ = 'bernd.stroehle@gmail.com'
ka_uts_com/app.py CHANGED
@@ -35,7 +35,7 @@ class App:
35
35
  cls.sw_replace_keys = kwargs.get('sw_replace_keys', False)
36
36
  if cls.sw_replace_keys:
37
37
  try:
38
- cls.keys = Yaml_.read_with_safeloader(PacMod.sh_path_keys(cls_com))
38
+ cls.keys = Yaml_.read_with_safeloader(PacMod.sh_path_keys_yml(cls_com))
39
39
  except Exception as exc:
40
40
  Log.error(exc, exc_info=True)
41
41
  raise
ka_uts_com/cfg.py CHANGED
@@ -2,6 +2,7 @@
2
2
  from typing import Any
3
3
 
4
4
  from ka_uts_uts.ioc.yaml_ import Yaml_
5
+ from ka_uts_uts.utils.pacmod import PacMod
5
6
 
6
7
  TyAny = Any
7
8
  TyTimeStamp = int
@@ -21,7 +22,8 @@ class Cfg:
21
22
  if cls.sw_init:
22
23
  return
23
24
  cls.sw_init = True
24
- _path = cls_com.sh_path_cfg_yaml()
25
+ _cls_app = kwargs.get('cls_app')
26
+ _path = PacMod.sh_path_cfg_yml(_cls_app)
25
27
  if _path:
26
28
  cls.cfg = Yaml_.read_with_safeloader(_path)
27
29
 
ka_uts_com/com.py CHANGED
@@ -1,13 +1,11 @@
1
- # coding=utf-8
2
1
  from typing import Any
3
2
 
4
- import os
3
+ # import os
5
4
  import time
6
5
  import calendar
7
6
  from datetime import datetime
8
7
 
9
8
  from ka_uts_equ.equ import AoEqu
10
- from ka_uts_uts.utils.pac import Pac
11
9
  from ka_uts_uts.utils.pacmod import PacMod
12
10
 
13
11
  from ka_uts_com.app import App
@@ -36,16 +34,10 @@ class Com:
36
34
  Communication Class
37
35
  """
38
36
  sw_init: bool = False
39
- dir_dat: TnStr = None
40
37
  tenant: TnStr = None
41
- log_type: TnStr = None
42
38
  cmd: TnStr = None
43
39
  d_com_pacmod: TyDic = {}
44
40
  d_app_pacmod: TyDic = {}
45
- path_bin = None
46
- path_log_cfg = None
47
-
48
- pid = None
49
41
 
50
42
  ts: TnTimeStamp
51
43
  ts_start: TnDateTime = None
@@ -67,17 +59,12 @@ class Com:
67
59
  if cls.sw_init:
68
60
  return
69
61
  cls.sw_init = True
70
- # cls.dir_dat = kwargs.get('dir_dat', '/data')
71
62
  cls.tenant = kwargs.get('tenant')
72
- # cls.log_type = kwargs.get('log_type', 'std')
73
63
  cls.cmd = kwargs.get('cmd')
74
64
  cls_app = kwargs.get('cls_app')
75
65
  cls.d_com_pacmod = PacMod.sh_d_pacmod(cls)
76
66
  cls.d_app_pacmod = PacMod.sh_d_pacmod(cls_app)
77
67
  cls.ts = calendar.timegm(time.gmtime())
78
- cls.pid = os.getpid()
79
-
80
- cls.path_bin = cls.sh_path_bin()
81
68
 
82
69
  cls.Log = Log.sh(**kwargs)
83
70
  cls.Cfg = Cfg.sh(cls, **kwargs)
@@ -95,30 +82,3 @@ class Com:
95
82
 
96
83
  cls.init(_kwargs)
97
84
  return _kwargs
98
-
99
- @classmethod
100
- def sh_path_bin(cls) -> Any:
101
- """
102
- show path to bin directory in package
103
- """
104
- _package = cls.d_app_pacmod['package']
105
- _path = 'bin'
106
- return Pac.sh_path_by_package(_package, _path)
107
-
108
- @classmethod
109
- def sh_path_data(cls) -> Any:
110
- """
111
- show path to data directory in package
112
- """
113
- _package = cls.d_app_pacmod['package']
114
- _path = 'data'
115
- return Pac.sh_path_by_package(_package, _path)
116
-
117
- @classmethod
118
- def sh_path_cfg_yaml(cls) -> Any:
119
- """
120
- show path to configuration yaml-file in data directory of package
121
- """
122
- _package = cls.d_app_pacmod['package']
123
- _path = os.path.join('data', 'cfg.yml')
124
- return Pac.sh_path_by_package(_package, _path)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ka_uts_com
3
- Version: 2.2.2.250430
3
+ Version: 2.2.4.250502
4
4
  Summary: Communication and CLIs Utilities
5
5
  Author-email: Bernd Stroehle <bernd.stroehle@gmail.com>
6
6
  Maintainer-email: Bernd Stroehle <bernd.stroehle@gmail.com>
@@ -56,17 +56,22 @@ To install with ``conda``:
56
56
 
57
57
  .. end installation
58
58
 
59
+ Package logging
60
+ ***************
61
+
62
+ (c.f.: **Appendix**: `Package Logging`)
63
+
59
64
  Package files
60
65
  *************
61
66
 
62
67
  Classification
63
68
  ==============
64
69
 
65
- The Package ``ka_uts_uts`` consist of Files with the following file types (c.f.: **Appendix**):
70
+ The Package ``ka_uts_com`` consist of the following file types (c.f.: **Appendix**):
66
71
 
67
- #. **Special files** (*Appendix: Special python package files*)
72
+ #. **Special files:** (c.f.: **Appendix:** *Special python package files*)
68
73
 
69
- #. **Dunder modules** (*Appendix: Special python package modules*)
74
+ #. **Dunder modules:** (c.f.: **Appendix:** *Special python package modules*)
70
75
 
71
76
  #. **Decorator modules**
72
77
 
@@ -74,8 +79,16 @@ The Package ``ka_uts_uts`` consist of Files with the following file types (c.f.:
74
79
 
75
80
  #. **Modules**
76
81
 
77
- a. *com.py*
78
- #. *timer.py*
82
+ #. **Communication Modules**
83
+
84
+ a. *com.py*
85
+ #. *timer.py*
86
+
87
+ #. **Base Modules**
88
+
89
+ a. *app.py*
90
+ #. *cfg.py*
91
+ #. *exit.py*
79
92
 
80
93
  Decorator Modules
81
94
  *****************
@@ -92,34 +105,9 @@ Overview
92
105
  |dec.py|Decorators module|
93
106
  +------+-----------------+
94
107
 
95
- Data Files
96
- **********
97
-
98
- Overview
99
- ========
100
-
101
- .. Data-Files-label:
102
- .. table:: *Data Files*
103
-
104
- +-----------+--------------------------------------------+
105
- |Name |Description |
106
- +===========+============================================+
107
- |log.std.yml|Yaml configuration file for standard logging|
108
- +-----------+--------------------------------------------+
109
- |log.usr.yml|Yaml configuration file for user logging |
110
- +-----------+--------------------------------------------+
111
-
112
108
  Package Files
113
109
  *************
114
110
 
115
- Classification
116
- ==============
117
-
118
- The Modules of Package ``ka_uts_com`` could be classified into the following module types:
119
-
120
- #. **Communication Modules**
121
- #. **Base Modules**
122
-
123
111
  Communication Modules
124
112
  =====================
125
113
 
@@ -142,54 +130,54 @@ Communication module com.py
142
130
 
143
131
  The Communication Module ``com.py`` contains the single static class ``Com``.
144
132
 
145
- Class Com
146
- ---------
133
+ com.py Class: Com
134
+ -----------------
147
135
 
148
136
  The static Class ``Com`` contains the subsequent variables and methods.
149
137
 
150
- Variables
151
- ^^^^^^^^^
152
-
153
- .. Variables-of-class-Com-label:
154
- .. table:: *Variables of class Com*
155
-
156
- +--------+-----------+-------+-----------------------------------+
157
- |Name |Type |Default|Description |
158
- +========+===========+=======+===================================+
159
- |d_pacmod|TyDic |{} |pacmod dictionary |
160
- +--------+-----------+-------+-----------------------------------+
161
- |pid |TyInt |None |current Process id |
162
- +--------+-----------+-------+-----------------------------------+
163
- |sw_init |TyBool |None |Initialisation switch |
164
- +--------+-----------+-------+-----------------------------------+
165
- |**Timestamp fields** |
166
- +--------+-----------+-------+-----------------------------------+
167
- |ts |TnTimeStamp|None |Timestamp |
168
- +--------+-----------+-------+-----------------------------------+
169
- |ts_start|TnDateTime |None |start timestamp in date time format|
170
- +--------+-----------+-------+-----------------------------------+
171
- |ts_end |TnDateTime |None |end timestamp in date time format |
172
- +--------+-----------+-------+-----------------------------------+
173
- |ts_etime|TnDateTime |None |elapse Time |
174
- +--------+-----------+-------+-----------------------------------+
175
- |d_timer |TyDic |False |Timer dictionary |
176
- +--------+-----------+-------+-----------------------------------+
177
- |**Links to other Classes** |
178
- +--------+-----------+-------+-----------------------------------+
179
- |App |TyAny |False |Application class |
180
- +--------+-----------+-------+-----------------------------------+
181
- |cfg |TyDic |None |Configuration dictionary |
182
- +--------+-----------+-------+-----------------------------------+
183
- |Log |TyLogger |False |Log class |
184
- +--------+-----------+-------+-----------------------------------+
185
- |Exit |TyAny |False |Exit class |
186
- +--------+-----------+-------+-----------------------------------+
187
-
188
- Methods
189
- ^^^^^^^
190
-
191
- .. Methods-of-class-Com-label:
192
- .. table:: *Methods-of-class-Com*
138
+ Com: Variables
139
+ ^^^^^^^^^^^^^^
140
+
141
+ .. Com-Variables-label:
142
+ .. table:: *Com: Variables*
143
+
144
+ +------------+-----------+-------+---------------------------------------+
145
+ |Name |Type |Default|Description |
146
+ +============+===========+=======+=======================================+
147
+ |sw_init |TyBool |None |Initialisation switch |
148
+ +------------+-----------+-------+---------------------------------------+
149
+ |d_com_pacmod|TyDic |{} |Communication package module dictionary|
150
+ +------------+-----------+-------+---------------------------------------+
151
+ |d_app_pacmod|TyDic |{} |Application package module dictionary |
152
+ +------------+-----------+-------+---------------------------------------+
153
+ |**Timestamp fields** |
154
+ +------------+-----------+-------+---------------------------------------+
155
+ |ts |TnTimeStamp|None |Timestamp |
156
+ +------------+-----------+-------+---------------------------------------+
157
+ |ts_start |TnDateTime |None |start timestamp in date time format |
158
+ +------------+-----------+-------+---------------------------------------+
159
+ |ts_end |TnDateTime |None |end timestamp in date time format |
160
+ +------------+-----------+-------+---------------------------------------+
161
+ |ts_etime |TnDateTime |None |elapse Time |
162
+ +------------+-----------+-------+---------------------------------------+
163
+ |d_timer |TyDic |False |Timer dictionary |
164
+ +------------+-----------+-------+---------------------------------------+
165
+ |**Links to other Classes** |
166
+ +------------+-----------+-------+---------------------------------------+
167
+ |App |TyAny |False |Application class |
168
+ +------------+-----------+-------+---------------------------------------+
169
+ |cfg |TyDic |None |Configuration dictionary |
170
+ +------------+-----------+-------+---------------------------------------+
171
+ |Log |TyLogger |False |Log class |
172
+ +------------+-----------+-------+---------------------------------------+
173
+ |Exit |TyAny |False |Exit class |
174
+ +------------+-----------+-------+---------------------------------------+
175
+
176
+ Com: Methods
177
+ ^^^^^^^^^^^^
178
+
179
+ .. Com-Methods-label:
180
+ .. table:: *Com Methods*
193
181
 
194
182
  +---------+-------------------------------------------------------+
195
183
  |Name |Description |
@@ -199,14 +187,14 @@ Methods
199
187
  |sh_kwargs|Show keyword arguments |
200
188
  +---------+-------------------------------------------------------+
201
189
 
202
- Method init
203
- ^^^^^^^^^^^
190
+ Com Method: init
191
+ ^^^^^^^^^^^^^^^^
204
192
 
205
193
  Parameter
206
194
  """""""""
207
195
 
208
- .. Parameter-of-method-init-label:
209
- .. table:: *Parameter-of-method-init*
196
+ ..Com-Method-init-Parameter-label:
197
+ .. table:: *Com Method init: Parameter*
210
198
 
211
199
  +---------+-----+-----------------+
212
200
  |Name |Type |Description |
@@ -216,14 +204,14 @@ Parameter
216
204
  |\**kwargs|TyAny|keyword arguments|
217
205
  +---------+-----+-----------------+
218
206
 
219
- Method sh_kwargs
220
- ^^^^^^^^^^^^^^^^
207
+ Com Method: sh_kwargs
208
+ ^^^^^^^^^^^^^^^^^^^^^
221
209
 
222
210
  Parameter
223
211
  """""""""
224
212
 
225
- .. Parameter-of-method-sh_kwargs-label:
226
- .. table:: *Parameter of method sh_kwargs*
213
+ .. Com-Method-sh_kwargs-Parameter-label:
214
+ .. table:: *Com Method sh_kwargs: Parameter*
227
215
 
228
216
  +--------+-----+--------------------+
229
217
  |Name |Type |Description |
@@ -240,14 +228,14 @@ Parameter
240
228
  Time management Module timer.py
241
229
  ===============================
242
230
 
243
- Classes
244
- -------
231
+ timer.py: Classes
232
+ -----------------
245
233
 
246
234
  The Module ``timer.py`` contains the following classes
247
235
 
248
236
 
249
- .. Static-classes-of-module-timer.py-label:
250
- .. table:: *Static classes of module timer.py*
237
+ .. timer.py-Classes-label:
238
+ .. table:: *timer.py classes*
251
239
 
252
240
  +---------+------+---------------+
253
241
  |Name |Type |Description |
@@ -258,14 +246,14 @@ The Module ``timer.py`` contains the following classes
258
246
  +---------+------+---------------+
259
247
 
260
248
 
261
- Class Timer
262
- -----------
249
+ timer.py Class: Timer
250
+ ---------------------
263
251
 
264
- Methods
265
- ^^^^^^^
252
+ Timer: Methods
253
+ ^^^^^^^^^^^^^^
266
254
 
267
- .. Methods-of-class-Timer-label:
268
- .. table:: *Methods of class Timer*
255
+ .. Timer-Methods-label:
256
+ .. table:: *Timer Methods*
269
257
 
270
258
  +----------+------------------------------------+
271
259
  |Name |Description |
@@ -277,8 +265,8 @@ Methods
277
265
  |end |End Timer and Log Timer info message|
278
266
  +----------+------------------------------------+
279
267
 
280
- Method sh_task_id
281
- ^^^^^^^^^^^^^^^^^
268
+ Timer Method: sh_task_id
269
+ ^^^^^^^^^^^^^^^^^^^^^^^^
282
270
 
283
271
  Show task id, which is created by the concatination of the following items if they are defined:
284
272
  #. package,
@@ -292,8 +280,8 @@ __qualname__ is used.
292
280
  Parameter
293
281
  """""""""
294
282
 
295
- .. Parameter-of-method-sh_task_id-label:
296
- .. table:: *Parameter-of-method-sh_task_id*
283
+ .. Timer-Method-sh_task_id-Parameter-label:
284
+ .. table:: *Timer Method sh_task_id: Parameter*
297
285
 
298
286
  +--------+-----+-----------------+
299
287
  |Name |Type |Description |
@@ -310,8 +298,8 @@ Parameter
310
298
  Return Value
311
299
  """"""""""""
312
300
 
313
- .. Return-value-of-method-sh_task_id-label:
314
- .. table:: *Return value of method sh_task_id*
301
+ .. Timer-Method-sh_task_id-Return-Value-label:
302
+ .. table:: *Timer Method sh_task_id: Return Value*
315
303
 
316
304
  +----+-----+-----------+
317
305
  |Name|Type |Description|
@@ -319,14 +307,14 @@ Return Value
319
307
  | |TyStr|Task Id |
320
308
  +----+-----+-----------+
321
309
 
322
- Method start
323
- ^^^^^^^^^^^^
310
+ Timer Method: start
311
+ ^^^^^^^^^^^^^^^^^^^
324
312
 
325
313
  Parameter
326
314
  """""""""
327
315
 
328
- .. Parameter-of-method-start-label:
329
- .. table:: *Parameter of method start*
316
+ .. Timer-Method-start-Parameter-label:
317
+ .. table:: *Timer Method start: Parameter*
330
318
 
331
319
  +--------+-----+-------------+
332
320
  |Name |Type |Description |
@@ -340,14 +328,14 @@ Parameter
340
328
  |sep |TyStr|Separator |
341
329
  +--------+-----+-------------+
342
330
 
343
- Method: end
344
- ^^^^^^^^^^^
331
+ Timer Method: end
332
+ ^^^^^^^^^^^^^^^^^
345
333
 
346
334
  Parameter
347
335
  """""""""
348
336
 
349
- .. Parameter-of-end-method-label:
350
- .. table:: *Parameter of end method*
337
+ .. Timer-Method-end-Parameter-label:
338
+ .. table:: *Timer Method end: Parameter*
351
339
 
352
340
  +--------+-----+-------------+
353
341
  |Name |Type |Description |
@@ -380,8 +368,8 @@ Overview
380
368
  |exit\_.py|Exit Manafement setup module|
381
369
  +---------+----------------------------+
382
370
 
383
- Application setup module: app\_.py
384
- ==================================
371
+ Base module: app\_.py
372
+ =====================
385
373
 
386
374
  The Module ``app.py`` contains a single static class ``App_``.
387
375
 
@@ -390,11 +378,11 @@ Class: App\_
390
378
 
391
379
  The static class ``App_`` contains the subsequent static variables and methods
392
380
 
393
- Static Variables
394
- ^^^^^^^^^^^^^^^^
381
+ App\_: Static Variables
382
+ ^^^^^^^^^^^^^^^^^^^^^^^
395
383
 
396
- .. Static-variables-of-class-App_-label:
397
- .. table:: *Static Variables of class App_*
384
+ .. Appl\_ Static-Variables-label:
385
+ .. table:: *Appl\_ tatic Variables*
398
386
 
399
387
  +---------------+-------+-------+---------------------+
400
388
  |Name |Type |Default|Description |
@@ -412,11 +400,11 @@ Static Variables
412
400
  |app |TyDic |None |Appliction dictionary|
413
401
  +---------------+-------+-------+---------------------+
414
402
 
415
- Methods
416
- ^^^^^^^
403
+ App\_: Methods
404
+ ^^^^^^^^^^^^^^
417
405
 
418
- .. Methods-of-class-App_-label:
419
- .. table:: *Methods of class App_*
406
+ .. App\_-Methods-label:
407
+ .. table:: *App\_ Methods*
420
408
 
421
409
  +----+------+------------------------------------+
422
410
  |Name|Type |Description |
@@ -427,14 +415,14 @@ Methods
427
415
  |sh |class |show (return) class |
428
416
  +----+------+------------------------------------+
429
417
 
430
- Method: init
431
- ^^^^^^^^^^^^
418
+ App\_ Method: init
419
+ ^^^^^^^^^^^^^^^^^^
432
420
 
433
421
  Parameter
434
422
  """""""""
435
423
 
436
- .. Parameter-of-method-init-label:
437
- .. table:: *Parameter of method init*
424
+ .. App\_-Method-init-label:
425
+ .. table:: *App\_ Method: init*
438
426
 
439
427
  +---------+-----+-----------------+
440
428
  |Name |Type |Description |
@@ -444,11 +432,11 @@ Parameter
444
432
  |\**kwargs|TyAny|Keyword arguments|
445
433
  +---------+-----+-----------------+
446
434
 
447
- Method: sh
448
- ^^^^^^^^^^
435
+ App\_ Method: sh
436
+ ^^^^^^^^^^^^^^^^
449
437
 
450
- .. Parameter-of-method-sh-label:
451
- .. table:: *Parameter of method sh*
438
+ .. App\_-Method-sh-label:
439
+ .. table:: *App\_ Method: sh*
452
440
 
453
441
  +---------+-----+-----------------+
454
442
  |Name |Type |Description |
@@ -461,8 +449,8 @@ Method: sh
461
449
  Return Value
462
450
  """"""""""""
463
451
 
464
- .. Return-values-of-method-sh-label:
465
- .. table:: *Return values of method sh*
452
+ .. App\_-Method-sh-Return-Value-label:
453
+ .. table:: *App\_ Method sh: Return Value*
466
454
 
467
455
  +----+--------+-----------+
468
456
  |Name|Type |Description|
@@ -470,21 +458,21 @@ Return Value
470
458
  |log |TyLogger|Logger |
471
459
  +----+--------+-----------+
472
460
 
473
- cfg\_.py
474
- ========
461
+ Base module: cfg\_.py
462
+ =====================
475
463
 
476
464
  The Base module cfg\_.py contains a single static class ``Cfg_``.
477
465
 
478
- Class Cfg\_
479
- -----------
466
+ cfg\_.py Class Cfg\_
467
+ ---------------------
480
468
 
481
469
  The static class ``Cfg_`` contains the subsequent static variables and methods
482
470
 
483
- Static Variables
484
- ^^^^^^^^^^^^^^^^
471
+ Cfg\_Static Variables
472
+ ^^^^^^^^^^^^^^^^^^^^^
485
473
 
486
- .. Static-variables-of-Cfg_-label:
487
- .. table:: *Static Variables of Cfg_*
474
+ .. Cfg\_-Static-Variables-label:
475
+ .. table:: *Cfg\_ Static Variables*
488
476
 
489
477
  +----+-----+-------+--------------------+
490
478
  |Name|Type |Default|Description |
@@ -492,11 +480,11 @@ Static Variables
492
480
  |cfg |TyDic|None |Configuration object|
493
481
  +----+-----+-------+--------------------+
494
482
 
495
- Methods
496
- ^^^^^^^
483
+ Cfg\_ Methods
484
+ ^^^^^^^^^^^^^
497
485
 
498
- .. Methods-of-class-Cfg_-label:
499
- .. table:: *Methods of class Cfg_*
486
+ .. Cfg\_-Methods-label:
487
+ .. table:: *Cfg\_ Methods*
500
488
 
501
489
  +----+------+-----------------------------------+
502
490
  |Name|Type |Description |
@@ -505,14 +493,14 @@ Methods
505
493
  | | |variable cls.dic and return cls.cfg|
506
494
  +----+------+-----------------------------------+
507
495
 
508
- Method: sh
509
- ^^^^^^^^^^
496
+ Cfg\_ Method: sh
497
+ ^^^^^^^^^^^^^^^^
510
498
 
511
499
  Parameter
512
500
  """""""""
513
501
 
514
- .. Parameter-of-method-init-label:
515
- .. table:: *Parameter of method sh*
502
+ .. Cfg\_-Method-sh-Parameter-label:
503
+ .. table:: *Cfg\_ Method sh: Parameter*
516
504
 
517
505
  +--------+--------+-----------------+
518
506
  |Name |Type |Description |
@@ -527,8 +515,8 @@ Parameter
527
515
  Return Value
528
516
  """"""""""""
529
517
 
530
- .. Return-values-of-method-sh-label:
531
- .. table:: *Return values of method sh*
518
+ .. Cfg\_-Method-sh-Return-Value-label:
519
+ .. table:: *Cfg\_ Method sh: Return Value*
532
520
 
533
521
  +-------+-----+-----------+
534
522
  |Name |Type |Description|
@@ -536,21 +524,21 @@ Return Value
536
524
  |cls.cfg|TyDic| |
537
525
  +-------+-----+-----------+
538
526
 
539
- Base Modul ext\_.py
540
- ===================
527
+ Base Modul: exit\_.py
528
+ =====================
541
529
 
542
530
  The Base module exit\_.py contains a single static class ``Ext_``.
543
531
 
544
- class Exit\_
545
- ------------
532
+ exit\_.py class: Exit\_
533
+ -----------------------
546
534
 
547
- The static Class ``Exit_`` contains the subsequent static variables and methods.
535
+ The static Class ``Exit_`` of Module exit\_.py contains the subsequent static variables and methods.
548
536
 
549
- Static Variables
550
- ^^^^^^^^^^^^^^^^
537
+ Exit\_: Variables
538
+ ^^^^^^^^^^^^^^^^^
551
539
 
552
- .. Static variables-of-class-Ext_-label:
553
- .. table:: *Static variables of class Ext_*
540
+ .. Exit\_-Variables-label:
541
+ .. table:: *Exit\_ Variables*
554
542
 
555
543
  +--------------+------+-------+---------------------+
556
544
  |Name |Type |Default|Description |
@@ -564,11 +552,11 @@ Static Variables
564
552
  |sw_interactive|TyBool|False |interactive switch |
565
553
  +--------------+------+-------+---------------------+
566
554
 
567
- Methods
568
- ^^^^^^^
555
+ Exit\_: Methods
556
+ ^^^^^^^^^^^^^^^
569
557
 
570
- .. Methods-of-class-Ext_-label:
571
- .. table:: *Methods of class Ext_*
558
+ .. Exit\_-Methods-label:
559
+ .. table:: *Exit\_ Methods*
572
560
 
573
561
  +----+------+------------------------------------+
574
562
  |Name|Method|Description |
@@ -579,14 +567,14 @@ Methods
579
567
  |sh |class |show (return) class |
580
568
  +----+------+------------------------------------+
581
569
 
582
- Method: init
583
- ^^^^^^^^^^^^
570
+ Exit\_: Method: init
571
+ ^^^^^^^^^^^^^^^^^^^^
584
572
 
585
573
  Parameter
586
574
  """""""""
587
575
 
588
- .. Parameter-of-method-init-label:
589
- .. table:: *Parameter of method init*
576
+ .. Exit\_-Method-init-Parameter:
577
+ .. table:: *Exit\_ Method init: Parameter*
590
578
 
591
579
  +---------+-----+-----------------+
592
580
  |Name |Type |Description |
@@ -596,14 +584,14 @@ Parameter
596
584
  |\**kwargs|TyAny|Keyword arguments|
597
585
  +---------+-----+-----------------+
598
586
 
599
- Method: sh
600
- ^^^^^^^^^^
587
+ Exit\_: Method: sh
588
+ ^^^^^^^^^^^^^^^^^^
601
589
 
602
590
  Parameter
603
591
  """""""""
604
592
 
605
- .. Parameter-of-method-sh-label:
606
- .. table:: *Parameter of method sh*
593
+ .. Exit\_-Method-sh-Parameter:
594
+ .. table:: *Exit\_ Method sh: Parameter*
607
595
 
608
596
  +---------+-----+-----------------+
609
597
  |Name |Type |Description |
@@ -616,8 +604,8 @@ Parameter
616
604
  Return Value
617
605
  """"""""""""
618
606
 
619
- .. Return-values-of-method-sh-label:
620
- .. table:: *Return values of method sh*
607
+ .. Exit\_-Method-sh-Return-Value:
608
+ .. table:: *Exit\_ Method sh: Return Value*
621
609
 
622
610
  +----+-----+-------------+
623
611
  |Name|Type |Description |
@@ -657,33 +645,25 @@ Application parameter for logging
657
645
  .. Application-parameter-used-in-log-naming-label:
658
646
  .. table:: *Application parameter used in log naming*
659
647
 
660
- +-----------------+--------------------------+-----------------+------------+
661
- |Name |Decription |Values |Example |
662
- | | +-----------------+ |
663
- | | |Value|Type | |
664
- +=================+==========================+=====+===========+============+
665
- |dir_dat |Application data directory| |Path |/otev/data |
666
- +-----------------+--------------------------+-----+-----------+------------+
667
- |tenant |Application tenant name | |str |UMH |
668
- +-----------------+--------------------------+-----+-----------+------------+
669
- |package |Application package name | |str |otev_xls_srr|
670
- +-----------------+--------------------------+-----+-----------+------------+
671
- |cmd |Application command | |str |evupreg |
672
- +-----------------+--------------------------+-----+-----------+------------+
673
- |pid |Process ID | |str |evupreg |
674
- +-----------------+--------------------------+-----+-----------+------------+
675
- |log_ts_type |Timestamp type used in |ts |Timestamp |ts |
676
- | |loggin files +-----+-----------+------------+
677
- | | |dt |Datetime | |
678
- +-----------------+--------------------------+-----+-----------+------------+
679
- |log_sw_single_dir|Enable single log |True |Bool |True |
680
- | |directory or multiple +-----+-----------+ |
681
- | |log directories |False|Bool | |
682
- +-----------------+--------------------------+-----+-----------+------------+
683
- |log_sw_pid |Enable display of pid |True |Bool |True |
684
- | |in log file name +-----+-----------+ |
685
- | | |False|Bool | |
686
- +-----------------+--------------------------+-----+-----------+------------+
648
+ +-----------------+---------------------------+----------+------------+
649
+ |Name |Decription |Values |Example |
650
+ +=================+===========================+==========+============+
651
+ |dir_dat |Application data directory | |/otev/data |
652
+ +-----------------+---------------------------+----------+------------+
653
+ |tenant |Application tenant name | |UMH |
654
+ +-----------------+---------------------------+----------+------------+
655
+ |package |Application package name | |otev_xls_srr|
656
+ +-----------------+---------------------------+----------+------------+
657
+ |cmd |Application command | |evupreg |
658
+ +-----------------+---------------------------+----------+------------+
659
+ |pid |Process ID |evupreg |
660
+ +-----------------+---------------------------+----------+------------+
661
+ |log_ts_type |Timestamp type used in |ts, |ts |
662
+ | |logging files|ts, dt |dt | |
663
+ +-----------------+---------------------------+----------+------------+
664
+ |log_sw_single_dir|Enable single log directory|True, |True |
665
+ | |or multiple log directories|False | |
666
+ +-----------------+---------------------------+----------+------------+
687
667
 
688
668
  Log type and Log directories
689
669
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -712,8 +692,8 @@ Single or multiple Application log directories can be used for each message type
712
692
  Log files naming
713
693
  ^^^^^^^^^^^^^^^^
714
694
 
715
- Conventions
716
- """""""""""
695
+ Naming Conventions
696
+ """"""""""""""""""
717
697
 
718
698
  .. Naming-conventions-for-logging-file-paths-label:
719
699
  .. table:: *Naming conventions for logging file paths*
@@ -732,47 +712,34 @@ Conventions
732
712
  |critical|/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
733
713
  +--------+-------------------------------------------------------+-------------------------+
734
714
 
735
- Examples (with log_ts_type = 'ts')
736
- """"""""""""""""""""""""""""""""""
737
-
738
- The examples use the following parameter values.
739
-
740
- #. dir_dat = '/data/otev'
741
- #. tenant = 'UMH'
742
- #. package = 'otev_srr'
743
- #. cmd = 'evupreg'
744
- #. log_sw_single_dir = True
745
- #. log_sw_pid = True
746
- #. log_ts_type = 'ts'
715
+ Naming Examples
716
+ """""""""""""""
747
717
 
748
718
  .. Naming-examples-for-logging-file-paths-label:
749
719
  .. table:: *Naming examples for logging file paths*
750
720
 
751
- +--------+----------------------------------------+------------------------+
752
- |Type |Directory |File |
753
- +========+========================================+========================+
754
- |debug |/data/otev/umh/RUN/otev_srr/evupreg/logs|debs_1737118199_9470.log|
755
- +--------+----------------------------------------+------------------------+
756
- |info |/data/otev/umh/RUN/otev_srr/evupreg/logs|infs_1737118199_9470.log|
757
- +--------+----------------------------------------+------------------------+
758
- |warning |/data/otev/umh/RUN/otev_srr/evupreg/logs|wrns_1737118199_9470.log|
759
- +--------+----------------------------------------+------------------------+
760
- |error |/data/otev/umh/RUN/otev_srr/evupreg/logs|errs_1737118199_9470.log|
761
- +--------+----------------------------------------+------------------------+
762
- |critical|/data/otev/umh/RUN/otev_srr/evupreg/logs|crts_1737118199_9470.log|
763
- +--------+----------------------------------------+------------------------+
721
+ +--------+--------------------------------------------+------------------------+
722
+ |Type |Directory |File |
723
+ +========+============================================+========================+
724
+ |debug |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|debs_1737118199_9470.log|
725
+ +--------+--------------------------------------------+------------------------+
726
+ |info |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|infs_1737118199_9470.log|
727
+ +--------+--------------------------------------------+------------------------+
728
+ |warning |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|wrns_1737118199_9470.log|
729
+ +--------+--------------------------------------------+------------------------+
730
+ |error |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|errs_1737118199_9470.log|
731
+ +--------+--------------------------------------------+------------------------+
732
+ |critical|/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|crts_1737118199_9470.log|
733
+ +--------+--------------------------------------------+------------------------+
764
734
 
765
735
  Python Terminology
766
736
  ==================
767
737
 
768
- Python package
769
- --------------
770
-
771
- Overview
772
- ^^^^^^^^
738
+ Python packages
739
+ ---------------
773
740
 
774
- .. Python package-label:
775
- .. table:: *Python package*
741
+ .. Python packages-label:
742
+ .. table:: *Python packages*
776
743
 
777
744
  +-----------+-----------------------------------------------------------------+
778
745
  |Name |Definition |
@@ -784,47 +751,42 @@ Overview
784
751
  |sub-package|another pyhon package. |
785
752
  +-----------+-----------------------------------------------------------------+
786
753
 
787
- Python package sub-directories
788
- ------------------------------
789
-
790
- Overview
791
- ^^^^^^^^
792
-
793
- .. Python package sub-direcories-label:
794
- .. table:: *Python package sub-directories*
795
-
796
- +---------------------+----------------------------------------+
797
- |Name |Definition |
798
- +=====================+========================================+
799
- |Python |directory contained in a python package.|
800
- |package sub-directory| |
801
- +---------------------+----------------------------------------+
802
- |Special python |Python package sub-directories with a |
803
- |package sub-directory|special meaning like data or cfg. |
804
- +---------------------+----------------------------------------+
805
-
806
- Special python package sub-directories
807
- --------------------------------------
808
-
809
- Overview
810
- ^^^^^^^^
811
-
812
- .. Special-python-package-sub-directories-label:
813
- .. table:: *Special python sun-directories*
754
+ Python package Sub-directories
755
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
814
756
 
815
- +----+------------------------------------------+
816
- |Name|Description |
817
- +====+==========================================+
818
- |data|Directory for package data files. |
819
- +----+------------------------------------------+
820
- |cfg |Directory for package configuration files.|
821
- +----+------------------------------------------+
757
+ .. Python package-Sub-directories-label:
758
+ .. table:: *Python packages Sub-directories*
759
+
760
+ +----------------------+-------------------------------+
761
+ |Name |Definition |
762
+ +======================+==========+====================+
763
+ |Python package |Sub-directories are directories|
764
+ |sub-directory |contained in python packages. |
765
+ +----------------------+-------------------------------+
766
+ |Special Python package|Python package sub-directories |
767
+ |sub-directory |with a special meaning. |
768
+ +----------------------+-------------------------------+
769
+
770
+ Special python package Sub-directories
771
+ """"""""""""""""""""""""""""""""""""""
772
+
773
+ .. Special-python-package-Sub-directories-label:
774
+ .. table:: *Special python Sub-directories*
775
+
776
+ +-------+------------------------------------------+
777
+ |Name |Description |
778
+ +=======+==========================================+
779
+ |bin |Directory for package scripts. |
780
+ +-------+------------------------------------------+
781
+ |cfg |Directory for package configuration files.|
782
+ +-------+------------------------------------------+
783
+ |data |Directory for package data files. |
784
+ +-------+------------------------------------------+
785
+ |service|Directory for systemd service scripts. |
786
+ +-------+------------------------------------------+
822
787
 
823
788
  Python package files
824
- --------------------
825
-
826
- Overview
827
- ^^^^^^^^
789
+ ^^^^^^^^^^^^^^^^^^^^
828
790
 
829
791
  .. Python-package-files-label:
830
792
  .. table:: *Python package files*
@@ -832,24 +794,21 @@ Overview
832
794
  +--------------+---------------------------------------------------------+
833
795
  |Name |Definition |
834
796
  +==============+==========+==============================================+
835
- |Python |File within a python package. |
836
- |package file | |
797
+ |Python |Files within a python package. |
798
+ |package files | |
837
799
  +--------------+---------------------------------------------------------+
838
- |Special python|Python package file which are not modules and used as |
839
- |package file |python marker files like ``__init__.py``. |
800
+ |Special python|Package files which are not modules and used as python |
801
+ |package files |and used as python marker files like ``__init__.py``. |
840
802
  +--------------+---------------------------------------------------------+
841
- |Python |File with suffix ``.py`` which could be empty or contain |
842
- |package module|python code; Other modules can be imported into a module.|
803
+ |Python package|Files with suffix ``.py``; they could be empty or contain|
804
+ |module |python code; other modules can be imported into a module.|
843
805
  +--------------+---------------------------------------------------------+
844
- |Special python|Python package module with special name and functionality|
845
- |package module|like ``main.py`` or ``__init__.py``. |
806
+ |Special python|Modules like ``__init__.py`` or ``main.py`` with special |
807
+ |package module|names and functionality. |
846
808
  +--------------+---------------------------------------------------------+
847
809
 
848
810
  Special python package files
849
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
850
-
851
- Overview
852
- °°°°°°°°
811
+ """"""""""""""""""""""""""""
853
812
 
854
813
  .. Special-python-package-files-label:
855
814
  .. table:: *Special python package files*
@@ -864,10 +823,7 @@ Overview
864
823
  +--------+--------+---------------------------------------------------------------+
865
824
 
866
825
  Special python package modules
867
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
868
-
869
- Overview
870
- °°°°°°°°
826
+ """"""""""""""""""""""""""""""
871
827
 
872
828
  .. Special-Python-package-modules-label:
873
829
  .. table:: *Special Python package modules*
@@ -891,34 +847,24 @@ Overview
891
847
  Python elements
892
848
  ---------------
893
849
 
894
- Overview
895
- °°°°°°°°
896
-
897
850
  .. Python elements-label:
898
851
  .. table:: *Python elements*
899
852
 
900
- +-------------------+---------------------------------------------+
901
- |Name |Definition |
902
- +===================+=============================================+
903
- |Python method |Function defined in a python module. |
904
- +-------------------+---------------------------------------------+
905
- |Special |Python method with special name and |
906
- |python method |functionality like ``init``. |
907
- +-------------------+---------------------------------------------+
908
- |Python class |Python classes are defined in python modules.|
909
- +-------------------+---------------------------------------------+
910
- |Python class method|Python method defined in a python class. |
911
- +-------------------+---------------------------------------------+
912
- |Special |Python class method with special name and |
913
- |Python class method|functionality like ``init``. |
914
- +-------------------+---------------------------------------------+
853
+ +---------------------+--------------------------------------------------------+
854
+ |Name |Description |
855
+ +=====================+========================================================+
856
+ |Python method |Python functions defined in python modules. |
857
+ +---------------------+--------------------------------------------------------+
858
+ |Special python method|Python functions with special names and functionalities.|
859
+ +---------------------+--------------------------------------------------------+
860
+ |Python class |Classes defined in python modules. |
861
+ +---------------------+--------------------------------------------------------+
862
+ |Python class method |Python methods defined in python classes |
863
+ +---------------------+--------------------------------------------------------+
915
864
 
916
865
  Special python methods
917
866
  ^^^^^^^^^^^^^^^^^^^^^^
918
867
 
919
- Overview
920
- °°°°°°°°
921
-
922
868
  .. Special-python-methods-label:
923
869
  .. table:: *Special python methods*
924
870
 
@@ -0,0 +1,14 @@
1
+ ka_uts_com/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ ka_uts_com/__version__.py,sha256=iPOOUJ1c3ajjBwUTCCh-Odw2bHe1S9duFt8LsgdFABo,365
3
+ ka_uts_com/app.py,sha256=XrMhqQI9YHzw1XmC8zGgCJwrwxzkHtHDEQIo9gP07DI,1151
4
+ ka_uts_com/cfg.py,sha256=RNWxOz3XtP0HgH0z1e6tAQA_L0alEh82_EOPOoyv3R4,768
5
+ ka_uts_com/com.py,sha256=CQIsrDEe8soZ41PxW2YN1s1NvagVa3PUo8DgiczUQc0,1938
6
+ ka_uts_com/exit.py,sha256=RIpFKwEGeBCBBPPQXIcLsrYeNY2dTF8BDlESe6UhdMo,791
7
+ ka_uts_com/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
+ ka_uts_com/timer.py,sha256=hSNDh5qV6stSRLLEv-G_eMRoglsOU9N2HvRPUQ-s7yU,2153
9
+ ka_uts_com/decorators/dec.py,sha256=NHerkpjOYpJXz2CIh9HlN3_YCyLv-SbyQL4ldyGUSpM,217
10
+ ka_uts_com-2.2.4.250502.dist-info/licenses/LICENSE.txt,sha256=BiT3QGI_2iRbdvgS3HDig57lnXJVk60Pj4xM9eeCczI,814
11
+ ka_uts_com-2.2.4.250502.dist-info/METADATA,sha256=lV_jZTpJf-XP24HKZuXGGquQ5DBh2zT74AenTQiIekY,31847
12
+ ka_uts_com-2.2.4.250502.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
13
+ ka_uts_com-2.2.4.250502.dist-info/top_level.txt,sha256=cWCIrm1g6Jn-FbCQuB3wBrrNH1YwqVlc6mE0jV6vg74,21
14
+ ka_uts_com-2.2.4.250502.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.0.1)
2
+ Generator: setuptools (80.1.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,14 +0,0 @@
1
- ka_uts_com/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- ka_uts_com/__version__.py,sha256=2rDHmi9PKXVhwxm4yZoSJwJIorzaxh6L2hqGcCyiaR8,365
3
- ka_uts_com/app.py,sha256=3ns3q-nmPArmKEwitIp4xHR5cEl5tU-Q6QM1NHkM9Wc,1147
4
- ka_uts_com/cfg.py,sha256=RQoOwiPRyElO40lu7GqXDcOV-G0Sx_9i09sxkZVK6mI,678
5
- ka_uts_com/com.py,sha256=NjnsDZSX8jvvc2tbSa0LhER8VoBfUsC9euCbY7EyIQQ,3080
6
- ka_uts_com/exit.py,sha256=RIpFKwEGeBCBBPPQXIcLsrYeNY2dTF8BDlESe6UhdMo,791
7
- ka_uts_com/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
- ka_uts_com/timer.py,sha256=hSNDh5qV6stSRLLEv-G_eMRoglsOU9N2HvRPUQ-s7yU,2153
9
- ka_uts_com/decorators/dec.py,sha256=NHerkpjOYpJXz2CIh9HlN3_YCyLv-SbyQL4ldyGUSpM,217
10
- ka_uts_com-2.2.2.250430.dist-info/licenses/LICENSE.txt,sha256=BiT3QGI_2iRbdvgS3HDig57lnXJVk60Pj4xM9eeCczI,814
11
- ka_uts_com-2.2.2.250430.dist-info/METADATA,sha256=sUl26AccLjsjPELOclMTsJdQxiawFhh_FfDKOuS1G2I,32982
12
- ka_uts_com-2.2.2.250430.dist-info/WHEEL,sha256=ooBFpIzZCPdw3uqIQsOo4qqbA4ZRPxHnOH7peeONza0,91
13
- ka_uts_com-2.2.2.250430.dist-info/top_level.txt,sha256=cWCIrm1g6Jn-FbCQuB3wBrrNH1YwqVlc6mE0jV6vg74,21
14
- ka_uts_com-2.2.2.250430.dist-info/RECORD,,