Package conary :: Package build :: Module build :: Class Ant
[hide private]
[frames] | no frames]

Class Ant

source code

  action.Action --+            
                  |            
action.RecipeAction --+        
                      |        
            BuildAction --+    
                          |    
  action.Action --+       |    
                  |       |    
action.RecipeAction --+   |    
                      |   |    
    action.ShellCommand --+    
                          |    
               BuildCommand --+
                              |
                             Ant

NAME

r.Ant() - Runs c{ant}

SYNOPSIS

r.Ant(antargs, [verbose], [options], [dir])

DESCRIPTION

The r.Ant() class is called from within a Conary recipe to execute the ant utility.

KEYWORDS

The r.Ant() class accepts the following keywords, with default values shown in parentheses when applicable:

package : (None) If set, must be a string that specifies the package (package='packagename'), component (package=':componentname'), or package and component (package='packagename:componentname') in which to place the files added while executing this command. Previously-specified PackageSpec or ComponentSpec lines will override the package specification, since all package and component specifications are considered in strict order as provided by the recipe.

EXAMPLES

r.Ant('jar javadoc')

Demonstrates calling r.Ant(), with the jar and javadoc arguments to ant.

Instance Methods [hide private]
None
do(self, macros)
Method which is used if the ShellCommand instance is invoked during build
source code

Inherited from BuildCommand: __init__

Inherited from BuildAction: doAction, initManifest, missingFiles

Inherited from action.RecipeAction: doPrep, doSuggestAutoBuildReqs, init_error

Inherited from action.Action: addArgs

Inherited from action.Action (private): _applyDefaults

Class Variables [hide private]
  _actionPathBuildRequires = set(['%(antcmd)s'])
  keywords = {'dir': '', 'options': '-lib %(javadir)s', 'subdir'...
  template = '%%(cdcmd)s CLASSPATH="%%(classpath)s" %%(antcmd)s ...
The string template used to build the shell command.

Inherited from BuildAction: useExplicitManifest

Instance Variables [hide private]

Inherited from action.ShellCommand: self.command

Method Details [hide private]

do(self, macros)

source code 
Method which is used if the ShellCommand instance is invoked during build
Returns: None
None
Overrides: BuildCommand.do
(inherited documentation)

Class Variable Details [hide private]

keywords

Value:
{'dir': '',
 'options': '-lib %(javadir)s',
 'subdir': '',
 'verbose': True}

template

The string template used to build the shell command.
Value:
'%%(cdcmd)s CLASSPATH="%%(classpath)s" %%(antcmd)s %%(antoptions)s %%(\
args)s'