Module support #19
Merged
Module support #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit is the first in a series of attempts to make this project
more useful as a Python module. It adds the `namealizer.WordGenerator`
class which is fairly simple and implements all of the same
functionality available from the command line. The object is created as
follows:
wg = namealizer.WordGenerator("path_to_dictionary")
With other optional initializers of:
wordstyle -> "lowercase", "uppercase", "capitalize", "mixedcase"
separator -> Any ascii character to use as a word separator
seed -> Number to seed the PRNG with, or None to auto-generate
You can then retrieve words in one of two ways:
wg["abc"] -> returns three words where the words start with each
letter given. Raises an NoWordForLetter exception if a
word with the desired start letter doesn't exist.
wg[3] -> returns three words where each word starts with a random
letter
The `wordstyle` or `separator` can the be changed by accessing these
properties directly, such as:
wg.separator = "-"
wg.wordstyle = "uppercase"
Related to issue #6
The previous commit added a new class for using this tool as an importable module. This commit adds tests to cover that new class. Test coverage at 98%. Related to issue #6.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is intended to add better support for using this tool as an importable Python module. It is related to issue #6.