2.0.0¶

MVC pattern. The goal was to explicitely demonstrate an MVC pattern out of the scope of web development.

Idiomatic code. In this overhaul there’s a big emphasis on idiomatic code. The code should be describing its’ own intention with the clarity your grandmother could read.

1.0.0¶

Learning! This was a Test Driven Development(TDD) exercise.

Also, explored:

• Tox, test automation
• Travis CI
• Python version agnostic programming
• Setuptools
• Publishing on pip
• Coverage via coveralls
• Documentation with sphinx and ReadTheDocs
• Cookiecutter development

MVC Intro¶

This game roughly follows the Model-View-Controller(MVC) pattern. In the latest overhaul, these roles have been explicitely named: hangman.model, hangman.view, hangman.controller.

Traditionally in MVC the controller is the focal point. It tells the view what information to collect from the user and what to show. It uses that information to communicate with the model–also, the data persistence later–and determine the next step. This Hangman MVC adheres to these principals

Model¶

The model is very simply the hangman game instance–hangman.model.Hangman. It’s a class. Every class should have “state” and the methods of that class should manage that state. In this case, the “state” is the current “state of the game”. The public API are for manageing that state.

The entirety of the game logic is contained in hangman.model.Hangman. You could technically play the game in the python console by instantiating the class, submitting guesses with the method hangman.model.Hangman.guess() and printing the game state.

For example:

>>> from hangman.hangman import Hangman
>>> game = Hangman(answer='hangman')
>>> game.guess('a')
hangman(status='_A___A_', misses=[], remaining_turns=10)

>>> game.guess('n').guess('z').guess('e')
hangman(status='_AN__AN', misses=['E', 'Z'], remaining_turns=8)

>>> game.status
'_AN__AN'

>>> game.misses
['E', 'Z']

>>> game.remaining_turns
8

View¶

hangman.view is a collection of stateless functions that represent the presentation layer. When called these functions handles printing the art to the console, and collecting input from the user.

Controller¶

In this program, the controller is actually the “game_loop”–hangman.controller.game_loop(). I still think of it as a controller because the role it plays–communicating I/O from the view with the model-persistence layer.

The controller tells the view later what to print and what data to collect. It uses that information update the state of the game (model) and handle game events.

Report Bugs¶

Report bugs at https://github.com/bionikspoon/Hangman/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Hangman could always use more documentation, whether as part of the official Hangman docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/bionikspoon/Hangman/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

hangman.__main__¶

Entry point for hangman command.

hangman.controller¶

This module is responsible for guiding the user through the game.

hangman.controller.game_loop(game=hangman(status='___', misses=[], remaining_turns=10), flash=<hangman.utils.FlashMessage object>)[source]¶

Main game loop.

Parameters:	game (hangman.model.Hangman) – Hangman game instance. flash (hangman.utils.FlashMessage) – FlashMessage utility
Returns:

hangman.model¶

This module contains all of the game logic.

class hangman.model.Hangman(answer=None)[source]¶

Bases: object

The hangman game object contains the logic for managing the status of the game and raising key game related events.

>>> from hangman.model import Hangman
>>> game = Hangman(answer='hangman')
>>> game.guess('a')
hangman(status='_A___A_', misses=[], remaining_turns=10)

>>> game.guess('n').guess('z').guess('e')
hangman(status='_AN__AN', misses=['E', 'Z'], remaining_turns=8)

>>> game.status
'_AN__AN'

>>> game.misses
['E', 'Z']

>>> game.remaining_turns
8

MAX_TURNS = 10¶

add_hit(value)[source]¶

Add a hit to the model. Check for game won.

Parameters:	value – A single letter.
Raises:	GameWon

add_miss(value)[source]¶

Add a miss to the model. Check for game over.

Parameters:	value – A single letter.
Raises:	GameOver

guess(letter)[source]¶

Check if guess is a hit or miss.

Parameters:	letter (str) – Letter to check
Returns:	self
Return type:	Hangman
Raises:	ValueError

hits¶

Get list of hits.

Return type:	[str]

is_valid_answer(word)[source]¶

Validate answer. Letters only. Max:16

Parameters:	word (str) – Word to validate.
Returns:
Return type:	bool

is_valid_guess(letter)[source]¶

Validate guess. Letters only. Max:1

Parameters:	letter (str) – Letter to validate
Returns:
Return type:	bool

misses¶

Get list of misses.

Return type:	[str]

remaining_turns¶

Calculate number of turns remaining.

Returns:	Number of turns remaining.
Return type:	int

status¶

Build a string representation of status with letters for hits and _ for unknowns.

Returns:	game status as string
Return type:	str

hangman.utils¶

App utilities.

class hangman.utils.WordBank[source]¶

Bases: object

Default collection of words to choose from

WORDS = ['ATTEMPT', 'DOLL', 'ELLEN', 'FLOATING', 'PRIDE', 'HEADING', 'FILM', 'KIDS', 'MONKEY', 'LUNGS', 'HABIT', 'SPIN', 'DISCUSSION', 'OFFICIAL', 'PHILADELPHIA', 'FACING', 'MARTIN', 'NORWAY', 'POLICEMAN', 'TOBACCO', 'VESSELS', 'TALES', 'VAPOR', 'INDEPENDENT', 'COOKIES', 'WEALTH', 'PENNSYLVANIA', 'EXPLANATION', 'DAMAGE', 'OCCASIONALLY', 'EXIST', 'SIMPLEST', 'PLATES', 'CANAL', 'NEIGHBORHOOD', 'PALACE', 'ADVICE', 'LABEL', 'DANNY', 'CLAWS', 'RUSH', 'CHOSE', 'EGYPT', 'POETRY', 'BREEZE', 'WOLF', 'MANUFACTURING', 'OURSELVES', 'SCARED', 'ARRANGEMENT', 'POSSIBLY', 'PROMISED', 'BRICK', 'ACRES', 'TREATED', 'SELECTION', 'POSITIVE', 'CONSTANTLY', 'SATISFIED', 'ZOO', 'CUSTOMS', 'UNIVERSITY', 'FIREPLACE', 'SHALLOW', 'INSTANT', 'SALE', 'PRACTICAL', 'SILLY', 'SATELLITES', 'SHAKING', 'ROCKY', 'SLOPE', 'CASEY', 'REMARKABLE', 'RUBBED', 'HAPPILY', 'MISSION', 'CAST', 'SHAKE', 'REQUIRE', 'DONKEY', 'EXCHANGE', 'JANUARY', 'MOUNT', 'AUTUMN', 'SLIP', 'BORDER', 'LEE', 'MELTED', 'TRAP', 'SOLAR', 'RECALL', 'MYSTERIOUS', 'SWUNG', 'CONTRAST', 'TOY', 'GRABBED', 'AUGUST', 'RELATIONSHIP', 'HUNTER', 'DEPTH', 'FOLKS', 'DEEPLY', 'IMAGE', 'STIFF', 'RHYME', 'ILLINOIS', 'SPECIES', 'ADULT', 'FINEST', 'THUMB', 'SLIGHT', 'GRANDMOTHER', 'SHOUT', 'HARRY', 'MATHEMATICS', 'MILL', 'ESSENTIAL', 'TUNE', 'FORT', 'COACH', 'NUTS', 'GARAGE', 'CALM', 'MEMORY', 'SOAP']¶

classmethod get()[source]¶

Get a random word from word list.

Return str:	Random word.

classmethod set(*values)[source]¶

Set WordBank word list.

Parameters:	values (tuple) –

class hangman.utils.FlashMessage[source]¶

Bases: object

Basic “flash message” implementation.

game_answer = ''¶

game_over = False¶

game_won = False¶

message = ''¶

exception hangman.utils.GameOver[source]¶

Bases: exceptions.Exception

Raised when out of turns.

exception hangman.utils.GameWon[source]¶

Bases: exceptions.Exception

Raised when answer has been guessed.

exception hangman.utils.GameFinished[source]¶

Bases: exceptions.Exception

Raised when controller should break game loop.

hangman.view¶

This module handles user interaction. Printing and prompting.

hangman.view.build_partial_picture(remaining_turns)[source]¶

Generator. Draw the iconic hangman game status.

Parameters:	remaining_turns (int) – Number of turns remaining.
Returns:	Line of picture.

hangman.view.build_partial_status(misses_block)[source]¶

Generator. Draw game status.

Returns:	Line of status.

hangman.view.draw_board(game, message=<hangman.utils.FlashMessage object>)[source]¶

Present the game status with pictures.

Clears the screen. Flashes any messages. Zip the two halves of the picture together.

Parameters:	game (hangman.Hangman) – game instance message (hangman.utils.FlashMessage) – flash message
Raises:	hangman.utils.GameFinished
Returns:	self

hangman.view.print_partial_body(picture, status)[source]¶

hangman.view.print_partial_footer(game_status)[source]¶

hangman.view.print_partial_header()[source]¶

hangman.view.print_partial_message(flash)[source]¶

hangman.view.print_spacer()[source]¶

hangman.view.prompt_guess()[source]¶

Prompt user for a single keystroke.

Returns:	a single letter
Raises:	KeyboardInterrupt

hangman.view.prompt_play_again()[source]¶

Prompt user to play again.

Return type:	bool
Returns:	bool response

hangman.view.say_goodbye()[source]¶

Write a goodbye message.