Inheritance diagram for SubjobSplitter:

Public Member Functions
	__init__ (self, *, arguments_generator=None)

	create_subjobs (self, job)

	assign_arguments (self, job)

	__repr__ (self)

Public Attributes
	arguments_generator = arguments_generator
	The `ArgumentsGenerator` used when creating subjobs.

Detailed Description

Abstract base class. This class handles the logic of creating subjobs for a `Job` object.
The `create_subjobs` function should be implemented and used to construct
the subjobs of the parent job object.

Parameters:
    arguments_generator (ArgumentsGenerator): Used to construct the generator function that will yield the argument
        tuple for each `SubJob`. The splitter will iterate through the generator each time `create_subjobs` is
        called. The `SubJob` will be sent into the generator with ``send(subjob)`` so that the generator can decide what
        arguments to return.

Definition at line 152 of file backends.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
		*	,
			arguments_generator = None )

Derived classes should call `super` to run this.

Definition at line 165 of file backends.py.

    def __init__(self, *, arguments_generator=None):
        """
        Derived classes should call `super` to run this.
        """
        
        self.arguments_generator = arguments_generator
 

Member Function Documentation

◆ repr()

__repr__ ( self )

Definition at line 204 of file backends.py.

    def __repr__(self):
        """
        """
        return f"{self.__class__.__name__}"
 
 

◆ assign_arguments()

assign_arguments	(		self,
			job )

Use the `arguments_generator` (if one exists) to assign the argument tuples to the
subjobs.

Definition at line 178 of file backends.py.

    def assign_arguments(self, job):
        """
        Use the `arguments_generator` (if one exists) to assign the argument tuples to the
        subjobs.
        """
        if self.arguments_generator:
            arg_gen = self.arguments_generator.generator
            generating = True
            for subjob in sorted(job.subjobs.values(), key=lambda sj: sj.id):
                if generating:
                    try:
                        args = arg_gen.send(subjob)
                    except StopIteration:
                        B2ERROR(f"StopIteration called when getting args for {subjob}, "
                                "setting all subsequent subjobs to have empty argument tuples.")
                        args = tuple()  # If our generator finishes before the subjobs we use empty argument tuples
                        generating = False
                else:
                    args = tuple()
                B2DEBUG(29, f"Arguments for {subjob}: {args}")
                subjob.args = args
            return
 
        B2INFO(f"No ArgumentsGenerator assigned to the {self} so subjobs of {job} "
               "won't automatically have arguments assigned.")
 

◆ create_subjobs()

create_subjobs	(		self,
			job )

Implement this method in derived classes to generate the `SubJob` objects.

Reimplemented in ArgumentsSplitter, MaxFilesSplitter, and MaxSubjobsSplitter.

Definition at line 173 of file backends.py.

    def create_subjobs(self, job):
        """
        Implement this method in derived classes to generate the `SubJob` objects.
        """
 

Member Data Documentation

◆ arguments_generator

arguments_generator = arguments_generator

The ArgumentsGenerator used when creating subjobs.

Definition at line 170 of file backends.py.

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

calibration/scripts/caf/backends.py

Public Member Functions

Public Attributes