Com: Variables

Com: Variables

Name	Type	Default	Description
sw_init	TyBool	None	Initialisation switch
d_com_pacmod	TyDic	{}	Communication package module dictionary
d_app_pacmod	TyDic	{}	Application package module dictionary
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

Com: Methods

Com Methods

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

Com Method: init

Com Method: sh_kwargs

Timer: Methods

Timer Methods

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

Timer 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.

Timer Method: start

Timer Method: end

App_: Static Variables

Appl_ tatic Variables

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

App_: Methods

App_ Methods

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

App_ Method: init

App_ Method: sh

App_ Method: sh

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

Cfg_Static Variables

Cfg_ Static Variables

Name	Type	Default	Description
cfg	TyDic	None	Configuration object

Cfg_ Methods

Cfg_ Methods

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

Cfg_ Method: sh

Exit_: Variables

Exit_ Variables

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

Exit_: Methods

Exit_ Methods

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

Exit_: Method: init

Exit_: Method: sh

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

Python package Sub-directories

Python packages Sub-directories

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

Python package files

Python package files

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

Special python methods

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.