selfie_lib.SnapshotFile.SnapshotFile Class Reference

Public Member Functions
	__init__ (self)
	serialize (self, list[str] valueWriter)
None	set_at_test_time (self, str key, Snapshot snapshot)
None	remove_all_indices (self, list[int] indices)
"SnapshotFile"	parse (cls, SnapshotValueReader value_reader)
"SnapshotFile"	create_empty_with_unix_newlines (cls, bool unix_newlines)

Static Public Member Functions
	writeEntry (list[str] valueWriter, str key, Optional[str] facet, SnapshotValue value)

Public Attributes
bool	unix_newlines = True
Optional[tuple[str, str]]	metadata = None
ArrayMap[str, Snapshot]	snapshots = ArrayMap.empty()
bool	was_set_at_test_time = False

Static Public Attributes
str	HEADER_PREFIX = "📷 "
str	END_OF_FILE = "[end of file]"

Protected Attributes
Lock	_lock = Lock()

Detailed Description

Definition at line 11 of file SnapshotFile.py.

Constructor & Destructor Documentation

__init__()

selfie_lib.SnapshotFile.SnapshotFile.__init__

(

self

)

Definition at line 15 of file SnapshotFile.py.

    def __init__(self):
        self.unix_newlines: bool = True
        self.metadata: Optional[tuple[str, str]] = None
        self.snapshots: ArrayMap[str, Snapshot] = ArrayMap.empty()
        self._lock: Lock = Lock()
        self.was_set_at_test_time: bool = False
 

Member Function Documentation

create_empty_with_unix_newlines()

"SnapshotFile" selfie_lib.SnapshotFile.SnapshotFile.create_empty_with_unix_newlines	(		cls,
		bool	unix_newlines )

Definition at line 105 of file SnapshotFile.py.

    def create_empty_with_unix_newlines(cls, unix_newlines: bool) -> "SnapshotFile":
        result = cls()
        result.unix_newlines = unix_newlines
        return result

parse()

"SnapshotFile" selfie_lib.SnapshotFile.SnapshotFile.parse	(		cls,
		SnapshotValueReader	value_reader )

Definition at line 81 of file SnapshotFile.py.

    def parse(cls, value_reader: SnapshotValueReader) -> "SnapshotFile":
        result = cls()
        result.unix_newlines = value_reader.unix_newlines
        reader = SnapshotReader(value_reader)
 
        peek_key = reader.peek_key()
        if peek_key and peek_key.startswith(cls.HEADER_PREFIX):
            metadata_name = peek_key[len(cls.HEADER_PREFIX) :]
            metadata_value = value_reader.next_value().value_string()
            result.metadata = (metadata_name, metadata_value)
            reader.next_snapshot()
 
        while True:
            peek_key = reader.peek_key()
            if peek_key is None or peek_key == cls.END_OF_FILE:
                break
            if peek_key.startswith(cls.HEADER_PREFIX):
                continue
            next_snapshot = reader.next_snapshot()
            result.snapshots = result.snapshots.plus(peek_key, next_snapshot)
 
        return result
 

remove_all_indices()

None selfie_lib.SnapshotFile.SnapshotFile.remove_all_indices	(		self,
		list[int]	indices )

Definition at line 73 of file SnapshotFile.py.

    def remove_all_indices(self, indices: list[int]) -> None:
        with self._lock:
            if not indices:
                return
            self.snapshots = self.snapshots.minus_sorted_indices(indices)
            self.was_set_at_test_time = True
 

serialize()

selfie_lib.SnapshotFile.SnapshotFile.serialize	(		self,
		list[str]	valueWriter )

Definition at line 22 of file SnapshotFile.py.

    def serialize(self, valueWriter: list[str]):
        if self.metadata is not None:
            self.writeEntry(
                valueWriter,
                f"📷 {self.metadata[0]}",
                None,
                SnapshotValue.of(self.metadata[1]),
            )
 
        for entry_key, entry_value in self.snapshots.items():
            self.writeEntry(valueWriter, entry_key, None, entry_value.subject)
            for facet_key, facet_value in entry_value.facets.items():
                self.writeEntry(valueWriter, entry_key, facet_key, facet_value)
 
        self.writeEntry(valueWriter, "", "end of file", SnapshotValue.of(""))
 

set_at_test_time()

None selfie_lib.SnapshotFile.SnapshotFile.set_at_test_time	(		self,
		str	key,
		Snapshot	snapshot )

Definition at line 68 of file SnapshotFile.py.

    def set_at_test_time(self, key: str, snapshot: Snapshot) -> None:
        with self._lock:
            self.snapshots = self.snapshots.plus_or_noop_or_replace(key, snapshot)
            self.was_set_at_test_time = True
 

writeEntry()

selfie_lib.SnapshotFile.SnapshotFile.writeEntry ( list[str] valueWriter, str key, Optional[str] facet, SnapshotValue value )

static

Definition at line 39 of file SnapshotFile.py.

    ):
        valueWriter.append("╔═ ")
        valueWriter.append(SnapshotValueReader.name_esc.escape(key))
        if facet is not None:
            valueWriter.append("[")
            valueWriter.append(SnapshotValueReader.name_esc.escape(facet))
            valueWriter.append("]")
        valueWriter.append(" ═╗")
        if value.is_binary:
            valueWriter.append(" base64 length ")
            valueWriter.append(str(len(value.value_binary())))
            valueWriter.append(" bytes")
        valueWriter.append("\n")
 
        if not key and facet == "end of file":
            return
 
        if value.is_binary:
            escaped = base64.b64encode(value.value_binary()).decode("utf-8")
            valueWriter.append(escaped.replace("\r", ""))
        else:
            escaped = SnapshotValueReader.body_esc.escape(value.value_string()).replace(
                "\n╔", "\n\ud801\udf41"
            )
            valueWriter.append(escaped)
        valueWriter.append("\n")
 

Member Data Documentation

_lock

Lock selfie_lib.SnapshotFile.SnapshotFile._lock = Lock()

protected

Definition at line 19 of file SnapshotFile.py.

END_OF_FILE

str selfie_lib.SnapshotFile.SnapshotFile.END_OF_FILE = "[end of file]"

static

Definition at line 13 of file SnapshotFile.py.

HEADER_PREFIX

selfie_lib.SnapshotFile.SnapshotFile.HEADER_PREFIX = "📷 "

static

Definition at line 12 of file SnapshotFile.py.

metadata

Optional[tuple[str, str]] selfie_lib.SnapshotFile.SnapshotFile.metadata = None

Definition at line 17 of file SnapshotFile.py.

snapshots

ArrayMap[str, Snapshot] selfie_lib.SnapshotFile.SnapshotFile.snapshots = ArrayMap.empty()

Definition at line 18 of file SnapshotFile.py.

unix_newlines

bool selfie_lib.SnapshotFile.SnapshotFile.unix_newlines = True

Definition at line 16 of file SnapshotFile.py.

was_set_at_test_time

bool selfie_lib.SnapshotFile.SnapshotFile.was_set_at_test_time = False

Definition at line 20 of file SnapshotFile.py.

---

The documentation for this class was generated from the following file:

• selfie-lib/selfie_lib/SnapshotFile.py