Refactoring

Author: mdmintz

seleniumbase/core/js_snippets.py

@@ -1,34 +1,34 @@
 """
-Manager for dealing with uploading/managing files on Amazon S3
+Methods for uploading/managing files on Amazon S3.
 """
-from boto.s3.connection import S3Connection
-from boto.s3.key import Key
 from seleniumbase.config import settings
 
 already_uploaded_files = []
 
 
 class S3LoggingBucket(object):
     """
-    A class to upload log files from tests to Amazon S3.
+    A class for uploading log files from tests to Amazon S3.
     Those files can then be shared easily.
     """
-
     def __init__(
         self,
         log_bucket=settings.S3_LOG_BUCKET,
         bucket_url=settings.S3_BUCKET_URL,
         selenium_access_key=settings.S3_SELENIUM_ACCESS_KEY,
         selenium_secret_key=settings.S3_SELENIUM_SECRET_KEY,
     ):
+        from boto.s3.connection import S3Connection
 
         self.conn = S3Connection(selenium_access_key, selenium_secret_key)
         self.bucket = self.conn.get_bucket(log_bucket)
         self.bucket_url = bucket_url
 
-    def get_key(self, _name):
+    def get_key(self, file_name):
         """ Create a new Key instance with the given name. """
-        return Key(bucket=self.bucket, name=_name)
+        from boto.s3.key import Key
+
+        return Key(bucket=self.bucket, name=file_name)
 
     def get_bucket(self):
         """ Return the bucket being used. """
@@ -37,7 +37,7 @@ def get_bucket(self):
     def upload_file(self, file_name, file_path):
         """Upload a given file from the file_path to the bucket
         with the new name/path file_name."""
-        upload_key = Key(bucket=self.bucket, name=file_name)
+        upload_key = self.get_key(file_name)
         content_type = "text/plain"
         if file_name.endswith(".html"):
             content_type = "text/html"

seleniumbase/core/s3_manager.py

@@ -2228,7 +2228,7 @@ def switch_to_frame(self, frame, timeout=None):
 
     def switch_to_default_content(self):
         """Brings driver control outside the current iframe.
-        (If driver control is inside an iframe, the driver control
+        (If the driver control is inside an iframe, the driver control
         will be set to one level above the current frame. If the driver
         control is not currently in an iframe, nothing will happen.)"""
         self.__check_scope()
@@ -5224,8 +5224,9 @@ def wait_for_element_not_present(
         """Same as self.wait_for_element_absent()
         Waits for an element to no longer appear in the HTML of a page.
         A hidden element still counts as appearing in the page HTML.
-        If an element with "hidden" status is acceptable,
-        use wait_for_element_not_visible() instead."""
+        If waiting for elements to be hidden instead of nonexistent,
+        use wait_for_element_not_visible() instead.
+        """
         self.__check_scope()
         if not timeout:
             timeout = settings.LARGE_TIMEOUT
@@ -5241,6 +5242,10 @@ def assert_element_not_present(
     ):
         """Same as self.assert_element_absent()
         Will raise an exception if the element stays present.
+        A hidden element counts as a present element, which fails this assert.
+        If you want to assert that elements are hidden instead of nonexistent,
+        use assert_element_not_visible() instead.
+        (Note that hidden elements are still present in the HTML of the page.)
         Returns True if successful. Default timeout = SMALL_TIMEOUT."""
         self.__check_scope()
         if not timeout:
@@ -8121,9 +8126,10 @@ def wait_for_element_absent(
         self, selector, by=By.CSS_SELECTOR, timeout=None
     ):
         """Waits for an element to no longer appear in the HTML of a page.
-        A hidden element still counts as appearing in the page HTML.
-        If an element with "hidden" status is acceptable,
-        use wait_for_element_not_visible() instead."""
+        A hidden element counts as a present element, which fails this assert.
+        If waiting for elements to be hidden instead of nonexistent,
+        use wait_for_element_not_visible() instead.
+        """
         self.__check_scope()
         if not timeout:
             timeout = settings.LARGE_TIMEOUT
@@ -8137,8 +8143,12 @@ def wait_for_element_absent(
     def assert_element_absent(
         self, selector, by=By.CSS_SELECTOR, timeout=None
     ):
-        """Similar to wait_for_element_absent() - returns nothing.
+        """Similar to wait_for_element_absent()
         As above, will raise an exception if the element stays present.
+        A hidden element counts as a present element, which fails this assert.
+        If you want to assert that elements are hidden instead of nonexistent,
+        use assert_element_not_visible() instead.
+        (Note that hidden elements are still present in the HTML of the page.)
         Returns True if successful. Default timeout = SMALL_TIMEOUT."""
         self.__check_scope()
         if not timeout:
@@ -8169,7 +8179,7 @@ def wait_for_element_not_visible(
     def assert_element_not_visible(
         self, selector, by=By.CSS_SELECTOR, timeout=None
     ):
-        """Similar to wait_for_element_not_visible() - returns nothing.
+        """Similar to wait_for_element_not_visible()
         As above, will raise an exception if the element stays visible.
         Returns True if successful. Default timeout = SMALL_TIMEOUT."""
         self.__check_scope()