pyb.tasks

Package pyb :: Package tasks

[show private | hide private]

Package pyb.tasks

Task module which contains all the core tasks for Pyb.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Submodules
`java`: Tasks related to Java. `jython`: Tasks related to Jython. `py`: Python related tasks.

Function Summary
	`bunzip2(src, destfile, destdir)` Decompress a bzip2 file.
	`bzip2(src, destfile, includeFilters, excludeFilters)` Compress a file using bzip2.
	`copy(src, basedir, destdir, includeFilters, excludeFilters, debug)` Copy files and directories from one location to another.
	`delete(file, dir)` Delete the specified file or directory.
	`fail(message, task)` Force the build to fail.
	`gunzip(src, destfile, destdir)` Decompress a gzip file.
	`gzip(src, destfile)` Compress a file using gzip.
	`log(taskname, message)`
	`sleep(s)` Sleep for s seconds.
	`tar(basedir, destfile, compression, includeFilters, excludeFilters)` Create a tar archive.
	`untar(src, destdir)` Untar the specified file.
	`unzip(src, destdir)` Unzip the specified file into the given directory.
	`zip(basedir, destfile, compress, includeFilters, excludeFilters)` Create a zip archive.

Function Details

bunzip2(src, destfile=None, destdir=None)

Decompress a bzip2 file.

Either destfile or destdir must be specified.

src: The source gzip file (REQUIRED) destfile: The file to write to destdir: The directory to write to

bzip2(src='', destfile=None, includeFilters=['.*'], excludeFilters=[])

Compress a file using bzip2.

src: The source file to gzip (REQUIRED) destfile: The gzip file to write to (REQUIRED)

copy(src=None, basedir=None, destdir='', includeFilters=['.'], excludeFilters=['.CVS\\.*'], debug=False)

Copy files and directories from one location to another.

Either the src or the basedir parameters must be specified.

Parameters:: src - The source file; basedir - The base directory; destdir - The destination directory (current directory); includeFilters - Regular expression strings used to include files (All Files); excludeFilters - Regular expression strings used to exclude files; debug - Set to True to enable debugging

delete(file=None, dir=None)

Delete the specified file or directory.

Either the file or the dir must be specified.

file: The file path dir: The directory path

fail(message=None, task=None)

Force the build to fail.

message: The reason for the failure task: The name of the task

gunzip(src, destfile=None, destdir=None)

Decompress a gzip file.

Either destfile or destdir must be specified.

src: The source gzip file (REQUIRED) destfile: The file to write to destdir: The directory to write to

gzip(src=None, destfile=None)

Compress a file using gzip.

src: The source file to gzip (REQUIRED) destfile: The gzip file to write to (REQUIRED)

sleep(s)

Sleep for s seconds.

@param s Number of seconds to sleep

tar(basedir='', destfile=None, compression='none', includeFilters=['.*'], excludeFilters=[])

Create a tar archive.

basedir: The base directory (current directory) destfile: The tar file to write to (REQUIRED) compression: 'none', 'gzip' or 'bzip2' ('none') includeFilters: Regular expression Strings to include files (All files) excludeFilters: Regular expression strings to exclude files (empty list)

untar(src=None, destdir='')

Untar the specified file.

src: The source tar file destdir: The destination directory (current directory)

unzip(src, destdir)

Unzip the specified file into the given directory.

src: The source zip file destdir: The destination directory taskname: The taskname

zip(basedir='', destfile=None, compress=True, includeFilters=['.*'], excludeFilters=[])

Create a zip archive.

basedir: The base directory (current directory) destfile: The ZIP file to write to (REQUIRED) compress: Set to false to disable compression (True) includeFilters: Regular expression Strings to include files (All files) excludeFilters: Regular expression strings to exclude files (empty list)

Generated by Epydoc 2.1 on Fri Apr 23 15:39:19 2004

http://epydoc.sf.net