ka-uts-com 2.1.1.250415

Communication Class Utilities

Overview

Communication Utilities

Installation

The package ka_uts_com can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_uts_com

To install with conda:

$ conda install -c conda-forge ka_uts_com

Package files

Classification

The Files of Package ka_uts_com could be classified into the follwing file types:

1. Special files

2. Dunder modules

3. Decorator modules

4. Package modules

5. Data files

Decorator Modules

Overview

Decorator Modules

Name	Decription
dec.py	Decorators module

Data Files

Overview

Data Files

Name	Description
log.std.yml	Yaml configuration file for standard logging
log.usr.yml	Yaml configuration file for user logging

Package Files

Classification

The Modules of Package ka_uts_com could be classified into the following module types:

1. Communication Modules

2. Base Modules

Communication Modules

Overview

Communication Modules

Name	Decription
com.py	Communication handling module
timer.py	Timer management module

Communication module com.py

The Communication Module com.py contains the single static class Com.

Class Com

The static Class Com contains the subsequent variables and methods.

Variables

Variables of class Com

Name	Type	Default	Description
d_pacmod	TyDic	{}	pacmod dictionary
pid	TyInt	None	current Process id
sw_init	TyBool	None	Initialisation switch
Timestamp fields
ts	TnTimeStamp	None	Timestamp
ts_start	TnDateTime	None	start timestamp in date time format
ts_end	TnDateTime	None	end timestamp in date time format
ts_etime	TnDateTime	None	elapse Time
d_timer	TyDic	False	Timer dictionary
Links to other Classes
App	TyAny	False	Application class
cfg	TyDic	None	Configuration dictionary
Log	TyLogger	False	Log class
Exit	TyAny	False	Exit class

Methods

Methods-of-class-Com

Name	Description
init	Initialise static variables if they are not initialized
sh_kwargs	Show keyword arguments

Method init

Parameter

Parameter-of-method-init

Name	Type	Description
cls	class	current class
**kwargs	TyAny	keyword arguments

Method sh_kwargs

Parameter

Parameter of method sh_kwargs

Name	Type	Description
cls	class	current class
root_cls	class	root lass
d_parms	TyDic	parameter dictionary
*args	list	arguments array

Time management Module timer.py

Classes

The Module timer.py contains the following classes

Static classes of module timer.py

Name	Type	Description
Timestamp	static	Timestamp class
Timer	static	Timer class

Class Timer

Methods

Methods of class Timer

Name	Description
sh_task_id	Show task id
start	Start Timer
end	End Timer and Log Timer info message

Method sh_task_id

Show task id, which is created by the concatination of the following items if they are defined: #. package, #. module, #. class_name, #. parms The items package and module are get from the package-module directory; The item class_name is the class_id if its a string, otherwise the attribute __qualname__ is used.

Parameter

Parameter-of-method-sh_task_id

Name	Type	Description
d_pacmod	TyDic	pacmod dictionary
class_id	TyAny	Class Id
parms	TnAny	Parameters
sep	TyStr	Separator

Return Value

Return value of method sh_task_id

Name	Type	Description
	TyStr	Task Id

Method start

Parameter

Parameter of method start

Name	Type	Description
cls	class	current class
class_id	TyAny	Class Id
parms	TnAny	Parameter
sep	TyStr	Separator

Method: end

Parameter

Parameter of end method

Name	Type	Description
cls	class	current class
class_id	TyAny	Class Id
parms	TnAny	Parameter
sep	TyStr	Separator

Base Modules

Overview

Base Modules

Name	Decription
app_.py	Application setup module
cfg_.py	Configuration setup module
exit_.py	Exit Manafement setup module

Application setup module: app_.py

The Module app.py contains a single static class App_.

Class: App_

The static class App_ contains the subsequent static variables and methods

Static Variables

Static Variables of class App_

Name	Type	Default	Description
sw_init	TyBool	False	initialisation switch
httpmod	TyDic	None	http modus
sw_replace_keys	TnBool	False	replace keys switch
keys	TnArr	None	Keys array
reqs	TyDic	None	Requests dictionary
app	TyDic	None	Appliction dictionary

Methods

Methods of class App_

Name	Type	Description
init	class	initialise static variables of class if they are not allready initialized
sh	class	show (return) class

Method: init

Parameter

Parameter of method init

Name	Type	Description
cls	class	Current class
**kwargs	TyAny	Keyword arguments

Method: sh

Parameter of method sh

Name	Type	Description
cls	class	Current class
**kwargs	TyAny	Keyword arguments

Return Value

Return values of method sh

Name	Type	Description
log	TyLogger	Logger

cfg_.py

The Base module cfg_.py contains a single static class Cfg_.

Class Cfg_

The static class Cfg_ contains the subsequent static variables and methods

Static Variables

Static Variables of Cfg_

Name	Type	Default	Description
cfg	TyDic	None	Configuration object

Methods

Methods of class Cfg_

Name	Type	Description
sh	class	read pacmod yaml file into class variable cls.dic and return cls.cfg

Method: sh

Parameter

Parameter of method sh

Name	Type	Description
cls	class	Current class
log	TyLogger	Logger
d_pacmod	TyDic	pacmod dictionary

Return Value

Return values of method sh

Name	Type	Description
cls.cfg	TyDic

Base Modul ext_.py

The Base module exit_.py contains a single static class Ext_.

class Exit_

The static Class Exit_ contains the subsequent static variables and methods.

Static Variables

Static variables of class Ext_

Name	Type	Default	Description
sw_init	TyBool	False	initialisation switch
sw_critical	TyBool	False	critical switch
sw_stop	TyBool	False	stop switch
sw_interactive	TyBool	False	interactive switch

Methods

Methods of class Ext_

Name	Method	Description
init	class	initialise static variables of class if they are not allready initialized
sh	class	show (return) class

Method: init

Parameter

Parameter of method init

Name	Type	Description
cls	class	Current class
**kwargs	TyAny	Keyword arguments

Method: sh

Parameter

Parameter of method sh

Name	Type	Description
cls	class	Current class
**kwargs	TyAny	Keyword arguments

Return Value

Return values of method sh

Name	Type	Description
cls	class	Current class

Appendix

Package Logging

Description

The Standard or user specifig logging is carried out by the log.py module of the logging package ka_uts_log using the configuration files ka_std_log.yml or ka_usr_log.yml in the configuration directory cfg of the logging package ka_uts_log. The Logging configuration of the logging package could be overriden by yaml files with the same names in the configuration directory cfg of the application packages.

Log message types

Logging defines log file path names for the following log message types: .

1. debug

2. info

3. warning

4. error

5. critical

Application parameter for logging

Application parameter used in log naming

Name	Decription	Values	Example
dir_dat	Application data directory		/otev/data
tenant	Application tenant name		UMH
package	Application package name		otev_xls_srr
cmd	Application command		evupreg
pid	Process ID		æevupreg
log_ts_type	Timestamp type used in logging files|ts, dt	ts, dt	ts
log_sw_single_dir	Enable single log directory or multiple log directories	True, False	True

Log type and Log directories

Single or multiple Application log directories can be used for each message type:

Log types and directoriesg

Log type	Log directory
long	short	multiple	single
debug	dbqs	dbqs	logs
info	infs	infs	logs
warning	wrns	wrns	logs
error	errs	errs	logs
critical	crts	crts	logs

Log files naming

Conventions

Naming conventions for logging file paths

Type	Directory	File
debug	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
info	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
warning	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
error	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log
critical	/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>	<Log type>_<ts>_<pid>.log

Examples

Naming examples for logging file paths

Type	Directory	File
debug	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	debs_1737118199_9470.log
info	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	infs_1737118199_9470.log
warning	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	wrns_1737118199_9470.log
error	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	errs_1737118199_9470.log
critical	/data/otev/umh/RUN/otev_xls_srr/evupreg/logs	crts_1737118199_9470.log

Python Terminology

Python package

Overview

Python package

Name	Definition
Python package	Python packages are directories that contains the special module __init__.py and other modules, packages files or directories.
Python sub-package	Python sub-packages are python packages which are contained in another pyhon package.

Python package sub-directories

Overview

Python package sub-directories

Name	Definition
Python package sub-directory	Python packages sub-directories are directories contained in python packages.
Special Python package sub-directory	Special Python package sub-directories are python package sub-directories with with a special meaning

Special python package sub-directories

Overview

Special python sun-directories

Name	Description
data	Directory for package data files.
cfg	Directory for package configuration files.

Python package files

Overview

Python package files

Name	Definition
Python package files	Python packages are files within a python package.
Special python package files	Special python package files are package files which are not modules and used as python marker files like __init__.py
Python package module	Python modules are files with suffix .py; they could be empty or contain python code; other modules can be imported into a module.
Special python package module	Special python modules like __init__.py or main.py are python modules with special names and functionality.

Special python package files

Overview °°°°°°°°

Special python package files

Name	Type	Description
py.typed	Type checking marker file	The py.typed file is a marker file used in Python packages to indicate that the package supports type checking. This is a part of the PEP 561 standard, which provides a standardized way to package and distribute type information in Python.

Special python package modules

Overview °°°°°°°°

Special Python package modules

Name	Type	Description
__init__.py	Package directory marker file	The dunder (double underscore) module __init__.py is used to execute initialisation code or mark the directory it contains as a package. The Module enforces explicit imports and thus clear namespace use and call them with the dot notation.
__main__.py	entry point for the package	The dunder module __main__.py serves as an entry point for the package. The module is executed when the package is called by the interpreter with the command python -m <package name>.
__version__.py	Version file	The dunder module __version__.py consist of assignment statements used in Versioning.

Python elements

Overview °°°°°°°°

Python elements

Python method	Python methods are python functions defined in python modules.
Special python method	Special python methods are python functions with special names and functionalities.
Python class	Python classes are defined in python modules.
Python class method	Python class methods are python methods defined python classes.

Special python methods

Overview °°°°°°°°

Special python methods

Name	Type	Description
__init__	class object constructor method	The special method __init__ is called when an instance (object) of a class is created; instance attributes can be defined and initalized in the method.

Table of Contents

Table of Content

• Overview

• Installation

• Package files

• Decorator Modules

• Data Files

• Package Files

  • Classification

  • Communication Modules

  • Communication module com.py

    • Class Com

      • Variables

      • Methods

      • Method init

      • Method sh_kwargs

  • Time management Module timer.py

    • Classes

    • Class Timer

      • Methods

      • Method sh_task_id

        • Parameter

        • Return Value

      • Method start

      • Method: end

• Base Modules

  • Overview

  • Application setup module: app_.py

    • Class: App_

      • Static Variables

      • Methods

      • Method: init

      • Method: sh

        • Return Value

  • cfg_.py

    • Class Cfg_

      • Static Variables

      • Methods

      • Method: sh

        • Parameter

        • Return Value

  • Base Modul ext_.py

    • class Exit_

      • Static Variables

      • Methods

      • Method: init

      • Method: sh

        • Parameter

        • Return Value

• Appendix

  • Package Logging

    • Description

    • Log message types

      • Application parameter for logging

      • Log type and Log directories

      • Log files naming

        • Conventions

        • Examples

  • Python Terminology

    • Python package

    • Python package sub-directories

    • Special python package sub-directories

    • Python package files

      • Overview

      • Special python package files

      • Special python package modules

    • Python elements

      • Special python methods

  • Table of Contents