ka-uts-wdp 2.0.1.250403

Watchdog Processor

Overview

Dictionary ‘Utilities’

Installation

Package ka_uts_wdp can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_uts_wdp

To install with conda:

$ conda install -c conda-forge ka_uts_wdp

Package logging

Standard or user specific Package logging of the package ka_uts_wdp is defined in the static logging class Log_ of Base module log_.py of the Communication Package ka_uts_com. The default Logging configuration is defined by the yaml files log.std.yml or log.usr.yml in the data directory of the Communication package. The Logging configuration could be overriden by yaml files with the same names in the data directory of the application package ka_uts_wdp. Logging defines log file paths for the following log message types: .

1. debug

2. error

3. info

4. log

Naming conventions for logging file

Type	Directory	File
debug	/data/<tenant>/RUN/<package>/<function>/debs	debs_<pid>_<ts>.log
error	/data/<tenant>/RUN/<package>/<function>/errs	errs_<pid>_<ts>.log
warning	/data/<tenant>/RUN/<package>/<function>/errs	wrns_<pid>_<ts>.log
info	/data/<tenant>/RUN/<package>/<function>/logs	infs_<pid>_<ts>.log
log	/data/<tenant>/RUN/<package>/<function>/logs	logs_<pid>_<ts>.log

Naming examples of logging file

Type	Directory	File
debug	/data/umh/RUN/umh_otec/srr/debs	debs_9470_1737118199.log
error	/data/umh/RUN/umh_otec/srr/errs	errs_9470_1737118199.log
warning	/data/umh/RUN/umh_otec/srr/errs	errs_9470_1737118199.log
info	/data/umh/RUN/umh_otec/srr/logs	logs_9470_1737118199.log

Package files

Classification

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

1. Special files

2. Dunder modules

3. Sub Package

4. Data files

Special files

Special files of package ka uts wdp

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.

Dunder Modules

Dunder-Modules

Name	Type	Description
__init__.py	Package directory marker file	The module 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.
__version__.py	Version file	The module consist of Assignment Statements for system Variables used in Versioning.

Sub-packages

The Package ka_uts_wdp contains the sub-package pmeh:

Sub-package pmeh

The Sub-package pmeh contains following files:

1. special file: py.typed

2. dunder module: __init__.py

3. modules: wdp.py

Module: wdp.py

The Module wdp.py contains the followinga classes:

Name	Type	Description
CustomHandler	normal	Custom Handler of PatternMatchingEventHandler
WdP	static	Watch Dog Processor

Class: CustomHandler

The class CustomHandler contains the subsequent methods.

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 refered by file path is modified’ event

Class WdP

The static class WdP contains the subsequent methods.

Methods

Methods-of-class-WdP

Name	Type	Description
pmeh	static	WatchDog Task for pattern matching of files paths

Appendix

Table of Content

• Overview

• Installation

• Package logging

• Package files

• Special files

• Dunder Modules

• Sub-packages

  • Sub-package pmeh

    • Module: wdp.py

      • Class: CustomHandler

        • Methods

      • Class WdP

        • Methods

• Appendix