Change gcloud package to google.cloud #2223
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhermes
added
packaging
do not merge
googlebot
added
the
cla: yes
| pkg_resources.declare_namespace(__name__) | ||
| except ImportError: | ||
| import pkgutil | ||
| __path___ = pkgutil.extend_path(__path__, __name__) |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
dhermes
force-pushed
the
namespace-change
branch
from
45b46c8
to
102b781
Compare
|
@dhermes, I'm sure this will break json-docs as well. |
|
@daspecster Definitely. I was planning on asking for your help at some point. Trying to get the basic |
dhermes
force-pushed
the
namespace-change
branch
from
4acb8ef
to
a30295d
Compare
Done via: $ mkdir google $ git mv gcloud google/cloud
Done via: $ git grep -l 'import gcloud' | \ > xargs sed -i s/'import gcloud'/'import google.cloud'/g
Done via: $ git grep -l 'from gcloud import' | \ > xargs sed -i s/'from gcloud import'/'from google.cloud import'/g
Done via: $ git grep -l '>>> from gcloud.' | \ > xargs sed -i s/'>>> from gcloud.'/'>>> from google.cloud.'/g
This was done entirely via sed. First checked that
the remaining imports were at the start of their
respective lines:
$ git grep 'from gcloud.*import' > anywhere.txt
$ git grep '^[[:space:]]*from gcloud.*import' > line_start.txt
$ diff -s anywhere.txt line_start.txt
Files anywhere.txt and line_start.txt are identical
$ rm -f anywhere.txt line_start.txt
Then put all the imports in a text file
$ git grep -h '^[[:space:]]*from gcloud.*import' > imports.txt
Then parsed that file to get a list of the modules:
$ cat << EOF > get_mods.py
> def get_import(line):
> a, b, c, d = line.strip().split(None, 3)
> assert a == 'from'
> assert c == 'import'
> try:
> e, f, g = b.split('.', 2)
> except ValueError:
> e, f = b.split('.')
> assert e == 'gcloud'
> return f
>
> with open('imports.txt', 'rb') as file_obj:
> imported = sorted(set(map(get_import, file_obj.readlines())))
>
> for mod in imported:
> print(mod)
>
> EOF
$ python get_mods.py > mods.txt
$ rm -f imports.txt get_mods.py
Then using the list of modules to rewrite the imports
$ cat << 'EOF' > all-sed.sh
> for mod in $(cat mods.txt); do
> git grep -l "from gcloud.${mod}" | \
> xargs sed -i s/"from gcloud.${mod}"/"from google.cloud.${mod}"/g
> done
>
> EOF
$ /bin/bash all-sed.sh
$ rm -f all-sed.sh mods.txt
Done via: $ git grep -l 'gcloud-python' | \ > xargs sed -i s/gcloud-python/google-cloud-python/g
Done via: $ git grep -l 'hack-on-gcloud' | \ > xargs sed -i s/hack-on-gcloud/hack-on-google-cloud-python/g
Done via: $ git grep -l 'automodule:: gcloud' | \ > xargs sed -i s/'automodule:: gcloud'/'automodule:: google.cloud'/g
Done via: $ git grep -l '<gcloud.' | \ > xargs sed -i s/'<gcloud.'/'<google.cloud.'/g $ git grep -l '`gcloud\.' | \ > xargs sed -i s/'`gcloud\.'/'`google.cloud.'/g
Done via: $ git grep -l '"gcloud/' | \ > xargs sed -i s/'"gcloud\/'/'"google\/cloud\/'/g
Many usages were ad-hoc so this was done by hand rather than via a sed script.
Done via: $ git grep -l 'GCLOUD_' | \ > xargs sed -i s/'GCLOUD_'/'GOOGLE_CLOUD_'/g
Done via: $ git grep -l GCloudError | \ > xargs sed -i s/GCloudError/GoogleCloudError/g
Done via: $ git grep -l '~gcloud' | \ > xargs sed -i s/'~gcloud'/'~google.cloud'/g
commit 6faf161 Author: Danny Hermes <daniel.j.hermes@gmail.com> Date: Tue Aug 30 12:39:46 2016 -0700 Converting almost all packages to namespace packages. As a result, the module objects for those packages can no longer contain members. Hence the following is no longer possible: >>> from google.cloud import storage >>> client = storage.Client() The "_generated" packages have not been converted to namespace packages and neither have "google.cloud.logging.handlers" nor "google.cloud.logging.handlers.transports". In addition, some members of "google.cloud.logging" have been moved into "google.cloud.logging.client" in order to be importable. Finally, the unit tests all pass at this commit, but `tox` fails to run them: the namespace imports appear broken to `tox` even though they aren't broken to the `virtualenv` for the given `tox` environment.
| @@ -326,7 +326,7 @@ instead of | |||
| ``https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst``) | |||
| may cause problems creating links or rendering the description. | |||
|
|
|||
| .. _description on PyPI: https://pypi.python.org/pypi/gcloud | |||
| .. _description on PyPI: https://pypi.python.org/pypi/google-cloud | |||
|
|
|||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
@tseaver Renames that are also a concern: |
| @@ -290,7 +290,7 @@ def _assign_entity_to_pb(entity_pb, entity): | |||
|
|
|||
| Helper method for ``Batch.put``. | |||
|
|
|||
| :type entity_pb: :class:`google.cloud.datastore._generated.entity_pb2.Entity` | |||
| :type entity_pb: :class:`.datastore._generated.entity_pb2.Entity` | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
@tseaver Other than the path changes on docstrings, anything else for me to do? |
|
@dhermes Nope, I think we have to trust our tests here. |
|
@tseaver merging now to stop blocking other PRs and to avoid having a long Travis wait time. Will send the docstring fixes in a new PR ASAP. Also going to rename the repo immediately after merging |
dhermes
removed
the
do not merge
|
FYI AppVeyor seems happy: https://ci.appveyor.com/project/dhermes/gcloud-python/build/1.0.631.master |
dhermes
added a commit
to dhermes/google-cloud-python
that referenced
this pull request
Sep 7, 2016
Follow-up to PR googleapis#2223. The Sphinx mechanism of using a `.` to mean "go find this class" can be confusing, so we make sure the `.` also is a relative path.
|
@dhermes System tests for pubsub and logging are failing, due to the namespace packages. |
|
I'm working on a fix for them. |
|
Just filed #2259 for the overall fix. Something more specific busted for logging and pubsub? |
|
Namespace packages break the client construction for pubsub and logging. |
This was referenced Sep 7, 2016
dhermes
added a commit
to dhermes/google-cloud-python
that referenced
this pull request
Sep 7, 2016
Follow-up to PR googleapis#2223. The Sphinx mechanism of using a `.` to mean "go find this class" can be confusing, so we make sure the `.` also is a relative path.
This was referenced Sep 16, 2016
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also use namespace packages throughout.
The commit messages will be quite useful, as almost all of them contain bash scripts used to generated the commit.
Fixes #1978
/cc @jonparrott
Currently the PR has problems (e.g. imports don't work for
tox), but I wanted to get it out there as a start since it is such a monster.