Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update the documentation for the generator contrib

Browse source
This commit is contained in:
Vincent Le Goff 2017-07-22 11:25:55 +02:00 • committed by Griatch
parent d1dfc1062d
commit b74cc7a82f
2 changed files with 19 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
evennia/contrib/README.md
View file

@ -30,8 +30,8 @@ things you want from here into your game folder and change them there.
multiple descriptions for time and season as well as details. multiple descriptions for time and season as well as details.
* GenderSub (Griatch 2015) - Simple example (only) of storing gender * GenderSub (Griatch 2015) - Simple example (only) of storing gender
on a character and access it in an emote with a custom marker. on a character and access it in an emote with a custom marker.
* In-game Python (Vincent Le Geoff 2017) - Allow trusted builders to script * Generator (Vincent Le Goff 2017) - Simple pseudo-random generator of
objects and events using Python from in-game. strings with rules, avoiding repetitions.
* Mail (grungies1138 2016) - An in-game mail system for communication. * Mail (grungies1138 2016) - An in-game mail system for communication.
* Menu login (Griatch 2011) - A login system using menus asking * Menu login (Griatch 2011) - A login system using menus asking
for name/password rather than giving them as one command for name/password rather than giving them as one command
@ -59,6 +59,8 @@ things you want from here into your game folder and change them there.
* EGI_Client (gtaylor 2016) - Client for reporting game status * EGI_Client (gtaylor 2016) - Client for reporting game status
to the Evennia game index (games.evennia.com) to the Evennia game index (games.evennia.com)
* In-game Python (Vincent Le Goff 2017) - Allow trusted builders to script
objects and events using Python from in-game.
* Tutorial examples (Griatch 2011, 2015) - A folder of basic * Tutorial examples (Griatch 2011, 2015) - A folder of basic
example objects, commands and scripts. example objects, commands and scripts.
* Tutorial world (Griatch 2011, 2015) - A folder containing the * Tutorial world (Griatch 2011, 2015) - A folder containing the

22
evennia/contrib/generator.py
View file

@ -1,7 +1,7 @@
""" """
Pseudo-random generator and registry Pseudo-random generator and registry
Evennia contribution - Vincent-lg 2017 Evennia contribution - Vincent Le Goff 2017
This contrib can be used to generate pseudo-random strings of information This contrib can be used to generate pseudo-random strings of information
with specific criteria. You could, for instance, use it to generate with specific criteria. You could, for instance, use it to generate
@ -14,14 +14,14 @@ Here's a very simple example:
from evennia.contrib.generator import Generator from evennia.contrib.generator import Generator
# Create a generator for phone numbers # Create a generator for phone numbers
phone_generator = Generator("phone number", r"555-\d{3}-\d{4}") phone_generator = Generator("phone number", r"555-\d{3}-\d{4}")
# Generate a phone number # Generate a phone number (555-XXX-XXXX with X as numbers)
number = phone_generator.generate() number = phone_generator.generate()
# `number` will contain something like: "555-981-2207" # `number` will contain something like: "555-981-2207"
# If you call `phone_generator.generate`, it won't give the same anymore. # If you call `phone_generator.generate`, it won't give the same anymore.
phone_generator.all() phone_generator.all()
# Will return a list of all currently-used phone numbers # Will return a list of all currently-used phone numbers
phone_generator.free("555-981-2207") phone_generator.free("555-981-2207")
# The number can be generated again. # The number can be generated again
``` ```
To use it, you will need to: To use it, you will need to:
@ -107,8 +107,16 @@ class Generator(object):
to remove a generated string, or the `clear` method to remove all to remove a generated string, or the `clear` method to remove all
generated strings. generated strings.
Bear in mind, however, that while the generated strings will be
stored to avoid repetition, the generator will not concern itself
with how the string is stored on the object you use. You probably
want to create a tag to mark this object. This is outside of the scope
of this class.
""" """
# We keep the script as a class variable to optimize querying
# with multiple instandces
script = None script = None
def __init__(self, name, regex): def __init__(self, name, regex):
@ -142,7 +150,7 @@ class Generator(object):
# Analyze the regex if any # Analyze the regex if any
if regex: if regex:
self.find_elements(regex) self._find_elements(regex)
def __repr__(self): def __repr__(self):
return "<evennia.contrib.generator.Generator for {}>".format(self.name) return "<evennia.contrib.generator.Generator for {}>".format(self.name)
@ -166,7 +174,7 @@ class Generator(object):
Args: Args:
store (bool, optional): store the generated string in the script. store (bool, optional): store the generated string in the script.
keep_trying (bool, optional): keep on trying if the string already exists. keep_trying (bool, optional): keep on trying if the string is already used.
Returns: Returns:
The newly-generated string. The newly-generated string.
@ -212,7 +220,7 @@ class Generator(object):
def free(self, element): def free(self, element):
""" """
Removes a generated string from the list of stored strings. Remove a generated string from the list of stored strings.
Args: Args:
element (str): the string to remove from the list of generated strings. element (str): the string to remove from the list of generated strings.
@ -254,7 +262,7 @@ class Generator(object):
type(self).script = script type(self).script = script
return script return script
def find_elements(self, regex): def _find_elements(self, regex):
""" """
Find the elements described in the regular expression. This will Find the elements described in the regular expression. This will
analyze the provided regular expression and try to find elements. analyze the provided regular expression and try to find elements.