Public Member Functions
	__init__ (self, PytestSnapshotSystem system, TypedPath test_file)
	assert_not_terminated (self)
	test_start (self, str testname)
	test_failed (self, str testname)
	test_finish (self, str testname)
	keep (self, str test, Optional[str] suffix_or_all)
	write (self, str test, str suffix, Snapshot snapshot, CallStack call_stack, SnapshotFileLayout layout)
Optional[Snapshot]	read (self, str test, str suffix)
SnapshotFile	read_file (self)

Public Attributes
	system = system
	test_file = test_file
int	finishes_expected = 0
int	finishes_so_far = 0
bool	has_failed = False
Optional[SnapshotFile]	file = None
AtomicReference[ArrayMap[str, WithinTestGC]]	tests
Optional[DiskWriteTracker]	disk_write_tracker = DiskWriteTracker()
Optional[str]	testname_in_progress = None
bool	testname_in_progress_failed = False

Static Public Attributes
	TERMINATED = ArrayMap.empty().plus(" ~ / f!n1shed / ~ ", WithinTestGC())

Detailed Description

Definition at line 287 of file plugin.py.

Constructor & Destructor Documentation

◆ init()

pytest_selfie.plugin.SnapshotFileProgress.__init__	(		self,
		PytestSnapshotSystem	system,
		TypedPath	test_file )

Definition at line 290 of file plugin.py.

    def __init__(self, system: PytestSnapshotSystem, test_file: TypedPath):
        self.system = system
        # the test file which holds the test case which we are the snapshot file for
        self.test_file = test_file
 
        # before the tests run, we find out how many we expect to happen
        self.finishes_expected = 0
        # while the tests run, we count up until they have all run, and then we can cleanup
        self.finishes_so_far = 0
        # have any tests failed?
        self.has_failed = False
 
        # lazy-loaded snapshot file
        self.file: Optional[SnapshotFile] = None
        self.tests: AtomicReference[ArrayMap[str, WithinTestGC]] = AtomicReference(
            ArrayMap.empty()
        )
        self.disk_write_tracker: Optional[DiskWriteTracker] = DiskWriteTracker()
        # the test name which is currently in progress, if any
        self.testname_in_progress: Optional[str] = None
        self.testname_in_progress_failed = False
 

Member Function Documentation

◆ assert_not_terminated()

pytest_selfie.plugin.SnapshotFileProgress.assert_not_terminated ( self )

Definition at line 312 of file plugin.py.

    def assert_not_terminated(self):
        if self.tests.get() == SnapshotFileProgress.TERMINATED:
            raise RuntimeError(
                "Cannot call methods on a terminated SnapshotFileProgress"
            )
 

◆ keep()

pytest_selfie.plugin.SnapshotFileProgress.keep	(		self,
		str	test,
		Optional[str]	suffix_or_all )

Definition at line 401 of file plugin.py.

    def keep(self, test: str, suffix_or_all: Optional[str]):
        self.assert_not_terminated()
        if suffix_or_all is None:
            self.tests.get()[test].keep_all()
        else:
            self.tests.get()[test].keep_suffix(suffix_or_all)
 

◆ read()

Optional[Snapshot] pytest_selfie.plugin.SnapshotFileProgress.read	(		self,
		str	test,
		str	suffix )

Definition at line 422 of file plugin.py.

    def read(self, test: str, suffix: str) -> Optional[Snapshot]:
        self.assert_not_terminated()
        snapshot = self.read_file().snapshots.get(f"{test}{suffix}")
        if snapshot is not None:
            self.tests.get()[test].keep_suffix(suffix)
        return snapshot
 

◆ read_file()

SnapshotFile pytest_selfie.plugin.SnapshotFileProgress.read_file ( self )

Definition at line 429 of file plugin.py.

    def read_file(self) -> SnapshotFile:
        if self.file is None:
            snapshot_path = self.system.layout_pytest.snapshotfile_for_testfile(
                self.test_file
            )
            if os.path.exists(snapshot_path.absolute_path) and os.path.isfile(
                snapshot_path.absolute_path
            ):
                with open(snapshot_path.absolute_path, "rb") as f:
                    content = f.read()
                self.file = SnapshotFile.parse(SnapshotValueReader.of_binary(content))
            else:
                self.file = SnapshotFile.create_empty_with_unix_newlines(
                    self.system.layout_pytest.unix_newlines
                )
        return self.file
 
 

◆ test_failed()

pytest_selfie.plugin.SnapshotFileProgress.test_failed	(		self,
		str	testname )

Definition at line 329 of file plugin.py.

    def test_failed(self, testname: str):
        self.__assert_in_progress(testname)
        self.has_failed = True
        self.tests.get()[testname].keep_all()
 

◆ test_finish()

pytest_selfie.plugin.SnapshotFileProgress.test_finish	(		self,
		str	testname )

Definition at line 334 of file plugin.py.

    def test_finish(self, testname: str):
        self.__assert_in_progress(testname)
        self.finishes_so_far += 1
        self.testname_in_progress = None
        if self.finishes_so_far == self.finishes_expected:
            self.__all_tests_finished()
 

◆ test_start()

pytest_selfie.plugin.SnapshotFileProgress.test_start	(		self,
		str	testname )

Definition at line 318 of file plugin.py.

    def test_start(self, testname: str):
        if "/" in testname:
            raise ValueError(f"Test name cannot contain '/', was {testname}")
        self.assert_not_terminated()
        if self.testname_in_progress is not None:
            raise RuntimeError(
                f"Cannot start a new test {testname}, {self.testname_in_progress} is already in progress"
            )
        self.testname_in_progress = testname
        self.tests.update_and_get(lambda it: it.plus_or_noop(testname, WithinTestGC()))
 

◆ write()

pytest_selfie.plugin.SnapshotFileProgress.write	(		self,
		str	test,
		str	suffix,
		Snapshot	snapshot,
		CallStack	call_stack,
		SnapshotFileLayout	layout )

Definition at line 408 of file plugin.py.

    ):
        self.assert_not_terminated()
        key = f"{test}{suffix}"
        self.disk_write_tracker.record(key, snapshot, call_stack, layout)  # type: ignore
        self.tests.get()[test].keep_suffix(suffix)
        self.read_file().set_at_test_time(key, snapshot)
 

Member Data Documentation

◆ disk_write_tracker

Optional[DiskWriteTracker] pytest_selfie.plugin.SnapshotFileProgress.disk_write_tracker = DiskWriteTracker()

Definition at line 307 of file plugin.py.

◆ file

Optional[SnapshotFile] pytest_selfie.plugin.SnapshotFileProgress.file = None

Definition at line 303 of file plugin.py.

◆ finishes_expected

int pytest_selfie.plugin.SnapshotFileProgress.finishes_expected = 0

Definition at line 296 of file plugin.py.

◆ finishes_so_far

int pytest_selfie.plugin.SnapshotFileProgress.finishes_so_far = 0

Definition at line 298 of file plugin.py.

◆ has_failed

bool pytest_selfie.plugin.SnapshotFileProgress.has_failed = False

Definition at line 300 of file plugin.py.

◆ system

pytest_selfie.plugin.SnapshotFileProgress.system = system

Definition at line 291 of file plugin.py.

◆ TERMINATED

pytest_selfie.plugin.SnapshotFileProgress.TERMINATED = ArrayMap.empty().plus(" ~ / f!n1shed / ~ ", WithinTestGC())

static

Definition at line 288 of file plugin.py.

◆ test_file

pytest_selfie.plugin.SnapshotFileProgress.test_file = test_file

Definition at line 293 of file plugin.py.

◆ testname_in_progress

Optional[str] pytest_selfie.plugin.SnapshotFileProgress.testname_in_progress = None

Definition at line 309 of file plugin.py.

◆ testname_in_progress_failed

bool pytest_selfie.plugin.SnapshotFileProgress.testname_in_progress_failed = False

Definition at line 310 of file plugin.py.

◆ tests

AtomicReference[ArrayMap[str, WithinTestGC]] pytest_selfie.plugin.SnapshotFileProgress.tests

Initial value:

=  AtomicReference(
            ArrayMap.empty()
        )

Definition at line 304 of file plugin.py.

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

pytest-selfie/pytest_selfie/plugin.py

Public Member Functions

Public Attributes

Static Public Attributes