Merge pull request #13 from juanjux/fix/protocol-naming

renamed SD api calls and parse_uast (to parse) module function

Author: juanjux

README.md

@@ -9,7 +9,7 @@ API
 from bblfsh import BblfshClient
 
 client = BblfshClient("0.0.0.0:9432")
-print(client.parse_uast("/path/to/file.py"))
+print(client.parse("/path/to/file.py"))
 ```
 
 Command line

bblfsh/__main__.py

@@ -27,7 +27,7 @@ def main():
     if not args.disable_bblfsh_autorun:
         ensure_bblfsh_is_running()
     client = BblfshClient(args.endpoint)
-    print(client.parse_uast(args.file, args.language))
+    print(client.parse(args.file, args.language))
 
 
 if __name__ == "__main__":

bblfsh/client.py

@@ -7,7 +7,7 @@
 sys.path.insert(0, os.path.join(os.path.dirname(__file__),
                                 "github/com/bblfsh/sdk/protocol"))
 sys.path.insert(0, os.path.dirname(__file__))
-from bblfsh.github.com.bblfsh.sdk.protocol.generated_pb2 import ParseUASTRequest
+from bblfsh.github.com.bblfsh.sdk.protocol.generated_pb2 import ParseRequest
 from bblfsh.github.com.bblfsh.sdk.protocol.generated_pb2_grpc import ProtocolServiceStub
 
 
@@ -27,7 +27,7 @@ def __init__(self, endpoint):
         self._channel = grpc.insecure_channel(endpoint)
         self._stub = ProtocolServiceStub(self._channel)
 
-    def parse_uast(self, filename, language=None, contents=None, timeout=None,
+    def parse(self, filename, language=None, contents=None, timeout=None,
                    unicode_errors="ignore"):
         """
         Queries the Babelfish server and receives the UAST for the specified
@@ -52,10 +52,10 @@ def parse_uast(self, filename, language=None, contents=None, timeout=None,
         if contents is None:
             with open(filename, errors=unicode_errors) as fin:
                 contents = fin.read()
-        request = ParseUASTRequest(filename=os.path.basename(filename),
+        request = ParseRequest(filename=os.path.basename(filename),
                                    content=contents,
                                    language=self._scramble_language(language))
-        response = self._stub.ParseUAST(request, timeout=timeout)
+        response = self._stub.Parse(request, timeout=timeout)
         return response
 
     @staticmethod

bblfsh/github/com/bblfsh/sdk/protocol/generated_pb2.py

@@ -12,17 +12,17 @@ def __init__(self, channel):
     Args:
       channel: A grpc.Channel.
     """
-    self.ParseUAST = channel.unary_unary(
-        '/github.com.bblfsh.sdk.protocol.ProtocolService/ParseUAST',
-        request_serializer=generated__pb2.ParseUASTRequest.SerializeToString,
-        response_deserializer=generated__pb2.ParseUASTResponse.FromString,
+    self.Parse = channel.unary_unary(
+        '/github.com.bblfsh.sdk.protocol.ProtocolService/Parse',
+        request_serializer=generated__pb2.ParseRequest.SerializeToString,
+        response_deserializer=generated__pb2.ParseResponse.FromString,
         )
 
 
 class ProtocolServiceServicer(object):
 
-  def ParseUAST(self, request, context):
-    """ParseUAST uses DefaultParser to process the given UAST parsing request.
+  def Parse(self, request, context):
+    """Parse uses DefaultParser to process the given parsing request to get the UAST.
     """
     context.set_code(grpc.StatusCode.UNIMPLEMENTED)
     context.set_details('Method not implemented!')
@@ -31,10 +31,10 @@ def ParseUAST(self, request, context):
 
 def add_ProtocolServiceServicer_to_server(servicer, server):
   rpc_method_handlers = {
-      'ParseUAST': grpc.unary_unary_rpc_method_handler(
-          servicer.ParseUAST,
-          request_deserializer=generated__pb2.ParseUASTRequest.FromString,
-          response_serializer=generated__pb2.ParseUASTResponse.SerializeToString,
+      'Parse': grpc.unary_unary_rpc_method_handler(
+          servicer.Parse,
+          request_deserializer=generated__pb2.ParseRequest.FromString,
+          response_serializer=generated__pb2.ParseResponse.SerializeToString,
       ),
   }
   generic_handler = grpc.method_handlers_generic_handler(

bblfsh/github/com/bblfsh/sdk/protocol/generated_pb2_grpc.py

@@ -3,7 +3,7 @@
 import docker
 
 from bblfsh import BblfshClient
-from bblfsh.github.com.bblfsh.sdk.protocol.generated_pb2 import ParseUASTResponse
+from bblfsh.github.com.bblfsh.sdk.protocol.generated_pb2 import ParseResponse
 from github.com.bblfsh.sdk.uast.generated_pb2 import Node
 from bblfsh.launcher import ensure_bblfsh_is_running
 
@@ -26,24 +26,24 @@ def setUp(self):
         self.client = BblfshClient("0.0.0.0:9432")
 
     def testUASTDefaultLanguage(self):
-        uast = self.client.parse_uast(__file__)
+        uast = self.client.parse(__file__)
         self._validate_uast(uast)
 
     def testUASTPython(self):
-        uast = self.client.parse_uast(__file__, language="Python")
+        uast = self.client.parse(__file__, language="Python")
         self._validate_uast(uast)
 
     def testUASTFileContents(self):
         with open(__file__) as fin:
             contents = fin.read()
-        uast = self.client.parse_uast("file.py", contents=contents)
+        uast = self.client.parse("file.py", contents=contents)
         self._validate_uast(uast)
 
     def _validate_uast(self, uast):
         self.assertIsNotNone(uast)
         # self.assertIsInstance() does not work - must be some metaclass magic
         self.assertEqual(type(uast).DESCRIPTOR.full_name,
-                         ParseUASTResponse.DESCRIPTOR.full_name)
+                         ParseResponse.DESCRIPTOR.full_name)
         self.assertEqual(len(uast.errors), 0)
         self.assertIsInstance(uast.uast, Node)
 

bblfsh/github/com/bblfsh/sdk/uast/generated_pb2.py

@@ -8,24 +8,38 @@ option (gogoproto.protosizer_all) = true;
 option (gogoproto.sizer_all) = false;
 option go_package = "protocol";
 
-// ParseUASTRequest is a request to parse a file and get its UAST.
-message ParseUASTRequest {
+// ParseRequest is a request to parse a file and get its UAST.
+message ParseRequest {
 	option (gogoproto.goproto_getters) = false;
 	option (gogoproto.typedecl) = false;
 	string filename = 1;
 	string language = 2;
 	string content = 3;
+	github.com.bblfsh.sdk.protocol.Encoding encoding = 4;
 }
 
-// ParseUASTResponse is the reply to ParseUASTRequest.
-message ParseUASTResponse {
+// ParseResponse is the reply to ParseRequest.
+message ParseResponse {
 	option (gogoproto.goproto_getters) = false;
 	option (gogoproto.typedecl) = false;
 	github.com.bblfsh.sdk.protocol.Status status = 1;
 	repeated string errors = 2;
 	github.com.bblfsh.sdk.uast.Node uast = 3 [(gogoproto.customname) = "UAST"];
 }
 
+// Encoding is the encoding used for the content string. Currently only
+// UTF-8 or Base64 encodings are supported. You should use UTF-8 if you can
+// and Base64 as a fallback.
+enum Encoding {
+	option (gogoproto.enumdecl) = false;
+	option (gogoproto.goproto_enum_prefix) = false;
+	option (gogoproto.goproto_enum_stringer) = false;
+	// UTF8 encoding
+	UTF8 = 0 [(gogoproto.enumvalue_customname) = "UTF8"];
+	// Base64 encoding
+	BASE64 = 1 [(gogoproto.enumvalue_customname) = "Base64"];
+}
+
 // Status is the status of a response.
 enum Status {
 	option (gogoproto.enumdecl) = false;
@@ -40,7 +54,7 @@ enum Status {
 }
 
 service ProtocolService {
-	// ParseUAST uses DefaultParser to process the given UAST parsing request.
-	rpc ParseUAST (github.com.bblfsh.sdk.protocol.ParseUASTRequest) returns (github.com.bblfsh.sdk.protocol.ParseUASTResponse);
+	// Parse uses DefaultParser to process the given parsing request to get the UAST.
+	rpc Parse (github.com.bblfsh.sdk.protocol.ParseRequest) returns (github.com.bblfsh.sdk.protocol.ParseResponse);
 }