parpg-core: src/parpg/settings.py annotate

annotate src/parpg/settings.py @ 24:ca8b9588bb48

Ok, this time I ACTUALLY updated the parpg-assets subrepo.

author	M. George Hansen <technopolitica@gmail.com>
date	Thu, 16 Jun 2011 15:14:10 -1000
parents	4706e0194af3
children	aa3d837024a3

rev	line source
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 #!/usr/bin/env python2
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # Copyright (C) 2011 Edwin Marshall <emarshall85@gmail.com>
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # This file is part of PARPG.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7 # PARPG is free software: you can redistribute it and/or modify
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	8 # it under the terms of the GNU General Public License as published by
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # (at your option) any later version.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12 # PARPG is distributed in the hope that it will be useful,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15 # GNU General Public License for more details.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17 # You should have received a copy of the GNU General Public License
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 # along with PARPG. If not, see <http://www.gnu.org/licenses/>.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20 """ Provides a class used for reading and writing various configurable options
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 throughout the game
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 This class produces an INI formated settings file as opposed to an XML
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 formatted one. The reason that python's built-in ConfigurationParser isn't
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 sufficient is because comments aren't preserved when writing a settings
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 file, the order in which the options are written isn't preserved, and the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 interface used with this class is arguably more convenient that
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 ConfigParser's.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30 Default Settings may be generated by envoking this module from the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 command line:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 python -m settings.py [system] [data_directory]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34 where [system] is one of local, windows, or linux (mac coming soon),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 and data_directory is the base path for the data files to be loaded.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37 Both [system] and [data_directory] are option. If omitted, both
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 default to whichever what is reasonable based on the system settings.py
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 is run on
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 import os
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 import sys
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 import platform
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46 #TODO: add logging to replace print statements
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 class Section(object):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48 """ An object that represents a section in a settings file.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 Options can be added to a section by simply assigning a value to an
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 attribute:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 section.foo = baz
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 would produce:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 [section]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 foo = baz
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 in the settings file. Options that do not exist on assignment
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 are created dynamcially.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 Values are automatically converted to the appropriate python type.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60 Options that begin and end with brackets([, ]) are converted to lists,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 and options that are double-quoted (") are converted to strings.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 Section also recognizes booleans regardless of case, in addition to the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63 literals 'yes' and 'no' of any case. Except in the case of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 double-quoted strings, extra white-space is trimmed, so you need not
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 worry. For example:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 foo = bar
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 is equivalent to :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 foo = baz
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 def __init__(self, name):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 """ Initialize a new section.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 @param name: name of the section. In the INI file, sections are surrounded
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 by brackets ([name])
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 @type name: string
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 self.name = name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 def __setattr__(self, option, value):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 """ Assign a value to an option, converting types when appropriate.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 @param option: name of the option to assign a value to.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83 @type option: string @param value: value to be assigned to the option.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 @type value: int, float, string, boolean, or list
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 value = str(value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 if value.startswith('[') and value.endswith(']'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 value = [item.strip() for item in value[1:-1].split(',')]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89 elif value.lower() == 'true' or value.lower() == 'yes':
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 value = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 elif value.lower() == 'false' or value.lower() == 'no':
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 value = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 elif value.isdigit():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 value = int(value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97 value = float(value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 except ValueError:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 # leave as string
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 self.__dict__[option] = value
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 def __getattribute__(self, option):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 """ Returns the option's value"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 # Remove leading and trailing quotes from strings that have them
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 return_value = object.__getattribute__(self, option)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 for key, value in return_value.iteritems():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 if (hasattr(value, 'split') and
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 value.startswith("\"") and value.endswith("\"")):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 return_value[key] = value[1:-1]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 except AttributeError:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 return return_value
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 @property
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 def options(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 """ Returns a dictionary of existing options """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 options = self.__dict__
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 # get rid of properties that aren't actually options
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 if options.has_key('name'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 options.pop('name')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 return options
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128 class Settings(object):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 """ An object that represents a settings file, its sectons,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 and the options defined within those sections.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 """
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	132 def __init__(self, settings_path='', system_path='', user_path='',
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	133 filename='parpg.cfg'):
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 """ initializes a new settings object. If no paths are given, they are
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 guessed based on whatever platform the script was run on.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 Examples:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 paths = ['/etc/parpg', '/home/user_name/.config/parpg']
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 settings = Settings(*paths)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 paths = {'system': '/etc/parpg',
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 'user': '/home/user_name/.config/parpg'}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143 settings = Settings(**paths)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 settings = Settings('.')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 settigns = Settings()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 @param system_path: Path to the system settings file.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150 @type system_path: string (must be a valid path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	152 @param user_path: Path to the user settings file. Options that
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 are missing from this file are propogated
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 from the system settings file and saved on
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 request
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156 @type user_path: string (must be a valid path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	158 @param suffix: Suffix of the settings file that will be generated.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159 @type suffix: string
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160 """
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	161 self.filename = filename
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162 self.settings_file = ''
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	163
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164 self.paths = {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	165 if not system_path and not user_path and not settings_path:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166 # use platform-specific values as paths
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 (self.paths['system'], self.paths['user'],
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 self.paths['settings']) = self.platform_paths()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170 # convert supplied paths to absolute paths
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171 abs_paths = [os.path.expanduser(path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 for path in [system_path, user_path, settings_path]]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 (self.paths['system'], self.paths['user'],
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174 self.paths['settings']) = abs_paths
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176 self.read()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179 def __getattr__(self, name):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	180 """ Returns a Section object to be used for assignment, creating one
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 if it doesn't exist.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 @param name: name of section to be retrieved
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 @type name: string
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186 if name in ['get', 'set']:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187 raise AttributeError("{0} is deprecated. Please consult Settings' "
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 "documentation for information on how to "
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189 "create/modify sections and their respective "
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190 "options".format(name))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192 if not self.__dict__.has_key(name):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 setattr(self, name, Section(name))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195 return getattr(self, name)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 def platform_paths(self, system=None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198 if system is None:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 system = platform.system().lower()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 if system == 'linux':
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 return (os.path.join(os.sep, 'usr', 'share', 'parpg'),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203 os.path.join(os.environ['XDG_CONFIG_HOME'], 'parpg'),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204 os.path.join(os.sep, 'etc', 'parpg'))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 elif system == 'windows':
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206 return (os.path.join(os.environ['PROGRAMFILES'], 'PARPG'),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207 os.path.join(os.environ['USERDATA'], 'PARPG'),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208 os.path.join(os.environ['PROGRAMFILES'], 'PARPG'))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210 # TODO: determine values for Mac
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 return None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 def read(self, filenames=None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214 """ Reads a settings file and populates the settings object
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215 with its sections and options. Calling this method without
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 any arguments simply re-reads the previously defined filename
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217 and paths
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219 @param filenames: name of files to be parsed.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220 @type path: string or list
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223 if filenames is None:
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	224 filenames = [os.path.join(self.paths['settings'], self.filename),
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	225 os.path.join(self.paths['user'], self.filename)]
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226 elif hasattr(filenames, 'split'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 filenames = [filenames]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229 for filename in filenames:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 section = None
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	231 if os.path.exists(filename):
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	232 try:
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	233 self.settings_file = open(filename, 'r').readlines()
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	234 except IOError as (errno, strerror):
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	235 if errno == 2:
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	236 if os.path.basename(filename).startswith('system'):
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	237 print ('{0} could not be found. Please supply a '
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	238 'different path or generate a system settings '
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	239 'file with:\n'
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	240 'python2 -m parpg.settings').format(filename)
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	241 sys.exit(1)
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	242 else:
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	243 print 'Error No. {0}: {1} {2}'.format(errno, filename, strerror)
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244 sys.exit(1)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245
11 4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	246 for line in self.settings_file:
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	247 if line.startswith('#') or line.strip() == '':
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	248 continue
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	249 elif line.startswith('[') and line.endswith(']\n'):
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	250 getattr(self, line[1:-2])
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	251 section = line[1:-2]
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	252 else:
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	253 option, value = [item.strip()
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	254 for item in line.split('=', 1)]
4706e0194af3 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	255 setattr(getattr(self, section), option, value)
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257 def write(self, filename=None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	258 """ Writes a settings file based on the settings object's
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 sections and options
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	261 @param filename: Name of file to save to. By default, this is
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	262 the user settings file.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	263 @type path: string
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	264 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	265 if filename is None:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	266 filename = os.path.join(self.paths['user'],
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	267 'user{0}'.format(self.suffix))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	268
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	269 for section in self.sections:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	270 if '[{0}]\n'.format(section) not in self.settings_file:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	271 self.settings_file.append('\n[{0}]\n'.format(section))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	272 for option, value in getattr(self, section).options.iteritems():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	273 template = '{0} = {1}\n'.format(option, value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	274 self.settings_file.append(template)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	275 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	276 start_of_section = (self.settings_file
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	277 .index('[{0}]\n'.format(section)) + 1)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	278
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	279 for option, value in getattr(self,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	280 section).options.iteritems():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	281 if hasattr(value, 'sort'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	282 value = '[{0}]'.format(', '.join(value))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	283
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	284 new_option = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	285 template = '{0} = {1}\n'.format(option, value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	286 for index, line in enumerate(self.settings_file[:]):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	287 if option in line:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	288 new_option = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	289 if str(value) not in line:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	290 self.settings_file[index] = template
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	291
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	292 break
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	293 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	294 new_option = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	295 if new_option:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	296 while self.settings_file[start_of_section].startswith('#'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	297 start_of_section += 1
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	298
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	299 self.settings_file.insert(start_of_section, template)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	300
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	301 with open(filename, 'w') as out_stream:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	302 for line in self.settings_file:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	303 out_stream.write(line)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	304
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	305 @property
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	306 def sections(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	307 """ Returns a list of existing sections"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	308 sections = self.__dict__.keys()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	309 sections.pop(sections.index('settings_file'))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	310 sections.pop(sections.index('paths'))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	311 sections.pop(sections.index('suffix'))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	312
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	313 return sections
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	314
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	315 @property
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	316 def system_path(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	317 return self.paths['system']
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	318
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	319 @property
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	320 def user_path(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	321 return self.paths['user']
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	322
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	323 @property
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	324 def settings_path(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	325 return self.paths['settings']
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	326
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	327 DEFAULT_SETTINGS = """\
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	328 [fife]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	329 #------------------------------------------------------------------------------
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	330 # Options marked with ? are untested/unknown
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	331
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	332 # Game window's title (string) DO NOT EDIT!
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	333 WindowTitle = PARPG Techdemo 2
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	334
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	335 # Icon to use for the game window's border (filename) DO NOT EDIT!
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	336 WindowIcon = window_icon.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	337
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	338 # Video driver to use. (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	339 VideoDriver = ""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	340
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	341 # Backend to use for graphics (OpenGL\|SDL)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	342 RenderBackend = OpenGL
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	343
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	344 # Run the game in fullscreen mode or not. (True\|False)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	345 FullScreen = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	346
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	347 # Screen Resolution's width. Not used if FullScreen is set to False (800\|1024\|etc)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	348 ScreenWidth = 1024
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	349
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	350 # Screen Resolution's height. Not used if FullScreen is set to False (600\|768\|etc)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	351 ScreenHeight = 768
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	352
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	353 # Screen DPI? (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	354 BitsPerPixel = 0
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	355
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	356 # ? (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	357 SDLRemoveFakeAlpha = 1
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	358
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	359 # Subdirectory to load icons from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	360 IconsPath = icons
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	361
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	362 # ? ([R, G, B])
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	363 ColorKey = [250, 0, 250]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	364
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	365 # ? (True\|False)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	366 ColorKeyEnabled = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	367
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	368 # Turn on sound effects and music (True\|False)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	369 EnableSound = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	370
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	371 # Initial volume of sound effects and music (0.0-100.0?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	372 InitialVolume = 5.0
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	373
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	374 # Characters to use to render fonts. DO NOT EDIT!
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	375 FontGlyphs = " abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?-+/():;%&`'*#=[]\""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	376
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	377 # Subdirectory to load fronts from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	378 FontsPath = fonts
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	379
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	380 # Font to load when game starts
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	381 Font = oldtypewriter.ttf
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	382
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	383 # Size of in-game fonts
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	384 DefaultFontSize = 12
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	385
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	386 # ? (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	387 LogModules = [controller]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	388
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	389 # ? (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	390 PychanDebug = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	391
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	392 # use Psyco Acceperation (True\|False)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	393 UsePsyco = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	394
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	395 # ? (?)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	396 ProfilingOn = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	397
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	398 # Lighting Model to use (0-2)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	399 Lighting = 0
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	400
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	401 [parpg]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	402 #------------------------------------------------------------------------------
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	403
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	404 # System subdirectory to load maps from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	405 MapsPath = maps
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	406
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	407 # YAML file that contains the available maps (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	408 MapsFile = maps.yaml
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	409
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	410 # Map to load when game starts (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	411 Map = Mall
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	412
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	413 # ? (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	414 AllAgentsFile = all_agents.yaml
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	415
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	416 # System subdirectory to load objects from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	417 ObjectsPath = objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	418
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	419 # YAML file that contains the database of availabel objects (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	420 ObjectDatabaseFile = object_database.yaml
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	421
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	422 # System subdirectory to load dialogues from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	423 DialoguesPath = dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	424
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	425 # System subdirectory to load quests from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	426 QuestsPath = quests
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	427
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	428 # User subdirectory to save screenshots to
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	429 ScreenshotsPath = screenshots
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	430
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	431 # User subdirectory to save games to
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	432 SavesPath = saves
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	433
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	434 # System subdirectory where gui files are loaded from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	435 GuiPath = gui
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	436
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	437 # System subdirectory where cursors are loaded from (path)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	438 CursorPath = cursors
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	439
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	440 # File to use for default cursor (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	441 CursorDefault = cursor_plain.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	442
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	443 # File to use for up cursor (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	444 CursorUp = cursor_up.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	445
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	446 # File to use for right cursor (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	447 CursorRight = cursor_right.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	448
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	449 # File to use for down cursor (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	450 CursorDown = cursor_down.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	451
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	452 # File to use for left cursor (filename)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	453 CursorLeft = cursor_left.png
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	454
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	455 # Player walk speed (digit)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	456 PCSpeed = 3\
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	457 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	458
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	459 if __name__ == '__main__':
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	460 from optparse import OptionParser
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	461
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	462 usage = "usage: %prog [options] system[, system, ...]"
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	463 parser = OptionParser(usage=usage)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	464
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	465 parser.add_option('-f', '--filename', default='system.cfg',
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	466 help='Filename of output configuration file')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	467
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	468 opts, args = parser.parse_args()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	469
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	470 with open(opts.filename, 'w') as f:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	471 for line in DEFAULT_SETTINGS:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	472 f.write(line)

Mercurial > parpg-core

annotate src/parpg/settings.py @ 24:ca8b9588bb48