endplay.types.hand

Classes:

Hand([data])

Class allowing manipulations of cards in the hand of a single player

class endplay.types.hand.Hand(data: Union[str, Array[c_uint]] = '...')

Bases: object

Class allowing manipulations of cards in the hand of a single player

Methods:

`add`(card)	Adds a card to the hand
`clear`()	Remove all cards from the hand
`copy`()
`extend`(cards)	Add multiple cards to the hand
`from_lin`(lin)	Construct a Hand from a LIN string
`from_pbn`(pbn)	Construct a Hand from a PBN string
`pprint`([vertical, stream])	Print the suits in the hand using suit symbols
`remove`(card)	Remove a card from the hand
`to_LaTeX`([vertical, ten_as_letter])	Create a LaTeX representation of the hand.
`to_lin`()	Convert a Hand to a LIN string
`to_pbn`()	return: A PBN representation of the hand

Attributes:

`clubs`	The club holding of the hand
`diamonds`	The diamond holding of the hand
`hearts`	The heart holding of the hand
`spades`	The spade holding of the hand

add(card: Card) → bool

Adds a card to the hand

extend(cards: Iterable[Card]) → int

Add multiple cards to the hand

static from_lin(lin: str) → Hand

Construct a Hand from a LIN string

static from_pbn(pbn: str) → Hand

Construct a Hand from a PBN string

pprint(vertical: bool = True, stream=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>) → None: Print the suits in the hand using suit symbols

remove(card: Card) → bool

Remove a card from the hand

Parameters:: card – The card to be added to the hand, can be a string representation e.g. “CQ”
Returns:: False if the card wasn’t in the hand, True otherwise

to_LaTeX(vertical: bool = True, ten_as_letter: bool = False) → str

Create a LaTeX representation of the hand.

Parameters:

to_pbn() → str