Merge pull request #107 from TobiasGoetz/develop

Release 1.0

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = */tests/*,*/__init__.py

.github/workflows/pytest.yml

@@ -25,7 +25,7 @@ jobs:
  - name: Install dependencies
  run: |
  python -m pip install --upgrade pip
- pip install pylint
+ pip install pylint parameterized
  if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
  - name: Analysing the code with pylint
  run: |
@@ -44,7 +44,7 @@ jobs:
  - name: Install dependencies
  run: |
  python -m pip install --upgrade pip
- pip install pytest pytest-cov coverage
+ pip install pytest pytest-cov coverage parameterized
  if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
  - name: Test with pytest
  run: |

.gitignore

@@ -128,4 +128,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-/.idea/
+/.idea/
+/kniffel/*.pkl

kniffel/app.py

@@ -0,0 +1,127 @@
+"""
+Modelling and executing Kniffel
+"""
+import os
+import pickle
+from pathlib import Path
+
+from kniffel.models.game import Game
+
+
+def list_saved_games() -> list[str]:
+ """
+ List all saved games
+ :return:
+ """
+ save_games = []
+ curr_dir = Path(__file__).parent.resolve()
+ for file in os.listdir(curr_dir):
+ if file.endswith(".pkl"):
+ save_games.append(str(file))
+ return save_games
+
+
+def print_save_games():
+ """
+ Print all saved games
+ :return:
+ """
+ print("Available games:")
+ for game in list_saved_games():
+ # print file name without extension
+ print(f"\t{game.split('.')[0]}")
+
+
+def load_game(path: Path) -> Game:
+ """
+ Load game from file
+ :return:
+ """
+ print("Loading game...")
+ with open(path, 'rb') as file:
+ print("Game loaded!")
+ return pickle.load(file)
+
+
+def create_game(player_count: int = 1, ai_count: int = 1) -> Game:
+ """
+ Create game
+ :return:
+ """
+ counter = 1
+
+ curr_dir = Path(__file__).parent.resolve()
+ game_path = os.path.join(curr_dir, f"game{counter}.pkl")
+ while Path(game_path).exists():
+ counter += 1
+ game_path = os.path.join(curr_dir, f"game{counter}.pkl")
+
+ game = Game(number_of_players=player_count, number_of_ai=ai_count, path=game_path)
+ print(f"Game created at {game_path}")
+ return game
+
+
+def main():
+ """
+ Main function
+ :return:
+ """
+
+ print("Welcome to Kniffel!")
+ is_running = True
+ game = None
+ while is_running:
+ print("Available commands:"
+ "\n\t[1] create - Create new game"
+ "\n\t[2] load - Load game"
+ "\n\t[3] delete - Delete game"
+ "\n\t[9] exit - Exit program")
+ command = input("\nEnter command: ")
+ match command:
+ case "create" | "1":
+ print("Choose number of players:")
+ number_of_players = input()
+ print("Choose number of AI players:")
+ number_of_ai = input()
+ try:
+ game = create_game(int(number_of_players), int(number_of_ai))
+ except ValueError:
+ print("Invalid input!")
+ case "load" | "2":
+ if len(list_saved_games()) == 0:
+ print("No games available")
+ continue
+ print_save_games()
+ print("\nEnter game name:")
+ game_name = input()
+ try:
+ game = load_game(Path(game_name + ".pkl"))
+ game.path = Path(game_name + ".pkl")
+ except FileNotFoundError:
+ print("Game not found!")
+ except pickle.UnpicklingError:
+ print("Invalid file!")
+ case "delete" | "3":
+ if len(list_saved_games()) == 0:
+ print("No games available")
+ continue
+ print_save_games()
+ print("\nEnter game name:")
+ game_name = input()
+ try:
+ os.remove(Path(game_name + ".pkl"))
+ print("Game deleted!")
+ except FileNotFoundError:
+ print("Game not found!")
+ case "exit" | "quit" | "q" | "9":
+ is_running = False
+ case _:
+ print("Invalid command!")
+
+ if game is None:
+ continue
+ game.play()
+
+
+if __name__ == "__main__":
+ main()

kniffel/exceptions.py

@@ -25,3 +25,9 @@ class InvalidCommandError(Exception):
  """
  Exception for invalid command
  """
+
+
+class CategoryAlreadyFilledError(Exception):
+ """
+ Exception for already filled category
+ """