selfie_lib.Snapshot.Snapshot Class Reference

Public Member Functions
	__init__ (self, SnapshotValue subject, ArrayMap[str, SnapshotValue] facet_data=ArrayMap.empty())
SnapshotValue	subject (self)
ArrayMap[str, SnapshotValue]	facets (self)
bool	__eq__ (self, object other)
int	__hash__ (self)
"Snapshot"	plus_facet (self, str key, Union[bytes, str, SnapshotValue] value)
"Snapshot"	plus_or_replace (self, str key, Union[bytes, str, SnapshotValue] value)
Union[SnapshotValue, None]	subject_or_facet_maybe (self, str key)
SnapshotValue	subject_or_facet (self, str key)
Iterator[tuple[str, SnapshotValue]]	items (self)
str	__repr__ (self)

Static Public Member Functions
"Snapshot"	of (Union[bytes, str, SnapshotValue] data)
"Snapshot"	of_items (Iterator[tuple[str, SnapshotValue]] items)

Protected Attributes
	_subject
	_facet_data

Detailed Description

Definition at line 9 of file Snapshot.py.

Constructor & Destructor Documentation

__init__()

selfie_lib.Snapshot.Snapshot.__init__	(		self,
		SnapshotValue	subject,
		ArrayMap[str, SnapshotValue]	facet_data = ArrayMap.empty()
	)

Definition at line 10 of file Snapshot.py.

    ):
        self._subject = subject
        self._facet_data = facet_data
 

Member Function Documentation

__eq__()

bool selfie_lib.Snapshot.Snapshot.__eq__	(		self,
		object	other
	)

Definition at line 26 of file Snapshot.py.

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Snapshot):
            return NotImplemented
        return self._subject == other._subject and self._facet_data == other._facet_data
 

__hash__()

int selfie_lib.Snapshot.Snapshot.__hash__

(

self

)

Definition at line 31 of file Snapshot.py.

    def __hash__(self) -> int:
        return hash((self._subject, tuple(self._facet_data.items())))
 

__repr__()

str selfie_lib.Snapshot.Snapshot.__repr__

(

self

)

Definition at line 92 of file Snapshot.py.

    def __repr__(self) -> str:
        pieces = [f"Snapshot.of({self.subject.value_string()!r})"]
        for e in self.facets.items():
            pieces.append(f"\n  .plus_facet({e[0]!r}, {e[1].value_string()!r})")  # noqa: PERF401
        return "".join(pieces)

facets()

ArrayMap[str, SnapshotValue] selfie_lib.Snapshot.Snapshot.facets

(

self

)

Definition at line 23 of file Snapshot.py.

    def facets(self) -> ArrayMap[str, SnapshotValue]:
        return self._facet_data
 

items()

Iterator[tuple[str, SnapshotValue]] selfie_lib.Snapshot.Snapshot.items

(

self

)

Definition at line 88 of file Snapshot.py.

    def items(self) -> Iterator[tuple[str, SnapshotValue]]:
        yield ("", self._subject)
        yield from self._facet_data.items()
 

of()

"Snapshot" selfie_lib.Snapshot.Snapshot.of ( Union[bytes, str, SnapshotValue]  data )

static

Definition at line 67 of file Snapshot.py.

    def of(data: Union[bytes, str, SnapshotValue]) -> "Snapshot":
        if not isinstance(data, SnapshotValue):
            data = SnapshotValue.of(data)
        return Snapshot(data, ArrayMap.empty())
 

of_items()

"Snapshot" selfie_lib.Snapshot.Snapshot.of_items ( Iterator[tuple[str, SnapshotValue]]  items )

static

Definition at line 73 of file Snapshot.py.

    def of_items(items: Iterator[tuple[str, SnapshotValue]]) -> "Snapshot":
        subject = None
        facets = ArrayMap.empty()
        for entry in items:
            (key, value) = entry
            if key == "":
                if subject is not None:
                    raise ValueError(
                        "Duplicate root snapshot value.\n   first: ${subject}\n  second: ${value}"
                    )
                subject = value
            else:
                facets = facets.plus(key, value)
        return Snapshot(subject if subject else SnapshotValue.of(""), facets)
 

plus_facet()

"Snapshot" selfie_lib.Snapshot.Snapshot.plus_facet	(		self,
		str	key,
		Union[bytes, str, SnapshotValue]	value
	)

Definition at line 34 of file Snapshot.py.

    ) -> "Snapshot":
        if key == "":
            raise ValueError("The empty string is reserved for the subject.")
        return Snapshot(
            self._subject,
            self._facet_data.plus(_to_unix(key), SnapshotValue.of(value)),
        )
 

plus_or_replace()

"Snapshot" selfie_lib.Snapshot.Snapshot.plus_or_replace	(		self,
		str	key,
		Union[bytes, str, SnapshotValue]	value
	)

Definition at line 44 of file Snapshot.py.

    ) -> "Snapshot":
        if key == "":
            return Snapshot(SnapshotValue.of(value), self._facet_data)
        else:
            return Snapshot(
                self._subject,
                self._facet_data.plus_or_noop_or_replace(
                    _to_unix(key), SnapshotValue.of(value)
                ),
            )
 

subject()

SnapshotValue selfie_lib.Snapshot.Snapshot.subject

(

self

)

Definition at line 19 of file Snapshot.py.

    def subject(self) -> SnapshotValue:
        return self._subject
 

subject_or_facet()

SnapshotValue selfie_lib.Snapshot.Snapshot.subject_or_facet	(		self,
		str	key
	)

Definition at line 60 of file Snapshot.py.

    def subject_or_facet(self, key: str) -> SnapshotValue:
        value = self.subject_or_facet_maybe(key)
        if value is None:
            raise KeyError(f"'{key}' not found in snapshot.")
        return value
 

subject_or_facet_maybe()

Union[SnapshotValue, None] selfie_lib.Snapshot.Snapshot.subject_or_facet_maybe	(		self,
		str	key
	)

Definition at line 57 of file Snapshot.py.

    def subject_or_facet_maybe(self, key: str) -> Union[SnapshotValue, None]:
        return self._subject if key == "" else self._facet_data.get(key)
 

Member Data Documentation

_facet_data

selfie_lib.Snapshot.Snapshot._facet_data

protected

Definition at line 16 of file Snapshot.py.

_subject

selfie_lib.Snapshot.Snapshot._subject

protected

Definition at line 15 of file Snapshot.py.

---

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

• selfie-lib/selfie_lib/Snapshot.py