Converting almost all packages to namespace packages.

dhermes · dhermes · commit 6faf161cfa02 · 2016-08-30T12:39:46.000-07:00
As a result, the module objects for those packages can no longer
contain members. Hence the following is no longer possible:

&gt;&gt;&gt; from google.cloud import storage
&gt;&gt;&gt; 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.
diff --git a/google/__init__.py b/google/__init__.py
@@ -11,3 +11,10 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/__init__.py b/google/cloud/__init__.py
@@ -14,6 +14,9 @@
 
 """Google Cloud API access in idiomatic Python."""
 
-from pkg_resources import get_distribution
-
-__version__ = get_distribution('google-cloud').version
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/bigquery/__init__.py b/google/cloud/bigquery/__init__.py
@@ -21,12 +21,9 @@
 - :class:`google.cloud.bigquery.table.Table` represents a single "relation".
 """
 
-from google.cloud.bigquery.client import Client
-from google.cloud.bigquery.connection import Connection
-from google.cloud.bigquery.dataset import AccessGrant
-from google.cloud.bigquery.dataset import Dataset
-from google.cloud.bigquery.schema import SchemaField
-from google.cloud.bigquery.table import Table
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/bigtable/__init__.py b/google/cloud/bigtable/__init__.py
@@ -15,24 +15,9 @@
 """Google Cloud Bigtable API package."""
 
 
-from google.cloud.bigtable.client import Client
-
-
-_ERR_MSG = """\
-gRPC is required for using the Cloud Bigtable API, but
-importing the gRPC library (grpcio in PyPI) has failed.
-
-As of June 2016, grpcio is only supported in Python 2.7,
-which unfortunately means the Cloud Bigtable API isn't
-available if you're using Python 3 or Python < 2.7.
-
-If you're using Python 2.7 and importing / installing
-grpcio has failed, this likely means you have a non-standard version
-of Python installed. Check http://grpc.io if you're
-having trouble installing the grpcio package.
-"""
-
 try:
-    import grpc
-except ImportError as exc:  # pragma: NO COVER
-    raise ImportError(_ERR_MSG, exc)
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/datastore/__init__.py b/google/cloud/datastore/__init__.py
@@ -50,13 +50,9 @@
   when race conditions may occur.
 """
 
-from google.cloud.datastore.batch import Batch
-from google.cloud.datastore.connection import Connection
-from google.cloud.datastore.client import Client
-from google.cloud.datastore.entity import Entity
-from google.cloud.datastore.key import Key
-from google.cloud.datastore.query import Query
-from google.cloud.datastore.transaction import Transaction
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/dns/__init__.py b/google/cloud/dns/__init__.py
@@ -23,11 +23,9 @@
   deleting resource record sets) to a zone.
 """
 
-from google.cloud.dns.zone import Changes
-from google.cloud.dns.client import Client
-from google.cloud.dns.connection import Connection
-from google.cloud.dns.zone import ManagedZone
-from google.cloud.dns.resource_record_set import ResourceRecordSet
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/error_reporting/__init__.py b/google/cloud/error_reporting/__init__.py
@@ -14,4 +14,9 @@
 
 """Client library for Stackdriver Error Reporting"""
 
-from google.cloud.error_reporting.client import Client
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/language/__init__.py b/google/cloud/language/__init__.py
@@ -14,6 +14,9 @@
 
 """Client library for Google Cloud Natural Language API."""
 
-from google.cloud.language.client import Client
-from google.cloud.language.document import Document
-from google.cloud.language.document import Encoding
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/logging/__init__.py b/google/cloud/logging/__init__.py
@@ -14,10 +14,9 @@
 
 """Google Stackdriver Logging API wrapper."""
 
-from google.cloud.logging.client import Client
-from google.cloud.logging.connection import Connection
-
-
-SCOPE = Connection.SCOPE
-ASCENDING = 'timestamp asc'
-DESCENDING = 'timestamp desc'
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/logging/_gax.py b/google/cloud/logging/_gax.py
@@ -56,8 +56,8 @@ def list_entries(self, projects, filter_='', order_by='',
                         https://cloud.google.com/logging/docs/view/advanced_filters
 
         :type order_by: str
-        :param order_by: One of :data:`google.cloud.logging.ASCENDING` or
-                         :data:`google.cloud.logging.DESCENDING`.
+        :param order_by: One of :data:`~google.cloud.logging.client.ASCENDING`
+                         or :data:`~google.cloud.logging.client.DESCENDING`.
 
         :type page_size: int
         :param page_size: maximum number of entries to return, If not passed,
diff --git a/google/cloud/logging/client.py b/google/cloud/logging/client.py
@@ -49,6 +49,10 @@
 
 _DISABLE_GAX = os.getenv('GOOGLE_CLOUD_DISABLE_GAX', False)
 _USE_GAX = _HAVE_GAX and not _DISABLE_GAX
+ASCENDING = 'timestamp asc'
+"""Query string to order by ascending timestamps."""
+DESCENDING = 'timestamp desc'
+"""Query string to order by decending timestamps."""
 
 
 class Client(JSONClient):
@@ -172,8 +176,8 @@ def list_entries(self, projects=None, filter_=None, order_by=None,
                         https://cloud.google.com/logging/docs/view/advanced_filters
 
         :type order_by: str
-        :param order_by: One of :data:`google.cloud.logging.ASCENDING` or
-                         :data:`google.cloud.logging.DESCENDING`.
+        :param order_by: One of :data:`~google.cloud.logging.client.ASCENDING`
+                         or :data:`~google.cloud.logging.client.DESCENDING`.
 
         :type page_size: int
         :param page_size: maximum number of entries to return, If not passed,
diff --git a/google/cloud/logging/connection.py b/google/cloud/logging/connection.py
@@ -77,8 +77,8 @@ def list_entries(self, projects, filter_=None, order_by=None,
                         https://cloud.google.com/logging/docs/view/advanced_filters
 
         :type order_by: str
-        :param order_by: One of :data:`google.cloud.logging.ASCENDING` or
-                         :data:`google.cloud.logging.DESCENDING`.
+        :param order_by: One of :data:`~google.cloud.logging.client.ASCENDING`
+                         or :data:`~google.cloud.logging.client.DESCENDING`.
 
         :type page_size: int
         :param page_size: maximum number of entries to return, If not passed,
diff --git a/google/cloud/logging/handlers/transports/background_thread.py b/google/cloud/logging/handlers/transports/background_thread.py
@@ -21,7 +21,7 @@
 import copy
 import threading
 
-from google.cloud.logging import Client
+from google.cloud.logging.client import Client
 from google.cloud.logging.handlers.transports.base import Transport
 
 
diff --git a/google/cloud/logging/logger.py b/google/cloud/logging/logger.py
@@ -283,8 +283,8 @@ def list_entries(self, projects=None, filter_=None, order_by=None,
                         https://cloud.google.com/logging/docs/view/advanced_filters
 
         :type order_by: string
-        :param order_by: One of :data:`google.cloud.logging.ASCENDING` or
-                         :data:`google.cloud.logging.DESCENDING`.
+        :param order_by: One of :data:`~google.cloud.logging.client.ASCENDING`
+                         or :data:`~google.cloud.logging.client.DESCENDING`.
 
         :type page_size: int
         :param page_size: maximum number of entries to return, If not passed,
diff --git a/google/cloud/logging/test__gax.py b/google/cloud/logging/test__gax.py
@@ -51,7 +51,7 @@ def test_ctor(self):
 
     def test_list_entries_no_paging(self):
         from google.gax import INITIAL_PAGE
-        from google.cloud.logging import DESCENDING
+        from google.cloud.logging.client import DESCENDING
         from google.cloud._testing import _GAXPageIterator
         TOKEN = 'TOKEN'
         TEXT = 'TEXT'
diff --git a/google/cloud/logging/test_client.py b/google/cloud/logging/test_client.py
@@ -234,7 +234,7 @@ def test_list_entries_defaults(self):
             ([self.PROJECT], None, None, None, None))
 
     def test_list_entries_explicit(self):
-        from google.cloud.logging import DESCENDING
+        from google.cloud.logging.client import DESCENDING
         from google.cloud.logging.entries import ProtobufEntry
         from google.cloud.logging.entries import StructEntry
         from google.cloud.logging.logger import Logger
diff --git a/google/cloud/logging/test_connection.py b/google/cloud/logging/test_connection.py
@@ -97,7 +97,7 @@ def test_list_entries_no_paging(self):
         self.assertEqual(conn._called_with['data'], SENT)
 
     def test_list_entries_w_paging(self):
-        from google.cloud.logging import DESCENDING
+        from google.cloud.logging.client import DESCENDING
         PROJECT1 = 'PROJECT1'
         PROJECT2 = 'PROJECT2'
         TIMESTAMP = self._make_timestamp()
diff --git a/google/cloud/logging/test_logger.py b/google/cloud/logging/test_logger.py
@@ -364,7 +364,7 @@ def test_list_entries_defaults(self):
         self.assertEqual(client._listed, LISTED)
 
     def test_list_entries_explicit(self):
-        from google.cloud.logging import DESCENDING
+        from google.cloud.logging.client import DESCENDING
         PROJECT1 = 'PROJECT1'
         PROJECT2 = 'PROJECT2'
         FILTER = 'resource.type:global'
diff --git a/google/cloud/monitoring/__init__.py b/google/cloud/monitoring/__init__.py
@@ -14,34 +14,9 @@
 
 """Google Stackdriver Monitoring API wrapper."""
 
-from google.cloud.monitoring.client import Client
-from google.cloud.monitoring.connection import Connection
-from google.cloud.monitoring.group import Group
-from google.cloud.monitoring.label import LabelDescriptor
-from google.cloud.monitoring.label import LabelValueType
-from google.cloud.monitoring.metric import Metric
-from google.cloud.monitoring.metric import MetricDescriptor
-from google.cloud.monitoring.metric import MetricKind
-from google.cloud.monitoring.metric import ValueType
-from google.cloud.monitoring.query import Aligner
-from google.cloud.monitoring.query import Query
-from google.cloud.monitoring.query import Reducer
-from google.cloud.monitoring.resource import Resource
-from google.cloud.monitoring.resource import ResourceDescriptor
-from google.cloud.monitoring.timeseries import Point
-from google.cloud.monitoring.timeseries import TimeSeries
-
-__all__ = (
-    'Client',
-    'Connection',
-    'Group',
-    'LabelDescriptor', 'LabelValueType',
-    'Metric', 'MetricDescriptor', 'MetricKind', 'ValueType',
-    'Aligner', 'Query', 'Reducer',
-    'Resource', 'ResourceDescriptor',
-    'Point', 'TimeSeries',
-    'SCOPE',
-)
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/pubsub/__init__.py b/google/cloud/pubsub/__init__.py
@@ -23,10 +23,9 @@
   subscription (either pull or push) to a topic.
 """
 
-from google.cloud.pubsub.client import Client
-from google.cloud.pubsub.connection import Connection
-from google.cloud.pubsub.subscription import Subscription
-from google.cloud.pubsub.topic import Topic
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/resource_manager/__init__.py b/google/cloud/resource_manager/__init__.py
@@ -14,9 +14,9 @@
 
 """Google Cloud Resource Manager API wrapper."""
 
-from google.cloud.resource_manager.client import Client
-from google.cloud.resource_manager.connection import Connection
-from google.cloud.resource_manager.project import Project
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/storage/__init__.py b/google/cloud/storage/__init__.py
@@ -39,11 +39,9 @@
   machine).
 """
 
-from google.cloud.storage.batch import Batch
-from google.cloud.storage.blob import Blob
-from google.cloud.storage.bucket import Bucket
-from google.cloud.storage.client import Client
-from google.cloud.storage.connection import Connection
-
-
-SCOPE = Connection.SCOPE
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/streaming/__init__.py b/google/cloud/streaming/__init__.py
@@ -13,3 +13,10 @@
 # limitations under the License.
 
 # Vendored-in from google-apitools 0.4.11
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/translate/__init__.py b/google/cloud/translate/__init__.py
@@ -14,5 +14,9 @@
 
 """Google Cloud Translate API wrapper."""
 
-from google.cloud.translate.client import Client
-from google.cloud.translate.connection import Connection
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/vision/__init__.py b/google/cloud/vision/__init__.py
@@ -13,3 +13,10 @@
 # limitations under the License.
 
 """Google Cloud Vision API package."""
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/setup.py b/setup.py
diff --git a/tox.ini b/tox.ini
