selfie_lib.CacheSelfie.CacheSelfie Class Reference

Inheritance diagram for selfie_lib.CacheSelfie.CacheSelfie:

Public Member Functions
	__init__ (self, DiskStorage disk, Roundtrip[T, str] roundtrip, Callable[..., T] generator)
T	to_match_disk (self, str sub="")
T	to_match_disk_TODO (self, str sub="")
T	to_be_TODO (self, Optional[Any] _=None)
T	to_be (self, str expected)

Public Attributes
	disk
	roundtrip
	generator

Protected Member Functions
T	_to_match_disk_impl (self, str sub, bool is_todo)
T	_to_be_impl (self, Optional[str] snapshot)

Detailed Description

Definition at line 67 of file CacheSelfie.py.

Constructor & Destructor Documentation

__init__()

selfie_lib.CacheSelfie.CacheSelfie.__init__	(		self,
		DiskStorage	disk,
		Roundtrip[T, str]	roundtrip,
		Callable[..., T]	generator
	)

Definition at line 68 of file CacheSelfie.py.

    ):
        self.disk = disk
        self.roundtrip = roundtrip
        self.generator = generator
 

Member Function Documentation

_to_be_impl()

T selfie_lib.CacheSelfie.CacheSelfie._to_be_impl (   self, Optional[str]  snapshot  )

protected

Definition at line 114 of file CacheSelfie.py.

    def _to_be_impl(self, snapshot: Optional[str]) -> T:
        call = recordCall(False)
        system = _selfieSystem()
        writable = system.mode.can_write(snapshot is None, call, system)
        if writable:
            actual = self.generator()
            literal_string_formatter = LiteralString()
            system.write_inline(
                LiteralValue(
                    snapshot, self.roundtrip.serialize(actual), literal_string_formatter
                ),
                call,
            )
            return actual
        else:
            if snapshot is None:
                raise Exception("Can't call `to_be_todo` in readonly mode!")
            else:
                return self.roundtrip.parse(snapshot)
 
 

_to_match_disk_impl()

T selfie_lib.CacheSelfie.CacheSelfie._to_match_disk_impl (   self, str  sub, bool  is_todo  )

protected

Definition at line 84 of file CacheSelfie.py.

    def _to_match_disk_impl(self, sub: str, is_todo: bool) -> T:
        call = recordCall(False)
        system = _selfieSystem()
        if system.mode.can_write(is_todo, call, system):
            actual = self.generator()
            self.disk.write_disk(
                Snapshot.of(self.roundtrip.serialize(actual)), sub, call
            )
            if is_todo:
                system.write_inline(TodoStub.to_match_disk.create_literal(), call)
            return actual
        else:
            if is_todo:
                raise Exception("Can't call `to_match_disk_todo` in readonly mode!")
            else:
                snapshot = self.disk.read_disk(sub, call)
                if snapshot is None:
                    raise Exception(system.mode.msg_snapshot_not_found())
                if snapshot.subject.is_binary or len(snapshot.facets) > 0:
                    raise Exception(
                        f"Expected a string subject with no facets, got {snapshot}"
                    )
                return self.roundtrip.parse(snapshot.subject.value_string())
 

to_be()

T selfie_lib.CacheSelfie.CacheSelfie.to_be	(		self,
		str	expected
	)

Definition at line 111 of file CacheSelfie.py.

    def to_be(self, expected: str) -> T:
        return self._to_be_impl(expected)
 

to_be_TODO()

T selfie_lib.CacheSelfie.CacheSelfie.to_be_TODO	(		self,
		Optional[Any]	_ = None
	)

Definition at line 108 of file CacheSelfie.py.

    def to_be_TODO(self, _: Optional[Any] = None) -> T:
        return self._to_be_impl(None)
 

to_match_disk()

T selfie_lib.CacheSelfie.CacheSelfie.to_match_disk	(		self,
		str	sub = ""
	)

Definition at line 78 of file CacheSelfie.py.

    def to_match_disk(self, sub: str = "") -> T:
        return self._to_match_disk_impl(sub, False)
 

to_match_disk_TODO()

T selfie_lib.CacheSelfie.CacheSelfie.to_match_disk_TODO	(		self,
		str	sub = ""
	)

Definition at line 81 of file CacheSelfie.py.

    def to_match_disk_TODO(self, sub: str = "") -> T:
        return self._to_match_disk_impl(sub, True)
 

Member Data Documentation

disk

selfie_lib.CacheSelfie.CacheSelfie.disk

Definition at line 74 of file CacheSelfie.py.

generator

selfie_lib.CacheSelfie.CacheSelfie.generator

Definition at line 76 of file CacheSelfie.py.

roundtrip

selfie_lib.CacheSelfie.CacheSelfie.roundtrip

Definition at line 75 of file CacheSelfie.py.

---

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

• selfie-lib/selfie_lib/CacheSelfie.py