Package fife :: Package extensions :: Package serializers :: Module xml_loader_tools
[hide private]
[frames] | no frames]

Module xml_loader_tools

source code

utilities for xml maploading process

Functions [hide private]
 
loadImportFile(loader, path, engine, debug=False)
uses XMLObjectLoader to load import files from path
source code
 
loadImportDir(loader, path, engine, debug=False)
helper function to call loadImportFile on a directory
source code
 
loadImportDirRec(loader, path, engine, debug=False)
helper function to call loadImportFile recursive on a directory
source code
 
root_subfile(masterfile, subfile)
Returns new path for given subfile (path), which is rooted against masterfile E.g.
source code
 
reverse_root_subfile(masterfile, subfile)
does inverse operation to root_subfile.
source code
 
norm_path(path)
Makes the path use '/' delimited separators.
source code
 
frange(limit1, limit2=None, increment=1.)
Range function that accepts floats (and integers).
source code

Imports: range, old_div, os, math


Function Details [hide private]

loadImportFile(loader, path, engine, debug=False)

source code 

uses XMLObjectLoader to load import files from path

Parameters:
  • path (string) - path to import file
  • debug (bool) - flag to activate / deactivate print statements

loadImportDir(loader, path, engine, debug=False)

source code 

helper function to call loadImportFile on a directory

Parameters:
  • path (string) - path to import directory
  • debug (bool) - flag to activate / deactivate print statements

loadImportDirRec(loader, path, engine, debug=False)

source code 

helper function to call loadImportFile recursive on a directory

Parameters:
  • path (string) - path to import directory
  • debug (bool) - flag to activate / deactivate print statements

root_subfile(masterfile, subfile)

source code 

Returns new path for given subfile (path), which is rooted against masterfile E.g. if masterfile is ./../foo/bar.xml and subfile is ./../foo2/subfoo.xml, returned path is ../foo2/subfoo.xml NOTE: masterfile is expected to be *file*, not directory. subfile can be either

reverse_root_subfile(masterfile, subfile)

source code 

does inverse operation to root_subfile. E.g. E.g. if masterfile is ./../foo/bar.xml and subfile is ../foo2/subfoo.xml, returned path ./../foo2/subfoo.xml Usually this function is used to convert saved paths into engine relative paths NOTE: masterfile is expected to be *file*, not directory. subfile can be either

norm_path(path)

source code 

Makes the path use '/' delimited separators. FIFE always uses these delimiters, but some os-related routines will default to os.path.sep.

frange(limit1, limit2=None, increment=1.)

source code 

Range function that accepts floats (and integers). If only one limit is specified, assumes 0 as lower limit.

Usage: frange(-2, 2, 0.1) frange(10) frange(10, increment = 0.5)

The returned value is an iterator. Use list(frange) for a list.

source: http://code.activestate.com/recipes/ 66472-frange-a-range-function-with-float-increments/

Parameters:
  • limit1 (float) - lower range limit
  • limit2 (float) - upper range limit
  • increment (float) - length of each step @rtype generator @return iterable over (limit2 - limit1) / increment steps