pyOpenVBA 5.2.1__tar.gz → 5.2.2__tar.gz

{pyopenvba-5.2.1 → pyopenvba-5.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyOpenVBA
-Version: 5.2.1
+Version: 5.2.2
 Summary: Read and write VBA macros and Excel Power Query in pure Python, no dependencies.
 Project-URL: Homepage, https://github.com/WilliamSmithEdward/pyOpenVBA
 Project-URL: Repository, https://github.com/WilliamSmithEdward/pyOpenVBA

{pyopenvba-5.2.1 → pyopenvba-5.2.2}/docs/power_query.md

@@ -221,6 +221,13 @@ wrong: **a connections part holding no connections is one Excel refuses**,
 so removing the last connection removes the part, its content type and
 its relationship as well.
 
+The hidden name has a rule of its own. **`localSheetId` is the zero-based
+position of the sheet the name belongs to** among the workbook's sheets,
+not a constant, and it has to agree with the sheet the reference names.
+Written as 0 it was right only while the table landed on the first sheet;
+anywhere else Excel refuses to open the workbook, which is invisible in a
+one-sheet file and so went unnoticed.
+
 ### Refresh control
 
 The boxes in Excel's Connection Properties dialog belong to that

{pyopenvba-5.2.1 → pyopenvba-5.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyOpenVBA"
-version = "5.2.1"
+version = "5.2.2"
 description = "Read and write VBA macros and Excel Power Query in pure Python, no dependencies."
 readme = "README.md"
 license = { text = "MIT" }

{pyopenvba-5.2.1 → pyopenvba-5.2.2}/src/pyopenvba/__init__.py

@@ -291,4 +291,4 @@ def push_power_query(
     """
     return _push_queries(src_dir, workbook, out=out, encoding=encoding, remove_missing=remove_missing)
 
-__version__ = "5.2.1"
+__version__ = "5.2.2"

{pyopenvba-5.2.1 → pyopenvba-5.2.2}/src/pyopenvba/powerquery/_sheets.py

@@ -169,13 +169,15 @@ def drop_content_type(package: OpcFile, part: str) -> None:
     )
 
 
-def sheet_part(package: OpcFile, sheet: str | int) -> tuple[str, str]:
-    """The worksheet part for a sheet name or one-based position, and the
-    name of the sheet."""
-    workbook = package.read(_WORKBOOK).decode("utf-8")
-    rels = package.read(_WORKBOOK_RELS).decode("utf-8")
-    targets = _relationship_targets(rels)
-    sheets: list[tuple[str, str]] = []
+def sheet_entries(workbook: str) -> list[tuple[str, str]]:
+    """``(name, relationship id)`` for each sheet, in the order the
+    workbook lists them.
+
+    The order is load-bearing: a ``definedName`` names the sheet it is
+    local to by its position here, so the list is the one place that
+    settles both which part a sheet is and what index it has.
+    """
+    out: list[tuple[str, str]] = []
     for element in re.findall(r"<sheet\b[^>]*>", workbook):
         attributes = _attributes(element)
         # The relationship attribute carries a namespace prefix, and which
@@ -184,7 +186,27 @@ def sheet_part(package: OpcFile, sheet: str | int) -> tuple[str, str]:
             (value for key, value in attributes.items() if key.endswith(":id")), None
         )
         if "name" in attributes and identifier:
-            sheets.append((attributes["name"], identifier))
+            out.append((attributes["name"], identifier))
+    return out
+
+
+def sheet_index(package: OpcFile, name: str) -> int:
+    """A sheet's zero-based position among the workbook's sheets."""
+    sheets = sheet_entries(package.read(_WORKBOOK).decode("utf-8"))
+    for index, (found, _identifier) in enumerate(sheets):
+        if found == name:
+            return index
+    known = ", ".join(pair[0] for pair in sheets)
+    raise PowerQueryError(f"this workbook has no sheet named {name!r}; it has: {known}")
+
+
+def sheet_part(package: OpcFile, sheet: str | int) -> tuple[str, str]:
+    """The worksheet part for a sheet name or one-based position, and the
+    name of the sheet."""
+    workbook = package.read(_WORKBOOK).decode("utf-8")
+    rels = package.read(_WORKBOOK_RELS).decode("utf-8")
+    targets = _relationship_targets(rels)
+    sheets = sheet_entries(workbook)
     if not sheets:
         raise PowerQueryError("this workbook lists no worksheets")
     if isinstance(sheet, int):
@@ -432,13 +454,22 @@ def _widen_dimension(sheet: str, reference: str) -> str:
 
 
 def _add_defined_name(package: OpcFile, sheet_name: str, number: int, reference: str) -> None:
+    """The hidden name Excel gives an external data range.
+
+    ``localSheetId`` is the zero-based position of the sheet the name
+    belongs to among the workbook's sheets, so it has to be looked up
+    rather than assumed.  Writing a constant 0 was right only while the
+    table landed on the first sheet, and named a different sheet than the
+    reference did for any other, which Excel will not open.
+    """
+    local = sheet_index(package, sheet_name)
     raw = package.read(_WORKBOOK).decode("utf-8")
     first, last = reference.split(":")
     absolute = f"${column_letter(CellRef.parse(first).column)}${CellRef.parse(first).row}"
     absolute += f":${column_letter(CellRef.parse(last).column)}${CellRef.parse(last).row}"
     quoted = f"'{sheet_name}'" if re.search(r"[^A-Za-z0-9_]", sheet_name) else sheet_name
     defined = (
-        f'<definedName name="ExternalData_{number}" localSheetId="0" hidden="1">'
+        f'<definedName name="ExternalData_{number}" localSheetId="{local}" hidden="1">'
         f"{quoted}!{absolute}</definedName>"
     )
     empty = re.search(r"<definedNames\s*/>", raw)