Clients

Last updated 4 months ago

There are some clients in different languages that provide a higher level API, built on top of gRPC and libuast.

These clients make it easier to both parse and analyze the resulting UAST, abstracting from network communication and providing a query language to filter UASTs and can be used both as a library or as command line programs.

Existing clients

There are clients for the following languages:

Language

Status

UAST.v2 / libuast.v3

URL

Python

Alpha

WIP

https://github.com/bblfsh/client-python

Go

Beta

https://github.com/bblfsh/client-go

Scala

WIP

https://github.com/bblfsh/client-scala

Examples

The client API's differ to adapt to their language specific idioms, the following code snippets show several simple examples with the Go, Python and Scala clients that parse a file and apply a filter to return all the simple identifiers:

Go example

As a command, using bblfsh-cli:

bblfsh-cli -q [XPath query] -m semantic [file.ext]

As a library:

package main
import (
"fmt"
"gopkg.in/bblfsh/client-go.v3"
"gopkg.in/bblfsh/client-go.v3/tools"
)
func main() {
client, err := bblfsh.NewClient("localhost:9432")
if err != nil {
panic(err)
}
res, _, err := client.NewParseRequest().ReadFile("some_file.py").UAST()
if err != nil {
panic(err)
}
query := "//*[@role='Identifier' and not(@role='Qualified')]"
it, _ := tools.Filter(res, query)
for it.Next() {
fmt.Println(it.Node())
}
}

Python example

As a command:

python -m bblfsh -q [XPath query] -f [file.ext]

As a library:

import bblfsh
from bblfsh import filter as filter_uast
if __name__ == "__main__":
client = bblfsh.BblfshClient("0.0.0.0:9432")
response = client.parse("some_file.py")
if response.status != 0:
raise Exception('Some error happened: ' + str(response.errors))
query = "//*[@role='Identifier' and not(@role='Qualified')]"
nodes = filter_uast(response.uast, query)
for n in nodes:
print(n)

Scala example

As a command:

java -jar bblfsh-client-assembly-1.0.1.jar -q [XPath query] -f file.py

As a library:

import org.bblfsh.client.BblfshClient._
import gopkg.in.bblfsh.sdk.v1.protocol.generated.ParseResponse
import gopkg.in.bblfsh.sdk.v1.uast.generated.Node
import scala.io.Source
class BblfshClientParseTest {
val fileName = "src/test/resources/SampleJavaFile.java"
val fileContent = Source.fromFile(fileName) .getLines.mkString
val resp = client.parse(fileName, fileContent)
if (resp.uast.isDefined) {
rootNode = resp.uast.get
val filtered = client.filter(rootNode, "//*[@role='Identifier' and not(@role='Qualified')]")
filtered.foreach{ println }
} else {
// ... handle resp.uast.errors
}
}

Query language

When using one of the clients that support libuast you can query the UAST result nodes using an xpath-like query language. Check the UAST querying page in this documentation for the details.

Iterators

The client also allow you to instance an Iterator object and iterate over the tree on several predefined orders:

To check the exact way to use an iterator you must consult the readme of the specific client you're using, but they're generally easy to use as this Python example shows:

import bblfsh
client = bblfsh.BblfshClient("0.0.0.0:9432")
root = client.parse("/path/to/myfile.py")
for node in bblfsh.iterator(root, bblfsh.TreeOrder.PRE_ORDER):
#... do stuff with the node