Skip to content

Commit 966e893

Browse files
authored
chore: Adjust gapic namespace to google.cloud.bigquery_datatransfer (#61)
* chore: use google.cloud.bigquery_datatransfer namespace Using google.cloud.bigquery.datatransfer turned out to be too problematic to use with the google.cloud.bigquery library (namespace clashes). * Adjust code to renamed namespace * Update UPGRADING guide with new (old) namespace
1 parent 4a05e61 commit 966e893

File tree

33 files changed

+106
-109
lines changed

33 files changed

+106
-109
lines changed

packages/google-cloud-bigquery-datatransfer/CONTRIBUTING.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -80,25 +80,6 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
8080

8181
.. nox: https://pypi.org/project/nox/
8282
83-
Note on Editable Installs / Develop Mode
84-
========================================
85-
86-
- As mentioned previously, using ``setuptools`` in `develop mode`_
87-
or a ``pip`` `editable install`_ is not possible with this
88-
library. This is because this library uses `namespace packages`_.
89-
For context see `Issue #2316`_ and the relevant `PyPA issue`_.
90-
91-
Since ``editable`` / ``develop`` mode can't be used, packages
92-
need to be installed directly. Hence your changes to the source
93-
tree don't get incorporated into the **already installed**
94-
package.
95-
96-
.. _namespace packages: https://www.python.org/dev/peps/pep-0420/
97-
.. _Issue #2316: https://github.com/GoogleCloudPlatform/google-cloud-python/issues/2316
98-
.. _PyPA issue: https://github.com/pypa/packaging-problems/issues/12
99-
.. _develop mode: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
100-
.. _editable install: https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs
101-
10283
*****************************************
10384
I'm getting weird errors... Can you help?
10485
*****************************************

packages/google-cloud-bigquery-datatransfer/UPGRADING.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,24 @@ The 2.0.0 release requires Python 3.6+.
3838

3939
> **WARNING**: Breaking change
4040
41-
The library was moved into `google.cloud.bigquery` namespace. Existing imports
42-
need to be updated.
41+
42+
### Version 2.1.0
43+
44+
The library had its old namespace restored, since importing from
45+
`google.cloud.bigquery` clashed with the `google-cloud-bigquery` library when the
46+
latter was also installed.
47+
48+
The import paths that were changed in version `2.0.0` should be reverted:
49+
50+
```py
51+
from google.cloud import bigquery_datatransfer
52+
from google.cloud import bigquery_datatransfer_v1
53+
```
54+
55+
### Version 2.0.0
56+
57+
(obsolete) The library was moved into `google.cloud.bigquery` namespace. Existing
58+
imports need to be updated, unless using a version `>=2.1.0`.
4359

4460
**Before:**
4561
```py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Services for Google Cloud Bigquery Datatransfer v1 API
22
======================================================
33

4-
.. automodule:: google.cloud.bigquery.datatransfer_v1.services.data_transfer_service
4+
.. automodule:: google.cloud.bigquery_datatransfer_v1.services.data_transfer_service
55
:members:
66
:inherited-members:
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Types for Google Cloud Bigquery Datatransfer v1 API
22
===================================================
33

4-
.. automodule:: google.cloud.bigquery.datatransfer_v1.types
4+
.. automodule:: google.cloud.bigquery_datatransfer_v1.types
55
:members:

packages/google-cloud-bigquery-datatransfer/docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
"sphinx.ext.autosummary",
4040
"sphinx.ext.intersphinx",
4141
"sphinx.ext.coverage",
42+
"sphinx.ext.doctest",
4243
"sphinx.ext.napoleon",
4344
"sphinx.ext.todo",
4445
"sphinx.ext.viewcode",

packages/google-cloud-bigquery-datatransfer/docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ API Reference
88
.. toctree::
99
:maxdepth: 2
1010

11-
Client <datatransfer_v1/services>
12-
Types <datatransfer_v1/types>
11+
Client <bigquery_datatransfer_v1/services>
12+
Types <bigquery_datatransfer_v1/types>
1313

1414

1515
Migration Guide

packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery/datatransfer/__init__.py renamed to packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer/__init__.py

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,84 +15,84 @@
1515
# limitations under the License.
1616
#
1717

18-
from google.cloud.bigquery.datatransfer_v1.services.data_transfer_service.async_client import (
18+
from google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.async_client import (
1919
DataTransferServiceAsyncClient,
2020
)
21-
from google.cloud.bigquery.datatransfer_v1.services.data_transfer_service.client import (
21+
from google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.client import (
2222
DataTransferServiceClient,
2323
)
24-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
24+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
2525
CheckValidCredsRequest,
2626
)
27-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
27+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
2828
CheckValidCredsResponse,
2929
)
30-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
30+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
3131
CreateTransferConfigRequest,
3232
)
33-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import DataSource
34-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import DataSourceParameter
35-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
33+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import DataSource
34+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import DataSourceParameter
35+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
3636
DeleteTransferConfigRequest,
3737
)
38-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
38+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
3939
DeleteTransferRunRequest,
4040
)
41-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
41+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
4242
GetDataSourceRequest,
4343
)
44-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
44+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
4545
GetTransferConfigRequest,
4646
)
47-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
47+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
4848
GetTransferRunRequest,
4949
)
50-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
50+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
5151
ListDataSourcesRequest,
5252
)
53-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
53+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
5454
ListDataSourcesResponse,
5555
)
56-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
56+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
5757
ListTransferConfigsRequest,
5858
)
59-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
59+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
6060
ListTransferConfigsResponse,
6161
)
62-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
62+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
6363
ListTransferLogsRequest,
6464
)
65-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
65+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
6666
ListTransferLogsResponse,
6767
)
68-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
68+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
6969
ListTransferRunsRequest,
7070
)
71-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
71+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
7272
ListTransferRunsResponse,
7373
)
74-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
74+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
7575
ScheduleTransferRunsRequest,
7676
)
77-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
77+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
7878
ScheduleTransferRunsResponse,
7979
)
80-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
80+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
8181
StartManualTransferRunsRequest,
8282
)
83-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
83+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
8484
StartManualTransferRunsResponse,
8585
)
86-
from google.cloud.bigquery.datatransfer_v1.types.datatransfer import (
86+
from google.cloud.bigquery_datatransfer_v1.types.datatransfer import (
8787
UpdateTransferConfigRequest,
8888
)
89-
from google.cloud.bigquery.datatransfer_v1.types.transfer import EmailPreferences
90-
from google.cloud.bigquery.datatransfer_v1.types.transfer import ScheduleOptions
91-
from google.cloud.bigquery.datatransfer_v1.types.transfer import TransferConfig
92-
from google.cloud.bigquery.datatransfer_v1.types.transfer import TransferMessage
93-
from google.cloud.bigquery.datatransfer_v1.types.transfer import TransferRun
94-
from google.cloud.bigquery.datatransfer_v1.types.transfer import TransferState
95-
from google.cloud.bigquery.datatransfer_v1.types.transfer import TransferType
89+
from google.cloud.bigquery_datatransfer_v1.types.transfer import EmailPreferences
90+
from google.cloud.bigquery_datatransfer_v1.types.transfer import ScheduleOptions
91+
from google.cloud.bigquery_datatransfer_v1.types.transfer import TransferConfig
92+
from google.cloud.bigquery_datatransfer_v1.types.transfer import TransferMessage
93+
from google.cloud.bigquery_datatransfer_v1.types.transfer import TransferRun
94+
from google.cloud.bigquery_datatransfer_v1.types.transfer import TransferState
95+
from google.cloud.bigquery_datatransfer_v1.types.transfer import TransferType
9696

9797
__all__ = (
9898
"CheckValidCredsRequest",
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from google.auth import credentials # type: ignore
2929
from google.oauth2 import service_account # type: ignore
3030

31-
from google.cloud.bigquery.datatransfer_v1.services.data_transfer_service import pagers
32-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
33-
from google.cloud.bigquery.datatransfer_v1.types import transfer
31+
from google.cloud.bigquery_datatransfer_v1.services.data_transfer_service import pagers
32+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
33+
from google.cloud.bigquery_datatransfer_v1.types import transfer
3434
from google.protobuf import duration_pb2 as duration # type: ignore
3535
from google.protobuf import field_mask_pb2 as field_mask # type: ignore
3636
from google.protobuf import struct_pb2 as struct # type: ignore
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
from google.auth.exceptions import MutualTLSChannelError # type: ignore
3333
from google.oauth2 import service_account # type: ignore
3434

35-
from google.cloud.bigquery.datatransfer_v1.services.data_transfer_service import pagers
36-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
37-
from google.cloud.bigquery.datatransfer_v1.types import transfer
35+
from google.cloud.bigquery_datatransfer_v1.services.data_transfer_service import pagers
36+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
37+
from google.cloud.bigquery_datatransfer_v1.types import transfer
3838
from google.protobuf import duration_pb2 as duration # type: ignore
3939
from google.protobuf import field_mask_pb2 as field_mask # type: ignore
4040
from google.protobuf import struct_pb2 as struct # type: ignore
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717

1818
from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple
1919

20-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
21-
from google.cloud.bigquery.datatransfer_v1.types import transfer
20+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
21+
from google.cloud.bigquery_datatransfer_v1.types import transfer
2222

2323

2424
class ListDataSourcesPager:
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
from google.api_core import retry as retries # type: ignore
2626
from google.auth import credentials # type: ignore
2727

28-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
29-
from google.cloud.bigquery.datatransfer_v1.types import transfer
28+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
29+
from google.cloud.bigquery_datatransfer_v1.types import transfer
3030
from google.protobuf import empty_pb2 as empty # type: ignore
3131

3232

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626

2727
import grpc # type: ignore
2828

29-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
30-
from google.cloud.bigquery.datatransfer_v1.types import transfer
29+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
30+
from google.cloud.bigquery_datatransfer_v1.types import transfer
3131
from google.protobuf import empty_pb2 as empty # type: ignore
3232

3333
from .base import DataTransferServiceTransport, DEFAULT_CLIENT_INFO
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
import grpc # type: ignore
2828
from grpc.experimental import aio # type: ignore
2929

30-
from google.cloud.bigquery.datatransfer_v1.types import datatransfer
31-
from google.cloud.bigquery.datatransfer_v1.types import transfer
30+
from google.cloud.bigquery_datatransfer_v1.types import datatransfer
31+
from google.cloud.bigquery_datatransfer_v1.types import transfer
3232
from google.protobuf import empty_pb2 as empty # type: ignore
3333

3434
from .base import DataTransferServiceTransport, DEFAULT_CLIENT_INFO
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import proto # type: ignore
1919

2020

21-
from google.cloud.bigquery.datatransfer_v1.types import transfer
21+
from google.cloud.bigquery_datatransfer_v1.types import transfer
2222
from google.protobuf import duration_pb2 as duration # type: ignore
2323
from google.protobuf import field_mask_pb2 as field_mask # type: ignore
2424
from google.protobuf import timestamp_pb2 as timestamp # type: ignore

packages/google-cloud-bigquery-datatransfer/samples/create_scheduled_query.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020

2121
def sample_create_transfer_config(project_id, dataset_id, authorization_code=""):
2222
# [START bigquerydatatransfer_create_scheduled_query]
23-
from google.cloud.bigquery import datatransfer_v1
23+
from google.cloud import bigquery_datatransfer
2424

25-
client = datatransfer_v1.DataTransferServiceClient()
25+
client = bigquery_datatransfer.DataTransferServiceClient()
2626

2727
# TODO(developer): Set the project_id to the project that contains the
2828
# destination dataset.
@@ -54,7 +54,7 @@ def sample_create_transfer_config(project_id, dataset_id, authorization_code="")
5454

5555
parent = f"projects/{project_id}"
5656

57-
transfer_config = datatransfer_v1.types.TransferConfig(
57+
transfer_config = bigquery_datatransfer.TransferConfig(
5858
destination_dataset_id=dataset_id,
5959
display_name="Your Scheduled Query Name",
6060
data_source_id="scheduled_query",

packages/google-cloud-bigquery-datatransfer/samples/snippets/quickstart.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717

1818
def run_quickstart(project="my-project"):
1919
# [START bigquerydatatransfer_quickstart]
20-
from google.cloud.bigquery import datatransfer
20+
from google.cloud import bigquery_datatransfer
2121

22-
client = datatransfer.DataTransferServiceClient()
22+
client = bigquery_datatransfer.DataTransferServiceClient()
2323

2424
# TODO: Update to your project ID.
2525
# project = "my-project"

packages/google-cloud-bigquery-datatransfer/samples/tests/conftest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ def credentials():
3939

4040
@pytest.fixture(scope="module")
4141
def bqdts_client(credentials):
42-
from google.cloud.bigquery import datatransfer_v1
42+
from google.cloud import bigquery_datatransfer
4343

44-
return datatransfer_v1.DataTransferServiceClient(credentials=credentials)
44+
return bigquery_datatransfer.DataTransferServiceClient(credentials=credentials)
4545

4646

4747
@pytest.fixture(scope="module")

packages/google-cloud-bigquery-datatransfer/samples/update_transfer_config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020

2121
def sample_update_transfer_config(config_name, display_name):
2222
# [START bigquerydatatransfer_update_transfer_config]
23-
from google.cloud.bigquery import datatransfer_v1
23+
from google.cloud import bigquery_datatransfer
2424

25-
client = datatransfer_v1.DataTransferServiceClient()
25+
client = bigquery_datatransfer.DataTransferServiceClient()
2626
# TODO(developer): Set the config_name which user wants to update.
2727
# config_name = "your-created-transfer-config-name"
2828

packages/google-cloud-bigquery-datatransfer/scripts/fixup_datatransfer_v1_keywords.py renamed to packages/google-cloud-bigquery-datatransfer/scripts/fixup_bigquery_datatransfer_v1_keywords.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def partition(
3737
return results[1], results[0]
3838

3939

40-
class datatransferCallTransformer(cst.CSTTransformer):
40+
class bigquery_datatransferCallTransformer(cst.CSTTransformer):
4141
CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata')
4242
METHOD_TO_PARAMS: Dict[str, Tuple[str]] = {
4343
'check_valid_creds': ('name', ),
@@ -103,7 +103,7 @@ def fix_files(
103103
in_dir: pathlib.Path,
104104
out_dir: pathlib.Path,
105105
*,
106-
transformer=datatransferCallTransformer(),
106+
transformer=bigquery_datatransferCallTransformer(),
107107
):
108108
"""Duplicate the input dir to the output dir, fixing file method calls.
109109
@@ -136,7 +136,7 @@ def fix_files(
136136

137137
if __name__ == '__main__':
138138
parser = argparse.ArgumentParser(
139-
description="""Fix up source that uses the datatransfer client library.
139+
description="""Fix up source that uses the bigquery_datatransfer client library.
140140
141141
The existing sources are NOT overwritten but are copied to output_dir with changes made.
142142

packages/google-cloud-bigquery-datatransfer/setup.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,6 @@
5757
if "google.cloud" in packages:
5858
namespaces.append("google.cloud")
5959

60-
if "google.cloud.bigquery" in packages:
61-
namespaces.append("google.cloud.bigquery")
62-
6360
setuptools.setup(
6461
name=name,
6562
version=version,
@@ -87,7 +84,7 @@
8784
install_requires=dependencies,
8885
extras_require=extras,
8986
python_requires=">=3.6",
90-
scripts=["scripts/fixup_datatransfer_v1_keywords.py"],
87+
scripts=["scripts/fixup_bigquery_datatransfer_v1_keywords.py"],
9188
include_package_data=True,
9289
zip_safe=False,
9390
)

0 commit comments

Comments
 (0)