endplay.interact.actions

The actions which can be applied to a CommandObject.

Classes:

`Action`()
`DealAction`(pbn)
`GetHandAction`(player)
`PlayAction`(card)
`SetBoardAction`(board_no)
`SetFirstAction`(first)
`SetHandAction`(player, hand)
`SetTrumpAction`(trump)
`ShuffleAction`(*constraints)
`UnplayAction`()

Exceptions:

ActionNotAppliedError

class endplay.interact.actions.Action

Bases: ABC

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

abstractmethod apply(cmdobj: CommandObject) → Any

abstract property name: str

abstractmethod unapply(cmdobj: CommandObject)

exception endplay.interact.actions.ActionNotAppliedError: Bases: RuntimeError

class endplay.interact.actions.DealAction(pbn: str)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_deal: Deal | None

unapply(cmdobj)

class endplay.interact.actions.GetHandAction(player: Player)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_hand: Hand | None

unapply(cmdobj)

class endplay.interact.actions.PlayAction(card: Card | str)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_trick: tuple[Player, list[Card]] | None

unapply(cmdobj)

class endplay.interact.actions.SetBoardAction(board_no: int)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_board_no: int | None

unapply(cmdobj)

class endplay.interact.actions.SetFirstAction(first: Player)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_first: Player | None

unapply(cmdobj)

class endplay.interact.actions.SetHandAction(player: Player, hand: Hand | str)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_hand: Hand | None

unapply(cmdobj)

class endplay.interact.actions.SetTrumpAction(trump: Denom)

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

prev_trump: Denom | None

unapply(cmdobj)

class endplay.interact.actions.ShuffleAction(*constraints: str)

Bases: DealAction

Attributes:

`_abc_impl`
`name`

_abc_impl = <_abc._abc_data object>

property name

prev_deal: Deal | None

class endplay.interact.actions.UnplayAction

Bases: Action

Attributes:

`_abc_impl`
`name`

Methods:

`apply`(cmdobj)
`unapply`(cmdobj)

_abc_impl = <_abc._abc_data object>

apply(cmdobj)

property name

unapply(cmdobj)

unplayed_card: Card | None