CdRefiner Class Reference

Inheritance diagram for CdRefiner:

Public Member Functions
	__init__ (self, wrapped_refiner, folder_name=None, groupby_addition=None)
	refine (self, harvesting_module, crops, tdirectory=None, groupby_part_name=None, groupby_value=None, *args, **kwds)
	__get__ (self, harvesting_module, cls=None)
	__call__ (self, harvesting_module, crops=None, *args, **kwds)

Public Attributes
	wrapped_refiner = wrapped_refiner
	cached value of the wrapped refiner
	folder_name = folder_name
	cached value of the folder name
	groupby_addition = groupby_addition
	cached value of the suffix for a groupby selection
	refiner_function = refiner_function
	cached copy of the instance's refiner function

Static Public Attributes
str	default_folder_name = ""
	Folder name to be used if a groupby selection is active.
str	default_groupby_addition = "_groupby_{groupby}_{groupby_value}"
	Default suffix for a groupby selection.

Detailed Description

Refiner for change-directory

Definition at line 1039 of file refiners.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			wrapped_refiner,
			folder_name = None,
			groupby_addition = None )

Constructor for this refiner

Definition at line 1047 of file refiners.py.

                 groupby_addition=None):
        """Constructor for this refiner"""
 
        ## cached value of the wrapped refiner
        self.wrapped_refiner = wrapped_refiner
        ## cached value of the folder name
        self.folder_name = folder_name
        ## cached value of the suffix for a groupby selection
        self.groupby_addition = groupby_addition
 

Member Function Documentation

__call__()

__call__ ( self, harvesting_module, crops = None, * args, ** kwds )

inherited

implementation of the function-call of the Refiner instance
     r = Refiner()
     r(harvester) # decoration
     r(harvester, crops, args, keywords) # refinement

Definition at line 55 of file refiners.py.

    def __call__(self, harvesting_module, crops=None, *args, **kwds):
        """implementation of the function-call of the Refiner instance
             r = Refiner()
             r(harvester) # decoration
             r(harvester, crops, args, keywords) # refinement
        """
        if crops is None:
            # Decoration mode
            harvesting_module.refiners.append(self)
            return harvesting_module
        else:
            # Refining mode
            return self.refine(harvesting_module, crops, *args, **kwds)
 

__get__()

__get__ ( self, harvesting_module, cls = None )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

    def __get__(self, harvesting_module, cls=None):
        """Getter of the Refiner instance"""
        if harvesting_module is None:
            # Class access
            return self
        else:
            # Instance access
            refine = self.refine
 
            def bound_call(*args, **kwds):
                return refine(harvesting_module, *args, **kwds)
            return bound_call
 

refine()

refine	(		self,
			harvesting_module,
			crops,
			tdirectory = None,
			groupby_part_name = None,
			groupby_value = None,
		*	args,
		**	kwds )

Process the change-directory

Reimplemented from Refiner.

Definition at line 1060 of file refiners.py.

               **kwds):
        """Process the change-directory"""
 
        folder_name = self.folder_name
        if folder_name is None:
            if groupby_value is not None:
                folder_name = "{groupby_addition}"
            else:
                folder_name = self.default_folder_name
 
        groupby_addition = self.groupby_addition
 
        if groupby_addition is None:
            groupby_addition = self.default_groupby_addition
 
        if groupby_part_name is None and groupby_value is None:
            groupby_addition = ""
        else:
            groupby_addition = formatter.format(groupby_addition,
                                                groupby=groupby_part_name,
                                                groupby_value=groupby_value)
 
        folder_name = formatter.format(folder_name,
                                       groupby_addition=groupby_addition,
                                       groupby=groupby_part_name,
                                       groupby_value=groupby_value)
 
        folder_name = '/'.join(root_save_name(name) for name in folder_name.split('/'))
 
        with root_cd(tdirectory):
            with root_cd(folder_name) as tdirectory:
                self.wrapped_refiner(harvesting_module,
                                     crops,
                                     tdirectory=tdirectory,
                                     groupby_part_name=groupby_part_name,
                                     groupby_value=groupby_value,
                                     *args,
                                     **kwds)
 
 

Member Data Documentation

default_folder_name

str default_folder_name = ""

static

Folder name to be used if a groupby selection is active.

Definition at line 1043 of file refiners.py.

default_groupby_addition

str default_groupby_addition = "_groupby_{groupby}_{groupby_value}"

static

Default suffix for a groupby selection.

Definition at line 1045 of file refiners.py.

folder_name

folder_name = folder_name

cached value of the folder name

Definition at line 1056 of file refiners.py.

groupby_addition

groupby_addition = groupby_addition

cached value of the suffix for a groupby selection

Definition at line 1058 of file refiners.py.

refiner_function

refiner_function = refiner_function

inherited

cached copy of the instance's refiner function

Definition at line 40 of file refiners.py.

wrapped_refiner

wrapped_refiner = wrapped_refiner

cached value of the wrapped refiner

Definition at line 1054 of file refiners.py.

---

The documentation for this class was generated from the following file:

• tracking/scripts/tracking/harvest/refiners.py