pytest_selfie.plugin.PytestSnapshotSystem Class Reference

Inheritance diagram for pytest_selfie.plugin.PytestSnapshotSystem:

Public Member Functions
	__init__ (self, SelfieSettingsAPI settings)
	planning_to_run (self, TypedPath testfile, str testname)
	mark_path_as_written (self, TypedPath path)
	test_start (self, TypedPath testfile, str testname)
	test_failed (self, TypedPath testfile, str testname)
	test_finish (self, TypedPath testfile, str testname)
	finished_all_tests (self)
Mode	mode (self)
FS	fs (self)
SnapshotFileLayout	layout (self)
DiskStorage	disk_thread_local (self)
bool	source_file_has_writable_comment (self, CallStack call)
	write_inline (self, LiteralValue literal_value, CallStack call)
None	write_to_be_file (self, TypedPath path, "ByteString" data, CallStack call)

Public Attributes
	layout_pytest
	layout

Detailed Description

Definition at line 150 of file plugin.py.

Constructor & Destructor Documentation

__init__()

pytest_selfie.plugin.PytestSnapshotSystem.__init__	(		self,
		SelfieSettingsAPI	settings
	)

Definition at line 151 of file plugin.py.

    def __init__(self, settings: SelfieSettingsAPI):
        self.__fs = FSImplementation()
        self.__mode = settings.calc_mode()
        self.layout_pytest = PytestSnapshotFileLayout(self.__fs, settings)
        self.__comment_tracker = CommentTracker()
        self.__inline_write_tracker = InlineWriteTracker()
        self.__toBeFileWriteTracker = ToBeFileWriteTracker()
 
        self.__progress_per_file: defaultdict[TypedPath, SnapshotFileProgress] = (
            _keydefaultdict(lambda key: SnapshotFileProgress(self, key))  # type: ignore
        )  # type: ignore
        # the test which is running right now, if any
        self.__in_progress: Optional[SnapshotFileProgress] = None
        # double-checks that we don't have any tests in progress
        self.check_for_invalid_state: AtomicReference[Optional[ArraySet[TypedPath]]] = (
            AtomicReference(ArraySet.empty())
        )
 

Member Function Documentation

disk_thread_local()

DiskStorage pytest_selfie.plugin.PytestSnapshotSystem.disk_thread_local

(

self

)

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

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 236 of file plugin.py.

    def disk_thread_local(self) -> DiskStorage:
        if (
            self.__in_progress is None
            or self.__in_progress.testname_in_progress is None
        ):
            raise RuntimeError("No test in progress")
        return DiskStoragePytest(
            self.__in_progress, self.__in_progress.testname_in_progress
        )
 

finished_all_tests()

pytest_selfie.plugin.PytestSnapshotSystem.finished_all_tests

(

self

)

Definition at line 208 of file plugin.py.

    def finished_all_tests(self):
        snapshotsFilesWrittenToDisk = self.check_for_invalid_state.get_and_update(
            lambda _: None
        )
        if snapshotsFilesWrittenToDisk is None:
            raise RuntimeError("finished_all_tests() was called more than once.")
 
        if self.mode != Mode.readonly:
            if self.__inline_write_tracker.hasWrites():
                self.__inline_write_tracker.persist_writes(self.layout)
 
            for path in self.__comment_tracker.paths_with_once():
                source = SourceFile(path.name, self.fs.file_read(path))
                source.remove_selfie_once_comments()
                self.fs.file_write(path, source.as_string)
 

fs()

FS pytest_selfie.plugin.PytestSnapshotSystem.fs

(

self

)

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 229 of file plugin.py.

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

layout()

SnapshotFileLayout pytest_selfie.plugin.PytestSnapshotSystem.layout

(

self

)

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 233 of file plugin.py.

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

mark_path_as_written()

pytest_selfie.plugin.PytestSnapshotSystem.mark_path_as_written	(		self,
		TypedPath	path
	)

Definition at line 173 of file plugin.py.

    def mark_path_as_written(self, path: TypedPath):
        def update_fun(arg: Optional[ArraySet[TypedPath]]):
            if arg is None:
                raise RuntimeError(
                    "Snapshot file is being written after all tests were finished."
                )
            return arg.plusOrThis(path)
 
        self.check_for_invalid_state.update_and_get(update_fun)
 

mode()

Mode pytest_selfie.plugin.PytestSnapshotSystem.mode

(

self

)

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 225 of file plugin.py.

    def mode(self) -> Mode:
        return self.__mode
 

planning_to_run()

pytest_selfie.plugin.PytestSnapshotSystem.planning_to_run	(		self,
		TypedPath	testfile,
		str	testname
	)

Definition at line 169 of file plugin.py.

    def planning_to_run(self, testfile: TypedPath, testname: str):  # noqa: ARG002
        progress = self.__progress_per_file[testfile]
        progress.finishes_expected += 1
 

source_file_has_writable_comment()

bool pytest_selfie.plugin.PytestSnapshotSystem.source_file_has_writable_comment	(		self,
		CallStack	call
	)

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

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 246 of file plugin.py.

    def source_file_has_writable_comment(self, call: CallStack) -> bool:
        return self.__comment_tracker.hasWritableComment(call, self.layout)
 

test_failed()

pytest_selfie.plugin.PytestSnapshotSystem.test_failed	(		self,
		TypedPath	testfile,
		str	testname
	)

Definition at line 191 of file plugin.py.

    def test_failed(self, testfile: TypedPath, testname: str):
        self.__assert_inprogress(testfile)
        self.__in_progress.test_failed(testname)  # type: ignore
 

test_finish()

pytest_selfie.plugin.PytestSnapshotSystem.test_finish	(		self,
		TypedPath	testfile,
		str	testname
	)

Definition at line 195 of file plugin.py.

    def test_finish(self, testfile: TypedPath, testname: str):
        self.__assert_inprogress(testfile)
        self.__in_progress.test_finish(testname)  # type: ignore
        self.__in_progress = None
 

test_start()

pytest_selfie.plugin.PytestSnapshotSystem.test_start	(		self,
		TypedPath	testfile,
		str	testname
	)

Definition at line 183 of file plugin.py.

    def test_start(self, testfile: TypedPath, testname: str):
        if self.__in_progress:
            raise RuntimeError(
                f"Test already in progress. {self.__in_progress.test_file} is running, can't start {testfile}"
            )
        self.__in_progress = self.__progress_per_file[testfile]
        self.__in_progress.test_start(testname)
 

write_inline()

pytest_selfie.plugin.PytestSnapshotSystem.write_inline	(		self,
		LiteralValue	literal_value,
		CallStack	call
	)

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

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 249 of file plugin.py.

    def write_inline(self, literal_value: LiteralValue, call: CallStack):
        self.__inline_write_tracker.record(literal_value, call, self.layout)
 

write_to_be_file()

None pytest_selfie.plugin.PytestSnapshotSystem.write_to_be_file	(		self,
		TypedPath	path,
		"ByteString"	data,
		CallStack	call
	)

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

Reimplemented from selfie_lib.SnapshotSystem.SnapshotSystem.

Definition at line 252 of file plugin.py.

    ) -> None:
        # Directly write to disk using ToBeFileWriteTracker
        self.__toBeFileWriteTracker.writeToDisk(
            path, bytes(data), call, self.layout_pytest
        )
 
 

Member Data Documentation

layout

pytest_selfie.plugin.PytestSnapshotSystem.layout

Definition at line 217 of file plugin.py.

layout_pytest

pytest_selfie.plugin.PytestSnapshotSystem.layout_pytest

Definition at line 154 of file plugin.py.

---

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

• pytest-selfie/pytest_selfie/plugin.py