pdftools_toolbox.pdf.forms.field_node_map

Classes

class pdftools_toolbox.pdf.forms.field_node_map.FieldNodeMap(handle)[source]

Bases: _NativeObject, dict

lookup(identifier_path: str | None) → FieldNode[source]

Access a form field by path

Lookup the form field node given by the identifier path.

Parameters:

identifierPath (Optional[str]) – the identifier path in which sub forms must be delimited by full stops ‘.’

Returns:

the resulting form field node.

Return type:

pdftools_toolbox.pdf.forms.field_node.FieldNode

Raises:

StateError – if the document has already been closed
pdftools_toolbox.not_found_error.NotFoundError – if no form field with this identifier exists

pop(k[, d]) → v, remove specified key and return the corresponding value.[source]: If key is not found, default is returned if given, otherwise KeyError is raised

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

update([E, ]**F) → None. Update D from dict/iterable E and F.[source]: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

setdefault(key, default=None)[source]

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.