Skip to content

Plugins API

est_shizard.plugins #

est_shizard.plugins.TestItemContext dataclass #

TestItemContext(
    root_dir: Path,
    run_dir: Path,
    artifacts_dir: Path,
    scripts_dir: Path,
    test_function_name: str,
    test_suite_name: str,
    test_item_name: str,
    test_item_normalized_name: str,
    hash_test_item_name: str,
    test_function_context: TestFunctionContext,
    monkey_patch: MonkeyPatch,
    _env: dict | None = None,
)

artifacts_dir instance-attribute #

artifacts_dir: Path

env property writable #

env: dict | None

hash_test_item_name instance-attribute #

hash_test_item_name: str

monkey_patch instance-attribute #

monkey_patch: MonkeyPatch

root_dir instance-attribute #

root_dir: Path

run_dir instance-attribute #

run_dir: Path

scripts_dir instance-attribute #

scripts_dir: Path

test_function_context instance-attribute #

test_function_context: TestFunctionContext

test_function_name instance-attribute #

test_function_name: str

test_item_name instance-attribute #

test_item_name: str

test_item_normalized_name instance-attribute #

test_item_normalized_name: str

test_suite_name instance-attribute #

test_suite_name: str

est_shizard.plugins.RunReport dataclass #

RunReport(
    exit_code: int | None = None,
    exception: Exception | None = None,
)

exception class-attribute instance-attribute #

exception: Exception | None = None

exit_code class-attribute instance-attribute #

exit_code: int | None = None

est_shizard.plugins.get_test_item_context #

get_test_item_context(item: Item) -> TestItemContext

est_shizard.plugins.get_test_item_env #

get_test_item_env(item: Item) -> dict

est_shizard.plugins.collect_dict_from_hook_results #

collect_dict_from_hook_results(
    plugin_results: list,
) -> dict

est_shizard.plugins.is_est_shizard_test #

is_est_shizard_test(item: Item) -> bool

est_shizard.plugins.stash_keys #

est_shizard.plugins.stash_keys.TEST_ITEM_CMD_KEY module-attribute #

TEST_ITEM_CMD_KEY: StashKey[str] = StashKey[str]()

est_shizard.plugins.stash_keys.TEST_ITEM_ERROR_MSG_KEY module-attribute #

TEST_ITEM_ERROR_MSG_KEY: StashKey[str] = StashKey[str]()

est_shizard.plugins.stash_keys.TEST_ITEM_CONTEXT module-attribute #

TEST_ITEM_CONTEXT: StashKey[TestItemContext] = StashKey[
    TestItemContext
]()

est_shizard.plugins.stash_keys.TEST_ITEM_UID module-attribute #

TEST_ITEM_UID: StashKey[str] = StashKey[str]()