GroupByRefiner Class Reference

Inheritance diagram for GroupByRefiner:

Collaboration diagram for GroupByRefiner:

Public Member Functions
def	__init__ (self, wrapped_refiner, by=None, exclude_by=None)
def	refine (self, harvesting_module, crops, groupby_part_name=None, groupby_value=None, *args, **kwds)
def	__get__ (self, harvesting_module, cls=None)
def	__call__ (self, harvesting_module, crops=None, *args, **kwds)
def	refine (self, harvesting_module, *args, **kwds)

Public Attributes
	wrapped_refiner
	cached value of the wrapped refiner
	by
	cached value of the group-by classifier
	exclude_by
	cached value of the exclude-by classifier
	refiner_function
	cached copy of the instance's refiner function

Static Public Attributes
bool	default_exclude_by = True
	default value of the exclude-by classifier

Detailed Description

Refiner for grouping

Definition at line 939 of file refiners.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			wrapped_refiner,
			by = None,
			exclude_by = None
	)

Constructor for this refiner

Definition at line 945 of file refiners.py.

Member Function Documentation

__call__()

def __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.

__get__()

def __get__ (   self,   harvesting_module,   cls = None  )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

refine() [1/2]

def refine (   self,   harvesting_module, *  args, **  kwds  )

inherited

Apply the instance's refiner function

Definition at line 69 of file refiners.py.

refine() [2/2]

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

Process this grouping

Definition at line 959 of file refiners.py.

---

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

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