LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

clarified some comments and conformed some function names

Browse Source
This commit is contained in:
Andrew Brown
2012-02-05 00:20:58 -05:00
parent 324100206b
commit 50ebdd7f2c
3 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
overviewer_core/configParser.py
View File

@@ -67,7 +67,7 @@ class MultiWorldParser(object):
"""Validate and return the configuration"""
# Okay, this is okay, isn't it? We're going to create the validation
# routine right here, right now. I hope this works!
validator = settingsValidators.make_configdictvalidator(self._settings)
validator = settingsValidators.make_configDictValidator(self._settings)
# Woah. What just happened? No. WAIT, WHAT ARE YOU...
validated_config = validator(self._config_state)
# WHAT HAVE YOU DONE?

8
overviewer_core/settingsDefinition.py
View File

@@ -31,8 +31,8 @@
# appear in the resulting parsed options.
# The signature for validator callables is validator(value_given). Remember
# that the default is passed in as value_given in the event that required is
# False and default is not None.
# that the default is passed in as value_given if the user did not provide a
# value.
# This file doesn't specify the format or even the type of the setting values,
# it is up to the validators to ensure the values passed in are the right type,
@@ -61,7 +61,7 @@ __all__ = ['render', 'world', 'outputdir']
# config file.
render = Setting(required=True, default={},
validator=dictValidator(validateStr, make_configdictvalidator(
validator=make_dictValidator(validateStr, make_configDictValidator(
{
"worldname": Setting(required=True, validator=validateStr, default=None),
"dimension": Setting(required=True, validator=validateDimension, default="default"),
@@ -83,7 +83,7 @@ render = Setting(required=True, default={},
)))
# The world dict, mapping world names to world paths
world = Setting(required=True, validator=dictValidator(validateStr, validateWorldPath), default={})
world = Setting(required=True, validator=make_dictValidator(validateStr, validateWorldPath), default={})
outputdir = Setting(required=True, validator=validateOutputDir, default=None)

21
overviewer_core/settingsValidators.py
View File

@@ -133,9 +133,12 @@ def validateOutputDir(d):
raise ValidationException("You must specify a valid output directory")
return os.path.abspath(d)
def dictValidator(keyvalidator, valuevalidator):
"""Compose a dict validator by validating each key/value combination with
the given key validator and value validator
def make_dictValidator(keyvalidator, valuevalidator):
"""Compose and return a dict validator -- a validator that validates each
key and value in a dictionary.
The arguments are the validator function to use for the keys, and the
validator function to use for the values.
"""
def v(d):
@@ -145,13 +148,15 @@ def dictValidator(keyvalidator, valuevalidator):
return newd
return v
def make_configdictvalidator(config):
def make_configDictValidator(config):
"""Okay, stay with me here, this may get confusing. This function returns a
validator that validates a "configdict". This is a term I just made up to
refer to a dict where keys are strings and values are something. The
argument to /this/ function is a dictionary mapping those key names to
Setting objects. When the validator validates, it calls all the appropriate
validators to validate each item in the configdict.
refer to a dict that holds config information: keys are strings and values
are whatever that config value is. The argument to /this/ function is a
dictionary defining the valid keys for the configdict. It therefore maps
those key names to Setting objects. When the returned validator function
validates, it calls all the appropriate validators for each configdict
setting
I hope that makes sense.