Excel 'Utilities'
The package ka_uts_xls ís a collection of interface modules to the following 'Python Excel Utilities'
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
The Files of Package ka_uts_xls could be classified into the following file types:
The Modules of Package ka_uts_xls could be classified into the following module file types:
I/O Control Module Name Description ioc.py I/O Control processing for excel files
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
Methods of static class IocWbOp Com Name Description get get Workbook using the openpyxel package
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
Methods of static class IocWbPe Com Name Description get get Workbook using the pyexcelerate package
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 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
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
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 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
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
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
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
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 Module using the package openpyxel Name Description wbop.py Excel Workbook management using the openpyxel package
Workbook Module using the package pyexcelerate Name Description wbpe.py Excel Workbook management using the pyexcelerate package
Worksheet-Module-using-the-package-openpyxel Name Description wbpe.py Excel Worksheet management using the openpyxl package
Cell-Module-using-the-package-openpyxel Name Description rwop.py Excel Cell management using the pyexcelerate package
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.
Logging defines log file path names for the following log message types: .
Application parameter used in log naming Name Decription Values Example dir_dat Application data directory /otev/data tenant Application tenant name UMH package Application package name otev_xls_srr cmd Application command evupreg pid Process ID æevupreg log_ts_type Timestamp type used in logging files|ts, dt ts, dt ts log_sw_single_dir Enable single log directory or multiple log directories True, False True
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
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
Naming examples for logging file paths Type Directory File debug /data/otev/umh/RUN/otev_xls_srr/evupreg/logs debs_1737118199_9470.log info /data/otev/umh/RUN/otev_xls_srr/evupreg/logs infs_1737118199_9470.log warning /data/otev/umh/RUN/otev_xls_srr/evupreg/logs wrns_1737118199_9470.log error /data/otev/umh/RUN/otev_xls_srr/evupreg/logs errs_1737118199_9470.log critical /data/otev/umh/RUN/otev_xls_srr/evupreg/logs crts_1737118199_9470.log
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 Name Definition Python package sub-directory Python packages sub-directories are directories contained in python packages. Special Python package sub-directory Special Python package sub-directories are python package sub-directories with with a special meaning
Special python sun-directories Name Description data Directory for package data files. cfg Directory for package configuration files.
Python package files Name Definition Python package files Python packages are files within a python package. Special python package files Special python package files are package files which are not modules and used as python marker files like __init__.py Python package module Python modules are files with suffix .py; they could be empty or contain python code; other modules can be imported into a module. Special python package module Special python modules like __init__.py or main.py are python modules with special names and functionality.
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.
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.
Overview °°°°°°°°
Python elements Python method Python methods are python functions defined in python modules. Special python method Special python methods are python functions with special names and functionalities. Python class Python classes are defined in python modules. Python class method Python class methods are python methods defined python classes.
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.