Update black and isort linting tools

Author: DougCorell

api/osf_api.py

@@ -121,8 +121,7 @@ def delete_all_user_projects(session, user=None):
 
 
 def delete_project(session, guid, user=None):
-    """Delete a single project. Simply pass in the guid
-    """
+    """Delete a single project. Simply pass in the guid"""
     if not user:
         user = current_user(session)
     nodes_url = user.relationships.nodes['links']['related']['href']
@@ -135,8 +134,7 @@ def delete_project(session, guid, user=None):
 
 
 def create_custom_collection(session):
-    """Create a new custom collection. You can modify the title of the collection here as well.
-    """
+    """Create a new custom collection. You can modify the title of the collection here as well."""
     collections_url = '{}/v2/collections/'.format(session.api_base_url)
 
     payload = {
@@ -147,8 +145,7 @@ def create_custom_collection(session):
 
 
 def delete_custom_collections(session):
-    """Delete all custom collections for the current user.
-    """
+    """Delete all custom collections for the current user."""
     collections_url = '{}/v2/collections/'.format(session.api_base_url)
     data = session.get(collections_url)
 
@@ -161,8 +158,7 @@ def delete_custom_collections(session):
 # TODO rename this to get_node_providers, and create new function that actually IS get_node_addons -
 #  note, this is confusing, talk to BrianG before we change this
 def get_node_addons(session, node_id):
-    """Return a list of the names of all the addons connected to the given node.
-    """
+    """Return a list of the names of all the addons connected to the given node."""
     url = '/v2/nodes/{}/files/'.format(node_id)
     data = session.get(url, query_parameters={'page[size]': 20})
     providers = []
@@ -222,8 +218,7 @@ def upload_fake_file(
 
 
 def delete_addon_files(session, provider, current_browser, guid):
-    """Delete all files for the given addon.
-    """
+    """Delete all files for the given addon."""
     files_url = '{}/v2/nodes/{}/files/{}/'.format(session.api_base_url, guid, provider)
 
     data = session.get(url=files_url, query_parameters={'page[size]': 20})
@@ -245,8 +240,7 @@ def delete_file(session, delete_url):
 
 
 def get_providers_list(session=None, type='preprints'):
-    """Return the providers list data. The default is the preprint providers list.
-    """
+    """Return the providers list data. The default is the preprint providers list."""
     if not session:
         session = get_default_session()
     url = '/v2/providers/' + type
@@ -265,14 +259,13 @@ def get_provider(session=None, type='registrations', provider_id='osf'):
 
 
 def get_provider_submission_status(provider):
-    """Return the boolean attribute `allow_submissions` from the dictionary object (provider)
-    """
+    """Return the boolean attribute `allow_submissions` from the dictionary object (provider)"""
     return provider['attributes']['allow_submissions']
 
 
 def get_providers_total(provider_name, session):
-    """ Return the total number of preprints for a given service provider.
-        Note: Reformat provider names to all lowercase and remove white spaces.
+    """Return the total number of preprints for a given service provider.
+    Note: Reformat provider names to all lowercase and remove white spaces.
     """
     provider_url = '/v2/providers/preprints/{}/preprints/'.format(
         provider_name.lower().replace(' ', '')
@@ -281,7 +274,10 @@ def get_providers_total(provider_name, session):
 
 
 def connect_provider_root_to_node(
-    session, provider, external_account_id, node_id=settings.PREFERRED_NODE,
+    session,
+    provider,
+    external_account_id,
+    node_id=settings.PREFERRED_NODE,
 ):
     """Initialize the node<=>addon connection, add the given external_account_id, and configure it
     to connect to the root folder of the provider."""

base/exceptions.py

@@ -7,7 +7,6 @@ class HttpError(PageException):
 
 
 class LoginError(PageException):
-    """Error used when driver is in an unexpected login state.
-    """
+    """Error used when driver is in an unexpected login state."""
 
     pass

base/expected_conditions.py

@@ -2,7 +2,7 @@
 
 
 class link_has_href(object):
-    """ An Expectation for checking link is visible and has an href so
+    """An Expectation for checking link is visible and has an href so
     you can click it."""
 
     def __init__(self, locator):
@@ -17,7 +17,7 @@ def __call__(self, driver):
 
 
 class window_at_index(object):
-    """ An Expectation for checking if a tab is open for certain index
+    """An Expectation for checking if a tab is open for certain index
     so you can switch to it."""
 
     def __init__(self, page_index):

base/locators.py

@@ -128,8 +128,8 @@ def __init__(self, selector, path, timeout=settings.TIMEOUT):
 
     def get_element(self, driver, attribute_name):
         """Must be implemented by every Locator subclass. Defines how a locator is used within
-         a page (or element). Ultimately is a locator's return value when used in the PageObject model.
-         """
+        a page (or element). Ultimately is a locator's return value when used in the PageObject model.
+        """
         raise NotImplementedError
 
 

components/accessibility.py

@@ -15,17 +15,17 @@ def run_axe(
         terminal_errors=True,
         exclude_best_practice=False,
     ):
-        """ Use the axe testing engine to perform accessibility checks on a web page
-            Parameters:
-            - page_name - string - unique identifier for the web page being tested
-                - used as part of file name when writing results files
-            - write_files - boolean - used to determine whether or not to write results
-                files - default = True
-            - terminal_errors - boolean - used to determine whether or not to output
-                errors to terminal window - default = True
-            - exclude_best_practice - boolean - used to determine whether or not to
-                exclude the Best Practice rule set when performing accessibility check.
-                - default = False
+        """Use the axe testing engine to perform accessibility checks on a web page
+        Parameters:
+        - page_name - string - unique identifier for the web page being tested
+            - used as part of file name when writing results files
+        - write_files - boolean - used to determine whether or not to write results
+            files - default = True
+        - terminal_errors - boolean - used to determine whether or not to output
+            errors to terminal window - default = True
+        - exclude_best_practice - boolean - used to determine whether or not to
+            exclude the Best Practice rule set when performing accessibility check.
+            - default = False
         """
         axe = Axe(driver)
         # Inject axe-core javascript into page.
@@ -76,7 +76,7 @@ def run_axe(
 
 
 def write_results_files(axe, results, page_name):
-    """ Write results to output .json files (3 separate files for passes, violations,
+    """Write results to output .json files (3 separate files for passes, violations,
     and incomplete) and also convert each .json file to a .csv file.  So there should
     be 6 separate files created for each execution of axe.  We are using the Panda
     library to convert .json to .csv files.

components/email_access.py

@@ -5,7 +5,7 @@ class EmailAccess:
     def get_latest_email_body_by_imap(
         imap_host, email_address, password, mailbox, search_key, search_value
     ):
-        """ This method uses Internet Message Access Protocol (IMAP) to login to an IMAP
+        """This method uses Internet Message Access Protocol (IMAP) to login to an IMAP
         enabled email address and retrieve the body of the latest email that matches the
         provided search criteria.
             Parameters:
@@ -37,7 +37,7 @@ def get_latest_email_body_by_imap(
         return email_body
 
     def get_count_of_unseen_emails_by_imap(imap_host, email_address, password):
-        """ This method uses Internet Message Access Protocol (IMAP) to login to an IMAP
+        """This method uses Internet Message Access Protocol (IMAP) to login to an IMAP
         enabled email address and retrieve the count of unseen emails in the account inbox.
             Parameters:
             - imap_host: host imap email server
@@ -59,29 +59,29 @@ def get_count_of_unseen_emails_by_imap(imap_host, email_address, password):
 
 
 def imap_connect_and_login(imap_host, email_address, password):
-    """ Function to make SSL connection to IMP host and login with the given credentials
-        Parameters:
-        - imap_host: host imap email server
-        - email_address: IMAP enabled email address
-        - password: password for the IMAP enabled email address
-        Returns IMAP connected object
+    """Function to make SSL connection to IMP host and login with the given credentials
+    Parameters:
+    - imap_host: host imap email server
+    - email_address: IMAP enabled email address
+    - password: password for the IMAP enabled email address
+    Returns IMAP connected object
     """
     imap = imaplib.IMAP4_SSL(imap_host)
     imap.login(email_address, password)
     return imap
 
 
 def imap_close(imap):
-    """ Function that closes the current email mailbox and logs out of the email account
-        Parameters:
-        - imap: IMAP connected object
+    """Function that closes the current email mailbox and logs out of the email account
+    Parameters:
+    - imap: IMAP connected object
     """
     imap.close()
     imap.logout()
 
 
 def search(key, value, imap):
-    """ Function to search through emails for a given key value pair and return a
+    """Function to search through emails for a given key value pair and return a
     filtered email list.
     EX: result_uids = search('FROM', '[email protected]', con)
         Parameters:

pages/collections.py

@@ -8,8 +8,7 @@
 
 
 class BaseCollectionPage(OSFBasePage):
-    """The base page from which all collection pages inherit.
-    """
+    """The base page from which all collection pages inherit."""
 
     base_url = settings.OSF_HOME + '/collections/'
     url_addition = ''
@@ -24,8 +23,7 @@ def __init__(self, driver, verify=False, provider=None):
 
     @property
     def url(self):
-        """Set the URL based on the provider domain.
-        """
+        """Set the URL based on the provider domain."""
         return urljoin(self.base_url, self.provider_id) + '/' + self.url_addition
 
 

pages/login.py

@@ -150,14 +150,12 @@ def login(driver, user=settings.USER_ONE, password=settings.USER_ONE_PASSWORD):
 
 
 def safe_login(driver, user=settings.USER_ONE, password=settings.USER_ONE_PASSWORD):
-    """Raise a LoginError if login fails.
-    """
+    """Raise a LoginError if login fails."""
     login(driver, user=user, password=password)
     if not OSFBasePage(driver).is_logged_in():
         raise LoginError('Login failed')
 
 
 def logout(driver):
-    """Log the user out.
-    """
+    """Log the user out."""
     driver.get(settings.OSF_HOME + '/logout/')

pages/preprints.py

@@ -10,8 +10,7 @@
 
 
 class BasePreprintPage(OSFBasePage):
-    """The base page from which all preprint pages inherit.
-    """
+    """The base page from which all preprint pages inherit."""
 
     base_url = settings.OSF_HOME + '/preprints/'
     url_addition = ''
@@ -28,8 +27,7 @@ def __init__(self, driver, verify=False, provider=None):
 
     @property
     def url(self):
-        """Set the URL based on the provider domain.
-        """
+        """Set the URL based on the provider domain."""
         if self.provider and self.provider_id != 'osf':
             if self.provider['attributes']['domain_redirect_enabled']:
                 return urljoin(self.provider_domain, self.url_addition)
@@ -181,8 +179,7 @@ class ReviewsDashboardPage(OSFBasePage):
 
 
 class BaseReviewsPage(OSFBasePage):
-    """The base page from which all preprint provider review pages inherit.
-    """
+    """The base page from which all preprint provider review pages inherit."""
 
     base_url = settings.OSF_HOME + '/reviews/preprints/'
     url_addition = ''
@@ -199,8 +196,7 @@ def __init__(self, driver, verify=False, provider=None):
 
     @property
     def url(self):
-        """Set the URL based on the provider domain.
-        """
+        """Set the URL based on the provider domain."""
         return urljoin(self.base_url, self.provider_id) + '/' + self.url_addition
 
     def verify(self):

pages/registries.py

@@ -24,8 +24,7 @@ def __init__(self, driver, verify=False, provider=None):
 
     @property
     def url(self):
-        """Set the URL based on the provider
-        """
+        """Set the URL based on the provider"""
         if self.provider and self.provider_id != 'osf':
             return urljoin(self.base_url, self.provider_id) + '/' + self.url_addition
         return self.base_url + self.url_addition
@@ -170,5 +169,7 @@ def __init__(self, driver, verify=False, draft_id='', url_addition=''):
 class DraftRegistrationReviewPage(BaseRegistrationDraftPage):
     url_addition = 'review'
     identity = Locator(
-        By.CSS_SELECTOR, '[data-test-toggle-anchor-nav-button]', settings.LONG_TIMEOUT,
+        By.CSS_SELECTOR,
+        '[data-test-toggle-anchor-nav-button]',
+        settings.LONG_TIMEOUT,
     )

requirements.txt

@@ -12,5 +12,5 @@ pre-commit==1.18.3
 ipdb==0.12.2
 axe-selenium-python==2.1.6
 pandas==1.2.4
-isort==5.8.0
-black==19.10b0
+isort==5.9.3
+black==22.3.0

tests/conftest.py

@@ -78,8 +78,8 @@ def delete_user_projects_at_setup(session):
 @pytest.fixture
 def default_project(session):
     """Creates a new project through the api and returns it. Deletes the project at the end of the test run.
-     If PREFERRED_NODE is set, returns the APIDetail of preferred node.
-     """
+    If PREFERRED_NODE is set, returns the APIDetail of preferred node.
+    """
     if settings.PREFERRED_NODE:
         yield osf_api.get_node(session)
     else:
@@ -115,8 +115,7 @@ def project_with_file(session, default_project):
 
 
 def pytest_addoption(parser):
-    """Accept input parameters when running pytest from command line
-    """
+    """Accept input parameters when running pytest from command line"""
     # Flag to determine whether to write accessibility output files
     parser.addoption('--write_files', action='store')
     # Flag to determine whether to exclude Best Practice rules from accessibility check

tests/test_a11y_cas.py

@@ -32,7 +32,7 @@ def test_accessibility(self, driver, session, write_files, exclude_best_practice
 
 @markers.dont_run_on_prod
 class TestLogin2FAPage:
-    """ This test logs in as a user with 2 Factor Authentication enabled. After entering
+    """This test logs in as a user with 2 Factor Authentication enabled. After entering
     their login credentials as normal the user is then directed to a 2 Factor Authentication
     page.
     """
@@ -53,7 +53,7 @@ def test_accessibility(self, driver, session, write_files, exclude_best_practice
 
 @markers.dont_run_on_prod
 class TestLoginToSPage:
-    """ This test logs in as a user that has not accepted the OSF Terms of Service.  After
+    """This test logs in as a user that has not accepted the OSF Terms of Service.  After
     entering their login credentials as normal the user is then directed to a Terms of
     Service acceptance page.
     """
@@ -124,7 +124,7 @@ def test_accessibility(self, driver, session, write_files, exclude_best_practice
 
 
 class TestInstitutionForgotPasswordPage:
-    """ Test the Forgot Password page that is reached from the Unsupported Institution
+    """Test the Forgot Password page that is reached from the Unsupported Institution
     Login Page. This Forgot Password page is different from the other Forgot Password
     page in OSF.
     """
@@ -148,8 +148,7 @@ def test_accessibility(self, driver, session, write_files, exclude_best_practice
 
 class TestGenericCASExceptionPage:
     def test_accessibility(self, driver, session, write_files, exclude_best_practice):
-        """ Test the Service not authorized exception page by having an invalid service in the url
-        """
+        """Test the Service not authorized exception page by having an invalid service in the url"""
         driver.get(settings.CAS_DOMAIN + '/login?service=https://noservice.osf.io/')
         assert GenericCASPage(driver, verify=True)
         a11y.run_axe(
@@ -166,7 +165,7 @@ class TestCASOauthAuthorizationPage:
     def test_accessibility(
         self, driver, session, write_files, exclude_best_practice, must_be_logged_in
     ):
-        """ Test the CAS Oauth Authorization page by building an authorization url using
+        """Test the CAS Oauth Authorization page by building an authorization url using
         the required parameters and then navigating to that url. No need to complete the
         authorization process since we just want to evaluate the authorization page for
         accessibility compliance.