Package Ganga :: Package Lib :: Package Mergers :: Module Merger :: Class CustomMerger :: Class _proxyClass
[hide private]
[frames] | no frames]

Class _proxyClass

source code

    object --+    
             |    
GPIProxyObject --+
                 |
                Lib.Mergers.Merger.CustomMerger._proxyClass

User tool for writing custom merging tools with Python
    
    Allows a script to be supplied that performs the merge of some custom file type.
    The script must be a python file which defines the following function:
    
    def mergefiles(file_list, output_file):
    
        #perform the merge
        if not success:
            return -1
        else:
            return 0
            
    This module will be imported and used by the CustomMerger. The file_list is a
    list of paths to the files to be merged. output_file is a string path for
    the output of the merge. This file must exist by the end of the merge or the
    merge will fail. If the merge cannot proceed, then the function should return a 
    non-zero integer.
    
    Clearly this tool is provided for advanced ganga usage only, and should be used with
    this in mind.
    
    

Properties:

     files        A list of files to merge.. (simple property, list,
                  default=[],comparable)

     module       Path to a python module to perform the merge.. ('files'
                  object, default=None,comparable)

     ignorefailed Jobs that are in the failed or killed states will be excluded
                  from the merge when this flag is set to True.. (simple
                  property, default=False,comparable)

     overwrite    The default behaviour for this Merger object. Will overwrite
                  output files.. (simple property, default=False,comparable)

Nested Classes [hide private]
  _impl
This is a Ganga.GPI.CustomMerger implementation class.
Instance Methods [hide private]
 
__eq__(self, x)
Equality operator (==), compare the CustomMerger properties which are declared as [comparable].
source code
 
__init__(self, *args, **kwds)
GPI CustomMerger object constructor: CustomMerger() : create custommerger with default settings; CustomMerger(c) : make a copy of c; CustomMerger(c,x=a,...): make a copy of c and set property 'x' to a, etc..
source code
 
__ne__(self, x)
Non-equality operator (!=).
source code
 
__repr__(self)
Return an short representation of CustomMerger object.
source code
 
__setattr__(self, x, v)
Set a property of CustomMerger with consistency and safety checks.
source code
 
__str__(self)
Return a printable string representing CustomMerger object as a tree of properties.
source code
 
copy(self)
Make an identical copy of self.
source code
 
merge(...) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables [hide private]
  files = <Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at...
  ignorefailed = <Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor ob...
  module = <Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object a...
  overwrite = <Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor objec...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwds)
(Constructor)

source code 

GPI CustomMerger object constructor: CustomMerger() : create custommerger with default settings; CustomMerger(c) : make a copy of c; CustomMerger(c,x=a,...): make a copy of c and set property 'x' to a, etc..

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

Return an short representation of CustomMerger object.

Overrides: object.__repr__

__setattr__(self, x, v)

source code 

Set a property of CustomMerger with consistency and safety checks. Setting a [protected] or a unexisting property raises AttributeError.

Overrides: object.__setattr__

__str__(self)
(Informal representation operator)

source code 

Return a printable string representing CustomMerger object as a tree of properties.

Overrides: object.__str__

Class Variable Details [hide private]

files

Value:
<Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at 0x17fe450>

ignorefailed

Value:
<Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at 0x17fe590>

module

Value:
<Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at 0x17fe4d0>

overwrite

Value:
<Ganga.GPIDev.Base.Proxy.ProxyDataDescriptor object at 0x17fe610>