Github
文档======== PokerKit
PokerKit是一个开源软件库，由多伦多大学计算机扑克学生研究小组用纯Python编写，用于模拟游戏、评估牌力和进行统计分析。PokerKit支持广泛的扑克变体，并提供灵活的架构让用户定义自己的自定义游戏。这些功能通过直观统一的高级编程API暴露。该库可用于多种场景，从扑克AI开发、工具创建到在线扑克casino实现。PokerKit的可靠性已通过静态类型检查、大量文档测试和单元测试得到验证，实现了99%的代码覆盖率。
特性
- 支持主要和次要扑克变体的广泛游戏逻辑
- 高速牌力评估
- 可自定义的游戏状态和参数
- 通过静态类型检查和大量单元测试及文档测试实现的稳健实现
安装
PokerKit库需要Python 3.11或更高版本，可以使用pip安装：
.. code-block:: bash
pip install pokerkit
用法
以下展示了PokerKit的示例用法。
全下情况下的多轮发牌 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
以下展示了Phil Hellmuth和Loose Cannon Ernest Wiggins之间的4轮发牌对决。
链接：https://youtu.be/cnjJv7x0HMY?si=4l05Ez7lQVczt8DI&t=638
注意，某些玩家的起始筹码设置为math.inf，因为未提及具体数额。
.. code-block:: python
from math import inf
from pokerkit import Automation, Mode, NoLimitTexasHoldem
state = NoLimitTexasHoldem.create_state( # 自动化操作 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HOLE_CARDS_SHOWING_OR_MUCKING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), False, # 统一前注？ {-1: 600}, # 前注 (200, 400, 800), # 盲注或马前注 400, # 最小下注 (inf, 116400, 86900, inf, 50000, inf), # 起始筹码 6, # 玩家数量 mode=Mode.CASH_GAME, )
以下是翻牌前的发牌和行动。
.. code-block:: python
state.deal_hole('JsTh') # Tony G state.deal_hole('Ah9d') # Hellmuth state.deal_hole('KsKc') # Wiggins state.deal_hole('5c2h') # Negreanu state.deal_hole('6h5h') # Brunson state.deal_hole('6s3s') # Laak
state.fold() # Negreanu state.complete_bet_or_raise_to(2800) # Brunson state.fold() # Laak state.check_or_call() # Tony G state.complete_bet_or_raise_to(12600) # Hellmuth state.check_or_call() # Wiggins state.check_or_call() # Brunson state.check_or_call() # Tony G
以下是翻牌的发牌和行动。
.. code-block:: python
state.burn_card('??') state.deal_board('9hTs9s')
state.check_or_call() # Tony G state.complete_bet_or_raise_to(17000) # Hellmuth state.complete_bet_or_raise_to(36000) # Wiggins state.fold() # Brunson state.fold() # Tony G state.complete_bet_or_raise_to(103800) # Hellmuth state.check_or_call() # Wiggins
以下是选择发牌轮数。
.. code-block:: python
state.select_runout_count(4) # Hellmuth state.select_runout_count(None) # Wiggins
以下是第一轮发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('Jh') # 转牌 state.burn_card('??') state.deal_board('Ad') # 河牌
以下是第二轮发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('Kh') # 转牌 state.burn_card('??') state.deal_board('3c') # 河牌
以下是第三轮发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('7s') # 转牌 state.burn_card('??') state.deal_board('8s') # 河牌
以下是第四轮发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('Qc') # 转牌 state.burn_card('??') state.deal_board('Kd') # 河牌
以下是最终筹码。
.. code-block:: python
print(state.stacks) # [inf, 79400, 149700, inf, 37400, inf]
无限注德州扑克示例牌局 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
以下展示了Tom Dwan和Phil Ivey之间首次电视直播的百万美元底池。
链接：https://youtu.be/GnxFohpljqM
注意，Patrik Antonius的起始筹码设置为math.inf，因为未提及具体数额。
.. code-block:: python
from math import inf
from pokerkit import Automation, NoLimitTexasHoldem
state = NoLimitTexasHoldem.create_state( # 自动化操作 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HOLE_CARDS_SHOWING_OR_MUCKING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), True, # 统一前注？ 500, # 前注 (1000, 2000), # 盲注或马前注 2000, # 最小下注 (1125600, inf, 553500), # 起始筹码 3, # 玩家数量 )
以下是翻牌前的发牌和行动。
.. code-block:: python
state.deal_hole('Ac2d') # Ivey state.deal_hole('????') # Antonius state.deal_hole('7h6h') # Dwan
state.complete_bet_or_raise_to(7000) # Dwan state.complete_bet_or_raise_to(23000) # Ivey state.fold() # Antonius state.check_or_call() # Dwan
以下是翻牌的发牌和行动。
.. code-block:: python
state.burn_card('??') state.deal_board('Jc3d5c')
state.complete_bet_or_raise_to(35000) # Ivey state.check_or_call() # Dwan
以下是转牌的发牌和行动。
.. code-block:: python
state.burn_card('??') state.deal_board('4h')
state.complete_bet_or_raise_to(90000) # Ivey state.complete_bet_or_raise_to(232600) # Dwan state.complete_bet_or_raise_to(1067100) # Ivey state.check_or_call() # Dwan
以下是河牌的发牌。
.. code-block:: python state.burn_card('??') state.deal_board('Jh')
以下是最终的筹码栈。
.. code-block:: python
print(state.stacks) # [572100, inf, 1109500]
一个短牌德州扑克的示例牌局 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
以下展示了Xuan和Phua之间的一次全下注牌局。
链接：https://youtu.be/QlgCcphLjaQ
.. code-block:: python
from pokerkit import Automation, NoLimitShortDeckHoldem
state = NoLimitShortDeckHoldem.create_state( # 自动化操作 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HOLE_CARDS_SHOWING_OR_MUCKING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), True, # 统一前注？ 3000, # 前注 {-1: 3000}, # 盲注或扩展盲注 3000, # 最小下注 (495000, 232000, 362000, 403000, 301000, 204000), # 起始筹码 6, # 玩家数量 )
以下是翻牌前的发牌和行动。
.. code-block:: python
state.deal_hole('Th8h') # Badziakouski state.deal_hole('QsJd') # Zhong state.deal_hole('QhQd') # Xuan state.deal_hole('8d7c') # Jun state.deal_hole('KhKs') # Phua state.deal_hole('8c7h') # Koon
state.check_or_call() # Badziakouski state.check_or_call() # Zhong state.complete_bet_or_raise_to(35000) # Xuan state.fold() # Jun state.complete_bet_or_raise_to(298000) # Phua state.fold() # Koon state.fold() # Badziakouski state.fold() # Zhong state.check_or_call() # Xuan
以下是翻牌的发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('9h6cKc')
以下是转牌的发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('Jh')
以下是河牌的发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('Ts')
以下是最终的筹码栈。
.. code-block:: python
print(state.stacks) # [489000, 226000, 684000, 400000, 0, 198000]
一个奥马哈梭哈的示例牌局 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
以下展示了Patrik Antonius和Viktor Blom之间创下的最大在线扑克底池记录的牌局。
链接：https://youtu.be/UMBm66Id2AA
.. code-block:: python
from pokerkit import Automation, PotLimitOmahaHoldem
state = PotLimitOmahaHoldem.create_state( # 自动化操作 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HOLE_CARDS_SHOWING_OR_MUCKING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), True, # 统一前注？ 0, # 前注 (500, 1000), # 盲注或扩展盲注 1000, # 最小下注 (1259450.25, 678473.5), # 起始筹码 2, # 玩家数量 )
以下是翻牌前的发牌和行动。
.. code-block:: python
state.deal_hole('Ah3sKsKh') # Antonius state.deal_hole('6d9s7d8h') # Blom
state.complete_bet_or_raise_to(3000) # Blom state.complete_bet_or_raise_to(9000) # Antonius state.complete_bet_or_raise_to(27000) # Blom state.complete_bet_or_raise_to(81000) # Antonius state.check_or_call() # Blom
以下是翻牌的发牌和行动。
.. code-block:: python
state.burn_card('??') state.deal_board('4s5c2h')
state.complete_bet_or_raise_to(91000) # Antonius state.complete_bet_or_raise_to(435000) # Blom state.complete_bet_or_raise_to(779000) # Antonius state.check_or_call() # Blom
以下是转牌的发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('5h')
以下是河牌的发牌。
.. code-block:: python
state.burn_card('??') state.deal_board('9c')
以下是最终的筹码栈。
.. code-block:: python
print(state.stacks) # [1937923.75, 0.0]
一个固定限注2-7低牌三次换牌的示例牌局 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
以下展示了Yockey和Arieh之间的一次倒霉牌局。
链接：https://youtu.be/pChCqb2FNxY
.. code-block:: python
from pokerkit import Automation, FixedLimitDeuceToSevenLowballTripleDraw
state = FixedLimitDeuceToSevenLowballTripleDraw.create_state( # 自动化操作 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HOLE_CARDS_SHOWING_OR_MUCKING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), True, # 统一前注？ 0, # 前注 (75000, 150000), # 盲注或扩展盲注 150000, # 小盲注 300000, # 大盲注 (1180000, 4340000, 5910000, 10765000), # 起始筹码 4, # 玩家数量 )
以下是发牌前的发牌和行动。
.. code-block:: python
state.deal_hole('7h6c4c3d2c') # Yockey state.deal_hole('??????????') # Hui state.deal_hole('??????????') # Esposito state.deal_hole('AsQs6s5c3c') # Arieh
state.fold() # Esposito state.complete_bet_or_raise_to() # Arieh state.complete_bet_or_raise_to() # Yockey state.fold() # Hui state.check_or_call() # Arieh
以下是第一次换牌和行动。
.. code-block:: python
state.stand_pat_or_discard() # Yockey state.stand_pat_or_discard('AsQs') # Arieh state.burn_card('??') state.deal_hole('2hQh') # Arieh
state.complete_bet_or_raise_to() # Yockey state.check_or_call() # Arieh
以下是第二次换牌和行动。
.. code-block:: python state.stand_pat_or_discard() # Yockey state.stand_pat_or_discard('Qh') # Arieh state.burn_card('??') state.deal_hole('4d') # Arieh
state.complete_bet_or_raise_to() # Yockey state.check_or_call() # Arieh
以下是第三轮抽牌和行动。
.. code-block:: python
state.stand_pat_or_discard() # Yockey state.stand_pat_or_discard('6s') # Arieh state.burn_card('??') state.deal_hole('7c') # Arieh
state.complete_bet_or_raise_to() # Yockey state.check_or_call() # Arieh
以下是最终的筹码堆。
.. code-block:: python
print(state.stacks) # [0, 4190000, 5910000, 12095000]
巴杜吉牌局示例 ^^^^^^^^^^^^^^^^^^^^
以下展示了维基百科中的一个巴杜吉牌局示例。
链接：https://en.wikipedia.org/wiki/Badugi
注意，由于未提及起始筹码，因此将起始筹码设置为 math.inf。
.. code-block:: python
from math import inf
from pokerkit import Automation, FixedLimitBadugi
state = FixedLimitBadugi.create_state( # 自动化 ( Automation.ANTE_POSTING, Automation.BET_COLLECTION, Automation.BLIND_OR_STRADDLE_POSTING, Automation.HAND_KILLING, Automation.CHIPS_PUSHING, Automation.CHIPS_PULLING, ), True, # 统一前注？ 0, # 前注 (1, 2), # 盲注或马前注 2, # 小注 4, # 大注 inf, # 起始筹码 4, # 玩家数量 )
以下是翻牌前的发牌和行动。
.. code-block:: python
state.deal_hole('????????') # Bob state.deal_hole('????????') # Carol state.deal_hole('????????') # Ted state.deal_hole('????????') # Alice
state.fold() # Ted state.check_or_call() # Alice state.check_or_call() # Bob state.check_or_call() # Carol
以下是第一轮抽牌和行动。
.. code-block:: python
state.stand_pat_or_discard('????') # Bob state.stand_pat_or_discard('????') # Carol state.stand_pat_or_discard('??') # Alice state.burn_card('??') state.deal_hole('????') # Bob state.deal_hole('????') # Carol state.deal_hole('??') # Alice
state.check_or_call() # Bob state.complete_bet_or_raise_to() # Carol state.check_or_call() # Alice state.check_or_call() # Bob
以下是第二轮抽牌和行动。
.. code-block:: python
state.stand_pat_or_discard('??') # Bob state.stand_pat_or_discard() # Carol state.stand_pat_or_discard('??') # Alice state.burn_card('??') state.deal_hole('??') # Bob state.deal_hole('??') # Alice
state.check_or_call() # Bob state.complete_bet_or_raise_to() # Carol state.complete_bet_or_raise_to() # Alice state.fold() # Bob state.check_or_call() # Carol
以下是第三轮抽牌和行动。
.. code-block:: python
state.stand_pat_or_discard('??') # Carol state.stand_pat_or_discard() # Alice state.burn_card('??') state.deal_hole('??') # Carol
state.check_or_call() # Carol state.complete_bet_or_raise_to() # Alice state.check_or_call() # Carol
以下是摊牌。
.. code-block:: python
state.show_or_muck_hole_cards('2s4c6d9h') # Alice state.show_or_muck_hole_cards('3s5d7c8h') # Carol
以下是最终的筹码堆。
.. code-block:: python
print(state.stacks) # [inf, inf, inf, inf] print(state.payoffs) # [-4, 20, 0, -16]
测试和验证
PokerKit 拥有广泛的测试覆盖率，通过了 mypy 严格模式的静态类型检查，并在真实场景中得到了广泛使用的验证。
贡献
欢迎贡献！请阅读我们的贡献指南以获取更多信息。
许可证
PokerKit 根据 MIT 许可证分发。
引用
如果您在研究中使用了 PokerKit，请引用我们的库：
.. code-block:: bibtex
@ARTICLE{10287546, author={Kim, Juho}, journal={IEEE Transactions on Games}, title={PokerKit: A Comprehensive Python Library for Fine-Grained Multi-Variant Poker Game Simulations}, year={2023}, volume={}, number={}, pages={1-8}, doi={10.1109/TG.2023.3325637}}
