Skip to content
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.

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

docs: add docstring return type section to BigQueryOptions class #964

Merged
merged 14 commits into from
Oct 3, 2024
Merged
Changes from 1 commit
Commits
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
48 changes: 45 additions & 3 deletions bigframes/_config/bigquery_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ def application_name(self) -> Optional[str]:
The application name to amend to the user agent sent to Google APIs.
The recommended format is ``"application-name/major.minor.patch_version"``
or ``"(gpn:PartnerName;)"`` for official Google partners.

Returns:
None or str:
Application name as a string if exists; otherwise None.
"""
return self._application_name

Expand All @@ -114,7 +118,12 @@ def application_name(self, value: Optional[str]):

@property
def credentials(self) -> Optional[google.auth.credentials.Credentials]:
"""The OAuth2 credentials to use for this client."""
"""The OAuth2 credentials to use for this client.

Returns:
None or google.auth.credentials.Credentials:
google.auth.credentials.Credentials if exists; otherwise None.
"""
return self._credentials

@credentials.setter
Expand All @@ -128,6 +137,10 @@ def location(self) -> Optional[str]:
"""Default location for job, datasets, and tables.

For more information, see https://cloud.google.com/bigquery/docs/locations BigQuery locations.

Returns:
None or str:
Default location as a string; otherwise None.
"""
return self._location

Expand All @@ -140,7 +153,12 @@ def location(self, value: Optional[str]):

@property
def project(self) -> Optional[str]:
"""Google Cloud project ID to use for billing and as the default project."""
"""Google Cloud project ID to use for billing and as the default project.

Returns:
None or str:
Google Cloud project ID as a string; otherwise None.
"""
return self._project

@project.setter
Expand All @@ -163,6 +181,10 @@ def bq_connection(self) -> Optional[str]:

If this option isn't provided, or project or location aren't provided,
session will use its default project/location/connection_id as default connection.

Returns:
None or str:
Name of the BigQuery connection as a string; otherwise None.
"""
return self._bq_connection

Expand All @@ -181,6 +203,12 @@ def skip_bq_connection_check(self) -> bool:
connection (default or user-provided) does not exist, or it does not have
necessary permissions set up to support BigQuery DataFrames operations,
then a runtime error will be reported.

Returns:
bool:
A boolean value, where True indicates a BigQuery connection is
not created or the connection does not have necessary
permissions set up; otherwise False.
"""
return self._skip_bq_connection_check

Expand All @@ -203,6 +231,11 @@ def use_regional_endpoints(self) -> bool:
Requires that ``location`` is set. For example, to connect to
asia-northeast1-bigquery.googleapis.com, specify
``location='asia-northeast1'`` and ``use_regional_endpoints=True``.

Returns:
bool:
A boolean value, where True indicates that a location is set;
otherwise False.
"""
return self._use_regional_endpoints

Expand Down Expand Up @@ -235,6 +268,10 @@ def kms_key_name(self) -> Optional[str]:
Cloud KMS CryptoKey Encrypter/Decrypter IAM role in the key's project.
For more information, see https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role
Assign the Encrypter/Decrypter.

Returns:
None or str:
Customer managed encryption key as a string; otherwise None.
arwas11 marked this conversation as resolved.
Show resolved Hide resolved
"""
return self._kms_key_name

Expand All @@ -247,7 +284,12 @@ def kms_key_name(self, value: str):

@property
def ordering_mode(self) -> Literal["strict", "partial"]:
"""Controls whether total row order is always maintained for DataFrame/Series."""
"""Controls whether total row order is always maintained for DataFrame/Series.

Returns:
Literal:
A literal string value of either strict or partial ordering mode.
"""
return self._ordering_mode.value

@ordering_mode.setter
Expand Down