pythonic_coracool.cxx File Reference

#include <Python.h>
#include <CoolKernel/ChannelSelection.h>
#include <CoolKernel/IFolder.h>
#include <CoolKernel/IDatabase.h>
#include "CoralBase/Attribute.h"
#include "CoralBase/AttributeList.h"
#include "CoralBase/AttributeListSpecification.h"
#include <CoraCool/CoraCoolDatabaseSvcFactory.h>
#include <CoraCool/CoraCoolDatabaseSvc.h>
#include <CoraCool/CoraCoolDatabase.h>
#include <CoraCool/CoraCoolFolder.h>
#include <CoraCool/CoraCoolObjectIter.h>
#include <CoraCool/CoraCoolObject.h>
#include <functional>
#include <string>
#include <iostream>
#include "CxxUtils/checker_macros.h"

Go to the source code of this file.

Macros
#define	likely(x)   __builtin_expect((x),1)
#define	unlikely(x)   __builtin_expect((x),0)
#define	MAKE_FETCHER(type, converter)

Typedefs
typedef std::function< PyObject *(const AttributeList &)>	coral_attribute_fetcher_t

Functions
PyObject *	no_coral_conversion_available (const AttributeList &)
PyObject *	qr_PyString_FromBlob (const coral::Blob &blob)
PyObject *	qr_PyString_FromStdString (const string &str)
template<typename T >
const T &	fetch_attribute_data (const coral::Attribute &A)
coral_attribute_fetcher_t	create_attribute_fetcher (const char *name, const string &type_name)
bool	make_fetchers (PyObject *to_fetch, const AttributeList &attribute_list, vector< coral_attribute_fetcher_t > &payload_fetchers)
PyObject *	apply_function (PyObject *function, PyObject *object)
CoraCoolFolderPtr	fetch_coracool_folder (IDatabasePtr cooldb, const string &folder)
const cool::RecordSpecification	get_coracool_payload_spec (IDatabasePtr cooldb, const string &folder)
PyObject *	make_iov_key (PyObject *iovkey_wrapper, unsigned long long value)
PyObject *	browse_coracool (IDatabasePtr cooldb, const string &folder, ValidityKey since, ValidityKey until, const ChannelSelection &cs=ChannelSelection::all(), const char *tag="", PyObject *to_fetch=NULL, PyObject *object_converter=NULL, PyObject *inner_object_converter=NULL, PyObject *iovkey_wrapper=NULL)

Variables
	ATLAS_NO_CHECK_FILE_THREAD_SAFETY

Macro Definition Documentation

likely

#define likely

(

x

)

__builtin_expect((x),1)

Definition at line 9 of file pythonic_coracool.cxx.

MAKE_FETCHER

#define MAKE_FETCHER	(		type,
			converter
	)

Value:

      if (type_name == #type) {                                          \
          return [sname] (const AttributeList& l) -> PyObject*           \
            { return converter(fetch_attribute_data<type>(l[sname])); }; \
      }

unlikely

#define unlikely

(

x

)

__builtin_expect((x),0)

Definition at line 10 of file pythonic_coracool.cxx.

Typedef Documentation

coral_attribute_fetcher_t

typedef std::function<PyObject* (const AttributeList&)> coral_attribute_fetcher_t

Definition at line 52 of file pythonic_coracool.cxx.

Function Documentation

apply_function()

PyObject* apply_function ( PyObject *  function, PyObject *  object  )

inline

Definition at line 151 of file pythonic_coracool.cxx.

{
    // Convert object according to function, taking care of references
    // If function is null, return unmodified object
    if (!function || function == Py_None) return object;
    PyObject *old_object = object;
    PyObject *new_object = PyObject_CallObject(function, object);
    Py_DECREF(old_object);
    return new_object;
}

browse_coracool()

PyObject* browse_coracool	(	IDatabasePtr	cooldb,
		const string &	folder,
		ValidityKey	since,
		ValidityKey	until,
		const ChannelSelection &	cs = ChannelSelection::all(),
		const char *	tag = "",
		PyObject *	to_fetch = NULL,
		PyObject *	object_converter = NULL,
		PyObject *	inner_object_converter = NULL,
		PyObject *	iovkey_wrapper = NULL
	)

Definition at line 188 of file pythonic_coracool.cxx.

{
    // Browse CoraCool objects
    CoraCoolFolderPtr     coralFolder = fetch_coracool_folder(cooldb, folder);
    CoraCoolObjectIterPtr objects     = coralFolder->browseObjects(since, until, 
                                                                   cs, tag);
    
    // Number of attributes to be fetched
    const Py_ssize_t count = to_fetch ? PySequence_Size(to_fetch) : 0;
    
    PyObject* result = PyList_New(0); // List which is returned by this function
    bool first = true;                // Is this the first iteration?
    CoraCoolObject::const_iterator payload; // Current payload
    
    // List of functors which convert an Attribute into a python value
    vector<coral_attribute_fetcher_t> payload_fetchers; 
    
    // Loop over IoVs
    while (objects->hasNext())
    {
        const CoraCoolObjectPtr& object = objects->next();
        
        PyObject *py_payload_tuple = PyTuple_New(object->size());
        unsigned int payload_index = 0;
        
        // Loop over multiple payloads per record
        for (payload = object->begin(); 
             payload != object->end();
             ++payload, ++payload_index)
        {
            if (unlikely(first))
            {
                // On the first iteration, figure out the types and create
                // specialised functions for retrieving them
                first = false;
                if (!make_fetchers(to_fetch, *payload, payload_fetchers))
                    return NULL; // Failure, throw python exception from above
            }
        
            // Create a tuple for the payload and fill it from payload fetchers
            PyObject *py_payload = PyTuple_New(count);
            for (Py_ssize_t i = 0; i < count; i++)
                PyTuple_SET_ITEM(py_payload, i, payload_fetchers[i](*payload));
                
            py_payload = apply_function(inner_object_converter, py_payload);
            
            if (!py_payload)
            {
                // apply_function returned an error
                // We won't return the list to python so we need to tell python it
                // can be deleted
                Py_DECREF(py_payload_tuple);
                Py_DECREF(result);
                return NULL;
            }
                
            PyTuple_SET_ITEM(py_payload_tuple, payload_index, py_payload);
        }
        
        PyObject *one = PyTuple_New(4);
        
        PyTuple_SET_ITEM(one, 0, make_iov_key(iovkey_wrapper, object->since()));
        PyTuple_SET_ITEM(one, 1, make_iov_key(iovkey_wrapper, object->until()));
        
        PyTuple_SET_ITEM(one, 2, PyLong_FromLong(object->channelId()));
        
        // SET_ITEM steals reference, no decref needed
        PyTuple_SET_ITEM(one, 3, py_payload_tuple);
        
        one = apply_function(object_converter, one);
        if (!one)
        {
            // apply_function returned an error
            // We won't return the list to python so we need to tell python it
            // can be deleted
            Py_DECREF(result);
            return NULL;
        }
        
        PyList_Append(result, one);
        Py_DECREF(one);
    }
    
    return result;
}

create_attribute_fetcher()

coral_attribute_fetcher_t create_attribute_fetcher	(	const char *	name,
		const string &	type_name
	)

Definition at line 70 of file pythonic_coracool.cxx.

{
    // Test type against type_name. If true, return a functor for this type.
    // Be sure to use only a copy of name --- the original may not be valid
    // by the time the lambda is called.
    std::string sname = name;
    #define MAKE_FETCHER(type, converter)                                \
      if (type_name == #type) {                                          \
          return [sname] (const AttributeList& l) -> PyObject*           \
            { return converter(fetch_attribute_data<type>(l[sname])); }; \
      }
    
    // See the python c-api reference for python conversion functions
    // Python/C API Reference Manual >> Concrete Objects Layer
    // http://docs.python.org/c-api/concrete.html
    
    MAKE_FETCHER(short,     PyLong_FromLong)
    MAKE_FETCHER(int,       PyLong_FromLong)
    MAKE_FETCHER(long long, PyLong_FromLongLong)
    
    /*
    
    Types from COOL:
        We need to build up a similar list from CORAL, it would be nice to know
        where they came from.
    
    MAKE_FETCHER(Bool,      PyBool_FromLong)
    MAKE_FETCHER(Float,     PyFloat_FromDouble)
    MAKE_FETCHER(Double,    PyFloat_FromDouble)
    MAKE_FETCHER(UChar,     PyLong_FromLong)
    MAKE_FETCHER(UInt16,    PyLong_FromUnsignedLong)
    MAKE_FETCHER(UInt32,    PyLong_FromUnsignedLong)
    MAKE_FETCHER(UInt63,    PyLong_FromUnsignedLongLong)
    MAKE_FETCHER(UInt64,    PyLong_FromUnsignedLongLong)
    MAKE_FETCHER(String255, qr_PyString_FromStdString)
    MAKE_FETCHER(String4k,  qr_PyString_FromStdString)
    MAKE_FETCHER(String64k, qr_PyString_FromStdString)
    MAKE_FETCHER(String16M, qr_PyString_FromStdString)
    MAKE_FETCHER(Blob16M,   qr_PyString_FromBlob)
    MAKE_FETCHER(Blob64k,   qr_PyString_FromBlob)
    */
 
    PyErr_Format(PyExc_RuntimeError, 
                 "Type '%s' is not in type conversion table. "
                 "Please add it to pythonic_coracool.cxx. "
                 "Can't convert field '%s'.",
                 type_name.c_str(),
                 name);
    return no_coral_conversion_available;
}

fetch_attribute_data()

template<typename T >

const T& fetch_attribute_data

(

const coral::Attribute &

A

)

Definition at line 62 of file pythonic_coracool.cxx.

{
    return A.data<T>();
}

fetch_coracool_folder()

CoraCoolFolderPtr fetch_coracool_folder	(	IDatabasePtr	cooldb,
		const string &	folder
	)

Definition at line 162 of file pythonic_coracool.cxx.

{
    CoraCoolDatabaseSvc&  corasvc     = CoraCoolDatabaseSvcFactory::
                                        databaseService();
                                        
    CoraCoolDatabasePtr   coradb      = corasvc.openDatabase(
                                            cooldb->databaseId(), cooldb, true);
                                            
    return coradb->getFolder(folder);
}

get_coracool_payload_spec()

const cool::RecordSpecification get_coracool_payload_spec	(	IDatabasePtr	cooldb,
		const string &	folder
	)

Definition at line 174 of file pythonic_coracool.cxx.

{
    return fetch_coracool_folder(cooldb, folder)->payloadSpecification();
}

make_fetchers()

bool make_fetchers	(	PyObject *	to_fetch,
		const AttributeList &	attribute_list,
		vector< coral_attribute_fetcher_t > &	payload_fetchers
	)

Definition at line 125 of file pythonic_coracool.cxx.

{
    const Py_ssize_t count = to_fetch ? PySequence_Size(to_fetch) : 0;
 
    for (Py_ssize_t i = 0; i < count; i++)
    {
        PyObject *py_name = PySequence_GetItem(to_fetch, i);
        const char *name = _PyUnicode_AsString(py_name);
        const string type = attribute_list[name].specification().typeName();
                       
        coral_attribute_fetcher_t pf = create_attribute_fetcher(name, type);
        
        auto pff = pf.target<PyObject* (*)(const AttributeList&)>();
        if ( pff && *pff == &no_coral_conversion_available)
            return false; // Failure: A python exception was thrown above
            
        payload_fetchers.push_back(pf);
        Py_DECREF(py_name);
    }
    
    return true; // Success
}

make_iov_key()

PyObject* make_iov_key ( PyObject *  iovkey_wrapper, unsigned long long  value  )

inline

Definition at line 179 of file pythonic_coracool.cxx.

{
    static const char * const argtypes = const_cast<char *>("K");
    if (iovkey_wrapper && iovkey_wrapper != Py_None)
        return PyObject_CallFunction(iovkey_wrapper, argtypes, value);
    return PyLong_FromUnsignedLongLong(value);
}

no_coral_conversion_available()

PyObject* no_coral_conversion_available

(

const AttributeList &

)

Definition at line 55 of file pythonic_coracool.cxx.

{return NULL;}

qr_PyString_FromBlob()

PyObject* qr_PyString_FromBlob

(

const coral::Blob &

blob

)

Definition at line 99 of file quick_retrieve.cxx.

{
    const char* data = reinterpret_cast<const char*>(blob.startingAddress());
    return PyBytes_FromStringAndSize(data, blob.size());
}

qr_PyString_FromStdString()

PyObject* qr_PyString_FromStdString

(

const string &

str

)

Definition at line 105 of file quick_retrieve.cxx.

{
    return PyUnicode_FromStringAndSize(str.c_str(), str.size());
}

Variable Documentation

ATLAS_NO_CHECK_FILE_THREAD_SAFETY

ATLAS_NO_CHECK_FILE_THREAD_SAFETY

Definition at line 34 of file pythonic_coracool.cxx.