neale/moth
neale
/
moth
mirror of https://github.com/dirtbags/moth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added a bit more documentation. 

Changed 'answers' to 'answer', 'hashes' to 'hash' for consistency.
This commit is contained in:
Paul Ferrell 2016-10-18 13:29:41 -06:00
parent f2c12aa3ea
commit 66bf05f213
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
puzzles.py
View File

@ -46,7 +46,6 @@ class Puzzle:
REQUIRED_KEYS = [ REQUIRED_KEYS = [
'author', 'author',
'answer', 'answer',
'points'
] ]
SINGULAR_KEYS = [ SINGULAR_KEYS = [
'name' 'name'
@ -57,7 +56,7 @@ class Puzzle:
'answer_words.txt'))] 'answer_words.txt'))]
def __init__(self, category_seed, path=None, points=None): def __init__(self, category_seed, path=None, points=None):
"""A MOTH Puzzle """A MOTH Puzzle.
:param category_seed: A byte string to use as a seed for random numbers for this puzzle. :param category_seed: A byte string to use as a seed for random numbers for this puzzle.
It is combined with the puzzle points. It is combined with the puzzle points.
:param path: An optional path to a puzzle directory. The point value for the puzzle is taken :param path: An optional path to a puzzle directory. The point value for the puzzle is taken
@ -72,6 +71,14 @@ class Puzzle:
:param points: The point value of the puzzle. Mutually exclusive with path. :param points: The point value of the puzzle. Mutually exclusive with path.
If neither of the above are given, the point value for the puzzle will have to If neither of the above are given, the point value for the puzzle will have to
be set at instantiation. be set at instantiation.
For puzzle attributes, this class acts like a dictionary that in most cases assigns
always returns a list. Certain keys, however behave differently:
- Keys in Puzzle.SINGULAR_KEYS can only have one value, and writing to these overwrites
that value.
- The keys 'hidden', 'file', and 'resource' all create a new PuzzleFile object that
gets added under the 'files' key.
- The 'answer' also adds a new hash under the the 'hash' key.
""" """
super().__init__() super().__init__()
@ -216,8 +223,8 @@ class Puzzle:
if key == 'answer': if key == 'answer':
# Handle adding answers to the puzzle # Handle adding answers to the puzzle
self._dict['hashes'].append(djb2hash(value.encode('utf8'))) self._dict['hash'].append(djb2hash(value.encode('utf8')))
self._dict['answers'].append(value) self._dict['answer'].append(value)
elif key == 'file': elif key == 'file':
# Handle adding files to the puzzle # Handle adding files to the puzzle
path = os.path.join(self._puzzle_dir, 'files', value) path = os.path.join(self._puzzle_dir, 'files', value)