Skip to content

Commit 62fbcc8

Browse files
committed
refactor(api-core): rename gapic_v1.method_helpers to gapic_v1.request and improve docstring
1 parent 79f3668 commit 62fbcc8

3 files changed

Lines changed: 12 additions & 5 deletions

File tree

packages/google-api-core/google/api_core/gapic_v1/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
# Older Python versions safely ignore this variable.
2626
__lazy_modules__: Set[str] = {
2727
"google.api_core.gapic_v1.client_info",
28-
"google.api_core.gapic_v1.method_helpers",
28+
"google.api_core.gapic_v1.request",
2929
"google.api_core.gapic_v1.routing_header",
3030
}
31-
__all__ = ["client_info", "method_helpers", "routing_header"]
31+
__all__ = ["client_info", "request", "routing_header"]
3232

3333
if _has_grpc:
3434
__lazy_modules__.update(
@@ -42,7 +42,7 @@
4242

4343
from google.api_core.gapic_v1 import ( # noqa: E402
4444
client_info,
45-
method_helpers,
45+
request,
4646
routing_header,
4747
)
4848

packages/google-api-core/google/api_core/gapic_v1/method_helpers.py renamed to packages/google-api-core/google/api_core/gapic_v1/request.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@
1414
# limitations under the License.
1515
#
1616

17-
"""Helpers for method requests."""
17+
"""Helpers for preparing and structuring API requests.
18+
19+
This module provides utilities to preprocess request parameters and objects
20+
before invoking API methods, such as automatically generating request IDs
21+
if they are not already set.
22+
"""
1823

1924
import uuid
2025
from typing import Union
26+
2127
import google.protobuf.message
2228

2329

packages/google-api-core/tests/unit/gapic/test_method_helpers.py renamed to packages/google-api-core/tests/unit/gapic/test_request.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
# limitations under the License.
1515

1616
import re
17-
from google.api_core.gapic_v1.method_helpers import setup_request_id
17+
18+
from google.api_core.gapic_v1.request import setup_request_id
1819

1920

2021
def test_setup_request_id():

0 commit comments

Comments
 (0)