code.rst

API Documentation

This is the PyDealer API documentation. It contains the documentation extracted from the docstrings of the various classes, methods, and functions in the PyDealer package. If you want to know what a certain function/method does, this is the place to look.

Contents

• :mod:`card` Module
• :mod:`stack` Module
• :mod:`deck` Module
• :mod:`tools` Module
• :mod:`const` Module

:mod:`card` Module

Source

.. automodule:: pydealer.card
    :members:
    :undoc-members:

:mod:`stack` Module

Source

.. automodule:: pydealer.stack
    :members:
    :undoc-members:

:mod:`deck` Module

Source

.. automodule:: pydealer.deck
    :members:
    :undoc-members:
    :show-inheritance: :class:`pydealer.stack.Stack`

:mod:`tools` Module

Source

.. automodule:: pydealer.tools
    :members:
    :undoc-members:

:mod:`const` Module

Source

.. automodule:: pydealer.const
    :members:
    :undoc-members:

.. data:: SUITS

["Diamonds", "Clubs", "Hearts", "Spades"]

.. data:: VALUES

["2", "3", "4", "5", "6", "7", "8", "9", "10", "Jack", "Queen", "King", "Ace"]

.. data:: BIG2_RANKS

{
    "values": {
        "2": 13,
        "Ace": 12,
        "King": 11,
        "Queen": 10,
        "Jack": 9,
        "10": 8,
        "9": 7,
        "8": 6,
        "7": 5,
        "6": 4,
        "5": 3,
        "4": 2,
        "3": 1,
    },
    "suits": {
        "Spades": 4,
        "Hearts": 3,
        "Clubs": 2,
        "Diamonds": 1
    }
}

.. data:: DEFAULT_RANKS

{
    "values": {
        "Ace": 13,
        "King": 12,
        "Queen": 11,
        "Jack": 10,
        "10": 9,
        "9": 8,
        "8": 7,
        "7": 6,
        "6": 5,
        "5": 4,
        "4": 3,
        "3": 2,
        "2": 1
    },
    "suits": {
        "Spades": 4,
        "Hearts": 3,
        "Clubs": 2,
        "Diamonds": 1
    }
}

.. data:: POKER_RANKS

{
    "Ace": 13,
    "King": 12,
    "Queen": 11,
    "Jack": 10,
    "10": 9,
    "9": 8,
    "8": 7,
    "7": 6,
    "6": 5,
    "5": 4,
    "4": 3,
    "3": 2,
    "2": 1
}

.. data:: TOP

"top"

.. data:: BOTTOM

"bottom"