Respond to review

Author: oerc0122

data_collections_api/dumpers.py

@@ -314,15 +314,19 @@ def get_str_loader(fmt: Formats):
 
 
 @overload
-def guess_format(path: Path) -> Formats: ...
+def guess_format(path: Path) -> Formats: ...  # numpydoc ignore=GL08
 
 
 @overload
-def guess_format(path: Path, *, raise_on_invalid: Literal[True]) -> Formats: ...
+def guess_format(
+    path: Path, *, raise_on_invalid: Literal[True]
+) -> Formats: ...  # numpydoc ignore=GL08
 
 
 @overload
-def guess_format(path: Path, *, raise_on_invalid: Literal[False]) -> Formats | None: ...
+def guess_format(
+    path: Path, *, raise_on_invalid: Literal[False]
+) -> Formats | None: ...  # numpydoc ignore=GL08
 
 
 def guess_format(path: Path, *, raise_on_invalid: bool = True) -> Formats | None:

data_collections_api/schemas/__init__.py

@@ -16,7 +16,8 @@
 
 @singledispatch
 def get_schema(schema) -> Schema:
-    """Get schema.
+    """
+    Get schema.
 
     Parameters
     ----------

docs/source/cli.rst

@@ -125,6 +125,10 @@ validate
 
       Parse :option:`FILE` as this type (default: determine from suffix).
 
+   .. option:: -S SCHEMA, --schema SCHEMA
+
+      Validate against the given schema (default: :doc:`base`)
+
 Validate the metadata file for a dataset before uploading.
 
 ``data_collections_api`` can validate your metadata file against the schema to verify the contents

docs/source/conf.py

@@ -32,7 +32,7 @@
 extensions = [
     "numpydoc",
     "sphinx.ext.autodoc",
-    "sphinx.ext.apidoc",
+    # "sphinx.ext.apidoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",

docs/source/schemas/index.rst

@@ -8,4 +8,3 @@ This page documents the available schemas.
    :caption: Schemas:
 
    base
-

docs/source/scripts/schema_gen.py

@@ -5,6 +5,7 @@
 import argparse
 from pathlib import Path
 from shutil import rmtree
+import sys
 from textwrap import indent
 from typing import TYPE_CHECKING
 
@@ -171,6 +172,42 @@ def get_filename(fmt: str, key: str) -> str:
     return fmt % key
 
 
+def clear_folder(folder: Path, *, force: bool = False, verbose: bool = False) -> None:
+    """Delete folder and create new (empty) one.
+
+    Parameters
+    ----------
+    folder : Path
+        Folder to clear.
+    force : bool
+        Do not ask whether to remove folder.
+    verbose : bool
+        Print status.
+    """
+    if not folder.exists():
+        return
+
+    if folder.samefile(Path.cwd()):
+        print("Cannot clear folder as this is current working directory.")
+        return
+
+    if (
+        not force
+        and input(f"Running this will clear {folder}, are you sure you want to continue? [y/N] ")
+        .strip()
+        .lower()
+        != "y"
+    ):
+        print("Cancelling.")
+        sys.exit()
+
+    if verbose:
+        print(f"Deleting {folder}...")
+
+    rmtree(folder, ignore_errors=True)
+    folder.mkdir()
+
+
 def main(args_in: Sequence[str] | None = None, /) -> None:
     """Parse schemas and dump to file.
 
@@ -193,25 +230,8 @@ def main(args_in: Sequence[str] | None = None, /) -> None:
     if args.verbose:
         print(f"Generating schemas for keys {', '.join(map(repr, schemas.values()))}...")
 
-    if args.clear and args.out_folder.exists() and not args.out_folder.samefile(Path.cwd()):
-        if (
-            not args.force
-            and input(
-                f"Running this will clear {args.out_folder},"
-                " are you sure you want to continue? [y/N] "
-            )
-            .strip()
-            .lower()
-            != "y"
-        ):
-            print("Cancelling.")
-            return
-
-        if args.verbose:
-            print(f"Deleting {args.out_folder}...")
-
-        rmtree(args.out_folder, ignore_errors=True)
-        args.out_folder.mkdir()
+    if args.clear:
+        clear_folder(args.out_folder, force=args.force, verbose=args.verbose)
 
     for key, out_name in zip(schemas.values(), out_names, strict=True):
         out_path = args.out_folder / out_name

pyproject.toml

@@ -11,7 +11,7 @@ authors = [
     { name = "Jas Kalayan" },
     { name = "Alin M. Elena" },
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.10",
@@ -37,7 +37,7 @@ dependencies = [
 ruamel = ["ruamel.yaml>=0.17.22"]
 yaml = ["pyYAML>=3.13"]
 docs = [
-   "sphinx>=8.2",
+   "sphinx>=0.13.1",
    "sphinxcontrib-contentui<1.0.0,>=0.2.5",
    "furo==2025.9.25",
    "numpydoc>=1.9.0",