chiark / gitweb /
systemd-python: allow Reader to be used as a context manager
[elogind.git] / src / python-systemd / _reader.c
index 7f200d53f6152a967ec1b25d4cb52a6d8bbe150c..6759555c126ae26cb9d82bb4e5ceaa3cb149251c 100644 (file)
 #include "macro.h"
 #include "util.h"
 
-#if PY_MAJOR_VERSION >=3
-# define unicode_FromStringAndSize PyUnicode_FromStringAndSize
-# define unicode_FromString PyUnicode_FromString
-# define long_FromLong PyLong_FromLong
-# define long_FromSize_t PyLong_FromSize_t
-# define long_Check PyLong_Check
-# define long_AsLong PyLong_AsLong
-#else
-/* Python 3 type naming convention is used */
-# define unicode_FromStringAndSize PyString_FromStringAndSize
-# define unicode_FromString PyString_FromString
-# define long_FromLong PyInt_FromLong
-# define long_FromSize_t PyInt_FromSize_t
-# define long_Check PyInt_Check
-# define long_AsLong PyInt_AsLong
-#endif
-
 typedef struct {
     PyObject_HEAD
     sd_journal *j;
@@ -64,7 +47,7 @@ static int set_error(int r, const char* path, const char* invalid_message) {
         errno = -r;
         PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
     }
-    return 1;
+    return -1;
 }
 
 #if PY_MAJOR_VERSION >= 3
@@ -94,25 +77,34 @@ static void Reader_dealloc(Reader* self)
 }
 
 PyDoc_STRVAR(Reader__doc__,
-             "Reader([flags][,path]) -> ...\n\n"
+             "Reader([flags | path]) -> ...\n\n"
              "Reader allows filtering and retrieval of Journal entries.\n"
+             "Note: this is a low-level interface, and probably not what you\n"
+             "want, use systemd.journal.Reader instead.\n\n"
              "Argument `flags` sets open flags of the journal, which can be one\n"
              "of, or ORed combination of constants: LOCAL_ONLY (default) opens\n"
              "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"
+             "journal files of system services and the kernel.\n\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.");
+             "`flags` and `path` are exclusive.\n");
 static int Reader_init(Reader *self, PyObject *args, PyObject *keywds)
 {
-    int flags = SD_JOURNAL_LOCAL_ONLY, r;
+    int flags = 0, r;
     char *path = NULL;
 
     static const char* const kwlist[] = {"flags", "path", NULL};
     if (!PyArg_ParseTupleAndKeywords(args, keywds, "|iz", (char**) kwlist,
                                      &flags, &path))
-        return 1;
+        return -1;
+
+    if (!flags)
+        flags = SD_JOURNAL_LOCAL_ONLY;
+    else
+        if (path) {
+            PyErr_SetString(PyExc_ValueError, "cannot use both flags and path");
+            return -1;
+        }
 
     Py_BEGIN_ALLOW_THREADS
     if (path)
@@ -124,6 +116,77 @@ static int Reader_init(Reader *self, PyObject *args, PyObject *keywds)
     return set_error(r, path, "Invalid flags or path");
 }
 
+PyDoc_STRVAR(Reader_fileno__doc__,
+             "fileno() -> int\n\n"
+             "Get a file descriptor to poll for changes in the journal.\n"
+             "This method invokes sd_journal_get_fd().\n"
+             "See man:sd_journal_get_fd(3).");
+static PyObject* Reader_fileno(Reader *self, PyObject *args)
+{
+    int r;
+    r = sd_journal_get_fd(self->j);
+    set_error(r, NULL, NULL);
+    if (r < 0)
+        return NULL;
+    return long_FromLong(r);
+}
+
+PyDoc_STRVAR(Reader_reliable_fd__doc__,
+             "reliable_fd() -> bool\n\n"
+             "Returns True iff the journal can be polled reliably.\n"
+             "This method invokes sd_journal_reliable_fd().\n"
+             "See man:sd_journal_reliable_fd(3).");
+static PyObject* Reader_reliable_fd(Reader *self, PyObject *args)
+{
+    int r;
+    r = sd_journal_reliable_fd(self->j);
+    set_error(r, NULL, NULL);
+    if (r < 0)
+        return NULL;
+    return PyBool_FromLong(r);
+}
+
+PyDoc_STRVAR(Reader_close__doc__,
+             "close() -> None\n\n"
+             "Free resources allocated by this Reader object.\n"
+             "This method invokes sd_journal_close().\n"
+             "See man:sd_journal_close(3).");
+static PyObject* Reader_close(Reader *self, PyObject *args)
+{
+    assert(self);
+    assert(!args);
+
+    sd_journal_close(self->j);
+    self->j = NULL;
+    Py_RETURN_NONE;
+}
+
+PyDoc_STRVAR(Reader___enter____doc__,
+             "__enter__() -> self\n\n"
+             "Part of the context manager protocol.\n"
+             "Returns self.\n");
+static PyObject* Reader___enter__(PyObject *self, PyObject *args)
+{
+    assert(self);
+    assert(!args);
+
+    Py_INCREF(self);
+    return self;
+}
+
+PyDoc_STRVAR(Reader___exit____doc__,
+             "__exit__(type, value, traceback) -> None\n\n"
+             "Part of the context manager protocol.\n"
+             "Closes the journal.\n");
+static PyObject* Reader___exit__(Reader *self, PyObject *args)
+{
+    assert(self);
+
+    sd_journal_close(self->j);
+    self->j = NULL;
+    Py_RETURN_NONE;
+}
+
 PyDoc_STRVAR(Reader_get_next__doc__,
              "get_next([skip]) -> dict\n\n"
              "Return dictionary of the next log entry. Optional skip value will\n"
@@ -208,7 +271,7 @@ static PyObject* Reader_get_next(Reader *self, PyObject *args)
                 if (r < 0)
                     goto error;
 
-                PyDict_SetItem(dict, key, tmp_list);
+                r = PyDict_SetItem(dict, key, tmp_list);
                 if (r < 0)
                     goto error;
             }
@@ -360,60 +423,34 @@ static PyObject* Reader_flush_matches(Reader *self, PyObject *args)
     Py_RETURN_NONE;
 }
 
-PyDoc_STRVAR(Reader_seek__doc__,
-             "seek(offset[, whence]) -> None\n\n"
-             "Jump `offset` entries in the journal. Argument\n"
-             "`whence` defines what the offset is relative to:\n"
-             "os.SEEK_SET (default) from first match in journal;\n"
-             "os.SEEK_CUR from current position in journal;\n"
-             "and os.SEEK_END is from last match in journal.");
-static PyObject* Reader_seek(Reader *self, PyObject *args, PyObject *keywds)
+PyDoc_STRVAR(Reader_seek_head__doc__,
+             "seek_head() -> None\n\n"
+             "Jump to the beginning of the journal.\n"
+             "This method invokes sd_journal_seek_head().\n"
+             "See man:sd_journal_seek_head(3).");
+static PyObject* Reader_seek_head(Reader *self, PyObject *args)
 {
-    int64_t offset;
-    int whence = SEEK_SET;
-    PyObject *result = NULL;
-
-    static const char* const kwlist[] = {"offset", "whence", NULL};
-    if (!PyArg_ParseTupleAndKeywords(args, keywds, "L|i", (char**) kwlist,
-                                     &offset, &whence))
+    int r;
+    Py_BEGIN_ALLOW_THREADS
+    r = sd_journal_seek_head(self->j);
+    Py_END_ALLOW_THREADS
+    if (set_error(r, NULL, NULL))
         return NULL;
+    Py_RETURN_NONE;
+}
 
-    switch(whence) {
-    case SEEK_SET: {
-        int r;
-        Py_BEGIN_ALLOW_THREADS
-        r = sd_journal_seek_head(self->j);
-        Py_END_ALLOW_THREADS
-        if (set_error(r, NULL, NULL))
-            return NULL;
-
-        if (offset > 0LL)
-            result = PyObject_CallMethod((PyObject *)self, (char*) "get_next",
-                                         (char*) "L", offset);
-        break;
-    }
-    case SEEK_CUR:
-        result = PyObject_CallMethod((PyObject *)self, (char*) "get_next",
-                                     (char*) "L", offset);
-        break;
-    case SEEK_END: {
-        int r;
-        Py_BEGIN_ALLOW_THREADS
-        r = sd_journal_seek_tail(self->j);
-        Py_END_ALLOW_THREADS
-        if (set_error(r, NULL, NULL))
-            return NULL;
-
-        result = PyObject_CallMethod((PyObject *)self, (char*) "get_next",
-                                     (char*) "L", offset < 0LL ? offset : -1LL);
-        break;
-    }
-    default:
-        PyErr_SetString(PyExc_ValueError, "Invalid value for whence");
-    }
-
-    Py_XDECREF(result);
-    if (PyErr_Occurred())
+PyDoc_STRVAR(Reader_seek_tail__doc__,
+             "seek_tail() -> None\n\n"
+             "Jump to the end of the journal.\n"
+             "This method invokes sd_journal_seek_tail().\n"
+             "See man:sd_journal_seek_tail(3).");
+static PyObject* Reader_seek_tail(Reader *self, PyObject *args)
+{
+    int r;
+    Py_BEGIN_ALLOW_THREADS
+    r = sd_journal_seek_tail(self->j);
+    Py_END_ALLOW_THREADS
+    if (set_error(r, NULL, NULL))
         return NULL;
     Py_RETURN_NONE;
 }
@@ -507,9 +544,10 @@ static PyObject* Reader_wait(Reader *self, PyObject *args, PyObject *keywds)
         return NULL;
 
     Py_BEGIN_ALLOW_THREADS
-    r = sd_journal_wait(self->j, timeout ==0 ? (uint64_t) -1 : timeout * 1E6);
+    r = sd_journal_wait(self->j,
+                        timeout == 0 ? (uint64_t) -1 : timeout * 1E6);
     Py_END_ALLOW_THREADS
-    if (set_error(r, NULL, NULL))
+    if (set_error(r, NULL, NULL) < 0)
         return NULL;
 
     return long_FromLong(r);
@@ -638,12 +676,19 @@ static PyGetSetDef Reader_getseters[] = {
 };
 
 static PyMethodDef Reader_methods[] = {
+    {"fileno",          (PyCFunction) Reader_fileno, METH_NOARGS, Reader_fileno__doc__},
+    {"reliable_fd",     (PyCFunction) Reader_reliable_fd, METH_NOARGS, Reader_reliable_fd__doc__},
+    {"close",           (PyCFunction) Reader_close, METH_NOARGS, Reader_close__doc__},
+    {"__enter__",       (PyCFunction) Reader___enter__, METH_NOARGS, Reader___enter____doc__},
+    {"__exit__",        (PyCFunction) Reader___exit__, METH_VARARGS, Reader___exit____doc__},
+    {"close",           (PyCFunction) Reader_close, METH_NOARGS, Reader_close__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__},
     {"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__},
-    {"seek",            (PyCFunction) Reader_seek, METH_VARARGS | METH_KEYWORDS,  Reader_seek__doc__},
+    {"seek_head",       (PyCFunction) Reader_seek_head, METH_NOARGS, Reader_seek_head__doc__},
+    {"seek_tail",       (PyCFunction) Reader_seek_tail, METH_NOARGS, Reader_seek_tail__doc__},
     {"seek_realtime",   (PyCFunction) Reader_seek_realtime, METH_VARARGS, Reader_seek_realtime__doc__},
     {"seek_monotonic",  (PyCFunction) Reader_seek_monotonic, METH_VARARGS, Reader_seek_monotonic__doc__},
     {"wait",            (PyCFunction) Reader_wait, METH_VARARGS, Reader_wait__doc__},