Python client v3 (UASTv2)

README.md

@@ -48,16 +48,18 @@ Please, read the [getting started](https://doc.bblf.sh/using-babelfish/getting-s
 import bblfsh
 
 client = bblfsh.BblfshClient("0.0.0.0:9432")
-uast = client.parse("/path/to/file.py").uast
-print(uast)
+uast = client.parse("/path/to/file.py")
+print(uast.load())
+
 # "filter' allows you to use XPath queries to filter on result nodes:
-print(bblfsh.filter(uast, "//Import[@roleImport and @roleDeclaration]//alias"))
+it = uast.filter("//Import[@role='Import' and @role='Declaration']//alias")
+for node in it:
+    print(node.load())
 
-# filter\_[bool|string|number] must be used when using XPath functions returning
-# these types:
-print(bblfsh.filter_bool(uast, "boolean(//*[@strtOffset or @endOffset])"))
-print(bblfsh.filter_string(uast, "name(//*[1])"))
-print(bblfsh.filter_number(uast, "count(//*)"))
+# filter must be used when using XPath functions returning these types:
+print(uast.filter("boolean(//*[@strtOffset or @endOffset])"))
+print(uast.filter("name(//*[1])"))
+print(uast.filter("count(//*)"))
 
 # You can also iterate on several tree iteration orders:
 it = bblfsh.iterator(uast, bblfsh.TreeOrder.PRE_ORDER)

bblfsh/client.py

@@ -3,7 +3,7 @@
 
 import grpc
 
-import bblfsh.pyuast
+from bblfsh.pyuast import decode as uast_decode
 
 from bblfsh.aliases import ParseRequest, DriverStub, ProtocolServiceStub, VersionRequest, SupportedLanguagesRequest
 
@@ -83,7 +83,8 @@ def parse(self, filename, language=None, contents=None, mode=None, raw=False, ti
         """
         if raw:
             return response.uast
-        return pyuast.decode(response.uast, 0)
+        ctx = uast_decode(response.uast, format=0)
+        return ctx
 
     def supported_languages(self):
         sup_response = self._stub_v1.SupportedLanguages(SupportedLanguagesRequest())

bblfsh/pyuast.cc

@@ -263,7 +263,7 @@ class ContextExt {
         }
 
         uast::Iterator<NodeHandle> *it = ctx->Filter(unode, query);
-        delete(query);
+
         return newIter(it, false);
     }
 
@@ -309,13 +309,22 @@ static PyObject *PyContextExt_root(PyContextExt *self, PyObject *Py_UNUSED(ignor
     return self->p->RootNode();
 }
 
+// PyContextExt_load returns a root node converted to Python object.
+// Returns a new reference.
+static PyObject *PyContextExt_load(PyContextExt *self, PyObject *Py_UNUSED(ignored)) {
+    PyObject* root = PyContextExt_root(self, nullptr);
+    return PyNodeExt_load((PyNodeExt*)root, nullptr);
+}
+
 // PyContextExt_filter filters UAST.
 // Returns a new reference.
-static PyObject *PyContextExt_filter(PyContextExt *self, PyObject *args) {
-    PyObject *node = nullptr;
+static PyObject *PyContextExt_filter(PyContextExt *self, PyObject *args, PyObject *kwargs) {
+    char* kwds[] = {"query", "node", NULL};
     char *query = nullptr;
-    if (!PyArg_ParseTuple(args, "Os", &node, &query))
+    PyObject *node = nullptr;
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|O", kwds, &query, &node))
       return nullptr;
+    // TODO: freeing the query leads to a segfault; need to clarify why
     return self->p->Filter(node, query);
 }
 
@@ -333,7 +342,10 @@ static PyMethodDef PyContextExt_methods[] = {
     {"root", (PyCFunction) PyContextExt_root, METH_NOARGS,
      "Return the root node attached to this query context"
     },
-    {"filter", (PyCFunction) PyContextExt_filter, METH_VARARGS,
+    {"load", (PyCFunction) PyContextExt_load, METH_NOARGS,
+     "Load external node to Python"
+    },
+    {"filter", (PyCFunction) PyContextExt_filter, METH_VARARGS | METH_KEYWORDS,
      "Filter a provided UAST with XPath"
     },
     {"encode", (PyCFunction) PyContextExt_encode, METH_VARARGS,
@@ -869,10 +881,11 @@ static PyObject *PyContext_root(PyContext *self, PyObject *Py_UNUSED(ignored)) {
     return self->p->RootNode();
 }
 
-static PyObject *PyContext_filter(PyContext *self, PyObject *args) {
-    PyObject *node = nullptr;
+static PyObject *PyContext_filter(PyContext *self, PyObject *args, PyObject *kwargs) {
+    char* kwds[] = {"query", "node", NULL};
     char *query = nullptr;
-    if (!PyArg_ParseTuple(args, "Os", &node, &query))
+    PyObject *node = nullptr;
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|O", kwds, &query, &node))
       return nullptr;
     return self->p->Filter(node, query);
 }
@@ -889,7 +902,7 @@ static PyMethodDef PyContext_methods[] = {
     {"root", (PyCFunction) PyContext_root, METH_NOARGS,
      "Return the root node attached to this query context"
     },
-    {"filter", (PyCFunction) PyContext_filter, METH_VARARGS,
+    {"filter", (PyCFunction) PyContext_filter, METH_VARARGS | METH_KEYWORDS,
      "Filter a provided UAST with XPath"
     },
     {"encode", (PyCFunction) PyContext_encode, METH_VARARGS,
@@ -964,11 +977,12 @@ static PyObject *PyUastIter_new(PyObject *self, PyObject *args) {
   return ctx->Iterate(obj, (TreeOrder)order, true);
 }
 
-static PyObject *PyContextExt_decode(PyObject *self, PyObject *args) {
+static PyObject *PyContextExt_decode(PyObject *self, PyObject *args, PyObject *kwargs) {
+    char* kwds[] = {"data", "format", NULL};
     PyObject *obj = nullptr;
-    UastFormat format = UAST_BINARY; // TODO: make it a kwarg
+    UastFormat format = UAST_BINARY; // TODO: make it an enum
 
-    if (!PyArg_ParseTuple(args, "Oi", &obj, &format))
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|i", kwds, &obj, &format))
       return nullptr;
 
     Py_buffer buf;
@@ -992,6 +1006,7 @@ static PyObject *PyContextExt_decode(PyObject *self, PyObject *args) {
 }
 
 static PyObject *PyContext_new(PyObject *self, PyObject *args) {
+    // TODO: optionally accept root object
     if (!PyArg_ParseTuple(args, "")) {
       return nullptr;
     }
@@ -1006,7 +1021,7 @@ static PyObject *PyContext_new(PyObject *self, PyObject *args) {
 
 static PyMethodDef extension_methods[] = {
     {"iterator", PyUastIter_new, METH_VARARGS, "Get an iterator over a node"},
-    {"decode", PyContextExt_decode, METH_VARARGS, "Decode UAST from a byte array"},
+    {"decode", (PyCFunction)PyContextExt_decode, METH_VARARGS | METH_KEYWORDS, "Decode UAST from a byte array"},
     {"uast", PyContext_new, METH_VARARGS, "Creates a new UAST context"},
     {nullptr, nullptr, 0, nullptr}
 };

setup.py

@@ -13,7 +13,7 @@
 from setuptools.command.build_ext import build_ext
 
 VERSION = "3.0.0"
-LIBUAST_VERSION = "v3.0.0-rc2"
+LIBUAST_VERSION = "v3.0.0-rc3"
 LIBUAST_ARCH = "linux-amd64"
 SDK_V1_VERSION = "v1.16.1"
 SDK_V1_MAJOR = SDK_V1_VERSION.split('.')[0]
@@ -25,8 +25,7 @@
 log = logging.getLogger("setup.py")
 
 # For debugging libuast-client interactions, set to True in production!
-# FIXME: change to true
-GET_LIBUAST = False
+GET_LIBUAST = True
 if not GET_LIBUAST:
     log.warning("WARNING: not retrieving libuast, using local version")