Merge branch 'master' of https://github.com/terminusdb/terminusdb-client-python into IncreaseTestCoverage#123

Author: Pradhvan

.gitignore

@@ -20,6 +20,7 @@ woqlclient/*.egg-info/
 coverage.xml
 report.xml
 .coverage
+terminusdb_client_coverage/
 
 *.so
 *~

makefile

@@ -18,6 +18,10 @@ flake8:
 coverage:
 	pipenv run py.test terminusdb_client/tests --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=terminusdb_client terminusdb_client/tests
 
+# Command to  generate a coverage report html
+coverage_html:
+	coverage html -d terminusdb_client_coverage
+
 interrogate:
 	interrogate -v -I -i -p -s terminusdb_client/woqlclient/woqlClient.py terminusdb_client/woqldataframe/woqlDataframe.py terminusdb_client/woqlquery/woql_query.py terminusdb_client/woqlquery/woql_library.py
 

terminusdb_client/woqldataframe/woqlDataframe.py

@@ -15,10 +15,36 @@
 
 
 class EmptyException(Exception):
+    """ Exception inherited from the built-in Exception Class
+
+    Parameters
+    ----------
+    msg : str
+        Error message that is describing the exception
+
+    Raises
+    ------
+    EmptyException
+        If the result table of the query is empty
+
+    """
     pass
 
 
 def _is_empty(query):
+    """Checks if the result table of a query is empty
+
+    Parameters
+    ----------
+    query : dict
+            JSON of the result of the query
+
+    Returns
+    -------
+    bool
+        TRUE if the result table is empty, else FALSE
+
+    """
     return len(query["bindings"]) == 0