Makeprojects
Loading...
Searching...
No Matches
makeprojects.makerez.BuildRezFile Class Reference

Class to build rez files. More...

Inheritance diagram for makeprojects.makerez.BuildRezFile:
Collaboration diagram for makeprojects.makerez.BuildRezFile:

Public Member Functions

 __init__ (self, file_name, priority=25, configuration=None, verbose=False)
 Class to handle .rezfile.
 build (self)
 Build a rezfile using makerez.
 clean (self)
 Delete temporary files.
Public Member Functions inherited from makeprojects.build_objects.BuildObject
 __init__ (self, file_name, priority=None, configuration=None)
 Initializers for an BuildObject.
 run_command (self, cmd, verbose)
 Issue a command and return the generated BuildError.
 __repr__ (self)
 Convert the object into a string.
 __str__ (self)
 Convert the object into a string.

Public Attributes

 verbose = verbose
 Save the verbose flag.
Public Attributes inherited from makeprojects.build_objects.BuildObject
 file_name = os.path.abspath(file_name)
 Name of file to build.
 priority = int(priority)
 Numeric priorty in ascending order.
 configuration = configuration
 Configuration if applicable.

Detailed Description

Class to build rez files.

Constructor & Destructor Documentation

◆ __init__()

makeprojects.makerez.BuildRezFile.__init__ ( self,
file_name,
priority = 25,
configuration = None,
verbose = False )

Class to handle .rezfile.

Parameters
file_namePathname to the *.rezscript to build
priorityPriority to build this object
configurationConfiguration to build
verboseTrue if verbose output

Member Function Documentation

◆ build()

makeprojects.makerez.BuildRezFile.build ( self)

Build a rezfile using makerez.

  Execute the program ``makerez`` to build the script.
Returns
BuildError object

Reimplemented from makeprojects.build_objects.BuildObject.

◆ clean()

makeprojects.makerez.BuildRezFile.clean ( self)

Delete temporary files.

  This function is called by ``cleanme`` to remove temporary files.

  On exit, return 0 for no error, or a non zero error code if there was an
  error to report. None if not implemented or not applicable.
Returns
None if not implemented, otherwise an integer error code.

Reimplemented from makeprojects.build_objects.BuildObject.