Changelog

All notable changes to this project will be documented in this file.

Version 0.4.17 (April 9, 2024)

Changed

  • Make error/warning messages more descriptive.

Added

  • Censored hole cards pokerkit.state.State.get_censored_hole_cards().

  • Turn index pokerkit.state.State.turn_index.

Version 0.4.16 (April 5, 2024)

Added

  • Restore action notation pn sm - for showing hole cards.

Version 0.4.15 (March 29, 2024)

Added

  • Raise error for ACPC protocol converter when hole cards unknown.

  • PHH to Pluribus protocol converter.

Version 0.4.14 (March 25, 2024)

Added

  • Analysis module

    • Range parser pokerkit.analysis.parse_range (e.g. "AKs,T8o-KJo,6h5h,A2+").

    • Equity calculator pokerkit.analysis.calculate_equities.

    • Hand strength calculator pokerkit.analysis.calculate_hand_strength.

    • Player statistics pokerkit.analysis.Statistics.

Version 0.4.13 (March 23, 2024)

Changed

  • Renamed pokerkit.state.State.all_in_show_status to pokerkit.state.State.all_in_status.

Added

  • pokerkit.state.State.reserved_cards

  • pokerkit.state.State.cards_in_play

  • pokerkit.state.State.cards_not_in_play

Version 0.4.12 (March 21, 2024)

Removed

  • Remove non-compliant action notation pn sm - for showing hole cards.

Added

  • Commentary for state actions.

  • User-defined field support for PHH.

  • PHH to ACPC protocol converter

Version 0.4.11 (March 15, 2024)

Added

  • Deuce-to-seven badugi hand lookup/evaluator.

Version 0.4.10 (February 11, 2024)

Added

  • pokerkit.state.State.pot_amounts for iterating through main/side pot amounts.

Changed

  • Forbid showdown without specifying cards if unknown hole cards are dealt.

Version 0.4.9 (January 28, 2024)

Changed

  • New field rake for pokerkit.notation.HandHistory when constructing games/states.

Version 0.4.8 (January 22, 2024)

Changed

  • New action notation pn sm - for showing hole cards.

  • pokerkit.notation.HandHistory.iter_state_actions for iterating through states with actions.

Version 0.4.7 (January 20, 2024)

Changed

  • If there are multiple pots (main + side), pokerkit.state.State.push_chips must be called multiple times.

  • Custom automations are passed through the constructor for pokerkit.notation.HandHistory.

  • Support rakes.

Version 0.4.6 (January 8, 2024)

Changed

  • Collapse pots (main + side) that have the same players in the pokerkit.state.State.pots property.

  • Allow default automations to be overridden in pokerkit.notation.HandHistory.create_game and pokerkit.notation.HandHistory.create_game.

Version 0.4.5 (January 4, 2024)

Changed

  • Fix incorrect type annotation for class attribute optional_field_names in optional_field_names in``pokerkit.notation.HandHistory``.

  • Operation queries also catch UserWarning.

Version 0.4.4 (January 1, 2024)

Added

  • Add class attributes game_field_names and ignored_field_names to pokerkit.notation.HandHistory.

Changed

  • Remove class attributes game_field_names and ignored_field_names from pokerkit.notation.HandHistory

Version 0.4.3 (December 17, 2023)

Added

  • The new .phh optional fields: time_zone

Version 0.4.2 (December 15, 2023)

Added

  • New .phh optional fields: time, time_limit, time_banks, level.

Version 0.4.1 (December 13, 2023)

Added

  • New .phh optional fields: url, city, region, postal_code, country.

Changed

  • ante_trimming_status is now an optional field for .phh files.

Version 0.4.0 (December 11, 2023)

Changed

  • When not enough cards to deal everybody’s hole cards, a board dealing is done.

  • Showdown can specify what cards the player showed.

  • More generous state operations when it comes to cards. Some things that were errors are now warnings.

  • When all-in, cards are shown via show_or_muck_hole_cards.

  • None is no longer ValuesLike or CardsLike.

Added

  • Cards with unknown rank or suit.

  • float compatibility (without static typing support).

  • Poker action notation support.

  • Poker hand history file format (.phh) support.

Version 0.3.2 (December 4, 2023)

Changed

  • When saving state configuration, player_count is not saved.

Version 0.3.1 (December 4, 2023)

Added

  • Allow state configuration to be saved.

Version 0.3.0 (October 7, 2023)

Changed

  • Call unittest.main in unit test files when executed as __main__.

  • Move the automations parameter to be the first parameter of pokerkit.state.State.

Version 0.2.1 (September 27, 2023)

Changed

  • Make pokerkit.state.Operation available as pokerkit.Operation by importing it in pokerkit.__init__.

Version 0.2.0 (September 10, 2023)

Changed

  • Limit the maximum number of completions, bets, or raises to 4 in the pre-configured Fixed-limit deuce-to-seven triple draw and Fixed-limit badugi variants.

  • Flip antes just like blinds during heads-up play (in the case of big blind antes).

  • Also reshuffle all discarded cards (including from the current draw round) along with mucked and burned cards when the deck runs out. Previously, discarded cards from the same draw round was excluded.

  • Rename pokerkit.state.State.verify_card_availability_making to pokerkit.state.State.verify_cards_availability_making.

Added

  • Add more unit tests and doctests to achieve 99% code coverage.

Version 0.1.1 (August 29, 2023)

Bugfixes

  • Fix AssertionError being raised in certain scenarios after discards are made when the state was configured to automatically deal with hole cards.

Changed

  • When the dealer deals hole cards after standing pat or discarding, an explicit ValueError is raised unless every player has stood pat or discarded.

Version 0.1.0 (August 27, 2023)

Added

  • pokerkit.state.Operation abstract base class for all operation classes.

  • pokerkit.utilities.shuffled helper function.

  • pokerkit.state.State.discarded_cards to keep track of discarded cards.

  • pokerkit.state.State.street_count property.

  • pokerkit.state.State.street_indices property.

Changed

  • pokerkit.state.State now also accepts pokerkit.utilities.ValuesLike instances as arguments for various parameters.

  • pokerkit.state.State requires player_count argument to be passed during initialization.

  • Various operation classes such as pokerkit.state.State.AntePosting moved to pokerkit.state and is no longer a nested class of pokerkit.state.State.

  • Renamed pokerkit.lookups.RegularLowLookup to pokerkit.lookups.RegularLookup for enhanced consistency.

  • Renamed pokerkit.state.State.burned_cards to pokerkit.state.State.burn_cards.

  • Renamed pokerkit.state.State.verify_card_availabilities to pokerkit.state.State.verify_card_availability_making.

  • Changed the property pokerkit.state.State.available_cards to method pokerkit.state.State.get_available_cards.

  • Cards can be dealt from the mucked cards or burn cards if the deck is empty.

  • Warning is printed if cards are dealt from burn cards without any good reason.

Version 0.0.2 (August 17, 2023)

Added

  • Introduce pokerkit.utilities.CardsLike and pokerkit.utilities.ValuesLike type aliases to simplify type annotations of various methods.

Version 0.0.1 (August 7, 2023)

Changed

  • Modify the methods that only accept an iterable of Card so they can accept any card-like object.

  • Make the protected attributes of the instances of the Hand type and its descendants public.

  • Move pokerkit.state.State._clean_cards and pokerkit.games.Game._clean_values to pokerkit.utilities.

Version 0.0.0 (August 2, 2023)

Initial Release