Skip to content

fix: add special method parameters to set of reserved module names #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
software-dov merged 3 commits into from
Jan 28, 2022
Merged

fix: add special method parameters to set of reserved module names #1168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
500b5a2
fix: add special method parameters to set of reserved module names
software-dov Jan 28, 2022
bf583eb
Stylecheck
software-dov Jan 28, 2022
77bfb64
Merge branch 'main' into metadata
software-dov Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion gapic/schema/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,12 +262,16 @@ def build(
file_descriptors,
), opts=opts)

# "metadata", "retry", "timeout", and "request" are reserved words in client methods.
invalid_module_names = set(keyword.kwlist) | {
"metadata", "retry", "timeout", "request"}

def disambiguate_keyword_fname(
full_path: str,
visited_names: Container[str]) -> str:
path, fname = os.path.split(full_path)
name, ext = os.path.splitext(fname)
if name in keyword.kwlist or full_path in visited_names:
if name in invalid_module_names or full_path in visited_names:
name += "_"
full_path = os.path.join(path, name + ext)
if full_path in visited_names:
Expand Down
26 changes: 25 additions & 1 deletion tests/unit/schema/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,27 @@ def test_proto_keyword_fname():
name='class.proto',
package='google.keywords.v1',
messages=(make_message_pb2(name='ClassRequest', fields=()),),
)
),
make_file_pb2(
name='metadata.proto',
package='google.keywords.v1',
messages=(make_message_pb2(name='MetadataRequest', fields=()),),
),
make_file_pb2(
name='retry.proto',
package='google.keywords.v1',
messages=(make_message_pb2(name='RetryRequest', fields=()),),
),
make_file_pb2(
name='timeout.proto',
package='google.keywords.v1',
messages=(make_message_pb2(name='TimeoutRequest', fields=()),),
),
make_file_pb2(
name='request.proto',
package='google.keywords.v1',
messages=(make_message_pb2(name='RequestRequest', fields=()),),
),
)

# We can't create new collisions, so check that renames cascade.
Expand All @@ -243,6 +263,10 @@ def test_proto_keyword_fname():
'import__.proto',
'class_.proto',
'class__.proto',
'metadata_.proto',
'retry_.proto',
'timeout_.proto',
'request_.proto',
}


Expand Down