cortex/scripts/do at main · ImageEngine/cortex · GitHub

History

executable file

250 lines (192 loc) · 7.29 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

#!/usr/bin/env python2.5

##########################################################################

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

# * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

# * Redistributions in binary form must reproduce the above copyright

# notice, this list of conditions and the following disclaimer in the

# documentation and/or other materials provided with the distribution.

# * Neither the name of Image Engine Design nor the names of any

# other contributors to this software may be used to endorse or

# promote products derived from this software without specific prior

# written permission.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

##########################################################################

usage = """

Usage : do [option] [action [actionOptions]]

Examples :

do -help [action]

Print this help.

do -help action

Print specific help for the specified action.

do -help -version v action

Print specific help for the specified action.

do -listActions

List all available actions.

do -listActions actionMatch

List all actions which contain the specified string somewhere in their name.

do -listVersions action

List all available versions of the specified action.

do action -arg1 value1 -arg2 value2

Execute the specified action, passing the specified action arguments.

do -version v action -arg1 value1 -arg2 value2

Execute a specified version of an action, passing the specified arguments.

do action -arg1 value1 -arg2 value2 -save filename.ext

Execute the specified action, passing the specified action arguments and

saving the result in the specified file.

do -version v action -arg1 value1 -arg2 value2 -save filename.ext

Execute a specified version of an action, passing the specified argument

and saving the result in the specified file.

"""

import os

import sys

import StringIO

import IECore

###############################################################################

# a coupla useful functions

###############################################################################

def exitWithUsage( exitCode = 1 ) :

sys.stderr.write( usage )

sys.exit( exitCode )

def getAction( args, index ) :

"""Returns a tuple of action, newIndex where action is a loaded action

and newIndex is the index from which to continue parsing. Exits with

a helpful message on failure."""

if args[index]=="-version" :

if len( args ) < index + 3 :

exitWithUsage()

else :

actionVersion = args[index+1]

actionName = args[index+2]

newIndex = index + 3

else :

actionName = args[index]

actionVersion = None

newIndex = index + 1

if actionVersion :

try :

actionVersion = int( actionVersion )

except :

sys.stderr.write( "Version must be an integer" )

sys.exit( 1 )

if actionName[0]=="-" :

exitWithUsage()

matchingActionNames = loader.classNames( "*" + actionName )

if not len( matchingActionNames ) :

sys.stderr.write( "Action \"%s\" does not exist.\n" % actionName )

sys.exit( 1 )

elif len( matchingActionNames )>1 :

sys.stderr.write( "Action name \"%s\" is ambiguous - could be any of the following : \n" % actionName )

for n in matchingActionNames :

sys.stderr.write( "\t" + n + "\n" )

sys.exit( 1 )

else :

actionName = matchingActionNames[0]

actionVersions = loader.versions( actionName )

if not actionVersion :

actionVersion = actionVersions[-1]

if not actionVersion in actionVersions :

sys.stderr.write( "Version \"%s\" of action \"%s\" does not exist.\n" % (actionVersion, actionName) )

sys.exit( 1 )

return ( actionName, actionVersion, newIndex )

###############################################################################

# the rest

###############################################################################

# check we have at least one argument

if len( sys.argv ) < 2 :

exitWithUsage()

loader = IECore.ClassLoader.defaultOpLoader()

# do the right thing based on the first flag

if sys.argv[1]=="-help" :

if len(sys.argv)==2 :

exitWithUsage( 1 )

else :

actionName, actionVersion, newIndex = getAction( sys.argv, 2 )

if len( sys.argv ) > newIndex :

exitWithUsage()

c = loader.load( actionName, actionVersion ) ()

textIO = StringIO.StringIO()

formatter = IECore.WrappedTextFormatter( textIO )

formatter.paragraph( "Name : " + c.name + "\n" )

formatter.paragraph( c.description + "\n" )

if len( c.parameters().values() ):

formatter.heading( "Parameters" )

formatter.indent()

for p in c.parameters().values() :

IECore.formatParameterHelp( p, formatter )

formatter.unindent()

formatter.paragraph( "Path : " + c.path + " Version : " + str( c.version ) )

print textIO.getvalue()

sys.exit( 0 )

elif sys.argv[1]=="-listActions" :

if len( sys.argv )==2 :

actions = loader.classNames()

else :

actions = loader.classNames( "*" + sys.argv[2] + "*" )

for action in actions :

sys.stdout.write( action + "\n" )

sys.exit( 0 )

elif sys.argv[1]=="-listVersions" :

if len( sys.argv )!=3 :

exitWithUsage()

else :

try:

versions = loader.versions( sys.argv[2] )

except Exception, e:

print e

sys.exit( 1 )

if not len( versions ) :

sys.stderr.write( "Action \"%s\" does not exist.\n" % sys.argv[2] )

sys.exit( 1 )

for v in versions :

sys.stdout.write( str(v) + "\n" )

sys.exit( 0 )

else :

# either "action" or "-version v action"

actionName, actionVersion, nextArg = getAction( sys.argv, 1 )

action = loader.load( actionName, actionVersion )()

# if the last two flags specify saving then we need to remove them

# before parsing.

actionArgs = sys.argv[nextArg:]

saveFileName = ""

if len( actionArgs ) > 1 :

if actionArgs[-2]=="-save" or actionArgs[-2]=="-write" :

saveFileName = actionArgs[-1]

actionArgs = actionArgs[:-2]

parameters = action.parameters()

try :

IECore.ParameterParser().parse( actionArgs, parameters )

result = action()

if saveFileName :

writer = IECore.Writer.create( result, saveFileName )

if writer :

writer.write()

else :

sys.stderr.write( "ERROR : No Writer to save results of type \"%s\" as \"%s\".\n" % ( result.typeName(), saveFileName ) )

sys.exit( 1 )

else :

sys.stdout.write( str( result ) + "\n" )

except Exception, e :

sys.stderr.write( "ERROR : %s\n" % e )

sys.exit( 1 )

sys.exit( 0 )

cortex/scripts/do at main · ImageEngine/cortex · GitHub

Uh oh!

Expand file tree

Breadcrumbs

do

Latest commit

History

Breadcrumbs

do

File metadata and controls