added getdns.get_errorstr_by_id() method, added it to doc, updated version number in docs

Author: MelindaShore

doc/conf.py

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.1'
+version = '0.1.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.1'
+release = '0.2.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/functions.rst

@@ -493,3 +493,23 @@ This is an example callback function:
             print 'Query timed out'
         else:
             print 'Unknown error'
+
+
+Utility methods
+---------------
+
+At the present time we support one utility method.
+
+.. py:method:: get_errorstr_by_id(id)
+
+   ``getdns.get_errorstr_by_id`` returns a string containing
+   text describing a getdns return code, helping to make
+   reporting errors to users a little easier.  For example:
+
+.. code-block:: python
+
+    if results.replies_full['status'] != getdns.GETDNS_RESPSTATUS_GOOD:
+        print(getdns.get_errorstr_by_id(id=results.replies_full['status'])
+        sys.exit(1)
+
+   

doc/index.rst

@@ -29,7 +29,7 @@ This version of getdns has been built and tested against Python
 2.7.  We also expect these other prerequisites to be
 installed:
 
-* `libgetdns <http://getdnsapi.net/>`_, version 0.1.2 or later
+* `libgetdns <http://getdnsapi.net/>`_, version 0.1.7 or later
 * `libldns <https://www.nlnetlabs.nl/projects/ldns/>`_,
   version 1.6.11 or later
 * `libunbound
@@ -45,7 +45,7 @@ as follows:
 
   ./configure --with-libevent
 
-This release has been tested against libgetdns 0.1.5.
+This release has been tested against libgetdns 0.1.7.
 
 Building
 ========

getdns.c

@@ -211,12 +211,34 @@ PyTypeObject getdns_ContextType = {
     (initproc)context_init,    /* tp_init           */
 };
 
-
+static PyObject *get_errorstr_by_id(PyObject *self, PyObject *args, PyObject *keywds);
 
 static struct PyMethodDef getdns_methods[] = {
+    { "get_errorstr_by_id", (PyCFunction)get_errorstr_by_id,
+      METH_VARARGS|METH_KEYWORDS, "return getdns error text by error id" },
     { 0, 0, 0 }
 };
 
+
+static PyObject *
+get_errorstr_by_id(PyObject *self, PyObject *args, PyObject *keywds)
+{
+    static char *kwlist[] = { "id",
+                            NULL };
+    int id;
+    char *errstr;
+
+    if (!PyArg_ParseTupleAndKeywords(args, keywds, "i", kwlist, &id))  {
+        PyErr_SetString(getdns_error, GETDNS_RETURN_INVALID_PARAMETER_TEXT);
+        return NULL;
+    }
+    if ((errstr = (char *)getdns_get_errorstr_by_id((uint16_t)id)) == 0) 
+        return Py_None;
+    else
+        return PyString_FromString(errstr);
+}
+
+
 PyMODINIT_FUNC
 initgetdns(void)
 {