Define all in gcloud/monitoring/init.py. by rimey · Pull Request #1747 · googleapis/google-cloud-python · GitHub

This is so that "from gcloud.monitoring import *" doesn't import
the package's module names.

This is so that "from gcloud.monitoring import *" doesn't import the package's module names.

-0, mostly because from foo import * is a truly evil pattern. I would definitely vote to reject any docs change which showed from gcloud.monitoring import *.

Looking at the module: there are no names present which are not listed in __all__.

This is a package, so it brings in all the module names: client, connection, label, metric, ...

from gcloud.monitoring import * is useful interactively.

>>> from gcloud import monitoring
>>> client = monitoring.Client('my-project')
>>> q = client.query(hours=2).align(Aligner.ALIGN_MEAN, minutes=5)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'Aligner' is not defined
>>> from gcloud.monitoring import *
>>> q = client.query(hours=2).align(Aligner.ALIGN_MEAN, minutes=5)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'module' object has no attribute 'query'

I'm fine with defining __all__. But, @jonparrott recently pointed out that imported modules are not considered part of the public API. From PEP8

Imported names should always be considered an implementation detail. Other modules must not rely on indirect access to such imported names unless they are an explicitly documented part of the containing module's API, such as os.path or a package's init module that exposes functionality from submodules.

For an example from the stdlib.

>>> import subprocess
>>> subprocess.sys
<module 'sys' (built-in)>

I'm OK with this change -- though I'm -1 to using the import * pattern in our documentation.

If people want to use that interactively that's fine with me, but it's certainly not recommended.

Shall we merge then? @tseaver any objections?

Ditto on that. Namespaces are one of Python's strengths (both in language design and community / "idiomatic" behavior). From the Zen of Python:

Namespaces are one honking great idea -- let's do more of those!

Defining __all__ in this circumstance is standard practice. You just don't see it that much outside of carefully curated libraries like the Python standard library, because it's of minor consequence, for the reasons you have mentioned.

LGTM

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

* feat: add functionality to hash data (#1677) * feat: add functionality to hash data * change sensitive fields to private * update to sha512 * update docstring * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: add request-response log helpers (#1685) * chore: add request-response log helpers * fix presubmit * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: opt-in logging support for request / response (#1686) * feat: opt-in logging support for request/response * add pragma no cover * add test coverage for request/response * add code coverage * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: remove logging for async requests (#1698) * chore: remove logging for async requests * change Dict to Mapping * fix mypy and lint issues * address PR feedback * link issue * feat: parse request/response for logging (#1696) * feat: parse request/response for logging * add test case for list * address PR comments * address PR feedback * fix typo * add test coverage * add code coverage * feat: hash sensitive info in logs (#1700) * feat: hash sensitive info in logs * make helper private * add code coverage * address PR feedback * fix mypy type issue * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add support for async response log (#1733) * feat: add support for async response log * fix whitespace * add await * add code coverage * fix lint * fix lint issues * address PR feedback * address PR feedback * link issue * feat: add request response logs for sync api calls (#1747) * fix: remove dependency on api-core for logging (#1748) * fix: remove dep on api-core for logging * disable propagation to the root logger * update async helpers tests * fix lint issue --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

…rovided (#1747) Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #1745 🦕

Define __all__ in gcloud/monitoring/__init__.py.

e46d81c

This is so that "from gcloud.monitoring import *" doesn't import the package's module names.

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 23, 2016

rimey added the api: monitoring Issues related to the Cloud Monitoring API. label Apr 23, 2016

dhermes merged commit 8491da2 into googleapis:master Apr 25, 2016

rimey deleted the import-star branch April 25, 2016 17:35

tseaver mentioned this pull request May 16, 2016

Cut 0.14.0 release. #1799

Merged

parthea added a commit that referenced this pull request Nov 24, 2025

chore(deps): update all dependencies (#1747 )

729ae56

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

parthea pushed a commit that referenced this pull request Apr 1, 2026

feat: Add experimental polars execution (#1747 )

03fdc86

Define all in gcloud/monitoring/init.py. by rimey · Pull Request #1747 · googleapis/google-cloud-python · GitHub

Uh oh!

Define all in gcloud/monitoring/init.py. - #1747

Define all in gcloud/monitoring/init.py.#1747
dhermes merged 1 commit into
googleapis:masterfrom
rimey:import-star

rimey commented Apr 23, 2016

Uh oh!

tseaver commented Apr 23, 2016

Uh oh!

tseaver commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

dhermes commented Apr 23, 2016

Uh oh!

jgeewax commented Apr 23, 2016

Uh oh!

dhermes commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

tseaver commented Apr 25, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Define __all__ in gcloud/monitoring/__init__.py. by rimey · Pull Request #1747 · googleapis/google-cloud-python · GitHub

Uh oh!

Define __all__ in gcloud/monitoring/__init__.py. - #1747

Define __all__ in gcloud/monitoring/__init__.py.#1747dhermes merged 1 commit intogoogleapis:mastergoogleapis/google-cloud-python:masterfrom rimey:import-starCopy head branch name to clipboard

Conversation

rimey commented Apr 23, 2016

Uh oh!

tseaver commented Apr 23, 2016

Uh oh!

tseaver commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

dhermes commented Apr 23, 2016

Uh oh!

jgeewax commented Apr 23, 2016

Uh oh!

dhermes commented Apr 23, 2016

Uh oh!

rimey commented Apr 23, 2016

Uh oh!

tseaver commented Apr 25, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Define all in gcloud/monitoring/init.py. by rimey · Pull Request #1747 · googleapis/google-cloud-python · GitHub

Define all in gcloud/monitoring/init.py. - #1747

Define all in gcloud/monitoring/init.py.#1747
dhermes merged 1 commit into
googleapis:masterfrom
rimey:import-star