selfie_lib.SnapshotSystem.SnapshotSystem Class Reference

Inheritance diagram for selfie_lib.SnapshotSystem.SnapshotSystem:

Public Member Functions
FS	fs (self)
"Mode"	mode (self)
SnapshotFileLayout	layout (self)
bool	source_file_has_writable_comment (self, CallStack call)
None	write_inline (self, LiteralValue literal_value, CallStack call)
None	write_to_be_file (self, TypedPath path, ByteString data, CallStack call)
DiskStorage	disk_thread_local (self)

Detailed Description

Definition at line 30 of file SnapshotSystem.py.

Member Function Documentation

disk_thread_local()

DiskStorage selfie_lib.SnapshotSystem.SnapshotSystem.disk_thread_local

(

self

)

Returns the DiskStorage for the test associated with this thread, else error.

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 67 of file SnapshotSystem.py.

    def disk_thread_local(self) -> DiskStorage:
        """
        Returns the DiskStorage for the test associated with this thread, else error.
        """
        ...
 
 

fs()

FS selfie_lib.SnapshotSystem.SnapshotSystem.fs

(

self

)

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 33 of file SnapshotSystem.py.

    def fs(self) -> FS: ...
 

layout()

SnapshotFileLayout selfie_lib.SnapshotSystem.SnapshotSystem.layout

(

self

)

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 41 of file SnapshotSystem.py.

    def layout(self) -> SnapshotFileLayout: ...
 

mode()

"Mode" selfie_lib.SnapshotSystem.SnapshotSystem.mode

(

self

)

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 37 of file SnapshotSystem.py.

    def mode(self) -> "Mode": ...
 

source_file_has_writable_comment()

bool selfie_lib.SnapshotSystem.SnapshotSystem.source_file_has_writable_comment	(		self,
		CallStack	call
	)

Returns true if the sourcecode for the given call has a writable annotation.

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 44 of file SnapshotSystem.py.

    def source_file_has_writable_comment(self, call: CallStack) -> bool:
        """
        Returns true if the sourcecode for the given call has a writable annotation.
        """
        ...
 

write_inline()

None selfie_lib.SnapshotSystem.SnapshotSystem.write_inline	(		self,
		LiteralValue	literal_value,
		CallStack	call
	)

Indicates that the following value should be written into test sourcecode.

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 51 of file SnapshotSystem.py.

    def write_inline(self, literal_value: LiteralValue, call: CallStack) -> None:
        """
        Indicates that the following value should be written into test sourcecode.
        """
        ...
 

write_to_be_file()

None selfie_lib.SnapshotSystem.SnapshotSystem.write_to_be_file	(		self,
		TypedPath	path,
		ByteString	data,
		CallStack	call
	)

Writes the given bytes to the given file, checking for duplicate writes.

Reimplemented in pytest_selfie.plugin.PytestSnapshotSystem.

Definition at line 58 of file SnapshotSystem.py.

    ) -> None:
        """
        Writes the given bytes to the given file, checking for duplicate writes.
        """
        ...
 

---

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

• selfie-lib/selfie_lib/SnapshotSystem.py