Communication Utilities
The package ka_uts_uts can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install ka_uts_uts
To install with conda:
$ conda install -c conda-forge ka_uts_uts
(c.f.: Appendix: Package Logging)
The Package ka_uts_uts consist of the following file types (c.f.: Appendix):
The Sub-package ioc contains the following modules.
Modules of Sub package ioc Name Decription jinja_.py I/O Control methods for jinja2 files. yaml_.py I/O Control methods for yaml files.
The Module jinja2_.py contains the static class Jinja2
The static Class Jinja2 provides I/O Control methods for Jinja2 files; it contains the subsequent methods.
Methods of class Jinja2 Name Description read Read log file path with jinja read_template Read log file path with jinja2
Parameter of method read Name Type Description pacmod TnDic filename str
Parameter of method read template Name Type Description pacmod TnDic filename TnAny
The Module yaml_.py contains the static class Yaml.
The static Class Yaml provides I/O Control functions for Yaml files; it contains the subsequent methods
Methods of class Yaml Name Description load Load yaml string into any object using yaml loader. Default is yaml.safeloader read Read yaml file path into any object using yaml loader. Default loader is yaml.safeloader
Parameter of method load Name Type Description string TyStr loader TyStr
Parameter of method read Name Type Description path TyStr loader TyStr
The Sub-package utils contains the following modules.
Modules-of-Sub-package-utils Name Functionality pacmod.py Manage Packages and Modules pac.py Manage Packages
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.
Logging defines log file path names for the following log message types: .
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
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
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
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 packages 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-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 a special meaning.
Special python sun-directories Name Description data Directory for package data files. cfg Directory for package configuration files.
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 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 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 Name 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 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.