maverick.deck.Deck

class maverick.deck.Deck(*, cards: list[Card])

A standard deck of 52 playing cards.

Fields

cardslist[Card]

The list of cards in the deck.

Examples

>>> from maverick import Deck
>>> deck = Deck.standard_deck(shuffle=True)
>>> dealt_cards = deck.deal(5)
>>> len(dealt_cards)
5
>>> len(deck.cards)
47

__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.
build([shuffle])	Build a standard deck of 52 cards.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
deal(n)	Deal n random cards from the deck.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
missing_cards()	Return the list of cards missing from the deck.
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, ...])
remove_cards(cards_to_remove)	Remove specified cards from the deck.
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
shuffle([n])	Shuffle the deck of cards n times.
standard_deck([shuffle])	Create and optionally shuffle a standard deck of 52 cards.
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.
cards

classmethod build(shuffle: bool = False) → Deck

Build a standard deck of 52 cards.

Parameters:

shuffle (bool, optional) – Whether to shuffle the deck after building (default is False).

classmethod standard_deck(shuffle: bool = False) → Deck

Create and optionally shuffle a standard deck of 52 cards.

This is an alias for Deck.build() for clarity.

Parameters:

shuffle (bool, optional) – Whether to shuffle the deck after building (default is False).

deal(n: int) → list[Card]

Deal n random cards from the deck.

Parameters:

n (int) – The number of cards to deal.

Returns:

The list of dealt cards.

Return type:

list[Card]

Raises:

ValueError – If there are not enough cards in the deck to deal.

Notes

1. Dealt cards are removed from the deck.

2. If n <= 0, an empty list is returned.

shuffle(n: int = 1) → Deck

Shuffle the deck of cards n times.

Parameters:

n (int, optional) – The number of times to shuffle the deck (default is 1).

missing_cards() → list[Card]

Return the list of cards missing from the deck.

remove_cards(cards_to_remove: list[Card]) → None

Remove specified cards from the deck.

Parameters:

cards_to_remove (list[Card]) – The list of cards to remove from the deck.

model_config = {}

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