chore(fixit): clean up vision web samples (GoogleCloudPlatform#10035)

balajismaniam · web-flow · commit 827807bfebfd · 2023-05-24T09:07:55.000-07:00
* chore(fixit): clean up vision web samples

* Added type hints and used f-strings

---------

Co-authored-by: Balaji Subramaniam &lt;balajismaniam@google.com&gt;
diff --git a/vision/snippets/web/web_detect.py b/vision/snippets/web/web_detect.py
@@ -26,20 +26,29 @@
 import argparse
 
 from google.cloud import vision
+
 # [END vision_web_detection_tutorial_imports]
 
 
-def annotate(path):
-    """Returns web annotations given the path to an image."""
+def annotate(path: str) -> vision.WebDetection:
+    """Returns web annotations given the path to an image.
+
+    Args:
+        path: path to the input image.
+
+    Returns:
+        An WebDetection object with relevant information of the
+        image from the internet (i.e., the annotations).
+    """
     # [START vision_web_detection_tutorial_annotate]
     client = vision.ImageAnnotatorClient()
 
-    if path.startswith('http') or path.startswith('gs:'):
+    if path.startswith("http") or path.startswith("gs:"):
         image = vision.Image()
         image.source.image_uri = path
 
     else:
-        with open(path, 'rb') as image_file:
+        with open(path, "rb") as image_file:
             content = image_file.read()
 
         image = vision.Image(content=content)
@@ -50,48 +59,58 @@ def annotate(path):
     return web_detection
 
 
-def report(annotations):
-    """Prints detected features in the provided web annotations."""
+def report(annotations: vision.WebDetection) -> None:
+    """Prints detected features in the provided web annotations.
+
+    Args:
+        annotations: The web annotations (WebDetection object) from which
+        the features should be parsed and printed.
+    """
     # [START vision_web_detection_tutorial_print_annotations]
     if annotations.pages_with_matching_images:
-        print('\n{} Pages with matching images retrieved'.format(
-            len(annotations.pages_with_matching_images)))
+        print(
+            f"\n{len(annotations.pages_with_matching_images)} Pages with matching images retrieved"
+        )
 
         for page in annotations.pages_with_matching_images:
-            print(f'Url   : {page.url}')
+            print(f"Url   : {page.url}")
 
     if annotations.full_matching_images:
-        print('\n{} Full Matches found: '.format(
-              len(annotations.full_matching_images)))
+        print(
+            f"\n{len(annotations.full_matching_images)} Full Matches found: "
+        )
 
         for image in annotations.full_matching_images:
-            print(f'Url  : {image.url}')
+            print(f"Url  : {image.url}")
 
     if annotations.partial_matching_images:
-        print('\n{} Partial Matches found: '.format(
-              len(annotations.partial_matching_images)))
+        print(
+            f"\n{len(annotations.partial_matching_images)} Partial Matches found: "
+        )
 
         for image in annotations.partial_matching_images:
-            print(f'Url  : {image.url}')
+            print(f"Url  : {image.url}")
 
     if annotations.web_entities:
-        print('\n{} Web entities found: '.format(
-              len(annotations.web_entities)))
+        print(f"\n{len(annotations.web_entities)} Web entities found: ")
 
         for entity in annotations.web_entities:
-            print(f'Score      : {entity.score}')
-            print(f'Description: {entity.description}')
+            print(f"Score      : {entity.score}")
+            print(f"Description: {entity.description}")
     # [END vision_web_detection_tutorial_print_annotations]
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # [START vision_web_detection_tutorial_run_application]
     parser = argparse.ArgumentParser(
         description=__doc__,
-        formatter_class=argparse.RawDescriptionHelpFormatter)
-    path_help = str('The image to detect, can be web URI, '
-                    'Google Cloud Storage, or path to local file.')
-    parser.add_argument('image_url', help=path_help)
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    path_help = str(
+        "The image to detect, can be web URI, "
+        "Google Cloud Storage, or path to local file."
+    )
+    parser.add_argument("image_url", help=path_help)
     args = parser.parse_args()
 
     report(annotate(args.image_url))
diff --git a/vision/snippets/web/web_detect_test.py b/vision/snippets/web/web_detect_test.py
@@ -20,17 +20,16 @@
 
 
 @pytest.mark.flaky(max_runs=3, min_passes=1)
-def test_detect_file(capsys):
-    file_name = ('../detect/resources/landmark.jpg')
+def test_detect_file(capsys) -> None:
+    file_name = "../detect/resources/landmark.jpg"
     web_detect.report(web_detect.annotate(file_name))
     out, _ = capsys.readouterr()
-    assert 'description' in out.lower()
+    assert "description" in out.lower()
 
 
 @pytest.mark.flaky(max_runs=3, min_passes=1)
-def test_detect_web_gsuri(capsys):
-    file_name = ('gs://{}/vision/landmark/pofa.jpg'.format(
-                 ASSET_BUCKET))
+def test_detect_web_gsuri(capsys) -> None:
+    file_name = "gs://{}/vision/landmark/pofa.jpg".format(ASSET_BUCKET)
     web_detect.report(web_detect.annotate(file_name))
     out, _ = capsys.readouterr()
-    assert 'description:' in out.lower()
+    assert "description:" in out.lower()
