From 6bd9e662bd25f2f5ee32a59d6b22802711f0bd28 Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Sat, 24 Mar 2012 01:51:56 -0400 Subject: [PATCH] Renaming ``pecan.configuration.Config.as_dict`` to ``to_dict``. --- pecan/__init__.py | 2 +- pecan/configuration.py | 5 ++-- pecan/hooks.py | 2 +- pecan/tests/test_conf.py | 56 ++++++++++++++++++++-------------------- 4 files changed, 32 insertions(+), 33 deletions(-) diff --git a/pecan/__init__.py b/pecan/__init__.py index 704ce51..82812ad 100644 --- a/pecan/__init__.py +++ b/pecan/__init__.py @@ -51,7 +51,7 @@ def make_app(root, static_root=None, logging={}, debug=False, # Pass logging configuration (if it exists) on to the Python logging module if logging: if isinstance(logging, Config): - logging = logging.as_dict() + logging = logging.to_dict() if 'version' not in logging: logging['version'] = 1 load_logging_config(logging) diff --git a/pecan/configuration.py b/pecan/configuration.py index 230aec8..94dd579 100644 --- a/pecan/configuration.py +++ b/pecan/configuration.py @@ -79,8 +79,7 @@ class Config(object): def __dictify__(self, obj, prefix): ''' - Private helper method for as_dict. - **Do not use directly** + Private helper method for to_dict. ''' for k, v in obj.items(): if prefix: @@ -91,7 +90,7 @@ class Config(object): obj[k] = v return obj - def as_dict(self, prefix=None): + def to_dict(self, prefix=None): ''' Converts recursively the Config object into a valid dictionary. diff --git a/pecan/hooks.py b/pecan/hooks.py index fd7bf29..3c05296 100644 --- a/pecan/hooks.py +++ b/pecan/hooks.py @@ -256,7 +256,7 @@ class RequestViewerHook(PecanHook): self.config = {'items': self.available} else: if config.__class__.__name__ == 'Config': - self.config = config.as_dict() + self.config = config.to_dict() else: self.config = config self.writer = writer diff --git a/pecan/tests/test_conf.py b/pecan/tests/test_conf.py index 1a64905..74e9d2a 100644 --- a/pecan/tests/test_conf.py +++ b/pecan/tests/test_conf.py @@ -182,56 +182,56 @@ class TestConf(TestCase): conf = configuration.Config({'a': 1}) assert conf.get('b', True) is True - def test_config_as_dict(self): + def test_config_to_dict(self): from pecan import configuration conf = configuration.initconf() assert isinstance(conf, configuration.Config) - as_dict = conf.as_dict() + to_dict = conf.to_dict() - assert isinstance(as_dict, dict) - assert as_dict['server']['host'] == '0.0.0.0' - assert as_dict['server']['port'] == '8080' - assert as_dict['app']['modules'] == [] - assert as_dict['app']['root'] == None - assert as_dict['app']['static_root'] == 'public' - assert as_dict['app']['template_path'] == '' + assert isinstance(to_dict, dict) + assert to_dict['server']['host'] == '0.0.0.0' + assert to_dict['server']['port'] == '8080' + assert to_dict['app']['modules'] == [] + assert to_dict['app']['root'] == None + assert to_dict['app']['static_root'] == 'public' + assert to_dict['app']['template_path'] == '' - def test_config_as_dict_nested(self): + def test_config_to_dict_nested(self): from pecan import configuration """have more than one level nesting and convert to dict""" conf = configuration.initconf() nested = {'one': {'two': 2}} conf['nested'] = nested - as_dict = conf.as_dict() + to_dict = conf.to_dict() - assert isinstance(as_dict, dict) - assert as_dict['server']['host'] == '0.0.0.0' - assert as_dict['server']['port'] == '8080' - assert as_dict['app']['modules'] == [] - assert as_dict['app']['root'] == None - assert as_dict['app']['static_root'] == 'public' - assert as_dict['app']['template_path'] == '' - assert as_dict['nested']['one']['two'] == 2 + assert isinstance(to_dict, dict) + assert to_dict['server']['host'] == '0.0.0.0' + assert to_dict['server']['port'] == '8080' + assert to_dict['app']['modules'] == [] + assert to_dict['app']['root'] == None + assert to_dict['app']['static_root'] == 'public' + assert to_dict['app']['template_path'] == '' + assert to_dict['nested']['one']['two'] == 2 - def test_config_as_dict_prefixed(self): + def test_config_to_dict_prefixed(self): from pecan import configuration """Add a prefix for keys""" conf = configuration.initconf() assert isinstance(conf, configuration.Config) - as_dict = conf.as_dict('prefix_') + to_dict = conf.to_dict('prefix_') - assert isinstance(as_dict, dict) - assert as_dict['prefix_server']['prefix_host'] == '0.0.0.0' - assert as_dict['prefix_server']['prefix_port'] == '8080' - assert as_dict['prefix_app']['prefix_modules'] == [] - assert as_dict['prefix_app']['prefix_root'] == None - assert as_dict['prefix_app']['prefix_static_root'] == 'public' - assert as_dict['prefix_app']['prefix_template_path'] == '' + assert isinstance(to_dict, dict) + assert to_dict['prefix_server']['prefix_host'] == '0.0.0.0' + assert to_dict['prefix_server']['prefix_port'] == '8080' + assert to_dict['prefix_app']['prefix_modules'] == [] + assert to_dict['prefix_app']['prefix_root'] == None + assert to_dict['prefix_app']['prefix_static_root'] == 'public' + assert to_dict['prefix_app']['prefix_template_path'] == '' class TestGlobalConfig(TestCase):