indra::util::llmanifest::LLManifest Class Reference

List of all members.

Public Member Functions

def for_platform
def __init__
def default_grid
def default_channel
def construct
def exclude
def prefix
def end_prefix
def get_src_prefix
def get_dst_prefix
def src_path_of
def dst_path_of
def ensure_src_dir
def ensure_dst_dir
def run_command
def created_path
def put_in_file
def replace_in
def copy_action
def package_action
def copy_finish
def package_finish
def unpacked_finish
def cleanup_finish
def process_file
def process_directory
def includes
def remove
def ccopy
def ccopytree
def cmakedirs
def find_existing_file
def contents_of_tar
def wildcard_regex
def check_file_exists
def expand_globs
def path
def do

Public Attributes

 args
 file_list
 excludes
 actions
 src_prefix
 dst_prefix
 created_paths

Static Public Attributes

dictionary manifests = {}
tuple for_platform = classmethod(for_platform)
tuple wildcard_pattern = re.compile('\*')

Static Private Attributes

 __metaclass__ = LLManifestRegistry


Detailed Description

Definition at line 229 of file llmanifest.py.


Member Function Documentation

def indra::util::llmanifest::LLManifest::for_platform (   self,
  platform,
  arch = None 
)

Definition at line 232 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::__init__ (   self,
  srctree,
  dsttree,
  args 
)

Definition at line 238 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::default_grid (   self  ) 

Definition at line 248 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::default_channel (   self  ) 

Definition at line 250 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::construct (   self  ) 

Meant to be overriden by LLManifest implementors with code that
constructs the complete destination hierarchy.

Definition at line 253 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::exclude (   self,
  glob 
)

Excludes all files that match the glob from being included
in the file list by path().

Definition at line 258 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::prefix (   self,
  src = '',
  dst = None 
)

Pushes a prefix onto the stack.  Until end_prefix is
called, all relevant method calls (esp. to path()) will prefix
paths with the entire prefix stack.  Source and destination
prefixes can be different, though if only one is provided they
are both equal.  To specify a no-op, use an empty string, not
None.

Definition at line 263 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::end_prefix (   self,
  descr = None 
)

Pops a prefix off the stack.  If given an argument, checks
the argument against the top of the stack.  If the argument
matches neither the source or destination prefixes at the top
of the stack, then misnesting must have occurred and an
exception is raised.

Definition at line 276 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::get_src_prefix (   self  ) 

Returns the current source prefix.

Definition at line 288 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::get_dst_prefix (   self  ) 

Returns the current destination prefix.

Definition at line 292 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::src_path_of (   self,
  relpath 
)

Returns the full path to a file or directory specified
relative to the source directory.

Definition at line 296 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::dst_path_of (   self,
  relpath 
)

Returns the full path to a file or directory specified
relative to the destination directory.

Definition at line 301 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::ensure_src_dir (   self,
  reldir 
)

Construct the path for a directory relative to the
source path, and ensures that it exists.  Returns the
full path.

Definition at line 306 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::ensure_dst_dir (   self,
  reldir 
)

Construct the path for a directory relative to the
destination path, and ensures that it exists.  Returns the
full path.

Definition at line 314 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::run_command (   self,
  command 
)

Runs an external command, and returns the output.  Raises
an exception if the command reurns a nonzero status code.  For
debugging/informational purpoases, prints out the command's
output as it is received.

Definition at line 322 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::created_path (   self,
  path 
)

Declare that you've created a path in order to
  a) verify that you really have created it
  b) schedule it for cleanup

Definition at line 344 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::put_in_file (   self,
  contents,
  dst 
)

Definition at line 352 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::replace_in (   self,
  src,
  dst = None,
  searchdict = {} 
)

Definition at line 358 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::copy_action (   self,
  src,
  dst 
)

Definition at line 371 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::package_action (   self,
  src,
  dst 
)

Definition at line 384 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::copy_finish (   self  ) 

Definition at line 387 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::package_finish (   self  ) 

Definition at line 390 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::unpacked_finish (   self  ) 

Definition at line 393 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::cleanup_finish (   self  ) 

Delete paths that were specified to have been created by this script

Definition at line 404 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::process_file (   self,
  src,
  dst 
)

Definition at line 410 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::process_directory (   self,
  src,
  dst 
)

Definition at line 423 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::includes (   self,
  src,
  dst 
)

Definition at line 440 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::remove (   self,
  paths 
)

Definition at line 447 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::ccopy (   self,
  src,
  dst 
)

Copy a single file or symlink.  Uses filecmp to skip copying for existing files.

Definition at line 456 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::ccopytree (   self,
  src,
  dst 
)

Direct copy of shutil.copytree with the additional
feature that the destination directory can exist.  It
is so dumb that Python doesn't come with this. Also it
implements the excludes functionality.

Definition at line 479 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::cmakedirs (   self,
  path 
)

Ensures that a directory exists, and doesn't throw an exception
if you call it on an existing directory.

Definition at line 504 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::find_existing_file (   self,
  list 
)

Definition at line 513 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::contents_of_tar (   self,
  src_tar,
  dst_dir 
)

Extracts the contents of the tarfile (specified
relative to the source prefix) into the directory
specified relative to the destination directory.

Definition at line 523 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::wildcard_regex (   self,
  src_glob,
  dst_glob 
)

Definition at line 537 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::check_file_exists (   self,
  path 
)

Definition at line 549 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::expand_globs (   self,
  src,
  dst 
)

Definition at line 556 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::path (   self,
  src,
  dst = None 
)

Definition at line 571 of file llmanifest.py.

def indra::util::llmanifest::LLManifest::do (   self,
  actions 
)

Definition at line 595 of file llmanifest.py.


Member Data Documentation

Definition at line 230 of file llmanifest.py.

Definition at line 231 of file llmanifest.py.

Definition at line 236 of file llmanifest.py.

tuple indra::util::llmanifest::LLManifest::wildcard_pattern = re.compile('\*') [static]

Definition at line 555 of file llmanifest.py.

Definition at line 240 of file llmanifest.py.

Definition at line 241 of file llmanifest.py.

Definition at line 242 of file llmanifest.py.

Definition at line 243 of file llmanifest.py.

Definition at line 244 of file llmanifest.py.

Definition at line 245 of file llmanifest.py.

Definition at line 246 of file llmanifest.py.


The documentation for this class was generated from the following file:

Generated on Fri May 16 09:42:30 2008 for SecondLife by  doxygen 1.5.5