parpg-source: settings.py annotate

annotate settings.py @ 95:d67e8288e9bf

Added saveable_fields to Container.

author	KarstenBock@gmx.net
date	Tue, 27 Sep 2011 15:57:36 +0200
parents	bf1dd9c24a7e
children	76041ed90a5d

rev	line source
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 #!/usr/bin/env python2
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # Copyright (C) 2011 Edwin Marshall <emarshall85@gmail.com>
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # This file is part of PARPG.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 #
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # (at your option) any later version.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 #
7a89ea5404b1 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,
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15 # GNU General Public License for more details.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 #
7a89ea5404b1 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
7a89ea5404b1 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/>.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 throughout the game
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 ConfigParser's.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 command line:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 python -m settings.py [system] [data_directory]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33
7a89ea5404b1 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),
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 is run on
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 import os
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 import sys
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 import platform
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46 #TODO: add logging to replace print statements
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 class Section(object):
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 attribute:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 section.foo = baz
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 would produce:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 [section]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 foo = baz
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 are created dynamcially.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 Values are automatically converted to the appropriate python type.
7a89ea5404b1 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,
7a89ea5404b1 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.
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 worry. For example:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 foo = bar
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 is equivalent to :
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 foo = baz
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 def __init__(self, name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 """ Initialize a new section.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 by brackets ([name])
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 @type name: string
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 self.name = name
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 def __setattr__(self, option, value):
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81
7a89ea5404b1 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.
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 @type value: int, float, string, boolean, or list
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 value = str(value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 if value.startswith('[') and value.endswith(']'):
7a89ea5404b1 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(',')]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89 elif value.lower() == 'true' or value.lower() == 'yes':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 value = True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 elif value.lower() == 'false' or value.lower() == 'no':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 value = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 elif value.isdigit():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 value = int(value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97 value = float(value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 except ValueError:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 # leave as string
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 self.__dict__[option] = value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 def __getattribute__(self, option):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 """ Returns the option's value"""
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 return_value = object.__getattribute__(self, option)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 for key, value in return_value.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 if (hasattr(value, 'split') and
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 value.startswith("\"") and value.endswith("\"")):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 return_value[key] = value[1:-1]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 except AttributeError:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 return return_value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 @property
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 def options(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 """ Returns a dictionary of existing options """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 options = self.__dict__
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 # get rid of properties that aren't actually options
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 if options.has_key('name'):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 options.pop('name')
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 return options
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128 class Settings(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 """ An object that represents a settings file, its sectons,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 and the options defined within those sections.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 """
1 4912a6f97c52 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='',
4912a6f97c52 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 7a89ea5404b1 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
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 Examples:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 paths = ['/etc/parpg', '/home/user_name/.config/parpg']
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 settings = Settings(*paths)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 paths = {'system': '/etc/parpg',
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 'user': '/home/user_name/.config/parpg'}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143 settings = Settings(**paths)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 settings = Settings('.')
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 settigns = Settings()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 @param system_path: Path to the system settings file.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150 @type system_path: string (must be a valid path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 are missing from this file are propogated
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 from the system settings file and saved on
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 request
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156 @type user_path: string (must be a valid path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157
7a89ea5404b1 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.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159 @type suffix: string
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160 """
1 4912a6f97c52 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 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162 self.settings_file = ''
1 4912a6f97c52 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	163
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164 self.paths = {}
7a89ea5404b1 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:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166 # use platform-specific values as paths
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 (self.paths['system'], self.paths['user'],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 self.paths['settings']) = self.platform_paths()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170 # convert supplied paths to absolute paths
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171 abs_paths = [os.path.expanduser(path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 for path in [system_path, user_path, settings_path]]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 (self.paths['system'], self.paths['user'],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174 self.paths['settings']) = abs_paths
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176 self.read()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179 def __getattr__(self, name):
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 if it doesn't exist.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 @param name: name of section to be retrieved
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 @type name: string
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186 if name in ['get', 'set']:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187 raise AttributeError("{0} is deprecated. Please consult Settings' "
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 "documentation for information on how to "
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189 "create/modify sections and their respective "
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190 "options".format(name))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192 if not self.__dict__.has_key(name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 setattr(self, name, Section(name))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195 return getattr(self, name)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 def platform_paths(self, system=None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198 if system is None:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 system = platform.system().lower()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 if system == 'linux':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 return (os.path.join(os.sep, 'usr', 'share', 'parpg'),
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203 os.path.join(os.environ['XDG_CONFIG_HOME'], 'parpg'),
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204 os.path.join(os.sep, 'etc', 'parpg'))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 elif system == 'windows':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206 return (os.path.join(os.environ['PROGRAMFILES'], 'PARPG'),
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207 os.path.join(os.environ['USERDATA'], 'PARPG'),
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208 os.path.join(os.environ['PROGRAMFILES'], 'PARPG'))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210 # TODO: determine values for Mac
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 return None
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 def read(self, filenames=None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214 """ Reads a settings file and populates the settings object
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215 with its sections and options. Calling this method without
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 any arguments simply re-reads the previously defined filename
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217 and paths
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219 @param filenames: name of files to be parsed.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220 @type path: string or list
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223 if filenames is None:
1 4912a6f97c52 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),
4912a6f97c52 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 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226 elif hasattr(filenames, 'split'):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 filenames = [filenames]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229 for filename in filenames:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 section = None
1 4912a6f97c52 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):
4912a6f97c52 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	232 try:
4912a6f97c52 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()
4912a6f97c52 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):
4912a6f97c52 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:
4912a6f97c52 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'):
4912a6f97c52 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 '
4912a6f97c52 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 '
4912a6f97c52 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'
4912a6f97c52 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)
4912a6f97c52 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)
4912a6f97c52 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	242 else:
4912a6f97c52 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 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244 sys.exit(1)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245
1 4912a6f97c52 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:
4912a6f97c52 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() == '':
4912a6f97c52 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	248 continue
4912a6f97c52 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'):
4912a6f97c52 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])
4912a6f97c52 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]
4912a6f97c52 Various improvements to the build process including support for self-contained builds. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	252 else:
4912a6f97c52 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()
4912a6f97c52 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)]
4912a6f97c52 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 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257 def write(self, filename=None):
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 sections and options
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	262 the user settings file.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	263 @type path: string
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	264 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	265 if filename is None:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	266 filename = os.path.join(self.paths['user'],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	267 'user{0}'.format(self.suffix))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	268
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	269 for section in self.sections:
4 bf1dd9c24a7e Scrolling by keyboard is now possible. DomtronVox parents: 1 diff changeset	270
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	271 if '[{0}]\n'.format(section) not in self.settings_file:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	272 self.settings_file.append('\n[{0}]\n'.format(section))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	273 for option, value in getattr(self, section).options.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	274 template = '{0} = {1}\n'.format(option, value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	275 self.settings_file.append(template)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	276 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	277 start_of_section = (self.settings_file
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	278 .index('[{0}]\n'.format(section)) + 1)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	279
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	280 for option, value in getattr(self,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	281 section).options.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	282 if hasattr(value, 'sort'):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	283 value = '[{0}]'.format(', '.join(value))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	284
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	285 new_option = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	286 template = '{0} = {1}\n'.format(option, value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	287 for index, line in enumerate(self.settings_file[:]):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	288 if option in line:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	289 new_option = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	290 if str(value) not in line:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	291 self.settings_file[index] = template
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	292
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	293 break
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	294 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	295 new_option = True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	296 if new_option:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	297 while self.settings_file[start_of_section].startswith('#'):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	298 start_of_section += 1
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	299
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	300 self.settings_file.insert(start_of_section, template)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	301
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	302 with open(filename, 'w') as out_stream:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	303 for line in self.settings_file:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	304 out_stream.write(line)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	305
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	306 @property
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	307 def sections(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	308 """ Returns a list of existing sections"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	309 sections = self.__dict__.keys()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	310 sections.pop(sections.index('settings_file'))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	311 sections.pop(sections.index('paths'))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	312 sections.pop(sections.index('suffix'))
4 bf1dd9c24a7e Scrolling by keyboard is now possible. DomtronVox parents: 1 diff changeset	313 sections.pop(sections.index('filename'))
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	314
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	315 return sections
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	316
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	317 @property
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	318 def system_path(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	319 return self.paths['system']
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	320
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	321 @property
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	322 def user_path(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	323 return self.paths['user']
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	324
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	325 @property
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	326 def settings_path(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	327 return self.paths['settings']
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	328
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	329 DEFAULT_SETTINGS = """\
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	330 [fife]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	331 #------------------------------------------------------------------------------
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	332 # Options marked with ? are untested/unknown
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	333
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	334 # Game window's title (string) DO NOT EDIT!
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	335 WindowTitle = PARPG Techdemo 2
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	336
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	337 # Icon to use for the game window's border (filename) DO NOT EDIT!
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	338 WindowIcon = window_icon.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	339
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	340 # Video driver to use. (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	341 VideoDriver = ""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	342
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	343 # Backend to use for graphics (OpenGL\|SDL)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	344 RenderBackend = OpenGL
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	345
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	346 # Run the game in fullscreen mode or not. (True\|False)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	347 FullScreen = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	348
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	349 # Screen Resolution's width. Not used if FullScreen is set to False (800\|1024\|etc)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	350 ScreenWidth = 1024
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	351
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	352 # Screen Resolution's height. Not used if FullScreen is set to False (600\|768\|etc)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	353 ScreenHeight = 768
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	354
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	355 # Screen DPI? (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	356 BitsPerPixel = 0
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	357
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	358 # ? (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	359 SDLRemoveFakeAlpha = 1
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	360
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	361 # Subdirectory to load icons from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	362 IconsPath = icons
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	363
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	364 # ? ([R, G, B])
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	365 ColorKey = [250, 0, 250]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	366
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	367 # ? (True\|False)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	368 ColorKeyEnabled = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	369
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	370 # Turn on sound effects and music (True\|False)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	371 EnableSound = True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	372
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	373 # Initial volume of sound effects and music (0.0-100.0?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	374 InitialVolume = 5.0
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	375
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	376 # Characters to use to render fonts. DO NOT EDIT!
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	377 FontGlyphs = " abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?-+/():;%&`'*#=[]\""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	378
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	379 # Subdirectory to load fronts from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	380 FontsPath = fonts
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	381
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	382 # Font to load when game starts
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	383 Font = oldtypewriter.ttf
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	384
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	385 # Size of in-game fonts
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	386 DefaultFontSize = 12
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	387
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	388 # ? (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	389 LogModules = [controller]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	390
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	391 # ? (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	392 PychanDebug = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	393
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	394 # use Psyco Acceperation (True\|False)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	395 UsePsyco = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	396
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	397 # ? (?)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	398 ProfilingOn = False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	399
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	400 # Lighting Model to use (0-2)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	401 Lighting = 0
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	402
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	403 [parpg]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	404 #------------------------------------------------------------------------------
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	405
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	406 # System subdirectory to load maps from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	407 MapsPath = maps
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	408
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	409 # YAML file that contains the available maps (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	410 MapsFile = maps.yaml
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	411
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	412 # Map to load when game starts (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	413 Map = Mall
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	414
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	415 # ? (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	416 AllAgentsFile = all_agents.yaml
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	417
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	418 # System subdirectory to load objects from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	419 ObjectsPath = objects
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	420
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	421 # YAML file that contains the database of availabel objects (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	422 ObjectDatabaseFile = object_database.yaml
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	423
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	424 # System subdirectory to load dialogues from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	425 DialoguesPath = dialogue
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	426
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	427 # System subdirectory to load quests from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	428 QuestsPath = quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	429
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	430 # User subdirectory to save screenshots to
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	431 ScreenshotsPath = screenshots
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	432
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	433 # User subdirectory to save games to
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	434 SavesPath = saves
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	435
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	436 # System subdirectory where gui files are loaded from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	437 GuiPath = gui
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	438
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	439 # System subdirectory where cursors are loaded from (path)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	440 CursorPath = cursors
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	441
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	442 # File to use for default cursor (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	443 CursorDefault = cursor_plain.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	444
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	445 # File to use for up cursor (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	446 CursorUp = cursor_up.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	447
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	448 # File to use for right cursor (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	449 CursorRight = cursor_right.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	450
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	451 # File to use for down cursor (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	452 CursorDown = cursor_down.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	453
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	454 # File to use for left cursor (filename)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	455 CursorLeft = cursor_left.png
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	456
4 bf1dd9c24a7e Scrolling by keyboard is now possible. DomtronVox parents: 1 diff changeset	457 # how many pixles to move the camera per time frame (digit)
bf1dd9c24a7e Scrolling by keyboard is now possible. DomtronVox parents: 1 diff changeset	458 ScrollSpeed = 1.0
bf1dd9c24a7e Scrolling by keyboard is now possible. DomtronVox parents: 1 diff changeset	459
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	460 # Player walk speed (digit)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	461 PCSpeed = 3\
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	462 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	463
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	464 if __name__ == '__main__':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	465 from optparse import OptionParser
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	466
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	467 usage = "usage: %prog [options] system[, system, ...]"
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	468 parser = OptionParser(usage=usage)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	469
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	470 parser.add_option('-f', '--filename', default='system.cfg',
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	471 help='Filename of output configuration file')
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	472
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	473 opts, args = parser.parse_args()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	474
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	475 with open(opts.filename, 'w') as f:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	476 for line in DEFAULT_SETTINGS:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	477 f.write(line)

Mercurial > parpg-source

annotate settings.py @ 95:d67e8288e9bf