maverick.hand.Hand

class maverick.hand.Hand(*, private_cards: list[Card], community_cards: list[Card])

Private cards plus as many community cards as needed to complete the hand.

Fields

private_cardslist[Card]

The private cards held by the player.

community_cardslist[Card]

The community cards on the table.

Examples

>>> from maverick import Hand, Card
>>> hand = Hand(
...     private_cards=[Card(suit='S', rank=14), Card(suit='H', rank=13)],
...     community_cards=[Card(suit='D', rank=10), Card(suit='C', rank=11), Card(suit='H', rank=12)]
... )
>>> hand.score()
(HandType.STRAIGHT, 8.1234)  # Example output, actual value may vary

>>> from maverick import Hand, Card, Deck
>>> deck = Deck.standard_deck(shuffle=True)
>>> private_cards = deck.deal(2)
>>> community_cards = deck.deal(5)
>>> hand = Hand(private_cards=private_cards, community_cards=community_cards)
>>> hand.score()
(HandType.FLUSH, 6.5678)  # Example output, actual value may vary

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
all_possible_hands(private_cards[, ...])	Generate all possible hands.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
model_json_schema(by_alias, ref_template, ...)	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
score()	Classifies and scores the hand.
update_forward_refs(**localns)
validate(value)

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
private_cards
community_cards

score() → Tuple[HandType, float]

Classifies and scores the hand.

Returns (HandType, float_score) where higher scores = stronger hands.

classmethod all_possible_hands(private_cards: list[Card], community_cards: list[Card] | None = None) → Iterator[Hand]

Generate all possible hands.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].