API Reference¶

typed_wrap¶

from behave_data import typed_wrap

typed_wrap(table, config=None)

Wraps a Behave Table in TypedTableWrapper.

Returns a TypedTableWrapper.

from behave_data import raw_table

raw_table(table)

Wraps a table in RawTable for header-included access.

from behave_data import TypedTableWrapper

wrapper = TypedTableWrapper(table, config)

Methods:

from behave_data import DataManager, Config

dm = DataManager(Config())

dm.fixture(name, **overrides)

Get fixture data with optional overrides.

dm.build(name, count=1, overrides=None)

Build data. Returns a list if count > 1, otherwise a single dict.

dm.resolve(value)

Resolve a placeholder string. Non-string values pass through.

dm.mask(value)

Return "***" if value is a resolved secret, else original value.

from behave_data import FixtureRegistry, data_fixture

registry = FixtureRegistry()
registry.register("user", lambda: {"name": "Alice"})

@data_fixture(name, scope="scenario", params=None) decorator registers a fixture in the global registry.

from behave_data import BuilderRegistry, data_builder

registry = BuilderRegistry()
registry.register("product", lambda o: {"name": "Widget", **o})

@data_builder(name) decorator registers a builder.

from behave_data import Config

config = Config()
config = Config.from_file("behave_data.yml")

from behave_data import diff

diff(expected, actual, ordered=True, ignore_columns=None, surplus_columns=True)

Raises TableDiffError if tables differ.

from behave_data import resolve_placeholder

resolve_placeholder(value, config, manager=None)

Resolve env:, file:, secret:, ref: placeholders.

from behave_data import register_type

register_type("upper", lambda v: v.upper())

from behave_data import (
    setup_data,
    before_feature_hook,
    before_scenario_hook,
    before_step_hook,
    after_scenario_hook,
)