Skip to content

Commit 966e893

Browse files
plamutplamut
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

33 files changed

Lines changed: 106 additions & 109 deletions

File tree

‎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

packages/google-cloud-bigquery-datatransfer/docs/datatransfer_v1/services.rst renamed to packages/google-cloud-bigquery-datatransfer/docs/bigquery_datatransfer_v1/services.rst

Lines changed: 1 addition & 1 deletion
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:

packages/google-cloud-bigquery-datatransfer/docs/datatransfer_v1/types.rst renamed to packages/google-cloud-bigquery-datatransfer/docs/bigquery_datatransfer_v1/types.rst

Lines changed: 1 addition & 1 deletion
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",

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

File renamed without changes.

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

File renamed without changes.

packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery/datatransfer_v1/py.typed renamed to packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/py.typed

File renamed without changes.

0 commit comments

Comments
 (0)