ka-uts-xls 2.1.0.250408

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

Special files

Special files are used for type checking or other purposes.

Special-file

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 file is part of the PEP 561 standard, which provides a standardized way to package and distribute type information in Python.

Dunder Modules

Dunder Modules are Modules whose name contains 2 leading and trailing “_”.

Overview

Dunder-Modules

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

__version__.py

Variables

Variables of Dunder module __version__.py

Name	Example
__title__	‘ka_uts_xls’
__description__	‘Excel Utilities.’
__url__	‘https://ka-com.readthedocs.io/en/latest’
__version___	‘2023.2.2’
__build__	0x022200
__author_email_	‘Bernd Stroehle’
__license__	‘Apache-2.0’
__copyright__	‘Copyright 2025 bs29’
__cake__	u’u2728 U0001f370 u2728’

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

Table of Content

• Overview

• Installation

• Package files

• Special files

• Dunder Modules

  • Overview

  • __version__.py

• 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