ka-uts-prc 3.0.0.250505

Process and Thread Management Utilities

Overview

Processing Utilities

Installation

The package ka_uts_prc can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_uts_prc

To install with conda:

$ conda install -c conda-forge ka_uts_prc

This requires that the readme extra is installed:

$ python -m pip install ka_uts_prc[readme]

Modules

The Package ka_uts_prc contains the subsequent modules.

Modules of package ka_uts_prc*

Module
Name	Description
prc.py	Management of “array of arrays”.
run.py	Array of Dictionaries

Processing Module with classes

Module	Static Classes
Name	Type	Name	Description
prc	Task runner for iterator	Ra	Process Task decorated by the ray remote decorator for all iterator items.
		Co	Process Task using concurrent futures with process- or thread-pool.
		Mp	Process Tasks using multiprocessing with process- or thread-pool
		Sp	Process Task sequentially for all iterator items.
		Prc	Create iterator for path-templates optionally modified by transformer functions (if defined).
			Process Tasks by selecting the run-, process- or thread-function of one of the Processing classes Ra, Co, Mp, Sp with the run_method using the function table of run methods: d_run_method_2_fnc.

Special-Modules without classes

Module	Type	Statements
__init__	Package directory marker	Module with no Statements; the module is used to mark the directory it contains as a package. A dummy Module enforces explicit imports and thus clear namespace use and call them with the dot dot notation
__version__	Version	Assignment Statements for Version System Variables

Processing Modul: prc_by_dir

The Modul prc_by_dir contains the subsequent static classes with static variables and methods

Classes of module prc_by_dir

Static Classes
Name	Description
Ra	Execute tasks using Ray
Co	Execute tasks using Concurrent futures
Mp	Execute tasks using multiprocessing
Sp	Execute tasks using single processing
Prc	Run tasks with selected method

static Class: Ra

static Methods

Ra static Methods of prc

Static Method	Parameter: P / Return Value: RV
Name	Description	Name	Type	P/RV	Description
process	Run tasks in parallel by executing the task decorated with with the ray remote decorator for every iterator item	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value

static Class: Co

static Methods

Co static Methods of prc

Static Method	Parameter: P / Return Value: RV
Name	Description	Name	Type	P/RV	Description
process	Run tasks in parallel by applying the map method of the concurrent futures process pool executor to the task and the iterator.	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value
thread	Run tasks in parallel by applying the map method of the concurrent futures thread pool executor to the task and the iterator.	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value

static Class: Mp

static Methods

Mp static Methods of prc

Static Method	Parameter: P / Return Value: RV
Name	Description	Name	Type	P/RV	Description
process	Run tasks in parallel by applying the map method of the multiprocessing process pool to the task and the iterator.	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value
thread	Run tasks in parallel by applying the map method of the multiprocessing thread pool to the task and the iterator.	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value

static Class: Sp

static Methods

Sp static Methods of prc

Static Method	Parameter: P / Return Value: RV
Name	Description	Name	Type	P/RV	Description
run	Run tasks sequentially for all items of the iterator	cls	class	P	current class
		kwargs	T_Dic	P	keyword arguments
			None	RV	no return value

static Class: Prc

static Variables

Prc static Variables of prc

Static Variable
Name	Type	Description
d_run_method_2_fnc		T_Dic	Dictionary to translate run methods into run functions

static Methods

Prc static Methods of prc

Static Method	Parameter: P / Return Value: RV
Name	Description	Name	Type	P/RV	Description
do	Select executer with run method and run method function table.	cls	class	P	current class
	Create iterator using the Task function: yield_dl_template.	kwargs	T_Dic	P	keyword arguments
	Run the Task function: task with the executor.		None	RV	no return value

Special Modul: __version__

The Modul __version__ contains no classes, but assignment statements for system variables used by versioning.

__version_ System Variables

System Variable	Example
__title__	‘ka_uts_prc’
__description__	‘Processing Utilities.’
__url__	‘https://ka-com.readthedocs.io/en/latest’
__version___	‘1.0.0.24.08.24’
__build__	0x022200
__author_email_	‘Bernd Stroehle’
__license__	‘Apache-2.0’
__copyright__	‘Copyright 2024 Bernd Stroehle
__cake__	u’u2728 U0001f370 u2728’

Module Data

System Variable	Description
log.main.tenant.yml __copyright__	‘ka_uts_prc’ ‘Copyright 2023 bs29’

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
Value|Type
dir_dat	Application data directory		Path	/otev/data
tenant	Application tenant name		str	UMH
package	Application package name		str	otev_xls_srr
cmd	Application command		str	evupreg
pid	Process ID		str	evupreg
log_ts_type	Timestamp type used in loggin files	ts	Timestamp	ts
		dt	Datetime
log_sw_single_dir	Enable single log directory or multiple log directories	True	Bool	True
		False	Bool
log_sw_pid	Enable display of pid in log file name	True	Bool	True
		False	Bool

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 (with log_ts_type = ‘ts’)

The examples use the following parameter values.

1. dir_dat = ‘/data/otev’

2. tenant = ‘UMH’

3. package = ‘otev_srr’

4. cmd = ‘evupreg’

5. log_sw_single_dir = True

6. log_sw_pid = True

7. log_ts_type = ‘ts’

Naming examples for logging file paths

Type	Directory	File
debug	/data/otev/umh/RUN/otev_srr/evupreg/logs	debs_1737118199_9470.log
info	/data/otev/umh/RUN/otev_srr/evupreg/logs	infs_1737118199_9470.log
warning	/data/otev/umh/RUN/otev_srr/evupreg/logs	wrns_1737118199_9470.log
error	/data/otev/umh/RUN/otev_srr/evupreg/logs	errs_1737118199_9470.log
critical	/data/otev/umh/RUN/otev_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	directory contained in a python package.
Special python package sub-directory	Python package sub-directories with a special meaning like data or cfg.

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 file	File within a python package.
Special python package file	Python package file which are not modules and used as python marker files like __init__.py.
Python package module	File with suffix .py which could be empty or contain python code; Other modules can be imported into a module.
Special python package module	Python package module with special name and functionality like main.py or __init__.py.

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

Name	Definition
Python method	Function defined in a python module.
Special python method	Python method with special name and functionality like init.
Python class	Python classes are defined in python modules.
Python class method	Python method defined in a python class.
Special Python class method	Python class method with special name and functionality like init.

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

• Modules

  • Processing Modul: prc_by_dir

    • static Class: Ra

    • static Class: Co

    • static Class: Mp

    • static Class: Sp

    • static Class: Prc

      • static Variables

      • static Methods

  • Special Modul: __version__

  • Module Data

• Appendix

  • Package Logging

    • Description

    • Log message types

      • Application parameter for logging

      • Log type and Log directories

      • Log files naming

        • Conventions

        • Examples (with log_ts_type = ‘ts’)

  • 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