python/docs: use the same links on top as in man pages

[elogind.git] / src / python-systemd / _reader.c

diff --git a/src/python-systemd/_reader.c b/src/python-systemd/_reader.c
index e5733f0bcaeec0f0a3bb92abe017950eeaebbe8c..160ab69a3caa5c13f80f9e2bb10de0eeb1dbb8e3 100644 (file)
--- a/src/python-systemd/_reader.c
+++ b/src/python-systemd/_reader.c
@@ -64,7 +64,7 @@ static int set_error(int r, const char* path, const char* invalid_message) {
         errno = -r;
         PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
     }
         errno = -r;
         PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
     }

-    return 1;
+    return -1;

 }
 
 #if PY_MAJOR_VERSION >= 3
 }
 
 #if PY_MAJOR_VERSION >= 3


@@ -94,25 +94,34 @@ static void Reader_dealloc(Reader* self)
 }
 
 PyDoc_STRVAR(Reader__doc__,
 }
 
 PyDoc_STRVAR(Reader__doc__,

-             "Reader([flags][,path]) -> ...\n\n"
+             "Reader([flags | path]) -> ...\n\n"

              "Reader allows filtering and retrieval of Journal entries.\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"
              "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"
              "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)
 {
 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))
     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)
 
     Py_BEGIN_ALLOW_THREADS
     if (path)


@@ -124,6 +133,48 @@ static int Reader_init(Reader *self, PyObject *args, PyObject *keywds)
     return set_error(r, path, "Invalid flags or path");
 }
 
     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)
+{
+    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"
 PyDoc_STRVAR(Reader_get_next__doc__,
              "get_next([skip]) -> dict\n\n"
              "Return dictionary of the next log entry. Optional skip value will\n"


@@ -378,7 +429,7 @@ static PyObject* Reader_seek_head(Reader *self, PyObject *args)
 
 PyDoc_STRVAR(Reader_seek_tail__doc__,
              "seek_tail() -> None\n\n"
 
 PyDoc_STRVAR(Reader_seek_tail__doc__,
              "seek_tail() -> None\n\n"

-             "Jump to the beginning of the journal.\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)
              "This method invokes sd_journal_seek_tail().\n"
              "See man:sd_journal_seek_tail(3).");
 static PyObject* Reader_seek_tail(Reader *self, PyObject *args)


@@ -613,6 +664,9 @@ static PyGetSetDef Reader_getseters[] = {
 };
 
 static PyMethodDef Reader_methods[] = {
 };
 
 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__},

     {"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__},
     {"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__},