Updated documentation.

This commit is contained in:
Maxim Stewart 2020-04-11 15:00:22 -05:00
parent ff349deb9e
commit a9641acc8e
4 changed files with 13 additions and 3 deletions

View File

@ -9,7 +9,15 @@ from core import Context
class Main(Context): class Main(Context):
"""
This is the start that pulls the Context in and its mixins.
Load a command file from here or another class then call
respective method names and pass data as needed.
"""
def __init__(self, args): def __init__(self, args):
"""
Initialize it all...
"""
super().__init__(args) super().__init__(args)
try: try:

View File

@ -37,7 +37,7 @@ class ControlerMixin:
def createXPath(self, data): def createXPath(self, data):
""" """
Don't call directly. Don't call directly from a command file.
:return: created xpath string :return: created xpath string
""" """

View File

@ -19,6 +19,8 @@ class Browser:
:note: Should consider creating methods per browser type. :note: Should consider creating methods per browser type.
:param browserType: The browser we want to use :param browserType: The browser we want to use
:param headless: If we have a gui or not :param headless: If we have a gui or not
:return: the selenium browser driver
""" """
driver = None driver = None
_log_path = "./core/logs/webdriver.log" _log_path = "./core/logs/webdriver.log"

View File

@ -12,7 +12,7 @@ class Logger:
""" """
Create a new logging object and return it. Create a new logging object and return it.
:note: :note:
NOSET # Don't know the actual log level of this... (defaulting or litterally none?) NOSET # Don't know the actual log level of this... (defaulting or literally none?)
Log Levels (From least to most) Log Levels (From least to most)
Type Value Type Value
CRITICAL 50 CRITICAL 50
@ -23,7 +23,7 @@ class Logger:
:param loggerName: Sets the name of the logger object. (Used in log lines) :param loggerName: Sets the name of the logger object. (Used in log lines)
:param createFile: Whether we create a log file or just pump to terminal :param createFile: Whether we create a log file or just pump to terminal
:return: returns the logging object we created :return: the logging object we created
""" """
globalLogLvl = logging.DEBUG # Keep this at highest so that handlers can filter to their desired levels globalLogLvl = logging.DEBUG # Keep this at highest so that handlers can filter to their desired levels