chore: use ruff linter and formatter (#1351)

* chore(pre-commit): switch to ruff for linting and formatting

Replace isort and black with ruff and ruff-format in pre-commit config.
Update hooks to use ruff for both linting and formatting, specifying
versions v0.9.6 and v0.11.2. Remove isort and black hooks, and keep
other hooks unchanged.

* feat(imports): add utilities for optional dependencies

Introduced a new `imports.py` module providing utilities to handle optional
dependencies. This includes functions for importing optional modules with
customizable error handling, checking for their presence, and version
validation. Also added a mapping for commonly used optional dependencies
and a helper to retrieve them with predefined settings.

Author: Pouyanpi

.pre-commit-config.yaml

@@ -5,16 +5,17 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.14.6
     hooks:
-      - id: isort
-        args: [ "--profile", "black" ]
-        name: isort (python)
-  - repo: https://github.com/psf/black
-    rev: 23.3.0
-    hooks:
-      - id: black
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.4.2
     hooks:
@@ -32,9 +33,3 @@ repos:
         language: system
         types: [python]
         pass_filenames: false
-# Deactivating this for now.
-#  - repo: https://github.com/pycqa/pylint
-#    rev: v2.17.0
-#    hooks:
-#      - id: pylint
-#        language_version: python3.10

build_notebook_docs.py

@@ -87,7 +87,7 @@ def _fix_prefix_and_type_in_code_blocks(md_file_path):
                     updated_block = "\n".join(lines)
                     content = content.replace(block, updated_block)
                     block = updated_block
-            except:
+            except Exception:
                 pass
 
         if lines[0] == "```" and "from nemoguardrails" in block:
@@ -194,9 +194,7 @@ def rename_md_to_readme(start_dir):
 
         # We do some additional post-processing
         _remove_code_blocks_with_text(readme_path.absolute(), "# Init:")
-        _remove_code_blocks_with_text(
-            readme_path.absolute(), "# Hide from documentation page."
-        )
+        _remove_code_blocks_with_text(readme_path.absolute(), "# Hide from documentation page.")
 
         _remove_code_blocks_with_text(
             readme_path.absolute(),

docs/colang-2/examples/csl.py

@@ -22,7 +22,7 @@
 sys.path.append(str(pathlib.Path(__file__).parent.parent.parent.parent.resolve()))
 print(sys.path)
 
-from utils import compare_interaction_with_test_script
+from utils import compare_interaction_with_test_script  # noqa: E402
 
 ########################################################################################################################
 # CORE
@@ -637,9 +637,7 @@ async def test_repeating_timer():
 # USAGE_END: test_repeating_timer
         """
 
-    await compare_interaction_with_test_script(
-        test_script, colang_code, wait_time_s=2.0
-    )
+    await compare_interaction_with_test_script(test_script, colang_code, wait_time_s=2.0)
 
 
 @pytest.mark.asyncio
@@ -809,9 +807,7 @@ async def test_polling_llm_request_response():
 # USAGE_END: test_polling_llm_request_response
         """
 
-    await compare_interaction_with_test_script(
-        test_script, colang_code, llm_responses=['"nine"']
-    )
+    await compare_interaction_with_test_script(test_script, colang_code, llm_responses=['"nine"'])
 
 
 @pytest.mark.asyncio

docs/colang-2/examples/utils.py

@@ -92,6 +92,6 @@ async def compare_interaction_with_test_script(
     )
     clean_test_script = cleanup(test_script)
     clean_result = cleanup(result)
-    assert (
-        clean_test_script == clean_result
-    ), f"\n----\n{clean_result}\n----\n\ndoes not match test script\n\n----\n{clean_test_script}\n----"
+    assert clean_test_script == clean_result, (
+        f"\n----\n{clean_result}\n----\n\ndoes not match test script\n\n----\n{clean_test_script}\n----"
+    )