python.atlascp Namespace Reference

Classes
class	Corrections

Functions
	_make_tool_class (tool_type_name)
	__getattr__ (name)
	configure (path, *, namespace="CP")

Variables
dict	_class_cache = {}

Function Documentation

__getattr__()

python.atlascp.__getattr__

(

name

)

Return a constructor for the named CP tool type.

Called when code accesses ``atlascp.<ToolTypeName>``. Returns a callable
that creates and initializes a ``Tool`` subclass instance.

Parameters
----------
name:
    Tool type name without namespace, e.g. "MuonEfficiencyScaleFactors".

Returns
-------
callable
    A constructor with signature
    ``(instance_name=None, /, *, namespace="CP", properties=None, rename_containers=None)``.
    ``instance_name`` is positional-only and optional; all other arguments are keyword-only.
    When omitted, an auto-generated unique name is used.

Definition at line 45 of file atlascp.py.

def __getattr__(name):
    """Return a constructor for the named CP tool type.
 
    Called when code accesses ``atlascp.<ToolTypeName>``. Returns a callable
    that creates and initializes a ``Tool`` subclass instance.
 
    Parameters
    ----------
    name:
        Tool type name without namespace, e.g. "MuonEfficiencyScaleFactors".
 
    Returns
    -------
    callable
        A constructor with signature
        ``(instance_name=None, /, *, namespace="CP", properties=None, rename_containers=None)``.
        ``instance_name`` is positional-only and optional; all other arguments are keyword-only.
        When omitted, an auto-generated unique name is used.
    """
    def constructor(instance_name=None, /, *, namespace="CP", properties=None, rename_containers=None):
        if instance_name is None:
            instance_name = f"unique{uuid.uuid4().hex[:12]}"
        type_and_name = f"{namespace}::{name}/{instance_name}"
        cls = _make_tool_class(name)
        instance = cls.__new__(cls)
        Tool.__init__(instance, type_and_name, properties=properties, rename_containers=rename_containers)
        return instance
    constructor.__name__ = name
    constructor.__qualname__ = name
    return constructor
 
 

_make_tool_class()

python.atlascp._make_tool_class ( tool_type_name )

protected

Return a named Tool subclass for tool_type_name, creating it if needed.

Parameters
----------
tool_type_name:
    The C++ class name without namespace, e.g. "MuonEfficiencyScaleFactors".

Returns
-------
type
    A subclass of Tool whose ``__name__`` equals ``tool_type_name``.
    Repeated calls with the same name return the same class object.

Definition at line 26 of file atlascp.py.

def _make_tool_class(tool_type_name):
    """Return a named Tool subclass for tool_type_name, creating it if needed.
 
    Parameters
    ----------
    tool_type_name:
        The C++ class name without namespace, e.g. "MuonEfficiencyScaleFactors".
 
    Returns
    -------
    type
        A subclass of Tool whose ``__name__`` equals ``tool_type_name``.
        Repeated calls with the same name return the same class object.
    """
    if tool_type_name not in _class_cache:
        _class_cache[tool_type_name] = type(tool_type_name, (Tool,), {})
    return _class_cache[tool_type_name]
 
 

configure()

python.atlascp.configure	(		path,
		*	,
			namespace = "CP" )

Load a TOML config file and return an initialized Corrections object.

The ``[global]`` section provides default ``rename_containers`` and
``properties``. Tool entries are defined as ``[[tool.TypeName]]`` blocks;
multiple blocks of the same type create multiple tool instances.

Parameters
----------
path:
    Path to a TOML configuration file (str or Path).
namespace:
    C++ namespace for all tools (default ``"CP"``).

Returns
-------
Corrections

Definition at line 128 of file atlascp.py.

def configure(path, *, namespace="CP"):
    """Load a TOML config file and return an initialized Corrections object.
 
    The ``[global]`` section provides default ``rename_containers`` and
    ``properties``. Tool entries are defined as ``[[tool.TypeName]]`` blocks;
    multiple blocks of the same type create multiple tool instances.
 
    Parameters
    ----------
    path:
        Path to a TOML configuration file (str or Path).
    namespace:
        C++ namespace for all tools (default ``"CP"``).
 
    Returns
    -------
    Corrections
    """
    cfg = load_config(path)
    global_cfg = cfg.get("global", {})
    tools = []
    for type_name, entries in cfg.get("tool", {}).items():
        for entry in entries:
            merged = merge_tool_config(global_cfg, entry)
            constructor = __getattr__(type_name)
            tool = constructor(
                namespace=namespace,
                properties=merged["properties"] or None,
                rename_containers=merged["rename_containers"] or None,
            )
            tools.append((type_name, tool))
    return Corrections(tools)

Variable Documentation

_class_cache

dict python.atlascp._class_cache = {}

protected

Definition at line 23 of file atlascp.py.