Reference Manual

Functions
def	add_campaign

def	copy_default_templates

def	customize_default_template

def	get_first_match

def	main

Variables
tuple	required_version = (2,7)

Function Documentation

def mps_setup_new_align.add_campaign	(	campaign_file,
		campaign,
		args
	)

Adds a line with campaign information from `args` to `campaign_file`.

Arguments:
- `campaign_file`: output file
- `campaign`: name of the campaign
- `args`: command line arguments for this campaign

Definition at line 142 of file mps_setup_new_align.py.

References split.

Referenced by main().

 
 def add_campaign(campaign_file, campaign, args):
     """Adds a line with campaign information from `args` to `campaign_file`.
 
     Arguments:
     - `campaign_file`: output file
     - `campaign`: name of the campaign
     - `args`: command line arguments for this campaign
     """
 
     campaign_info = campaign.ljust(10)
     campaign_info += os.environ["USER"].ljust(12)
     campaign_info += datetime.date.today().isoformat().ljust(11)
 
     version = os.environ["CMSSW_VERSION"]
     if args.checked_out[1]:
         local_area = os.path.join(os.environ["CMSSW_BASE"], "src")
         with open(os.devnull, 'w') as devnull:
             # check which tags (-> e.g. release names) point at current commit
             p = subprocess.Popen(["git", "tag", "--points-at", "HEAD"],
                                  cwd = local_area, stdout=subprocess.PIPE,
                                  stderr=devnull)
             tags = p.communicate()[0].split()
             # check for deleted, untracked, modified files respecting .gitignore:
             p = subprocess.Popen(["git", "ls-files", "-d", "-o", "-m",
                                   "--exclude-standard"],
                                  cwd = local_area, stdout=subprocess.PIPE,
                                  stderr=devnull)
             files = p.communicate()[0].split()
             # check for staged tracked files:
             p = subprocess.Popen(["git", "diff", "--name-only", "--staged"],
                                  cwd = local_area, stdout=subprocess.PIPE,
                                  stderr=devnull)
             files.extend(p.communicate()[0].split())
         if version not in tags or len(files) != 0:
             version += " (mod.)"
 
     campaign_info += version.ljust(34)
     campaign_info += args.type.ljust(17)
     campaign_info += args.description.strip() + "\n"
 
     fcntl.flock(campaign_file, fcntl.LOCK_EX)
     campaign_file.write(campaign_info)
     fcntl.flock(campaign_file, fcntl.LOCK_UN)
 
     return campaign_info
 

split

double split

Definition: MVATrainer.cc:139

mps_setup_new_align.add_campaign

def add_campaign

Definition: mps_setup_new_align.py:142

def mps_setup_new_align.copy_default_templates	(	args,
		next_campaign
	)

Copies the default configuration templates.

Arguments:
- `args`: container with the needed information
- `next_campaign`: destination for the copy operation

Definition at line 189 of file mps_setup_new_align.py.

References customize_default_template(), and join().

Referenced by main().

 
 def copy_default_templates(args, next_campaign):
     """Copies the default configuration templates.
 
     Arguments:
     - `args`: container with the needed information
     - `next_campaign`: destination for the copy operation
     """
 
     default_conf_dir = os.path.join(args.MPS_dir, "templates")
     template_files = ("universalConfigTemplate.py", "alignment_config.ini")
     for f in template_files:
         shutil.copy(os.path.join(default_conf_dir, f), next_campaign)
 
     # customize alignment_config.ini
     # - replace job name with campaign ID as initial value
     # - replace global tag with the corresponding auto GT depending on data type
     customize_default_template(os.path.join(next_campaign, "alignment_config.ini"),
                                (r"(jobname\s*[=:])(.*)", r"\1 "+next_campaign),
                                (r"(globaltag\s*[=:])(.*)",
                                 r"\1 auto:run2_"+args.type.lower()))
 
     print "    - copied default configuration templates from",
     print "'"+default_conf_dir+"'"
     print "    - please modify these template files according to your needs:",
     print ", ".join(template_files)
 

mps_setup_new_align.copy_default_templates

def copy_default_templates

Definition: mps_setup_new_align.py:189

mps_setup_new_align.customize_default_template

def customize_default_template

Definition: mps_setup_new_align.py:216

join

static std::string join(char **cmd)

Definition: RemoteFile.cc:18

def mps_setup_new_align.customize_default_template	(	file_name,
		regex_replace_pairs
	)

Replace all lines in `file_name` matching `regex_string` with
`replace_string`.
Lines starting with '#' or ';' are ignored.

Arguments:
- `file_name`: path to the file to be customized
- `regex_replace_pairs`: tuples containing a regex string and its
                         replacement

Definition at line 216 of file mps_setup_new_align.py.

Referenced by copy_default_templates().

 
 def customize_default_template(file_name, *regex_replace_pairs):
     """
     Replace all lines in `file_name` matching `regex_string` with
     `replace_string`.
     Lines starting with '#' or ';' are ignored.
 
     Arguments:
     - `file_name`: path to the file to be customized
     - `regex_replace_pairs`: tuples containing a regex string and its
                              replacement
     """
 
     comment = re.compile(r"^\s*[;#]")
     replacements = []
     for regex_string, replace_string in regex_replace_pairs:
         replacements.append((re.compile(regex_string), replace_string))
 
     customized = ""
     with open(file_name, "r") as f:
         for line in f:
             custom_line = line
             if not re.match(comment, custom_line):
                 for regex,replace_string in replacements:
                     custom_line = re.sub(regex, replace_string, custom_line)
             customized += custom_line
     with open(file_name, "w") as f:
         f.write(customized)
 

mps_setup_new_align.customize_default_template

def customize_default_template

Definition: mps_setup_new_align.py:216

def mps_setup_new_align.get_first_match	(	regex,
		directory
	)

Checks if `directory` matches `regex` and returns the first match converted
to an integer. If it does not match -1 is returned.

Arguments:
- `regex`: Regular expression to be tested against
- `directory`: name of the directory under test

Definition at line 125 of file mps_setup_new_align.py.

Referenced by main().

 
 def get_first_match(regex, directory):
     """
     Checks if `directory` matches `regex` and returns the first match converted
     to an integer. If it does not match -1 is returned.
 
     Arguments:
     - `regex`: Regular expression to be tested against
     - `directory`: name of the directory under test
     """
 
     result = regex.search(directory)
     if result is None:
         return -1
     else:
         return int(result.group(1))
 

mps_setup_new_align.get_first_match

def get_first_match

Definition: mps_setup_new_align.py:125

def mps_setup_new_align.main ( argv = None )

Main routine of the script.

Arguments:
- `argv`: arguments passed to the main routine

Definition at line 28 of file mps_setup_new_align.py.

References add_campaign(), helper.checked_out_MPS(), copy_default_templates(), get_first_match(), and join().

 
 def main(argv = None):
     """Main routine of the script.
 
     Arguments:
     - `argv`: arguments passed to the main routine
     """
 
     if argv == None:
         argv = sys.argv[1:]
 
     parser = argparse.ArgumentParser(
         description="Setup a new alignment campaign in the MPproduction area.")
     parser.add_argument("-d", "--description", dest="description", required=True,
                         help="comment to describe the purpose of the campaign")
     parser.add_argument("-t", "--data-type", dest="type", required=True,
                         metavar="TYPE", choices=["MC", "data"],
                         help="type of the input data (choices: %(choices)s)")
     parser.add_argument("-c", "--copy", dest="copy", metavar="CAMPAIGN",
                         help="input campaign (optional)")
     args = parser.parse_args(argv)
 
 
     if os.path.basename(os.path.normpath(os.getcwd())) != "MPproduction":
         print ">>> Cannot create a campaign outside of the 'MPproduction' area."
         print ">>> Please change to the 'MPproduction' directory first."
         sys.exit(1)
 
     if len(args.description.strip()) == 0:
         print ">>> Please provide a non-empty description of the campaign"
         sys.exit(1)
 
     MPS_dir = os.path.join("src", "Alignment", "MillePedeAlignmentAlgorithm")
     args.checked_out = checked_out_MPS()
     if args.checked_out[0]:
         MPS_dir = os.path.join(os.environ["CMSSW_BASE"], MPS_dir)
     else:
         MPS_dir = os.path.join(os.environ["CMSSW_RELEASE_BASE"], MPS_dir)
     args.MPS_dir = MPS_dir
 
     mp_regex = re.compile(r"mp([0-9]+).*")
     all_campaign_numbers = sorted(map(lambda x: get_first_match(mp_regex, x),
                                       os.listdir(".")))
     next_number = (0
                    if len(all_campaign_numbers) == 0
                    else sorted(all_campaign_numbers)[-1] + 1)
 
     while True:
         try:
             number_of_digits = len(str(next_number))
             number_of_digits = 4 if number_of_digits <= 4 else number_of_digits
             next_campaign = "mp{{0:0{0}d}}".format(number_of_digits)
             next_campaign = next_campaign.format(next_number)
             os.makedirs(next_campaign)
             print ">>> Created new campaign:", next_campaign
 
             campaign_list = "MP_ali_list.txt"
             with open(campaign_list, "a") as f:
                 campaign_info = add_campaign(f, next_campaign, args)
             backup_dir = ".MP_ali_list"
             try:
                 os.makedirs(backup_dir)
             except OSError as e:
                 if e.args == (17, 'File exists'):
                     pass
                 else:
                     raise
             with open(os.path.join(backup_dir, campaign_list), "a") as f:
                 fcntl.flock(f, fcntl.LOCK_EX)
                 f.write(campaign_info)
                 fcntl.flock(f, fcntl.LOCK_UN)
             print "    - updated campaign list '"+campaign_list+"'"
 
             if args.copy is None:
                 copy_default_templates(args, next_campaign)
             else:
                 copied_files = []
                 for ext in ("py", "ini", "txt"):
                     for config_file in glob.glob(args.copy+"/*."+ext):
                         copied_files.append(os.path.basename(config_file))
                         shutil.copy(config_file, next_campaign)
                 if len(copied_files) == 0:
                     print "    - no configuration files for '"+args.copy+"'"
                     copy_default_templates(args, next_campaign)
                 else:
                     print "    - copied configuration files from",
                     print "'"+args.copy+"':", ", ".join(copied_files)
 
         except OSError as e:
             if e.args == (17, 'File exists'):
                 next_number += 1 # someone created a campaign ~at the same time
                 continue
             else:
                 raise
         break
 