| text | expected | status |
|---|---|---|
| Guest | guest | ✓ |
| Order received | order-received | ✓ |
| Work Object | work-object | ✓ |
| do_the_thing | do-the-thing | ✓ |
| Buy / sell | buy-sell | ✓ |
| Guest #1 | guest-1 | ✓ |
| café | caf | ✓ |
| booking system | booking-system | ✓ |
| text | status |
|---|---|
| --- | ✓ |
| ✓ | |
| ✓ | |
| ### | ✓ |
| phase_name | status |
|---|---|
| given | ✓ |
| then | ✓ |
| text | status |
|---|---|
| count={obj.attr} | ✓ |
| {d[key]} | ✓ |
| {x + 1} | ✓ |
@scenario(...). Not every pytest test is a scenario — undecorated tests are tolerated but not collected.with given(...) / when(...) / then(...) block, or the root recording from a step fixture. Steps nest. Each carries a phase, text, status ('passed' by default; set to 'failed' on the step where a scenario fails, for highlighting in the report), optional error, attachments, and children.given, when, or then. A step has exactly one phase.@scenario(name, tags=[...]). Used by the report's filter UI.attach(label, content).@scenario-decorated test that also carries @pytest.mark.parametrize(...). Produces multiple scenario records during a run; pytest-given groups them.@given(text). Only @given is allowed on fixtures; @when / @then are rejected.with given(...), popped on exit. Mirrored inside a fixture recording while a fixture body is running.Glossary(), with .actor(...), .work_object(...), .verb(...) registration methods and g('foo') (declare-or-get a kindless term, optional definition=) / g['foo'] (get-only, raises on unknown) accessor forms.story('Title', [activity(...), ...]). Stories are first-class report tabs and the unit of coverage.actor + verb + work_object plus optional connective words. Constructed by activity(...).Narration dataclass bundling a flat rendered text: str with a parts: list[NarrationPart] (empty for plain-string authoring; populated when the source was a t-string or pytest_given.Template, with NarrationLiteral / NarrationValue / NarrationPlaceholder pieces). The structured form lets the templatizer and renderer treat parametrize-bound values specially without regex tricks.when action and its then outcome as two sibling steps from a single with block. Used mainly to narrate an expected raise (with when_then('the action', 'the error is raised'), pytest.raises(...)), so the action and its outcome stay distinct steps.{name} placeholders that the parameter table fills in per case. Non-first cases' structured text is discarded.tests/test_x.py::test_y[a-b]). Used as a key throughout the collector.price * 1.2).given_source_link config (preset name like vscode / github, or a raw URL template). Captured per-scenario as a SourceLocation (POSIX relpath + 1-indexed line) from pytest.Item.location. Disabled by default.FileGlossary(path) class. It parses all GFM pipe tables in the file into the same inner Glossary model; terms are accessed by name (g['Guest'], case-insensitive). Kind inference fills in term kinds post-collection from activity slot positions when no explicit kind_column is configured.DeferredTermHandle returned by the code glossary (g('foo') declare-or-get, g['foo'] get-only) and by a file glossary (g['Guest']). One handle type serves all kinds (unlike the eager Actor/Work Object/Verb handles); the kind stays None until kind inference runs.None when kindless), and an optional definition (`strbook('books') records books as a surface form of the canonical book.NarrationTermRef in step text and as ActivityTermRef inside activity prose.guest('Alice') is an instance of the Guest actor). Instances aggregate in the Glossary tab's refs block.ActivityPart = `ActivityTermRefpath(...) lets alternate activity sequences share a prefix.@scenario(story=, activities=) and the activity= kwarg on given/when/then.activity= pin, regardless of its narration.resolve_glossary_kinds) that assigns each undeclared term a kind from the slot positions it occupies across all story activities; declared kinds are verified against observed positions instead. A term used in incompatible slots (or conflicting with its declared kind) raises. A term never referenced by any activity stays kindless.kind=None — left unset when kind inference finds no story slot to infer from (a term used only in t-string steps, never in an activity). Shown in the report's Uncategorized bucket.definition is None; surfaced by a badge and filter in the Glossary view. Orthogonal to kindless.