chiark / gitweb /
systemd-python: move default call dicts from C to python
authorSteven Hiscocks <steven@hiscocks.me.uk>
Fri, 15 Feb 2013 16:59:50 +0000 (16:59 +0000)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 22 Feb 2013 15:57:43 +0000 (16:57 +0100)
src/python-systemd/_reader.c
src/python-systemd/journal.py

index 69c6d02a9ef3491250e6a233cc281c1788a5cf94..f047ab9e6d95b81a362f2a7610d5618950d23724 100644 (file)
@@ -25,8 +25,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 typedef struct {
     PyObject_HEAD
     sd_journal *j;
-    PyObject *default_call;
-    PyObject *call_dict;
 } Journal;
 static PyTypeObject JournalType;
 
@@ -34,27 +32,11 @@ static void
 Journal_dealloc(Journal* self)
 {
     sd_journal_close(self->j);
-    Py_XDECREF(self->default_call);
-    Py_XDECREF(self->call_dict);
     Py_TYPE(self)->tp_free((PyObject*)self);
 }
 
-static PyObject *
-Journal_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
-{
-    Journal *self;
-
-    self = (Journal *)type->tp_alloc(type, 0);
-    if (self != NULL) {
-        self->call_dict = PyDict_New();
-        self->default_call = Py_None;
-    }
-
-    return (PyObject *) self;
-}
-
 PyDoc_STRVAR(Journal__doc__,
-"Journal([flags][, default_call][, call_dict][,path]) -> ...\n"
+"Journal([flags][,path]) -> ...\n"
 "Journal instance\n\n"
 "Returns instance of Journal, which allows filtering and return\n"
 "of journal entries.\n"
@@ -63,13 +45,6 @@ PyDoc_STRVAR(Journal__doc__,
 "journal on local machine only; RUNTIME_ONLY opens only\n"
 "volatile journal files; and SYSTEM_ONLY opens only\n"
 "journal files of system services and the kernel.\n"
-"Argument `default_call` must be a callable that accepts one\n"
-"argument which is string/bytes value of a field and returns\n"
-"python object.\n"
-"Argument `call_dict` is a dictionary where the key represents\n"
-"a field name, and value is a callable as per `default_call`.\n"
-"A set of sane defaults for `default_call` and `call_dict` are\n"
-"present.\n"
 "Argument `path` is the directory of journal files. Note that\n"
 "currently flags are ignored when `path` is present as they are\n"
 " not relevant.");
@@ -78,38 +53,12 @@ Journal_init(Journal *self, PyObject *args, PyObject *keywds)
 {
     int flags=SD_JOURNAL_LOCAL_ONLY;
     char *path=NULL;
-    PyObject *default_call=NULL, *call_dict=NULL;
 
-    static char *kwlist[] = {"flags", "default_call", "call_dict", "path", NULL};
-    if (! PyArg_ParseTupleAndKeywords(args, keywds, "|iOOs", kwlist,
-                                      &flags, &default_call, &call_dict, &path))
+    static char *kwlist[] = {"flags", NULL};
+    if (! PyArg_ParseTupleAndKeywords(args, keywds, "|is", kwlist,
+                                      &flags, &path))
         return 1;
 
-    if (default_call) {
-        if (PyCallable_Check(default_call) || default_call == Py_None) {
-            Py_DECREF(self->default_call);
-            self->default_call = default_call;
-            Py_INCREF(self->default_call);
-        }else{
-            PyErr_SetString(PyExc_TypeError, "Default call not callable");
-            return 1;
-        }
-    }
-
-    if (call_dict) {
-        if (PyDict_Check(call_dict)) {
-            Py_DECREF(self->call_dict);
-            self->call_dict = call_dict;
-            Py_INCREF(self->call_dict);
-        }else if (call_dict == Py_None) {
-            Py_DECREF(self->call_dict);
-            self->call_dict = PyDict_New();
-        }else{
-            PyErr_SetString(PyExc_TypeError, "Call dictionary must be dict type");
-            return 1;
-        }
-    }
-
     int r;
     if (path) {
         r = sd_journal_open_directory(&self->j, path, 0);
@@ -132,42 +81,6 @@ Journal_init(Journal *self, PyObject *args, PyObject *keywds)
     return 0;
 }
 
-static PyObject *
-Journal___process_field(Journal *self, PyObject *key, const void *value, ssize_t value_len)
-{
-    PyObject *callable=NULL, *return_value=NULL;
-    if (PyDict_Check(self->call_dict))
-        callable = PyDict_GetItem(self->call_dict, key);
-
-    if (PyCallable_Check(callable)) {
-#if PY_MAJOR_VERSION >=3
-        return_value = PyObject_CallFunction(callable, "y#", value, value_len);
-#else
-        return_value = PyObject_CallFunction(callable, "s#", value, value_len);
-#endif
-        if (!return_value)
-            PyErr_Clear();
-    }
-    if (!return_value && PyCallable_Check(self->default_call))
-#if PY_MAJOR_VERSION >=3
-        return_value = PyObject_CallFunction(self->default_call, "y#", value, value_len);
-#else
-        return_value = PyObject_CallFunction(self->default_call, "s#", value, value_len);
-#endif
-    if (!return_value) {
-        PyErr_Clear();
-#if PY_MAJOR_VERSION >=3
-        return_value = PyBytes_FromStringAndSize(value, value_len);
-#else
-        return_value = PyString_FromStringAndSize(value, value_len);
-#endif
-    }
-    if (!return_value) {
-        return_value = Py_None;
-    }
-    return return_value;
-}
-
 PyDoc_STRVAR(Journal_get_next__doc__,
 "get_next([skip]) -> dict\n\n"
 "Return dictionary of the next log entry. Optional skip value will\n"
@@ -223,10 +136,10 @@ Journal_get_next(Journal *self, PyObject *args)
 #else
         key = PyString_FromStringAndSize(msg, delim_ptr - (const char*) msg);
 #endif
-        value = Journal___process_field(self, key, delim_ptr + 1, (const char*) msg + msg_len - (delim_ptr + 1) );
+        value = PyBytes_FromStringAndSize(delim_ptr + 1, (const char*) msg + msg_len - (delim_ptr + 1) );
         if (PyDict_Contains(dict, key)) {
             cur_value = PyDict_GetItem(dict, key);
-            if (PyList_CheckExact(cur_value) && PyList_Size(cur_value) > 1) {
+            if (PyList_CheckExact(cur_value)) {
                 PyList_Append(cur_value, value);
             }else{
                 tmp_list = PyList_New(0);
@@ -252,7 +165,7 @@ Journal_get_next(Journal *self, PyObject *args)
 #else
         key = PyString_FromString("__REALTIME_TIMESTAMP");
 #endif
-        value = Journal___process_field(self, key, realtime_str, strlen(realtime_str));
+        value = PyBytes_FromString(realtime_str);
         PyDict_SetItem(dict, key, value);
         Py_DECREF(key);
         Py_DECREF(value);
@@ -268,7 +181,7 @@ Journal_get_next(Journal *self, PyObject *args)
 #else
         key = PyString_FromString("__MONOTONIC_TIMESTAMP");
 #endif
-        value = Journal___process_field(self, key, monotonic_str, strlen(monotonic_str));
+        value = PyBytes_FromString(monotonic_str);
 
         PyDict_SetItem(dict, key, value);
         Py_DECREF(key);
@@ -282,7 +195,7 @@ Journal_get_next(Journal *self, PyObject *args)
 #else
         key = PyString_FromString("__CURSOR");
 #endif
-        value = Journal___process_field(self, key, cursor, strlen(cursor));
+        value = PyBytes_FromString(cursor);
         PyDict_SetItem(dict, key, value);
         free(cursor);
         Py_DECREF(key);
@@ -303,11 +216,7 @@ Journal_get_previous(Journal *self, PyObject *args)
     if (! PyArg_ParseTuple(args, "|L", &skip))
         return NULL;
 
-    PyObject *dict, *arg;
-    arg = Py_BuildValue("(L)", -skip);
-    dict = Journal_get_next(self, arg);
-    Py_DECREF(arg);
-    return dict;
+    return PyObject_CallMethod((PyObject *)self, "get_next", "L", -skip);
 }
 
 PyDoc_STRVAR(Journal_add_match__doc__,
@@ -485,14 +394,10 @@ Journal_seek(Journal *self, PyObject *args, PyObject *keywds)
             return NULL;
         }
         if (offset > 0LL) {
-            arg = Py_BuildValue("(L)", offset);
-            Py_DECREF(Journal_get_next(self, arg));
-            Py_DECREF(arg);
+            Py_DECREF(PyObject_CallMethod((PyObject *)self, "get_next", "L", offset));
         }
     }else if (whence == SEEK_CUR){
-        arg = Py_BuildValue("(L)", offset);
-        Py_DECREF(Journal_get_next(self, arg));
-        Py_DECREF(arg);
+        Py_DECREF(PyObject_CallMethod((PyObject *)self, "get_next", "L", offset));
     }else if (whence == SEEK_END){
         int r;
         Py_BEGIN_ALLOW_THREADS
@@ -502,13 +407,9 @@ Journal_seek(Journal *self, PyObject *args, PyObject *keywds)
             PyErr_SetString(PyExc_RuntimeError, "Error seeking to tail");
             return NULL;
         }
-        arg = Py_BuildValue("(L)", -1LL);
-        Py_DECREF(Journal_get_next(self, arg));
-        Py_DECREF(arg);
+        Py_DECREF(PyObject_CallMethod((PyObject *)self, "get_next", "L", -1LL));
         if (offset < 0LL) {
-            arg = Py_BuildValue("(L)", offset);
-            Py_DECREF(Journal_get_next(self, arg));
-            Py_DECREF(arg);
+            Py_DECREF(PyObject_CallMethod((PyObject *)self, "get_next", "L", offset));
         }
     }else{
         PyErr_SetString(PyExc_ValueError, "Invalid value for whence");
@@ -706,13 +607,10 @@ Journal_iter(PyObject *self)
 static PyObject *
 Journal_iternext(PyObject *self)
 {
-    Journal *iter = (Journal *)self;
     PyObject *dict, *arg;
     Py_ssize_t dict_size;
 
-    arg =  Py_BuildValue("()");
-    dict = Journal_get_next(iter, arg);
-    Py_DECREF(arg);
+    dict = PyObject_CallMethod(self, "get_next", "");
     dict_size = PyDict_Size(dict);
     if ((int64_t) dict_size > 0LL) {
         return dict;
@@ -764,7 +662,7 @@ Journal_query_unique(Journal *self, PyObject *args)
 
     SD_JOURNAL_FOREACH_UNIQUE(self->j, uniq, uniq_len) {
         delim_ptr = memchr(uniq, '=', uniq_len);
-        value = Journal___process_field(self, key, delim_ptr + 1, (const char*) uniq + uniq_len - (delim_ptr + 1));
+        value = PyBytes_FromStringAndSize(delim_ptr + 1, (const char*) uniq + uniq_len - (delim_ptr + 1));
         PySet_Add(value_set, value);
         Py_DECREF(value);
     }
@@ -867,56 +765,6 @@ Journal_this_machine(Journal *self, PyObject *args)
     Py_RETURN_NONE;
 }
 
-static PyObject *
-Journal_get_default_call(Journal *self, void *closure)
-{
-    Py_INCREF(self->default_call);
-    return self->default_call;
-}
-
-static int
-Journal_set_default_call(Journal *self, PyObject *value, void *closure)
-{
-    if (value == NULL) {
-        PyErr_SetString(PyExc_TypeError, "Cannot delete default_call");
-        return -1;
-    }
-    if (! PyCallable_Check(value)) {
-        PyErr_SetString(PyExc_TypeError, "default_call must be callable");
-        return -1;
-    }
-    Py_DECREF(self->default_call);
-    Py_INCREF(value);
-    self->default_call = value;
-
-    return 0;
-}
-
-static PyObject *
-Journal_get_call_dict(Journal *self, void *closure)
-{
-    Py_INCREF(self->call_dict);
-    return self->call_dict;
-}
-
-static int
-Journal_set_call_dict(Journal *self, PyObject *value, void *closure)
-{
-    if (value == NULL) {
-        PyErr_SetString(PyExc_TypeError, "Cannot delete call_dict");
-        return -1;
-    }
-    if (! PyDict_Check(value)) {
-        PyErr_SetString(PyExc_TypeError, "call_dict must be dict type");
-        return -1;
-    }
-    Py_DECREF(self->call_dict);
-    Py_INCREF(value);
-    self->call_dict = value;
-
-    return 0;
-}
-
 static PyObject *
 Journal_get_data_threshold(Journal *self, void *closure)
 {
@@ -972,16 +820,6 @@ static PyGetSetDef Journal_getseters[] = {
     (setter)Journal_set_data_threshold,
     "data threshold",
     NULL},
-    {"call_dict",
-    (getter)Journal_get_call_dict,
-    (setter)Journal_set_call_dict,
-    "dictionary of calls for each field",
-    NULL},
-    {"default_call",
-    (getter)Journal_get_default_call,
-    (setter)Journal_set_default_call,
-    "default call for values for fields",
-    NULL},
     {NULL}
 };
 
@@ -1057,7 +895,7 @@ static PyTypeObject JournalType = {
     0,                                /* tp_dictoffset */
     (initproc)Journal_init,           /* tp_init */
     0,                                /* tp_alloc */
-    Journal_new,                      /* tp_new */
+    PyType_GenericNew,                /* tp_new */
 };
 
 #if PY_MAJOR_VERSION >= 3
index fafddaa27e1d1ca40cedf8ab7b17e0fd3966f9d0..8a688f978b569ad102eb62597b1f1ad814590e8f 100644 (file)
@@ -32,49 +32,88 @@ from ._journal import sendv, stream_fd
 from ._reader import (_Journal, NOP, APPEND, INVALIDATE,
                       LOCAL_ONLY, RUNTIME_ONLY, SYSTEM_ONLY)
 
+_MONOTONIC_CONVERTER = lambda x: datetime.timedelta(microseconds=float(x))
+_REALTIME_CONVERTER = lambda x: datetime.datetime.fromtimestamp(float(x)/1E6)
+DEFAULT_CONVERTERS = {
+    'MESSAGE_ID': uuid.UUID,
+    'PRIORITY': int,
+    'LEADER': int,
+    'SESSION_ID': int,
+    'USERSPACE_USEC': int,
+    'INITRD_USEC': int,
+    'KERNEL_USEC': int,
+    '_UID': int,
+    '_GID': int,
+    '_PID': int,
+    'SYSLOG_FACILITY': int,
+    'SYSLOG_PID': int,
+    '_AUDIT_SESSION': int,
+    '_AUDIT_LOGINUID': int,
+    '_SYSTEMD_SESSION': int,
+    '_SYSTEMD_OWNER_UID': int,
+    'CODE_LINE': int,
+    'ERRNO': int,
+    'EXIT_STATUS': int,
+    '_SOURCE_REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
+    '__REALTIME_TIMESTAMP': _REALTIME_CONVERTER,
+    '_SOURCE_MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
+    '__MONOTONIC_TIMESTAMP': _MONOTONIC_CONVERTER,
+    'COREDUMP': bytes,
+    'COREDUMP_PID': int,
+    'COREDUMP_UID': int,
+    'COREDUMP_GID': int,
+    'COREDUMP_SESSION': int,
+    'COREDUMP_SIGNAL': int,
+    'COREDUMP_TIMESTAMP': _REALTIME_CONVERTER,
+}
+
+if sys.version_info >= (3,):
+    _convert_unicode = functools.partial(str, encoding='utf-8')
+else:
+    _convert_unicode = functools.partial(unicode, encoding='utf-8')
+
 class Journal(_Journal):
-    def __new__(cls, *args, **kwargs):
-        self = _Journal.__new__(cls, *args, **kwargs)
-        if sys.version_info[0] >= 3:
-            self.default_call = functools.partial(str, encoding='utf-8')
-        else:
-            self.default_call = functools.partial(unicode, encoding='utf-8')
-        self.call_dict = {
-            'MESSAGE_ID': uuid.UUID,
-            'PRIORITY': int,
-            'LEADER': int,
-            'SESSION_ID': int,
-            'USERSPACE_USEC': int,
-            'INITRD_USEC': int,
-            'KERNEL_USEC': int,
-            '_UID': int,
-            '_GID': int,
-            '_PID': int,
-            'SYSLOG_FACILITY': int,
-            'SYSLOG_PID': int,
-            '_AUDIT_SESSION': int,
-            '_AUDIT_LOGINUID': int,
-            '_SYSTEMD_SESSION': int,
-            '_SYSTEMD_OWNER_UID': int,
-            'CODE_LINE': int,
-            'ERRNO': int,
-            'EXIT_STATUS': int,
-            '_SOURCE_REALTIME_TIMESTAMP': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
-            '__REALTIME_TIMESTAMP': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
-            '_SOURCE_MONOTONIC_TIMESTAMP': lambda x: datetime.timedelta(microseconds=float(x)),
-            '__MONOTONIC_TIMESTAMP': lambda x: datetime.timedelta(microseconds=float(x)),
-            'COREDUMP_PID': int,
-            'COREDUMP_UID': int,
-            'COREDUMP_GID': int,
-            'COREDUMP_SESSION': int,
-            'COREDUMP_SIGNAL': int,
-            'COREDUMP_TIMESTAMP': lambda x: datetime.datetime.fromtimestamp(float(x)/1E6),
-        }
-        if sys.version_info[0] >= 3:
-            self.call_dict['COREDUMP'] = bytes
+    def __init__(self, converters=None, *args, **kwargs):
+        super(Journal, self).__init__(*args, **kwargs)
+        if sys.version_info >= (3,3):
+            self.converters = ChainMap()
+            if converters is not None:
+                self.converters.maps.append(converters)
+            self.converters.maps.append(DEFAULT_CONVERTERS)
         else:
-            self.call_dict['COREDUMP'] = str
-        return self
+            # suitable fallback, e.g.
+            self.converters = DEFAULT_CONVERTERS.copy()
+            if converters is not None:
+                self.converters.update(converters)
+
+    def _convert_field(self, key, value):
+        try:
+            result = self.converters[key](value)
+        except KeyError:
+            # Default conversion in unicode
+            try:
+                result = _convert_unicode(value)
+            except:
+                # Leave in default bytes
+                result = value
+        return result
+
+    def _convert_entry(self, entry):
+        result = {}
+        for key, value in entry.iteritems():
+            if isinstance(value, list):
+                result[key] = [self._convert_field(key, val) for val in value]
+            else:
+                result[key] = self._convert_field(key, value)
+        return result
+
+    def get_next(self, *args, **kwargs):
+        return self._convert_entry(
+            super(Journal, self).get_next(*args, **kwargs))
+
+    def query_unique(self, key, *args, **kwargs):
+        return set(self._convert_field(key, value)
+            for value in super(Journal, self).query_unique(key, *args, **kwargs))
 
 def _make_line(field, value):
         if isinstance(value, bytes):