Vision code re-organization (#3952)

googleapis · Sep 15, 2017 · 3100238 · 3100238
1 parent 6cddf11
commit 3100238
Show file tree

Hide file tree

Showing 51 changed files with 318 additions and 293 deletions.
diff --git a/packages/google-cloud-vision/.coveragerc b/packages/google-cloud-vision/.coveragerc
@@ -1,5 +1,8 @@
 [run]
 branch = True
+omit =
+  google/cloud/vision_v1/gapic/*.py
+  google/cloud/vision_v1/proto/*.py
 
 [report]
 fail_under = 100

diff --git a/packages/google-cloud-vision/google/cloud/gapic/__init__.py b/packages/google-cloud-vision/google/cloud/gapic/__init__.py
diff --git a/packages/google-cloud-vision/google/cloud/gapic/vision/__init__.py b/packages/google-cloud-vision/google/cloud/gapic/vision/__init__.py
diff --git a/packages/google-cloud-vision/google/cloud/gapic/vision/v1/image_annotator_client_config.json b/packages/google-cloud-vision/google/cloud/gapic/vision/v1/image_annotator_client_config.json
diff --git a/packages/google-cloud-vision/google/cloud/proto/__init__.py b/packages/google-cloud-vision/google/cloud/proto/__init__.py
diff --git a/packages/google-cloud-vision/google/cloud/proto/vision/__init__.py b/packages/google-cloud-vision/google/cloud/proto/vision/__init__.py
diff --git a/packages/google-cloud-vision/google/cloud/proto/vision/v1/__init__.py b/packages/google-cloud-vision/google/cloud/proto/vision/v1/__init__.py
diff --git a/packages/google-cloud-vision/google/cloud/vision/__init__.py b/packages/google-cloud-vision/google/cloud/vision/__init__.py
@@ -34,7 +34,10 @@
 __version__ = get_distribution('google-cloud-vision').version
 
 from google.cloud.vision.client import Client
-from google.cloud.vision_v1 import *  # noqa
+
+from google.cloud.vision_v1 import enums
+from google.cloud.vision_v1 import ImageAnnotatorClient
+from google.cloud.vision_v1 import types
 
 
 __all__ = (

diff --git a/packages/google-cloud-vision/google/cloud/vision/_gax.py b/packages/google-cloud-vision/google/cloud/vision/_gax.py
@@ -14,8 +14,8 @@
 
 """GAX Client for interacting with the Google Cloud Vision API."""
 
-from google.cloud.gapic.vision.v1 import image_annotator_client
-from google.cloud.proto.vision.v1 import image_annotator_pb2
+from google.cloud.vision_v1.gapic import image_annotator_client
+from google.cloud.vision_v1.proto import image_annotator_pb2
 
 from google.cloud.vision import __version__
 from google.cloud.vision.annotations import Annotations
@@ -43,7 +43,7 @@ def annotate(self, images=None, requests_pb=None):
                        e.g. [(image, [feature_one, feature_two]),]
 
         :type requests_pb: list
-        :param requests_pb: List of :class:`google.cloud.proto.vision.v1.\
+        :param requests_pb: List of :class:`google.cloud.vision_v1.proto.\
                             image_annotator_pb2.AnnotateImageRequest`
 
         :rtype: list
@@ -77,7 +77,7 @@ def _to_gapic_feature(feature):
     :param feature: Local ``Feature`` class to be converted to gRPC ``Feature``
                     instance.
 
-    :rtype: :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.Feature`
+    :rtype: :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.Feature`
     :returns: gRPC ``Feature`` converted from
               :class:`~google.cloud.vision.feature.Feature`.
     """
@@ -92,7 +92,7 @@ def _to_gapic_image(image):
     :type image: :class:`~google.cloud.vision.image.Image`
     :param image: Local ``Image`` class to be converted to gRPC ``Image``.
 
-    :rtype: :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.Image`
+    :rtype: :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.Image`
     :returns: gRPC ``Image`` converted from
               :class:`~google.cloud.vision.image.Image`.
     """

diff --git a/packages/google-cloud-vision/google/cloud/vision/_http.py b/packages/google-cloud-vision/google/cloud/vision/_http.py
@@ -70,7 +70,7 @@ def annotate(self, images=None, requests_pb=None):
         :returns: List of :class:`~googe.cloud.vision.annotations.Annotations`.
 
         :type requests_pb: list
-        :param requests_pb: List of :class:`google.cloud.proto.vision.v1.\
+        :param requests_pb: List of :class:`google.cloud.vision_v1.proto.\
                             image_annotator_b2.AnnotateImageRequest`.
 
         :rtype: list

diff --git a/packages/google-cloud-vision/google/cloud/vision/annotations.py b/packages/google-cloud-vision/google/cloud/vision/annotations.py
@@ -124,7 +124,7 @@ def from_api_repr(cls, response):
     def from_pb(cls, response):
         """Factory: construct an instance of ``Annotations`` from protobuf.
 
-        :type response: :class:`~google.cloud.proto.vision.v1.\
+        :type response: :class:`~google.cloud.vision_v1.proto.\
                         image_annotator_pb2.AnnotateImageResponse`
         :param response: ``AnnotateImageResponse`` from protobuf call.
 
@@ -138,7 +138,7 @@ def from_pb(cls, response):
 def _process_image_annotations(image):
     """Helper for processing annotation types from protobuf.
 
-    :type image: :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.\
+    :type image: :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.\
                  AnnotateImageResponse`
     :param image: ``AnnotateImageResponse`` from protobuf.
 
@@ -179,7 +179,7 @@ def _make_entity_from_pb(annotations):
     """Create an entity from a protobuf response.
 
     :type annotations:
-    :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.EntityAnnotation`
+    :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.EntityAnnotation`
     :param annotations: protobuf instance of ``EntityAnnotation``.
 
     :rtype: list
@@ -192,7 +192,7 @@ def _make_faces_from_pb(faces):
     """Create face objects from a protobuf response.
 
     :type faces:
-    :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.FaceAnnotation`
+    :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.FaceAnnotation`
     :param faces: Protobuf instance of ``FaceAnnotation``.
 
     :rtype: list
@@ -204,7 +204,7 @@ def _make_faces_from_pb(faces):
 def _make_full_text_from_pb(full_text):
     """Create text annotation object from protobuf response.
 
-    :type full_text: :class:`~google.cloud.proto.vision.v1.\
+    :type full_text: :class:`~google.cloud.vision_v1.proto.\
                      text_annotation_pb2.TextAnnotation`
     :param full_text: Protobuf instance of ``TextAnnotation``.
 
@@ -217,7 +217,7 @@ def _make_full_text_from_pb(full_text):
 def _make_image_properties_from_pb(image_properties):
     """Create ``ImageProperties`` object from a protobuf response.
 
-    :type image_properties: :class:`~google.cloud.proto.vision.v1.\
+    :type image_properties: :class:`~google.cloud.vision_v1.proto.\
                             image_annotator_pb2.ImagePropertiesAnnotation`
     :param image_properties: Protobuf instance of
                              ``ImagePropertiesAnnotation``.
@@ -231,7 +231,7 @@ def _make_image_properties_from_pb(image_properties):
 def _make_safe_search_from_pb(safe_search):
     """Create ``SafeSearchAnnotation`` object from a protobuf response.
 
-    :type safe_search: :class:`~google.cloud.proto.vision.v1.\
+    :type safe_search: :class:`~google.cloud.vision_v1.proto.\
                             image_annotator_pb2.SafeSearchAnnotation`
     :param safe_search: Protobuf instance of ``SafeSearchAnnotation``.
 
@@ -244,7 +244,7 @@ def _make_safe_search_from_pb(safe_search):
 def _make_web_detection_from_pb(annotation):
     """Create ``WebDetection`` object from a protobuf response.
 
-    :type annotation: :class:`~google.cloud.proto.vision.v1.web_detection_pb2\
+    :type annotation: :class:`~google.cloud.vision_v1.proto.web_detection_pb2\
                       .WebDetection`
     :param annotation: Protobuf instance of ``WebDetection``.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/color.py b/packages/google-cloud-vision/google/cloud/vision/color.py
@@ -45,7 +45,7 @@ def from_api_repr(cls, image_properties):
     def from_pb(cls, image_properties):
         """Factory: construct ``ImagePropertiesAnnotation`` from a response.
 
-        :type image_properties: :class:`~google.cloud.proto.vision.v1.\
+        :type image_properties: :class:`~google.cloud.vision_v1.proto.\
                                 image_annotator_pb2.ImageProperties`
         :param image_properties: Protobuf response from Vision API with image
                                  properties data.
@@ -196,7 +196,7 @@ def from_api_repr(cls, color_information):
     def from_pb(cls, color_information):
         """Factory: construct ``ColorInformation`` for a color.
 
-        :type color_information: :class:`~google.cloud.proto.vision.v1.\
+        :type color_information: :class:`~google.cloud.vision_v1.proto.\
                                  image_annotator_pb2.ColorInfo`
         :param color_information: Color data with extra meta information.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/crop_hint.py b/packages/google-cloud-vision/google/cloud/vision/crop_hint.py
@@ -53,7 +53,7 @@ def from_api_repr(cls, response):
     def from_pb(cls, response):
         """Factory: construct ``CropHint`` from Vision gRPC response.
 
-        :type response: :class:`google.cloud.proto.vision.v1.\
+        :type response: :class:`google.cloud.vision_v1.proto.\
                         image_annotator_pb2.CropHint`
         :param response: gRPC response from Vision API with entity data.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/entity.py b/packages/google-cloud-vision/google/cloud/vision/entity.py
@@ -74,7 +74,7 @@ def from_api_repr(cls, response):
     def from_pb(cls, response):
         """Factory: construct entity from Vision gRPC response.
 
-        :type response: :class:`~google.cloud.proto.vision.v1.\
+        :type response: :class:`~google.cloud.vision_v1.proto.\
                         image_annotator_pb2.AnnotateImageResponse`
         :param response: gRPC response from Vision API with entity data.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/face.py b/packages/google-cloud-vision/google/cloud/vision/face.py
@@ -50,7 +50,7 @@ def from_api_repr(cls, angle):
     def from_pb(cls, angle):
         """Factory: convert protobuf Angle object to local Angle object.
 
-        :type angle: :class:`~google.cloud.proto.vision.v1.\
+        :type angle: :class:`~google.cloud.vision_v1.proto.\
                      image_annotator_pb2.FaceAnnotation`
         :param angle: Protobuf ``FaceAnnotation`` response with angle data.
 
@@ -126,7 +126,7 @@ def from_api_repr(cls, emotions):
     def from_pb(cls, emotions):
         """Factory: construct ``Emotions`` from Vision API response.
 
-        :type emotions: :class:`~google.cloud.proto.vision.v1.\
+        :type emotions: :class:`~google.cloud.vision_v1.proto.\
                         image_annotator_pb2.FaceAnnotation`
         :param emotions: Response dictionary representing a face with emotions.
 
@@ -225,7 +225,7 @@ def from_api_repr(cls, face):
     def from_pb(cls, face):
         """Factory: construct an instance of a Face from an protobuf response
 
-        :type face: :class:`~google.cloud.proto.vision.v1.\
+        :type face: :class:`~google.cloud.vision_v1.proto.\
                        image_annotator_pb2.AnnotateImageResponse`
         :param face: ``AnnotateImageResponse`` from gRPC call.
 
@@ -397,7 +397,7 @@ def from_api_repr(cls, face):
     def from_pb(cls, face):
         """Factory: construct image properties from image.
 
-        :type face: :class:`~google.cloud.proto.vision.v1.image_annotator_pb2.\
+        :type face: :class:`~google.cloud.vision_v1.proto.image_annotator_pb2.\
                     FaceAnnotation`
         :param face: Protobuf instace of `Face`.
 
@@ -508,7 +508,7 @@ def from_api_repr(cls, landmark):
     def from_pb(cls, landmark):
         """Factory: construct an instance of a Landmark from a response.
 
-        :type landmark: :class:`~google.cloud.proto.vision.v1.\
+        :type landmark: :class:`~google.cloud.vision_v1.proto.\
                         image_annotator_pb.FaceAnnotation.Landmark`
         :param landmark: Landmark representation from Vision API.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/geometry.py b/packages/google-cloud-vision/google/cloud/vision/geometry.py
@@ -43,7 +43,7 @@ def from_api_repr(cls, vertices):
     def from_pb(cls, vertices):
         """Factory: construct BoundsBase instance from a protobuf response.
 
-        :type vertices: :class:`~google.cloud.proto.vision.v1.\
+        :type vertices: :class:`~google.cloud.vision_v1.proto.\
                                  geometry_pb2.BoundingPoly`
         :param vertices: List of vertices.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/image.py b/packages/google-cloud-vision/google/cloud/vision/image.py
@@ -17,7 +17,7 @@
 
 from base64 import b64encode
 
-from google.cloud.proto.vision.v1 import image_annotator_pb2
+from google.cloud.vision_v1.proto import image_annotator_pb2
 
 from google.cloud.vision._gax import _to_gapic_image
 from google.cloud._helpers import _to_bytes
@@ -120,7 +120,7 @@ def _detect_annotation_from_pb(self, requests_pb=None):
         """Helper for pre-made requests.
 
         :type requests_pb: list
-        :param requests_pb: List of :class:`google.cloud.proto.vision.v1.\
+        :param requests_pb: List of :class:`google.cloud.vision_v1.proto.\
                             image_annotator_pb2.AnnotateImageRequest`
 
         :rtype: :class:`~google.cloud.vision.annotations.Annotations`

diff --git a/packages/google-cloud-vision/google/cloud/vision/likelihood.py b/packages/google-cloud-vision/google/cloud/vision/likelihood.py
@@ -17,7 +17,7 @@
 
 from enum import Enum
 
-from google.cloud.proto.vision.v1 import image_annotator_pb2
+from google.cloud.vision_v1.proto import image_annotator_pb2
 
 
 def _get_pb_likelihood(likelihood):

diff --git a/packages/google-cloud-vision/google/cloud/vision/safe_search.py b/packages/google-cloud-vision/google/cloud/vision/safe_search.py
@@ -66,7 +66,7 @@ def from_api_repr(cls, response):
     def from_pb(cls, image):
         """Factory: construct SafeSearchAnnotation from Vision API response.
 
-        :type image: :class:`~google.cloud.proto.vision.v1.\
+        :type image: :class:`~google.cloud.vision_v1.proto.\
                       image_annotator_pb2.SafeSearchAnnotation`
         :param image: Protobuf response from Vision API with safe search data.
 

diff --git a/packages/google-cloud-vision/google/cloud/vision/text.py b/packages/google-cloud-vision/google/cloud/vision/text.py
@@ -16,7 +16,7 @@
 
 import json
 
-from google.cloud.proto.vision.v1 import text_annotation_pb2
+from google.cloud.vision_v1.proto import text_annotation_pb2
 from google.protobuf import json_format
 
 
@@ -25,7 +25,7 @@ class TextAnnotation(object):
 
     :type pages: list
     :param pages: List of
-                  :class:`~google.cloud.proto.vision.v1.\
+                  :class:`~google.cloud.vision_v1.proto.\
                   text_annotation_pb2.Page`.
 
     :type text: str
@@ -54,7 +54,7 @@ def from_api_repr(cls, annotation):
     def from_pb(cls, annotation):
         """Factory: construct an instance of ``TextAnnotation`` from protobuf.
 
-        :type annotation: :class:`~google.cloud.proto.vision.v1.\
+        :type annotation: :class:`~google.cloud.vision_v1.proto.\
                           text_annotation_pb2.TextAnnotation`
         :param annotation: Populated instance of ``TextAnnotation``.
 
@@ -68,7 +68,7 @@ def pages(self):
         """Pages found in text image.
 
         :rtype: list
-        :returns: List of :class:`~google.cloud.proto.vision.v1.\
+        :returns: List of :class:`~google.cloud.vision_v1.proto.\
                           text_annotation_pb2.Page`.
         """
         return self._pages