Merge pull request #303 from aperture-data/release-0.4.10

Release 0.4.10

Author: gsaluja9

aperturedb/Blobs.py

@@ -4,4 +4,10 @@
 
 
 class Blobs(Entities):
+    """
+    **The object mapper representation of blobs in ApertureDB.**
+
+    This class is a layer on top of the native query.
+    It facilitates interactions with blobs in the database in the pythonic way.
+    """
     db_object = "_Blob"

aperturedb/BoundingBoxes.py

@@ -4,4 +4,10 @@
 
 
 class BoundingBoxes(Entities):
+    """
+    **The object mapper representation of bounding boxes in ApertureDB.**
+
+    This class is a layer on top of the native query.
+    It facilitates interactions with bounding boxes in the database in the pythonic way.
+    """
     db_object = "_BoundingBox"

aperturedb/Configuration.py

@@ -3,13 +3,17 @@
 
 @dataclass(repr=False)
 class Configuration:
+    """
+    **Configuration object for aperturedb sdk to be able to connect to ApertureDB**
+    """
     host: str
     port: int
     username: str
     password: str
     name: str
     use_ssl: bool = True
     use_rest: bool = False
+    use_keepalive: bool = True
 
     def __repr__(self) -> str:
         mode = "REST" if self.use_rest else "TCP"

aperturedb/Connector.py

@@ -36,6 +36,8 @@
 import ssl
 import logging
 
+import keepalive
+
 from threading import Lock
 from types import SimpleNamespace
 from dataclasses import dataclass
@@ -73,11 +75,9 @@ def valid(self) -> bool:
 
 class Connector(object):
     """
-    .. _connector-label:
-
     **Class to facilitate connections with an instance of aperturedb**
 
-    It lets the client execute any query as per the `Native Query specs <https://docs.aperturedata.io/>`_
+    It lets the client execute any query as per the `Native Query specs </category/aperturedb-query-language>`_
 
     Args:
         str (host): Address of the host to connect to.
@@ -86,12 +86,17 @@ class Connector(object):
         str (password): Password to specify while connecting to the db.
         str (token): Token to use while connecting to the database.
         bool (use_ssl): Use SSL to encrypt communication with the database.
+        bool (use_keepalive): Set keepalive on the connection with the database.
+            This has two benefits: It reduces the chance of disconnection for a long-running query,
+            and it means that diconnections are detected sooner.
+            Turn this off to reduce traffic on high-cost network connections.
         Configuration (config): Configuration object to use for connection.
     """
 
     def __init__(self, host="localhost", port=55555,
                  user="", password="", token="",
                  use_ssl=True, shared_data=None, authenticate=True,
+                 use_keepalive=True,
                  config: Configuration = None):
         self.connected = False
         self.last_response   = ''
@@ -101,19 +106,22 @@ def __init__(self, host="localhost", port=55555,
             self.host = host
             self.port = port
             self.use_ssl = use_ssl
+            self.use_keepalive = use_keepalive
             self.config = Configuration(
                 host=self.host,
                 port=self.port,
                 use_ssl=self.use_ssl,
                 username=user,
                 password=password,
-                name="runtime"
+                name="runtime",
+                use_keepalive=use_keepalive
             )
         else:
             self.config = config
             self.host = config.host
             self.port = config.port
             self.use_ssl = config.use_ssl
+            self.use_keepalive = config.use_keepalive
 
         self._connect()
 
@@ -228,6 +236,8 @@ def _connect(self):
 
         self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         self.conn.setsockopt(socket.SOL_TCP, socket.TCP_NODELAY, 1)
+        if self.use_keepalive:
+            keepalive.set(self.conn)
 
         # TCP_QUICKACK only supported in Linux 2.4.4+.
         # We use startswith for checking the platform following Python's

aperturedb/ConnectorRest.py

@@ -68,8 +68,6 @@ def valid(self) -> bool:
 
 class ConnectorRest(Connector):
     """
-    .. _connector-label:
-
     **Class to use aperturedb's REST interface**
 
     Args:

aperturedb/Constraints.py

@@ -8,6 +8,9 @@ class Conjunction(Enum):
 
 
 class Constraints(object):
+    """
+    **Constraints object for the Object mapper API**
+    """
 
     def __init__(self, conjunction: Conjunction = Conjunction.AND):
         self._conjunction = conjunction.value

aperturedb/DaskManager.py

@@ -17,6 +17,11 @@
 
 
 class DaskManager:
+    """
+    **Class responsible for setting up a local cluster and assigning parts
+    of data to each worker**
+    """
+
     def __init__(self, num_workers: int = -1):
         self.__num_workers = num_workers
         # The -1 magic number is to use as many 90% of the cores (1 worker per core).

aperturedb/DescriptorDataCSV.py

@@ -60,7 +60,7 @@ class DescriptorDataCSV(CSVParser.CSVParser):
     which is same for line 1 and line 2. The UUID and constraint_UUID ensure that a Descriptor is inserted only once in the DB.
 
     Association of an entity to a Descriptor can be specified by first ingesting other Objects, then Descriptors and finally by
-    using :class:`~aperturedb.ConnectionDataCSV.ConnectionDataCSV`
+    using [ConnectionDataCSV](/python_sdk/data_loaders/csv_wrappers/ConnectionDataCSV)
 
     In the above example, the constraint_UUID ensures that a connection with the specified
     UUID would be only inserted if it does not already exist in the database.

aperturedb/Entities.py

@@ -12,10 +12,13 @@
 
 class Entities(Subscriptable):
     """
-    This class is the common class to query any entity from apertureDB.
-    The specialized subclasses, which provide a more userfriendly interface, are:
-    :class:`~aperturedb.Entities.Images`
-    :class:`~aperturedb.Entities.Polygons`
+    This class is the common class to query any entity from ApertureDB.
+    The specialized subclasses, which provide a more user friendly interface, are:
+    * [Blobs](/python_sdk/object_wrappers/Blobs)
+    * [Bounding Boxes](/python_sdk/object_wrappers/BoundingBoxes)
+    * [Images](/python_sdk/object_wrappers/Images)
+    * [Plygons](/python_sdk/object_wrappers/Polygons)
+    * [Videos](/python_sdk/object_wrappers/Videos)
     """
     db_object = "Entity"
     find_command = f"Find{db_object}"

aperturedb/ImageDataCSV.py

@@ -25,7 +25,7 @@
 
 class ImageDataProcessor():
     """
-    Processing for Image Data used for Loading
+    **Processing for Image data, used when loading images**
     """
 
     def __init__(self, check_image, n_download_retries):