Introduce new project code standards (#962)

This change adds Ruff as the new linter and loosens Black's formatting
as well.
Due to this change, we can drop flake8 and old pre-commit hooks.

.gitignore

@@ -16,3 +16,5 @@ settings.ini
 
 # common venv name
 .airgun/
+venv*
+

.pre-commit-config.yaml

@@ -1,27 +1,17 @@
 # configuration for pre-commit git hooks
 
 repos:
-- repo: https://github.com/asottile/reorder_python_imports
-  rev: v3.0.1
-  hooks:
-  - id: reorder-python-imports
-- repo: https://github.com/asottile/pyupgrade
-  rev: v2.32.0
-  hooks:
-  - id: pyupgrade
-    args: [--py36-plus]
 - repo: https://github.com/psf/black
-  rev: 22.3.0
+  rev: 23.3.0
   hooks:
   - id: black
-- repo: https://github.com/pycqa/flake8
-  rev: 3.9.2
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.277
   hooks:
-  - id: flake8
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.2.0
   hooks:
-  - id: trailing-whitespace
-  - id: end-of-file-fixer
   - id: check-yaml
   - id: debug-statements

airgun/__init__.py

@@ -1,4 +1,3 @@
 from airgun.settings import Settings
 
-
 settings = Settings()

airgun/browser.py

@@ -2,28 +2,24 @@
 tests.
 """
 import base64
+from contextlib import contextmanager
+from datetime import datetime
 import logging
 import os
 import time
 import urllib
-from contextlib import contextmanager
-from datetime import datetime
 from urllib.parse import unquote
 
-import yaml
 from box import Box
 from selenium import webdriver
-from wait_for import TimedOutError
-from wait_for import wait_for
+from wait_for import TimedOutError, wait_for
 from webdriver_kaifuku import BrowserManager
-from widgetastic.browser import Browser
-from widgetastic.browser import DefaultPlugin
-from widgetastic.exceptions import NoAlertPresentException
-from widgetastic.exceptions import NoSuchElementException
+from widgetastic.browser import Browser, DefaultPlugin
+from widgetastic.exceptions import NoAlertPresentException, NoSuchElementException
+import yaml
 
 from airgun import settings
-from airgun.widgets import ConfirmationDialog
-from airgun.widgets import Pf4ConfirmationDialog
+from airgun.widgets import ConfirmationDialog, Pf4ConfirmationDialog
 
 LOGGER = logging.getLogger(__name__)
 
@@ -116,7 +112,7 @@ def finalize(self, passed=True):
             or not. Is only used for ``saucelabs`` provider.
         :return: None
         """
-        if self.provider == 'selenium' or self.provider == 'remote':
+        if self.provider in ('selenium', 'remote'):
             self._webdriver.quit()
             return
 
@@ -342,7 +338,7 @@ def get_downloads_list(self):
             '.filter(e => e.state === "COMPLETE")'
             '.map(e => e.file_url || e.fileUrl);'
         )
-        if self.browser_type == 'chrome' and self.browser_version >= 79:
+        if self.browser_type == 'chrome':
             script = (
                 'return document.querySelector("downloads-manager")'
                 '.shadowRoot.querySelector("#downloadsList")'
@@ -477,7 +473,7 @@ def handle_alert(
     ):
         """Extend the behaviour of widgetstatic.browser.handle_alert to handle PF4 alerts"""
         popup = self.get_alert(squash=squash)
-        if isinstance(popup, (Pf4ConfirmationDialog, ConfirmationDialog)):
+        if isinstance(popup, Pf4ConfirmationDialog | ConfirmationDialog):
             if cancel:
                 self.logger.info("  dismissing")
                 popup.cancel()

airgun/entities/activationkey.py

@@ -1,12 +1,13 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.activationkey import ActivationKeyCreateView
-from airgun.views.activationkey import ActivationKeyEditView
-from airgun.views.activationkey import ActivationKeysView
+from airgun.views.activationkey import (
+    ActivationKeyCreateView,
+    ActivationKeyEditView,
+    ActivationKeysView,
+)
 
 
 class ActivationKeyEntity(BaseEntity):

airgun/entities/ansible_role.py

@@ -1,10 +1,8 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
-from airgun.views.ansible_role import AnsibleRolesImportView
-from airgun.views.ansible_role import AnsibleRolesView
+from airgun.navigation import NavigateStep, navigator
+from airgun.views.ansible_role import AnsibleRolesImportView, AnsibleRolesView
 
 
 class AnsibleRolesEntity(BaseEntity):

airgun/entities/ansible_variable.py

@@ -1,10 +1,8 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
-from airgun.views.ansible_variable import AnsibleVariablesView
-from airgun.views.ansible_variable import NewAnsibleVariableView
+from airgun.navigation import NavigateStep, navigator
+from airgun.views.ansible_variable import AnsibleVariablesView, NewAnsibleVariableView
 
 
 class AnsibleVariablesEntity(BaseEntity):

airgun/entities/architecture.py

@@ -1,12 +1,13 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.architecture import ArchitectureCreateView
-from airgun.views.architecture import ArchitectureDetailsView
-from airgun.views.architecture import ArchitecturesView
+from airgun.views.architecture import (
+    ArchitectureCreateView,
+    ArchitectureDetailsView,
+    ArchitecturesView,
+)
 
 
 class ArchitectureEntity(BaseEntity):

airgun/entities/audit.py

@@ -1,6 +1,5 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
 from airgun.views.audit import AuditsView
 

airgun/entities/base.py

@@ -6,7 +6,6 @@
 
 
 class BaseEntity:
-
     HELPER_CLASS = BaseEntityHelper
 
     def __init__(self, browser):

airgun/entities/bookmark.py

@@ -1,9 +1,7 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.bookmark import BookmarkEditView
-from airgun.views.bookmark import BookmarksView
+from airgun.views.bookmark import BookmarkEditView, BookmarksView
 
 
 def _gen_queries(entity_name, controller=None):

airgun/entities/cloud_insights.py

@@ -1,9 +1,7 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.cloud_insights import CloudInsightsView
-from airgun.views.cloud_insights import CloudTokenView
+from airgun.views.cloud_insights import CloudInsightsView, CloudTokenView
 from airgun.views.job_invocation import JobInvocationCreateView
 
 

airgun/entities/cloud_inventory.py

@@ -1,6 +1,5 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
 from airgun.views.cloud_inventory import CloudInventoryListView
 

airgun/entities/computeprofile.py

@@ -1,13 +1,14 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.computeprofile import ComputeProfileCreateView
-from airgun.views.computeprofile import ComputeProfileDetailView
-from airgun.views.computeprofile import ComputeProfileRenameView
-from airgun.views.computeprofile import ComputeProfilesView
+from airgun.views.computeprofile import (
+    ComputeProfileCreateView,
+    ComputeProfileDetailView,
+    ComputeProfileRenameView,
+    ComputeProfilesView,
+)
 
 
 class ComputeProfileEntity(BaseEntity):

airgun/entities/computeresource.py

@@ -1,19 +1,20 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.computeresource import ComputeResourceRHVImageCreateView
-from airgun.views.computeresource import ComputeResourceRHVImageEditView
-from airgun.views.computeresource import ComputeResourcesView
-from airgun.views.computeresource import ComputeResourceVMwareImageCreateView
-from airgun.views.computeresource import ComputeResourceVMwareImageEditView
-from airgun.views.computeresource import ResourceProviderCreateView
-from airgun.views.computeresource import ResourceProviderDetailView
-from airgun.views.computeresource import ResourceProviderEditView
-from airgun.views.computeresource import ResourceProviderProfileView
-from airgun.views.computeresource import ResourceProviderVMImport
+from airgun.views.computeresource import (
+    ComputeResourceRHVImageCreateView,
+    ComputeResourceRHVImageEditView,
+    ComputeResourcesView,
+    ComputeResourceVMwareImageCreateView,
+    ComputeResourceVMwareImageEditView,
+    ResourceProviderCreateView,
+    ResourceProviderDetailView,
+    ResourceProviderEditView,
+    ResourceProviderProfileView,
+    ResourceProviderVMImport,
+)
 
 
 class ComputeResourceEntity(BaseEntity):
@@ -273,7 +274,7 @@ class ComputeResourceImageProvider(NavigateStep):
     (that depend from compute resource provider) before reaching navigation destination.
     """
 
-    PROVIDER_VIEWS = dict()
+    PROVIDER_VIEWS = {}
 
     def prerequisite(self, *args, **kwargs):
         entity_name = kwargs.get('entity_name')
@@ -293,23 +294,21 @@ def am_i_here(self, *args, **kwargs):
 
 @navigator.register(ComputeResourceEntity, 'Create Image')
 class ComputeResourceImageCreate(ComputeResourceImageProvider):
-
-    PROVIDER_VIEWS = dict(
-        RHV=ComputeResourceRHVImageCreateView,
-        VMware=ComputeResourceVMwareImageCreateView,
-    )
+    PROVIDER_VIEWS = {
+        'RHV': ComputeResourceRHVImageCreateView,
+        'VMware': ComputeResourceVMwareImageCreateView,
+    }
 
     def step(self, *args, **kwargs):
         self.parent.create_image.click()
 
 
 @navigator.register(ComputeResourceEntity, 'Edit Image')
 class ComputeResourceImageEdit(ComputeResourceImageProvider):
-
-    PROVIDER_VIEWS = dict(
-        RHV=ComputeResourceRHVImageEditView,
-        VMware=ComputeResourceVMwareImageEditView,
-    )
+    PROVIDER_VIEWS = {
+        'RHV': ComputeResourceRHVImageEditView,
+        'VMware': ComputeResourceVMwareImageEditView,
+    }
 
     def step(self, *args, **kwargs):
         image_name = kwargs.get('image_name')

airgun/entities/configgroup.py

@@ -1,12 +1,13 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.configgroup import ConfigGroupCreateView
-from airgun.views.configgroup import ConfigGroupEditView
-from airgun.views.configgroup import ConfigGroupsView
+from airgun.views.configgroup import (
+    ConfigGroupCreateView,
+    ConfigGroupEditView,
+    ConfigGroupsView,
+)
 
 
 class ConfigGroupEntity(BaseEntity):

airgun/entities/containerimagetag.py

@@ -1,9 +1,10 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.containerimagetag import ContainerImageTagDetailsView
-from airgun.views.containerimagetag import ContainerImageTagsView
+from airgun.views.containerimagetag import (
+    ContainerImageTagDetailsView,
+    ContainerImageTagsView,
+)
 
 
 class ContainerImageTagEntity(BaseEntity):

airgun/entities/contentcredential.py

@@ -1,12 +1,13 @@
 from navmazing import NavigateToSibling
 
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.contentcredential import ContentCredentialCreateView
-from airgun.views.contentcredential import ContentCredentialEditView
-from airgun.views.contentcredential import ContentCredentialsTableView
+from airgun.views.contentcredential import (
+    ContentCredentialCreateView,
+    ContentCredentialEditView,
+    ContentCredentialsTableView,
+)
 from airgun.views.product import ProductEditView
 
 

airgun/entities/contenthost.py

@@ -1,14 +1,14 @@
 from airgun.entities.base import BaseEntity
-from airgun.navigation import NavigateStep
-from airgun.navigation import navigator
+from airgun.navigation import NavigateStep, navigator
 from airgun.utils import retry_navigation
-from airgun.views.contenthost import ContentHostDetailsView
-from airgun.views.contenthost import ContentHostsView
-from airgun.views.contenthost import ContentHostTaskDetailsView
-from airgun.views.contenthost import ErrataDetailsView
-from airgun.views.contenthost import SyspurposeBulkActionView
-from airgun.views.job_invocation import JobInvocationCreateView
-from airgun.views.job_invocation import JobInvocationStatusView
+from airgun.views.contenthost import (
+    ContentHostDetailsView,
+    ContentHostsView,
+    ContentHostTaskDetailsView,
+    ErrataDetailsView,
+    SyspurposeBulkActionView,
+)
+from airgun.views.job_invocation import JobInvocationCreateView, JobInvocationStatusView
 
 
 class ContentHostEntity(BaseEntity):
@@ -108,7 +108,7 @@ def execute_module_stream_action(
             customize_values = {}
         view = self.navigate_to(self, 'Edit', entity_name=entity_name)
         view.module_streams.search(f'name = {module_name} and stream = {stream_version}')
-        action_type = dict(is_customize=customize, action=action_type)
+        action_type = {'is_customize': customize, 'action': action_type}
         view.module_streams.table.row(name=module_name, stream=stream_version)['Actions'].fill(
             action_type
         )