Skip to main content

ut_doa

Overview

Utilities for Dictionaries of Arrays

Installation

Package ut_doa can be installed from PyPI.

To install with pip:

$ python -m pip install ut_doa

Package logging

(c.f.: Appendix: Package Logging)

Package files

Classification

The Package ut_doa consist of the following file types (c.f.: Appendix: Python Glossary):

  1. Special files:

    1. py.typed

  2. Special modules:

    1. __init__.py

    2. __version__.py

  3. Modules

    1. doaod.py

    2. doa.py

Modules

Modules

Name

Description

doaod.py

Management of Dictionary of Arrays of Dictionaries.

doa.py

Management of Dictionary of Arrays.

Module: doaod.py

The Module doaod.py contains the static class DoAoD:

Class: DoAoD

The static Class DoAoD is used to manage Dictionary of Arrays of Dictionaries; it contains no variables and only static- or class- methods.

Methods
Methods of class DoAoD

Name

Description

is_dic_value_empty

Check if all keys of the given Dictionary of Arrays of Dictionaries are found in any Dictionary of the Array of Dictionaries and the value for the key is not empty.

sh_d_pddf

Convert Dictionary of Array of Dictionaries to Dictionary of Pandas dataframes.

sh_unique

Convert Dictionary of Array of Dictionaries to Dictionary of array of distinct dictionaries.

union_distinct_by_keys

Convert filtered Dictionary of Arrays of Dictionaries by keys to an Array of distinct Dictionaries.

union_distinct

Convert Dictionary of Arrays of Dictionaries to an Array of distinct Dictionaries.

union

Convert Dictionary of Arrays of Dictionaries to an Array of Dictionaries.

Module: doa.py

doa.py Classes

The Module doa.py contains the static classes DoA:

Class: DoA

The static Class DoA is used to manage Dictionary of Arrays; it contains no variables and only static- or class- methods.

Methods
Methods of class DoA

Name

Description

append_by_key_value

Append the value to the key-value of the dictionary of Arrays if the key-value exist as an array, otherwise assign the item as an array to the key and then append the value; if the item is not an array the item has to be modified as an array with the item as the only element.

append_by_keys_value

Locate the dictionary of arrays by the secondlast key of the keys if its an array and call the append_by_key_value function with the last key of the keys array, otherwise call this function with the string keys.

append_by_key_unique_value

Append the value to the key-value of the dictionary of Arrays if the key-value exist as an array and the values does not exist in the key-value, otherwise assign the item as an array to the key and then append the value; if the item is not an array the item has to be modified as an array with the item as the only element.

append_by_keys_unique_value

Locate the dictionary of arrays by the secondlast key of the keys if its an array and call the append_by_key_unique_value function with the last key of the keys array, otherwise call this function with the string keys.

extend_by_key_value

Extend the value to the key-value of the dictionary of Arrays if the key-value exist as an array, otherwise assign the item as an array to the key and then extend the value; if the item is not an array the item has to be modified as an array with the item as the only element.

extend_by_keys_value

Locate the dictionary of arrays by the secondlast key of the keys if its an array and call the extend_by_key_value function with the last key of the keys array, otherwise call this function with the string keys.

union_distinct_by_keys

Create new array with distinct elements of the arrays selected from the dictionary of arrays by the keys.

union_distinct

Create new array with distinct elements of each array of the dictionary of arrays.

union

Create new array with elements of each array of the dictionary of arrays.

Appendix

Package Logging

Description

Logging use the module log.py of the logging package ut_log. The module supports two Logging types:

  1. Standard Logging (std) or

  2. User Logging (usr).

The Logging type can be defined by one of the values ‘std’ or ‘usr’ of the parameter log_type; ‘std’ is the default. The different Logging types are configured by one of the following configuration files:

  1. log.std.yml or

  2. log.usr.yml

The configuration files can be stored in different configuration directories (ordered by increased priority):

  1. <package directory of the log package ut_log>/cfg,

  2. <package directory of the application package ui_eviq_srr>/cfg,

  3. <application directory of the application eviq>/cfg,

The active configuration file is the configuration file in the directory with the highest priority.

Examples

Site-packages-path = /appl/eviq/.pyenv/versions/3.11.12/lib/python3.11/site-packages Log-package = ut_log Application-package = ui_eviq_srr Application-home-path = /appl/eviq

Examples of log configuration-files

Log Configuration

Type

Directory Type

Directory

File

std

Log package

<Site-packages-path>/<Log-package>/cfg

log.std.yml

Application package

<Site-packages-path>/<application-package>/cfg

Application

<application-home-path>/cfg

usr

Log package

<site-packages-path>/ut_log/cfg

log.usr.yml

Application package

<site-packages-path>/ui_eviq_srr/cfg

Application

<application-path>/cfg

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

Log types 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

Application parameter for logging

Application parameter used in log naming

Name

Decription

Value

Description

Default

Example

appl_data

data directory

/data/eviq

tenant

tenant name

UMH

UMH

package

package name

ui_eviq_srr

cmd

command

evupreg

log_type

Logging Type

std:

Standard logging

std

std

usr:

User Logging

log_ts_type

Logging timestamp type

ts:

Sec since 1.1.1970

ts

ts

dt:

Datetime

log_sw_single_dir

Use single log directory

True

use single dir.

True

True

False

use muliple dir.

Log files naming

Naming Conventions (table format)
Naming conventions for logging file paths

Type

Directory

File

debug

/<appl_data>/<tenant>/RUN/<package>/<cmd>/debs

debs_<ts>_<pid>.log

critical

/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs

crts_<ts>_<pid>.log

error

/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs

errs_<ts>_<pid>.log

info

/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs

infs_<ts>_<pid>.log

warning

/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs

rnsg_<ts>_<pid>.log

Naming Conventions (tree format)
<appl_data>   Application data folder
│
└── <tenant>  Application tenant folder
    │
    └── RUN  Applications RUN folder for Application log files
        │
        └── <package>  RUN folder of Application package: <package>
            │
            └── <cmd>  RUN folder of Application command <cmd>
                │
                ├── debs  Application command debug messages folder
                │   │
                │   └── debs_<ts>_<pid>.log  debug messages for
                │                            run of command <cmd>
                │                            with pid <pid> at <ts>
                │
                └── logs  Application command log messages folder
                    │
                    ├── crts_<ts>_<pid>.log  critical messages for
                    │                        run of command <cmd>
                    │                        with pid <pid> at <ts>
                    ├── errs_<ts>_<pid>.log  error messages for
                    │                        run of command <cmd>
                    │                        with pid <pid> at <ts>
                    ├── infs_<ts>_<pid>.log  info messages for
                    │                        run of command <cmd>
                    │                        with pid <pid> at <ts>
                    └── wrns_<ts>_<pid>.log  warning messages for
                                             run of command <cmd>
                                             with pid <pid> at <ts>
Naming Examples (table format)
Naming conventions for logging file paths

Type

Directory

File

debug

/appl/eviq/UMH/RUN/ui_eviq_srr/evdomap/debs/

debs_1750096540_354710.log

critical

/appl/eviq/UMH/RUN/ui_eviq_srr/evdomap/logs/

crts_1749971151_240257.log

error

errs_1749971151_240257.log

info

infs_1750096540_354710.log

warning

wrns_1749971151_240257.log

Naming Examples (tree format)
/data/eviq/UMH/RUN/ui_eviq_srr/evdomap  Run folder of
│                                       of function evdomap
│                                       of package ui_eviq_srr
│                                       for teanant UMH
│                                       of application eviq
│
├── debs  debug folder of Application function: evdomap
│   │
│   └── debs_1748609414_314062.log  debug messages for run
│                                   of function evdomap
│                                   using pid: 314062 at: 1748609414
│
└── logs  log folder of Application function: evdomap
    │
    ├── errs_1748609414_314062.log  error messages for run
    │                               of function evdomap
    │                               with pid: 314062 at: 1748609414
    ├── infs_1748609414_314062.log  info messages for run
    │                               of function evdomap
    │                               with pid: 314062 at: 1748609414
    └── wrns_1748609414_314062.log  warning messages for run
                                    of function evdomap
                                    with pid: 314062 at: 1748609414

Configuration files

log.std.yml (jinja2 yml file)

Content
version: 1

disable_existing_loggers: False

loggers:

    # standard logger
    std:
        # level: NOTSET
        level: DEBUG
        handlers:
            - std_debug_console
            - std_debug_file
            - std_info_file
            - std_warning_file
            - std_error_file
            - std_critical_file

handlers:

    std_debug_console:
        class: 'logging.StreamHandler'
        level: DEBUG
        formatter: std_debug
        stream: 'ext://sys.stderr'

    std_debug_file:
        class: 'logging.FileHandler'
        level: DEBUG
        formatter: std_debug
        filename: '{{dir_run_debs}}/debs_{{ts}}_{{pid}}.log'
        mode: 'a'
        delay: true

    std_info_file:
        class: 'logging.FileHandler'
        level: INFO
        formatter: std_info
        filename: '{{dir_run_infs}}/infs_{{ts}}_{{pid}}.log'
        mode: 'a'
        delay: true

    std_warning_file:
        class: 'logging.FileHandler'
        level: WARNING
        formatter: std_warning
        filename: '{{dir_run_wrns}}/wrns_{{ts}}_{{pid}}.log'
        mode: 'a'
        delay: true

    std_error_file:
        class: 'logging.FileHandler'
        level: ERROR
        formatter: std_error
        filename: '{{dir_run_errs}}/errs_{{ts}}_{{pid}}.log'
        mode: 'a'
        delay: true

    std_critical_file:
        class: 'logging.FileHandler'
        level: CRITICAL
        formatter: std_critical
        filename: '{{dir_run_crts}}/crts_{{ts}}_{{pid}}.log'
        mode: 'a'
        delay: true

    std_critical_mail:
        class: 'logging.handlers.SMTPHandler'
        level: CRITICAL
        formatter: std_critical_mail
        mailhost : localhost
        fromaddr: 'monitoring@domain.com'
        toaddrs:
            - 'dev@domain.com'
            - 'qa@domain.com'
        subject: 'Critical error with application name'

formatters:

    std_debug:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
    std_info:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
    std_warning:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
    std_error:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
    std_critical:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
    std_critical_mail:
        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
        datefmt: '%Y-%m-%d %H:%M:%S'
Jinja2-variables
log.std.yml Jinja2 variables

Name

Definition

Example

dir_run_debs

debug run directory

/data/eviq/UMH/RUN/ui_eviq_srr/evupreg/debs

dir_run_infs

info run directory

/data/eviq/UMH/RUN/ui_eviq_srr/evupreg/logs

dir_run_wrns

warning run directory

dir_run_errs

error run directory

dir_run_crts

critical error run directory

ts

Timestamp since 1970 in [sec] if log_ts_type == ‘ts’

1749483509

Datetime in timezone Europe/ Berlin if log_ts_type == ‘dt’

20250609 17:38:29 GMT+0200

pid

Process ID

79133

Python Glossary

Python Modules

Overview

Python Modules

Name

Definition

Python modules

Files with suffix .py; they could be empty or contain python code; other modules can be imported into a module.

special Python modules

Modules like __init__.py or main.py with special names and functionality.

Python Function

Overview

Python Function

Name

Definition

Python function

Files with suffix .py; they could be empty or contain python code; other modules can be imported into a module.

special Python modules

Modules like __init__.py or main.py with special names and functionality.

Python Packages

Overview

Python Packages Overview

Name

Definition

Python package

Python packages are directories that contains the special module __init__.py and other modules, sub packages, files or directories.

Python sub-package

Python sub-packages are python packages which are contained in another python package.

Python package sub-directory

directory contained in a python package.

Python package special sub-directory

Python package sub-directories with a special meaning like data or cfg

Special python package sub-directories

Special python package 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 Files

Overview

Python files

Name

Definition

Python modules

Files with suffix .py; they could be empty or contain python code; other modules can be imported into a module.

Python package files

Files within a python package.

Python dunder modules

Python modules which are named with leading and trailing double underscores.

special Python files

Files which are not modules and used as python marker files like py.typed.

special Python modules

Modules like __init__.py or main.py with special names and functionality.

Python Special Files

Python special 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.

Python Special Modules

Python special 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 package entry point point. 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 classes

Overview

Python classes overview

Name

Description

Python class

A class is a container to group related methods and variables together, even if no objects are created. This helps in organizing code logically.

Python static class

A class which contains only @staticmethod or @classmethod methods and no instance-specific attributes or methods.

Python methods

Overview

Python methods overview

Name

Description

Python method

Python functions defined in python modules.

Python class method

Python functions defined in python classes.

Python special class method

Python class methods with special names and functionalities.

Python class methods

Python class methods

Name

Description

Python no instance class method

Python function defined in python classes and decorated with @classmethod or @staticmethod. The first parameter conventionally called cls is a reference to the current class.

Python instance class method

Python function defined in python classes; the first parameter conventionally called self is a reference to the current class object.

special Python class method

Python class functions with special names and functionalities.

Python special class methods

Python methods examples

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. The method us a single parameter conventionally called self to access the object.

Table of Contents

Metadata

Release files for ut-doa 1.1.0.20251005

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ut-doa 1.1.0.20251005
File Size Uploaded
ut_doa-1.1.0.20251005.tar.gz 24.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ut-doa 1.1.0.20251005
File Interpreter ABI Platform
ut_doa-1.1.0.20251005-py3-none-any.whl Python 3 none any Details

Total release size: 36.0 kB

Release files / ut_doa-1.1.0.20251005.tar.gz

Download URL ut_doa-1.1.0.20251005.tar.gz
Size 24.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ff4523ad9c878bf7f351c583b560e72cd4e058f497de44c25e040bbbe0fb4721
BLAKE2b-256 checksum
How to use checksums
d7b0d2d501fc951d9f46af7460f7771d2dbb168c65d235a8e2c3f81f682aa8d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Release files / ut_doa-1.1.0.20251005-py3-none-any.whl

Download URL ut_doa-1.1.0.20251005-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bc58bd532b1fe156512e793dade79d9156ffed01ab2e1ad31652a66fcb3bcbb1
BLAKE2b-256 checksum
How to use checksums
32f5d9e59e1de02d563268273fc64e0ce0999d14f61bb7ac1d8375784b5d0a57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page