Public Member Functions
	__init__ (self, whichcommand, args, db)

	add_arguments (self)

	get_iovs (self)

	modify_db (self, func, func_args, whichcommand=None)

Public Attributes
str	whichcommand = whichcommand
	from whichcommand it is called (copy, delete or modify)

	db = db
	conditions_db.ConditionsDB instance

	iovfilter = ItemFilter(args)
	ItemFilter.

	num_all_iovs = None
	number of iovs before payload and revision selection

dict	past_dict = {"delete": "deleted", "modify": "modified", "copy": "copied", "create": "created"}
	Dictionary with past participles.

Protected Attributes
	_args = args
	argparse.ArgumentParser instance

Detailed Description

Class to unify common parts of b2conditionsdb iovs commands

This class defines common argparse arguments,
common filter of iovs and common multithreading

Definition at line 488 of file cli_management.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		whichcommand,
		args,
		db )

initialization, just remember the arguments or parser and the database instance

Args:
    whichcommand (str): from whichcommand it is called (copy, delete or modify)
    args (argparse.ArgumentParser): where to append new arguments
    db (conditions_db.ConditionsDB): database instance to be used

Definition at line 496 of file cli_management.py.

    def __init__(self, whichcommand, args, db):
        """initialization, just remember the arguments or parser and the database instance
 
        Args:
            whichcommand (str): from whichcommand it is called (copy, delete or modify)
            args (argparse.ArgumentParser): where to append new arguments
            db (conditions_db.ConditionsDB): database instance to be used
        """
 
        
        self.whichcommand = whichcommand
        
        self._args = args
        
        self.db = db
        
        self.iovfilter = ItemFilter(args)
        
        self.num_all_iovs = None
        
        self.past_dict = {"delete": "deleted", "modify": "modified", "copy": "copied", "create": "created"}
 

Member Function Documentation

◆ add_arguments()

add_arguments ( self )

Add arguments to the parser

Definition at line 518 of file cli_management.py.

    def add_arguments(self):
        """Add arguments to the parser"""
 
        self._args.add_argument("tag", metavar="INPUT_TAGNAME",
                                help=f"globaltag for which the the IoVs should be {self.past_dict[self.whichcommand]}")
        if self.whichcommand == "copy":
            self._args.add_argument("output", metavar="OUTPUT_TAGNAME", help="globaltag to which the the IoVs should be copied")
        if self.whichcommand == "modify":
            self._args.add_argument("new_iov", metavar="NEW_IOV", help="New iov to be set to all considered iovs."
                                    " It should be a string with 4 numbers separated by spaces."
                                    " Use * to mark the fields that should not be modified. For example"
                                    " if 7 0 * * is given the iov (7, 1, 9, 42) will become (7 0 9 42).")
        self._args.add_argument("--iov-id", default=None, type=int,
                                help="IoVid of the iov to be considered")
        self._args.add_argument(
            "--iov-pattern",
            default=None,
            help="whitespace-separated string with pattern of the iov to be considered. "
            " Use * to mark the fields that should be ignored. Valid patterns are 0 0 -1 -1"
            " (a very specific IoV),  0 * -1 -1 (any iov that starts in any run of exp 0 and ends exactly in exp -1, run -1)"
            ", * * 3 45 (any Iov ending in exp 3, run 45, regardless from where it starts).")
        self._args.add_argument("--run-range", nargs=4, default=None, type=int,
                                metavar=("FIRST_EXP", "FIRST_RUN", "FINAL_EXP", "FINAL_RUN"),
                                help="Can be four numbers to limit the run range to be considered"
                                " Only iovs overlapping, even partially, with this range will be considered.")
        self._args.add_argument("--fully-contained", action="store_true",
                                help="If given together with ``--run_range`` limit the list of payloads "
                                "to the ones fully contained in the given run range")
        if self.whichcommand == "copy":
            self._args.add_argument("--set-run-range", action="store_true",
                                    help="If given together with ``--run_range`` modify the interval of validity"
                                    " of partially overlapping iovs to be fully contained in the given run range")
        self.iovfilter.add_arguments("payloads")
        self._args.add_argument("--revision", metavar='revision', type=int,
                                help="Specify the revision of the payload to be removed")
        self._args.add_argument("--dry-run", help="Don't do anything, just print what would be done",
                                action="store_true", default=False)
        if self.whichcommand == "copy":
            self._args.add_argument("--replace", help="Modify the iovs in the output tag to avoid overlaps",
                                    action="store_true", default=False)
        self._args.add_argument("-j", type=int, default=10, dest="nprocess",
                                help="Number of concurrent threads to use.")
 

◆ get_iovs()

get_iovs ( self )

Get the iovs already filtered

Definition at line 561 of file cli_management.py.

    def get_iovs(self):
        """Get the iovs already filtered"""
        if not self.iovfilter.check_arguments():
            B2ERROR("Issue with arguments")
 
        all_iovs = self.db.get_all_iovs(
            self._args.tag,
            run_range=self._args.run_range,
            fully_contained=self._args.fully_contained,
            message=str(self.iovfilter))
        self.num_all_iovs = len(all_iovs)
        iovs_to_return = []
        for iov in all_iovs:
            if self._args.iov_id and iov.iov_id != self._args.iov_id:
                continue
            if not self.iovfilter.check(iov.name):
                continue
            if self._args.iov_pattern and not fnmatch("{} {} {} {}".format(*iov.iov),
                                                      "{} {} {} {}".format(*self._args.iov_pattern.split())):
                continue
            if self._args.revision and iov.revision != self._args.revision:
                continue
            iovs_to_return.append(iov)
        return iovs_to_return
 

◆ modify_db()

modify_db	(	self,
		func,
		func_args,
		whichcommand = None )

Modify the database using multithreading

Definition at line 586 of file cli_management.py.

    def modify_db(self, func, func_args, whichcommand=None):
        """Modify the database using multithreading"""
        if whichcommand is None:
            whichcommand = self.whichcommand
        try:
            with ThreadPoolExecutor(max_workers=self._args.nprocess) as pool:
                start = time.monotonic()
                for iov_num, _ in enumerate(pool.map(func, func_args), 1):
                    eta = (time.monotonic() - start) / iov_num * (len(func_args) - iov_num)
                    B2INFO(f"{iov_num}/{len(func_args)} iovs {self.past_dict[whichcommand]}, ETA: {eta:.1f} seconds")
        except RuntimeError:
            B2ERROR(f"Not all iovs could be {self.past_dict[whichcommand]}. This could be a server/network problem "
                    "or the destination globaltag was not writeable.")
            raise
 
 

Member Data Documentation

◆ _args

_args = args

protected

argparse.ArgumentParser instance

Definition at line 508 of file cli_management.py.

◆ db

db = db

conditions_db.ConditionsDB instance

Definition at line 510 of file cli_management.py.

◆ iovfilter

iovfilter = ItemFilter(args)

ItemFilter.

Definition at line 512 of file cli_management.py.

◆ num_all_iovs

num_all_iovs = None

number of iovs before payload and revision selection

Definition at line 514 of file cli_management.py.

◆ past_dict

dict past_dict = {"delete": "deleted", "modify": "modified", "copy": "copied", "create": "created"}

Dictionary with past participles.

Definition at line 516 of file cli_management.py.

◆ whichcommand

str whichcommand = whichcommand

from whichcommand it is called (copy, delete or modify)

Definition at line 506 of file cli_management.py.

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

framework/scripts/conditions_db/cli_management.py

Public Member Functions

Public Attributes

Protected Attributes