numbers-parser 4.17.0.post1__tar.gz → 4.18.0__tar.gz

{numbers_parser-4.17.0.post1/src/numbers_parser.egg-info → numbers_parser-4.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numbers-parser
-Version: 4.17.0.post1
+Version: 4.18.0
 Summary: Read and write Apple Numbers spreadsheets
 Author-email: Jon Connell <python@figsandfudge.com>
 License-Expression: MIT
@@ -26,20 +26,15 @@ Dynamic: license-file
 
 [![Test Status](https://github.com/masaccio/numbers-parser/actions/workflows/run-all-tests.yml/badge.svg)](https://github.com/masaccio/numbers-parser/actions/workflows/run-all-tests.yml)[![Security Checks](https://github.com/masaccio/numbers-parser/actions/workflows/codeql.yml/badge.svg)](https://github.com/masaccio/numbers-parser/actions/workflows/codeql.yml)[![Code Coverage](https://codecov.io/gh/masaccio/numbers-parser/branch/main/graph/badge.svg?token=EKIUFGT05E)](https://codecov.io/gh/masaccio/numbers-parser)[![PyPI Version](https://badge.fury.io/py/numbers-parser.svg)](https://badge.fury.io/py/numbers-parser)
 
-`numbers-parser` is a Python module for parsing [Apple Numbers](https://www.apple.com/numbers/)`.numbers` files. It supports Numbers files
-generated by Numbers version 10.3, and up with the latest tested version being 14.1
-(current as of June 2024).
+`numbers-parser` is a Python module for reading and editing [Apple Numbers](https://www.apple.com/numbers/)`.numbers` files. It supports Numbers files generated by Numbers versions 3.x and later. It is tested against Numbers documents from 10.0 through to 14.4 (the last version of Numbers) and Numbers Creator Studio up to version 15.1, which the most current as of February 2026.
 
-It supports and is tested against Python versions from 3.10 onwards. It is not compatible
-with earlier versions of Python.
+It supports and is tested against Python versions from 3.10 onwards. It is not compatible with earlier versions of Python.
 
 ## Installation
 
 A pre-requisite for this package is [python-snappy](https://pypi.org/project/python-snappy/) which will be installed by Python automatically, but python-snappy also requires binary libraries for snappy compression.
 
-The most straightforward way to install the binary dependencies is to use
-[Homebrew](https://brew.sh) and source Python from Homebrew rather than from macOS as described
-in the [python-snappy github](https://github.com/andrix/python-snappy). Using [pipx](https://pipx.pypa.io/stable/installation/) for package management is also strongly recommended:
+The most straightforward way to install the binary dependencies is to use [Homebrew](https://brew.sh) and source Python from Homebrew rather than from macOS as described in the [python-snappy github](https://github.com/andrix/python-snappy). Using [pipx](https://pipx.pypa.io/stable/installation/) for package management is also strongly recommended:
 
 ```bash
 brew install snappy python3 pipx
@@ -52,9 +47,7 @@ For Linux (your package manager may be different):
 sudo apt-get -y install libsnappy-dev
 ```
 
-On Windows, you will need to either arrange for snappy to be found for VSC++ or you can install python
-[pre-compiled binary libraries](https://github.com/cgohlke/win_arm64-wheels/) which are only available
-for Windows on Arm. There appear to be no x86 pre-compiled packages for Windows.
+On Windows, you will need to either arrange for snappy to be found for VSC++ or you can install python [pre-compiled binary libraries](https://github.com/cgohlke/win_arm64-wheels/) which are only available for Windows on Arm. There appear to be no x86 pre-compiled packages for Windows.
 
 ```text
 pip install python_snappy-0.6.1-cp312-cp312-win_arm64.whl
@@ -118,12 +111,7 @@ python datatype. Available cell types are:
 | ErrorCell    | `None`               |                                                                                                        |
 | MergedCell   | `None`               | See [Merged cells](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.MergedCell) |
 
-Cell references can be either zero-offset row/column integers or an
-Excel/Numbers A1 notation. Where cell values are not `None` the
-property `formatted_value` returns the cell value as a `str` as
-displayed in Numbers. Cells that have no values in a table are
-represented as `EmptyCell` and cells containing evaluation errors of
-any kind `ErrorCell`.
+Cell references can be either zero-offset row/column integers or an Excel/Numbers A1 notation. Where cell values are not `None` the property `formatted_value` returns the cell value as a `str` as displayed in Numbers. Cells that have no values in a table are represented as `EmptyCell` and cells containing evaluation errors of any kind `ErrorCell`.
 
 ```python
 >>> table.cell(1,0)
@@ -140,10 +128,7 @@ any kind `ErrorCell`.
 
 ### Pandas Support
 
-Since the return value of `rows()` is a list of lists, you can pass
-this directly to pandas. Assuming you have a Numbers table with a single
-header which contains the names of the pandas series you want to create
-you can construct a pandas dataframe using:
+Since the return value of `rows()` is a list of lists, you can pass this directly to pandas. Assuming you have a Numbers table with a single header which contains the names of the pandas series you want to create you can construct a pandas dataframe using:
 
 ```python
 import pandas as pd
@@ -157,14 +142,9 @@ df = pd.DataFrame(data[1:], columns=data[0])
 
 ### Writing Numbers Documents
 
-Whilst support for writing numbers files has been stable since version
-3.4.0, you are highly recommended not to overwrite working Numbers files
-and instead save data to a new file.
+Whilst support for writing numbers files has been stable since version 3.4.0, you are highly recommended not to overwrite working Numbers files and instead save data to a new file.
 
-Cell values are written using
-[Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and
-`numbers-parser` will automatically create empty rows and columns
-for any cell references that are out of range of the current table.
+Cell values are written using [Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and `numbers-parser` will automatically create empty rows and columns for any cell references that are out of range of the current table.
 
 ```python
 doc = Document("write.numbers")
@@ -176,9 +156,7 @@ table.write("B7", datetime(2020, 12, 25))
 doc.save("new-sheet.numbers")
 ```
 
-Additional tables and worksheets can be added to a `Document` before saving using
-[Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and
-[Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
+Additional tables and worksheets can be added to a `Document` before saving using [Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and [Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
 
 ```python
 doc = Document()
@@ -204,19 +182,11 @@ styles. The following styles are supported:
 - cell background images
 - cell indents (first line, left, right, and text inset)
 
-Numbers conflates style attributes that can be stored in paragraph
-styles (the style menu in the text panel) with the settings that are
-available on the Style tab of the Text panel. Some attributes in Numbers
-are not applied to new cells when a style is applied.
+Numbers conflates style attributes that can be stored in paragraph styles (the style menu in the text panel) with the settings that are available on the Style tab of the Text panel. Some attributes in Numbers are not applied to new cells when a style is applied.
 
-To keep the API simple, `numbers-parser` packs all styling into a single
-[Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes
-not stored in a paragraph style are applied to each cell that includes it.
+To keep the API simple, `numbers-parser` packs all styling into a single [Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes not stored in a paragraph style are applied to each cell that includes it.
 
-Styles are read from cells using the
-[Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can
-add new styles with
-[Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
+Styles are read from cells using the [Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can add new styles with [Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
 
 ```python
 red_text = doc.add_style(
@@ -234,18 +204,11 @@ table.set_cell_style("C2", red_text)
 
 ### Cell Data Formatting
 
-Numbers has two different cell formatting types: data formats and custom
-formats.
+Numbers has two different cell formatting types: data formats and custom formats.
 
-Data formats are presented in Numbers in the Cell tab of the Format pane
-and are applied to individual cells. Like Numbers, `numbers-parsers`
-caches formatting information that is identical across multiple cells.
-You do not need to take any action for this to happen; this is handled
-internally by the package. Changing a data format for cell has no impact
-on any other cells.
+Data formats are presented in Numbers in the Cell tab of the Format pane and are applied to individual cells. Like Numbers, `numbers-parsers` caches formatting information that is identical across multiple cells. You do not need to take any action for this to happen; this is handled internally by the package. Changing a data format for cell has no impact on any other cells.
 
-Cell formats are changed using
-[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
+Cell formats are changed using [Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
 table.set_cell_formatting(
@@ -262,13 +225,7 @@ table.set_cell_formatting(
 )
 ```
 
-Custom formats are shared across a Document and can be applied to
-multiple cells in multiple tables. Editing a custom format changes the
-appearance of data in all cells that share that format. You must first
-add a custom format to the document using
-[Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format)
-before assigning it to cells using
-[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
+Custom formats are shared across a Document and can be applied to multiple cells in multiple tables. Editing a custom format changes the appearance of data in all cells that share that format. You must first add a custom format to the document using [Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format) before assigning it to cells using [Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
 long_date = doc.add_custom_format(
@@ -279,33 +236,17 @@ long_date = doc.add_custom_format(
 table.set_cell_formatting("C1", "custom", format=long_date)
 ```
 
-A limited number of currencies are formatted using symbolic notation
-rather than an ISO code. These are defined in
-`numbers_parser.currencies` and match the ones chosen by Numbers. For
-example, US dollars are referred to as `US$` whereas Euros and British
-Pounds are referred to using their symbols of `€` and `£`
-respectively.
+A limited number of currencies are formatted using symbolic notation rather than an ISO code. These are defined in `numbers_parser.currencies` and match the ones chosen by Numbers. For example, US dollars are referred to as `US$` whereas Euros and British Pounds are referred to using their symbols of `€` and `£` respectively.
 
 ### Borders
 
-`numbers-parser` supports reading and writing cell borders, though the
-interface for each differs. Individual cells can have each of their four
-borders tested, but when drawing new borders, these are set for the
-table to allow for drawing borders across multiple cells. Setting the
-border of merged cells is not possible unless the edge of the cells is
-at the end of the merged region.
+`numbers-parser` supports reading and writing cell borders, though the interface for each differs. Individual cells can have each of their four borders tested, but when drawing new borders, these are set for the table to allow for drawing borders across multiple cells. Setting the border of merged cells is not possible unless the edge of the cells is at the end of the merged region.
 
-Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class
-that can be initialized with line width, color and line style. The
-current state of a cell border is read using the
-[Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property
-and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border)
-sets the border for a cell edge or a range of cells.
+Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class that can be initialized with line width, color and line style. The current state of a cell border is read using the [Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border) sets the border for a cell edge or a range of cells.
 
 ## API
 
-For more examples and details of all available classes and methods,
-see the [full API docs](https://masaccio.github.io/numbers-parser/).
+For more examples and details of all available classes and methods, see the [full API docs](https://masaccio.github.io/numbers-parser/).
 
 ## Command-line scripts
 
@@ -318,9 +259,7 @@ a number of command-line scripts are installed:
 
 ### cat-numbers
 
-This script dumps Numbers spreadsheets into Excel-compatible CSV
-format, iterating through all the spreadsheets passed on the
-command-line.
+This script dumps Numbers spreadsheets into Excel-compatible CSV format, iterating through all the spreadsheets passed on the command-line.
 
 ```text
 usage: cat-numbers [-h] [-T | -S | -b] [-V] [--formulas] [--formatting]
@@ -349,25 +288,17 @@ options:
   --debug               Enable debug logging
 ```
 
-Note: `--formatting` will return different capitalization for 12-hour
-times due to differences between Numbers’ representation of these dates
-and `datetime.strftime`. Numbers in English locales displays 12-hour
-times with ‘am’ and ‘pm’, but `datetime.strftime` on macOS at least
-cannot return lower-case versions of AM/PM.
+Note: `--formatting` will return different capitalization for 12-hour times due to differences between Numbers’ representation of these dates and `datetime.strftime`. Numbers in English locales displays 12-hour times with ‘am’ and ‘pm’, but `datetime.strftime` on macOS at least cannot return lower-case versions of AM/PM.
 
 ### csv2numbers
 
-This script converts Excel-compatible CSV files into Numbers documents. Output files
-can optionally be provided, but is none are provided, the output is created by replacing
-the input’s files suffix with .numbers. For example:
+This script converts Excel-compatible CSV files into Numbers documents. Output files can optionally be provided, but is none are provided, the output is created by replacing the input’s files suffix with .numbers. For example:
 
 ```text
 csv2numbers file1.csv file2.csv -o file1.numbers file2.numbers
 ```
 
-Columns of data can have a number of transformations applied to them. The primary use-
-case intended for `csv2numbers` is converting banking exports to well-formatted
-spreadsheets.
+Columns of data can have a number of transformations applied to them. The primary use- case intended for `csv2numbers` is converting banking exports to well-formatted spreadsheets.
 
 ```text
 usage: csv2numbers [-h] [-V] [--whitespace] [--reverse] [--no-header]
@@ -455,39 +386,22 @@ csv2numbers --transform='Category=LOOKUP:Transaction;mapping.numbers' file1.csv
 
 Current known limitations of `numbers-parser` which may be implemented in the future are:
 
-- Table styles that allow new tables to adopt a style across the whole
-  table are not suppported
+- Table styles that allow new tables to adopt a style across the whole table are not supported
 - Creating cells of type `BulletedTextCell` is not supported
-- New tables are inserted with a fixed offset below the last table in a
-  worksheet which does not take into account title or caption size
-- Captions can be created and edited as of numbers-parser version 4.12, but cannot
-  be styled. New captions adopt the first caption style available in the current
-  document
+- New tables are inserted with a fixed offset below the last table in a worksheet which does not take into account title or caption size
+- Captions can be created and edited as of numbers-parser version 4.12, but cannot be styled. New captions adopt the first caption style available in the current document
 - Formulas cannot be written to a document
-- Pivot tables are unsupported and saving a document with a pivot table issues
-  a UnsupportedWarning (see [issue 73](https://github.com/masaccio/numbers-parser/issues/73) for details).
+- Pivot tables are unsupported and saving a document with a pivot table issues a UnsupportedWarning (see [issue 73](https://github.com/masaccio/numbers-parser/issues/73) for details).
+- Tables which have been saved grouped cannot be safely edited as references to written cells refer to the ungrouped cell rows rather than the row number in the groups.
 
 The following limitations are expected to always remain:
 
-- New sheets insert tables with formats copied from the first table in
-  the previous sheet rather than default table formats
-- Due to a limitation in Python’s
-  [ZipFile](https://docs.python.org/3/library/zipfile.html), Python
-  versions older than 3.11 do not support image filenames with UTF-8 characters
-  [Cell.add_style.bg_image()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Style) returns
-  `None` for such files and issues a `RuntimeWarning`
-  (see [issue 69](https://github.com/masaccio/numbers-parser/issues/69) for details).
-- Password-encrypted documents cannot be opened. You must first re-save without
-  a password to read (see [issue 88](https://github.com/masaccio/numbers-parser/issues/88) for details).
-  A UnsupportedError exception is raised when such documents are opened.
-- Due to changes in the format of Numbers documents, decoding of category groups
-  (introduced in `numbers-parser` version 4.16) is supported only for documents
-  created by Numbers 12.0 and later. No warnings are issued for earlier
+- New sheets insert tables with formats copied from the first table in the previous sheet rather than default table formats
+- Due to a limitation in Python’s [ZipFile](https://docs.python.org/3/library/zipfile.html), Python versions older than 3.11 do not support image filenames with UTF-8 characters [Cell.add_style.bg_image()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Style) returns `None` for such files and issues a `RuntimeWarning` (see [issue 69](https://github.com/masaccio/numbers-parser/issues/69) for details).
+- Password-encrypted documents cannot be opened. You must first re-save without a password to read (see [issue 88](https://github.com/masaccio/numbers-parser/issues/88) for details).  A UnsupportedError exception is raised when such documents are opened.
+- Due to changes in the format of Numbers documents, decoding of category groups (introduced in `numbers-parser` version 4.16) is supported only for documents created by Numbers 12.0 and later. No warnings are issued for earlier
   Numbers documents.
-- Only standard macOS fonts are not supported. If a document includes a non-standard
-  font, numbers-parser will issue a UnsupportedWarning and default styles to
-  Helvetica Neue. Reading font names from the system would add additional system-specific
-  dependencies to the package and so this is not planned to changed.
+- Only standard macOS fonts are not supported. If a document includes a non-standard font, numbers-parser will issue a UnsupportedWarning and default styles to Helvetica Neue. Reading font names from the system would add additional system-specific dependencies to the package and so this is not planned to changed.
 
 ## License
 

{numbers_parser-4.17.0.post1 → numbers_parser-4.18.0}/README.md

@@ -2,20 +2,15 @@
 
 [![Test Status](https://github.com/masaccio/numbers-parser/actions/workflows/run-all-tests.yml/badge.svg)](https://github.com/masaccio/numbers-parser/actions/workflows/run-all-tests.yml)[![Security Checks](https://github.com/masaccio/numbers-parser/actions/workflows/codeql.yml/badge.svg)](https://github.com/masaccio/numbers-parser/actions/workflows/codeql.yml)[![Code Coverage](https://codecov.io/gh/masaccio/numbers-parser/branch/main/graph/badge.svg?token=EKIUFGT05E)](https://codecov.io/gh/masaccio/numbers-parser)[![PyPI Version](https://badge.fury.io/py/numbers-parser.svg)](https://badge.fury.io/py/numbers-parser)
 
-`numbers-parser` is a Python module for parsing [Apple Numbers](https://www.apple.com/numbers/)`.numbers` files. It supports Numbers files
-generated by Numbers version 10.3, and up with the latest tested version being 14.1
-(current as of June 2024).
+`numbers-parser` is a Python module for reading and editing [Apple Numbers](https://www.apple.com/numbers/)`.numbers` files. It supports Numbers files generated by Numbers versions 3.x and later. It is tested against Numbers documents from 10.0 through to 14.4 (the last version of Numbers) and Numbers Creator Studio up to version 15.1, which the most current as of February 2026.
 
-It supports and is tested against Python versions from 3.10 onwards. It is not compatible
-with earlier versions of Python.
+It supports and is tested against Python versions from 3.10 onwards. It is not compatible with earlier versions of Python.
 
 ## Installation
 
 A pre-requisite for this package is [python-snappy](https://pypi.org/project/python-snappy/) which will be installed by Python automatically, but python-snappy also requires binary libraries for snappy compression.
 
-The most straightforward way to install the binary dependencies is to use
-[Homebrew](https://brew.sh) and source Python from Homebrew rather than from macOS as described
-in the [python-snappy github](https://github.com/andrix/python-snappy). Using [pipx](https://pipx.pypa.io/stable/installation/) for package management is also strongly recommended:
+The most straightforward way to install the binary dependencies is to use [Homebrew](https://brew.sh) and source Python from Homebrew rather than from macOS as described in the [python-snappy github](https://github.com/andrix/python-snappy). Using [pipx](https://pipx.pypa.io/stable/installation/) for package management is also strongly recommended:
 
 ```bash
 brew install snappy python3 pipx
@@ -28,9 +23,7 @@ For Linux (your package manager may be different):
 sudo apt-get -y install libsnappy-dev
 ```
 
-On Windows, you will need to either arrange for snappy to be found for VSC++ or you can install python
-[pre-compiled binary libraries](https://github.com/cgohlke/win_arm64-wheels/) which are only available
-for Windows on Arm. There appear to be no x86 pre-compiled packages for Windows.
+On Windows, you will need to either arrange for snappy to be found for VSC++ or you can install python [pre-compiled binary libraries](https://github.com/cgohlke/win_arm64-wheels/) which are only available for Windows on Arm. There appear to be no x86 pre-compiled packages for Windows.
 
 ```text
 pip install python_snappy-0.6.1-cp312-cp312-win_arm64.whl
@@ -94,12 +87,7 @@ python datatype. Available cell types are:
 | ErrorCell    | `None`               |                                                                                                        |
 | MergedCell   | `None`               | See [Merged cells](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.MergedCell) |
 
-Cell references can be either zero-offset row/column integers or an
-Excel/Numbers A1 notation. Where cell values are not `None` the
-property `formatted_value` returns the cell value as a `str` as
-displayed in Numbers. Cells that have no values in a table are
-represented as `EmptyCell` and cells containing evaluation errors of
-any kind `ErrorCell`.
+Cell references can be either zero-offset row/column integers or an Excel/Numbers A1 notation. Where cell values are not `None` the property `formatted_value` returns the cell value as a `str` as displayed in Numbers. Cells that have no values in a table are represented as `EmptyCell` and cells containing evaluation errors of any kind `ErrorCell`.
 
 ```python
 >>> table.cell(1,0)
@@ -116,10 +104,7 @@ any kind `ErrorCell`.
 
 ### Pandas Support
 
-Since the return value of `rows()` is a list of lists, you can pass
-this directly to pandas. Assuming you have a Numbers table with a single
-header which contains the names of the pandas series you want to create
-you can construct a pandas dataframe using:
+Since the return value of `rows()` is a list of lists, you can pass this directly to pandas. Assuming you have a Numbers table with a single header which contains the names of the pandas series you want to create you can construct a pandas dataframe using:
 
 ```python
 import pandas as pd
@@ -133,14 +118,9 @@ df = pd.DataFrame(data[1:], columns=data[0])
 
 ### Writing Numbers Documents
 
-Whilst support for writing numbers files has been stable since version
-3.4.0, you are highly recommended not to overwrite working Numbers files
-and instead save data to a new file.
+Whilst support for writing numbers files has been stable since version 3.4.0, you are highly recommended not to overwrite working Numbers files and instead save data to a new file.
 
-Cell values are written using
-[Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and
-`numbers-parser` will automatically create empty rows and columns
-for any cell references that are out of range of the current table.
+Cell values are written using [Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and `numbers-parser` will automatically create empty rows and columns for any cell references that are out of range of the current table.
 
 ```python
 doc = Document("write.numbers")
@@ -152,9 +132,7 @@ table.write("B7", datetime(2020, 12, 25))
 doc.save("new-sheet.numbers")
 ```
 
-Additional tables and worksheets can be added to a `Document` before saving using
-[Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and
-[Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
+Additional tables and worksheets can be added to a `Document` before saving using [Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and [Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
 
 ```python
 doc = Document()
@@ -180,19 +158,11 @@ styles. The following styles are supported:
 - cell background images
 - cell indents (first line, left, right, and text inset)
 
-Numbers conflates style attributes that can be stored in paragraph
-styles (the style menu in the text panel) with the settings that are
-available on the Style tab of the Text panel. Some attributes in Numbers
-are not applied to new cells when a style is applied.
+Numbers conflates style attributes that can be stored in paragraph styles (the style menu in the text panel) with the settings that are available on the Style tab of the Text panel. Some attributes in Numbers are not applied to new cells when a style is applied.
 
-To keep the API simple, `numbers-parser` packs all styling into a single
-[Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes
-not stored in a paragraph style are applied to each cell that includes it.
+To keep the API simple, `numbers-parser` packs all styling into a single [Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes not stored in a paragraph style are applied to each cell that includes it.
 
-Styles are read from cells using the
-[Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can
-add new styles with
-[Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
+Styles are read from cells using the [Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can add new styles with [Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
 
 ```python
 red_text = doc.add_style(
@@ -210,18 +180,11 @@ table.set_cell_style("C2", red_text)
 
 ### Cell Data Formatting
 
-Numbers has two different cell formatting types: data formats and custom
-formats.
+Numbers has two different cell formatting types: data formats and custom formats.
 
-Data formats are presented in Numbers in the Cell tab of the Format pane
-and are applied to individual cells. Like Numbers, `numbers-parsers`
-caches formatting information that is identical across multiple cells.
-You do not need to take any action for this to happen; this is handled
-internally by the package. Changing a data format for cell has no impact
-on any other cells.
+Data formats are presented in Numbers in the Cell tab of the Format pane and are applied to individual cells. Like Numbers, `numbers-parsers` caches formatting information that is identical across multiple cells. You do not need to take any action for this to happen; this is handled internally by the package. Changing a data format for cell has no impact on any other cells.
 
-Cell formats are changed using
-[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
+Cell formats are changed using [Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
 table.set_cell_formatting(
@@ -238,13 +201,7 @@ table.set_cell_formatting(
 )
 ```
 
-Custom formats are shared across a Document and can be applied to
-multiple cells in multiple tables. Editing a custom format changes the
-appearance of data in all cells that share that format. You must first
-add a custom format to the document using
-[Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format)
-before assigning it to cells using
-[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
+Custom formats are shared across a Document and can be applied to multiple cells in multiple tables. Editing a custom format changes the appearance of data in all cells that share that format. You must first add a custom format to the document using [Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format) before assigning it to cells using [Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
 long_date = doc.add_custom_format(
@@ -255,33 +212,17 @@ long_date = doc.add_custom_format(
 table.set_cell_formatting("C1", "custom", format=long_date)
 ```
 
-A limited number of currencies are formatted using symbolic notation
-rather than an ISO code. These are defined in
-`numbers_parser.currencies` and match the ones chosen by Numbers. For
-example, US dollars are referred to as `US$` whereas Euros and British
-Pounds are referred to using their symbols of `€` and `£`
-respectively.
+A limited number of currencies are formatted using symbolic notation rather than an ISO code. These are defined in `numbers_parser.currencies` and match the ones chosen by Numbers. For example, US dollars are referred to as `US$` whereas Euros and British Pounds are referred to using their symbols of `€` and `£` respectively.
 
 ### Borders
 
-`numbers-parser` supports reading and writing cell borders, though the
-interface for each differs. Individual cells can have each of their four
-borders tested, but when drawing new borders, these are set for the
-table to allow for drawing borders across multiple cells. Setting the
-border of merged cells is not possible unless the edge of the cells is
-at the end of the merged region.
+`numbers-parser` supports reading and writing cell borders, though the interface for each differs. Individual cells can have each of their four borders tested, but when drawing new borders, these are set for the table to allow for drawing borders across multiple cells. Setting the border of merged cells is not possible unless the edge of the cells is at the end of the merged region.
 
-Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class
-that can be initialized with line width, color and line style. The
-current state of a cell border is read using the
-[Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property
-and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border)
-sets the border for a cell edge or a range of cells.
+Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class that can be initialized with line width, color and line style. The current state of a cell border is read using the [Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border) sets the border for a cell edge or a range of cells.
 
 ## API
 
-For more examples and details of all available classes and methods,
-see the [full API docs](https://masaccio.github.io/numbers-parser/).
+For more examples and details of all available classes and methods, see the [full API docs](https://masaccio.github.io/numbers-parser/).
 
 ## Command-line scripts
 
@@ -294,9 +235,7 @@ a number of command-line scripts are installed:
 
 ### cat-numbers
 
-This script dumps Numbers spreadsheets into Excel-compatible CSV
-format, iterating through all the spreadsheets passed on the
-command-line.
+This script dumps Numbers spreadsheets into Excel-compatible CSV format, iterating through all the spreadsheets passed on the command-line.
 
 ```text
 usage: cat-numbers [-h] [-T | -S | -b] [-V] [--formulas] [--formatting]
@@ -325,25 +264,17 @@ options:
   --debug               Enable debug logging
 ```
 
-Note: `--formatting` will return different capitalization for 12-hour
-times due to differences between Numbers’ representation of these dates
-and `datetime.strftime`. Numbers in English locales displays 12-hour
-times with ‘am’ and ‘pm’, but `datetime.strftime` on macOS at least
-cannot return lower-case versions of AM/PM.
+Note: `--formatting` will return different capitalization for 12-hour times due to differences between Numbers’ representation of these dates and `datetime.strftime`. Numbers in English locales displays 12-hour times with ‘am’ and ‘pm’, but `datetime.strftime` on macOS at least cannot return lower-case versions of AM/PM.
 
 ### csv2numbers
 
-This script converts Excel-compatible CSV files into Numbers documents. Output files
-can optionally be provided, but is none are provided, the output is created by replacing
-the input’s files suffix with .numbers. For example:
+This script converts Excel-compatible CSV files into Numbers documents. Output files can optionally be provided, but is none are provided, the output is created by replacing the input’s files suffix with .numbers. For example:
 
 ```text
 csv2numbers file1.csv file2.csv -o file1.numbers file2.numbers
 ```
 
-Columns of data can have a number of transformations applied to them. The primary use-
-case intended for `csv2numbers` is converting banking exports to well-formatted
-spreadsheets.
+Columns of data can have a number of transformations applied to them. The primary use- case intended for `csv2numbers` is converting banking exports to well-formatted spreadsheets.
 
 ```text
 usage: csv2numbers [-h] [-V] [--whitespace] [--reverse] [--no-header]
@@ -431,39 +362,22 @@ csv2numbers --transform='Category=LOOKUP:Transaction;mapping.numbers' file1.csv
 
 Current known limitations of `numbers-parser` which may be implemented in the future are:
 
-- Table styles that allow new tables to adopt a style across the whole
-  table are not suppported
+- Table styles that allow new tables to adopt a style across the whole table are not supported
 - Creating cells of type `BulletedTextCell` is not supported
-- New tables are inserted with a fixed offset below the last table in a
-  worksheet which does not take into account title or caption size
-- Captions can be created and edited as of numbers-parser version 4.12, but cannot
-  be styled. New captions adopt the first caption style available in the current
-  document
+- New tables are inserted with a fixed offset below the last table in a worksheet which does not take into account title or caption size
+- Captions can be created and edited as of numbers-parser version 4.12, but cannot be styled. New captions adopt the first caption style available in the current document
 - Formulas cannot be written to a document
-- Pivot tables are unsupported and saving a document with a pivot table issues
-  a UnsupportedWarning (see [issue 73](https://github.com/masaccio/numbers-parser/issues/73) for details).
+- Pivot tables are unsupported and saving a document with a pivot table issues a UnsupportedWarning (see [issue 73](https://github.com/masaccio/numbers-parser/issues/73) for details).
+- Tables which have been saved grouped cannot be safely edited as references to written cells refer to the ungrouped cell rows rather than the row number in the groups.
 
 The following limitations are expected to always remain:
 
-- New sheets insert tables with formats copied from the first table in
-  the previous sheet rather than default table formats
-- Due to a limitation in Python’s
-  [ZipFile](https://docs.python.org/3/library/zipfile.html), Python
-  versions older than 3.11 do not support image filenames with UTF-8 characters
-  [Cell.add_style.bg_image()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Style) returns
-  `None` for such files and issues a `RuntimeWarning`
-  (see [issue 69](https://github.com/masaccio/numbers-parser/issues/69) for details).
-- Password-encrypted documents cannot be opened. You must first re-save without
-  a password to read (see [issue 88](https://github.com/masaccio/numbers-parser/issues/88) for details).
-  A UnsupportedError exception is raised when such documents are opened.
-- Due to changes in the format of Numbers documents, decoding of category groups
-  (introduced in `numbers-parser` version 4.16) is supported only for documents
-  created by Numbers 12.0 and later. No warnings are issued for earlier
+- New sheets insert tables with formats copied from the first table in the previous sheet rather than default table formats
+- Due to a limitation in Python’s [ZipFile](https://docs.python.org/3/library/zipfile.html), Python versions older than 3.11 do not support image filenames with UTF-8 characters [Cell.add_style.bg_image()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Style) returns `None` for such files and issues a `RuntimeWarning` (see [issue 69](https://github.com/masaccio/numbers-parser/issues/69) for details).
+- Password-encrypted documents cannot be opened. You must first re-save without a password to read (see [issue 88](https://github.com/masaccio/numbers-parser/issues/88) for details).  A UnsupportedError exception is raised when such documents are opened.
+- Due to changes in the format of Numbers documents, decoding of category groups (introduced in `numbers-parser` version 4.16) is supported only for documents created by Numbers 12.0 and later. No warnings are issued for earlier
   Numbers documents.
-- Only standard macOS fonts are not supported. If a document includes a non-standard
-  font, numbers-parser will issue a UnsupportedWarning and default styles to
-  Helvetica Neue. Reading font names from the system would add additional system-specific
-  dependencies to the package and so this is not planned to changed.
+- Only standard macOS fonts are not supported. If a document includes a non-standard font, numbers-parser will issue a UnsupportedWarning and default styles to Helvetica Neue. Reading font names from the system would add additional system-specific dependencies to the package and so this is not planned to changed.
 
 ## License
 

{numbers_parser-4.17.0.post1 → numbers_parser-4.18.0}/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 description = "Read and write Apple Numbers spreadsheets"
 name = "numbers-parser"
 readme = "README.md"
-version = "4.17.0.post1"
+version = "4.18.0"
 
 [project.urls]
 repository = "https://github.com/masaccio/numbers-parser"

{numbers_parser-4.17.0.post1 → numbers_parser-4.18.0}/src/numbers_parser/_cat_numbers.py

@@ -16,11 +16,19 @@ from numbers_parser import (
 )
 from numbers_parser import __name__ as numbers_parser_name
 from numbers_parser.constants import MAX_SIGNIFICANT_DIGITS
-from numbers_parser.experimental import _enable_experimental_features
+from numbers_parser.experimental import ExperimentalFeatures, enable_experimental_feature
 
 logger = logging.getLogger(numbers_parser_name)
 
 
+def experimental_feature_choice(s: str) -> ExperimentalFeatures:
+    try:
+        return ExperimentalFeatures[s]
+    except KeyError:
+        msg = f"invalid experimental feature: {s}"
+        raise argparse.ArgumentTypeError(msg)  # noqa: B904
+
+
 def command_line_parser():
     parser = argparse.ArgumentParser(
         description="Export data from Apple Numbers spreadsheet tables",
@@ -70,10 +78,13 @@ def command_line_parser():
     )
     parser.add_argument("document", nargs="*", help="Document(s) to export")
     parser.add_argument("--debug", default=False, action="store_true", help="Enable debug logging")
+    experimental_choices = [
+        f.name for f in ExperimentalFeatures if f is not ExperimentalFeatures.NONE
+    ]
     parser.add_argument(
         "--experimental",
-        default=False,
-        action="store_true",
+        type=experimental_feature_choice,
+        choices=[ExperimentalFeatures[name] for name in experimental_choices],
         help=argparse.SUPPRESS,
     )
     return parser
@@ -136,7 +147,7 @@ def main() -> None:
         else:
             logger.setLevel("ERROR")
         if args.experimental:
-            _enable_experimental_features(True)
+            enable_experimental_feature(args.experimental)
         for filename in args.document:
             try:
                 if args.list_sheets: