Merge branch 'dev'

Author: Nihisil

.coveragerc

@@ -0,0 +1,21 @@
+[run]
+omit =
+    env/*
+    project/bots_battle.py
+    project/game/ai/configs/*
+    project/game/bots_battle/*
+    project/settings/*
+    */test_*.py
+    */__init__.py
+    project/reproducer.py
+    project/main.py
+    project/tenhou/*
+    project/utils/statistics.py
+    project/utils/logger.py
+    project/conftest.py
+    project/utils/settings_handler.py
+    project/game/client.py
+    project/system_testing/generate_tests.py
+    project/system_testing/generate_documentation.py
+    project/system_testing/cases.py
+    project/system.py

.flake8

@@ -1,3 +1,5 @@
 [flake8]
+ignore = E203, E266, E501, W503
 max-line-length = 120
-exclude = *settings.py,tests_validate_hand.py
+select = B,C,E,F,W,T4,B9
+exclude = project/settings/*,tests_validate_hand.py,project/system_testing/cases.py,project/system_testing/test_system.py

.github/workflows/pythonapp.yml

@@ -0,0 +1,55 @@
+name: Mahjong bot
+
+on:
+  push:
+    branches: [master, dev]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.8'
+      - name: Install libs
+        run: pip install -r requirements/lint.txt
+      - name: Lint files
+        run: make lint
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.8'
+      - name: Install libs
+        run: pip install -r requirements/lint.txt
+      - name: Generate coverage report
+        run: make tests_coverage
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.PASSWORD }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: htmlcov # The folder the action should deploy.
+          CLEAN: true # Automatically remove deleted files from the deploy branch
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install libs
+        run: pip install -r requirements/dev.txt
+      - name: Run tests
+        run: make tests

.gitignore

@@ -1,26 +1,36 @@
 .idea
 env
 
+failed_*.txt
+
 *.py[cod]
 __pycache__
 .DS_Store
+.pytest_cache
 logs
-project/settings_local.py
-project/*_settings.py
+project/settings/*
+!project/settings/__init__.py
+!project/settings/base.py
 project/game/ai/common
 
-tests_validate_hand.py
+test_validate_hand.py
 loader.py
-socket_mock.py
 *.db
 temp
 *.log
+seeds.txt
 
 project/game/data/*
 project/analytics/data/*
 
+project/battle_results/**/*
+*.tar.gz
+
 # temporary files
 experiments
 
 *.prof
-profile.py
+profile.py
+
+.coverage
+htmlcov

.travis.yml

@@ -0,0 +1,12 @@
+FROM pypy:3.7-7.3.2-slim
+
+RUN useradd -ms /bin/bash docker-user
+
+WORKDIR /app/
+
+COPY requirements /requirements
+RUN pip install --no-cache-dir -r /requirements/dev.txt
+
+COPY ./project .
+
+USER docker-user

Dockerfile

@@ -1,7 +1,5 @@
 MIT License
 
-Copyright (c) [2016] [Alexey Lisikhin]
-
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

LICENSE.txt

@@ -0,0 +1,40 @@
+MAKE_FILE_PATH=$(abspath $(lastword $(MAKEFILE_LIST)))
+CURRENT_DIR=$(dir $(MAKE_FILE_PATH))
+
+check: generate_system_tests format lint tests
+
+format:
+	isort project/*
+	black project/*
+
+lint:
+	isort --check-only project/*
+	black --check project/*
+	flake8 project/*
+
+generate_system_tests:
+	python project/system.py
+
+tests:
+	PYTHONPATH=./project pytest -n 4
+
+tests_coverage:
+	PYTHONPATH=./project pytest --cov=. --cov-report html -n 4
+
+build_docker:
+	docker build -t mahjong_bot .
+
+GAMES=1
+run_battle:
+	docker run -u `id -u` -it --rm \
+		--cpus=".9" \
+		-v "$(CURRENT_DIR)project/:/app/" \
+		-v /dev/urandom:/dev/urandom \
+		mahjong_bot pypy3 bots_battle.py -g $(GAMES) $(ARGS)
+
+run_on_tenhou:
+	docker-compose up
+
+archive_replays:
+	tar -czvf "logs-$(shell date '+%Y-%m-%d-%H-%M').tar.gz" -C ./project/battle_results/logs/ .
+	tar -czvf "replays-$(shell date '+%Y-%m-%d-%H-%M').tar.gz" -C ./project/battle_results/replays/ .

Makefile

@@ -1,6 +1,6 @@
-[![Build Status](https://travis-ci.org/MahjongRepository/tenhou-python-bot.svg?branch=master)](https://travis-ci.org/MahjongRepository/tenhou-python-bot)
+![Build](https://github.com/MahjongRepository/tenhou-python-bot/workflows/Mahjong%20bot/badge.svg) [[Tests coverage]](http://mahjongrepository.github.io/tenhou-python-bot/)
 
-For now only **Python 3.5+** is supported.
+Bot was tested with Python 3.6+ and PyPy3, we are not supporting Python 2.
 
 # What do we have here?
 
@@ -14,124 +14,42 @@ You can find it here: https://github.com/MahjongRepository/mahjong
 
 For research purposes we built a simple bot to play riichi mahjong on tenhou.net server.
 
-### 0.4.0 version
+Here you can read about bot played games statistic: [versions history](doc/versions.md)
 
-Version with various improvements in hand building and melds calling.
-
-This version had played ~1000 games (hanchans) and achieved fourth dan (四段) a couple of times. 
-
-Stable rank was a second dan (二段) and stable rate was ~R1600.
-
-Stat:
-
-|   | Result |
-| --- | --- |
-| Average position | 2.53 |
-| Win rate | 19.21% |
-| Feed rate | 11.78% |
-| Riichi rate | 18.48% |
-| Call rate | 24.41% |
-
-| Places |  |
-| --- | --- |
-| First | 20.92% |
-| Second | 27.46% |
-| Third| 30.17% |
-| Fourth | 21.45% |
-| Bankruptcy | 6.19% |
-
-The number of fourth places was decreased.
-
-### 0.3.2 version
-
-Version with various improvements.
-
-This version had played 600 games (hanchans) and achieved fourth dan (四段) once.
-
-Stable rank was a first dan (初段).
-
-Stat:
-
-|   | Result |
-| --- | --- |
-| Average position | 2.53 |
-| Win rate | 19.97% |
-| Feed rate | 10.88% |
-| Riichi rate | 15.80% |
-| Call rate | 36.39% |
-
-| Places |  |
-| --- | --- |
-| First | 22.41% |
-| Second | 25.52% |
-| Third| 28.28% |
-| Fourth | 23.79% |
-| Bankruptcy | 4.48% |
-
-### 0.2.5 version
-
-This version is much smarter than 0.0.x versions. It can open hand, go to defence and build hand effective (all supported features you can find in releases description).
-
-This version had played 375 games (hanchans) and achieved second dan (二段).
-
-Rate was somewhere around R1500.
-
-Stat:
-
-|   | Result |
-| --- | --- |
-| Average position | 2.65 |
-| Win rate | 18.60% |
-| Feed rate | 10.59% |
-| Riichi rate | 15.64% |
-| Call rate | 34.89% |
-
-### 0.0.5 version
+# For developers
 
-It can reach a tempai and call a riichi. It doesn't know about dora, yaku, defence and etc. 
-Only about tempai and riichi so far.
+## How to run it?
 
-This version had played 335 games (hanchans) and achieved only first dan (初段) on the tenhou.net so far
-(and lost it later, and achieved it again...).
+1. `pip install -r requirements/lint.txt`
+1. Run `cd project && python main.py` it will connect to the tenhou.net and will play a game.
 
-Rate was somewhere around R1350.
+## How to run bot battle with pypy
 
-Stat:
+To make it easier run bot vs bot battles we prepared PyPy3 Docker container.
 
-|   | Result |
-| --- | --- |
-| Average position | 2.78 |
-| Win rate | 20.73% |
-| Feed rate | 19.40% |
-| Riichi rate | 36.17% |
-| Call rate | 0% |
+Run the game locally:
 
-So, even with the current simple logic it can play and win.
+1. [Install Docker](https://docs.docker.com/get-docker/) 
+1. Run `make build_docker`
+1. Run `make GAMES=1 run_battle` it will play one game locally. Logs and replays will be stored in `bots_battle` folder.
 
-# For developers
+Run bots with enabled decision logger (use it only for debug, since it harms performance):
+1. Run `make GAMES=1 ARGS=--logs run_battle`
 
-## How to run it?
+## Run multiple bots to play one game
 
-1. `pip install -r requirements.txt`
-2. Run `python main.py` it will connect to the tenhou.net and will play a game
+1. [Install Docker](https://docs.docker.com/get-docker/) and [Install Docker Compose](https://docs.docker.com/compose/install/)
+1. Run `make build_docker`
+1. Put bot configs to `project/settings/`. By default we are looking for these configs: `bot_1_settings.py`, `bot_2_settings.py`, `bot_3_settings.py`, `bot_4_settings.py`, `bot_5_settings.py`. Why 5 settings? Because tenhou doesn't start 2+ game in the custom lobby if you are running only 4 bots.
+1. Run `make run_on_tenhou`
 
 ## Configuration instructions
 
-1. Put your own settings to the `project/settings_local.py` file. 
-They will override settings from default `settings.py` file
-2. Also you can override some default settings with command argument. 
-Use `python main.py -h` to check all available commands
-
-## Implement your own AI
-
-https://github.com/MahjongRepository/tenhou-python-bot/wiki/Implement-AI
-
-## Round reproducer
-
-https://github.com/MahjongRepository/tenhou-python-bot/wiki/Round-reproducer
+1. Put your own settings to the `project/settings/settings_local.py` file. 
+They will override settings from default `settings/base.py` file.
+1. Also, you can override some default settings with command arguments. 
+Use `python main.py -h` to check all available commands.
 
-## Contribution to the project
+## Game reproducer
 
-All PRs are welcomed anytime. Currently the project is in early stage and 
-I'm working on the different parts of it in the same time, so before making any 
-big changes it's better to check with me to avoid code duplication.
+It can be useful to debug bot errors or strange discards: [game reproducer](doc/reproducer.md)