selfie_lib.CacheSelfie.CacheSelfieBinary Class Reference

Inheritance diagram for selfie_lib.CacheSelfie.CacheSelfieBinary:

Public Member Functions
	__init__ (self, DiskStorage disk, Roundtrip[T, bytes] roundtrip, Callable[..., T] generator)
T	to_match_disk (self, str sub="")
T	to_match_disk_TODO (self, str sub="")
T	to_be_file_TODO (self, str subpath)
T	to_be_file (self, str subpath)
T	to_be_base64_TODO (self, Optional[Any] _=None)
T	to_be_base64 (self, str snapshot)

Public Attributes
	disk
	roundtrip
	generator

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

Detailed Description

Definition at line 135 of file CacheSelfie.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 136 of file CacheSelfie.py.

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

Member Function Documentation

_to_be_base64_impl()

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

protected

Definition at line 216 of file CacheSelfie.py.

    def _to_be_base64_impl(self, snapshot: Optional[str]) -> T:
        system = _selfieSystem()
        call = recordCall(False)
        writable = system.mode.can_write(snapshot is None, call, system)
 
        if writable:
            actual = self.generator()
            base64_data = base64.b64encode(self.roundtrip.serialize(actual)).decode(
                "utf-8"
            )
            literal_string_formatter = LiteralString()
            system.write_inline(
                LiteralValue(snapshot, base64_data, literal_string_formatter),
                call,
            )
            return actual
        else:
            if snapshot is None:
                raise Exception("Can't call `to_be_TODO` in read-only mode!")
            else:
                decoded_data = base64.b64decode(snapshot.encode("utf-8"))
                return self.roundtrip.parse(decoded_data)

_to_be_file_impl()

T selfie_lib.CacheSelfie.CacheSelfieBinary._to_be_file_impl (   self, str  subpath, bool  is_todo  )

protected

Definition at line 187 of file CacheSelfie.py.

    def _to_be_file_impl(self, subpath: str, is_todo: bool) -> T:
        system = _selfieSystem()
        call = recordCall(False)
        writable = system.mode.can_write(is_todo, call, system)
 
        if writable:
            actual = self.generator()
 
            if is_todo:
                system.write_inline(TodoStub.to_be_file.create_literal(), call)
 
            with open(subpath, "wb") as file:
                file.write(self.roundtrip.serialize(actual))
 
            return actual
        else:
            if is_todo:
                raise Exception("Can't call `to_be_file_TODO` in read-only mode!")
            else:
                with open(subpath, "rb") as file:
                    serialized_data = file.read()
                return self.roundtrip.parse(serialized_data)
 

_to_match_disk_impl()

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

protected

Definition at line 152 of file CacheSelfie.py.

    def _to_match_disk_impl(self, sub: str, is_todo: bool) -> T:
        system = _selfieSystem()
        call = recordCall(False)
 
        if system.mode.can_write(is_todo, call, system):
            actual = self.generator()
            serialized_data = self.roundtrip.serialize(actual)
            self.disk.write_disk(Snapshot.of(serialized_data), 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 read-only 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 binary subject with no facets, got {snapshot}"
                    )
 
                return self.roundtrip.parse(snapshot.subject.value_binary())
 

to_be_base64()

T selfie_lib.CacheSelfie.CacheSelfieBinary.to_be_base64	(		self,
		str	snapshot
	)

Definition at line 213 of file CacheSelfie.py.

    def to_be_base64(self, snapshot: str) -> T:
        return self._to_be_base64_impl(snapshot)
 

to_be_base64_TODO()

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

Definition at line 210 of file CacheSelfie.py.

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

to_be_file()

T selfie_lib.CacheSelfie.CacheSelfieBinary.to_be_file	(		self,
		str	subpath
	)

Definition at line 184 of file CacheSelfie.py.

    def to_be_file(self, subpath: str) -> T:
        return self._to_be_file_impl(subpath, False)
 

to_be_file_TODO()

T selfie_lib.CacheSelfie.CacheSelfieBinary.to_be_file_TODO	(		self,
		str	subpath
	)

Definition at line 181 of file CacheSelfie.py.

    def to_be_file_TODO(self, subpath: str) -> T:
        return self._to_be_file_impl(subpath, True)
 

to_match_disk()

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

Definition at line 146 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.CacheSelfieBinary.to_match_disk_TODO	(		self,
		str	sub = ""
	)

Definition at line 149 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.CacheSelfieBinary.disk

Definition at line 142 of file CacheSelfie.py.

generator

selfie_lib.CacheSelfie.CacheSelfieBinary.generator

Definition at line 144 of file CacheSelfie.py.

roundtrip

selfie_lib.CacheSelfie.CacheSelfieBinary.roundtrip

Definition at line 143 of file CacheSelfie.py.

---

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

• selfie-lib/selfie_lib/CacheSelfie.py