fix linting

Author: petercrocker

tasks/__init__.py

@@ -1,4 +1,4 @@
-from invoke import Collection, Context, task # type: ignore
+from invoke import Collection, Context, task  # type: ignore
 
 from . import docusaurus, linter, schemas
 
@@ -18,6 +18,7 @@ def lint_all(context: Context) -> None:
 def format(context: Context) -> None:
     linter.format(context)
 
+
 # @task(name="docusaurus")
 # def docusaurus(context: Context) -> None:
 #     docusaurus.docusaurus(context)

tasks/docusaurus.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from invoke import Context, task # type: ignore
+from invoke import Context, task  # type: ignore
 
 CURRENT_DIRECTORY = Path(__file__).parent.resolve()
 DOCUMENTATION_DIRECTORY = CURRENT_DIRECTORY.parent / "docs"

tasks/linter.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-import yaml # type: ignore
+import yaml  # type: ignore
 from collections import OrderedDict
-from invoke import Context, task # type: ignore
+from invoke import Context, task  # type: ignore
 
 CURRENT_DIRECTORY = Path(__file__).resolve()
 DOCUMENTATION_DIRECTORY = CURRENT_DIRECTORY.parent / "docs"
@@ -27,6 +27,7 @@ def lint_yaml(context: Context) -> None:
     with context.cd(MAIN_DIRECTORY_PATH):
         context.run(exec_cmd)
 
+
 @task
 def lint_mypy(context: Context) -> None:
     """Run Linter to check all Python files."""
@@ -53,6 +54,7 @@ def lint_all(context: Context) -> None:
     lint_ruff(context)
     # lint_mypy(context)
 
+
 def sort_dict(d):
     """
     Recursively sort a dictionary by keys.
@@ -63,6 +65,7 @@ def sort_dict(d):
         return [sort_dict(item) for item in d]
     return d
 
+
 class PreserveLiteralStyleDumper(yaml.SafeDumper):
     """
     Custom Dumper to preserve the literal style for multiline strings.
@@ -76,6 +79,7 @@ def represent_scalar(self, tag, value, style=None):
             style = "|"
         return super().represent_scalar(tag, value, style=style)
 
+
 @task(name="sort-metadata")
 def sort_metadata(context: Context) -> None:
     print(f" - Sort {METADATA_FILE}")
@@ -84,4 +88,11 @@ def sort_metadata(context: Context) -> None:
 
     with open(METADATA_FILE, "w", encoding="utf-8") as f:
         f.write("---\n")
-        yaml.dump(metadata, f, Dumper=PreserveLiteralStyleDumper, default_flow_style=False, sort_keys=True, allow_unicode=True)
+        yaml.dump(
+            metadata,
+            f,
+            Dumper=PreserveLiteralStyleDumper,
+            default_flow_style=False,
+            sort_keys=True,
+            allow_unicode=True,
+        )

tasks/schemas.py

@@ -1,6 +1,6 @@
 import os
 from pathlib import Path
-import yaml # type: ignore
+import yaml  # type: ignore
 from invoke import Context, task  # type: ignore
 
 # If no version is indicated, we will take the latest
@@ -13,6 +13,7 @@
 
 METADATA_FILE = CURRENT_DIRECTORY.parent / ".metadata.yml"
 
+
 def _parse_and_load_extensions(
     context: Context, extensions_path: Path, allowed_to_fail: bool
 ) -> None:
@@ -85,10 +86,10 @@ def generate_readme(schema, extension_dir: Path) -> list:
     #     f"{schema.get('description', '')}\n",
     # ]
 
-    description = schema.get('description', '')
+    description = schema.get("description", "")
     content = [
         f"# {schema.get('name', '')}\n",
-        f"{description}\n" if not description.endswith('\n') else description
+        f"{description}\n" if not description.endswith("\n") else description,
     ]
 
     if dependencies := schema.get("dependencies", []):
@@ -99,12 +100,28 @@ def generate_readme(schema, extension_dir: Path) -> list:
 
     def format_table(headers: list, rows: list):
         """Generate a Markdown table."""
+
         def escape_markdown(text: str) -> str:
             # Escape special markdown characters
-            special_chars = ['|', '_', '*', '`', '[', ']', '(', ')', '#', '+', '-', '.', '!', '$']
+            special_chars = [
+                "|",
+                "_",
+                "*",
+                "`",
+                "[",
+                "]",
+                "(",
+                ")",
+                "#",
+                "+",
+                "-",
+                ".",
+                "!",
+                "$",
+            ]
 
             for char in special_chars:
-                text = text.replace(char, f'\\{char}')
+                text = text.replace(char, f"\\{char}")
             return text
 
         table = f"\n| {' | '.join(headers)} |\n"
@@ -155,10 +172,10 @@ def generate_node_data(node: dict):
         if node.get("order_by") or node.get("uniqueness_constraints"):
             node_markdown.append("#### Ordering and Constraints\n")
             node_markdown.append(
-                f"- **Order By:**{', ' .join(node.get('order_by', []))}"
+                f"- **Order By:**{', '.join(node.get('order_by', []))}"
             )
             node_markdown.append(
-                f"- **Uniqueness Constraints:**{', ' .join([' + '.join(c) for c in node.get('uniqueness_constraints', [])])}\n"
+                f"- **Uniqueness Constraints:**{', '.join([' + '.join(c) for c in node.get('uniqueness_constraints', [])])}\n"
             )
             # node_markdown.append("\n")
 
@@ -224,7 +241,9 @@ def build(context: Context) -> None:
     consolidated_doc = schema_docs_dir / "schema-library.mdx"
 
     all_content = []
-    all_content.append("---\ntitle: Schema Library Documentation\n---\n<!-- markdownlint-disable-file MD025 -->\n")
+    all_content.append(
+        "---\ntitle: Schema Library Documentation\n---\n<!-- markdownlint-disable-file MD025 -->\n"
+    )
 
     with open(METADATA_FILE, "r", encoding="utf-8") as f:
         schema = yaml.safe_load(f)
@@ -261,4 +280,3 @@ def build(context: Context) -> None:
     #                 generate_readme(schema[str(path)], path)
     #             except KeyError:
     #                 print(f"Schema `{path}` is not added to the {METADATA_FILE} file")
-