ut-dfr 2.0.0.20251016

Utilities for Dataframes (Pandas, Polars).

ut_dfr

Overview

Dataframe (Pandas, Polars) Utilities

Installation

Package ut_dfr can be installed from PyPI.

To install with pip:

$ python -m pip install ut_dfr

This requires that the readme extra is installed:

$ python -m pip install ut_dfr[readme]

Package Modules

Classification

The Modules of Package ut_dfr could be classified into the following module classes:

1. Modules for pandas dataframe

2. Modules for polars dataframe

The Package ut_aod 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. pddf.py Module for pandas dataframes

   2. pldf.py Module for polars dataframes

Module for Pandas Dataframe

Module for Pandas Dataframe

Name	Type
pddf.py	Pandas Dataframe

pddf.py

The Module pddf.py contains a single static classes PdDf.

pddf.py Class: PdDf

The static Class PdDf is used to manage Pandas Dataframes; it contains the subsequent methods.

PdDf Methods

Methods of static class PdDf

Name	Description
sh_d_aod	show dictionary of array of dictionaries.
sh_d_pddf	show dictionary of pandas dataframes.
pivot_table	create pandas dataframe pivot table. The pivot rules are defined by a pivot dictionary.
filter	Filter pandas dataframe. The filteris defined by filter dictionary
set_ix_drop_col_filter	set index and drop column filter
format-leading_zeros	format pandas dataframe columns with leading zeros
format-as-date	format pandas dataframe columns as date

PdDf Method: sh_d_aod

Parameter

Parameter of PdDf method sh_d_aod

Name	Type	Description
df	TyPdDf	Pandas Datafame
key	str	Keyword arguments

Return Value

Return Value of PdDf method sh_d_aod

Name	Type	Description
d_aod	TyDoAoD	dictionary of array of dictionaries

PdDf Method: sh_d_pddf

Parameter

Parameter of PdDf method sh_d_pddf

Name	Type	Description
cls	class	current class
df	TyPdDf	Pandas Datafame
key	str	keyword arguments

Return Value

Return Value of PdDf method sh_d_pddf

Name	Type	Description
d_df	TyDoPdDf	dictionary of pandas dataframes

PdDf Method: pivot_table

Parameter

Parameter of PdDf method pivot_table

Name	Type	Description
cls	class	current class
df	TyPdDf	pandas datafame
d_pv	TyDic	pivot table definition dictionary

Return Value

Return Value of PdDf method pivot_table

Name	Type	Description
dfpv	TyPdDf	pandas dataframe pivot table

PdDf Method: filter

Parameter

Parameter of PdDf method filter

Name	Type	Description
cls	class	current class
df	TyPdDf	pandas datafame
d_filter	TyDic	filter definition dictionary
relation	TyStr	filter relation

Return Value

Return Value of PdDf method filter

Name	Type	Description
df_new	TyPdDf	filtered pandas datafame

PdDf Method: set_ix_drop_col_filter

Parameter

Parameter of PdDf method set_ix_drop_col_filter

Name	Type	Description
cls	class	current class
df	TyPdDf	pandas datafame
d_filter	TyDic	filter definition dictionary
relation	str	filter relation

Return Value

Return Value of PdDf method set_ix_drop_col_filter

Name	Type	Description
df_new	TyPdDf	filtered pandas datafame

PdDf Module: format_leading_zeros

Parameter

Parameter of PdDf method format_leading_zeros

Name	Type	Description
cls	class	current class
df	TyPdDf	pandas datafame
d_filter	TyDic	filter definition dictionary
relation	str	filter relation

Return Value

Return Value of PdDf method format_leading_zeros

Name	Type	Description
df_new	TyPdDf	filtered pandas datafame

PdDf Method: format_as_date

Parameter

Parameter of PdDf method format_as_date

Name	Type	Description
cls	class	current class
df	TyPdDf	pandas datafame
d_filter	TyDic	filter definition dictionary
relation	str	filter relation

Return Value

Return Values of PdDf methodR ormat_as_date

Name	Type	Description
df_new	TyPdDf	filtered pandas datafame

Module for Polars Dataframe

Module for Polars Dataframe

Module	Classes
Name|Type	Name	Type	Description
pldf	Polars Dataframe		PdDf	Static	Manage Polars Dataframes

pldf.py

The Module pldf contains a single static class PLDF.

PlDf

The static Class PlDf contains the subsequent methods.

PlDf Methods

pldf Methods

Name	Description
filter	Filter polars dataframe using the given statement.
pivot	Create polars dataframe pivot table. The pivot rules are defined by the given pivot dictionary.
pivot_filter	Filter polars dataframe using the given statement and create polars dataframe pivot table from filtered dataframe. The pivot rules are defined by the given pivot dictionary.
to_aod	create pandas dataframe pivot table. The pivot rules are defined by pivot dictionary
to_doa	create pandas dataframe pivot table. The pivot rules are defined by pivot dictionary

PlDf Method: filter

Parameter

Parameter of PlDf method filter

Name	Type	Description
cls	class	current class
df	TyPdDf	polars datafame
stmt	TyStmt	filter statement

Return Value

Return Value of PlDf method filter

Name	Type	Description
df_new	TyPlDf	filtered polars datafame

PlDf Method: pivot

Parameter

Parameter of P.Df method pivot

Name	Type	Description
cls	class	current class
df	TyPlDf	polars datafame
d_pv	TyDic	pivot table definition dictionary

Return Value

Return value of PdDf method pivot

Name	Type	Description
dfpv	TyPlDf	polars dataframe pivot table

PlDf Method: pivot_filter

Parameter

Parameter of PdDf method pivot_filter

Name	Type	Description
cls	class	current class
df	TyPlDf	polars datafame
d_pv	TyDic	pivot table definition dictionary
stmt	TyStmt	filter statement

Return Value

Return value of PlDf method pivot_gilter

Name	Type	Description
dfpv	TyPlDf	polars dataframe pivot table

PlDf Method: to_aod

Parameter

Parameter of PdDf method to_aod

Name	Type	Description
df	TyPlDf	polars datafame

Return Value

Return value of PlDf method to_aod

Name	Type	Description
aod	TyAoD	Array of Dictionaries

PlDf Method: to_doa

Parameter

Parameter of PdDf method to_doa

Name	Type	Description
df	TyPlDf	polars datafame

Return Value

Return value of PlDf method to_doa

Name	Type	Description
doa	TyDoA	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: '[e-mail]'
        toaddrs:
            - '[e-mail]'
            - '[e-mail]'
        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

Table of Content

• ut_dfr

  • Overview

  • Installation

  • Package Modules

  • Module for Pandas Dataframe

    • pddf.py

      • pddf.py Class: PdDf

        • PdDf Methods

        • PdDf Method: sh_d_aod

          • Parameter

          • Return Value

        • PdDf Method: sh_d_pddf

          • Parameter

          • Return Value

        • PdDf Method: pivot_table

          • Parameter

          • Return Value

        • PdDf Method: filter

          • Parameter

          • Return Value

        • PdDf Method: set_ix_drop_col_filter

          • Parameter

          • Return Value

        • PdDf Module: format_leading_zeros

          • Parameter

          • Return Value

        • PdDf Method: format_as_date

          • Parameter

          • Return Value

  • Module for Polars Dataframe

    • pldf.py

      • PlDf

        • PlDf Methods

        • PlDf Method: filter

          • Parameter

          • Return Value

        • PlDf Method: pivot

          • Parameter

          • Return Value

        • PlDf Method: pivot_filter

          • Parameter

          • Return Value

        • PlDf Method: to_aod

          • Parameter

          • Return Value

        • PlDf Method: to_doa

          • Parameter

          • Return Value

• Appendix

  • Package Logging

    • Description

    • Examples

    • Log message types

      • Log types and Log directories

      • Application parameter for logging

      • Log files naming

        • Naming Conventions (table format)

        • Naming Conventions (tree format)

        • Naming Examples (table format)

        • Naming Examples (tree format)

    • Configuration files

      • Content

      • Jinja2-variables

  • Python Glossary

    • Python Modules

    • Python Function

    • Python Packages

      • Overview

      • Special python package sub-directories

    • Python Files

      • Overview

      • Python Special Files

      • Python Special Modules

    • Python classes

    • Python methods

      • Overview

      • Python class methods

      • Python special class methods

• Table of Contents