heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document changes to storage_system_from_config

Browse Source 
Chris suggested changing the docs for
storage_system_from_config:
- The only param is a config section.
- The format of that section is much simpler, no prefix.
This commit is contained in:
Elrond 2011-08-12 13:01:41 +02:00
parent f9b68f6efa
commit 758eb74654
1 changed files with 8 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
mediagoblin/storage.py
View File

@ -15,7 +15,6 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
import os import os
import re
import shutil import shutil
import urlparse import urlparse
import uuid import uuid
@ -443,29 +442,25 @@ def clean_listy_filepath(listy_filepath):
return cleaned_filepath return cleaned_filepath
def storage_system_from_config(config): def storage_system_from_config(config_section):
""" """
Utility for setting up a storage system from the paste app config. Utility for setting up a storage system from a config section.
Note that a special argument may be passed in to the paste_config Note that a special argument may be passed in to
which is "${storage_prefix}_storage_class" which will provide an the config_section which is "storage_class" which will provide an
import path to a storage system. This defaults to import path to a storage system. This defaults to
"mediagoblin.storage:BasicFileStorage" if otherwise undefined. "mediagoblin.storage:BasicFileStorage" if otherwise undefined.
Arguments: Arguments:
- paste_config: dictionary of config parameters - config_section: dictionary of config parameters
- storage_prefix: the storage system we're setting up / will be
getting keys/arguments from. For example 'publicstore' will
grab all arguments that are like 'publicstore_FOO'.
Returns: Returns:
An instantiated storage system. An instantiated storage system.
Example: Example:
storage_system_from_config( storage_system_from_config(
{'publicstore_base_url': '/media/', {'base_url': '/media/',
'publicstore_base_dir': '/var/whatever/media/'}, 'base_dir': '/var/whatever/media/'})
'publicstore')
Will return: Will return:
BasicFileStorage( BasicFileStorage(
@ -474,7 +469,7 @@ def storage_system_from_config(config):
""" """
# This construct is needed, because dict(config) does # This construct is needed, because dict(config) does
# not replace the variables in the config items. # not replace the variables in the config items.
config_params = dict(config.iteritems()) config_params = dict(config_section.iteritems())
if 'storage_class' in config_params: if 'storage_class' in config_params:
storage_class = config_params['storage_class'] storage_class = config_params['storage_class']