ka_uts_wdp
Overview
Watch Dog Processor ‘Utilities’
Installation
Package ka_uts_wdp can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install ka_uts_wdpTo install with conda:
$ conda install -c conda-forge ka_uts_wdpPackage logging
(c.f.: Appendix: Package Logging)
Package files
Classification
The Package ka_uts_wdp consist of the following file types (c.f.: Appendix):
Special files: (c.f.: Appendix: Special python package files)
Dunder modules: (c.f.: Appendix: Special python package modules)
Sub-packages
pmeh
Special files: (c.f.: Appendix: Special python package files)
Dunder modules: (c.f.: Appendix: Special python package modules)
Modules
modules: wdp.py
Sub-package: pmeh
Modules
The Sub-package pmeh contains the following modules.
pmeh Modules Name
Decription
wdp.py
Watch Dog Processor
Module: wdp.py
The Module wdp.py contains the following classes:
Name
Type
Description
CustomHandler
normal
Custom Handler of PatternMatchingEventHandler
WdP
static
Watch Dog Processor
wdp.py Class: CustomHandler
The class CustomHandler contains the subsequent methods.
CustomHandler Methods
Methods of class CustomHandler Name
Type
Description
__init__
instance
Initialise class CustomHandler
on_created
instance
Process event ‘File. refered by file path is created’
on_modified
instance
Process ‘File referred by file path is modified’ event
wdp.py Class: WdP
The static class WdP contains the subsequent methods.
WdP Methods
Methods-of-class-WdP Name
Type
Description
pmeh
static
WatchDog Task for pattern matching of files paths
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 standard- or user-configuration files in the logging package configuration directory:
<logging package directory>/cfg/ka_std_log.yml,
<logging package directory>/cfg/ka_usr_log.yml.
The Logging configuration of the logging package could be overriden by yaml files with the same names in the application package- or application data-configuration directories:
<application package directory>/cfg
<application data directory>/cfg.
Log message types
Logging defines log file path names for the following log message types: .
debug
info
warning
error
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
681025
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
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
Naming 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 packages
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-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.
Special python package Sub-directories
Special python Sub-directories Name
Description
bin
Directory for package scripts.
cfg
Directory for package configuration files.
data
Directory for package data files.
service
Directory for systemd service scripts.
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 package files
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
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
Python elements Name
Description
Python method
Python functions defined in python modules.
Special python method
Python functions with special names and functionalities.
Python class
Classes defined in python modules.
Python class method
Python methods defined in python classes
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.
Table of Contents
1 maintainer
Metadata
1 maintainer
Release files for ka-uts-wdp 4.0.3.250520
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ka_uts_wdp-4.0.3.250520.tar.gz | 47.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ka_uts_wdp-4.0.3.250520-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 58.3 kB
Release files / ka_uts_wdp-4.0.3.250520.tar.gz
| Download URL | ka_uts_wdp-4.0.3.250520.tar.gz |
|---|---|
| Size | 47.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d26a2404b157c8991f61fcaffd9c09d15d7ed641dba1eea3cbd12f6f93aab051
|
|
BLAKE2b-256 checksum How to use checksums |
ae578fd60fb6101c954309c8daa88065cbdb20c4a4c611d2ccdeb012d16090c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / ka_uts_wdp-4.0.3.250520-py3-none-any.whl
| Download URL | ka_uts_wdp-4.0.3.250520-py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f9bec5eb4fbfd0faea3f01ee704c5be9cf7d3d7183484c9dfc7e0194e1ba80d9
|
|
BLAKE2b-256 checksum How to use checksums |
b3ac8c8a962165a382715c8f8b0746bb60caa900f27a47611842934d948d4499
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
