feat: freezes reserved names list. (#1575)

* feat: freezes reserved names list.

* chore: fix bugs.

* chore: fix bug in async client.

* chore: fix bug in test.

* chore: update goldens.

* chore: revert some files.

---------

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

Author: Aza Tulepbergenov

gapic/utils/reserved_names.py

@@ -12,22 +12,81 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import builtins
-import itertools
-import keyword
-
+# DO NOT CHANGE this file, except when you need to add a new reserved keyword
+# from Python's new major release.
+# In an unforseen case if you have to make changes, please follow the process:
+# 1. Run the internal script to check if any of the existing Google APIs use the
+#   item to be added/removed. For external contributors, ask a Googler to do that
+#   during code review.
+# 2. If no APIs are using it, it's safe to add. Otherwise, consult with your TL.
+#
+# Changing this list will lead to breaking changes. This is happening because
+# GAPIC will add "_" to field names from that list. This will change the generated
+# client library surface (i.e. breaking change). Example of when this happened:
+# https://github.com/googleapis/gapic-generator-python/issues/835.
 
-# The exceptions to builtins are frequent and useful.
-# They are explicitly allowed message, module, and field names.
+# Each item in the list belongs to one of the following categories:
+# 1. Python keyword
+# 2. Used in Google APIs at the time of writing this PR
+# 3. Reserved word from Protoplus.
 RESERVED_NAMES = frozenset(
-    itertools.chain(
-        # We CANNOT make exceptions for keywords.
-        keyword.kwlist,
-        # We make SOME exceptions for certain names that collide with builtins.
-        set(dir(builtins)) - {"filter", "map", "id",
-            "input", "property", "vars", "set"},
-        # "mapping" and "ignore_unknown_fields" have special uses
-        # in the constructor of proto.Message
-        {"mapping", "ignore_unknown_fields"},
-    )
+    [
+        "any",
+        "format",
+        "yield",
+        "await",
+        "False",
+        "return",
+        "continue",
+        "as",
+        "pass",
+        "next",
+        "class",
+        "list",
+        "breakpoint",
+        "import",
+        "mapping",
+        "zip",
+        "locals",
+        "max",
+        "and",
+        "finally",
+        "dir",
+        "def",
+        "elif",
+        "from",
+        "nonlocal",
+        "min",
+        "not",
+        "object",
+        "global",
+        "with",
+        "else",
+        "__peg_parser__",
+        "del",
+        "range",
+        "open",
+        "assert",
+        "all",
+        "except",
+        "while",
+        "license",
+        "raise",
+        "True",
+        "lambda",
+        "for",
+        "or",
+        "if",
+        "in",
+        "async",
+        "slice",
+        "is",
+        "break",
+        "hash",
+        "None",
+        "try",
+        "type",
+        # Comes from Protoplus
+        "ignore_unknown_fields"
+    ]
 )

tests/unit/utils/test_uri_conv.py

@@ -19,8 +19,8 @@
 
 
 def test_convert_uri_fieldname():
-    uri = "abc/*/license/{license}/{xyz.reversed=reversed/*}"
-    expected_uri = "abc/*/license/{license_}/{xyz.reversed_=reversed/*}"
+    uri = "abc/*/license/{license}/{xyz.class=class/*}"
+    expected_uri = "abc/*/license/{license_}/{xyz.class_=class/*}"
     assert utils.convert_uri_fieldnames(uri) == expected_uri