Merge pull request #42 from chavarera/main

Improved documentation

Author: chavarera

.pre-commit-config.yaml

@@ -28,4 +28,10 @@ repos:
     rev: v0.27.1
     hooks:
       - id: markdownlint
-        entry: markdownlint --ignore .github
+        entry: markdownlint --ignore .github
+        
+  - repo: https://github.com/econchick/interrogate
+    rev: 1.4.0  
+    hooks:
+    - id: interrogate
+      args: [-vv, -i, --fail-under=80]

examples/with_class_object.py

@@ -10,6 +10,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def run(self):
+        """Code to visit url and fetch cookies and basic info"""
         self.get("https://google.com")
         sessionid = self.session()
         url = self.url()

s_tool/driver.py

@@ -42,10 +42,23 @@ def close(self):
             self.driver.quit()
 
     def __exit__(self, type, value, traceback):
-        """release the resources occupied with the current session"""
+        """release the resources occupied with the current session
+
+        Args:
+            type ([type]): type
+            value ([type]): value
+            traceback ([type]): and traceback
+        """
         self.close()
 
     def __enter__(self):
+        """Returns an selenium webdriver
+        Allows you to implement objects
+        which can be used easily with the with statement
+
+        Returns:
+            [webDriver]: selenium webdriver
+        """
         return self._load_driver()
 
     def _load_driver(self):
@@ -91,6 +104,7 @@ def _load_driver(self):
         return self
 
     def _load_methods(self):
+        """Load basic methods"""
         self.session = partial(get_session, self.driver)
         self.get = partial(visit, self.driver)
         self.text = partial(page_source, self.driver)

s_tool/exceptions.py

@@ -4,7 +4,17 @@ class SToolException(Exception):
     """
 
     def __init__(self, message):
+        """[summary]
+
+        Args:
+            message ([str]): Exception message
+        """
         self.message = message
 
     def __str__(self):
+        """Return Exception message
+
+        Returns:
+            [str]: Exception
+        """
         return str(self.message)

s_tool/parser.py

@@ -2,17 +2,19 @@
 from s_tool.utils import get_element
 
 
-def select_options(element, swap=None, text_exclude=[]):
+def select_options(element, swap=None, text_exclude=set()):
     """Return dropdown option in key value pair
 
     Args:
-        element      : An select element
-        text_exclude : list of values to exclude from result
+        element ([selenium.element]): An select element
+        swap ([bool], optional): Value as key if True. Defaults to None.
+        text_exclude (set, optional): to exclude from result. Defaults to set().
 
     Returns:
-        return dict of values and text of select element,
-        return empty dict() if element is not valid or not exists
+        [dict]: return dict of values and text of select element,
+                return empty dict() if element is not valid or not exists
     """
+
     option_dict = dict()
     if element and hasattr(element, "tag_name") and element.tag_name == "select":
         options = get_element(element, "option", "tag_name", many=True)
@@ -36,7 +38,6 @@ def get_table(table):
     Returns:
         return list of row list,
         return [] if table not valid
-
     """
     results = []
     if table and hasattr(table, "tag_name") and table.tag_name == "table":