Skip to content

Commit 43df1d4

Browse files
dhermesdhermes
committed
Making environment var. module public.
Also renaming all variables in the file to drop the `_ENV_VAR_NAME` post-fix and the leading underscore.
1 parent 4ee814f commit 43df1d4

13 files changed

Lines changed: 44 additions & 42 deletions

‎gcloud/_helpers.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@ class Local(object):
2626

2727
from six.moves.http_client import HTTPConnection # pylint: disable=F0401
2828

29-
from gcloud._environment_vars import _PROJECT_ENV_VAR_NAME
3029
try:
3130
from google.appengine.api import app_identity
3231
except ImportError:
3332
app_identity = None
3433

34+
from gcloud.environment_vars import PROJECT
35+
36+
3537
_RFC3339_MICROS = '%Y-%m-%dT%H:%M:%S.%fZ'
3638

3739

@@ -144,7 +146,7 @@ def _compute_engine_id():
144146

145147
def _get_production_project():
146148
"""Gets the production project if it can be inferred."""
147-
return os.getenv(_PROJECT_ENV_VAR_NAME)
149+
return os.getenv(PROJECT)
148150

149151

150152
def _determine_default_project(project=None):

‎gcloud/datastore/client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515

1616
import os
1717

18-
from gcloud._environment_vars import _DATASET_ENV_VAR_NAME
19-
from gcloud._environment_vars import _GCD_DATASET_ENV_VAR_NAME
2018
from gcloud._helpers import _LocalStack
2119
from gcloud._helpers import _app_engine_id
2220
from gcloud._helpers import _compute_engine_id
@@ -28,6 +26,8 @@
2826
from gcloud.datastore.key import Key
2927
from gcloud.datastore.query import Query
3028
from gcloud.datastore.transaction import Transaction
29+
from gcloud.environment_vars import DATASET
30+
from gcloud.environment_vars import GCD_DATASET
3131

3232

3333
_MAX_LOOPS = 128
@@ -36,12 +36,12 @@
3636

3737
def _get_production_dataset_id():
3838
"""Gets the production application ID if it can be inferred."""
39-
return os.getenv(_DATASET_ENV_VAR_NAME)
39+
return os.getenv(DATASET)
4040

4141

4242
def _get_gcd_dataset_id():
4343
"""Gets the GCD application ID if it can be inferred."""
44-
return os.getenv(_GCD_DATASET_ENV_VAR_NAME)
44+
return os.getenv(GCD_DATASET)
4545

4646

4747
def _determine_default_dataset_id(dataset_id=None):

‎gcloud/datastore/connection.py‎

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

1717
import os
1818

19-
from gcloud._environment_vars import _GCD_HOST_ENV_VAR_NAME
2019
from gcloud import connection
20+
from gcloud.environment_vars import GCD_HOST
2121
from gcloud.exceptions import make_exception
2222
from gcloud.datastore import _datastore_v1_pb2 as datastore_pb
2323

@@ -55,7 +55,7 @@ def __init__(self, credentials=None, http=None, api_base_url=None):
5555
credentials = self._create_scoped_credentials(credentials, SCOPE)
5656
super(Connection, self).__init__(credentials=credentials, http=http)
5757
if api_base_url is None:
58-
api_base_url = os.getenv(_GCD_HOST_ENV_VAR_NAME,
58+
api_base_url = os.getenv(GCD_HOST,
5959
connection.API_BASE_URL)
6060
self.api_base_url = api_base_url
6161

‎gcloud/datastore/test_client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ def test_no_value(self):
4949
def test_value_set(self):
5050
import os
5151
from gcloud._testing import _Monkey
52-
from gcloud.datastore.client import _DATASET_ENV_VAR_NAME
52+
from gcloud.datastore.client import DATASET
5353

5454
MOCK_DATASET_ID = object()
55-
environ = {_DATASET_ENV_VAR_NAME: MOCK_DATASET_ID}
55+
environ = {DATASET: MOCK_DATASET_ID}
5656
with _Monkey(os, getenv=environ.get):
5757
dataset_id = self._callFUT()
5858
self.assertEqual(dataset_id, MOCK_DATASET_ID)
@@ -76,10 +76,10 @@ def test_no_value(self):
7676
def test_value_set(self):
7777
import os
7878
from gcloud._testing import _Monkey
79-
from gcloud.datastore.client import _GCD_DATASET_ENV_VAR_NAME
79+
from gcloud.datastore.client import GCD_DATASET
8080

8181
MOCK_DATASET_ID = object()
82-
environ = {_GCD_DATASET_ENV_VAR_NAME: MOCK_DATASET_ID}
82+
environ = {GCD_DATASET: MOCK_DATASET_ID}
8383
with _Monkey(os, getenv=environ.get):
8484
dataset_id = self._callFUT()
8585
self.assertEqual(dataset_id, MOCK_DATASET_ID)

‎gcloud/datastore/test_connection.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ def test_custom_url_from_env(self):
5656
import os
5757
from gcloud._testing import _Monkey
5858
from gcloud.connection import API_BASE_URL
59-
from gcloud.datastore.connection import _GCD_HOST_ENV_VAR_NAME
59+
from gcloud.datastore.connection import GCD_HOST
6060

6161
HOST = object()
62-
fake_environ = {_GCD_HOST_ENV_VAR_NAME: HOST}
62+
fake_environ = {GCD_HOST: HOST}
6363

6464
with _Monkey(os, getenv=fake_environ.get):
6565
conn = self._makeOne()
@@ -79,11 +79,11 @@ def test_custom_url_constructor_and_env(self):
7979
import os
8080
from gcloud._testing import _Monkey
8181
from gcloud.connection import API_BASE_URL
82-
from gcloud.datastore.connection import _GCD_HOST_ENV_VAR_NAME
82+
from gcloud.datastore.connection import GCD_HOST
8383

8484
HOST1 = object()
8585
HOST2 = object()
86-
fake_environ = {_GCD_HOST_ENV_VAR_NAME: HOST1}
86+
fake_environ = {GCD_HOST: HOST1}
8787

8888
with _Monkey(os, getenv=fake_environ.get):
8989
conn = self._makeOne(api_base_url=HOST2)

gcloud/_environment_vars.py renamed to gcloud/environment_vars.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@
1818
and tests.
1919
"""
2020

21-
_PROJECT_ENV_VAR_NAME = 'GCLOUD_PROJECT'
21+
PROJECT = 'GCLOUD_PROJECT'
2222
"""Environment variable defining default project."""
2323

24-
_TESTS_PROJECT_ENV_VAR_NAME = 'GCLOUD_TESTS_PROJECT_ID'
24+
TESTS_PROJECT = 'GCLOUD_TESTS_PROJECT_ID'
2525
"""Environment variable defining project for tests."""
2626

27-
_DATASET_ENV_VAR_NAME = 'GCLOUD_DATASET_ID'
27+
DATASET = 'GCLOUD_DATASET_ID'
2828
"""Environment variable defining default dataset ID."""
2929

30-
_GCD_DATASET_ENV_VAR_NAME = 'DATASTORE_DATASET'
30+
GCD_DATASET = 'DATASTORE_DATASET'
3131
"""Environment variable defining default dataset ID under GCD."""
3232

33-
_GCD_HOST_ENV_VAR_NAME = 'DATASTORE_HOST'
33+
GCD_HOST = 'DATASTORE_HOST'
3434
"""Environment variable defining host for GCD dataset server."""
3535

36-
_TESTS_DATASET_ENV_VAR_NAME = 'GCLOUD_TESTS_DATASET_ID'
36+
TESTS_DATASET = 'GCLOUD_TESTS_DATASET_ID'
3737
"""Environment variable defining dataset ID for tests."""
3838

39-
_CREDENTIALS_ENV_VAR_NAME = 'GOOGLE_APPLICATION_CREDENTIALS'
39+
CREDENTIALS = 'GOOGLE_APPLICATION_CREDENTIALS'
4040
"""Environment variable defining location of Google credentials."""

‎gcloud/test__helpers.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,10 @@ def test_no_value(self):
150150
def test_value_set(self):
151151
import os
152152
from gcloud._testing import _Monkey
153-
from gcloud._helpers import _PROJECT_ENV_VAR_NAME
153+
from gcloud._helpers import PROJECT
154154

155155
MOCK_PROJECT = object()
156-
environ = {_PROJECT_ENV_VAR_NAME: MOCK_PROJECT}
156+
environ = {PROJECT: MOCK_PROJECT}
157157
with _Monkey(os, getenv=environ.get):
158158
project = self._callFUT()
159159
self.assertEqual(project, MOCK_PROJECT)

‎system_tests/clear_datastore.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616

1717
from six.moves import input
1818

19-
from gcloud._environment_vars import _TESTS_DATASET_ENV_VAR_NAME
2019
from gcloud import datastore
2120
from gcloud.datastore import client
21+
from gcloud.environment_vars import TESTS_DATASET
2222

2323

24-
client._DATASET_ENV_VAR_NAME = _TESTS_DATASET_ENV_VAR_NAME
24+
client.DATASET = TESTS_DATASET
2525
CLIENT = datastore.Client()
2626

2727

‎system_tests/datastore.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616
import pytz
1717
import unittest2
1818

19-
from gcloud._environment_vars import _TESTS_DATASET_ENV_VAR_NAME
2019
from gcloud import datastore
2120
from gcloud.datastore import client
21+
from gcloud.environment_vars import TESTS_DATASET
2222
# This assumes the command is being run via tox hence the
2323
# repository root is the current directory.
2424
from system_tests import populate_datastore
2525

2626

27-
client._DATASET_ENV_VAR_NAME = _TESTS_DATASET_ENV_VAR_NAME
27+
client.DATASET = TESTS_DATASET
2828
CLIENT = datastore.Client()
2929

3030

‎system_tests/populate_datastore.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616

1717
from six.moves import zip
1818

19-
from gcloud._environment_vars import _TESTS_DATASET_ENV_VAR_NAME
2019
from gcloud import datastore
2120
from gcloud.datastore import client
21+
from gcloud.environment_vars import TESTS_DATASET
2222

2323

24-
client._DATASET_ENV_VAR_NAME = _TESTS_DATASET_ENV_VAR_NAME
24+
client.DATASET = TESTS_DATASET
2525
CLIENT = datastore.Client()
2626

2727

0 commit comments

Comments
 (0)