ka-uts-xls 4.0.2.250519

Excel Utilities

Overview

Excel ‘Utilities’

The package ka_uts_xls ís a collection of interface modules to the following ‘Python Excel Utilities’

1. openpyxl

2. pyexcelerate

3. pandas dataframe excel functions

4. polars dataframe excel functions

Installation

The package ka_uts_xls can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_uts_xls

To install with conda:

$ conda install -c conda-forge ka_uts_xls

Package files

Classification

The Files of Package ka_uts_xls could be classified into the following file types:

1. Special files

2. Dunder modules

3. Package modules

4. Data files

Modules

Overview

The Modules of Package ka_uts_xls could be classified into the following module file types:

1. I/O modules

   1. I/O Control module

   2. I/O Input modules

   3. I/O Output modules

   4. I/O Update modules

2. Workbook modules

   1. Workbook modules using openpyxl

   2. Workbook modules using pyexcelerate

3. Worksheet modules

4. Cell (Row) modules

I/O Control Module

Overview

I/O Control Module

Name	Description
ioc.py	I/O Control processing for excel files

ioc.py

Static classes

The I/O Control Module ioc.py contains the following static classes.

Static Classes of I/O Control Module ioc.py

Name	Description
IocWbOp	Manage I/O control for excel workbooks using openpyxl package
IocWbPe	Manage I/O control for excel workbooks using pyexcelerate package

IocWbOp

Methods

Methods of static class IocWbOp Com

Name	Description
get	get Workbook using the openpyxel package

get

Parameter of Com method sh_kwargs

Name	Type	Description
**kwargs	TyAny	current class

Return value of IocWbPe method get

Name	Type	Description
	TyWbpP	pyexcelerate Workbook

IocWbPe

Methods

Methods of static class IocWbPe Com

Name	Description
get	get Workbook using the pyexcelerate package

get

Parameter of.static.class.IocWbPe.method.get

Name	Type	Description
**kwargs	TyAny	current class

Return value of IocWbPe method get

Name	Type	Description
	TyWbPe	pyexcelerate Workbook

Input I/O Modules

Overview

Input I/O Modules

Name	Description
ioipath.py	Run Input I/O for excel workbooks accessed by path
ioipathnm.py	Run Input I/O for excel workbooks accessed by path name

ioipath.py

Static classes

The Input I/O Module ioipath.py contains the following static classes.

Static Classes of Input I/O Module ioipath.py

Name	Description
IoiPathWbPd	Run Input I/O for excel workbooks accessed by path using pandas package
IoiPathWbPl	Run Input I/O for excel workbooks accessed by path using polaris package
IoiPathWbOp	Run Input I/O for excel workbooks accessed by path using openpyxel package
IoiPathWsOp	Run Input I/O for excel worksheets accessed by path using openpyxel package

ioipathnm.py

Static classes

The I/O Input Module ioipathnm.py contains the following static classes.

Static Classes of I/O Input Module ioipathnm.py

Name	Description
IoiPathnmWbPd	Run Input I/O for excel workbooks accessed by path name using pandas package
IoiPathnmWbPl	Run Input I/O for excel workbooks accessed by path name using polaris package
IoiPathnmWbOp	Run Input I/O for excel workbooks accessed by path name using openpyxel package
IoiPathnmWsOp	Run Input I/O for excel worksheets accessed by path name using openpyxel package

Output I/O Modules

Overview

Output I/O Modules

Name	Description
ioowbop.py	Run Output I/O for excel workbooks using the openpyxel package
ioowbpd.py	Run Output I/O for excel workbooks using the pandas package
ioowbpe.py	Run Output I/O for excel workbooks using the pyexcelerate package

ioowbop.py

Static classes

The Output I/O Module ioowbop.py contains the following static classes.

Static Classes of Output I/O Module ioowbop.py

Name	Description
IooPathWbOp	Run Output I/O for excel workbook to file referenced by path using the openpyxel package
IooPathnmWbOp	Run Output I/O for excel workbook to file referenced by path name using the openpyxel package

ioowbpd.py

Static classes

The Output I/O Module ioowbpd.py contains the following static classes.

Static Classes of Output I/O Module ioowbpd.py

Name	Description
IooPathPdDf	Run Output I/O for pandas dataframe to excel file referenced by path using the pandas writer

ioowbpe.py

Static classes

The I/O Output Module ioowbpe.py contains the following static classes.

Static Classes of Output I/O Module ioowbpe.py

Name	Description
IooPathWbPe	Run Output I/O for excel workbook to file referenced by path using the pyexcelerate package
IooPathnmWbPe	Run Output I/O for excel workbook to file referenced by path name using the pyexcelerate package

ioupath.py

Static classes

The I/O Update Module ioupath.py contains the following static class.

Static Class of Update I/O Module ioupath.py

Name	Description
IouPathWbOp	Run Update I/O of Excel template referenced by path by object using the openpyxel package

Workbook Modules using the package openpyxel

Overview

Workbook Module using the package openpyxel

Name	Description
wbop.py	Excel Workbook management using the openpyxel package

wbop.py

Classes

The Workbook Module wbop.py contains the following static class.

Static class of Workbook Module wbop.py

Name	Description
WbOp	Excel Workbook processing using the openpyxel package

Workbook Modules using the package pyexcelerate

Overview

Workbook Module using the package pyexcelerate

Name	Description
wbpe.py	Excel Workbook management using the pyexcelerate package

wbpe.py

Classes

The Workbook Module wbpe.py contains the following static class.

Static class of Workbook Module wbpe.py

Name	Description
WbPe	Excel Workbook processing using the pyexcelerate package

Worksheet Modules using the package openpyxel

Overview

Worksheet-Module-using-the-package-openpyxel

Name	Description
wbpe.py	Excel Worksheet management using the openpyxl package

wsop.py

Classes

The Worksheet Module wsop.py contains the following static class.

Static class of Worksheet Module wsop.py

Name	Description
WsOp	Excel Worksheet processing using the openpyxel package

Cell Modules using the package openpyxel

Overview

Cell-Module-using-the-package-openpyxel

Name	Description
rwop.py	Excel Cell management using the pyexcelerate package

rwop.py

Classes

The Cell Module rwop.py contains the following static class.

Static class of Cell Module wsop.py

Name	Description
RwOp	Excel Cell processing using the openpyxel package

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

• Package files

• Modules

• I/O Control Module

  • Overview

  • ioc.py

    • Static classes

    • IocWbOp

      • Methods

      • get

    • IocWbPe

      • Methods

      • get

• Input I/O Modules

  • Overview

  • ioipath.py

  • ioipathnm.py

• Output I/O Modules

  • Overview

  • ioowbop.py

  • ioowbpd.py

  • ioowbpe.py

  • ioupath.py

  • Workbook Modules using the package openpyxel

  • Overview

  • wbop.py

• Workbook Modules using the package pyexcelerate

  • Overview

  • wbpe.py

• Worksheet Modules using the package openpyxel

  • Overview

  • wsop.py

• Cell Modules using the package openpyxel

  • Overview

  • rwop.py

• 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