excel-list-transform 0.5__tar.gz

excel_list_transform-0.5/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Tom Björkholm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

excel_list_transform-0.5/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: excel-list-transform
+Version: 0.5
+Summary: Transform a list in excel or CSV
+Author: Tom Björkholm
+Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
+Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/excel-list-transform
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.5
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: types-openpyxl>=3.1.5.20240822
+Requires-Dist: pylightxl>=1.61
+Requires-Dist: XlsxWriter>=3.2.0
+Requires-Dist: pip>=23.2
+Requires-Dist: Pillow>=10.0.1
+Requires-Dist: setuptools>=74.0.0
+Requires-Dist: build>=1.2.1
+Requires-Dist: wheel>=0.44.0
+
+# excel-list-transform
+
+## Background
+
+This python application was born out of an experience at sail racing events. At the start of the events we received an excel list with participants (from a registration web) to enter into the scoring software and into tool for online notice board. The information was present in the excel file, but the columns were all wrong. To avoid the stressful manual rework of the information in the excel list this application was created.
+
+## What it does
+
+This small python application:
+ * reads data (that is a list with columns) from an excel file or from a comma separate values (CSV) file.
+ * splits columns in the list (like creating "first name" and "last name" columns from "name" column)
+ * merges columns in the list (like creating "name" column from "first name" and "last name" columns)
+ * removes columns in the list
+ * reorders columns in the list
+ * renames columns in the list
+ * inserts columns in the list
+ * rewrites columns in the list (like transforming telephone numbers from local/national format to international format)
+ * writest the resulting data (that is a list with columns) to an excel file or to a comma separate values (CSV) file.
+
+How this is done is governed by a configuration file. The application can create a number of example configuration files with accompanying description text files.
+
+## Installing it
+
+If you want to use it install it using pip. A precondition is that you have Python 3.10.5 or newer installed on you computer. Python can be downloaded from [https://www.python.org/downloads/](https://www.python.org/downloads/).
+
+### Installing on mac and Linux
+
+````
+pip3 install excel-list-transform
+````
+
+### Installing on Microsoft Windows
+
+````
+pip install excel-list-transform
+````
+
+## Running the application
+
+### Running the application on mac and Linux
+
+````
+python3 -m excel_list_transform --help
+python3 -m excel_list_transform example --help
+python3 -m excel_list_transform transform --help
+python3 -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python3 -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+### Running the application on Microsoft Windows
+
+````
+python -m excel_list_transform --help
+python -m excel_list_transform example --help
+python -m excel_list_transform transform --help
+python -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+## Suggested way to get started
+
+ 1. Use the "example" sub-command to generate a few example configuration (.cfg) files with description (.txt) files.
+ 2. Read the example configuration (.cfg) files and the accompanying description (.txt) files.
+ 3. Find an example that is close to what you want to achieve.
+ 4. Modify that configuration file to achieve what you want to achieve.
+ 5. Use the "transform" sub-command to read your data and output it transformed or reorganized according to your modified configuration file.
+ 6. Read the produced output. If necessary go back to step 4 and adjust how the data is transformed.
+
+### Description of configuration file
+
+When using the "example" sub-command to generate an example configuration file (say example.cfg) a text file describing the configuration and the syntax of the configuration file is also generated. If the example configuration file is named example.cfg, then the text file descriging the configuration is named example.txt. 
+
+You can generate several example configuration files each with an accompanying text file descriping it.
+
+Read the text file describing the configuration file while looking at the configuration file to understand the syntax and the possible options.
+
+## Performance
+
+This application is written for the moderate amounts of data when registering participants for the majority of sports events. If you have millions of rows this application is not for you.
+
+With an input file consisting of 20 columns producing an output file of 11 columns I have measured the following performance on a MacBook Air (laptop) from 2020:
+ * 1 000 rows processed in less than 0.5 seconds
+ * 10 000 rows processed in less than 4 seconds
+ * 80 000 rows processed in less than 30 seconds
+ * 120 000 rows processed in 40 seconds
+
+Naturally your performance will be different based on computer hardware, operating system and Python version. Generally it should be reasonably fast for less than 10 000 rows, painfully slow but somewhat usable up to 100 000 rows and probably so slow that it is unusable for more than 100 000 rows.
+
+## Source code
+
+Source code and tests are available at [https://bitbucket.org/tom-bjorkholm/excel-list-transform](https://bitbucket.org/tom-bjorkholm/excel-list-transform).

excel_list_transform-0.5/README.md

@@ -0,0 +1,76 @@
+# excel-list-transform
+
+## Background
+
+This python application was born out of an experience at sail racing events. At the start of the events we received an excel list with participants (from a registration web) to enter into the scoring software and into tool for online notice board. The information was present in the excel file, but the columns were all wrong. To avoid the stressful manual rework of the information in the excel list this application was created.
+
+## Using it
+
+If you want to use it install it using pip from [https://pypi.org/project/excel-list-transform](https://pypi.org/project/excel-list-transform). There is no need download anything from Bitbucket to use the application.
+
+### Installing on mac and Linux
+
+````
+pip3 install excel-list-transform
+````
+
+### Installing on Microsoft Windows
+
+````
+pip install excel-list-transform
+````
+
+### Information for use
+
+Please see [https://pypi.org/project/excel-list-transform](https://pypi.org/project/excel-list-transform) or please see README_pypi.md
+
+## What it does
+
+This small python application:
+ * reads data (that is a list with columns) from an excel file or from a comma separate values (CSV) file.
+ * splits columns in the list (like creating "first name" and "last name" columns from "name" column)
+ * merges columns in the list (like creating "name" column from "first name" and "last name" columns)
+ * removes columns in the list
+ * reorders columns in the list
+ * renames columns in the list
+ * inserts columns in the list
+ * rewrites columns in the list (like transforming telephone numbers from local/national format to international format)
+ * writest the resulting data (that is a list with columns) to an excel file or to a comma separate values (CSV) file.
+
+How this is done is governed by a configuration file. The application can create a number of example configuration files with accompanying description text files.
+
+## For developers
+
+### Needed environment
+
+#### OS
+
+For running the script and running the test suite you need a mac or a Linux computer. Even if the resulting application can be installed and used on Windows, the scripts for building and testing is only implemented for mac and Linux.
+
+#### Python version
+
+The tests and the script for running the tests, coverage, mypy etc. requires Python version 3.12.5 or newer.
+
+#### Zsh
+
+The scripts are all zsh. zsh is available by default on modern macs. zsh can easily be installed on Linux (on Ubuntu: sudo apt install zsh).
+
+### Internal APIs not quaranteed
+
+The internal APIs in this package are not guaranteed to be stable. They can change without warning between versions.
+
+### Building application
+
+There are 3 scripts for building the application
+ * setup_build_environment.zsh
+ Run this script first to get the environment set up for building
+ * doBuild.zsh
+ Run this script to build an installation package (.whl) and to run the tests on it in a venv (virtual environment).
+ * clean.zsh
+ Deletes all files that was produced by the build to start over from a clean state.
+
+The "testing" includes pytest, pylint, flake8 and mypy.
+
+After running doBuild.zsh you can open reports/index.htm to see all test reports.
+
+After running doBuild.zsh you can do manual test of the built and installed application in the virtual environment ./venv

excel_list_transform-0.5/README_pypi.md

@@ -0,0 +1,91 @@
+# excel-list-transform
+
+## Background
+
+This python application was born out of an experience at sail racing events. At the start of the events we received an excel list with participants (from a registration web) to enter into the scoring software and into tool for online notice board. The information was present in the excel file, but the columns were all wrong. To avoid the stressful manual rework of the information in the excel list this application was created.
+
+## What it does
+
+This small python application:
+ * reads data (that is a list with columns) from an excel file or from a comma separate values (CSV) file.
+ * splits columns in the list (like creating "first name" and "last name" columns from "name" column)
+ * merges columns in the list (like creating "name" column from "first name" and "last name" columns)
+ * removes columns in the list
+ * reorders columns in the list
+ * renames columns in the list
+ * inserts columns in the list
+ * rewrites columns in the list (like transforming telephone numbers from local/national format to international format)
+ * writest the resulting data (that is a list with columns) to an excel file or to a comma separate values (CSV) file.
+
+How this is done is governed by a configuration file. The application can create a number of example configuration files with accompanying description text files.
+
+## Installing it
+
+If you want to use it install it using pip. A precondition is that you have Python 3.10.5 or newer installed on you computer. Python can be downloaded from [https://www.python.org/downloads/](https://www.python.org/downloads/).
+
+### Installing on mac and Linux
+
+````
+pip3 install excel-list-transform
+````
+
+### Installing on Microsoft Windows
+
+````
+pip install excel-list-transform
+````
+
+## Running the application
+
+### Running the application on mac and Linux
+
+````
+python3 -m excel_list_transform --help
+python3 -m excel_list_transform example --help
+python3 -m excel_list_transform transform --help
+python3 -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python3 -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+### Running the application on Microsoft Windows
+
+````
+python -m excel_list_transform --help
+python -m excel_list_transform example --help
+python -m excel_list_transform transform --help
+python -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+## Suggested way to get started
+
+ 1. Use the "example" sub-command to generate a few example configuration (.cfg) files with description (.txt) files.
+ 2. Read the example configuration (.cfg) files and the accompanying description (.txt) files.
+ 3. Find an example that is close to what you want to achieve.
+ 4. Modify that configuration file to achieve what you want to achieve.
+ 5. Use the "transform" sub-command to read your data and output it transformed or reorganized according to your modified configuration file.
+ 6. Read the produced output. If necessary go back to step 4 and adjust how the data is transformed.
+
+### Description of configuration file
+
+When using the "example" sub-command to generate an example configuration file (say example.cfg) a text file describing the configuration and the syntax of the configuration file is also generated. If the example configuration file is named example.cfg, then the text file descriging the configuration is named example.txt. 
+
+You can generate several example configuration files each with an accompanying text file descriping it.
+
+Read the text file describing the configuration file while looking at the configuration file to understand the syntax and the possible options.
+
+## Performance
+
+This application is written for the moderate amounts of data when registering participants for the majority of sports events. If you have millions of rows this application is not for you.
+
+With an input file consisting of 20 columns producing an output file of 11 columns I have measured the following performance on a MacBook Air (laptop) from 2020:
+ * 1 000 rows processed in less than 0.5 seconds
+ * 10 000 rows processed in less than 4 seconds
+ * 80 000 rows processed in less than 30 seconds
+ * 120 000 rows processed in 40 seconds
+
+Naturally your performance will be different based on computer hardware, operating system and Python version. Generally it should be reasonably fast for less than 10 000 rows, painfully slow but somewhat usable up to 100 000 rows and probably so slow that it is unusable for more than 100 000 rows.
+
+## Source code
+
+Source code and tests are available at [https://bitbucket.org/tom-bjorkholm/excel-list-transform](https://bitbucket.org/tom-bjorkholm/excel-list-transform).

excel_list_transform-0.5/excel_list_transform.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: excel-list-transform
+Version: 0.5
+Summary: Transform a list in excel or CSV
+Author: Tom Björkholm
+Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
+Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/excel-list-transform
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.5
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: types-openpyxl>=3.1.5.20240822
+Requires-Dist: pylightxl>=1.61
+Requires-Dist: XlsxWriter>=3.2.0
+Requires-Dist: pip>=23.2
+Requires-Dist: Pillow>=10.0.1
+Requires-Dist: setuptools>=74.0.0
+Requires-Dist: build>=1.2.1
+Requires-Dist: wheel>=0.44.0
+
+# excel-list-transform
+
+## Background
+
+This python application was born out of an experience at sail racing events. At the start of the events we received an excel list with participants (from a registration web) to enter into the scoring software and into tool for online notice board. The information was present in the excel file, but the columns were all wrong. To avoid the stressful manual rework of the information in the excel list this application was created.
+
+## What it does
+
+This small python application:
+ * reads data (that is a list with columns) from an excel file or from a comma separate values (CSV) file.
+ * splits columns in the list (like creating "first name" and "last name" columns from "name" column)
+ * merges columns in the list (like creating "name" column from "first name" and "last name" columns)
+ * removes columns in the list
+ * reorders columns in the list
+ * renames columns in the list
+ * inserts columns in the list
+ * rewrites columns in the list (like transforming telephone numbers from local/national format to international format)
+ * writest the resulting data (that is a list with columns) to an excel file or to a comma separate values (CSV) file.
+
+How this is done is governed by a configuration file. The application can create a number of example configuration files with accompanying description text files.
+
+## Installing it
+
+If you want to use it install it using pip. A precondition is that you have Python 3.10.5 or newer installed on you computer. Python can be downloaded from [https://www.python.org/downloads/](https://www.python.org/downloads/).
+
+### Installing on mac and Linux
+
+````
+pip3 install excel-list-transform
+````
+
+### Installing on Microsoft Windows
+
+````
+pip install excel-list-transform
+````
+
+## Running the application
+
+### Running the application on mac and Linux
+
+````
+python3 -m excel_list_transform --help
+python3 -m excel_list_transform example --help
+python3 -m excel_list_transform transform --help
+python3 -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python3 -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+### Running the application on Microsoft Windows
+
+````
+python -m excel_list_transform --help
+python -m excel_list_transform example --help
+python -m excel_list_transform transform --help
+python -m excel_list_transform example -k forms_to_rrs -r by_name -o example.cfg
+python -m excel_list_transform transform -c example.cfg -i input.xlsx -o output.xlsx
+````
+
+## Suggested way to get started
+
+ 1. Use the "example" sub-command to generate a few example configuration (.cfg) files with description (.txt) files.
+ 2. Read the example configuration (.cfg) files and the accompanying description (.txt) files.
+ 3. Find an example that is close to what you want to achieve.
+ 4. Modify that configuration file to achieve what you want to achieve.
+ 5. Use the "transform" sub-command to read your data and output it transformed or reorganized according to your modified configuration file.
+ 6. Read the produced output. If necessary go back to step 4 and adjust how the data is transformed.
+
+### Description of configuration file
+
+When using the "example" sub-command to generate an example configuration file (say example.cfg) a text file describing the configuration and the syntax of the configuration file is also generated. If the example configuration file is named example.cfg, then the text file descriging the configuration is named example.txt. 
+
+You can generate several example configuration files each with an accompanying text file descriping it.
+
+Read the text file describing the configuration file while looking at the configuration file to understand the syntax and the possible options.
+
+## Performance
+
+This application is written for the moderate amounts of data when registering participants for the majority of sports events. If you have millions of rows this application is not for you.
+
+With an input file consisting of 20 columns producing an output file of 11 columns I have measured the following performance on a MacBook Air (laptop) from 2020:
+ * 1 000 rows processed in less than 0.5 seconds
+ * 10 000 rows processed in less than 4 seconds
+ * 80 000 rows processed in less than 30 seconds
+ * 120 000 rows processed in 40 seconds
+
+Naturally your performance will be different based on computer hardware, operating system and Python version. Generally it should be reasonably fast for less than 10 000 rows, painfully slow but somewhat usable up to 100 000 rows and probably so slow that it is unusable for more than 100 000 rows.
+
+## Source code
+
+Source code and tests are available at [https://bitbucket.org/tom-bjorkholm/excel-list-transform](https://bitbucket.org/tom-bjorkholm/excel-list-transform).

excel_list_transform-0.5/excel_list_transform.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+LICENSE.txt
+README.md
+README_pypi.md
+pyproject.toml
+setup.py
+excel_list_transform.egg-info/PKG-INFO
+excel_list_transform.egg-info/SOURCES.txt
+excel_list_transform.egg-info/dependency_links.txt
+excel_list_transform.egg-info/requires.txt
+excel_list_transform.egg-info/top_level.txt
+src/excel_list_transform/__init__.py
+src/excel_list_transform/__main__.py
+src/excel_list_transform/check_indata_common.py
+src/excel_list_transform/commontypes.py
+src/excel_list_transform/config.py
+src/excel_list_transform/config_enums.py
+src/excel_list_transform/config_excel_list_transform.py
+src/excel_list_transform/config_factory.py
+src/excel_list_transform/config_xls_list_refmt_name.py
+src/excel_list_transform/config_xls_list_refmt_num.py
+src/excel_list_transform/file_extension.py
+src/excel_list_transform/file_must_exist.py
+src/excel_list_transform/generate_cfg.py
+src/excel_list_transform/generate_txt.py
+src/excel_list_transform/handle_csv.py
+src/excel_list_transform/handle_empty_column.py
+src/excel_list_transform/handle_excel.py
+src/excel_list_transform/num_named_conversion.py
+src/excel_list_transform/rewrite_value.py
+src/excel_list_transform/str_to_enum.py
+src/excel_list_transform/transform_cmd.py
+src/excel_list_transform/transform_func.py
+src/excel_list_transform/transform_func_common.py
+src/excel_list_transform/transform_func_named.py
+src/excel_list_transform/transform_func_num.py

excel_list_transform-0.5/excel_list_transform.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

excel_list_transform-0.5/excel_list_transform.egg-info/requires.txt

@@ -0,0 +1,9 @@
+openpyxl>=3.1.5
+types-openpyxl>=3.1.5.20240822
+pylightxl>=1.61
+XlsxWriter>=3.2.0
+pip>=23.2
+Pillow>=10.0.1
+setuptools>=74.0.0
+build>=1.2.1
+wheel>=0.44.0

excel_list_transform-0.5/excel_list_transform.egg-info/top_level.txt

@@ -0,0 +1 @@
+excel_list_transform

excel_list_transform-0.5/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "excel-list-transform"
+version = "0.5"
+authors = [
+  { name="Tom Björkholm", email="klausuler_linnet0q@icloud.com" },
+]
+description = "Transform a list in excel or CSV"
+readme = "README_pypi.md"
+requires-python = ">=3.10.5"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dynamic = ["dependencies"]
+
+[project.urls]
+"Source code" = "https://bitbucket.org/tom-bjorkholm/excel-list-transform"

excel_list_transform-0.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

excel_list_transform-0.5/setup.py

@@ -0,0 +1,26 @@
+#! /usr/local/bin/python3
+"""Setup file specifying build of apo_tools.whl with APO tools library."""
+
+from setuptools import setup
+
+setup(
+  name='excel-list-transform',
+  version='0.5',
+  description='Transform a list in excel or CSV.',
+  author='Tom Björkholm',
+  author_email='klausuler_linnet0q@icloud.com',
+  python_requires='>=3.10.5',
+  packages=['excel_list_transform'],
+  package_dir={'excel_list_transform': 'src/excel_list_transform'},
+  install_requires=[
+    'openpyxl >= 3.1.5',
+    'types-openpyxl >= 3.1.5.20240822',
+    'pylightxl >= 1.61',
+    'XlsxWriter >= 3.2.0',
+    'pip >= 23.2',
+    'Pillow >= 10.0.1',
+    'setuptools >= 74.0.0',
+    'build >= 1.2.1',
+    'wheel>=0.44.0'
+  ]
+)

excel_list_transform-0.5/src/excel_list_transform/__init__.py

@@ -0,0 +1 @@
+"""Take an excel file and and change columns before saving as excel or CSV."""

excel_list_transform-0.5/src/excel_list_transform/__main__.py

@@ -0,0 +1,11 @@
+#! /usr/local/bin/python3
+"""Take an excel file and and change columns before saving as excel or CSV."""
+
+# Copyright (c) 2024 Tom Björkholm
+# MIT License
+
+
+from excel_list_transform.transform_cmd import transform_cmd  # pragma: no cover # noqa: E501
+
+if __name__ == '__main__':  # pragma: no cover
+    transform_cmd()

excel_list_transform-0.5/src/excel_list_transform/check_indata_common.py

@@ -0,0 +1,39 @@
+#! /usr/local/bin/python3
+"""Function for common indata checks.."""
+
+# Copyright (c) 2024 Tom Björkholm
+# MIT License
+
+
+import sys
+from typing import Callable, Optional
+from excel_list_transform.commontypes import Data
+
+
+def check_indata_common(indata: Data,
+                        fix_indata_empty_rows: Callable[[Data], None]) \
+                            -> None:
+    """Check that the indata is well formed common part."""
+    assert isinstance(indata, list), 'Internal error. ' + \
+        f'Expected list of rows but got {type(indata).__name__}'
+    if len(indata) < 1:
+        msg = 'No rows in input data'
+        print(msg, file=sys.stderr)
+        sys.exit(1)
+    fix_indata_empty_rows(indata)
+    if len(indata) < 1:
+        msg = 'No columns in input data'
+        print(msg, file=sys.stderr)
+        sys.exit(1)
+    num_cols: Optional[int] = None
+    for row in indata:
+        rowlen: int = len(row)
+        if num_cols is None:
+            num_cols = rowlen
+        else:
+            assert num_cols is not None
+            if num_cols != rowlen:
+                msg = 'Number of columns different between lines. '
+                msg += f'Found {num_cols} and {rowlen}. Aborting.'
+                print(msg, file=sys.stderr)
+                sys.exit(1)

excel_list_transform-0.5/src/excel_list_transform/commontypes.py

@@ -0,0 +1,59 @@
+#! /usr/local/bin/python3
+"""Common type definitions used for type hints."""
+
+# Copyright (c) 2024 Tom Björkholm
+# MIT License
+
+
+from typing import TypeAlias, Optional, cast, Sequence, Mapping, TypeVar, \
+    Any
+from datetime import datetime
+# imports needed by mypy, but not by python:
+from typing import Union, List, Dict  # pylint: disable=unused-import,ungrouped-imports # noqa: E501
+
+
+# types used to describe input and output data
+Value: TypeAlias = Optional[str | int | float | datetime]
+NumRow: TypeAlias = list[Value]
+NumRowSeq: TypeAlias = Sequence[Value]
+NameRow: TypeAlias = dict[str, Value]
+NameRowMap: TypeAlias = Mapping[str, Value]
+NumData: TypeAlias = list[NumRow]
+NumDataSeq: TypeAlias = list[NumRowSeq]
+NameData: TypeAlias = list[NameRow]
+NameDataMap: TypeAlias = Sequence[NameRowMap]
+Data = TypeVar('Data', NumData, NameData)
+DataCov = TypeVar('DataCov', NumDataSeq, NameDataMap)
+
+JsonType: TypeAlias = \
+    'Union[None, int, str, bool, List[JsonType], Dict[str, JsonType]]'
+
+# helper functions
+
+
+def num_row_to_str_list(row: NumRowSeq) -> list[str]:
+    """Convert NumRow to list of str."""
+    ret: list[str] = []
+    for i in row:
+        if isinstance(i, str):
+            ret.append(i)
+        elif i is None:
+            raise TypeError('Found None when expecting str.')
+        else:
+            ret.append(str(i))
+    return ret
+
+
+def str_list_to_num_row(row: list[str]) -> NumRow:
+    """Convert list of str to NumRow."""
+    return cast(NumRow, row)
+
+
+T = TypeVar('T')
+
+
+def get_checked_type(value: Optional[Any], istype: type[T]) -> T:
+    """Get value narrowed to be of type istype."""
+    assert value is not None
+    assert isinstance(value, istype)
+    return value