Python poker library
Project description
pokerlib
General
A Python poker library which focuses on simplifying a poker game implementation, when its io is supplied. It includes modules that help with hand parsing and poker game continuation.
One application of this library was made by the PokerMessenger app, which supplies library with io in the form of messenger group threads. The app's repo is at https://github.com/kuco23/pokermessenger.
Usage
Library consists of a module for parsing cards, which can be used seperately, and modules for running a poker game.
HandParser
This module allows for parsing of hands. A hand usually consists of 2 dealt cards plus 5 on the board, but you can use this for any number of cards.
from pokerlib import HandParser
from pokerlib.enums import Rank, Suit, Hand
hand = HandParser([
(Rank.SEVEN, Suit.HEART),
(Rank.EIGHT, Suit.SPADE),
(Rank.KING, Suit.DIAMOND),
(Rank.ACE, Suit.DIAMOND),
(Rank.QUEEN, Suit.DIAMOND),
(Rank.JACK, Suit.DIAMOND),
(Rank.TEN, Suit.DIAMOND)
])
hand.parse()
print(hand.handenum) # <Hand.STRAIGHTFLUSH: 8>
All of the enums used are of type IntEnum
, so you can also specify cards as integer pairs (look at pokerlib.enums
file to see the exact enumeration of ranks and suits). You can also compare different hands as
hand1 = HandParser([
(Rank.KING, Suit.SPADE),
(Rank.ACE, Suit.SPADE)
])
hand2 = HandParser([
(Rank.NINE, Suit.SPADE),
(Rank.TWO, Suit.CLUB)
])
board = [
(Rank.EIGHT, Suit.SPADE),
(Rank.TEN, Suit.SPADE),
(Rank.JACK, Suit.SPADE),
(Rank.QUEEN, Suit.SPADE),
(Rank.TWO, Suit.HEART)
]
hand1 += board
hand2 += board
hand1.parse()
hand2.parse()
print(hand1.handenum) # Hand.STRAIGHTFLUSH
print(hand2.handenum) # Hand.STRAIGHTFLUSH
print(hand1 > hand2) # True
you can also get kickers for a hand,
hand = HandParser([
(Rank.TWO, Suit.DIAMOND),
(Rank.ACE, Suit.CLUB),
(Rank.TWO, Suit.SPADE),
(Rank.THREE, Suit.DIAMOND),
(Rank.TEN, Suit.HEART),
(Rank.SIX, Suit.HEART),
(Rank.KING, Suit.CLUB)
])
hand.parse()
print(list(hand.kickercards))
# [
# (<Rank.ACE: 12>, <Suit.CLUB: 1>),
# (<Rank.KING: 11>, <Suit.CLUB: 1>),
# (<Rank.TEN: 8>, <Suit.HEART: 3>)
# ]
Note that kickers
attribute saves the indices of hand.cards
that form the kickercards
.
Poker Game
We can establish a poker table by defining its configuration. Table also generates output and we need to provide a function that handles it
from pokerlib import Player, PlayerGroup, Table
# just print output
class MyTable(Table):
def publicOut(self, action, **kwargs):
print(action, kwargs)
table = MyTable(
table_id = 0
seats = 2
players = PlayerGroup([])
buyin = 100
small_blind = 5
big_blind = 10
)
To add players, we can do
player1 = Player(
table_id = table.id,
_id = 1,
name = 'alice',
money = table.buyin
)
player2 = Player(
table_id = table.id,
_id = 2,
name = 'bob',
money = table.buyin
)
table += [player1, player2]
where 100 is the buyin amount. From here on, communication to the table
object is established through enums:
from pokerlib.enums import RoundPublicInId, TablePublicInId
table.publicIn(player1.id, TablePublicInId.STARTROUND)
table.publicIn(player1.id, RoundPublicInId.CALL)
table.publicIn(player2.id, RoundPublicInId.CHECK)
table.publicIn(player1.id, RoundPublicInId.CHECK)
table.publicIn(player2.id, RoundPublicInId.RAISE, raise_by=50)
table.publicIn(player1.id, RoundPublicInId.CALL)
table.publicIn(player1.id, RoundPublicInId.CHECK)
table.publicIn(player2.id, RoundPublicInId.CHECK)
table.publicIn(player1.id, RoundPublicInId.ALLIN)
table.publicIn(player2.id, RoundPublicInId.CALL)
Wrong inputs are mostly ignored, and additional outputs are generated to
keep players informed of the game continuation (like e.g. PLAYERACTIONREQUIRED
).
For all possible outputs check RoundPublicInId
and TablePublicInId
enums.
A new round has to be initiated by one of the players every time it ends.
A simple command line game, where you respond by enum names, can be started by
# define a table with fixed players
table.publicIn(player1.id, TablePublicInId.STARTROUND)
while True:
p = table.round.current_player
i = input(f'Player {p.name}: ')
cmd = RoundPublicInId.__members__[i]
table.publicIn(p.id, cmd)
Tests
Basic tests for this library are included.
For instance round_test.py
can be started from os terminal, by typing python round_test.py <player_num> <game_type>
, after which a simulation is run with not-that-informative data getting printed in stdout.
License
GNU General Public License v3.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.