Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
cmdLineUtils.py File Reference

Namespaces

namespace  cmdLineUtils
 Contain utils for ROOT command line tools.

Functions

 cmdLineUtils._copyTreeSubset (sourceFile, sourcePathSplit, destFile, destPathSplit, firstEvent, lastEvent, selectionString, branchinclude, branchexclude)
 Copy a subset of the tree from (sourceFile,sourcePathSplit) to (destFile,destPathSplit) according to options in optDict.
 cmdLineUtils._copyTreeSubsets (fileName, pathSplitList, destFile, destPathSplit, first, last, selectionString, branchinclude, branchexclude)
 cmdLineUtils._getParser (theHelp, theEpilog)
 Different functions to get a parser of arguments and options.
 cmdLineUtils._keyListExtended (rootFile, pathSplitList, recursive=False)
 ROOTPRINT.
 cmdLineUtils._moveObjects (fileName, pathSplitList, destFile, destPathSplit, oneFile, interactive)
 cmdLineUtils._setBranchStatus (tree, branchSelectionString, status=0)
 ROOTEVENTSELECTOR.
 cmdLineUtils._setIgnoreLevel (level)
 Several utils.
 cmdLineUtils.changeDirectory (rootFile, pathSplit)
 Change the current directory (ROOT.gDirectory) by the corresponding (rootFile,pathSplit).
 cmdLineUtils.copyRootObject (sourceFile, sourcePathSplit, destFile, destPathSplit, oneSource, recursive, replace)
 Initialize the recursive function 'copyRootObjectRecursive', written to be as unix-like as possible.
 cmdLineUtils.copyRootObjectRecursive (sourceFile, sourcePathSplit, destFile, destPathSplit, replace, setName="")
 Copy objects from a file or directory (sourceFile,sourcePathSplit) to an other file or directory (destFile,destPathSplit).
 cmdLineUtils.createDirectory (rootFile, pathSplit)
 Add a directory named 'pathSplit[-1]' in (rootFile,pathSplit[:-1]).
 cmdLineUtils.deleteObject (rootFile, pathSplit)
 Delete the object 'pathSplit[-1]' from (rootFile,pathSplit[:-1]).
 cmdLineUtils.deleteRootObject (rootFile, pathSplit, interactive, recursive)
 Remove the object (rootFile,pathSplit) -interactive : prompt before every removal -recursive : allow directory, and ROOT file, removal.
 cmdLineUtils.dirListSort (dirList)
 Sort list of directories by their names ignoring the case.
 cmdLineUtils.fileNameListMatch (filePattern, wildcards)
 Get the list of fileName that match with objPattern.
 cmdLineUtils.fileno (file_or_fd)
 Look for 'fileno' attribute.
 cmdLineUtils.getArgs (parser)
 Set of functions to put the arguments in shape.
 cmdLineUtils.getFromDirectory (objName)
 Get the object objName from the current directory.
 cmdLineUtils.getKey (rootFile, pathSplit)
 Get the key of the corresponding object (rootFile,pathSplit).
 cmdLineUtils.getKeyList (rootFile, pathSplit)
 Get the list of keys of the directory (rootFile,pathSplit), if (rootFile,pathSplit) is not a directory then get the key in a list.
 cmdLineUtils.getParserFile (theHelp, theEpilog="")
 Get a commandline parser with the defaults of the commandline utils and a list of source files.
 cmdLineUtils.getParserSingleFile (theHelp, theEpilog="")
 Get a commandline parser with the defaults of the commandline utils and a source file or not.
 cmdLineUtils.getParserSourceDest (theHelp, theEpilog="")
 Get a commandline parser with the defaults of the commandline utils, a list of source files and a destination file.
 cmdLineUtils.getSourceDestListOptDict (parser, wildcards=True)
 Get the list of tuples of sources, create destination name, destination pathSplit and the dictionary with options.
 cmdLineUtils.getSourceListArgs (parser, wildcards=True)
 Create a list of tuples that contain source ROOT file names and lists of path in these files as well as the original arguments.
 cmdLineUtils.getSourceListOptDict (parser, wildcards=True)
 Get the list of tuples and the dictionary with options.
 cmdLineUtils.isDirectory (rootFile, pathSplit)
 Return True if the object, corresponding to (rootFile,pathSplit), inherits from TDirectory.
 cmdLineUtils.isDirectoryKey (key)
 Return True if the object, corresponding to the key, inherits from TDirectory.
 cmdLineUtils.isExisting (rootFile, pathSplit)
 Return True if the object, corresponding to (rootFile,pathSplit), exits.
 cmdLineUtils.isTHnSparseKey (key)
 Return True if the object, corresponding to the key, inherits from THnSparse.
 cmdLineUtils.isTree (rootFile, pathSplit)
 Return True if the object, corresponding to (rootFile,pathSplit), inherits from TTree.
 cmdLineUtils.isTreeKey (key)
 Return True if the object, corresponding to the key, inherits from TTree.
 cmdLineUtils.joinPathSplit (pathSplit)
 Join the pathSplit with '/'.
 cmdLineUtils.keyClassSplitter (rootFile, pathSplitList)
 Return a list of directories and a list of keys corresponding to the other objects, for rootls and rootprint use.
 cmdLineUtils.keyListSort (keyList)
 Sort list of keys by their names ignoring the case.
 cmdLineUtils.manyOccurenceRemove (pathSplitList, fileName)
 Search for double occurence of the same pathSplit and remove them.
 cmdLineUtils.openROOTFile (fileName, mode="read")
 Open the ROOT file corresponding to fileName in the corresponding mode, redirecting the output not to see missing dictionnaries.
 cmdLineUtils.openROOTFileCompress (fileName, compress, recreate)
 Open a ROOT file (like openROOTFile) with the possibility to change compression settings.
 cmdLineUtils.pathSplitListMatch (fileName, objPattern, wildcards)
 Get the list of pathSplit that match with objPattern.
 cmdLineUtils.patternToFileNameAndPathSplitList (pattern, wildcards=True)
 Get the list of tuple containing both :
 cmdLineUtils.patternToPathSplitList (fileName, pattern)
 Get the list of pathSplit of objects in the ROOT file corresponding to fileName that match with the pattern.
 cmdLineUtils.rootEventselector (sourceList, destFileName, destPathSplit, compress=None, recreate=False, first=0, last=-1, selectionString="", branchinclude="", branchexclude="")
 cmdLineUtils.rootMv (sourceList, destFileName, destPathSplit, compress=None, interactive=False, recreate=False)
 cmdLineUtils.rootPrint (sourceList, directoryOption=None, divideOption=None, drawOption="", formatOption=None, outputOption=None, sizeOption=None, styleOption=None, verboseOption=False, recursiveOption=False)
 cmdLineUtils.stderrRedirected ()
 Redirect the output from sys.stderr to os.devnull.
 cmdLineUtils.stdoutRedirected ()
 Redirect the output from sys.stdout to os.devnull.
 cmdLineUtils.streamRedirected (source=sys.stdout, destination=os.devnull)
 Redirect the output from source to destination.
 cmdLineUtils.tupleListSort (tupleList)
 Sort list of tuples by their first elements ignoring the case.

Variables

str cmdLineUtils.ASK_FILE_REMOVE = "remove '{0}' ? (y/n) : "
str cmdLineUtils.ASK_OBJECT_REMOVE = "remove '{0}' from '{1}' ? (y/n) : "
str cmdLineUtils.COMPRESS_HELP
str cmdLineUtils.DELETE_ERROR = "object {0} was not existing, so it is not deleted"
str cmdLineUtils.DEST_HELP = "path of the destination."
str cmdLineUtils.DIRECTORY_REMOVE_ERROR = "cannot remove '{0}': Is a directory"
str cmdLineUtils.FILE_REMOVE_ERROR = "cannot remove '{0}': Is a ROOT file"
 cmdLineUtils.format
 cmdLineUtils.IgnoreCommandLineOptions
str cmdLineUtils.INTERACTIVE_HELP = "prompt before every removal."
str cmdLineUtils.LOG_FORMAT = "%(levelname)s: %(message)s"
str cmdLineUtils.MANY_OCCURENCE_WARNING = "Several versions of '{0}' are present in '{1}'. Only the most recent will be considered."
str cmdLineUtils.MOVE_ERROR = "error during copy of {0}, it is not removed from {1}"
 ROOTMV.
str cmdLineUtils.OMITTING_ERROR = "{0} '{1}' will be copied but not its subdirectories (if any). Use the -r option if you need a recursive copy."
str cmdLineUtils.OVERWRITE_ERROR = "cannot overwrite non-directory '{0}' with directory '{1}'"
str cmdLineUtils.RECREATE_HELP = "recreate the destination file."
str cmdLineUtils.RECURSIVE_HELP = "recurse inside directories"
str cmdLineUtils.REPLACE_HELP = "replace object if already existing"
str cmdLineUtils.SOURCE_HELP = "path of the source."
 Help strings for ROOT command line tools.
str cmdLineUtils.SOURCES_HELP = "path of the source(s)."
str cmdLineUtils.TARGET_ERROR = "target '{0}' is not a directory"
 Several functions shared by rootcp, rootmv and rootrm.