numbers-parser 4.14.1__tar.gz → 4.14.2__tar.gz

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numbers-parser
-Version: 4.14.1
+Version: 4.14.2
 Summary: Read and write Apple Numbers spreadsheets
 Home-page: https://github.com/masaccio/numbers-parser
 License: MIT
@@ -128,6 +128,18 @@ Cells are objects with a common base class of `Cell`. All cell types
 have a property `value` which returns the contents of the cell as a
 python datatype. Available cell types are:
 
+| Cell type    | value type           | Additional properties                                                                                  |
+|--------------|----------------------|--------------------------------------------------------------------------------------------------------|
+| NumberCell   | `float`              |                                                                                                        |
+| TextCell     | `str`                |                                                                                                        |
+| RichTextCell | `str`                | See [Rich text](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.RichTextCell)  |
+| EmptyCell    | `None`               |                                                                                                        |
+| BoolCell     | `bool`               |                                                                                                        |
+| DateCell     | `datetime.datetime`  |                                                                                                        |
+| DurationCell | `datetime.timedelta` |                                                                                                        |
+| 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
@@ -489,6 +501,7 @@ The following limitations are expected to always remain:
   (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.
 
 ## License
 

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/README.md

@@ -99,6 +99,18 @@ Cells are objects with a common base class of `Cell`. All cell types
 have a property `value` which returns the contents of the cell as a
 python datatype. Available cell types are:
 
+| Cell type    | value type           | Additional properties                                                                                  |
+|--------------|----------------------|--------------------------------------------------------------------------------------------------------|
+| NumberCell   | `float`              |                                                                                                        |
+| TextCell     | `str`                |                                                                                                        |
+| RichTextCell | `str`                | See [Rich text](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.RichTextCell)  |
+| EmptyCell    | `None`               |                                                                                                        |
+| BoolCell     | `bool`               |                                                                                                        |
+| DateCell     | `datetime.datetime`  |                                                                                                        |
+| DurationCell | `datetime.timedelta` |                                                                                                        |
+| 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
@@ -460,6 +472,7 @@ The following limitations are expected to always remain:
   (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.
 
 ## License
 

numbers_parser-4.14.2/pyproject.toml

@@ -0,0 +1,193 @@
+[tool.poetry]
+authors = ["Jon Connell <python@figsandfudge.com>"]
+classifiers = [
+  "Topic :: Office/Business :: Financial :: Spreadsheet",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+description = "Read and write Apple Numbers spreadsheets"
+documentation = "https://github.com/masaccio/numbers-parser/blob/main/README.md"
+license = "MIT"
+name = "numbers-parser"
+packages = [{include = "numbers_parser", from = "src"}]
+readme = "README.md"
+repository = "https://github.com/masaccio/numbers-parser"
+version = "4.14.2"
+
+[tool.poetry.scripts]
+cat-numbers = "numbers_parser._cat_numbers:main"
+unpack-numbers = "numbers_parser._unpack_numbers:main"
+csv2numbers = "numbers_parser._csv2numbers:main"
+
+[tool.poetry.dependencies]
+compact-json = "^1.1.3"
+protobuf = "*"
+python = ">=3.9,<4.0"
+python-snappy = "^0.7"
+sigfig = "^1.3.3"
+setuptools = ">=70.0.0"
+importlib-resources = ">=6.1"
+enum-tools = ">=0.11"
+python-dateutil = "^2.9.0.post0"
+
+[tool.poetry.group.dev.dependencies]
+gprof2dot = "^2022.7.29"
+line-profiler = "^4.0.3"
+mock = ">=5.1.0"
+psutil = ">=5.9"
+pytest = ">=7.2.0"
+pytest-check = ">=1.0"
+pytest-console-scripts = "^1.3.1"
+pytest-cov = ">=4.0,>=5.0"
+pytest-xdist = "^3.3.1"
+ruff = "*"
+tox = "^4.11.4"
+python-magic = ">=0.4"
+tqdm = ">=4.66"
+colorama = "^0.4.6"
+roman = "^4.2"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = ">= 7.3"
+enum-tools = ">=0.11"
+sphinx-toolbox = ">=3.5"
+sphinx-nefertiti = ">=0.3.3"
+sphinx-markdown-builder = ">=0.6"
+sphinx-copybutton = ">=0.5"
+
+[tool.poetry.group.bootstrap]
+optional = true
+
+[tool.poetry.group.bootstrap.dependencies]
+pyobjc-core = ">=10.2"
+pyobjc-framework-Cocoa = ">=10.2"
+py2app = ">=0.28"
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0"]
+
+[tool.coverage.run]
+branch = true
+omit = ["src/numbers_parser/generated/*.py"]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+show_contexts = true
+
+[tool.pytest.ini_options]
+addopts = "--cov=src/numbers_parser --cov-report=html --cov-report=term-missing:skip-covered --cov-context=test"
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+isolated_build = true
+envlist = py39, py310, py311, py312, py313
+[testenv]
+deps =
+  pytest
+  pytest-check
+  pytest-console-scripts
+  pytest-cov
+  pytest-xdist
+  python-magic
+  psutil
+  roman
+commands =
+  pytest tests/ --import-mode importlib -n logical --no-cov
+"""
+
+[tool.isort]
+profile = "black"
+
+[tool.ruff]
+exclude = [
+  # Machine-generated files
+  "**/.bootstrap/*",
+  "**/.tox/*",
+  "**/.vscode/*",
+  "**/src/numbers_parser/generated/*",
+  # Third-party files not to lint
+  "**/src/debug/lldbutil.py",
+]
+fix = true
+lint.ignore = [
+  # "PLR2004", # Allow constant values
+  "T201", # Allow print()
+  # To fix:
+  "ANN001", #Missing type annotation
+  "ANN002", #Missing type annotation
+  "ANN003", #Missing type annotation
+  "ANN201", #Missing return type annotation
+  "ANN202", #Missing return type annotation
+  "ANN204", #Missing return type annotation
+  "ANN205", #Missing return type annotation
+  "ANN206", #Missing return type annotation
+  "ANN401", #Dynamically typed expressions
+  "ARG001", #Unused function argument
+  "ARG002", #Unused method argument
+  "ARG003", #Unused class method argument
+  "BLE001", #Do not catch blind exception
+  "C901", #code too complex
+  "D100", #Missing docstring
+  "D101", #Missing docstring
+  "D102", #Missing docstring
+  "D103", #Missing docstring
+  "D105", #Missing docstring
+  "D107", #Missing docstring
+  "D205", # Blank line - conflicts with black
+  "D210", #No whitespaces allowed surrounding docstring text
+  "D400", #First line should end with a period
+  "D401", #First line of docstring should be in imperative mood
+  "D415", #First line should end with a period, question mark, or exclamation point
+  "E501", #Line too long
+  "ERA001", #Found commented-out code
+  "FBT001", #Boolean-typed positional argument in function definition
+  "FBT002", #Boolean default positional argument in function definition
+  "FBT003", #Boolean positional value in function call
+  "FIX002", #Line contains TODO, consider resolving the issue
+  "ISC003", #Explicitly concatenated string should be implicitly concatenated
+  "PERF401", #Use a list comprehension to create a transformed list
+  "PLR0913", #Too many arguments
+  "PLR2004", #Magic value used
+  "PLW0603", #Using the global statement
+  "PTH103", # Use of os.makedirs()
+  "PTH118", # Use of os.path.join()
+  "PTH119", # Use of os.path.basename()
+  "PTH123", # Use of open()
+  "RUF001", #String contains ambiguous
+  "RUF002", #Docstring contains ambiguous
+  "RUF003", #Comment contains ambiguous
+  "SIM115", #Use a context manager for opening files
+  "SLF001", #Private member accessed
+  "TD002", # TODO author
+  "TD003", # TODO author
+  # Conflicts with other rules
+  "D212", # Multiline summary first line
+  "D203", # Blank lines before class docstrings
+  "D416", # Colon after after section titles
+]
+line-length = 100
+lint.select = [ "ALL" ]
+src = ["src", "tests"]
+target-version = "py39"
+lint.unfixable = [
+  "ERA", # do not autoremove commented out code
+]
+
+[tool.ruff.lint.pylint]
+max-statements = 100
+max-branches = 20
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.per-file-ignores]
+"docs/conf.py" = ["INP001"]
+"src/build/**" = ["PLR2004", "INP001", "PTH"]
+"src/build/protodump.py" = ["PLR2004", "INP001", "PTH", "S110", "N806"]
+"src/debug/**" = ["INP001"]
+"tests/**" = ["PLR2004", "S101", "D103", "ANN201", "ANN001"]

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/src/numbers_parser/__init__.py

@@ -1,4 +1,4 @@
-__doc__ = """Parse and extract data from Apple Numbers spreadsheets"""
+"""Parse and extract data from Apple Numbers spreadsheets."""
 
 import importlib.metadata
 import os
@@ -20,11 +20,11 @@ _DEFAULT_NUMBERS_INSTALL_PATH = "/Applications/Numbers.app"
 _VERSION_PLIST_PATH = "Contents/version.plist"
 
 
-def _get_version():
+def _get_version() -> str:
     return __version__
 
 
-def _check_installed_numbers_version():
+def _check_installed_numbers_version() -> str:
     try:
         fp = open(os.path.join(_DEFAULT_NUMBERS_INSTALL_PATH, _VERSION_PLIST_PATH), "rb")
     except OSError:

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/src/numbers_parser/_cat_numbers.py

@@ -71,12 +71,12 @@ def command_line_parser():
     return parser
 
 
-def print_sheet_names(filename):
+def print_sheet_names(filename) -> None:
     for sheet in Document(filename).sheets:
         print(f"{filename}: {sheet.name}")
 
 
-def print_table_names(filename):
+def print_table_names(filename) -> None:
     for sheet in Document(filename).sheets:
         for table in sheet.tables:
             print(f"{filename}: {sheet.name}: {table.name}")
@@ -85,19 +85,18 @@ def print_table_names(filename):
 def cell_as_string(args, cell):
     if isinstance(cell, ErrorCell) and not (args.formulas):
         return "#REF!"
-    elif args.formulas and cell.formula is not None:
+    if args.formulas and cell.formula is not None:
         return cell.formula
-    elif args.formatting and cell.formatted_value is not None:
+    if args.formatting and cell.formatted_value is not None:
         return cell.formatted_value
-    elif isinstance(cell, NumberCell):
+    if isinstance(cell, NumberCell):
         return sigfig(cell.value, sigfigs=MAX_SIGNIFICANT_DIGITS, warn=False)
-    elif cell.value is None:
+    if cell.value is None:
         return ""
-    else:
-        return str(cell.value)
+    return str(cell.value)
 
 
-def print_table(args, filename):
+def print_table(args, filename) -> None:
     writer = csv.writer(sys.stdout, dialect="excel")
     for sheet in Document(filename).sheets:
         if args.sheet is not None and sheet.name not in args.sheet:
@@ -112,7 +111,7 @@ def print_table(args, filename):
                 writer.writerow(cells)
 
 
-def main():
+def main() -> None:
     parser = command_line_parser()
     args = parser.parse_args()
 
@@ -138,7 +137,7 @@ def main():
                     print_table_names(filename)
                 else:
                     print_table(args, filename)
-            except FileFormatError as e:
+            except FileFormatError as e:  # noqa: PERF203
                 print(f"{filename}:", str(e), file=sys.stderr)
                 sys.exit(1)
             except FileError as e:

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/src/numbers_parser/_csv2numbers.py

@@ -3,13 +3,14 @@
 from __future__ import annotations
 
 import argparse
+import contextlib
 import csv
 import re
 from dataclasses import dataclass
 from datetime import datetime, timezone
 from pathlib import Path
 from sys import exit, stderr
-from typing import NamedTuple, Tuple  # noqa: F401
+from typing import NamedTuple
 
 from dateutil.parser import parse
 
@@ -68,18 +69,18 @@ class Converter:
         """Parse a date string and return a datetime."""
         return parse(x, dayfirst=self.day_first).replace(tzinfo=timezone.utc)
 
-    def _transform_data(self):
+    def _transform_data(self) -> None:
         """Apply type transformations to the data based in current configuration."""
         # Convert data rows to dicts. csv.DictReader is not enough as we support CSV
         # files with no header.
         if self.no_header:
-            self.header = [x for x in range(len(self.data[0]))]
-        self.data = [{k: v for k, v in dict(zip(self.header, row)).items()} for row in self.data]
+            self.header = list(range(len(self.data[0])))
+        self.data = [dict(dict(zip(self.header, row)).items()) for row in self.data]
 
         if self.reverse:
             self.data = list(reversed(self.data))
         if self.date_columns is not None:
-            is_date_column = {x: True if x in self.date_columns else False for x in self.header}
+            is_date_column = {x: x in self.date_columns for x in self.header}
         for row in self.data:
             for k, v in row.items():
                 if self.whitespace:
@@ -88,17 +89,15 @@ class Converter:
                     row[k] = self._parse_date(v)
                 else:
                     # Attempt to coerce value into float
-                    try:
+                    with contextlib.suppress(ValueError):
                         row[k] = float(v.replace(",", ""))
-                    except ValueError:
-                        pass
 
     def rename_columns(self: Converter, mapper: dict) -> None:
         """Rename columns using column map."""
         if mapper is None:
             return
         self.no_header = False
-        self.header = [mapper[x] if x in mapper else x for x in self.header]
+        self.header = [mapper.get(x, x) for x in self.header]
 
     def delete_columns(self: Converter, columns: list) -> None:
         """Delete columns from the data."""
@@ -131,10 +130,7 @@ class Converter:
         doc = Document(num_rows=2, num_cols=2)
         table = doc.sheets[0].tables[0]
 
-        if self.no_header:
-            data = []
-        else:
-            data = [self.header]
+        data = [] if self.no_header else [self.header]
         data += [row.values() for row in self.data]
 
         for row_num, row in enumerate(data):
@@ -142,7 +138,10 @@ class Converter:
                 table.write(row_num, col_num, value)
                 if isinstance(value, datetime):
                     table.set_cell_formatting(
-                        row_num, col_num, "datetime", date_time_format="d MMM yyyy"
+                        row_num,
+                        col_num,
+                        "datetime",
+                        date_time_format="d MMM yyyy",
                     )
 
         doc.save(self.output_filename)

{numbers_parser-4.14.1 → numbers_parser-4.14.2}/src/numbers_parser/_unpack_numbers.py

@@ -64,13 +64,13 @@ class NumbersUnpacker(IWorkHandler):
             with open(target_path, "wb") as out:
                 out.write(blob)
 
-    def ensure_directory_exists(self, path: str):
+    def ensure_directory_exists(self, path: str) -> None:
         """Ensure that a path's directory exists."""
         parts = os.path.split(path)
         with contextlib.suppress(OSError):
             os.makedirs(os.path.join(*([self.output_dir, *list(parts[:-1])])))
 
-    def prettify_uuids(self, obj: object):
+    def prettify_uuids(self, obj: object) -> None:
         if isinstance(obj, dict):
             for k, v in obj.items():
                 if isinstance(v, dict):
@@ -90,7 +90,7 @@ class NumbersUnpacker(IWorkHandler):
                 elif isinstance(v, list):
                     self.prettify_uuids(v)
 
-    def prettify_cell_storage(self, obj: object):
+    def prettify_cell_storage(self, obj: object) -> None:
         if isinstance(obj, dict):
             for k, v in obj.items():
                 if isinstance(v, (dict, list)):
@@ -117,7 +117,7 @@ class NumbersUnpacker(IWorkHandler):
         return version in SUPPORTED_NUMBERS_VERSIONS
 
 
-def main():
+def main() -> None:
     parser = ArgumentParser()
     parser.add_argument("document", help="Apple Numbers file(s)", nargs="*")
     parser.add_argument("-V", "--version", action="store_true")