config

TmuxConfig(request=None, pytestconfig=None, tmpdir_factory=None, server_cfg_fixture=None, session_cfg_fixture=None, assertion_cfg_fixture=None)

Bases: Mapping[str, str]

Create a config instance.

Parameters:

Name	Type	Description	Default
request	Optional[pytest.FixtureRequest]	a pytest request fixture object	None
pytestconfig	Optional[pytest.Config]	a pytest pytestconfig fixture object	None
tmpdir_factory	Optional[pytest.TempdirFactory]	a pytest tmpdir_factory fixture object	None
server_cfg_fixture	Optional[Dict[str, Union[str, int]]]	a server config dictionary	None
session_cfg_fixture	Optional[Dict[str, Union[str, int]]]	a session config dictionary	None
assertion_cfg_fixture	Optional[Dict[str, Union[str, int]]]	a assertion config dictionary	None

Attributes:

Name	Type	Description
server		a TmuxConfigServer instance
session		a TmuxConfigSession instance
assertion		a TmuxConfigAssert instance
plugin		a TmuxConfigPlugin instance

Source code in pytest_tmux/config.py

def __init__(
    self,
    request: Optional[pytest.FixtureRequest] = None,
    pytestconfig: Optional[pytest.Config] = None,
    tmpdir_factory: Optional[pytest.TempdirFactory] = None,
    server_cfg_fixture: Optional[Dict[str, Union[str, int]]] = None,
    session_cfg_fixture: Optional[Dict[str, Union[str, int]]] = None,
    assertion_cfg_fixture: Optional[Dict[str, Union[str, int]]] = None,
) -> None:
    super().__setattr__("_config", {})
    super().__setattr__("_request", request)
    super().__setattr__("_tmpdir_factory", tmpdir_factory)
    super().__setattr__("_pytestconfig", pytestconfig)
    super().__setattr__("_server_cfg_fixture", server_cfg_fixture)
    super().__setattr__("_session_cfg_fixture", session_cfg_fixture)
    super().__setattr__("_assertion_cfg_fixture", assertion_cfg_fixture)
    self._default()

TmuxConfigAssert

Bases: TmuxConfig

Display config value by loading settings from

• default
• tmux_assertion_config fixture
• tmux_assertion_cfg marker
• tmux.config.assertion.[attribute] set in tests
• env
• cmd args

Parameters:

Name	Type	Description	Default
request		a pytest request fixture object	required
pytestconfig		a pytest pytestconfig fixture object	required
assertion_cfg_fixture		a assertion config dictionary	required

Attributes:

Name	Type	Description
**attrs		All args accepted by : pytest_tmux.client.TmuxClient.screen pytest_tmux.client.TmuxClient.row

TmuxConfigPlugin

Bases: TmuxConfig

Display config value by loading settings from

• default
• tmux.config.plugin.[attribute] set in tests
• env
• cmd args

Parameters:

Name	Type	Description	Default
request		a pytest request fixture object	required
pytestconfig		a pytest pytestconfig fixture object	required

Attributes:

Name	Type	Description
debug	bool	pytest-tmux debug setting

TmuxConfigServer

Bases: TmuxConfig

Display config value by loading settings from

• default
• tmux_server_config fixture
• env
• cmd args

Parameters:

Name	Type	Description	Default
request		a pytest request fixture object	required
pytestconfig		a pytest pytestconfig fixture object	required
tmpdir_factory		a pytest tmpdir_factory fixture object	required
server_cfg_fixture		a server config dictionary	required
session_cfg_fixture		a session config dictionary	required
assertion_cfg_fixture		a assertion config dictionary	required

Attributes:

Name	Type	Description
**args		All args accepted by libtmux.server.Server()

TmuxConfigSession

Bases: TmuxConfig

Display config value by loading settings from

• default
• tmux_session_config fixture
• tmux_session_cfg marker
• tmux.config.session.[attribute] set in tests
• env
• cmd args

Parameters:

Name	Type	Description	Default
request		a pytest request fixture object	required
pytestconfig		a pytest pytestconfig fixture object	required
session_cfg_fixture		a session config dictionary	required

Attributes:

Name	Type	Description
**attrs		All args accepted by libtmux.server.Server.new_session()