chore: minor updates

Author: kpiwko

.github/workflows/python_lint_and_test.yaml

@@ -32,9 +32,8 @@ jobs:
       - name: Run python style and linting tools
         run: |
           err=0
-          echo pre-commit:
           pre-commit install
-          pre-commit run --all-files --hook-stage pre-commit|| err=$?
+          pre-commit run --all-files --hook-stage pre-commit || err=$?
           exit $err
       - name: Run tests with coverage
         run: |

.pre-commit-config.yaml

@@ -3,6 +3,8 @@
 # manual stage - runs the same tools but modifies files
 # run as: pre-commit run --all-files --hook-stage manual
 repos:
+  #  See README.md for more information on this pre-commit hook
+  #  Please uncomment this hook if you are a Red Hat employee, and make sure you don't commit it back upstream
   # - repo: https://gitlab.cee.redhat.com/infosec-public/developer-workbench/tools.git
   #   rev: rh-pre-commit-2.3.0
   #   hooks:

README.md

@@ -178,7 +178,7 @@ For details on debugging the web interactions, see the `--pwdebug` option in the
 
 ### Linting and formatting rules
 
-This project uses `pre-commit` to handle linting and formatting. The `pre-commit` tool reads its configuration from [`.pre-commit-config.yaml`](./.pre-commit-config.yaml)` and the configuration options for the individual linters and formatters can be found in the [`pyproject.toml`](./pyproject.toml) file.
+This project uses `pre-commit` to handle linting and formatting. The `pre-commit` tool reads its configuration from [`.pre-commit-config.yaml`](./.pre-commit-config.yaml) and the configuration options for the individual linters and formatters can be found in the [`pyproject.toml`](./pyproject.toml) file.
 The same configuration is used in CI.
 
 To install and execute it locally, follow these steps:

logilica_cli/__main__.py

@@ -42,10 +42,7 @@
     "-o",
     "output_dir_path",
     type=click.Path(
-        writable=True,
-        file_okay=False,
-        path_type=pathlib.Path,
-        resolve_path=True,
+        writable=True, file_okay=False, path_type=pathlib.Path, resolve_path=True
     ),
     default=DEFAULT_OUTPUT_DIR,
     show_default=True,

logilica_cli/data_sources.py

@@ -10,11 +10,7 @@
 @common_options
 @click.pass_context
 def data_sources(
-    context: click.Context,
-    username: str,
-    password: str,
-    domain: str,
-    oauth: bool,
+    context: click.Context, username: str, password: str, domain: str, oauth: bool
 ) -> None:
     """Synchronizes configuration of integrations with the configuration file.
 

logilica_cli/page_dashboard.py

@@ -9,8 +9,9 @@ class DashboardPage:
     PDF_EXPORT_TIMEOUT = 120000
 
     def __init__(self, page: Page):
-        # PDF generation might take longer than default 30000 ms timeout, so modify for this page in global
-        # It can be export or download button that takes time to become visible
+        # PDF generation might take longer than default 30000 ms timeout,
+        # so modify for this page in global.
+        # It can be export or download button that takes time to become visible.
         page.set_default_timeout(self.PDF_EXPORT_TIMEOUT)
         self.page = page
         self.export_pdf_button = page.get_by_role("button", name="Export PDF")

logilica_cli/page_navigation.py

@@ -26,7 +26,8 @@ def navigate(self, *, menu_dropdown: Optional[str], link_name: str) -> None:
 
         link_locator = self.page.get_by_role("link", name=link_name)
 
-        # if dropdown argument was provided, check if dropdown is open as it hides the link
+        # If dropdown argument was provided, check if dropdown is open as
+        # it hides the link
         if menu_dropdown:
             for first_try in (True, False):
                 try:

logilica_cli/page_settings.py

@@ -79,7 +79,8 @@ def sync_integrations(self, integrations: dict[str, Any]) -> None:
         in integrations sections of the local configuration file.
 
         Raises:
-          RuntimeError: If any repositories could not have been added to the configuration.
+          RuntimeError:
+            If any repositories could not have been added to the configuration.
         """
 
         sync_failures: IntegrationSyncFailures = defaultdict(list)
@@ -279,7 +280,8 @@ def has_entity_imported(
     ) -> bool:
         search_field.fill(entity_id)
 
-        # here we need to find the innermost div element that exactly matches repository slug
+        # Here we need to find the innermost div element
+        # that exactly matches repository slug.
         found = self.page.get_by_text(text=entity_id, exact=True).nth(0).is_visible()
         if found:
             logging.debug("✅%s '%s' is imported", entity_type, entity_id)
@@ -323,8 +325,8 @@ def add_public_repository(
         self.add_public_repository_dialog_button.click()
         self.add_public_repository_input.fill(f"{host}/{entity_id}.git")
         self.add_public_repository_confirm_button.click()
-        # as UI refresh is triggered independently of the click and there is no guarantee the repository will be added
-        # at the top of the page, we don't validate the action success here but later
+        # UI refresh is triggered independently of the click and there is no guarantee
+        # the repository will be added at the top of the page, we'll validate it later
         return True
 
     def add_membership_entity(
@@ -374,8 +376,8 @@ def control_button(self, entity_id: str, *, order=0) -> Optional[Locator]:
             .get_by_role("button")
         )
 
-        # there might be the same slug in both imported repositories and available repositories
-        # in that case, we want to be able to select one specifically
+        # There might be the same slug in both imported repositories and available
+        # repositories, in that case, we want to be able to select one specifically.
         count = locator.count()
         if count == 1:
             return locator

logilica_cli/update_gdoc.py

@@ -182,13 +182,7 @@ def get_app_credentials_file(config: dict[str, any]) -> Path:
 
 
 GPP_SIGNATURE = Callable[
-    [
-        Optional[str],
-        Optional[Union[str, Literal[False]]],
-        Optional[str],
-        bool,
-        bool,
-    ],
+    [Optional[str], Optional[Union[str, Literal[False]]], Optional[str], bool, bool],
     Path,
 ]
 

pyproject.toml

@@ -21,6 +21,7 @@ select = [
   "E",  # pycodestyle (flake8)
   "F",  # pyflakes (flake8)
   "I",  # isort
+  "W505", # docstring line too long
 ]
 ignore = ["E501"]  # line length is covered by black
 
@@ -30,9 +31,13 @@ known-first-party = ["logilica_cli"]  # use separate section for project sources
 force-sort-within-sections = true     # don't separate import vs from
 order-by-type = false                 # sort alphabetic regardless of case
 
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 88
+
 
 [tool.black]
 line-length = 88
+skip-string-normalization = false
 skip-magic-trailing-comma = false
 include = '\.pyi?$'