ka-uts-com 2.2.0.250427__py3-none-any.whl → 2.2.3.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.0.250427'
4
+ __version__ = '2.2.3.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)
@@ -91,33 +78,7 @@ class Com:
91
78
  """
92
79
  _kwargs: TyDic = AoEqu.sh_d_eq(*args, d_parms=d_parms)
93
80
  _kwargs['cls_app'] = cls_app
94
- cls.init(_kwargs)
95
81
  _kwargs['com'] = cls
96
- return _kwargs
97
82
 
98
- @classmethod
99
- def sh_path_bin(cls) -> Any:
100
- """
101
- show path to bin directory in package
102
- """
103
- _package = cls.d_app_pacmod['package']
104
- _path = 'bin'
105
- return Pac.sh_path_by_package(_package, _path)
106
-
107
- @classmethod
108
- def sh_path_data(cls) -> Any:
109
- """
110
- show path to data directory in package
111
- """
112
- _package = cls.d_app_pacmod['package']
113
- _path = 'data'
114
- return Pac.sh_path_by_package(_package, _path)
115
-
116
- @classmethod
117
- def sh_path_cfg_yaml(cls) -> Any:
118
- """
119
- show path to configuration yaml-file in data directory of package
120
- """
121
- _package = cls.d_app_pacmod['package']
122
- _path = os.path.join('data', 'cfg.yml')
123
- return Pac.sh_path_by_package(_package, _path)
83
+ cls.init(_kwargs)
84
+ return _kwargs
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ka_uts_com
3
- Version: 2.2.0.250427
3
+ Version: 2.2.3.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>
@@ -18,8 +18,8 @@ Requires-Python: >=3.10
18
18
  Description-Content-Type: text/x-rst
19
19
  License-File: LICENSE.txt
20
20
  Requires-Dist: ka_uts_equ>=2.2.0.250427
21
- Requires-Dist: ka_uts_log>=2.1.1.250415
22
- Requires-Dist: ka_uts_uts>=2.1.1.250415
21
+ Requires-Dist: ka_uts_log>=2.2.0.250427
22
+ Requires-Dist: ka_uts_uts>=2.2.1.250429
23
23
  Dynamic: license-file
24
24
 
25
25
  ##########
@@ -56,19 +56,39 @@ 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 Files of Package ``ka_uts_com`` could be classified into the follwing file types:
70
+ The Package ``ka_uts_com`` consist of the following file types (c.f.: **Appendix**):
71
+
72
+ #. **Special files:** (c.f.: **Appendix:** *Special python package files*)
73
+
74
+ #. **Dunder modules:** (c.f.: **Appendix:** *Special python package modules*)
75
+
76
+ #. **Decorator modules**
77
+
78
+ a. *dec.py*
79
+
80
+ #. **Modules**
81
+
82
+ #. **Communication Modules**
83
+
84
+ a. *com.py*
85
+ #. *timer.py*
66
86
 
67
- #. *Special files*
68
- #. *Dunder modules*
69
- #. *Decorator modules*
70
- #. *Package modules*
71
- #. *Data files*
87
+ #. **Base Modules**
88
+
89
+ a. *app.py*
90
+ #. *cfg.py*
91
+ #. *exit.py*
72
92
 
73
93
  Decorator Modules
74
94
  *****************
@@ -85,34 +105,9 @@ Overview
85
105
  |dec.py|Decorators module|
86
106
  +------+-----------------+
87
107
 
88
- Data Files
89
- **********
90
-
91
- Overview
92
- ========
93
-
94
- .. Data-Files-label:
95
- .. table:: *Data Files*
96
-
97
- +-----------+--------------------------------------------+
98
- |Name |Description |
99
- +===========+============================================+
100
- |log.std.yml|Yaml configuration file for standard logging|
101
- +-----------+--------------------------------------------+
102
- |log.usr.yml|Yaml configuration file for user logging |
103
- +-----------+--------------------------------------------+
104
-
105
108
  Package Files
106
109
  *************
107
110
 
108
- Classification
109
- ==============
110
-
111
- The Modules of Package ``ka_uts_com`` could be classified into the following module types:
112
-
113
- #. **Communication Modules**
114
- #. **Base Modules**
115
-
116
111
  Communication Modules
117
112
  =====================
118
113
 
@@ -135,54 +130,54 @@ Communication module com.py
135
130
 
136
131
  The Communication Module ``com.py`` contains the single static class ``Com``.
137
132
 
138
- Class Com
139
- ---------
133
+ com.py Class: Com
134
+ -----------------
140
135
 
141
136
  The static Class ``Com`` contains the subsequent variables and methods.
142
137
 
143
- Variables
144
- ^^^^^^^^^
145
-
146
- .. Variables-of-class-Com-label:
147
- .. table:: *Variables of class Com*
148
-
149
- +--------+-----------+-------+-----------------------------------+
150
- |Name |Type |Default|Description |
151
- +========+===========+=======+===================================+
152
- |d_pacmod|TyDic |{} |pacmod dictionary |
153
- +--------+-----------+-------+-----------------------------------+
154
- |pid |TyInt |None |current Process id |
155
- +--------+-----------+-------+-----------------------------------+
156
- |sw_init |TyBool |None |Initialisation switch |
157
- +--------+-----------+-------+-----------------------------------+
158
- |**Timestamp fields** |
159
- +--------+-----------+-------+-----------------------------------+
160
- |ts |TnTimeStamp|None |Timestamp |
161
- +--------+-----------+-------+-----------------------------------+
162
- |ts_start|TnDateTime |None |start timestamp in date time format|
163
- +--------+-----------+-------+-----------------------------------+
164
- |ts_end |TnDateTime |None |end timestamp in date time format |
165
- +--------+-----------+-------+-----------------------------------+
166
- |ts_etime|TnDateTime |None |elapse Time |
167
- +--------+-----------+-------+-----------------------------------+
168
- |d_timer |TyDic |False |Timer dictionary |
169
- +--------+-----------+-------+-----------------------------------+
170
- |**Links to other Classes** |
171
- +--------+-----------+-------+-----------------------------------+
172
- |App |TyAny |False |Application class |
173
- +--------+-----------+-------+-----------------------------------+
174
- |cfg |TyDic |None |Configuration dictionary |
175
- +--------+-----------+-------+-----------------------------------+
176
- |Log |TyLogger |False |Log class |
177
- +--------+-----------+-------+-----------------------------------+
178
- |Exit |TyAny |False |Exit class |
179
- +--------+-----------+-------+-----------------------------------+
180
-
181
- Methods
182
- ^^^^^^^
183
-
184
- .. Methods-of-class-Com-label:
185
- .. 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*
186
181
 
187
182
  +---------+-------------------------------------------------------+
188
183
  |Name |Description |
@@ -192,14 +187,14 @@ Methods
192
187
  |sh_kwargs|Show keyword arguments |
193
188
  +---------+-------------------------------------------------------+
194
189
 
195
- Method init
196
- ^^^^^^^^^^^
190
+ Com Method: init
191
+ ^^^^^^^^^^^^^^^^
197
192
 
198
193
  Parameter
199
194
  """""""""
200
195
 
201
- .. Parameter-of-method-init-label:
202
- .. table:: *Parameter-of-method-init*
196
+ ..Com-Method-init-Parameter-label:
197
+ .. table:: *Com Method init: Parameter*
203
198
 
204
199
  +---------+-----+-----------------+
205
200
  |Name |Type |Description |
@@ -209,14 +204,14 @@ Parameter
209
204
  |\**kwargs|TyAny|keyword arguments|
210
205
  +---------+-----+-----------------+
211
206
 
212
- Method sh_kwargs
213
- ^^^^^^^^^^^^^^^^
207
+ Com Method: sh_kwargs
208
+ ^^^^^^^^^^^^^^^^^^^^^
214
209
 
215
210
  Parameter
216
211
  """""""""
217
212
 
218
- .. Parameter-of-method-sh_kwargs-label:
219
- .. table:: *Parameter of method sh_kwargs*
213
+ .. Com-Method-sh_kwargs-Parameter-label:
214
+ .. table:: *Com Method sh_kwargs: Parameter*
220
215
 
221
216
  +--------+-----+--------------------+
222
217
  |Name |Type |Description |
@@ -233,14 +228,14 @@ Parameter
233
228
  Time management Module timer.py
234
229
  ===============================
235
230
 
236
- Classes
237
- -------
231
+ timer.py: Classes
232
+ -----------------
238
233
 
239
234
  The Module ``timer.py`` contains the following classes
240
235
 
241
236
 
242
- .. Static-classes-of-module-timer.py-label:
243
- .. table:: *Static classes of module timer.py*
237
+ .. timer.py-Classes-label:
238
+ .. table:: *timer.py classes*
244
239
 
245
240
  +---------+------+---------------+
246
241
  |Name |Type |Description |
@@ -251,14 +246,14 @@ The Module ``timer.py`` contains the following classes
251
246
  +---------+------+---------------+
252
247
 
253
248
 
254
- Class Timer
255
- -----------
249
+ timer.py Class: Timer
250
+ ---------------------
256
251
 
257
- Methods
258
- ^^^^^^^
252
+ Timer: Methods
253
+ ^^^^^^^^^^^^^^
259
254
 
260
- .. Methods-of-class-Timer-label:
261
- .. table:: *Methods of class Timer*
255
+ .. Timer-Methods-label:
256
+ .. table:: *Timer Methods*
262
257
 
263
258
  +----------+------------------------------------+
264
259
  |Name |Description |
@@ -270,8 +265,8 @@ Methods
270
265
  |end |End Timer and Log Timer info message|
271
266
  +----------+------------------------------------+
272
267
 
273
- Method sh_task_id
274
- ^^^^^^^^^^^^^^^^^
268
+ Timer Method: sh_task_id
269
+ ^^^^^^^^^^^^^^^^^^^^^^^^
275
270
 
276
271
  Show task id, which is created by the concatination of the following items if they are defined:
277
272
  #. package,
@@ -285,8 +280,8 @@ __qualname__ is used.
285
280
  Parameter
286
281
  """""""""
287
282
 
288
- .. Parameter-of-method-sh_task_id-label:
289
- .. table:: *Parameter-of-method-sh_task_id*
283
+ .. Timer-Method-sh_task_id-Parameter-label:
284
+ .. table:: *Timer Method sh_task_id: Parameter*
290
285
 
291
286
  +--------+-----+-----------------+
292
287
  |Name |Type |Description |
@@ -303,8 +298,8 @@ Parameter
303
298
  Return Value
304
299
  """"""""""""
305
300
 
306
- .. Return-value-of-method-sh_task_id-label:
307
- .. 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*
308
303
 
309
304
  +----+-----+-----------+
310
305
  |Name|Type |Description|
@@ -312,14 +307,14 @@ Return Value
312
307
  | |TyStr|Task Id |
313
308
  +----+-----+-----------+
314
309
 
315
- Method start
316
- ^^^^^^^^^^^^
310
+ Timer Method: start
311
+ ^^^^^^^^^^^^^^^^^^^
317
312
 
318
313
  Parameter
319
314
  """""""""
320
315
 
321
- .. Parameter-of-method-start-label:
322
- .. table:: *Parameter of method start*
316
+ .. Timer-Method-start-Parameter-label:
317
+ .. table:: *Timer Method start: Parameter*
323
318
 
324
319
  +--------+-----+-------------+
325
320
  |Name |Type |Description |
@@ -333,14 +328,14 @@ Parameter
333
328
  |sep |TyStr|Separator |
334
329
  +--------+-----+-------------+
335
330
 
336
- Method: end
337
- ^^^^^^^^^^^
331
+ Timer Method: end
332
+ ^^^^^^^^^^^^^^^^^
338
333
 
339
334
  Parameter
340
335
  """""""""
341
336
 
342
- .. Parameter-of-end-method-label:
343
- .. table:: *Parameter of end method*
337
+ .. Timer-Method-end-Parameter-label:
338
+ .. table:: *Timer Method end: Parameter*
344
339
 
345
340
  +--------+-----+-------------+
346
341
  |Name |Type |Description |
@@ -373,8 +368,8 @@ Overview
373
368
  |exit\_.py|Exit Manafement setup module|
374
369
  +---------+----------------------------+
375
370
 
376
- Application setup module: app\_.py
377
- ==================================
371
+ Base module: app\_.py
372
+ =====================
378
373
 
379
374
  The Module ``app.py`` contains a single static class ``App_``.
380
375
 
@@ -383,11 +378,11 @@ Class: App\_
383
378
 
384
379
  The static class ``App_`` contains the subsequent static variables and methods
385
380
 
386
- Static Variables
387
- ^^^^^^^^^^^^^^^^
381
+ App\_: Static Variables
382
+ ^^^^^^^^^^^^^^^^^^^^^^^
388
383
 
389
- .. Static-variables-of-class-App_-label:
390
- .. table:: *Static Variables of class App_*
384
+ .. Appl\_ Static-Variables-label:
385
+ .. table:: *Appl\_ tatic Variables*
391
386
 
392
387
  +---------------+-------+-------+---------------------+
393
388
  |Name |Type |Default|Description |
@@ -405,11 +400,11 @@ Static Variables
405
400
  |app |TyDic |None |Appliction dictionary|
406
401
  +---------------+-------+-------+---------------------+
407
402
 
408
- Methods
409
- ^^^^^^^
403
+ App\_: Methods
404
+ ^^^^^^^^^^^^^^
410
405
 
411
- .. Methods-of-class-App_-label:
412
- .. table:: *Methods of class App_*
406
+ .. App\_-Methods-label:
407
+ .. table:: *App\_ Methods*
413
408
 
414
409
  +----+------+------------------------------------+
415
410
  |Name|Type |Description |
@@ -420,14 +415,14 @@ Methods
420
415
  |sh |class |show (return) class |
421
416
  +----+------+------------------------------------+
422
417
 
423
- Method: init
424
- ^^^^^^^^^^^^
418
+ App\_ Method: init
419
+ ^^^^^^^^^^^^^^^^^^
425
420
 
426
421
  Parameter
427
422
  """""""""
428
423
 
429
- .. Parameter-of-method-init-label:
430
- .. table:: *Parameter of method init*
424
+ .. App\_-Method-init-label:
425
+ .. table:: *App\_ Method: init*
431
426
 
432
427
  +---------+-----+-----------------+
433
428
  |Name |Type |Description |
@@ -437,11 +432,11 @@ Parameter
437
432
  |\**kwargs|TyAny|Keyword arguments|
438
433
  +---------+-----+-----------------+
439
434
 
440
- Method: sh
441
- ^^^^^^^^^^
435
+ App\_ Method: sh
436
+ ^^^^^^^^^^^^^^^^
442
437
 
443
- .. Parameter-of-method-sh-label:
444
- .. table:: *Parameter of method sh*
438
+ .. App\_-Method-sh-label:
439
+ .. table:: *App\_ Method: sh*
445
440
 
446
441
  +---------+-----+-----------------+
447
442
  |Name |Type |Description |
@@ -454,8 +449,8 @@ Method: sh
454
449
  Return Value
455
450
  """"""""""""
456
451
 
457
- .. Return-values-of-method-sh-label:
458
- .. table:: *Return values of method sh*
452
+ .. App\_-Method-sh-Return-Value-label:
453
+ .. table:: *App\_ Method sh: Return Value*
459
454
 
460
455
  +----+--------+-----------+
461
456
  |Name|Type |Description|
@@ -463,21 +458,21 @@ Return Value
463
458
  |log |TyLogger|Logger |
464
459
  +----+--------+-----------+
465
460
 
466
- cfg\_.py
467
- ========
461
+ Base module: cfg\_.py
462
+ =====================
468
463
 
469
464
  The Base module cfg\_.py contains a single static class ``Cfg_``.
470
465
 
471
- Class Cfg\_
472
- -----------
466
+ cfg\_.py Class Cfg\_
467
+ ---------------------
473
468
 
474
469
  The static class ``Cfg_`` contains the subsequent static variables and methods
475
470
 
476
- Static Variables
477
- ^^^^^^^^^^^^^^^^
471
+ Cfg\_Static Variables
472
+ ^^^^^^^^^^^^^^^^^^^^^
478
473
 
479
- .. Static-variables-of-Cfg_-label:
480
- .. table:: *Static Variables of Cfg_*
474
+ .. Cfg\_-Static-Variables-label:
475
+ .. table:: *Cfg\_ Static Variables*
481
476
 
482
477
  +----+-----+-------+--------------------+
483
478
  |Name|Type |Default|Description |
@@ -485,11 +480,11 @@ Static Variables
485
480
  |cfg |TyDic|None |Configuration object|
486
481
  +----+-----+-------+--------------------+
487
482
 
488
- Methods
489
- ^^^^^^^
483
+ Cfg\_ Methods
484
+ ^^^^^^^^^^^^^
490
485
 
491
- .. Methods-of-class-Cfg_-label:
492
- .. table:: *Methods of class Cfg_*
486
+ .. Cfg\_-Methods-label:
487
+ .. table:: *Cfg\_ Methods*
493
488
 
494
489
  +----+------+-----------------------------------+
495
490
  |Name|Type |Description |
@@ -498,14 +493,14 @@ Methods
498
493
  | | |variable cls.dic and return cls.cfg|
499
494
  +----+------+-----------------------------------+
500
495
 
501
- Method: sh
502
- ^^^^^^^^^^
496
+ Cfg\_ Method: sh
497
+ ^^^^^^^^^^^^^^^^
503
498
 
504
499
  Parameter
505
500
  """""""""
506
501
 
507
- .. Parameter-of-method-init-label:
508
- .. table:: *Parameter of method sh*
502
+ .. Cfg\_-Method-sh-Parameter-label:
503
+ .. table:: *Cfg\_ Method sh: Parameter*
509
504
 
510
505
  +--------+--------+-----------------+
511
506
  |Name |Type |Description |
@@ -520,8 +515,8 @@ Parameter
520
515
  Return Value
521
516
  """"""""""""
522
517
 
523
- .. Return-values-of-method-sh-label:
524
- .. table:: *Return values of method sh*
518
+ .. Cfg\_-Method-sh-Return-Value-label:
519
+ .. table:: *Cfg\_ Method sh: Return Value*
525
520
 
526
521
  +-------+-----+-----------+
527
522
  |Name |Type |Description|
@@ -529,21 +524,21 @@ Return Value
529
524
  |cls.cfg|TyDic| |
530
525
  +-------+-----+-----------+
531
526
 
532
- Base Modul ext\_.py
533
- ===================
527
+ Base Modul: exit\_.py
528
+ =====================
534
529
 
535
530
  The Base module exit\_.py contains a single static class ``Ext_``.
536
531
 
537
- class Exit\_
538
- ------------
532
+ exit\_.py class: Exit\_
533
+ -----------------------
539
534
 
540
- 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.
541
536
 
542
- Static Variables
543
- ^^^^^^^^^^^^^^^^
537
+ Exit\_: Variables
538
+ ^^^^^^^^^^^^^^^^^
544
539
 
545
- .. Static variables-of-class-Ext_-label:
546
- .. table:: *Static variables of class Ext_*
540
+ .. Exit\_-Variables-label:
541
+ .. table:: *Exit\_ Variables*
547
542
 
548
543
  +--------------+------+-------+---------------------+
549
544
  |Name |Type |Default|Description |
@@ -557,11 +552,11 @@ Static Variables
557
552
  |sw_interactive|TyBool|False |interactive switch |
558
553
  +--------------+------+-------+---------------------+
559
554
 
560
- Methods
561
- ^^^^^^^
555
+ Exit\_: Methods
556
+ ^^^^^^^^^^^^^^^
562
557
 
563
- .. Methods-of-class-Ext_-label:
564
- .. table:: *Methods of class Ext_*
558
+ .. Exit\_-Methods-label:
559
+ .. table:: *Exit\_ Methods*
565
560
 
566
561
  +----+------+------------------------------------+
567
562
  |Name|Method|Description |
@@ -572,14 +567,14 @@ Methods
572
567
  |sh |class |show (return) class |
573
568
  +----+------+------------------------------------+
574
569
 
575
- Method: init
576
- ^^^^^^^^^^^^
570
+ Exit\_: Method: init
571
+ ^^^^^^^^^^^^^^^^^^^^
577
572
 
578
573
  Parameter
579
574
  """""""""
580
575
 
581
- .. Parameter-of-method-init-label:
582
- .. table:: *Parameter of method init*
576
+ .. Exit\_-Method-init-Parameter:
577
+ .. table:: *Exit\_ Method init: Parameter*
583
578
 
584
579
  +---------+-----+-----------------+
585
580
  |Name |Type |Description |
@@ -589,14 +584,14 @@ Parameter
589
584
  |\**kwargs|TyAny|Keyword arguments|
590
585
  +---------+-----+-----------------+
591
586
 
592
- Method: sh
593
- ^^^^^^^^^^
587
+ Exit\_: Method: sh
588
+ ^^^^^^^^^^^^^^^^^^
594
589
 
595
590
  Parameter
596
591
  """""""""
597
592
 
598
- .. Parameter-of-method-sh-label:
599
- .. table:: *Parameter of method sh*
593
+ .. Exit\_-Method-sh-Parameter:
594
+ .. table:: *Exit\_ Method sh: Parameter*
600
595
 
601
596
  +---------+-----+-----------------+
602
597
  |Name |Type |Description |
@@ -609,8 +604,8 @@ Parameter
609
604
  Return Value
610
605
  """"""""""""
611
606
 
612
- .. Return-values-of-method-sh-label:
613
- .. table:: *Return values of method sh*
607
+ .. Exit\_-Method-sh-Return-Value:
608
+ .. table:: *Exit\_ Method sh: Return Value*
614
609
 
615
610
  +----+-----+-------------+
616
611
  |Name|Type |Description |
@@ -650,33 +645,25 @@ Application parameter for logging
650
645
  .. Application-parameter-used-in-log-naming-label:
651
646
  .. table:: *Application parameter used in log naming*
652
647
 
653
- +-----------------+--------------------------+-----------------+------------+
654
- |Name |Decription |Values |Example |
655
- | | +-----------------+ |
656
- | | |Value|Type | |
657
- +=================+==========================+=====+===========+============+
658
- |dir_dat |Application data directory| |Path |/otev/data |
659
- +-----------------+--------------------------+-----+-----------+------------+
660
- |tenant |Application tenant name | |str |UMH |
661
- +-----------------+--------------------------+-----+-----------+------------+
662
- |package |Application package name | |str |otev_xls_srr|
663
- +-----------------+--------------------------+-----+-----------+------------+
664
- |cmd |Application command | |str |evupreg |
665
- +-----------------+--------------------------+-----+-----------+------------+
666
- |pid |Process ID | |str |evupreg |
667
- +-----------------+--------------------------+-----+-----------+------------+
668
- |log_ts_type |Timestamp type used in |ts |Timestamp |ts |
669
- | |loggin files +-----+-----------+------------+
670
- | | |dt |Datetime | |
671
- +-----------------+--------------------------+-----+-----------+------------+
672
- |log_sw_single_dir|Enable single log |True |Bool |True |
673
- | |directory or multiple +-----+-----------+ |
674
- | |log directories |False|Bool | |
675
- +-----------------+--------------------------+-----+-----------+------------+
676
- |log_sw_pid |Enable display of pid |True |Bool |True |
677
- | |in log file name +-----+-----------+ |
678
- | | |False|Bool | |
679
- +-----------------+--------------------------+-----+-----------+------------+
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
+ +-----------------+---------------------------+----------+------------+
680
667
 
681
668
  Log type and Log directories
682
669
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -705,8 +692,8 @@ Single or multiple Application log directories can be used for each message type
705
692
  Log files naming
706
693
  ^^^^^^^^^^^^^^^^
707
694
 
708
- Conventions
709
- """""""""""
695
+ Naming Conventions
696
+ """"""""""""""""""
710
697
 
711
698
  .. Naming-conventions-for-logging-file-paths-label:
712
699
  .. table:: *Naming conventions for logging file paths*
@@ -725,47 +712,34 @@ Conventions
725
712
  |critical|/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
726
713
  +--------+-------------------------------------------------------+-------------------------+
727
714
 
728
- Examples (with log_ts_type = 'ts')
729
- """"""""""""""""""""""""""""""""""
730
-
731
- The examples use the following parameter values.
732
-
733
- #. dir_dat = '/data/otev'
734
- #. tenant = 'UMH'
735
- #. package = 'otev_srr'
736
- #. cmd = 'evupreg'
737
- #. log_sw_single_dir = True
738
- #. log_sw_pid = True
739
- #. log_ts_type = 'ts'
715
+ Naming Examples
716
+ """""""""""""""
740
717
 
741
718
  .. Naming-examples-for-logging-file-paths-label:
742
719
  .. table:: *Naming examples for logging file paths*
743
720
 
744
- +--------+----------------------------------------+------------------------+
745
- |Type |Directory |File |
746
- +========+========================================+========================+
747
- |debug |/data/otev/umh/RUN/otev_srr/evupreg/logs|debs_1737118199_9470.log|
748
- +--------+----------------------------------------+------------------------+
749
- |info |/data/otev/umh/RUN/otev_srr/evupreg/logs|infs_1737118199_9470.log|
750
- +--------+----------------------------------------+------------------------+
751
- |warning |/data/otev/umh/RUN/otev_srr/evupreg/logs|wrns_1737118199_9470.log|
752
- +--------+----------------------------------------+------------------------+
753
- |error |/data/otev/umh/RUN/otev_srr/evupreg/logs|errs_1737118199_9470.log|
754
- +--------+----------------------------------------+------------------------+
755
- |critical|/data/otev/umh/RUN/otev_srr/evupreg/logs|crts_1737118199_9470.log|
756
- +--------+----------------------------------------+------------------------+
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
+ +--------+--------------------------------------------+------------------------+
757
734
 
758
735
  Python Terminology
759
736
  ==================
760
737
 
761
- Python package
762
- --------------
763
-
764
- Overview
765
- ^^^^^^^^
738
+ Python packages
739
+ ---------------
766
740
 
767
- .. Python package-label:
768
- .. table:: *Python package*
741
+ .. Python packages-label:
742
+ .. table:: *Python packages*
769
743
 
770
744
  +-----------+-----------------------------------------------------------------+
771
745
  |Name |Definition |
@@ -777,47 +751,42 @@ Overview
777
751
  |sub-package|another pyhon package. |
778
752
  +-----------+-----------------------------------------------------------------+
779
753
 
780
- Python package sub-directories
781
- ------------------------------
782
-
783
- Overview
784
- ^^^^^^^^
785
-
786
- .. Python package sub-direcories-label:
787
- .. table:: *Python package sub-directories*
788
-
789
- +---------------------+----------------------------------------+
790
- |Name |Definition |
791
- +=====================+========================================+
792
- |Python |directory contained in a python package.|
793
- |package sub-directory| |
794
- +---------------------+----------------------------------------+
795
- |Special python |Python package sub-directories with a |
796
- |package sub-directory|special meaning like data or cfg. |
797
- +---------------------+----------------------------------------+
798
-
799
- Special python package sub-directories
800
- --------------------------------------
801
-
802
- Overview
803
- ^^^^^^^^
804
-
805
- .. Special-python-package-sub-directories-label:
806
- .. table:: *Special python sun-directories*
754
+ Python package Sub-directories
755
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
807
756
 
808
- +----+------------------------------------------+
809
- |Name|Description |
810
- +====+==========================================+
811
- |data|Directory for package data files. |
812
- +----+------------------------------------------+
813
- |cfg |Directory for package configuration files.|
814
- +----+------------------------------------------+
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
+ +-------+------------------------------------------+
815
787
 
816
788
  Python package files
817
- --------------------
818
-
819
- Overview
820
- ^^^^^^^^
789
+ ^^^^^^^^^^^^^^^^^^^^
821
790
 
822
791
  .. Python-package-files-label:
823
792
  .. table:: *Python package files*
@@ -825,24 +794,21 @@ Overview
825
794
  +--------------+---------------------------------------------------------+
826
795
  |Name |Definition |
827
796
  +==============+==========+==============================================+
828
- |Python |File within a python package. |
829
- |package file | |
797
+ |Python |Files within a python package. |
798
+ |package files | |
830
799
  +--------------+---------------------------------------------------------+
831
- |Special python|Python package file which are not modules and used as |
832
- |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``. |
833
802
  +--------------+---------------------------------------------------------+
834
- |Python |File with suffix ``.py`` which could be empty or contain |
835
- |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.|
836
805
  +--------------+---------------------------------------------------------+
837
- |Special python|Python package module with special name and functionality|
838
- |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. |
839
808
  +--------------+---------------------------------------------------------+
840
809
 
841
810
  Special python package files
842
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
843
-
844
- Overview
845
- °°°°°°°°
811
+ """"""""""""""""""""""""""""
846
812
 
847
813
  .. Special-python-package-files-label:
848
814
  .. table:: *Special python package files*
@@ -857,10 +823,7 @@ Overview
857
823
  +--------+--------+---------------------------------------------------------------+
858
824
 
859
825
  Special python package modules
860
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
861
-
862
- Overview
863
- °°°°°°°°
826
+ """"""""""""""""""""""""""""""
864
827
 
865
828
  .. Special-Python-package-modules-label:
866
829
  .. table:: *Special Python package modules*
@@ -884,34 +847,24 @@ Overview
884
847
  Python elements
885
848
  ---------------
886
849
 
887
- Overview
888
- °°°°°°°°
889
-
890
850
  .. Python elements-label:
891
851
  .. table:: *Python elements*
892
852
 
893
- +-------------------+---------------------------------------------+
894
- |Name |Definition |
895
- +===================+=============================================+
896
- |Python method |Function defined in a python module. |
897
- +-------------------+---------------------------------------------+
898
- |Special |Python method with special name and |
899
- |python method |functionality like ``init``. |
900
- +-------------------+---------------------------------------------+
901
- |Python class |Python classes are defined in python modules.|
902
- +-------------------+---------------------------------------------+
903
- |Python class method|Python method defined in a python class. |
904
- +-------------------+---------------------------------------------+
905
- |Special |Python class method with special name and |
906
- |Python class method|functionality like ``init``. |
907
- +-------------------+---------------------------------------------+
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
+ +---------------------+--------------------------------------------------------+
908
864
 
909
865
  Special python methods
910
866
  ^^^^^^^^^^^^^^^^^^^^^^
911
867
 
912
- Overview
913
- °°°°°°°°
914
-
915
868
  .. Special-python-methods-label:
916
869
  .. table:: *Special python methods*
917
870
 
@@ -0,0 +1,14 @@
1
+ ka_uts_com/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ ka_uts_com/__version__.py,sha256=t_0Kx0fHmWQPmaQ0lBYRU1WhrCePgyKr1kpAoor2xzI,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.3.250502.dist-info/licenses/LICENSE.txt,sha256=BiT3QGI_2iRbdvgS3HDig57lnXJVk60Pj4xM9eeCczI,814
11
+ ka_uts_com-2.2.3.250502.dist-info/METADATA,sha256=7aAoUwJnNqpU81-5PieL2DtaBE-ZcUWOBMcEvwbZbJ0,31847
12
+ ka_uts_com-2.2.3.250502.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
13
+ ka_uts_com-2.2.3.250502.dist-info/top_level.txt,sha256=cWCIrm1g6Jn-FbCQuB3wBrrNH1YwqVlc6mE0jV6vg74,21
14
+ ka_uts_com-2.2.3.250502.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.0.0)
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=X178HytYJn2nJ_3u7ZEbA14WN68VJsJ-_HnHbi62DTE,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=DvlZo5FBtVPJlNa4LIX_7x4kgFpRsPBPa0OGOre7aK0,3075
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.0.250427.dist-info/licenses/LICENSE.txt,sha256=BiT3QGI_2iRbdvgS3HDig57lnXJVk60Pj4xM9eeCczI,814
11
- ka_uts_com-2.2.0.250427.dist-info/METADATA,sha256=8NKVY_1kbxdJnkEAxJrbpYdftQpl29nzfS_aALTE8gM,32848
12
- ka_uts_com-2.2.0.250427.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
13
- ka_uts_com-2.2.0.250427.dist-info/top_level.txt,sha256=cWCIrm1g6Jn-FbCQuB3wBrrNH1YwqVlc6mE0jV6vg74,21
14
- ka_uts_com-2.2.0.250427.dist-info/RECORD,,