selfie_lib.SelfieImplementations.BinarySelfie Class Reference

Inheritance diagram for selfie_lib.SelfieImplementations.BinarySelfie:

Public Member Functions
	__init__ (self, Snapshot actual, DiskStorage disk, str only_facet)
"BinarySelfie"	to_match_disk (self, str sub="")
"BinarySelfie"	to_match_disk_TODO (self, str sub="")
bytes	to_be_base64_TODO (self, Any _=None)
bytes	to_be_base64 (self, str expected)
bytes	to_be_file_TODO (self, str subpath)
bytes	to_be_file (self, str subpath)
Public Member Functions inherited from selfie_lib.SelfieImplementations.ReprSelfie
T	to_be_TODO (self, Optional[T] _=None)
T	to_be (self, T expected)
Public Member Functions inherited from selfie_lib.SelfieImplementations.DiskSelfie
"StringFacet"	facet (self, str facet)
"StringFacet"	facets (self, *str facets)
"BinaryFacet"	facet_binary (self, str facet)

Public Attributes
	only_facet
Public Attributes inherited from selfie_lib.SelfieImplementations.ReprSelfie
	actual_before_repr
Public Attributes inherited from selfie_lib.SelfieImplementations.DiskSelfie
	actual
	disk

Protected Member Functions
bytes	_actual_bytes (self)
str	_actual_string (self)
bytes	_to_be_file_impl (self, str subpath, bool is_todo)

Detailed Description

Definition at line 176 of file SelfieImplementations.py.

Constructor & Destructor Documentation

__init__()

selfie_lib.SelfieImplementations.BinarySelfie.__init__	(		self,
		Snapshot	actual,
		DiskStorage	disk,
		str	only_facet
	)

Reimplemented from selfie_lib.SelfieImplementations.ReprSelfie.

Definition at line 177 of file SelfieImplementations.py.

    def __init__(self, actual: Snapshot, disk: DiskStorage, only_facet: str):
        super().__init__(actual.subject.value_binary(), actual, disk)
        self.only_facet = only_facet
 
        facet_value = actual.subject_or_facet_maybe(only_facet)
        if facet_value is None:
            raise ValueError(f"The facet {only_facet} was not found in the snapshot")
        elif not facet_value.is_binary:
            raise ValueError(
                f"The facet {only_facet} is a string, not a binary snapshot"
            )
 

Member Function Documentation

_actual_bytes()

bytes selfie_lib.SelfieImplementations.BinarySelfie._actual_bytes (   self )

protected

Definition at line 189 of file SelfieImplementations.py.

    def _actual_bytes(self) -> bytes:
        return self.actual.subject_or_facet(self.only_facet).value_binary()
 

_actual_string()

str selfie_lib.SelfieImplementations.BinarySelfie._actual_string (   self )

protected

Definition at line 213 of file SelfieImplementations.py.

    def _actual_string(self) -> str:
        return base64.b64encode(self._actual_bytes()).decode().replace("\r", "")
 

_to_be_file_impl()

bytes selfie_lib.SelfieImplementations.BinarySelfie._to_be_file_impl (   self, str  subpath, bool  is_todo  )

protected

Definition at line 216 of file SelfieImplementations.py.

    def _to_be_file_impl(self, subpath: str, is_todo: bool) -> bytes:
        call = recordCall(False)
        writable = _selfieSystem().mode.can_write(is_todo, call, _selfieSystem())
        actual_bytes = self._actual_bytes()
        path = _selfieSystem().layout.root_folder().resolve_file(subpath)
 
        if writable:
            if is_todo:
                _selfieSystem().write_inline(TodoStub.to_be_file.create_literal(), call)
            _selfieSystem().write_to_be_file(path, actual_bytes, call)
            return actual_bytes
        else:
            if is_todo:
                raise _selfieSystem().fs.assert_failed(
                    f"Can't call `to_be_file_TODO` in {Mode.readonly} mode!"
                )
            else:
                if not _selfieSystem().fs.file_exists(path):
                    raise _selfieSystem().fs.assert_failed(
                        _selfieSystem().mode.msg_snapshot_not_found_no_such_file(path)
                    )
                expected = _selfieSystem().fs.file_read_binary(path)
                if expected == actual_bytes:
                    return actual_bytes
                else:
                    raise _selfieSystem().fs.assert_failed(
                        message=_selfieSystem().mode.msg_snapshot_mismatch_binary(
                            expected, actual_bytes
                        ),
                        expected=expected,
                        actual=actual_bytes,
                    )
 

to_be_base64()

bytes selfie_lib.SelfieImplementations.BinarySelfie.to_be_base64	(		self,
		str	expected
	)

Reimplemented from selfie_lib.SelfieImplementations.BinaryFacet.

Definition at line 204 of file SelfieImplementations.py.

    def to_be_base64(self, expected: str) -> bytes:
        expected_bytes = base64.b64decode(expected)
        actual_bytes = self._actual_bytes()
        if actual_bytes == expected_bytes:
            return _check_src(actual_bytes)
        else:
            _to_be_didnt_match(expected, self._actual_string(), LiteralString())
            return actual_bytes
 

to_be_base64_TODO()

bytes selfie_lib.SelfieImplementations.BinarySelfie.to_be_base64_TODO	(		self,
		Any	_ = None
	)

Reimplemented from selfie_lib.SelfieImplementations.BinaryFacet.

Definition at line 200 of file SelfieImplementations.py.

    def to_be_base64_TODO(self, _: Any = None) -> bytes:
        _to_be_didnt_match(None, self._actual_string(), LiteralString())
        return self._actual_bytes()
 

to_be_file()

bytes selfie_lib.SelfieImplementations.BinarySelfie.to_be_file	(		self,
		str	subpath
	)

Reimplemented from selfie_lib.SelfieImplementations.BinaryFacet.

Definition at line 252 of file SelfieImplementations.py.

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

to_be_file_TODO()

bytes selfie_lib.SelfieImplementations.BinarySelfie.to_be_file_TODO	(		self,
		str	subpath
	)

Reimplemented from selfie_lib.SelfieImplementations.BinaryFacet.

Definition at line 249 of file SelfieImplementations.py.

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

to_match_disk()

"BinarySelfie" selfie_lib.SelfieImplementations.BinarySelfie.to_match_disk	(		self,
		str	sub = ""
	)

Reimplemented from selfie_lib.SelfieImplementations.DiskSelfie.

Definition at line 192 of file SelfieImplementations.py.

    def to_match_disk(self, sub: str = "") -> "BinarySelfie":
        super().to_match_disk(sub)
        return self
 

to_match_disk_TODO()

"BinarySelfie" selfie_lib.SelfieImplementations.BinarySelfie.to_match_disk_TODO	(		self,
		str	sub = ""
	)

Reimplemented from selfie_lib.SelfieImplementations.DiskSelfie.

Definition at line 196 of file SelfieImplementations.py.

    def to_match_disk_TODO(self, sub: str = "") -> "BinarySelfie":
        super().to_match_disk_TODO(sub)
        return self
 

Member Data Documentation

only_facet

selfie_lib.SelfieImplementations.BinarySelfie.only_facet

Definition at line 179 of file SelfieImplementations.py.

---

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

• selfie-lib/selfie_lib/SelfieImplementations.py