Perform code optimization

Author: mdmintz

docs/prepare.py

@@ -50,7 +50,7 @@ def process_file(file_name):
         content = content.replace("(" + md_path + ")", normalize_path(path))
 
     for url in urls:
-        path = url[len(GITHUB_URL):]
+        path = url[len(GITHUB_URL) :]  # noqa: E203
         paths.add(path)
         content = content.replace(
             url, normalize_path(os.path.relpath(path, directory))
@@ -83,9 +83,9 @@ def main(*args, **kwargs):
         process_file(file_)
 
     readme_file = "./docs/README.md"
-    with open(readme_file, 'r', encoding='utf-8') as f:
+    with open(readme_file, "r", encoding="utf-8") as f:
         all_code = f.read()
-    code_lines = all_code.split('\n')
+    code_lines = all_code.split("\n")
 
     changed = False
     seleniumbase_lines = []
@@ -99,24 +99,27 @@ def main(*args, **kwargs):
                 r'<p align="center"><div align="center">'
                 r'<a href="https://github.com/seleniumbase/SeleniumBase">'
                 r'<img src="https://img.shields.io/badge/'
-                r'✅%20💛%20View%20Code-on%20GitHub%20🌎%20🚀'
+                r"✅%20💛%20View%20Code-on%20GitHub%20🌎%20🚀"
                 r'-02A79E.svg" alt="SeleniumBase on GitHub" />'
-                r'</a></div></p>')
+                r"</a></div></p>"
+            )
         if "<!-- SeleniumBase Header1 -->" in line:
             changed = True
             line = (
                 '<section align="center"><div align="center">'
-                '<h2>✅ Reliable Browser Testing</h2>'
-                '</div></section>')
+                "<h2>✅ Reliable Browser Testing</h2>"
+                "</div></section>"
+            )
         if "<!-- SeleniumBase Docs -->" in line:
             changed = True
             line = (
                 '<h2><img src="https://seleniumbase.io/img/sb_icon.png" '
                 'title="SeleniumBase" width="20" /> SeleniumBase Docs '
                 '<img src="https://seleniumbase.io/img/sb_icon.png" '
-                'title="SeleniumBase" width="20" /></h2>')
+                'title="SeleniumBase" width="20" /></h2>'
+            )
         seleniumbase_lines.append(line)
     if changed:
-        out_file = codecs.open(readme_file, "w+", encoding='utf-8')
+        out_file = codecs.open(readme_file, "w+", encoding="utf-8")
         out_file.writelines("\r\n".join(seleniumbase_lines))
         out_file.close()

integrations/brython/index.py

@@ -2,4 +2,4 @@
 
 
 def setup_page():
-    document['topHeader'].textContent = "Brython Examples:"
+    document["topHeader"].textContent = "Brython Examples:"

integrations/node_js/my_first_test.py

@@ -2,7 +2,6 @@
 
 
 class MyTestClass(BaseCase):
-
     def test_basics(self):
         url = "https://store.xkcd.com/collections/posters"
         self.open(url)

integrations/node_js/test_demo_site.py

@@ -2,7 +2,6 @@
 
 
 class MyTestClass(BaseCase):
-
     def test_demo_site(self):
         self.open("https://seleniumbase.io/demo_page")
 

seleniumbase/common/decorators.py

@@ -9,14 +9,14 @@
 
 
 def retry_on_exception(tries=6, delay=1, backoff=2, max_delay=32):
-    '''
+    """
     Decorator for implementing exponential backoff for retrying on failures.
 
     tries: Max number of tries to execute the wrapped function before failing.
     delay: Delay time in seconds before the FIRST retry.
     backoff: Multiplier to extend the initial delay by for each retry.
     max_delay: Max time in seconds to wait between retries.
-    '''
+    """
     tries = math.floor(tries)
     if tries < 1:
         raise ValueError('"tries" must be greater than or equal to 1.')
@@ -37,21 +37,24 @@ def function_to_retry(*args, **kwargs):
                 except Exception as e:
                     if local_delay > max_delay:
                         local_delay = max_delay
-                    logging.exception('%s: Retrying in %d seconds...'
-                                      % (str(e), local_delay))
+                    logging.exception(
+                        "%s: Retrying in %d seconds..." % (str(e), local_delay)
+                    )
                     time.sleep(local_delay)
                     local_tries -= 1
                     local_delay *= backoff
             return func(*args, **kwargs)
+
         return function_to_retry
+
     return decorated_function_with_retry
 
 
 def rate_limited(max_per_second):
-    """ This decorator limits how often a method can get called in a second.
-        If the limit is exceeded, the call will be held in a queue until
-        enough time has passed.
-        Useful when trying to avoid overloading a system with rapid calls. """
+    """This decorator limits how often a method can get called in a second.
+    If the limit is exceeded, the call will be held in a queue until
+    enough time has passed.
+    Useful when trying to avoid overloading a system with rapid calls."""
     min_interval = 1.0 / float(max_per_second)
 
     def decorate(func):
@@ -76,33 +79,37 @@ def rate_limited_function(*args, **kargs):
             finally:
                 rate_lock.release()
             return func(*args, **kargs)
+
         return rate_limited_function
+
     return decorate
 
 
 def deprecated(message=None):
-    """ This decorator marks methods as deprecated.
-        A warning is displayed if the method is called. """
+    """This decorator marks methods as deprecated.
+    A warning is displayed if the method is called."""
 
     def decorated_method_to_deprecate(func):
         if inspect.isclass(func):
             # Handle a deprecated class differently from a deprecated method
             msg = "Class {}() is DEPRECATED! *** ".format(func.__name__)
             if message:
                 msg += "<> %s <>" % message
-            warnings.simplefilter('always', DeprecationWarning)  # See Warnings
+            warnings.simplefilter("always", DeprecationWarning)  # See Warnings
             warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
-            warnings.simplefilter('default', DeprecationWarning)  # Set Default
+            warnings.simplefilter("default", DeprecationWarning)  # Set Default
             return func
 
         @wraps(func)
         def new_func(*args, **kwargs):
             msg = "Method {}() is DEPRECATED! *** ".format(func.__name__)
             if message:
                 msg += "<> %s <>" % message
-            warnings.simplefilter('always', DeprecationWarning)  # See Warnings
+            warnings.simplefilter("always", DeprecationWarning)  # See Warnings
             warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
-            warnings.simplefilter('default', DeprecationWarning)  # Set Default
+            warnings.simplefilter("default", DeprecationWarning)  # Set Default
             return func(*args, **kwargs)
+
         return new_func
+
     return decorated_method_to_deprecate

seleniumbase/common/encryption.py

@@ -1,6 +1,6 @@
 # -\*- coding: utf-8 -\*-
 
-''' This is mainly for string obfuscation. '''
+""" This is mainly for string obfuscation. """
 
 import base64
 import codecs
@@ -13,16 +13,17 @@ def str_xor(string, key):
         raise Exception("2nd arg of str_xor() must be a string of length > 0!")
     if len(string) > len(key):
         difference = len(string) - len(key)
-        key = key + (
-            ((difference / len(key)) * key) + key)
+        key = key + (((difference / len(key)) * key) + key)
     result = None
     try:
         result = "".join(
-            [chr(ord(c1) ^ ord(c2)) for (c1, c2) in zip(string, key)])
+            [chr(ord(c1) ^ ord(c2)) for (c1, c2) in zip(string, key)]
+        )
     except Exception:
-        string = string.decode('utf-8')
+        string = string.decode("utf-8")
         result = "".join(
-            [chr(ord(c1) ^ ord(c2)) for (c1, c2) in zip(string, key)])
+            [chr(ord(c1) ^ ord(c2)) for (c1, c2) in zip(string, key)]
+        )
     return result
 
 
@@ -31,22 +32,22 @@ def is_obfuscated(string):
     # Obfuscated strings have a common predefined start token and end token.
     start_token = settings.OBFUSCATION_START_TOKEN
     end_token = settings.OBFUSCATION_END_TOKEN
-    return (string.startswith(start_token) and string.endswith(end_token))
+    return string.startswith(start_token) and string.endswith(end_token)
 
 
 def shuffle_string(string):
     if len(string) < 2:
         return string
-    return (string[1::2] + string[::2])
+    return string[1::2] + string[::2]
 
 
 def reverse_shuffle_string(string):
     if len(string) < 2:
         return string
     new_string = ""
-    odd = (len(string) % 2 == 1)
-    part1 = string[:int(len(string) / 2):1]
-    part2 = string[int(len(string) / 2)::1]
+    odd = len(string) % 2 == 1
+    part1 = string[: int(len(string) / 2) : 1]  # noqa: E203
+    part2 = string[int(len(string) / 2) :: 1]  # noqa: E203
     for c in range(len(part1)):
         new_string += part2[c]
         new_string += part1[c]
@@ -81,7 +82,7 @@ def ord_string_sum(string):
         for c in string:
             count += ord(c)
     except Exception:
-        string = string.decode('utf-8')
+        string = string.decode("utf-8")
         for c in string:
             count += ord(c)
     return count
@@ -97,14 +98,18 @@ def decrypt(string):
     already_encrypted = False
     if is_obfuscated(string):
         already_encrypted = True
-        string = string[len(start_token):-len(end_token)]
+        string = string[len(start_token) : -len(end_token)]  # noqa: E203
         string = base64.b64decode(codecs.encode(string))
     # Obfuscate the key used for string obfuscation
-    hd1 = hashlib.sha256(str(encryption_key).encode('utf-8')).hexdigest()
-    hd2 = hashlib.sha256(str(encryption_key[::-1]).encode('utf-8')).hexdigest()
+    hd1 = hashlib.sha256(str(encryption_key).encode("utf-8")).hexdigest()
+    hd2 = hashlib.sha256(str(encryption_key[::-1]).encode("utf-8")).hexdigest()
     b64_key = base64.b64encode(codecs.encode(encryption_key * 8))
-    xor_key = "".join([chr(ord(str(c3)) - int(c1, 16) - int(c2, 16)) for (
-        c1, c2, c3) in zip(hd1, hd2, b64_key.decode("utf-8"))])
+    xor_key = "".join(
+        [
+            chr(ord(str(c3)) - int(c1, 16) - int(c2, 16))
+            for (c1, c2, c3) in zip(hd1, hd2, b64_key.decode("utf-8"))
+        ]
+    )
     xor_key = blend_strings(xor_key, encryption_key)
     if len(xor_key) % 7 == 0:
         xor_key = xor_key + encryption_key[-1]
@@ -118,18 +123,30 @@ def decrypt(string):
             rem4 = (len(string) + ord_string_sum(string)) % 2
         if len(string) % 2 != 0:
             if rem3 == 1:
-                string = (chr(ord(string[-1]) - 5 - rem1) + string + ''
-                          '' + chr(ord(string[-1]) - 13 - rem1))
+                string = (
+                    chr(ord(string[-1]) - 5 - rem1)
+                    + string
+                    + chr(ord(string[-1]) - 13 - rem1)
+                )
             else:
-                string = (chr(ord(string[-1]) - 11 - rem1) + string + ''
-                          '' + chr(ord(string[-1]) - 23 - rem1))
+                string = (
+                    chr(ord(string[-1]) - 11 - rem1)
+                    + string
+                    + chr(ord(string[-1]) - 23 - rem1)
+                )
         elif len(string) > 1:
             if rem4 == 1:
-                string = (chr(ord(string[0]) - 19 + rem2) + string + ''
-                          '' + chr(ord(string[0]) - 7 - rem2))
+                string = (
+                    chr(ord(string[0]) - 19 + rem2)
+                    + string
+                    + chr(ord(string[0]) - 7 - rem2)
+                )
             else:
-                string = (chr(ord(string[0]) - 26 + rem2) + string + ''
-                          '' + chr(ord(string[0]) - 12 - rem2))
+                string = (
+                    chr(ord(string[0]) - 26 + rem2)
+                    + string
+                    + chr(ord(string[0]) - 12 - rem2)
+                )
         rem5 = (len(string) + ord_string_sum(string)) % 23
         string = rotate(string, rem5)
         result = str_xor(shuffle_string(string)[::-1], xor_key)

seleniumbase/common/obfuscate.py

@@ -14,7 +14,7 @@
 
 def main():
     try:
-        while(1):
+        while 1:
             print("\nEnter password to obfuscate: (CTRL+C to exit)")
             password = getpass.getpass()
             print("Verify password:")

seleniumbase/common/unobfuscate.py

@@ -20,9 +20,10 @@ def main():
         # Python 2 has the raw_input() method. Python 3 does not.
         input_method = raw_input  # noqa: ignore=F821
     try:
-        while(1):
+        while 1:
             code = input_method(
-                '\nEnter obfuscated/encrypted string: (CTRL+C to exit):\n')
+                "\nEnter obfuscated/encrypted string: (CTRL+C to exit):\n"
+            )
             print("\nHere is the unobfuscated string/password:")
             time.sleep(0.07)
             print(encryption.decrypt(code))

seleniumbase/console_scripts/logo_helper.py

@@ -4,13 +4,13 @@
 
 import colorama
 
-r'''
+r"""
    ______     __           _                 ____
   / ____/__  / /__  ____  (_)_  ______ ___  / _  \____  ________
   \__ \/ _ \/ / _ \/ __ \/ / / / / __ `__ \/ /_) / __ \/ ___/ _ \
  ___/ /  __/ /  __/ / / / / /_/ / / / / / / /_) / (_/ /__  /  __/
 /____/\___/_/\___/_/ /_/_/\__,_/_/ /_/ /_/_____/\__,_/____/\___/
-'''
+"""
 
 
 def get_seleniumbase_logo():