maverick.rules.DealingRules

maverick.rules.DealingRules#

class maverick.rules.DealingRules(*, max_players: Annotated[int, Ge(ge=2), Le(le=10)] = 9, min_players: Annotated[int, Ge(ge=2), Le(le=10)] = 2, hole_cards: Annotated[int, Ge(ge=1), Le(le=4)] = 2, board_cards_total: Annotated[int, Ge(ge=0), Le(le=5)] = 5, board_deal_pattern: dict[Street, int] = {Street.FLOP: 3, Street.PRE_FLOP: 0, Street.RIVER: 1, Street.TURN: 1})[source]#

Rules related to seating limits and how cards are dealt.

Fields#

max_players

Maximum number of seats allowed at the table. Typical values: - 6 for “6-max” - 9 for “full ring”

min_players

Minimum number of active players required to start a new hand. In most poker games, 2 is the minimum (heads-up).

hole_cards

Number of private cards dealt to each player at the start of a hand. - Hold’em: 2 - Omaha: 4 (commonly)

board_cards_total

Total number of community cards dealt by the end of the hand. - Hold’em / Omaha: 5 - Some games have 0 community cards.

board_deal_pattern

How board cards are revealed over the streets, expressed as a dictionary mapping Street to int.

For standard Hold’em: {

Street.PRE_FLOP: 0, Street.FLOP: 3, Street.TURN: 1, Street.RIVER: 1,

} meaning:

  • preflop: 0 board cards dealt (only hole cards)

  • flop: 3 board cards

  • turn: 1 board card

  • river: 1 board card

This pattern also implicitly defines how many betting rounds exist if you align each entry with one “street”.

__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.

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])

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.

max_players

min_players

hole_cards

board_cards_total

board_deal_pattern

model_config = {}#

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