Merge pull request #1822 from dandi/enh-validators

ENH: Machine-readable validate output with store/reload

Author: yarikoptic

.specify/specs/validate-machine-readable-output.md

@@ -92,6 +92,31 @@ instance as `dandi-api-local-docker-tests`.  See the note below on the
 `DANDI_DEVEL` environment variable, which is needed in order to expose the
 development command line options.
 
+## Code style conventions
+
+### Dataclass and attrs field documentation
+
+Document dataclass/attrs fields using `#:` comments above the field, not
+docstrings below.  This is the format Sphinx autodoc recognizes for attribute
+documentation:
+
+```python
+@dataclass
+class Movement:
+    """A movement/renaming of an asset"""
+
+    #: The asset's original path
+    src: AssetPath
+    #: The asset's destination path
+    dest: AssetPath
+    #: Whether to skip this operation because an asset already exists at the
+    #: destination
+    skip: bool = False
+```
+
+See [dandi.move.Movement on RTD](https://dandi.readthedocs.io/en/latest/modref/generated/dandi.move.html#dandi.move.Movement)
+for a rendered example.
+
 ## Environment variables
 
 - `DANDI_DEVEL` -- enables otherwise hidden command line options, such as

DEVELOPMENT.md

@@ -13,7 +13,7 @@
 from pydantic import DirectoryPath, validate_call
 
 from dandi.utils import find_parent_directory_containing
-from dandi.validate.types import (
+from dandi.validate._types import (
     Origin,
     OriginType,
     Scope,

dandi/bids_validator_deno/_validator.py

@@ -96,15 +96,21 @@ def upload(
     can point to specific files you would like to validate and have uploaded.
     """
     # Avoid heavy imports by importing with function:
-    from ..upload import upload
+    from ..upload import upload as upload_
+    from ..validate._io import validation_companion_path
 
     if jobs_pair is None:
         jobs = None
         jobs_per_file = None
     else:
         jobs, jobs_per_file = jobs_pair
 
-    upload(
+    ctx = click.get_current_context()
+    companion = (
+        validation_companion_path(ctx.obj.logfile) if ctx.obj is not None else None
+    )
+
+    upload_(
         paths,
         existing=existing,
         validation=validation,
@@ -115,4 +121,5 @@ def upload(
         jobs=jobs,
         jobs_per_file=jobs_per_file,
         sync=sync,
+        validation_log_path=companion,
     )