Merge pull request #135 from warenlg/master

Add type hints

Author: juanjux

bblfsh/__init__.py

@@ -15,7 +15,7 @@ class RoleSearchException(Exception):
     pass
 
 
-def role_id(role_name):
+def role_id(role_name: str) -> int:
     try:
         name = DESCRIPTOR.enum_types_by_name["Role"].values_by_name[role_name].number
     except KeyError:
@@ -24,7 +24,7 @@ def role_id(role_name):
     return name
 
 
-def role_name(role_id):
+def role_name(role_id: int) -> str:
     try:
         id_ = DESCRIPTOR.enum_types_by_name["Role"].values_by_number[role_id].name
     except KeyError:

bblfsh/__main__.py

@@ -1,6 +1,7 @@
 import argparse
 import sys
 
+import bblfsh
 from bblfsh.pyuast import filter
 
 from bblfsh.client import BblfshClient
@@ -28,7 +29,7 @@ def setup():
     args = parser.parse_args()
     return args
 
-def run_query(root, query, mapn, as_array):
+def run_query(root: bblfsh.Node, query: str, mapn: str, as_array: bool) -> None:
     result = list(filter(root, query))
 
     if not result:

bblfsh/client.py

@@ -3,8 +3,8 @@
 
 import grpc
 
-from bblfsh.aliases import (ParseRequest, NativeParseRequest, VersionRequest,
-        ProtocolServiceStub, SupportedLanguagesRequest, SupportedLanguagesResponse)
+from bblfsh.aliases import (ParseRequest, ParseResponse, NativeParseRequest, NativeParseResponse,
+        VersionRequest, ProtocolServiceStub, SupportedLanguagesRequest, SupportedLanguagesResponse)
 from bblfsh.sdkversion import VERSION
 
 # The following two insertions fix the broken pb import paths
@@ -22,33 +22,33 @@ class BblfshClient(object):
     Babelfish gRPC client. Currently it is only capable of fetching UASTs.
     """
 
-    def __init__(self, endpoint):
+    def __init__(self, endpoint: str):
         """
         Initializes a new instance of BblfshClient.
 
         :param endpoint: The address of the Babelfish server, \
                          for example "0.0.0.0:9432"
-        :type endpoint: str
         """
         self._channel = grpc.insecure_channel(endpoint)
         self._stub = ProtocolServiceStub(self._channel)
 
     @staticmethod
-    def _check_utf8(text):
+    def _check_utf8(text: str) -> None:
         try:
             text.decode("utf-8")
         except UnicodeDecodeError:
             raise NonUTF8ContentException("Content must be UTF-8, ASCII or Base64 encoded")
 
     @staticmethod
-    def _get_contents(contents, filename):
+    def _get_contents(contents: str, filename: str) -> str:
         if contents is None:
             with open(filename, "rb") as fin:
                 contents = fin.read()
         BblfshClient._check_utf8(contents)
         return contents
 
-    def parse(self, filename, language=None, contents=None, timeout=None):
+    def parse(self, filename: str, language: str=None, contents: str=None,
+              timeout: float=None) -> ParseResponse:
         """
         Queries the Babelfish server and receives the UAST response for the specified
         file.
@@ -61,10 +61,6 @@ def parse(self, filename, language=None, contents=None, timeout=None):
         :param contents: The contents of the file. IF None, it is read from \
                          filename.
         :param timeout: The request timeout in seconds.
-        :type filename: str
-        :type language: str
-        :type contents: str
-        :type timeout: float
         :return: UAST object.
         """
 
@@ -74,7 +70,8 @@ def parse(self, filename, language=None, contents=None, timeout=None):
                                language=self._scramble_language(language))
         return self._stub.Parse(request, timeout=timeout)
 
-    def native_parse(self, filename, language=None, contents=None, timeout=None):
+    def native_parse(self, filename: str, language: str=None, contents: str=None,
+                     timeout: float=None) -> NativeParseResponse:
         """
         Queries the Babelfish server and receives the native AST response for the specified
         file.
@@ -87,17 +84,13 @@ def native_parse(self, filename, language=None, contents=None, timeout=None):
         :param contents: The contents of the file. IF None, it is read from \
                          filename.
         :param timeout: The request timeout in seconds.
-        :type filename: str
-        :type language: str
-        :type contents: str
-        :type timeout: float
         :return: Native AST object.
         """
 
         contents = self._get_contents(contents, filename)
         request = NativeParseRequest(filename=os.path.basename(filename),
-                               content=contents,
-                               language=self._scramble_language(language))
+                                     content=contents,
+                                     language=self._scramble_language(language))
         return self._stub.NativeParse(request, timeout=timeout)
 
     def supported_languages(self):
@@ -114,7 +107,7 @@ def version(self):
         return self._stub.Version(VersionRequest())
 
     @staticmethod
-    def _scramble_language(lang):
+    def _scramble_language(lang: str) -> str:
         if lang is None:
             return None
         lang = lang.lower()

bblfsh/launcher.py

@@ -5,7 +5,7 @@
 import docker
 
 
-def ensure_bblfsh_is_running():
+def ensure_bblfsh_is_running() -> bool:
     log = logging.getLogger("bblfsh")
     try:
         client = docker.from_env(version="auto")