PyProfilingModule Class Reference

Inheritance diagram for PyProfilingModule:

Public Member Functions
	__init__ (self, module, output_file_name=None)
	initialize (self)
	event (self)
	terminate (self)
	wrapper_name (self)
	param (self)
	available_params (self)
	compose_wrapped_module_name (self, module)
	get_name (self)
	beginRun (self)
	endRun (self)

Public Attributes
str	output_file_name = self.default_output_file_name
	The output file name the results will be written into.
	profiler = cProfile.Profile()
	The used profiler instance.
	module = module
	The wrapped module.

Static Public Attributes
str	default_output_file_name = "profile.txt"
	The default name for output if none is given.

Detailed Description

Wrapper module that evaluates the computational performance of python modules.

Uses cProfile.

Attributes:
  module (basf2.Module): The wrapped module that should be profiled.
    Should be a module written in Python, since the profile interacts
    with the interpreter for the measurements, but cannot look into c++ implementations.

  output_file_name (str, optional): Path to the file where the profiling information
    shall be stored. Defaults to profile.txt.

  profiler (cProfile.Profile): Profiler instance to manage and extract the profiling statistics.

Definition at line 111 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			module,
			output_file_name = None )

Create a new PyProfilingModule wrapped around the given module
   which outputs its results to the output_file_name of given (if not, to profile.txt).

Definition at line 131 of file metamodules.py.

    def __init__(self, module, output_file_name=None):
        """Create a new PyProfilingModule wrapped around the given module
           which outputs its results to the output_file_name of given (if not, to profile.txt)."""
        super().__init__(module)
 
        
        self.output_file_name = self.default_output_file_name
 
        if output_file_name is not None:
            self.output_file_name = output_file_name
 

Member Function Documentation

available_params()

available_params ( self )

inherited

Forwards the available parameters

Definition at line 78 of file metamodules.py.

    def available_params(self):
        """Forwards the available parameters"""
        return self.module.available_params
 

beginRun()

beginRun ( self )

inherited

Begin run method of the module

Definition at line 94 of file metamodules.py.

    def beginRun(self):
        """Begin run method of the module"""
        self.module.beginRun()
 

compose_wrapped_module_name()

compose_wrapped_module_name ( self, module )

inherited

Compose a name that indicates the wrapped module.

Definition at line 82 of file metamodules.py.

    def compose_wrapped_module_name(self, module):
        """Compose a name that indicates the wrapped module."""
        return f"{self.wrapper_name}({module.name()})"
 

endRun()

endRun ( self )

inherited

End run method of the module

Definition at line 102 of file metamodules.py.

    def endRun(self):
        """End run method of the module"""
        self.module.endRun()
 

event()

event

(

self

)

Event method of the module

Reimplemented from WrapperModule.

Definition at line 148 of file metamodules.py.

    def event(self):
        """Event method of the module"""
        profiler = self.profiler
        profiler.enable()
        super().event()
        profiler.disable()
 

get_name()

get_name ( self )

inherited

Forwards the name().

Definition at line 86 of file metamodules.py.

    def get_name(self):
        """Forwards the name()."""
        return self.name()
 

initialize()

initialize

(

self

)

Initialize method of the module

Reimplemented from WrapperModule.

Definition at line 142 of file metamodules.py.

    def initialize(self):
        """Initialize method of the module"""
        
        self.profiler = cProfile.Profile()
        super().initialize()
 

param()

param ( self )

inherited

Forwards the parameters

Definition at line 73 of file metamodules.py.

    def param(self):
        """Forwards the parameters"""
        return self.module.param
 

terminate()

terminate

(

self

)

Terminate method of the module

Reimplemented from WrapperModule.

Definition at line 155 of file metamodules.py.

    def terminate(self):
        """Terminate method of the module"""
        super().terminate()
        sortby = 'cumulative'
        with open(self.output_file_name, 'w') as profile_output_file:
            profile_stats = pstats.Stats(self.profiler, stream=profile_output_file)
            profile_stats.sort_stats(sortby)
            profile_stats.print_stats()
 
 

wrapper_name()

wrapper_name ( self )

inherited

Name of the wrapper class.

Definition at line 68 of file metamodules.py.

    def wrapper_name(self):
        """Name of the wrapper class."""
        return self.__class__.__name__
 

Member Data Documentation

default_output_file_name

str default_output_file_name = "profile.txt"

static

The default name for output if none is given.

Definition at line 129 of file metamodules.py.

module

module = module

inherited

The wrapped module.

Definition at line 53 of file metamodules.py.

output_file_name

output_file_name = self.default_output_file_name

The output file name the results will be written into.

Definition at line 137 of file metamodules.py.

profiler

profiler = cProfile.Profile()

The used profiler instance.

Definition at line 145 of file metamodules.py.

---

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

• tracking/scripts/tracking/metamodules.py