Metadata-Version: 2.4
Name: phevaluator
Version: 0.6.0
Summary: PH Evaluator - an efficient Poker Hand Evaluator based on a Perfect Hash algorithm
Author-email: Henry Lee <lee0906@hotmail.com>
Maintainer-email: azriel1rf <azriel.1rf@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "{}"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2016-2023 Henry Lee
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/HenryRLee/PokerHandEvaluator
Project-URL: Documentation, https://henryrlee.github.io/PokerHandEvaluator/python
Project-URL: Repository, https://github.com/HenryRLee/PokerHandEvaluator
Project-URL: Issues, https://github.com/HenryRLee/PokerHandEvaluator/issues
Project-URL: Changelog, https://github.com/HenryRLee/PokerHandEvaluator/tags
Project-URL: Source, https://github.com/HenryRLee/PokerHandEvaluator/tree/master/python
Keywords: poker,texas-holdem,poker-evaluator
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Requires-Python: <4,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Dynamic: license-file

# PH Evaluator Python package (phevaluator)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/HenryRLee/PokerHandEvaluator/Build%20and%20Test?color=green&logo=github)](https://github.com/HenryRLee/PokerHandEvaluator/actions/workflows/build-and-test.yml)
[![PyPI version](https://badge.fury.io/py/phevaluator.svg)](https://badge.fury.io/py/phevaluator)
[![PyPI downloads](https://img.shields.io/pypi/dm/phevaluator)](https://shields.io/category/downloads)
[![Apache_2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/HenryRLee/PokerHandEvaluator/blob/master/python/LICENSE)

## Description

[PH Evaluator](https://github.com/HenryRLee/PokerHandEvaluator) is designed
for evaluating poker hands with more than 5 cards. Instead of traversing all
the combinations, it uses a perfect hash algorithm to get the hand strength
from a pre-computed hash table, which only costs very few CPU cycles and
considerably small memory (~100kb for the 7 card evaluation). With slight
modification, the same algorithm can be also applied to evaluating Omaha
poker hands.

The full API documentation is published at
<https://henryrlee.github.io/PokerHandEvaluator/python>.

## Installation

The library requires Python 3.10 or newer.

The evaluator is implemented as a C extension (`phevaluator._pheval`) that
wraps the C sources in the repository's [`cpp`](../cpp) directory, so a C
compiler and **pip 21.3 or newer** are required to build from source. Older
pip versions build out-of-tree and cannot reach the `cpp` directory.

* from release on PyPI

  ```shell
  pip install phevaluator
  ```

* from source code

  Build from within the repository (the sibling `cpp` directory is used to
  compile the extension):

  ```shell
  pip install .
  ```

  If you are using pip older than 21.3, either upgrade pip:

  ```shell
  pip install --upgrade pip
  ```

  or pass the `--use-feature=in-tree-build` flag so the build can access the
  `cpp` sources:

  ```shell
  pip install --use-feature=in-tree-build .
  ```

## Using the library

The main function is the `evaluate_cards` function.

```python
from phevaluator.evaluator import evaluate_cards

p1 = evaluate_cards("9c", "4c", "4s", "9d", "4h", "Qc", "6c")
p2 = evaluate_cards("9c", "4c", "4s", "9d", "4h", "2c", "9h")

# The rank is an integer from 1 (strongest) to 7462 (weakest), so a smaller
# value means a stronger hand. Player 2 has a stronger hand here.
print(f"The rank of the hand in player 1 is {p1}") # 292
print(f"The rank of the hand in player 2 is {p2}") # 236
```

The returned value is the rank of the hand among all 7462 distinct
five-card hands. It is identical to the return value of Cactus Kev's
evaluator: `1` is the best possible hand (a Royal Straight Flush) and `7462`
is the worst. A smaller value is always a stronger hand, so you can compare
two hands directly (e.g. `p2 < p1` means player 2 wins).

The function can take both numbers and card strings (with a format like: 'Ah' or
'2C'). Usage examples can be seen in [`examples.py`](examples.py).

### Omaha and Pot Limit Omaha

Omaha-style hands (five community cards followed by the hole cards) can be
evaluated with the dedicated functions:

```python
from phevaluator import evaluate_omaha_cards  # 4 hole cards
from phevaluator import evaluate_plo4_cards   # 4 hole cards (alias of Omaha)
from phevaluator import evaluate_plo5_cards   # 5 hole cards
from phevaluator import evaluate_plo6_cards   # 6 hole cards

# 5 community cards + 4 hole cards. The return value is a rank in the same
# 1 (strongest) to 7462 (weakest) scale as evaluate_cards, computed from the
# best five-card hand allowed by the Omaha rules.
evaluate_omaha_cards("4c", "5c", "6c", "7s", "8s", "2c", "9c", "As", "Kd")
```

`evaluate_plo5_cards` and `evaluate_plo6_cards` require the package to be built
with PLO5/PLO6 support. Their lookup tables are very large (hundreds of MB of
generated C source each), so they are **opt-in**: set the
`PHEVALUATOR_BUILD_PLO` environment variable when installing from the
repository.

```shell
# Build with PLO5 and PLO6 support (also accepts "5", "6", or "all")
PHEVALUATOR_BUILD_PLO=5,6 pip install .
```

Calling `evaluate_plo5_cards`/`evaluate_plo6_cards` on a package built without
the corresponding support raises `NotImplementedError`. `evaluate_plo4_cards`
(and `evaluate_omaha_cards`) are always available.

## Card Id

We can use an integer to represent a card. The two least significant bits
represent the 4 suits, ranging from 0-3. The rest of it represents the 13
ranks, ranging from 0-12.

More specifically, the ranks are:

deuce = 0, trey = 1, four = 2, five = 3, six = 4, seven = 5, eight = 6,
nine = 7, ten = 8, jack = 9, queen = 10, king = 11, ace = 12.

And the suits are:
club = 0, diamond = 1, heart = 2, spade = 3

So that you can use `rank * 4 + suit` to get the card ID.

Technically, it is fine to swap the suit values, as long as the suits are
uniquely mapped to the values 0, 1, 2, and 3. If you do swap the suit values,
make sure to update the mapping in the source code as well (`suit_map` in
[card.py](phevaluator/card.py)).

The complete card Id mapping can be found below. The rows are the ranks
from 2 to Ace, and the columns are the suits: club, diamond, heart and spade.

|      |    C |    D |    H |    S |
| ---: | ---: | ---: | ---: | ---: |
|    2 |    0 |    1 |    2 |    3 |
|    3 |    4 |    5 |    6 |    7 |
|    4 |    8 |    9 |   10 |   11 |
|    5 |   12 |   13 |   14 |   15 |
|    6 |   16 |   17 |   18 |   19 |
|    7 |   20 |   21 |   22 |   23 |
|    8 |   24 |   25 |   26 |   27 |
|    9 |   28 |   29 |   30 |   31 |
|    T |   32 |   33 |   34 |   35 |
|    J |   36 |   37 |   38 |   39 |
|    Q |   40 |   41 |   42 |   43 |
|    K |   44 |   45 |   46 |   47 |
|    A |   48 |   49 |   50 |   51 |

## Test

* The functionality of the evaluators is tested against CSV test data in the
  `test_data/` folder (generated by the C++ evaluator), covering five-card,
  six-card, seven-card, and PLO4 (Omaha) evaluations.
* The Card module is tested against the Card Id table documented above.

The tests import the compiled `phevaluator._pheval` extension, so build it
first (for example with an editable install, `pip install -e .`) and run the
tests from the repository root of the Python package:

```shell
python -m unittest discover -v
```

## Contributing

Thank you for your interest in contributing to the Python package of PHEvaluator!
To ensure a smooth contribution process, please follow the guidelines below.

### Requirements

* Python 3.10 or newer
* A C compiler (the evaluator is built as a C extension)
* [Ruff](https://docs.astral.sh/ruff/) for linting and formatting
* [mypy](https://mypy-lang.org/) for type checking

### Code style

* Follow the [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html).
* Write type hints following [PEP 484](https://www.python.org/dev/peps/pep-0484/).
* Include docstrings following [PEP 257](https://www.python.org/dev/peps/pep-0257/).
* Lint and format code using `Ruff`.

### Development Setup

Install development dependencies:

```shell
pip install '.[dev]'
```

### Checking Changes

You can install the package from the source code in `editable` mode:

```shell
pip install -e .
```

This allows the installed package to automatically reflect changes made in the `phevaluator`
folder.

### Building the Package

To build the package, run the following command:

```shell
python -m build
```

This will create a `dist` folder containing the built package.

Install the built package for testing:

```shell
pip install dist/*.whl
```

Check whether your distribution's long description will render correctly on PyPI:

```shell
python -m twine check dist/*
```
