python.ids Namespace Reference

Classes
class	DefectID
class	DefectIDBitfield
class	DefectsDBIDsNamesMixin

Functions
int	choose_new_defect_id (Mapping[Union[str, int], Union[str, int]] existing_map, str defect_name, bool virtual=False)

Variables
	log

Function Documentation

choose_new_defect_id()

int python.ids.choose_new_defect_id	(	Mapping[Union[str, int], Union[str,int]]	existing_map,
		str	defect_name,
		bool	virtual = False
	)

Function to create a new defect ID.

We're abandoning the mapping of defect names to IDs (Oct 2012).
Hence here we just ask for the first open gap in ID numbers.
It works for virtual IDs as well, though via a bit of an edge case for
when none exist yet.

Definition at line 47 of file ids.py.

def choose_new_defect_id(existing_map: Mapping[Union[str, int], Union[str,int]], 
                         defect_name: str, virtual: bool = False) -> int:
    """
    Function to create a new defect ID.
 
    We're abandoning the mapping of defect names to IDs (Oct 2012).
    Hence here we just ask for the first open gap in ID numbers.
    It works for virtual IDs as well, though via a bit of an edge case for
    when none exist yet.
    """
    existing = sorted(_ for _ in existing_map.values() if not isinstance(_, str))
    if len(existing) == 0:
        newid = 0
    else:
        newid = None
        for i, v in enumerate(existing[1:]):
            if v-existing[i] > 1:
                newid = existing[i]+1
                break
        if newid is None:
            newid = existing[-1] + 1
    did = DefectID(newid)
    did.is_virtual=virtual
    log.debug("Chose new id: %r", did)
    return int(did)
 

Variable Documentation

log

python.ids.log

Definition at line 3 of file ids.py.