tableio 0.2__tar.gz → 0.3__tar.gz

{tableio-0.2/tableio.egg-info → tableio-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tableio
-Version: 0.2
+Version: 0.3
 Summary: Uniform way to write table data to and read from different file formats
 Author: Tom Björkholm
 Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -13,12 +13,14 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: pip>=26.0.1
 Requires-Dist: setuptools>=82.0.1
-Requires-Dist: build>=1.4.0
+Requires-Dist: build>=1.4.2
 Requires-Dist: wheel>=0.46.3
 Requires-Dist: mformat-ext>=0.6
 Requires-Dist: openpyxl>=3.1.5
 Requires-Dist: types-openpyxl>=3.1.5.20260322
-Requires-Dist: odfdo>=3.22.1
+Requires-Dist: odfdo>=3.22.3
+Requires-Dist: xlsxwriter>=3.2.9
+Requires-Dist: pylightxl>=1.61
 Dynamic: author
 Dynamic: license-file
 Dynamic: requires-dist
@@ -30,15 +32,15 @@ The tableio package contains a number of classes providing a uniform way for
 a python program to write table data (rows of columns) to and read table data
 from a number of different common file formats.
 
-An increasing number of users want output from programs to de in a format
+An increasing number of users want output from programs to be in a format
 like a spreadsheet, and not the old fashoned raw text files. Similarly,
 many users want the data they feed into programs to be in a particular format
-(like a spreadsheet). The tableio packade tries to make it easier for the
+(like a spreadsheet). The tableio package tries to make it easier for the
 programmer to fullfil requests like that.
 
-The primary intended use is for text output from a python program, where the
-programmer would like the user to be able to select the input and output file
-formats.
+The primary intended use is for data table output from a python program
+and data table input to a python program, where the programmer would like
+the user to be able to select the input and output file formats.
 
 The support for spreadsheets is for reading and writing data. There is no
 intention to support reading or writing formulas. There is no support for
@@ -68,6 +70,8 @@ The currently supported formats are:
 |-------------|----------------|-----------|----------|
 | CSV         | csv            | yes       | yes      |
 | Excel       | OpenPyXL       | yes       | yes      |
+| Excel       | XlsxWriter     | yes       | -        |
+| Excel       | pylightxl      | yes       | yes      |
 | ODS         | odfdo          | yes       | yes      |
 | HTML        | mformat        | yes       | -        |
 | LaTeX       | mformat        | yes       | -        |
@@ -109,6 +113,8 @@ The main features are:
 - writing a table to a specific location in a spreadsheet (specified by a box)
 - reading table data from a specific location in a spreadsheet (specified by a box)
 - using multiple sheets in spreadsheets
+- finding location where some data is present in spreadsheet and doing modifications
+  at that position or at positions relative to that position.
 
 ## Example programs
 
@@ -118,8 +124,6 @@ example programs:
 
 ## API documentation
 
-Be aware that this is still in early development. The APIs may change between versions.
-
 You can find the public API documentation at [https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/api.md](https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/api.md)
 
 You can find the protected API documentation at [https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/protected_api.md](https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/protected_api.md)
@@ -132,15 +136,16 @@ a better start by reading the examples.
 
 ## Version history
 
-| Version | Date        | Python version | Comment                    |
-|---------|-------------|----------------|----------------------------|
-| 0.2     | 2026 Mar 28 | 3.12 or newer  | More features, API changes |
-| 0.1     | 2026 Mar 23 | 3.12 or newer  | First released version     |
+| Version | Date        | Python version | Comment                     |
+|---------|-------------|----------------|-----------------------------|
+| 0.3     | 2023 Apr 01 | 3.12 or newer  | Improved API, more backends |
+| 0.2     | 2026 Mar 28 | 3.12 or newer  | More features, API changes  |
+| 0.1     | 2026 Mar 23 | 3.12 or newer  | First released version      |
 
 ## Test summary
 
-- Test result: 869 passed in 11s
+- Test result: 1010 passed in 14s
 - No flake8 warnings.
 - No mypy errors found.
-- Built version(s): 0.2
+- Built version(s): 0.3
 - Build and test using Python 3.14.3

{tableio-0.2 → tableio-0.3}/README.md

@@ -93,8 +93,8 @@ information about the build system. This README can also be viewed at
 
 ## Test summary
 
-- Test result: 869 passed in 11s
+- Test result: 1010 passed in 14s
 - No flake8 warnings.
 - No mypy errors found.
-- Built version(s): 0.2
+- Built version(s): 0.3
 - Build and test using Python 3.14.3

{tableio-0.2 → tableio-0.3}/README_pypi.md

@@ -4,15 +4,15 @@ The tableio package contains a number of classes providing a uniform way for
 a python program to write table data (rows of columns) to and read table data
 from a number of different common file formats.
 
-An increasing number of users want output from programs to de in a format
+An increasing number of users want output from programs to be in a format
 like a spreadsheet, and not the old fashoned raw text files. Similarly,
 many users want the data they feed into programs to be in a particular format
-(like a spreadsheet). The tableio packade tries to make it easier for the
+(like a spreadsheet). The tableio package tries to make it easier for the
 programmer to fullfil requests like that.
 
-The primary intended use is for text output from a python program, where the
-programmer would like the user to be able to select the input and output file
-formats.
+The primary intended use is for data table output from a python program
+and data table input to a python program, where the programmer would like
+the user to be able to select the input and output file formats.
 
 The support for spreadsheets is for reading and writing data. There is no
 intention to support reading or writing formulas. There is no support for
@@ -42,6 +42,8 @@ The currently supported formats are:
 |-------------|----------------|-----------|----------|
 | CSV         | csv            | yes       | yes      |
 | Excel       | OpenPyXL       | yes       | yes      |
+| Excel       | XlsxWriter     | yes       | -        |
+| Excel       | pylightxl      | yes       | yes      |
 | ODS         | odfdo          | yes       | yes      |
 | HTML        | mformat        | yes       | -        |
 | LaTeX       | mformat        | yes       | -        |
@@ -83,6 +85,8 @@ The main features are:
 - writing a table to a specific location in a spreadsheet (specified by a box)
 - reading table data from a specific location in a spreadsheet (specified by a box)
 - using multiple sheets in spreadsheets
+- finding location where some data is present in spreadsheet and doing modifications
+  at that position or at positions relative to that position.
 
 ## Example programs
 
@@ -92,8 +96,6 @@ example programs:
 
 ## API documentation
 
-Be aware that this is still in early development. The APIs may change between versions.
-
 You can find the public API documentation at [https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/api.md](https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/api.md)
 
 You can find the protected API documentation at [https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/protected_api.md](https://bitbucket.org/tom-bjorkholm/table-io/src/master/doc/protected_api.md)
@@ -106,15 +108,16 @@ a better start by reading the examples.
 
 ## Version history
 
-| Version | Date        | Python version | Comment                    |
-|---------|-------------|----------------|----------------------------|
-| 0.2     | 2026 Mar 28 | 3.12 or newer  | More features, API changes |
-| 0.1     | 2026 Mar 23 | 3.12 or newer  | First released version     |
+| Version | Date        | Python version | Comment                     |
+|---------|-------------|----------------|-----------------------------|
+| 0.3     | 2023 Apr 01 | 3.12 or newer  | Improved API, more backends |
+| 0.2     | 2026 Mar 28 | 3.12 or newer  | More features, API changes  |
+| 0.1     | 2026 Mar 23 | 3.12 or newer  | First released version      |
 
 ## Test summary
 
-- Test result: 869 passed in 11s
+- Test result: 1010 passed in 14s
 - No flake8 warnings.
 - No mypy errors found.
-- Built version(s): 0.2
+- Built version(s): 0.3
 - Build and test using Python 3.14.3

{tableio-0.2 → tableio-0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tableio"
-version = "0.2"
+version = "0.3"
 authors = [
   { name="Tom Björkholm", email="klausuler_linnet0q@icloud.com" },
 ]

{tableio-0.2 → tableio-0.3}/setup.py

@@ -5,7 +5,7 @@ from setuptools import setup
 
 setup(
   name='tableio',
-  version='0.2',
+  version='0.3',
   description='Uniform way to write table data to and read from different ' \
     'file formats',
   author='Tom Björkholm',
@@ -17,11 +17,13 @@ setup(
   install_requires=[  # pylint: disable=duplicate-code
     'pip >= 26.0.1',
     'setuptools >= 82.0.1',
-    'build >= 1.4.0',
+    'build >= 1.4.2',
     'wheel >= 0.46.3',
     'mformat-ext >= 0.6',
     'openpyxl >= 3.1.5',
     'types-openpyxl >= 3.1.5.20260322',
-    'odfdo >= 3.22.1'
+    'odfdo >= 3.22.3',
+    'xlsxwriter >= 3.2.9',
+    'pylightxl >= 1.61'
   ]
 )

tableio-0.3/src/tableio/__init__.py

@@ -0,0 +1,47 @@
+#! /usr/local/bin/python3
+"""Curated top-level public API for the tableio package."""
+
+# Copyright (c) 2026 Tom Björkholm
+# MIT License
+#
+
+from tableio.capability import CAP_IGNORABLE, CAP_NEEDED, CAP_NOT_USED, \
+    Capabilities
+from tableio.color import Color
+from tableio.factory import create_tableio, filter_args_tableio, \
+    list_implementations_tableio, list_registered_tableio
+from tableio.optional_args import CsvDialect, OptionalArgs, OptionalArgsDict
+from tableio.tableio import Box, FileAccess, Position, TableIO
+from tableio.value_type import CellT, DictData, DictDataMap, Fmt, \
+    FmtDictData, FmtDictRow, FmtListData, FmtListRow, ListData, \
+    ListDataSeq, ReadResult, Value, ValueFmt
+
+__all__ = ['create_tableio',
+           'TableIO',
+           'FileAccess',
+           'Box',
+           'Position',
+           'OptionalArgs',
+           'OptionalArgsDict',
+           'Value',
+           'ListData',
+           'ListDataSeq',
+           'DictData',
+           'DictDataMap',
+           'ReadResult',
+           'Fmt',
+           'ValueFmt',
+           'FmtListRow',
+           'FmtDictRow',
+           'FmtListData',
+           'FmtDictData',
+           'CellT',
+           'Color',
+           'Capabilities',
+           'CAP_NEEDED',
+           'CAP_NOT_USED',
+           'CAP_IGNORABLE',
+           'filter_args_tableio',
+           'list_registered_tableio',
+           'list_implementations_tableio',
+           'CsvDialect']

{tableio-0.2 → tableio-0.3}/src/tableio/capability.py

@@ -87,6 +87,9 @@ class Capabilities(NamedTuple):
     multi_sheet: SingleCapability = SingleCapability()
     """The reader/writer class can read from or write to multiple sheets."""
 
+    can_find_value_position: SingleCapability = SingleCapability()
+    """The reader/writer class can find the position of a value."""
+
 
 def single_capability_match(offered: SingleCapability,
                             will_use: SingleCapability,
@@ -233,3 +236,14 @@ CAP_UNSUPPORTED = SingleCapability(supported=False,
    different location would not make sense. Thus the only sensible thing
    to do is to raise an exception.
    """
+
+CAP_ALL_IMPLEMENTED = Capabilities(can_read=CAP_IMPLEMENTED,
+                                   can_write=CAP_IMPLEMENTED,
+                                   can_fmt_row=CAP_IMPLEMENTED,
+                                   can_fmt_value=CAP_IMPLEMENTED,
+                                   filtered_data_range=CAP_IMPLEMENTED,
+                                   can_write_box=CAP_IMPLEMENTED,
+                                   can_read_box=CAP_IMPLEMENTED,
+                                   can_write_highlight=CAP_IMPLEMENTED,
+                                   multi_sheet=CAP_IMPLEMENTED,
+                                   can_find_value_position=CAP_IMPLEMENTED)

{tableio-0.2 → tableio-0.3}/src/tableio/factory.py

@@ -51,6 +51,37 @@ class TableIOFactoryNoCapabilityMatch(ValueError):
     """
 
 
+class InsufficientCapabilities(ValueError):
+    """Raised when requested capabilities contradict requested file access.
+
+    Error raised when the caller supplies both file access and an explicit
+    Capabilities object, but the requested capabilities do not include the
+    capability implied by that access mode. For example, READ requires
+    can_read, CREATE requires can_write, and UPDATE requires both.
+    """
+
+
+def _check_capabilities_for_file_access(
+        file_access: FileAccess,
+        capabilities: Optional[Capabilities]) -> None:
+    """Raise if explicit capabilities not enough for requested access mode."""
+    if capabilities is None:
+        return
+    if file_access == FileAccess.READ and not capabilities.can_read.supported:
+        msg = 'FileAccess.READ requires can_read capability.'
+        raise InsufficientCapabilities(msg)
+    if file_access == FileAccess.CREATE and \
+            not capabilities.can_write.supported:
+        msg = 'FileAccess.CREATE requires can_write capability.'
+        raise InsufficientCapabilities(msg)
+    if file_access == FileAccess.UPDATE and (
+            not capabilities.can_write.supported or
+            not capabilities.can_read.supported):
+        msg = 'FileAccess.UPDATE requires both can_read and '
+        msg += 'can_write capabilities.'
+        raise InsufficientCapabilities(msg)
+
+
 @total_ordering
 class ImplPrio(NamedTuple):
     """Priority of an implementation."""
@@ -339,6 +370,7 @@ class TableIOFactory:
             An instance of the requested TableIO subclass.
             Intended to be used as context manager, using a with statement.
         Raises:
+            InsufficientCapabilities: If capabilities contradict file_access.
             TableIOFactoryNoSuchError: If the format_name is not registered
                                         or the implementation name is not
                                         registered.
@@ -357,7 +389,17 @@ class TableIOFactory:
                  file_access: FileAccess, args: OptionalArgs = None,
                  implementation: Optional[str] = None,
                  capabilities: Optional[Capabilities] = None) -> TableIO:
-        """Internally create an instance of a registered subclass."""
+        """Internally create an instance of a registered subclass.
+
+        Raises:
+            InsufficientCapabilities: If capabilities contradict file_access.
+            TableIOFactoryNoSuchError: If the format_name is not registered
+                                       or the implementation name is not
+                                       registered.
+            TableIOFactoryNoCapabilityMatch: If the capabilities cannot be
+                                             matched to any implementation.
+        """
+        _check_capabilities_for_file_access(file_access, capabilities)
         correct_name: Optional[str] = None
         if format_name in self._formats:
             correct_name = format_name
@@ -371,8 +413,8 @@ class TableIOFactory:
             )
         assert correct_name is not None
         format_info: FactoryFormatInfo = self._formats[correct_name]
-        best_matches = format_info.best_match_names(capabilities=capabilities,
-                                                    empty_is_ok=False)
+        best_matches = format_info.best_match_names(
+            capabilities=capabilities, empty_is_ok=False)
         if implementation is not None:
             fikeys = list(format_info._registry.keys())  # pylint: disable=protected-access # noqa: E501
             if implementation not in fikeys:
@@ -666,6 +708,7 @@ def create_tableio(format_name: str,  # pylint: disable=too-many-arguments, too-
     Returns:
         An instance of the requested TableIO subclass.
     Raises:
+        InsufficientCapabilities: If capabilities contradict file_access.
         TableIOFactoryNoSuchError: If the format_name or implementation
                                    name is not registered.
         TableIOFactoryNoCapabilityMatch: If the capabilities cannot be

{tableio-0.2 → tableio-0.3}/src/tableio/reg_pkg_formats.py

@@ -16,6 +16,8 @@ from tableio.tableio_mformat import TableIOMformatHtml, TableIOMformatMd, \
     TableIOMformatRtf
 from tableio.tableio_csv import TableIOCsv
 from tableio.tableio_excel_openpyxl import TableIOExcelOpenPyXL
+from tableio.tableio_excel_pylightxl import TableIOExcelPylightxl
+from tableio.tableio_excel_xlsxwriter import TableIOExcelXlsxWriter
 from tableio.tableio_ods_odfdo import TableIOOdsOdfdo
 from tableio.tableio import TableIO
 
@@ -27,5 +29,8 @@ def register_formats_in_pkg() -> list[type[TableIO]]:
                                 TableIOMformatLatex, TableIOMformatDocx,
                                 TableIOMformatOdt, TableIOMformatPdf,
                                 TableIOMformatRtf, TableIOCsv,
-                                TableIOExcelOpenPyXL, TableIOOdsOdfdo]
+                                TableIOExcelOpenPyXL,
+                                TableIOExcelPylightxl,
+                                TableIOExcelXlsxWriter,
+                                TableIOOdsOdfdo]
     return ret