pytest_selfie.plugin Namespace Reference

Classes
class	_keydefaultdict
class	DiskStoragePytest
class	FSImplementation
class	PytestSnapshotFileLayout
class	PytestSnapshotSystem
class	SnapshotFileProgress

Functions
None	pytest_collection_modifyitems (pytest.Session session, pytest.Config config, list[pytest.Item] items)
	pytest_sessionfinish (pytest.Session session, exitstatus)
	pytest_runtest_protocol (pytest.Item item, Optional[pytest.Item] nextitem)
	pytest_runtest_makereport (pytest.CallInfo[None] call, pytest.Item item)
	delete_file_and_parent_dir_if_empty (TypedPath snapshot_file)
ArrayMap[str, WithinTestGC]	find_test_methods_that_didnt_run (TypedPath testfile, ArrayMap[str, WithinTestGC] tests)
	pytest_addoption (parser)
	bar (request)

Function Documentation

bar()

pytest_selfie.plugin.bar

(

request

)

Definition at line 479 of file plugin.py.

def bar(request):
    return request.config.option.dest_foo

delete_file_and_parent_dir_if_empty()

pytest_selfie.plugin.delete_file_and_parent_dir_if_empty

(

TypedPath

snapshot_file

)

Definition at line 447 of file plugin.py.

def delete_file_and_parent_dir_if_empty(snapshot_file: TypedPath):
    if os.path.isfile(snapshot_file.absolute_path):
        os.remove(snapshot_file.absolute_path)
        # if the parent folder is now empty, delete it
        parent = os.path.dirname(snapshot_file.absolute_path)
        if not os.listdir(parent):
            os.rmdir(parent)
 
 

find_test_methods_that_didnt_run()

ArrayMap[str, WithinTestGC] pytest_selfie.plugin.find_test_methods_that_didnt_run	(	TypedPath	testfile,
		ArrayMap[str, WithinTestGC]	tests
	)

Definition at line 456 of file plugin.py.

) -> ArrayMap[str, WithinTestGC]:
    # Implementation of finding test methods that didn't run
    # You can replace this with your own logic based on the class_name and tests dictionary
    return ArrayMap.empty()
 
 

pytest_addoption()

pytest_selfie.plugin.pytest_addoption

(

parser

)

Definition at line 465 of file plugin.py.

def pytest_addoption(parser):
    group = parser.getgroup("selfie")
    group.addoption(
        "--foo",
        action="store",
        dest="dest_foo",
        default="2024",
        help='Set the value for the fixture "bar".',
    )
 
    parser.addini("HELLO", "Dummy pytest.ini setting")
 
 
@pytest.fixture

pytest_collection_modifyitems()

None pytest_selfie.plugin.pytest_collection_modifyitems	(	pytest.Session	session,
		pytest.Config	config,
		list[pytest.Item]	items
	)

Definition at line 98 of file plugin.py.

) -> None:
    settings = SelfieSettingsAPI(config)
    system = PytestSnapshotSystem(settings)
    session.selfie_system = system  # type: ignore
    _initSelfieSystem(system)
    for item in items:
        (file, _, testname) = item.reportinfo()
        system.planning_to_run(TypedPath.of_file(os.path.abspath(file)), testname)
 
 
@pytest.hookimpl

pytest_runtest_makereport()

pytest_selfie.plugin.pytest_runtest_makereport	(	pytest.CallInfo[None]	call,
		pytest.Item	item
	)

Definition at line 129 of file plugin.py.

def pytest_runtest_makereport(call: pytest.CallInfo[None], item: pytest.Item):
    if call.excinfo is not None and call.when in (
        "call",
        "teardown",
    ):
        system: PytestSnapshotSystem = item.session.selfie_system  # type: ignore
        (file, _, testname) = item.reportinfo()
        system.test_failed(TypedPath.of_file(os.path.abspath(file)), testname)
 
 

pytest_runtest_protocol()

pytest_selfie.plugin.pytest_runtest_protocol	(	pytest.Item	item,
		Optional[pytest.Item]	nextitem
	)

Definition at line 118 of file plugin.py.

def pytest_runtest_protocol(item: pytest.Item, nextitem: Optional[pytest.Item]):  # noqa: ARG001
    (file, _, testname) = item.reportinfo()
    testfile = TypedPath.of_file(os.path.abspath(file))
 
    system: PytestSnapshotSystem = item.session.selfie_system  # type: ignore
    system.test_start(testfile, testname)
    yield
    system.test_finish(testfile, testname)
 
 
@pytest.hookimpl

pytest_sessionfinish()

pytest_selfie.plugin.pytest_sessionfinish	(	pytest.Session	session,
			exitstatus
	)

Definition at line 111 of file plugin.py.

def pytest_sessionfinish(session: pytest.Session, exitstatus):  # noqa: ARG001
    system: PytestSnapshotSystem = session.selfie_system  # type: ignore
    system.finished_all_tests()
    _clearSelfieSystem(system)
 
 
@pytest.hookimpl(hookwrapper=True)