Merge pull request #899 from seleniumbase/perform-code-optimization

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()

docs/requirements.txt

@@ -6,12 +6,12 @@ Markdown==3.3.4
 docutils==0.17.1
 Jinja2==2.11.3
 readme-renderer==29.0
-pymdown-extensions==8.1.1
+pymdown-extensions==8.2
 importlib-metadata==4.0.1;python_version>="3.6"
 lunr==0.5.8
 nltk==3.6.2
 mkdocs==1.1.2
-mkdocs-material==7.1.3
+mkdocs-material==7.1.4
 mkdocs-exclude-search==0.5.2;python_version>="3.6"
 mkdocs-simple-hooks==0.1.3
 mkdocs-material-extensions==1.0.1

help_docs/method_summary.md

@@ -323,6 +323,7 @@ self.get_path_of_downloaded_file(file, browser=False)
 self.is_downloaded_file_present(file, browser=False)
 
 self.delete_downloaded_file_if_present(file, browser=False)
+# Duplicates: self.delete_downloaded_file(file, browser=False)
 
 self.assert_downloaded_file(file, timeout=None, browser=False)
 

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")
 

requirements.txt

@@ -8,7 +8,7 @@ setuptools>=56.1.0;python_version>="3.6"
 setuptools-scm==5.0.2;python_version<"3.6"
 setuptools-scm>=6.0.1;python_version>="3.6"
 wheel>=0.36.2
-attrs>=20.3.0
+attrs>=21.2.0
 PyYAML>=5.4.1;python_version>="3.6"
 certifi>=2020.12.5
 six==1.16.0

seleniumbase/__init__.py

@@ -4,6 +4,7 @@
 from seleniumbase.common import decorators  # noqa
 from seleniumbase.common import encryption  # noqa
 import sys
+
 if sys.version_info[0] >= 3:
     from seleniumbase import translate  # noqa
 del sys  # Undo "import sys" / Simplify "dir(seleniumbase)"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.63.2"
+__version__ = "1.63.3"

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