# Copyright (c) 2010-2024 fastpyxl
from collections import defaultdict
import re
from fastpyxl.compat import safe_string
from fastpyxl.formula import Tokenizer
from fastpyxl.typed_serialisable.base import Serialisable
from fastpyxl.typed_serialisable.fields import AliasField, Field
from fastpyxl.utils.cell import SHEETRANGE_RE
RESERVED = frozenset(["Print_Area", "Print_Titles", "Criteria",
"_FilterDatabase", "Extract", "Consolidate_Area",
"Sheet_Title"])
_names = "|".join(RESERVED)
RESERVED_REGEX = re.compile(r"^_xlnm\.(?P<name>{0})".format(_names))
[docs]
class DefinedName(Serialisable):
tagname = "definedName"
name: str | None = Field.attribute(expected_type=str, allow_none=True, default=None) # unique per workbook/worksheet
comment: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
customMenu: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
description: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
help: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
statusBar: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
localSheetId: int | None = Field.attribute(expected_type=int, allow_none=True, default=None)
hidden: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
function: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
vbProcedure: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
xlm: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
functionGroupId: int | None = Field.attribute(expected_type=int, allow_none=True, default=None)
shortcutKey: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
publishToServer: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
workbookParameter: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
attr_text: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
value = AliasField("attr_text", default=None)
def __init__(self,
name=None,
comment=None,
customMenu=None,
description=None,
help=None,
statusBar=None,
localSheetId=None,
hidden=None,
function=None,
vbProcedure=None,
xlm=None,
functionGroupId=None,
shortcutKey=None,
publishToServer=None,
workbookParameter=None,
attr_text=None
):
self.name = name
self.comment = comment
self.customMenu = customMenu
self.description = description
self.help = help
self.statusBar = statusBar
self.localSheetId = localSheetId
self.hidden = hidden
self.function = function
self.vbProcedure = vbProcedure
self.xlm = xlm
self.functionGroupId = functionGroupId
self.shortcutKey = shortcutKey
self.publishToServer = publishToServer
self.workbookParameter = workbookParameter
self.attr_text = attr_text
@property
def type(self):
tok = Tokenizer("=" + self.value)
parsed = tok.items[0]
if parsed.type == "OPERAND":
return parsed.subtype
return parsed.type
@property
def destinations(self):
if self.type == "RANGE":
tok = Tokenizer("=" + self.value)
for part in tok.items:
if part.subtype == "RANGE":
m = SHEETRANGE_RE.match(part.value)
if m is None:
continue
sheetname = m.group('notquoted') or m.group('quoted')
yield sheetname, m.group('cells')
@property
def is_reserved(self):
name = self.name
if name is None:
return None
m = RESERVED_REGEX.match(name)
if m:
return m.group("name")
@property
def is_external(self):
return re.compile(r"^\[\d+\].*").match(self.value) is not None
def __iter__(self):
for key in self.__attrs__:
if key == "attr_text":
continue
v = getattr(self, key)
if v is not None:
if v in RESERVED:
v = "_xlnm." + v
yield key, safe_string(v)
[docs]
def to_tree(self, tagname=None, idx=None, namespace=None):
node = super().to_tree(tagname=tagname, idx=idx, namespace=namespace)
if self.attr_text is not None:
text = self.attr_text
if text.startswith("'") and "'!" in text:
q = text.index("'!")
inner = text[1:q]
if " " not in inner and "," not in inner:
text = inner + "!" + text[q + 2 :]
node.text = text
return node
[docs]
class DefinedNameDict(dict):
"""
Utility class for storing defined names.
Allows access by name and separation of global and scoped names
"""
def __setitem__(self, key, value):
if not isinstance(value, DefinedName):
raise TypeError("Value must be a an instance of DefinedName")
elif value.name != key:
raise ValueError("Key must be the same as the name")
super().__setitem__(key, value)
[docs]
def add(self, value):
"""
Add names without worrying about key and name matching.
"""
self[value.name] = value
[docs]
class DefinedNameList(Serialisable):
tagname = "definedNames"
definedName: list[DefinedName] = Field.sequence(expected_type=DefinedName, default=list)
def __init__(self, definedName=()):
self.definedName = list(definedName)
[docs]
def by_sheet(self):
"""
Break names down into sheet locals and globals
"""
names = defaultdict(DefinedNameDict)
for defn in self.definedName:
if defn.localSheetId is None:
if defn.name in ("_xlnm.Print_Titles", "_xlnm.Print_Area", "_xlnm._FilterDatabase"):
continue
names["global"][defn.name] = defn
else:
sheet = int(defn.localSheetId)
names[sheet][defn.name] = defn
return names
def _duplicate(self, defn):
"""
Check for whether DefinedName with the same name and scope already
exists
"""
for d in self.definedName:
if d.name == defn.name and d.localSheetId == defn.localSheetId:
return True
def __len__(self):
return len(self.definedName)
