parpg-source: common/utils.py annotate

annotate common/utils.py @ 180:0d0422243490

The getGameEnvironment method of GameState will now return a globals dictionary where __builtins__ is disabled.

author	Beliar
date	Sat, 10 Mar 2012 13:31:47 +0100
parents	06145a6ee387
children

rev	line source
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # This program 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	2 # 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	3 # 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	4 # (at your option) any later version.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # This program 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	7 # 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	8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 # GNU General Public License for more details.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # 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	12 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # Miscellaneous game functions
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	16 import sys
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	17 import os
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	18 import fnmatch
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	19
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20 from textwrap import dedent
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	21 from contextlib import contextmanager
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	22 from parpg import vfs
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 def addPaths (*paths):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 """Adds a list of paths to sys.path. Paths are expected to use forward
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 slashes, for example '../../engine/extensions'. Slashes are converted
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 to the OS-specific equivalent.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 @type paths: ???
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29 @param paths: Paths to files?
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30 @return: None"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 for p in paths:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 if not p in sys.path:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 sys.path.append(os.path.sep.join(p.split('/')))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 def parseBool(value):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 """Parses a string to get a boolean value"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37 if (value.isdigit()):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 return bool(int(value))
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 elif (value.isalpha):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 return value.lower()[0] == "t"
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 def locateFiles(pattern, root=os.curdir):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 """Locate all files matching supplied filename pattern in and below
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 supplied root directory."""
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	46 filepaths = []
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	47 filenames = vfs.VFS.listFiles(root)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	48 for filename in fnmatch.filter(filenames, pattern):
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	49 vfs_file_path = '/'.join([root, filename])
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	50 filepaths.append(vfs_file_path)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	51 dirnames = vfs.VFS.listDirectories(root)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	52 for dirname in dirnames:
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	53 subdir_filepaths = locateFiles(pattern, '/'.join([root, dirname]))
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	54 filepaths.extend(subdir_filepaths)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	55 return filepaths
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 def dedent_chomp(string):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58 """Remove common leading whitespace and chomp each non-blank line."""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 dedented_string = dedent(string).strip()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60 lines = dedented_string.splitlines()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 formatted_lines = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 for index in range(len(lines)):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63 line = lines[index]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 if index == len(lines) - 1:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 # Don't do anything to the last line.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 elif not line or line.isspace():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 line = '\n\n'
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 line = ''.join([line, ' '])
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 formatted_lines.append(line)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72 result = ''.join(formatted_lines)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 return result
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	74
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	75 @contextmanager
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	76 def cwd(dirname):
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	77 cwd = os.getcwd()
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	78
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	79 try:
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	80 os.chdir(dirname)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	81 yield
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	82 finally:
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	83 os.chdir(cwd)

Mercurial > parpg-source

annotate common/utils.py @ 180:0d0422243490