From 05d6e62a2b9095f2973650e8734dbbc23daca987 Mon Sep 17 00:00:00 2001 From: "github-classroom[bot]" <66690702+github-classroom[bot]@users.noreply.github.com> Date: Wed, 14 Feb 2024 18:48:23 +0000 Subject: [PATCH] Initial commit --- .github/classroom/autograding.json | 14 +++ .github/workflows/classroom.yaml | 21 ++++ .github/workflows/main.yaml | 3 + .gitignore | 160 ++++++++++++++++++++++++ LICENSE | 21 ++++ README.md | 44 +++++++ app/__init__.py | 0 app/hangman.py | 188 +++++++++++++++++++++++++++++ poetry.lock | 7 ++ pyproject.toml | 14 +++ 10 files changed, 472 insertions(+) create mode 100644 .github/classroom/autograding.json create mode 100644 .github/workflows/classroom.yaml create mode 100644 .github/workflows/main.yaml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 app/__init__.py create mode 100644 app/hangman.py create mode 100644 poetry.lock create mode 100644 pyproject.toml diff --git a/.github/classroom/autograding.json b/.github/classroom/autograding.json new file mode 100644 index 0000000..905af05 --- /dev/null +++ b/.github/classroom/autograding.json @@ -0,0 +1,14 @@ +{ + "tests": [ + { + "name": "Flake", + "setup": "sudo -H pip3 install poetry ; poetry install", + "run": "poetry run flake8 .", + "input": "", + "output": "", + "comparison": "included", + "timeout": 5, + "points": 1 + } + ] + } diff --git a/.github/workflows/classroom.yaml b/.github/workflows/classroom.yaml new file mode 100644 index 0000000..3c0d251 --- /dev/null +++ b/.github/workflows/classroom.yaml @@ -0,0 +1,21 @@ +name: GitHub Classroom Workflow + +on: [push] + +jobs: + build: + permissions: write-all + name: Autograding + strategy: + fail-fast: false + matrix: + python-version: [3.12.0] + poetry-version: [1.7.0] + os: [ubuntu-latest] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - uses: education/autograding@v1 diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..20402c3 --- /dev/null +++ b/.github/workflows/main.yaml @@ -0,0 +1,3 @@ +name: lab-metrics + +# add your pipline description below diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..68bc17f --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..da43e94 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Mark Patterson + +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 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3edfa6f --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Hangman Game + +Python console app hangman game based on the [code](https://github.com/markpatterson27/hangman-game) by [Mark Patterson](https://github.com/markpatterson27) + +## Install dependencies and run + +1. `pip install poetry` +2. `poetry install` +3. `poetry run python app/hangman.py` + +# Lab "Static analysis and Metrics" Assignment + +### Important instructions +1. do not move/delete the source files from the folders +1. you may refactor functions, but you **must** keep the signatures of the all original functions (e.g. _hangman()_, _splash_screen()_, _get_random_word()_) +1. the orginal functionality **must** remain +1. Submission: _commit_ and _push_ your changes to the current project to GitHub +1. do not edit _autograding_ or _classroom_ files +> :warning: **Note:** the autograding is simplified on purpose, it will be overwritten after the submission deadline with additional tests + +> :warning: **Note:** if you add tests, all tests should pass for final submission + +## Style check + +1. Install _flake8_ +1. Analyse the `app/hangman.py` +1. Correct all errors +1. All default _flake8_ checks **must pass** +1. Add _flake8_ check to the GitHub CI as an action to `.github/workflows/main.yaml` + +> :warning: **Note:** all the source code files in the project must pass the the default flake8 check. + +## Complexity analysis +Cyclomatic complexity is a part of maintainability index. The recommended complexity for functions is 10. + +1. Analyse complexity of `app/hangman.py`, +1. Refactor as needed. +1. Add complexity threashold check (i.e. 10 for max complexity) to GitHub CI as an action to `.github/workflows/main.yaml` + +> :warning: **Note:** autograding will check the complexity of all the source code files **after** the submission deadline in postprocessing. + +# Hints +* Check the [code quality tutorial](https://testdriven.io/blog/python-code-quality/) +* Flake rules https://www.flake8rules.com/ diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/hangman.py b/app/hangman.py new file mode 100644 index 0000000..a167bc6 --- /dev/null +++ b/app/hangman.py @@ -0,0 +1,188 @@ +# Console based hangman game. + +import random +import os + +# Constants +WORDS = ("python", "jumble", "easy", "difficult", "answer", "xylophone", "hangman", + "computer", "science", "programming", "mathematics", "player", "condition", + "reverse", "water", "board", "geeks", "keyboard", "laptop", "headphone", + "mouse", "printer", "scanner", "software", "hardware", "network", "server") + +HANGMAN_STAGES = ( +""" + ------- + |/ | + | + | + | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | + | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | | + | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | | + | | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | /| + | | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | /|\\ + | | + | + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | /|\\ + | | + | / + | + /|\\ +----------- +""",""" + ------- + |/ | + | O + | /|\\ + | | + | / \\ + | + /|\\ +----------- +""") + +# Functions +def clear_screen(): + """Clears the screen.""" + os.system("cls" if os.name == "nt" else "clear") + +def get_random_word(): + """Returns a random word from the WORDS tuple.""" + return random.choice(WORDS) + +def splash_screen(): + """The splash screen.""" + print(""" + _ _ ----- + | | | | __ _ _ __ __ _ _ __ ___ __ _ _ __ | o + | |_| |/ _` | '_ \\ / _` | '_ ` _ \\ / _` | '_ \\ | /|\\ + | _ | (_| | | | | (_| | | | | | | (_| | | | | | / \\ + |_| |_|\\__,_|_| |_|\\__, |_| |_| |_|\\__,_|_| |_| | + |___/ v1.0 + """) + input("Press enter to continue...") + clear_screen() + + +def hangman(): + """The hangman game.""" + try: + # game outer loop + while True: + # Setup + word = get_random_word() + guessed_letters = [] + guessed_word = ["_"] * len(word) + wrong_guesses = 0 + + # game inner loop + while True: + clear_screen() + print("Hangman game. Try to guess the word. (CTRL+C to quit)") + print(HANGMAN_STAGES[wrong_guesses]) + print(" ".join(guessed_word), end=' ') + print("(Guessed letters: " + ", ".join(guessed_letters),")") + print() + + # check if player has won + if "_" not in guessed_word: + print("You win!") + break + + # check if player has lost + if wrong_guesses == len(HANGMAN_STAGES)-1: + print("You lose!") + break + + # make sure player enters a single letter + while True: + guess = input("Guess a letter: ").lower() + if len(guess) == 1 and guess.isalpha(): + # check if letter has already been guessed + if guess in guessed_letters: + print("You have already guessed that letter.") + else: + break + else: + print("Invalid guess. Please enter a single letter.") + + # add guess to guessed letters + guessed_letters.append(guess) + + # check if guess is in word + if guess in word: + # add guess to guessed word + for i in range(len(word)): + if word[i] == guess: + guessed_word[i] = guess + else: + # increment wrong guesses + wrong_guesses += 1 + + # Ask the player if they want to play again + play_again = input("Play again? (y/n): ").lower() + if play_again != "y": + break + + print("\nGoodbye!") + + except KeyboardInterrupt: + print("\nGoodbye!") + exit() + + +# Main +if __name__ == "__main__": + splash_screen() + hangman() diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000..24cf95d --- /dev/null +++ b/poetry.lock @@ -0,0 +1,7 @@ +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +package = [] + +[metadata] +lock-version = "2.0" +python-versions = "^3.11" +content-hash = "81b2fa642d7f2d1219cf80112ace12d689d053d81be7f7addb98144d56fc0fb2" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a4078e8 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,14 @@ +[tool.poetry] +name = "project-hangman-game" +version = "0.1.0" +description = "" +authors = ["Your Name "] +readme = "README.md" + +[tool.poetry.dependencies] +python = "^3.11" + + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api"