cpluginsvc Namespace Reference

Classes
class	Registry
class	Factory
class	Property

Functions
	_find_library ()
	registry ()
	factories ()

Variables
str	__doc__
	(c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".
tuple	__all__
dict	_lib_basename
	_lib = ctypes.CDLL(_find_library(), ctypes.RTLD_GLOBAL)
	_instance = None
list	_functions_list
	n = f[0]
	func = getattr(_lib, n)
	argtypes
	restype
	errcheck
list	GAUDI_DEFAULT_PLUGIN_PATH

Function Documentation

_find_library()

cpluginsvc._find_library ( )

protected

Locate libGaudiPluginService, searching library path env vars explicitly.

Definition at line 50 of file cpluginsvc.py.

def _find_library():
    """Locate libGaudiPluginService, searching library path env vars explicitly."""
    search_vars = (
        ["DYLD_LIBRARY_PATH", "LD_LIBRARY_PATH"]
        if platform.system() == "Darwin"
        else ["LD_LIBRARY_PATH"]
    )
    for var in search_vars:
        for directory in os.environ.get(var, "").split(os.pathsep):
            if not directory:
                continue
            candidate = os.path.join(directory, _lib_basename)
            if os.path.exists(candidate):
                return candidate
    # Fall back to bare name and let the dynamic linker resolve it
    return _lib_basename
 
 

factories()

cpluginsvc.factories

(

)

factories returns the list of components factory informations known to the plugin service

Definition at line 101 of file cpluginsvc.py.

def factories():
    """
    factories returns the list of components factory informations known to the plugin service
    """
    return registry().factories
 
 

registry()

cpluginsvc.registry

(

)

registry returns the singleton-like instance of the plugin service.

Definition at line 91 of file cpluginsvc.py.

def registry():
    """registry returns the singleton-like instance of the plugin service."""
 
    global _instance
    if _instance:
        return _instance
    _instance = _lib.cgaudi_pluginsvc_instance()
    return _instance
 
 

Variable Documentation

__all__

tuple cpluginsvc.__all__

private

Initial value:

=  (
    "Registry",
    "registry",
    "factories",
    "Factory",
    "Property",
)

Definition at line 35 of file cpluginsvc.py.

__doc__

str cpluginsvc.__doc__

private

Initial value:

=  """
cpluginsvc is a ctypes-based wrapper for the C-API of the GaudiPluginService.
 
e.g.:
 
>>> from GaudiPluginService import cpluginsvc
>>> for _,f in cpluginsvc.factories().items():
...     try:
...         f.load()
...     except Exception:
...         print ("** could not load [%s] for factory [%s]" % (f.library, f.name))
...         continue
...     print(f)
...     for k,v in f.properties.iteritems():
...         print ("\t%s: %s" % (k,v))
"""

(c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".

# # In applying this licence, CERN does not waive the privileges and immunities # granted to it by virtue of its status as an Intergovernmental Organization # or submit itself to any jurisdiction. #

Definition at line 13 of file cpluginsvc.py.

_functions_list

list cpluginsvc._functions_list

protected

Definition at line 188 of file cpluginsvc.py.

_instance

cpluginsvc._instance = None

protected

Definition at line 88 of file cpluginsvc.py.

_lib

cpluginsvc._lib = ctypes.CDLL(_find_library(), ctypes.RTLD_GLOBAL)

protected

Definition at line 68 of file cpluginsvc.py.

_lib_basename

dict cpluginsvc._lib_basename

protected

Initial value:

=  {
    "Darwin": "libGaudiPluginService.dylib",
    "Windows": "libGaudiPluginService.dll",
    "Linux": "libGaudiPluginService.so",
}[platform.system()]

Definition at line 43 of file cpluginsvc.py.

argtypes

cpluginsvc.argtypes

Definition at line 249 of file cpluginsvc.py.

errcheck

cpluginsvc.errcheck

Definition at line 252 of file cpluginsvc.py.

func

cpluginsvc.func = getattr(_lib, n)

Definition at line 248 of file cpluginsvc.py.

GAUDI_DEFAULT_PLUGIN_PATH

list cpluginsvc.GAUDI_DEFAULT_PLUGIN_PATH

Initial value:

=  [
    p
    for p in _lib.cgaudi_pluginsvc_plugin_search_path().decode().split(os.pathsep)
    if p
]

Definition at line 256 of file cpluginsvc.py.

n

cpluginsvc.n = f[0]

Definition at line 247 of file cpluginsvc.py.

restype

cpluginsvc.restype

Definition at line 250 of file cpluginsvc.py.