morgan/systemd
1
0
Fork 0
mirror of https://github.com/morgan9e/systemd synced 2026-04-15 00:47:10 +09:00
Code Issues Packages Projects Releases Wiki Activity

python-systemd: Reader return special fields and _Reader changes

Browse Source 
Changes to _Reader make it match closer to C API, by removing `get_next`
and `get_previous`. A `get_all` method added, which returns dictionary
of fields using C API SD_JOURNAL_FOREACH_DATA macro, which can be used
in conjunction with `next`.

_Reader `get`, `next`, `get_{realtime,monotonic,cursor}` and new
`previous` methods are made private. This is so the traversal and
getting of journal fields can be made transparent in the python
interface.

Reader now solely implements `get_next` and `get_previous`, returning a
standard dictionary (future: other mapping types?) with all standard and
special fields through the converters. This makes the output the same as
journalctl json/export format output.

Iterator methods also moved to Reader, as they do not function as intend
with changes to _Reader.

These changes also mean that more optimised journal interfaces can be
made more easily from _Reader, by avoiding getting of unrequired fields
by using the `_get` method, and avoiding field conversions.
This commit is contained in:
Steven Hiscocks
2013-04-14 20:55:08 +01:00
committed by Zbigniew Jędrzejewski-Szmek
parent 76a80d93b5
commit 6a58bf4135
2 changed files with 70 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
src/python-systemd/_reader.c
View File

@@ -331,6 +331,21 @@ static PyObject* Reader_next(Reader *self, PyObject *args)
return PyBool_FromLong(r);
}
PyDoc_STRVAR(Reader_previous__doc__,
"previous([skip]) -> bool\n\n"
"Go to the previous log entry. Optional skip value means to \n"
"go to the `skip`\\-th previous log entry.\n"
"Returns False if at start of file, True otherwise.");
static PyObject* Reader_previous(Reader *self, PyObject *args)
{
int64_t skip = 1LL;
if (!PyArg_ParseTuple(args, "|L:previous", &skip))
return NULL;
return PyObject_CallMethod((PyObject *)self, (char*) "_next",
(char*) "L", -skip);
}
static int extract(const char* msg, size_t msg_len,
PyObject **key, PyObject **value) {
@@ -399,24 +414,16 @@ static PyObject* Reader_get(Reader *self, PyObject *args)
}
PyDoc_STRVAR(Reader_get_next__doc__,
"get_next([skip]) -> dict\n\n"
"Return dictionary of the next log entry. Optional skip value will\n"
"return the `skip`\\-th log entry. Returns an empty dict on EOF.");
static PyObject* Reader_get_next(Reader *self, PyObject *args)
PyDoc_STRVAR(Reader_get_all__doc__,
"_get_all() -> dict\n\n"
"Return dictionary of the current log entry.");
static PyObject* Reader_get_all(Reader *self, PyObject *args)
{
PyObject _cleanup_Py_DECREF_ *tmp = NULL;
PyObject *dict;
const void *msg;
size_t msg_len;
int r;
tmp = Reader_next(self, args);
if (!tmp)
return NULL;
if (tmp == Py_False) /* EOF */
return PyDict_New();
dict = PyDict_New();
if (!dict)
return NULL;
@@ -536,22 +543,6 @@ static PyObject* Reader_get_monotonic(Reader *self, PyObject *args)
return tuple;
}
PyDoc_STRVAR(Reader_get_previous__doc__,
"get_previous([skip]) -> dict\n\n"
"Return dictionary of the previous log entry. Optional skip value\n"
"will return the -`skip`\\-th log entry. Equivalent to get_next(-skip).");
static PyObject* Reader_get_previous(Reader *self, PyObject *args)
{
int64_t skip = 1LL;
if (!PyArg_ParseTuple(args, "|L:get_previous", &skip))
return NULL;
return PyObject_CallMethod((PyObject *)self, (char*) "get_next",
(char*) "L", -skip);
}
PyDoc_STRVAR(Reader_add_match__doc__,
"add_match(match) -> None\n\n"
"Add a match to filter journal log entries. All matches of different\n"
@@ -806,32 +797,6 @@ static PyObject* Reader_test_cursor(Reader *self, PyObject *args)
return PyBool_FromLong(r);
}
static PyObject* Reader_iter(PyObject *self)
{
Py_INCREF(self);
return self;
}
static PyObject* Reader_iternext(PyObject *self)
{
PyObject *dict;
Py_ssize_t dict_size;
dict = PyObject_CallMethod(self, (char*) "get_next", (char*) "");
if (PyErr_Occurred())
return NULL;
dict_size = PyDict_Size(dict);
if ((int64_t) dict_size > 0LL) {
return dict;
} else {
Py_DECREF(dict);
PyErr_SetNone(PyExc_StopIteration);
return NULL;
}
}
PyDoc_STRVAR(Reader_query_unique__doc__,
"query_unique(field) -> a set of values\n\n"
"Return a set of unique values appearing in journal for the\n"
@@ -1007,12 +972,12 @@ static PyMethodDef Reader_methods[] = {
{"get_usage", (PyCFunction) Reader_get_usage, METH_NOARGS, Reader_get_usage__doc__},
{"__enter__", (PyCFunction) Reader___enter__, METH_NOARGS, Reader___enter____doc__},
{"__exit__", (PyCFunction) Reader___exit__, METH_VARARGS, Reader___exit____doc__},
{"next", (PyCFunction) Reader_next, METH_VARARGS, Reader_next__doc__},
{"get", (PyCFunction) Reader_get, METH_VARARGS, Reader_get__doc__},
{"get_next", (PyCFunction) Reader_get_next, METH_VARARGS, Reader_get_next__doc__},
{"get_previous", (PyCFunction) Reader_get_previous, METH_VARARGS, Reader_get_previous__doc__},
{"get_realtime", (PyCFunction) Reader_get_realtime, METH_NOARGS, Reader_get_realtime__doc__},
{"get_monotonic", (PyCFunction) Reader_get_monotonic, METH_NOARGS, Reader_get_monotonic__doc__},
{"_next", (PyCFunction) Reader_next, METH_VARARGS, Reader_next__doc__},
{"_previous", (PyCFunction) Reader_previous, METH_VARARGS, Reader_previous__doc__},
{"_get", (PyCFunction) Reader_get, METH_VARARGS, Reader_get__doc__},
{"_get_all", (PyCFunction) Reader_get_all, METH_NOARGS, Reader_get_all__doc__},
{"_get_realtime", (PyCFunction) Reader_get_realtime, METH_NOARGS, Reader_get_realtime__doc__},
{"_get_monotonic", (PyCFunction) Reader_get_monotonic, METH_NOARGS, Reader_get_monotonic__doc__},
{"add_match", (PyCFunction) Reader_add_match, METH_VARARGS|METH_KEYWORDS, Reader_add_match__doc__},
{"add_disjunction", (PyCFunction) Reader_add_disjunction, METH_NOARGS, Reader_add_disjunction__doc__},
{"flush_matches", (PyCFunction) Reader_flush_matches, METH_NOARGS, Reader_flush_matches__doc__},
@@ -1023,7 +988,7 @@ static PyMethodDef Reader_methods[] = {
{"process", (PyCFunction) Reader_process, METH_NOARGS, Reader_process__doc__},
{"wait", (PyCFunction) Reader_wait, METH_VARARGS, Reader_wait__doc__},
{"seek_cursor", (PyCFunction) Reader_seek_cursor, METH_VARARGS, Reader_seek_cursor__doc__},
{"get_cursor", (PyCFunction) Reader_get_cursor, METH_NOARGS, Reader_get_cursor__doc__},
{"_get_cursor", (PyCFunction) Reader_get_cursor, METH_NOARGS, Reader_get_cursor__doc__},
{"test_cursor", (PyCFunction) Reader_test_cursor, METH_VARARGS, Reader_test_cursor__doc__},
{"query_unique", (PyCFunction) Reader_query_unique, METH_VARARGS, Reader_query_unique__doc__},
{"get_catalog", (PyCFunction) Reader_get_catalog, METH_NOARGS, Reader_get_catalog__doc__},
@@ -1056,8 +1021,8 @@ static PyTypeObject ReaderType = {
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
Reader_iter, /* tp_iter */
Reader_iternext, /* tp_iternext */
0, /* tp_iter */
0, /* tp_iternext */
Reader_methods, /* tp_methods */
0, /* tp_members */
Reader_getsetters, /* tp_getset */

45
src/python-systemd/journal.py
View File

@@ -176,6 +176,25 @@ class Reader(_Reader):
result[key] = self._convert_field(key, value)
return result
def __iter__(self):
"""Part of iterator protocol.
Returns self.
"""
return self
if _sys.version_info >= (3,):
def __next__(self):
"""Part of iterator protocol.
Returns self.get_next().
"""
return self.get_next()
else:
def next(self):
"""Part of iterator protocol.
Returns self.get_next().
"""
return self.get_next()
def add_match(self, *args, **kwargs):
"""Add one or more matches to the filter journal log entries.
All matches of different field are combined in a logical AND,
@@ -190,15 +209,35 @@ class Reader(_Reader):
super(Reader, self).add_match(arg)
def get_next(self, skip=1):
"""Return the next log entry as a dictionary of fields.
"""Return the next log entry as a mapping type, currently
a standard dictionary of fields.
Optional skip value will return the `skip`\-th log entry.
Entries will be processed with converters specified during
Reader creation.
"""
return self._convert_entry(
super(Reader, self).get_next(skip))
if super(Reader, self)._next(skip):
entry = super(Reader, self)._get_all()
if entry:
entry['__REALTIME_TIMESTAMP'] = self._get_realtime()
entry['__MONOTONIC_TIMESTAMP'] = self._get_monotonic()
entry['__CURSOR'] = self._get_cursor()
return self._convert_entry(entry)
return dict()
def get_previous(self, skip=1):
"""Return the previous log entry as a mapping type,
currently a standard dictionary of fields.
Optional skip value will return the -`skip`\-th log entry.
Entries will be processed with converters specified during
Reader creation.
Equivilent to get_next(-skip).
"""
return self.get_next(-skip)
def query_unique(self, field):
"""Return unique values appearing in the journal for given `field`.