|
| 1 | +# 2.0.0 Migration Guide |
| 2 | + |
| 3 | +The 2.0 release of the `google-cloud-vision` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage. |
| 4 | + |
| 5 | +If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-vision/issues). |
| 6 | + |
| 7 | +## Supported Python Versions |
| 8 | + |
| 9 | +> **WARNING**: Breaking change |
| 10 | +
|
| 11 | +The 2.0.0 release requires Python 3.6+. |
| 12 | + |
| 13 | + |
| 14 | +## Method Calls |
| 15 | + |
| 16 | +> **WARNING**: Breaking change |
| 17 | +
|
| 18 | +Methods expect request objects. We provide a script that will convert most common use cases. |
| 19 | + |
| 20 | +* Install the library |
| 21 | + |
| 22 | +```py |
| 23 | +python3 -m pip install google-cloud-vision |
| 24 | +``` |
| 25 | + |
| 26 | +* The script `fixup_vision_v1_keywords.py` is shipped with the library. It expects |
| 27 | +an input directory (with the code to convert) and an empty destination directory. |
| 28 | + |
| 29 | +```sh |
| 30 | +$ fixup_vision_v1_keywords.py --input-directory .samples/ --output-directory samples/ |
| 31 | +``` |
| 32 | + |
| 33 | +**Before:** |
| 34 | +```py |
| 35 | +from google.cloud import vision_v1 |
| 36 | + |
| 37 | +client = vision_v1.ProductSearchClient() |
| 38 | + |
| 39 | +product_set = client.get_product_set("name") |
| 40 | +``` |
| 41 | + |
| 42 | + |
| 43 | +**After:** |
| 44 | +```py |
| 45 | +from google.cloud import vision_v1 |
| 46 | + |
| 47 | +client = vision_v1.ProductSearchClient() |
| 48 | + |
| 49 | +product_set = client.get_product_set(request={"name": "name"}) |
| 50 | +``` |
| 51 | + |
| 52 | +### More Details |
| 53 | + |
| 54 | +In `google-cloud-vision<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters. |
| 55 | + |
| 56 | +**Before:** |
| 57 | +```py |
| 58 | + def create_product_set( |
| 59 | + self, |
| 60 | + parent, |
| 61 | + product_set, |
| 62 | + product_set_id=None, |
| 63 | + retry=google.api_core.gapic_v1.method.DEFAULT, |
| 64 | + timeout=google.api_core.gapic_v1.method.DEFAULT, |
| 65 | + metadata=None, |
| 66 | + ): |
| 67 | +``` |
| 68 | + |
| 69 | +In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional. |
| 70 | + |
| 71 | +Some methods have additional keyword only parameters. The available parameters depend on the `google.api.method_signature` annotation specified by the API producer. |
| 72 | + |
| 73 | + |
| 74 | +**After:** |
| 75 | +```py |
| 76 | + def create_product_set( |
| 77 | + self, |
| 78 | + request: product_search_service.CreateProductSetRequest = None, |
| 79 | + *, |
| 80 | + parent: str = None, |
| 81 | + product_set: product_search_service.ProductSet = None, |
| 82 | + product_set_id: str = None, |
| 83 | + retry: retries.Retry = gapic_v1.method.DEFAULT, |
| 84 | + timeout: float = None, |
| 85 | + metadata: Sequence[Tuple[str, str]] = (), |
| 86 | + ) -> product_search_service.ProductSet: |
| 87 | +``` |
| 88 | + |
| 89 | +> **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive. |
| 90 | +> Passing both will result in an error. |
| 91 | +
|
| 92 | + |
| 93 | +Both of these calls are valid: |
| 94 | + |
| 95 | +```py |
| 96 | +response = client.create_product_set( |
| 97 | + request={ |
| 98 | + "parent": parent, |
| 99 | + "product_set_id": product_set_id, |
| 100 | + "product_set": product_set |
| 101 | + } |
| 102 | +) |
| 103 | +``` |
| 104 | + |
| 105 | +```py |
| 106 | +response = client.create_product_set( |
| 107 | + parent=parent, |
| 108 | + product_set_id=product_set_id, |
| 109 | + product_set=product_set |
| 110 | +) |
| 111 | +``` |
| 112 | + |
| 113 | +This call is invalid because it mixes `request` with a keyword argument `product_set`. Executing this code |
| 114 | +will result in an error. |
| 115 | + |
| 116 | +```py |
| 117 | +response = client.create_product_set( |
| 118 | + request={ |
| 119 | + "parent": parent, |
| 120 | + "product_set_id": product_set_id |
| 121 | + }, |
| 122 | + product_set=product_set |
| 123 | +) |
| 124 | +``` |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | +## Enums and Types |
| 129 | + |
| 130 | + |
| 131 | +> **WARNING**: Breaking change |
| 132 | +
|
| 133 | +The submodules `enums` and `types` have been removed. |
| 134 | + |
| 135 | +**Before:** |
| 136 | +```py |
| 137 | +from google.cloud import vision_v1 |
| 138 | + |
| 139 | +likelihood = vision_v1.enums.Likelihood.UNKNOWN |
| 140 | +request = vision_v1.types.GetProductSetRequest(name="name") |
| 141 | +``` |
| 142 | + |
| 143 | + |
| 144 | +**After:** |
| 145 | +```py |
| 146 | +from google.cloud import vision_v1 |
| 147 | + |
| 148 | +likelihood = vision_v1.Likelihood.UNKNOWN |
| 149 | +request = vision_v1.GetProductSetRequest(name="name") |
| 150 | +``` |
| 151 | + |
| 152 | +## Location Path Helper Method |
| 153 | + |
| 154 | +Loation path helper method has been removed. Please construct |
| 155 | +the path manually. |
| 156 | + |
| 157 | +```py |
| 158 | +project = "my-project" |
| 159 | +location = "location" |
| 160 | + |
| 161 | +location_path = f"projects/{project}/locations/{location}" |
| 162 | +``` |
0 commit comments