python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock Class Reference

Inheritance diagram for python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock:

Collaboration diagram for python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock:

Public Member Functions
def	__init__ (self)
def	instanceName (self)
Path	get_output_path (self)
None	makeAlgs (self, config)

Detailed Description

ConfigBlock for tool properties printing.

This class handles configuration for printing tool properties to a specified
output file.

Definition at line 9 of file PrintToolConfigAlgConfig.py.

Constructor & Destructor Documentation

__init__()

def python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock.__init__

(

self

)

Definition at line 16 of file PrintToolConfigAlgConfig.py.

    def __init__(self):
        super (PrintToolConfigAlgBlock, self).__init__ ()
 
        self.addOption('OutputFile', 'tool_config.txt', type=str,
                       info="Name of the file where the tool configuration will be written.")
        self.addOption('OutputDir', None, type=str,
                       info="Directory where the output file will be written. If 'None',"
                       " the current directory of the job.")
 

Member Function Documentation

get_output_path()

Path python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock.get_output_path

(

self

)

Get the complete output file path.

Returns:
    Path object representing the full output file path.

Definition at line 29 of file PrintToolConfigAlgConfig.py.

    def get_output_path(self) -> Path:
        """Get the complete output file path.
 
        Returns:
            Path object representing the full output file path.
        """
        output_dir = self.OutputDir if self.OutputDir is not None else Path.cwd()
        return Path(output_dir) / self.OutputFile
 

instanceName()

def python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock.instanceName

(

self

)

Return the instance name for this block

Definition at line 25 of file PrintToolConfigAlgConfig.py.

    def instanceName (self) :
        """Return the instance name for this block"""
        return '' # no instance name needed for singleton block
 

makeAlgs()

None python.PrintToolConfigAlgConfig.PrintToolConfigAlgBlock.makeAlgs	(		self,
			config
	)

Create and configure the PrintToolConfigAlg algorithm.

Args:
    config: Configuration object used to create the algorithm.

Definition at line 38 of file PrintToolConfigAlgConfig.py.

    def makeAlgs(self, config) -> None:
        """Create and configure the PrintToolConfigAlg algorithm.
 
        Args:
            config: Configuration object used to create the algorithm.
        """
        if isAthena and useComponentAccumulator:
            # we leave the implementation for Athena/AthAnalysis to a future MR
            # this will be based on https://gitlab.cern.ch/atlas/athena/-/merge_requests/77616
            return
 
        alg = config.createAlgorithm('CP::PrintToolConfigAlg', 'PrintToolConfigAlg')
        alg.OutputFile = str(self.get_output_path())

---

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

• PrintToolConfigAlgConfig.py