Halberd.clues.file

Package Halberd :: Package clues :: Module file |
[hide private]
[frames] | no frames]

# Module file

source code

Utilities for clue storage.

Provides functionality needed to store clues on disk.

Classes | [hide private]
| InvalidFile The loaded file is not a valid clue file.
| ClueDir Stores clues hierarchically using the underlying filesystem.

Functions | [hide private]
save(filename, clues) Save a clues to a file. | source code
`list` |
load(filename) Load clues from file. | source code

Variables | [hide private]
| __package__ = ``'``Halberd.clues``'``

Function Details | [hide private]

### save(filename, clues) | source code
Save a clues to a file. Parameters: `filename` (`str`) - Name of the file where the clues will be written to. `clues` (`list`) - Sequence of clues to write.

### load(filename) | source code
Load clues from file. Parameters: `filename` (`str`) - Name of the files where the clues are stored. Returns: `list` Clues extracted from the file. Raises: `InvalidFile` - In case there's a problem while reinterpreting the clues.