python.Dso Namespace Reference

Classes
class	CxxDsoDb
class	DsoDb
class	PyDsoDb
class	RflxEnums
	classes ----------------------------------------------------------------— More...

Functions
def	_libName (lib)
def	_get_native_libname (libname)
	functions --------------------------------------------------------------— More...
def	load_library (libname)
def	find_library (libname)
def	_is_rootcint_dict (libname)
def	_to_rootmap_name (typename)
def	_to_rflx_name (typename)

Variables
string	__version__ = "$Revision: 1.12 $"
string	__author__ = "Sebastien Binet <binet@cern.ch>"
string	__doc__
list	__all__
	registry = _Dso.DsoDb()
	_aliases
	data -------------------------------------------------------------------— More...
	_typedefs
	FIXME: in waiting for a proper registration of typedefs in genreflex... More...
	_cpp_builtins
	FIXME: in waiting for a proper registration of typedefs in genreflex... More...
	_is_stl_sequence
	_is_stl_mapping
	DsoDb

Function Documentation

_get_native_libname()

def python.Dso._get_native_libname (   libname )

private

functions --------------------------------------------------------------—

helpers

return the OS-native name from an OS-indenpendent one 

Definition at line 82 of file Tools/PyUtils/python/Dso.py.

def _get_native_libname(libname):
    """ return the OS-native name from an OS-indenpendent one """
    plat = sys.platform
    if plat.count('linux')>0:
        lib_prefix,lib_suffix = 'lib', '.so'
    elif plat == 'win32':
        lib_prefix,lib_suffix = '', '.dll'
    elif plat == 'darwin':
        lib_prefix,lib_suffix = 'lib','.dylib'
    else:
        raise RuntimeError ("sorry platform [%s] is not (yet?) supported"%plat)
    _sys_libname = libname
    if not _sys_libname.startswith (lib_prefix):
        _sys_libname = ''.join([lib_prefix,_sys_libname])
    if not _sys_libname.endswith (lib_suffix):
        _sys_libname = ''.join([_sys_libname, lib_suffix])
    return _sys_libname
 

_is_rootcint_dict()

def python.Dso._is_rootcint_dict (   libname )

private

helper function to reject rootcint libraries entries from rootmap
files (which appeared w/ ROOT v21/22)
It seems all of them (and on all platforms) are named like:
 vector<char>: vector.dll

Definition at line 141 of file Tools/PyUtils/python/Dso.py.

def _is_rootcint_dict (libname):
    """helper function to reject rootcint libraries entries from rootmap
    files (which appeared w/ ROOT v21/22)
    It seems all of them (and on all platforms) are named like:
     vector<char>: vector.dll
    """
    if libname == ".dll": # pathological case...
        return False
    pat = re.compile(r'\w*?.dll')
    return not (libname.startswith("lib")) and \
           not (pat.match (libname) is None)
 

_libName()

def python.Dso._libName (   lib )

private

Definition at line 15 of file Tools/PyUtils/python/Dso.py.

def _libName(lib):
    import platform
    if platform.system() == "Linux":
        if lib[:3]  != "lib": lib = "lib"+lib
        if lib[-3:] != ".so": lib = lib+".so"
    return lib
 

_to_rflx_name()

def python.Dso._to_rflx_name (   typename )

private

helper method to massage a typename into something understandable
by reflex (which doesn't understand the same thing than rootmaps).

Definition at line 253 of file Tools/PyUtils/python/Dso.py.

def _to_rflx_name (typename):
    """helper method to massage a typename into something understandable
    by reflex (which doesn't understand the same thing than rootmaps).
    """
    global _aliases,_typedefs
    typename = typename.replace(', ',',')
    # first the easy case: builtins
    if typename in _cpp_builtins:
        return typename
    # known missing typedefs ?
    if typename in _typedefs.keys():
        t = _typedefs[typename]
        return _to_rflx_name(t)
    # handle default template arguments of STL sequences
    if _is_stl_sequence.match(typename):
        # rootmap files do not contain the default template arguments
        # for STL containers... consistency, again.
        _m = _is_stl_sequence.match (typename)
        _m_type = _m.group('TemplateArg')
        # handle the dreaded 'std::Bla<Foo<d> >
        _m_type = _to_rflx_name (_m_type.strip())
        if _m_type.endswith('>'):
            _m_type += ' '
        typename = 'std::%s<%s>' % (_m.group('ContType'), _m_type)
    typename = typename.replace('std::string>',
                                'std::basic_string<char> >')
    typename = typename.replace('std::string',
                                'std::basic_string<char>')
    return typename
 

_to_rootmap_name()

def python.Dso._to_rootmap_name (   typename )

private

helper method to massage a typename into something understandable
by the rootmap files

Definition at line 216 of file Tools/PyUtils/python/Dso.py.

def _to_rootmap_name(typename):
    """
    helper method to massage a typename into something understandable
    by the rootmap files
    """
    global _aliases
    typename = typename.replace(', ',',')
    # first the easy case: builtins
    if typename in _cpp_builtins:
        return typename
    # known missing aliases ?
    if typename in _aliases.keys():
        t = _aliases[typename]
        return _to_rootmap_name(t)
    # handle default template arguments of STL sequences
    if _is_stl_sequence.match(typename):
        # rootmap files do not contain the default template arguments
        # for STL containers... consistency, again.
        _m = _is_stl_sequence.match(typename)
        _m_type = _m.group('TemplateArg')
        # handle the dreaded 'std::Bla<Foo<d> >
        _m_type = _to_rootmap_name(_m_type.strip())
        if _m_type.endswith('>'):
            _m_type += ' '
        typename = 'std::%s<%s>' % (_m.group('ContType'),
                                    _m_type)
    # need to massage a bit the typename to match ROOT naming convention
    typename = typename.replace('std::basic_string<char> ',
                                'string ')
    typename = typename.replace('std::basic_string<char>',
                                'string')
    typename = typename.replace('std::', '')
    typename = typename.replace('> >', '>->')
    typename = typename.replace(' >', '>')
    typename = typename.replace('>->', '> >')
    return typename
 

find_library()

def python.Dso.find_library

(

libname

)

Helper function to find the (full)path to a library given its natural name.
 @return None on failure
 
usage:
 >>> find_library('AthenaServices')
 '/afs/cern.ch/.../AtlasCore/[release]/InstallArea/.../libAthenaServices.so

Definition at line 112 of file Tools/PyUtils/python/Dso.py.

def find_library(libname):
    """
    Helper function to find the (full)path to a library given its natural name.
     @return None on failure
     
    usage:
     >>> find_library('AthenaServices')
     '/afs/cern.ch/.../AtlasCore/[release]/InstallArea/.../libAthenaServices.so
    """
    import os
    
    _sys_libname = _get_native_libname(libname)
    # FIXME: REALLY not portable...
    if os.name != 'posix':
        raise RuntimeError('sorry OS [%s] is not supported' % os.name)
    
    if 'LD_LIBRARY_PATH' in os.environ:
        for d in os.environ['LD_LIBRARY_PATH'].split(os.pathsep):
            lib = os.path.join(d, _sys_libname)
            if os.path.exists(lib):
                return lib
    return
 
 

load_library()

def python.Dso.load_library

(

libname

)

Helper method to load a library by its natural name, not the OS-native name.
But if the OS-native name is given, it is safely handled too.
usage:
 >>> load_library ('AthenaServices')
 >>> load_library ('AthenaServicesDict')

Definition at line 100 of file Tools/PyUtils/python/Dso.py.

def load_library (libname):
    """
    Helper method to load a library by its natural name, not the OS-native name.
    But if the OS-native name is given, it is safely handled too.
    usage:
     >>> load_library ('AthenaServices')
     >>> load_library ('AthenaServicesDict')
    """
    _sys_libname = _get_native_libname(libname)
    import ctypes
    return ctypes.cdll.LoadLibrary (_sys_libname)
 

Variable Documentation

__all__

python.Dso.__all__

private

Initial value:

=  [
    'registry',
    ]

Definition at line 17 of file Control/AthenaServices/python/Dso.py.

__author__

python.Dso.__author__ = "Sebastien Binet <binet@cern.ch>"

private

Definition at line 11 of file Control/AthenaServices/python/Dso.py.

__doc__

string python.Dso.__doc__

private

Initial value:

=  """\
simple interface to the rootmap files to easily locate reflex dictionaries \
(and load them)
"""

Definition at line 12 of file Control/AthenaServices/python/Dso.py.

__version__

string python.Dso.__version__ = "$Revision: 1.12 $"

private

Definition at line 10 of file Control/AthenaServices/python/Dso.py.

_aliases

python.Dso._aliases

private

data -------------------------------------------------------------------—

Definition at line 23 of file Tools/PyUtils/python/Dso.py.

_cpp_builtins

python.Dso._cpp_builtins

private

FIXME: in waiting for a proper registration of typedefs in genreflex...

Definition at line 38 of file Tools/PyUtils/python/Dso.py.

_is_stl_mapping

python.Dso._is_stl_mapping

private

Definition at line 73 of file Tools/PyUtils/python/Dso.py.

_is_stl_sequence

python.Dso._is_stl_sequence

private

Definition at line 70 of file Tools/PyUtils/python/Dso.py.

_typedefs

python.Dso._typedefs

private

FIXME: in waiting for a proper registration of typedefs in genreflex...

Definition at line 32 of file Tools/PyUtils/python/Dso.py.

DsoDb

python.Dso.DsoDb

Definition at line 477 of file Tools/PyUtils/python/Dso.py.

registry

python.Dso.registry = _Dso.DsoDb()

Definition at line 158 of file Control/AthenaServices/python/Dso.py.