Method mark

tables/file.py:2522–2566

Mark the state of the database. Creates a mark for the current state of the database. A unique (and immutable) identifier for the mark is returned. An optional name (a string) can be assigned to the mark. Both the identifier of a mark and its name can be used in :met

(self, name: str | None = None)

        self._undoEnabled = False

    def mark(self, name: str | None = None) -> int:
        """Mark the state of the database.

        Creates a mark for the current state of the database. A unique (and
        immutable) identifier for the mark is returned. An optional name (a
        string) can be assigned to the mark. Both the identifier of a mark and
        its name can be used in :meth:`File.undo` and :meth:`File.redo`
        operations. When the name has already been used for another mark,
        an UndoRedoError is raised.

        This method can only be called when the Undo/Redo mechanism has been
        enabled. Otherwise, an UndoRedoError is raised.

        """
        self._check_open()
        self._check_undo_enabled()

        if name is None:
            name = ""
        else:
            if not isinstance(name, str):
                raise TypeError(
                    "Only strings are allowed as mark names. "
                    "You passed object: '%s'" % name
                )
            if name in self._markers:
                raise UndoRedoError(
                    "Name '%s' is already used as a marker "
                    "name. Try another one." % name
                )

            # The file is going to be changed.
            self._check_writable()

            self._markers[name] = self._curmark + 1

        # Create an explicit mark
        # Insert the mark in the action log
        self._log("MARK", str(self._curmark + 1), name)
        self._curmark += 1
        self._nmarks = self._curmark + 1
        self._seqmarkers.append(self._curaction)
        # Create a group for the current mark
        self._create_mark(self._trans, self._curmark)
        return self._curmark

    def _log(self, action: str, *args) -> None:
        """Log an action.