Merge branch 'release-v5.5'

Author: looselycoupled

btrdb/__init__.py

@@ -15,13 +15,11 @@
 ## Imports
 ##########################################################################
 
-import os
 from btrdb.conn import Connection, BTrDB
 from btrdb.endpoint import Endpoint
-from btrdb.exceptions import ConnectionError, CredentialsFileNotFound, \
-    ProfileNotFound
+from btrdb.exceptions import ConnectionError
 from btrdb.version import get_version
-from btrdb.utils.credentials import load_profile
+from btrdb.utils.credentials import credentials_by_profile, credentials
 
 ##########################################################################
 ## Module Variables
@@ -37,8 +35,8 @@
 ## Functions
 ##########################################################################
 
-def _connect(conn_str=None, apikey=None):
-    return BTrDB(Endpoint(Connection(conn_str, apikey=apikey).channel))
+def _connect(endpoints=None, apikey=None):
+    return BTrDB(Endpoint(Connection(endpoints, apikey=apikey).channel))
 
 def connect(conn_str=None, apikey=None, profile=None):
     """
@@ -64,39 +62,18 @@ def connect(conn_str=None, apikey=None, profile=None):
         An instance of the BTrDB context to directly interact with the database.
 
     """
-    # Check function arguments
-
+    # do not allow user to provide both address and profile
     if conn_str and profile:
         raise ValueError("Received both conn_str and profile arguments.")
 
+    # use specific profile if requested
     if profile:
-        credentials = load_profile(profile)
-        return _connect(credentials["endpoints"], credentials["api_key"])
-
-    if conn_str:
-        return _connect(conn_str, apikey)
-
-    # Check ENV variables
-
-    keys = os.environ.keys()
-    if BTRDB_PROFILE in keys and BTRDB_ENDPOINTS in keys:
-        raise ValueError("Found both BTRDB_PROFILE and BTRDB_ENDPOINTS in ENV. "
-            "Only one is allowed.")
-
-    if BTRDB_PROFILE in keys:
-        credentials = load_profile(os.environ[BTRDB_PROFILE])
-        return _connect(credentials["endpoints"], credentials["api_key"])
+        return _connect(**credentials_by_profile(profile))
 
-    if BTRDB_ENDPOINTS in keys:
-        return _connect(os.environ[BTRDB_ENDPOINTS], os.environ.get(BTRDB_API_KEY, None))
-
-
-    # Attempt default profile (no arguments or ENV found)
-
-    try:
-        credentials = load_profile("default")
-        return _connect(credentials["endpoints"], credentials["api_key"])
-    except (CredentialsFileNotFound, ProfileNotFound):
-        pass
+    # resolve credentials using combination of arguments, env
+    creds = credentials(conn_str, apikey)
+    if "endpoints" in creds:
+        return _connect(**creds)
 
     raise ConnectionError("Could not determine credentials to use.")
+

btrdb/conn.py

@@ -45,8 +45,8 @@
 
 
 class Connection(object):
+
     def __init__(self, addrportstr, apikey=None):
-        # type: () -> BTrDB
         """
         Connects to a BTrDB server
 
@@ -57,10 +57,6 @@ def __init__(self, addrportstr, apikey=None):
         apikey: str
             The option API key to authenticate requests
 
-        Returns
-        -------
-        Connection
-            A Connection class object.
         """
         addrport = addrportstr.split(":", 2)
         chan_ops = [('grpc.default_compression_algorithm', CompressionAlgorithm.gzip)]
@@ -110,7 +106,6 @@ class BTrDB(object):
     def __init__(self, endpoint):
         self.ep = endpoint
 
-
     def streams(self, *identifiers, versions=None):
         """
         Returns a StreamSet object with BTrDB streams from the supplied
@@ -240,10 +235,10 @@ def streams_in_collection(self, *collection, is_collection_prefix=True, tags=Non
         annotations: Dict[str, str]
             The annotations to identify the stream.
 
-        Yields
+        Returns
         ------
-        Stream Generator
-            A stream generator that iterates over the search results.
+        list
+            A list of stream objects found with the provided search arguments.
 
         """
         result = []
@@ -269,7 +264,6 @@ def streams_in_collection(self, *collection, is_collection_prefix=True, tags=Non
         return result
 
     def collection_metadata(self, prefix):
-        # type: (csv.writer, QueryType, int, int, int, int, bool, *Tuple[int, str, UUID]) -> Tuple[Dict[str, int], Dict[str, int]]
         """
         Gives statistics about metadata for collections that match a
         prefix.
@@ -279,6 +273,12 @@ def collection_metadata(self, prefix):
         prefix: str
             A prefix of the collection names to look at
 
+        Returns
+        -------
+        tuple
+            A tuple of dictionaries containing metadata on the streams in the
+            provided collection.
+
         """
         ep = self.ep
         tags, annotations = ep.getMetadataUsage(prefix)

btrdb/point.py

@@ -152,39 +152,42 @@ def time(self):
         The mean value of the time series point within a range of time
         """
         return self._time
+
     @property
     def min(self):
         """
         The minimum value of the time series within a range of time
         """
         return self._min
+
     @property
     def mean(self):
         """
         The mean value of the time series within a range of time
         """
         return self._mean
+
     @property
     def max(self):
         """
         The maximum value of the time series within a range of time
         """
         return self._max
+
     @property
     def count(self):
         """
         The number of values within the time series for a range of time
         """
         return self._count
+
     @property
     def stddev(self):
         """
         The standard deviation of the values of a time series within a range of time
         """
         return self._stddev
 
-
-
     def __getitem__(self, index):
         if index == 0:
             return self.time