Class Snapshot

python/database.py:121–236

``class Snapshot`` is a model of an individual database snapshot, created on save.

class Snapshot:
	"""
    ``class Snapshot`` is a model of an individual database snapshot, created on save.
    """
	def __init__(self, handle):
		self.handle = core.handle_of_type(handle, core.BNSnapshot)

	def __del__(self):
		core.BNFreeSnapshot(self.handle)

	@property
	def database(self) -> 'Database':
		"""Get the owning database (read-only)"""
		return Database(handle=core.BNGetSnapshotDatabase(self.handle))

	@property
	def id(self) -> int:
		"""Get the numerical id (read-only)"""
		return core.BNGetSnapshotId(self.handle)

	@property
	def name(self) -> str:
		"""Get the displayed snapshot name"""
		return core.BNGetSnapshotName(self.handle)

	@name.setter
	def name(self, value: str) -> None:
		"""Set the displayed snapshot name"""
		core.BNSetSnapshotName(self.handle, value)

	@property
	def is_auto_save(self) -> bool:
		"""If the snapshot was the result of an auto-save (read-only)"""
		return core.BNIsSnapshotAutoSave(self.handle)

	@property
	def has_contents(self) -> bool:
		"""If the snapshot has contents, and has not been trimmed (read-only)"""
		return core.BNSnapshotHasContents(self.handle)

	@property
	def has_undo(self) -> bool:
		"""If the snapshot has undo data (read-only)"""
		return core.BNSnapshotHasUndo(self.handle)

	@property
	def first_parent(self) -> Optional['Snapshot']:
		"""Get the first parent of the snapshot, or None if it has no parents (read-only)"""
		handle = core.BNGetSnapshotFirstParent(self.handle)
		if handle is None:
			return None
		return Snapshot(handle=handle)

	@property
	def parents(self) -> List['Snapshot']:
		"""Get a list of all parent snapshots of the snapshot (read-only)"""
		count = ctypes.c_ulonglong(0)
		parents = core.BNGetSnapshotParents(self.handle, count)