Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions mahjong/hand_calculating/yaku_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,12 @@ class YakuConfig:
"""

def __init__(self) -> None:
"""
Instantiate one instance of every yaku and yakuman for condition checking.

Attributes are organized by han value: situational yaku, 1-han through
6-han pattern yaku, yakuman, double yakuman, yakuman situations, and bonus dora.
"""
# Yaku situations
self.tsumo = Tsumo()
self.riichi = Riichi()
Expand Down
10 changes: 10 additions & 0 deletions mahjong/hand_calculating/yaku_list/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
"""
Concrete :class:`~mahjong.hand_calculating.yaku.Yaku` subclasses for standard yaku (non-yakuman).

Each class implements :meth:`~mahjong.hand_calculating.yaku.Yaku.is_condition_met`
to test whether the pattern is present in a given hand decomposition.

All classes are re-exported here for convenient access via
``from mahjong.hand_calculating.yaku_list import <ClassName>``.
"""

from mahjong.hand_calculating.yaku_list.aka_dora import AkaDora
from mahjong.hand_calculating.yaku_list.chankan import Chankan
from mahjong.hand_calculating.yaku_list.chantai import Chantai
Expand Down
7 changes: 7 additions & 0 deletions mahjong/hand_calculating/yaku_list/yakuman/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
Concrete :class:`~mahjong.hand_calculating.yaku.Yaku` subclasses for yakuman-level patterns.

All classes are re-exported here for convenient access via
``from mahjong.hand_calculating.yaku_list.yakuman import <ClassName>``.
"""

from mahjong.hand_calculating.yaku_list.yakuman.chiihou import Chiihou
from mahjong.hand_calculating.yaku_list.yakuman.chinroto import Chinroutou
from mahjong.hand_calculating.yaku_list.yakuman.chuuren_poutou import ChuurenPoutou
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ ignore = [
"FBT002", # boolean-default-value-positional-argument
"FBT003", # boolean-positional-value-in-call
"D100", # missing-docstring-in-public-module
"D104", # missing-docstring-in-public-package
]

[tool.ruff.lint.pycodestyle]
Expand All @@ -112,7 +111,6 @@ convention = "pep257"
"D", # pydocstyle
"S101", # assert
]
"./mahjong/hand_calculating/yaku_config.py" = ["D107"] # __init__ only sets yaku instances

[tool.ruff.lint.per-file-ignores]
"mahjong/hand_calculating/yaku_list/*.py" = ["ARG002"] # for `is_condition_met()`
Expand Down
Loading