python.Helpers Namespace Reference

Classes
class	ShutUp

Functions
	MakexAODDataFrame (inputs)
	ROOTSetup (batch=True)
	release_metadata ()
str	get_release_setup (Logger logger, no_setup=False)
None	list_changed_packages (Logger logger, no_setup=False)
List[str]	warnings_count (Path file_name)

Function Documentation

get_release_setup()

str python.Helpers.get_release_setup	(	Logger	logger,
			no_setup = False )

Get release setup.

Definition at line 9 of file Tools/WorkflowTestRunner/python/Helpers.py.

def get_release_setup(logger: Logger, no_setup=False) -> str:
    """Get release setup."""
    if no_setup:
        logger.info("No release information is available when a release is not set-up.\n")
        return ""
 
    current_nightly = environ["AtlasBuildStamp"]
    release_base = environ["AtlasBuildBranch"]
    release_head = environ["AtlasVersion"]
    platform = environ["LCG_PLATFORM"]
    project = environ["AtlasProject"]
    builds_dir_search_str = f"/cvmfs/atlas-nightlies.cern.ch/repo/sw/{release_base}_{project}_{platform}/[!latest_]*/{project}/{release_head}"
    # finds all directories matching above search pattern, and sorts by modification time
    # suggest to use latest opt over dbg
    sorted_list = sorted(glob(builds_dir_search_str), key=path.getmtime)
    latest_nightly = ""
    for folder in reversed(sorted_list):
        if not glob(f"{folder}/../../{release_base}__{project}*-opt*.log"):
            continue
        latest_nightly = folder.split("/")[-3]
        break
 
    if current_nightly != latest_nightly:
        logger.info(f"Please be aware that you are not testing your tags in the latest available nightly, which is {latest_nightly}")
 
    setup = "%s,%s,%s,Athena" % (release_base, platform.replace("-", ","), current_nightly)
 
    logger.info(f"Your tags will be tested in environment {setup}")
 
    return setup
 
 

list_changed_packages()

None python.Helpers.list_changed_packages	(	Logger	logger,
			no_setup = False )

List packages that have changed.

Definition at line 41 of file Tools/WorkflowTestRunner/python/Helpers.py.

def list_changed_packages(logger: Logger, no_setup=False) -> None:
    """List packages that have changed."""
    if no_setup:
        logger.info("The list of changed packages is not available when the relase is not set-up.\n")
        return
 
    if "WorkDir_DIR" in environ:
        logger.info("Changed packages in your build to be tested:\n")
        file_path = Path(environ["WorkDir_DIR"])
        fname = file_path / "packages.txt"
        with fname.open() as fp:
            lines = fp.readlines()
            last_line = lines[-1].strip() if lines else None
            for line in lines:
                line = line.strip()
                if "#" not in line:
                    if line == last_line:
                        logger.info(f"{line}\n")
                    else:
                        logger.info(line)
    else:
        logger.warning("A release area with locally installed packages has not been setup.")
        logger.warning("quit by executing <CONTROL-C> if this is not your intention, and")
        logger.warning("source <YOUR_CMake_BUILD_AREA>/setup.sh")
        logger.warning("to pickup locally built packages in your environment.\n")
    pass
 
 

MakexAODDataFrame()

python.Helpers.MakexAODDataFrame

(

inputs

)

Helper function creating a ROOT::RDataFrame object reading xAOD files

The function returns an instance of ROOT::RDataFrame that uses
xAOD::RDataSource for reading its inputs.

Keyword arguments:
  inputs -- A single string, or a list of string selecting the input file(s)
            Note that the string(s) may contain wildcards and environment
            variables as well.

Definition at line 6 of file Control/xAODDataSource/python/Helpers.py.

def MakexAODDataFrame( inputs ):
    """Helper function creating a ROOT::RDataFrame object reading xAOD files
 
    The function returns an instance of ROOT::RDataFrame that uses
    xAOD::RDataSource for reading its inputs.
 
    Keyword arguments:
      inputs -- A single string, or a list of string selecting the input file(s)
                Note that the string(s) may contain wildcards and environment
                variables as well.
    """
 
    # Make sure that the dictionary is loaded.
    ROOT.xAOD.ROOT6_xAODDataSource_WorkAround_Dummy()
 
    # Use the C++ function for the heavy lifting.
    return ROOT.xAOD.MakeDataFrame( inputs )

release_metadata()

python.Helpers.release_metadata

(

)

Returns information about the current release based on ReleaseData

Definition at line 112 of file Tools/PyUtils/python/Helpers.py.

def release_metadata():
   """Returns information about the current release based on ReleaseData"""
 
   import configparser
   d = {
      'project name': '?',
      'release': '?',
      'base release': '?',
      'nightly release': '?',
      'nightly name': '?',
      'date': '?',
      'platform': '?',
      }
 
   for cmake_path in os.environ['CMAKE_PREFIX_PATH'].split(os.pathsep):
      release_data = os.path.join(cmake_path, 'ReleaseData')
      if os.path.exists(release_data):
         d1=d
         cfg = configparser.ConfigParser()
         try:
            cfg.read( release_data )
            if cfg.has_section( 'release_metadata' ):
               d1.update( dict( cfg.items( 'release_metadata' ) ) )
               d1['platform'] = os.getenv( '%s_PLATFORM' % d1['project name'],
                                           '?' )
               release = d1['release'].split('.')
               base_release = d1['base release'].split('.')
               if len(release)>=3 or len(base_release)>=3:
                  return d1
         except Exception:
            pass
   return d

ROOTSetup()

python.Helpers.ROOTSetup

(

batch = True

)

Do basic ROOT setup. This should be called before any other import of ROOT.

Definition at line 19 of file Tools/PyUtils/python/Helpers.py.

def ROOTSetup(batch=True):
   """
   Do basic ROOT setup. This should be called before any other import of ROOT.
   """
   from AthenaCommon.Logging import log
   log.debug('Setting ROOT batch mode to %s', batch)
 
   if batch is True:
      os.environ['ROOT_BATCH'] = '1'
   else:
      os.environ.pop('ROOT_BATCH', None)
 
 

warnings_count()

List[str] python.Helpers.warnings_count

(

Path

file_name

)

Run a WARNING helper function.

Definition at line 69 of file Tools/WorkflowTestRunner/python/Helpers.py.

def warnings_count(file_name: Path) -> List[str]:
    """Run a WARNING helper function."""
    warnings = []
    with file_name.open() as file:
        for line in file:
            if "WARNING" in line and "| WARNING |" not in line:
                warnings.append(line)
    return warnings