numbers-parser 4.20.0__tar.gz → 4.22.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. {numbers_parser-4.20.0/src/numbers_parser.egg-info → numbers_parser-4.22.0}/PKG-INFO +1 -1
  2. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/pyproject.toml +9 -2
  3. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/_csv2numbers.py +33 -10
  4. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/cell.py +63 -39
  5. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/constants.py +24 -20
  6. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/document.py +55 -10
  7. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/formula.py +6 -2
  8. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/model.py +206 -5
  9. {numbers_parser-4.20.0 → numbers_parser-4.22.0/src/numbers_parser.egg-info}/PKG-INFO +1 -1
  10. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser.egg-info/SOURCES.txt +3 -1
  11. numbers_parser-4.22.0/tests/test_comments.py +146 -0
  12. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_coverage.py +19 -3
  13. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_formatting.py +15 -1
  14. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_issues.py +194 -2
  15. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_styles.py +0 -32
  16. numbers_parser-4.22.0/tests/test_write_empty_cell.py +25 -0
  17. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/LICENSE.rst +0 -0
  18. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/README.md +0 -0
  19. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/setup.cfg +0 -0
  20. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/__init__.py +0 -0
  21. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/_cat_numbers.py +0 -0
  22. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/_unpack_numbers.py +0 -0
  23. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/bullets.py +0 -0
  24. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/containers.py +0 -0
  25. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/currencies.py +0 -0
  26. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/data/empty.numbers +0 -0
  27. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/exceptions.py +0 -0
  28. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/experimental.py +0 -0
  29. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TNArchives_pb2.py +0 -0
  30. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TNArchives_sos_pb2.py +0 -0
  31. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TNCommandArchives_pb2.py +0 -0
  32. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TNCommandArchives_sos_pb2.py +0 -0
  33. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSAArchives_pb2.py +0 -0
  34. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSAArchives_sos_pb2.py +0 -0
  35. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSACommandArchives_sos_pb2.py +0 -0
  36. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCEArchives_pb2.py +0 -0
  37. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCH3DArchives_pb2.py +0 -0
  38. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHArchives_Common_pb2.py +0 -0
  39. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHArchives_GEN_pb2.py +0 -0
  40. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHArchives_pb2.py +0 -0
  41. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHArchives_sos_pb2.py +0 -0
  42. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHCommandArchives_pb2.py +0 -0
  43. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCHPreUFFArchives_pb2.py +0 -0
  44. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCKArchives_pb2.py +0 -0
  45. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSCKArchives_sos_pb2.py +0 -0
  46. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSDArchives_pb2.py +0 -0
  47. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSDArchives_sos_pb2.py +0 -0
  48. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSDCommandArchives_pb2.py +0 -0
  49. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSKArchives_pb2.py +0 -0
  50. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSPArchiveMessages_pb2.py +0 -0
  51. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSPDatabaseMessages_pb2.py +0 -0
  52. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSPMessages_pb2.py +0 -0
  53. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSSArchives_pb2.py +0 -0
  54. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSSArchives_sos_pb2.py +0 -0
  55. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSTArchives_pb2.py +0 -0
  56. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSTArchives_sos_pb2.py +0 -0
  57. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSTCommandArchives_pb2.py +0 -0
  58. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSTStylePropertyArchiving_pb2.py +0 -0
  59. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSWPArchives_pb2.py +0 -0
  60. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSWPArchives_sos_pb2.py +0 -0
  61. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/TSWPCommandArchives_pb2.py +0 -0
  62. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/__init__.py +0 -0
  63. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/fontmap.py +0 -0
  64. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/functionmap.py +0 -0
  65. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/generated/mapping.py +0 -0
  66. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/iwafile.py +0 -0
  67. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/iwork.py +0 -0
  68. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/numbers_cache.py +0 -0
  69. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/numbers_uuid.py +0 -0
  70. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/roman.py +0 -0
  71. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser/xrefs.py +0 -0
  72. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser.egg-info/dependency_links.txt +0 -0
  73. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser.egg-info/entry_points.txt +0 -0
  74. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser.egg-info/requires.txt +0 -0
  75. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/src/numbers_parser.egg-info/top_level.txt +0 -0
  76. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_all_formulas.py +0 -0
  77. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_api_change.py +0 -0
  78. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_borders.py +0 -0
  79. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_bullets.py +0 -0
  80. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_cat_numbers.py +0 -0
  81. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_categories.py +0 -0
  82. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_create_cells.py +0 -0
  83. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_csv2numbers.py +0 -0
  84. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_currency.py +0 -0
  85. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_encrypted.py +0 -0
  86. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_folder.py +0 -0
  87. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_formulas.py +0 -0
  88. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_large.py +0 -0
  89. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_local_docs.py +0 -0
  90. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_memory_leaks.py +0 -0
  91. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_merges.py +0 -0
  92. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_package.py +0 -0
  93. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_properties.py +0 -0
  94. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_roman.py +0 -0
  95. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_save.py +0 -0
  96. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_slices.py +0 -0
  97. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_table_size.py +0 -0
  98. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_tables.py +0 -0
  99. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_unpack_numbers.py +0 -0
  100. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_unsupported.py +0 -0
  101. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_uuids.py +0 -0
  102. {numbers_parser-4.20.0 → numbers_parser-4.22.0}/tests/test_version.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: numbers-parser
3
- Version: 4.20.0
3
+ Version: 4.22.0
4
4
  Summary: Read and write Apple Numbers spreadsheets
5
5
  Author-email: Jon Connell <python@figsandfudge.com>
6
6
  License-Expression: MIT
@@ -24,7 +24,7 @@ classifiers = [
24
24
  description = "Read and write Apple Numbers spreadsheets"
25
25
  name = "numbers-parser"
26
26
  readme = "README.md"
27
- version = "4.20.0"
27
+ version = "4.22.0"
28
28
 
29
29
  [project.urls]
30
30
  repository = "https://github.com/masaccio/numbers-parser"
@@ -74,6 +74,13 @@ bootstrap = [
74
74
  "pyobjc-framework-Cocoa>=10.2",
75
75
  "py2app>=0.28",
76
76
  ]
77
+ visualcheck = [
78
+ "osascript>=0.0.27",
79
+ "pillow>=12.3.0",
80
+ "pixelmatch>=0.4.0",
81
+ "pymupdf>=1.28.2",
82
+ "rich>=15.0.0",
83
+ ]
77
84
 
78
85
  [build-system]
79
86
  requires = ["setuptools >= 61.0"]
@@ -107,7 +114,7 @@ addopts = "--cov=src/numbers_parser --cov-report=html --cov-report=term-missing:
107
114
 
108
115
  [tool.tox]
109
116
  requires = ["tox>=4.0"]
110
- env_list = ["py310", "py311", "py312", "py313"]
117
+ env_list = ["py310", "py311", "py312", "py313", "py314", "py315"]
111
118
 
112
119
  [tool.tox.env_run_base]
113
120
  deps = [
@@ -8,6 +8,7 @@ import csv
8
8
  import re
9
9
  import sys
10
10
  from abc import abstractmethod
11
+ from copy import copy
11
12
  from dataclasses import dataclass
12
13
  from datetime import datetime, timezone
13
14
  from pathlib import Path
@@ -15,7 +16,7 @@ from typing import NamedTuple
15
16
 
16
17
  from dateutil.parser import parse
17
18
 
18
- from numbers_parser import Document, NumbersError, _get_version
19
+ from numbers_parser import Document, NumbersError, _get_version, xl_rowcol_to_cell
19
20
 
20
21
 
21
22
  class ColumnTransform(NamedTuple):
@@ -82,7 +83,8 @@ class Converter:
82
83
  if self.reverse:
83
84
  self.data = list(reversed(self.data))
84
85
  if self.date_columns is not None:
85
- is_date_column = {x: x in self.date_columns for x in self.header}
86
+ date_columns = [self._column_key(col) for col in self.date_columns]
87
+ is_date_column = {x: x in date_columns for x in self.header}
86
88
  for row in self.data:
87
89
  for k, v in row.items():
88
90
  if self.whitespace:
@@ -94,18 +96,30 @@ class Converter:
94
96
  with contextlib.suppress(ValueError):
95
97
  row[k] = float(v.replace(",", ""))
96
98
 
99
+ def _column_key(self, column: str | int) -> str | int:
100
+ """Resolve an index against named headers; retain keys for headerless CSVs."""
101
+ header = self.header or []
102
+ if isinstance(column, int) and column not in header and 0 <= column < len(header):
103
+ return header[column]
104
+ return column
105
+
97
106
  def rename_columns(self: Converter, mapper: dict) -> None:
98
107
  """Rename columns using column map."""
99
108
  if mapper is None:
100
109
  return
110
+ mapper = {self._column_key(key): value for key, value in mapper.items()}
101
111
  self.no_header = False
102
112
  self.header = [mapper.get(x, x) for x in self.header]
113
+ self.data = [
114
+ {mapper.get(key, key): value for key, value in row.items()} for row in self.data
115
+ ]
103
116
 
104
117
  def delete_columns(self: Converter, columns: list) -> None:
105
118
  """Delete columns from the data."""
106
119
  if columns is None:
107
120
  return
108
121
 
122
+ columns = [self._column_key(col) for col in columns]
109
123
  missing_columns = list(set(columns) - set(self.header))
110
124
  if len(missing_columns) > 0:
111
125
  msg = "'" + "', '".join([str(x) for x in missing_columns]) + "'"
@@ -123,9 +137,12 @@ class Converter:
123
137
  if columns is None:
124
138
  return
125
139
  for transform in columns:
126
- transform.transform(self.header, self.data)
127
- if transform.dest not in self.header:
128
- self.header.append(transform.dest)
140
+ resolved = copy(transform)
141
+ resolved.sources = [self._column_key(source) for source in transform.sources]
142
+ resolved.dest = self._column_key(transform.dest)
143
+ resolved.transform(self.header, self.data)
144
+ if resolved.dest not in self.header:
145
+ self.header.append(resolved.dest)
129
146
 
130
147
  def save(self: Converter) -> None:
131
148
  """Write dataframe transctions to a Numbers file."""
@@ -153,6 +170,7 @@ class Transformer:
153
170
  """Base class for column transformations."""
154
171
 
155
172
  def __init__(self: Transformer, source: str, dest: str) -> None:
173
+ self.row_num = 0
156
174
  self.dest = int(dest) if dest.isnumeric() else dest
157
175
  self.sources = [int(x) if x.isnumeric() else x for x in source.split(";")]
158
176
 
@@ -168,6 +186,7 @@ class Transformer:
168
186
  msg = "'" + "', '".join([str(x) for x in missing]) + "'"
169
187
  msg += ": transform failed: column(s) do not exist in CSV"
170
188
  raise RuntimeError(msg)
189
+ self.row_num = len(header) - 1
171
190
  for row in data:
172
191
  self.transform_row(row)
173
192
 
@@ -177,11 +196,15 @@ class MergeTransformer(Transformer):
177
196
 
178
197
  def transform_row(self: MergeTransformer, row: list[str]) -> list[str]:
179
198
  """Merge data in a single row."""
180
- value = ""
181
- for col in self.sources:
182
- if row[col] and not value:
183
- value = row[col]
184
- row[self.dest] = value
199
+ value = None
200
+ for col, col_name in enumerate(self.sources):
201
+ if row[col_name] != "":
202
+ if value is not None:
203
+ ref = xl_rowcol_to_cell(self.row_num, col)
204
+ print(f"Warning: merge found multiple values for cell '{ref}'")
205
+ else:
206
+ value = row[col_name]
207
+ row[self.dest] = value if value is not None else ""
185
208
 
186
209
 
187
210
  class NegTransformer(Transformer):
@@ -83,6 +83,7 @@ __all__ = [
83
83
  "BulletedTextCell",
84
84
  "Cell",
85
85
  "CellBorder",
86
+ "Comment",
86
87
  "CustomFormatting",
87
88
  "DateCell",
88
89
  "DurationCell",
@@ -605,6 +606,16 @@ class MergeAnchor:
605
606
  self.size = size
606
607
 
607
608
 
609
+ @dataclass
610
+ class Comment:
611
+ """A comment associated with a cell."""
612
+
613
+ author: str
614
+ text: str
615
+ creation_date: datetime
616
+ replies: list[Comment] = field(default_factory=list)
617
+
618
+
608
619
  @dataclass
609
620
  class CellStorageFlags:
610
621
  _string_id: int = None
@@ -623,12 +634,11 @@ class CellStorageFlags:
623
634
  _duration_format_id: int = None
624
635
  _text_format_id: int = None
625
636
  _bool_format_id: int = None
637
+ _comment_id: int = None
626
638
  _extra_bits: int = 0
627
639
 
628
640
  def __repr__(self) -> str:
629
- fields = [
630
- f"{k[1:]}={v}" for k, v in asdict(self).items() if k.endswith("_id") and v is not None
631
- ]
641
+ fields = [f"{k[1:]}={v}" for k, v in asdict(self).items() if v is not None]
632
642
  return ", ".join([x for x in fields if x if not None])
633
643
 
634
644
  def flags(self):
@@ -844,6 +854,13 @@ class Cell(CellStorageFlags, Cacheable):
844
854
  stacklevel=2,
845
855
  )
846
856
 
857
+ @property
858
+ def comments(self) -> list[Comment]:
859
+ """Return a list of (comment, author) tuples for the cell."""
860
+ if self._comment_id is None:
861
+ return []
862
+ return self._model.table_comments(self._table_id, self._comment_id)
863
+
847
864
  @classmethod
848
865
  def _empty_cell(cls, table_id: int, row: int, col: int, model: object):
849
866
  return Cell._from_storage(table_id, row, col, EMPTY_STORAGE_BUFFER, model)
@@ -860,7 +877,9 @@ class Cell(CellStorageFlags, Cacheable):
860
877
  @classmethod
861
878
  def _from_value(cls, row: int, col: int, value):
862
879
  # TODO: write needs to retain/init the border
863
- if isinstance(value, str):
880
+ if value is None:
881
+ cell = EmptyCell(row, col)
882
+ elif isinstance(value, str):
864
883
  cell = TextCell(row, col, value)
865
884
  elif isinstance(value, bool):
866
885
  cell = BoolCell(row, col, value)
@@ -881,7 +900,7 @@ class Cell(CellStorageFlags, Cacheable):
881
900
  cell = DurationCell(row, col, value)
882
901
  else:
883
902
  msg = "Can't determine cell type from type " + type(value).__name__
884
- raise ValueError(msg) # noqa: TRY004
903
+ raise ValueError(msg)
885
904
 
886
905
  return cell
887
906
 
@@ -954,7 +973,9 @@ class Cell(CellStorageFlags, Cacheable):
954
973
  storage_flags._text_format_id, offset = unpack_int(buffer, offset)
955
974
  if flags & 0x40000:
956
975
  storage_flags._bool_format_id, offset = unpack_int(buffer, offset)
957
- # Skip 0x80000 (comment_id) and 0x100000 (import_warning_id)
976
+ if flags & 0x80000:
977
+ storage_flags._comment_id, offset = unpack_int(buffer, offset)
978
+ # Skip 0x100000 (import_warning_id)
958
979
 
959
980
  cell_type = buffer[1]
960
981
  if cell_type == TSTArchives.genericCellType:
@@ -1119,25 +1140,18 @@ class Cell(CellStorageFlags, Cacheable):
1119
1140
  )
1120
1141
  return None
1121
1142
 
1122
- # TODO: reason about these bits more as this is entirely built from a
1123
- # scikit DecisionTreeClassifier based on observations of available
1124
- # Numbers documents. A side-effect of this approach is that it
1125
- # converts Automatic cells into standard cells which feels wrong.
1126
- #
1127
- # self._extra_bits = sum(
1128
- # 1 << bit
1129
- # for value, bit in (
1130
- # (self._num_format_id, 0),
1131
- # (self._currency_format_id, 1),
1132
- # (self._duration_format_id, 2),
1133
- # (self._date_format_id, 3),
1134
- # (self._bool_format_id, 5),
1135
- # (self._text_format_id, 7),
1136
- # (self._currency_format_id, 11),
1137
- # (self._formula_id, 15),
1138
- # )
1139
- # if value is not None
1140
- # )
1143
+ for field_id, bit in (
1144
+ (self._num_format_id, 0),
1145
+ (self._currency_format_id, 1),
1146
+ (self._duration_format_id, 2),
1147
+ (self._date_format_id, 3),
1148
+ (self._bool_format_id, 5),
1149
+ (self._text_format_id, 7),
1150
+ (self._currency_format_id, 11),
1151
+ (self._formula_id, 15),
1152
+ ):
1153
+ if field_id is not None:
1154
+ self._extra_bits |= 1 << bit
1141
1155
 
1142
1156
  storage = bytearray(12)
1143
1157
  storage[0] = 5
@@ -1205,14 +1219,10 @@ class Cell(CellStorageFlags, Cacheable):
1205
1219
  flags |= 0x40000
1206
1220
  length += 4
1207
1221
  storage += pack("<i", self._bool_format_id)
1208
-
1209
- # TODO: pack extra_bits for newly created cells.
1210
- # 0x0001 - number
1211
- # 0x0002 - currency
1212
- # 0x0004 - duration
1213
- # 0x0008 - datetime
1214
- # 0x0020 - bool
1215
- # 0x0080 - string
1222
+ if self._comment_id is not None:
1223
+ flags |= 0x80000
1224
+ length += 4
1225
+ storage += pack("<i", self._comment_id)
1216
1226
 
1217
1227
  storage[8:12] = pack("<i", flags)
1218
1228
  if len(storage) < 32:
@@ -1446,6 +1456,8 @@ class Cell(CellStorageFlags, Cacheable):
1446
1456
  self._control_id = control_id
1447
1457
  elif format_type in [FormattingType.DATETIME, CustomFormattingType.DATETIME]:
1448
1458
  self._date_format_id = format_id
1459
+ elif format_type == FormattingType.DURATION:
1460
+ self._duration_format_id = format_id
1449
1461
  elif format_type in [FormattingType.TEXT, CustomFormattingType.TEXT]:
1450
1462
  self._text_format_id = format_id
1451
1463
  else:
@@ -1779,7 +1791,7 @@ def _expand_quotes(value: str) -> str:
1779
1791
  return formatted_value
1780
1792
 
1781
1793
 
1782
- def _decode_number_format( # noqa: PLR0912
1794
+ def _decode_number_format( # noqa: PLR0912, PLR0915
1783
1795
  number_format: TSKArchives.FormatStructArchive,
1784
1796
  value: float,
1785
1797
  name: str,
@@ -1865,7 +1877,10 @@ def _decode_number_format( # noqa: PLR0912
1865
1877
  dec_pad = None
1866
1878
  dec_width = num_decimals
1867
1879
 
1868
- (integer, decimal) = str(float(value)).split(".")
1880
+ value = round(float(value), num_decimals) if num_decimals > 0 else round(float(value))
1881
+
1882
+ # Custom formats have a maximum of 10 decimals
1883
+ (integer, decimal) = f"{value:.10f}".split(".")
1869
1884
  if num_decimals > 0:
1870
1885
  integer = int(integer)
1871
1886
  decimal = round(float(f"0.{decimal}"), num_decimals)
@@ -1936,10 +1951,16 @@ def _decode_number_format( # noqa: PLR0912
1936
1951
  elif dec_pad == CellPadding.SPACE and decimal == 0 and num_integers > 0:
1937
1952
  formatted_value += ".".ljust(dec_width + 1)
1938
1953
  elif dec_pad == CellPadding.SPACE:
1939
- decimal_str = str(decimal)[2:]
1954
+ if "e" in str(decimal):
1955
+ decimal_str = f"{decimal:.{num_decimals}f}"[2:]
1956
+ else:
1957
+ decimal_str = str(decimal)[2:]
1940
1958
  formatted_value += "." + decimal_str.ljust(dec_width)
1941
1959
  elif decimal or num_integers == 0:
1942
- formatted_value += "." + str(decimal)[2:]
1960
+ if "e" in str(decimal):
1961
+ formatted_value += "." + f"{decimal:.{num_decimals}f}"[2:]
1962
+ else:
1963
+ formatted_value += "." + str(decimal)[2:]
1943
1964
 
1944
1965
  formatted_value = custom_format_string.replace(format_spec, formatted_value)
1945
1966
  return sign + _expand_quotes(formatted_value)
@@ -2051,10 +2072,10 @@ def _format_base(value: float, number_format) -> str:
2051
2072
 
2052
2073
 
2053
2074
  def _format_fraction_parts_to(whole: int, numerator: int, denominator: int):
2054
- if whole > 0:
2075
+ if whole != 0:
2055
2076
  if numerator == 0:
2056
2077
  return str(whole)
2057
- return f"{whole} {numerator}/{denominator}"
2078
+ return f"{whole} {abs(numerator)}/{denominator}"
2058
2079
  if numerator == 0:
2059
2080
  return "0"
2060
2081
  if numerator == denominator:
@@ -2150,6 +2171,9 @@ class Formatting:
2150
2171
  control_format: ControlFormattingType = ControlFormattingType.NUMBER
2151
2172
  currency_code: str = "GBP"
2152
2173
  date_time_format: str = DEFAULT_DATETIME_FORMAT
2174
+ duration_style: DurationStyle = DurationStyle.COMPACT
2175
+ duration_unit_largest: DurationUnits = None
2176
+ duration_unit_smallest: DurationUnits = None
2153
2177
  decimal_places: int = None
2154
2178
  fraction_accuracy: FractionAccuracy = FractionAccuracy.THREE
2155
2179
  increment: float = 1.0
@@ -1,5 +1,5 @@
1
1
  from datetime import datetime
2
- from enum import IntEnum
2
+ from enum import IntEnum, auto
3
3
  from importlib.resources import files
4
4
  from math import ceil
5
5
 
@@ -229,28 +229,29 @@ class FormatType(IntEnum):
229
229
 
230
230
 
231
231
  class FormattingType(IntEnum):
232
- BASE = 1
233
- CURRENCY = 2
234
- DATETIME = 3
235
- FRACTION = 4
236
- NUMBER = 5
237
- PERCENTAGE = 6
238
- SCIENTIFIC = 7
239
- TICKBOX = 8
240
- RATING = 9
241
- SLIDER = 10
242
- STEPPER = 11
243
- POPUP = 12
244
- TEXT = 13
232
+ BASE = auto()
233
+ CURRENCY = auto()
234
+ DATETIME = auto()
235
+ DURATION = auto()
236
+ FRACTION = auto()
237
+ NUMBER = auto()
238
+ PERCENTAGE = auto()
239
+ SCIENTIFIC = auto()
240
+ TICKBOX = auto()
241
+ RATING = auto()
242
+ SLIDER = auto()
243
+ STEPPER = auto()
244
+ POPUP = auto()
245
+ TEXT = auto()
245
246
 
246
247
 
247
248
  class ControlFormattingType(IntEnum):
248
- BASE = 1
249
- CURRENCY = 2
250
- FRACTION = 4
251
- NUMBER = 5
252
- PERCENTAGE = 6
253
- SCIENTIFIC = 7
249
+ BASE = auto()
250
+ CURRENCY = auto()
251
+ FRACTION = auto()
252
+ NUMBER = auto()
253
+ PERCENTAGE = auto()
254
+ SCIENTIFIC = auto()
254
255
 
255
256
 
256
257
  class OwnerKind(IntEnum):
@@ -263,6 +264,7 @@ FORMATTING_ALLOWED_CELLS = {
263
264
  "base": ["NumberCell"],
264
265
  "currency": ["NumberCell"],
265
266
  "datetime": ["DateCell"],
267
+ "duration": ["DurationCell"],
266
268
  "fraction": ["NumberCell"],
267
269
  "number": ["NumberCell"],
268
270
  "percentage": ["NumberCell"],
@@ -352,6 +354,7 @@ ALLOWED_FORMATTING_PARAMETERS = {
352
354
  "use_accounting_style",
353
355
  ],
354
356
  FormattingType.DATETIME: ["date_time_format"],
357
+ FormattingType.DURATION: ["duration_style", "duration_unit_largest", "duration_unit_smallest"],
355
358
  FormattingType.FRACTION: ["fraction_accuracy"],
356
359
  FormattingType.NUMBER: [
357
360
  "decimal_places",
@@ -386,6 +389,7 @@ FORMAT_TYPE_MAP = {
386
389
  FormattingType.BASE: FormatType.BASE,
387
390
  FormattingType.CURRENCY: FormatType.CURRENCY,
388
391
  FormattingType.DATETIME: FormatType.DATE,
392
+ FormattingType.DURATION: FormatType.DURATION,
389
393
  FormattingType.FRACTION: FormatType.FRACTION,
390
394
  FormattingType.NUMBER: FormatType.DECIMAL,
391
395
  FormattingType.PERCENTAGE: FormatType.PERCENT,
@@ -17,7 +17,6 @@ from numbers_parser.cell import (
17
17
  MergedCell,
18
18
  Style,
19
19
  TextCell,
20
- UnsupportedWarning,
21
20
  )
22
21
  from numbers_parser.constants import (
23
22
  CUSTOM_FORMATTING_ALLOWED_CELLS,
@@ -79,7 +78,7 @@ class Document:
79
78
 
80
79
  """
81
80
 
82
- def __init__(
81
+ def __init__( # noqa: PLR0917
83
82
  self,
84
83
  filename: str | Path | None = None,
85
84
  sheet_name: str | None = "Sheet 1",
@@ -167,12 +166,11 @@ class Document:
167
166
  if self._model.is_a_pivot_table(table._table_id):
168
167
  table_name = self._model.table_name(table._table_id)
169
168
  warn(
170
- f"Not modifying pivot table '{table_name}'",
171
- UnsupportedWarning,
169
+ f"Pivot table '{table_name}' may be corrupted by save.",
170
+ RuntimeWarning,
172
171
  stacklevel=2,
173
172
  )
174
- else:
175
- self._model.recalculate_table_data(table._table_id, table._data)
173
+ self._model.recalculate_table_data(table._table_id, table._data)
176
174
  self._model.save(Path(filename), package, password, hint)
177
175
 
178
176
  def add_sheet(
@@ -460,7 +458,7 @@ class Sheet:
460
458
  num_header_cols,
461
459
  )
462
460
 
463
- def _add_table(
461
+ def _add_table( # noqa: PLR0917
464
462
  self,
465
463
  table_name,
466
464
  from_table_id,
@@ -1076,9 +1074,9 @@ class Table(Cacheable):
1076
1074
  The row number (zero indexed)
1077
1075
  col: int
1078
1076
  The column number (zero indexed)
1079
- value: str | int | float | bool | DateTime | Duration
1080
- The value to write to the cell. The generated cell type is automatically
1081
- created based on the type of ``value``.
1077
+ value: str | int | float | bool | DateTime | Duration | None
1078
+ The value to write to the cell, or ``None`` to clear it. The generated
1079
+ cell type is automatically created based on the type of ``value``.
1082
1080
  style: Style | str | None
1083
1081
  The name of a document custom style or a :py:class:`~numbers_parser.cell.Style` object.
1084
1082
 
@@ -1504,6 +1502,48 @@ class Table(Cacheable):
1504
1502
  for col, cell in enumerate(cells):
1505
1503
  cell._set_merge(merge_cells.get((row, col)))
1506
1504
 
1505
+ def add_comment(
1506
+ self,
1507
+ *args,
1508
+ author: str = __package__,
1509
+ reply: bool = False,
1510
+ ) -> None:
1511
+ """
1512
+ Add a comment or reply to a cell.
1513
+
1514
+ Parameters
1515
+ ----------
1516
+ *args:
1517
+ Either a cell reference (e.g., "A1") and the comment text, or
1518
+ row and column integers followed by the comment text.
1519
+ author: str, optional, default: "numbers_parser"
1520
+ The author name for the comment.
1521
+ reply: bool, optional, default: ``False``
1522
+ If ``True``, adds the comment as a reply to an existing comment thread.
1523
+
1524
+ Raises
1525
+ ------
1526
+ TypeError:
1527
+ If no comments exist and ``reply`` is ``True``, or of adding a
1528
+ comment to a cell that already has comments and ``reply`` is ``False``.
1529
+
1530
+ """
1531
+ (row, col, *args) = self._validate_cell_coords(*args)
1532
+ if len(args) == 1:
1533
+ text = args[0]
1534
+ elif len(args) > 1:
1535
+ msg = "too many positional arguments to add_comment"
1536
+ raise TypeError(msg)
1537
+ else:
1538
+ msg = "no text defined for comment"
1539
+ raise TypeError(msg)
1540
+
1541
+ if isinstance(self._data[row][col], MergedCell):
1542
+ msg = "Cannot add a comment to a merged cell; add it to the merge anchor instead"
1543
+ raise TypeError(msg)
1544
+
1545
+ self._model.add_comment_to_cell(self._table_id, row, col, text, author, reply)
1546
+
1507
1547
  def set_cell_border(self, *args) -> None:
1508
1548
  """
1509
1549
  Set the borders for a cell.
@@ -1723,6 +1763,11 @@ class Table(Cacheable):
1723
1763
  strftime-like formatting string of :ref:`Numbers date/time
1724
1764
  directives <datetime_formats>`.
1725
1765
 
1766
+ :``"duration"``:
1767
+ * **duration_style** (*:py:class:`~numbers_parser.DurationStyle`, optional, default: DurationStyle.COMPACT*) - How the duration units are rendered.
1768
+ * **duration_unit_largest** (*:py:class:`~numbers_parser.DurationUnits`, optional, default: None*) - the first and largest duration unit to display
1769
+ * **duration_unit_smallest** (*:py:class:`~numbers_parser.DurationUnits`, optional, default: None*) - the last and smallest duration unit to display
1770
+
1726
1771
  :``"fraction"``:
1727
1772
  * **fraction_accuracy** (*:py:class:`~numbers_parser.FractionAccuracy`, optional, default: FractionAccuracy.THREE* - The
1728
1773
  precision of the faction.
@@ -271,8 +271,12 @@ def number_to_str(v: int) -> str:
271
271
  v_str = repr(v)
272
272
  if "e" in v_str:
273
273
  number, exp = v_str.split("e")
274
- number = re.sub(r"[,-.]", "", number)
275
- zeroes = "0" * (abs(int(exp)) - 1)
274
+ number = re.sub(r"[,-]", "", number)
275
+ num_zeroes = abs(int(exp)) - 1
276
+ if "." in number:
277
+ num_zeroes -= len(number.split(".")[1]) - 1
278
+ number = number.replace(".", "")
279
+ zeroes = "0" * num_zeroes
276
280
  if int(exp) > 0:
277
281
  return f"{number}{zeroes}"
278
282
  return f"0.{zeroes}{number}"