Merge pull request #40 from rayosborn:refine-output

Refine-output

Author: rayosborn

src/nxvalidate/definitions/base_classes/NXroot.nxdl.xml

@@ -45,13 +45,35 @@
     <attribute name="file_update_time" type="NX_DATE_TIME">
         <doc>Date and time of last file change at close</doc>
     </attribute>
-    <attribute name="NeXus_version">
+    <attribute name="NeXus_version" deprecated="NAPI is frozen.">
         <doc>
             Version of NeXus API used in writing the file.
 
-            Only used when the NAPI has written the file.
             Note that this is different from the version of the
-            base class or application definition version number.
+            base class or application definition version number.            
+        </doc>
+    </attribute>
+    <attribute name="NeXus_repository">
+        <doc>
+            A repository containing the application definitions
+            used for creating this file.
+            If the ``NeXus_release`` attribute contains a commit distance and hash,
+            this should refer to this repository.
+        </doc>
+    </attribute>
+    <attribute name="NeXus_release">
+        <doc>
+            The version of NeXus definitions used in writing the file. This can either be a date-based
+            NeXus release (e.g., YYYY.MM), see https://github.com/nexusformat/definitions/releases or
+            a version tag that includes additional development information, such as a commit distance and
+            a Git hash. This is typically formatted as  `vYYYY.MM.post1.dev&lt;commit-distance&gt;-g&lt;git-hash&gt;`,
+            where `YYYY.MM` refers to the base version of the NeXus definitions. `post1.dev&lt;commit-distance&gt;` 
+            indicates that the definitions are based on a commit after the base version (post1), with
+            `&lt;commit-distance&gt;` being the number of commits since that version. `g&lt;git-hash&gt;` is the 
+            abbreviated Git hash that identifies the specific commit of the definitions being used.
+
+            If the version includes both a commit distance and a Git hash, the ``NeXus_repository`` 
+            attribute must be included, specifying the URL of the repository containing that version.
         </doc>
     </attribute>
     <attribute name="HDF_version">
@@ -101,4 +123,3 @@
         </doc>
     </attribute>
 </definition>
-

src/nxvalidate/scripts/nxinspect.py

@@ -10,8 +10,6 @@
 import argparse
 import logging
 
-from nexusformat.nexus import NeXusError
-
 import nxvalidate
 from nxvalidate.validate import (logger, inspect_base_class,
                                  validate_application, validate_file)
@@ -74,7 +72,7 @@ def main():
         else:
             validate_file(filename, path=path, definitions=definitions)
     else:
-        raise NeXusError('A file or base class must be specified')
+        logger.error('A file or base class must be specified')
 
 
 if __name__ == "__main__":

src/nxvalidate/utils.py

@@ -9,6 +9,7 @@
 import os
 import re
 import sys
+from pathlib import Path
 
 if sys.version_info < (3, 10):
     from importlib_resources import files as package_files
@@ -19,7 +20,6 @@
 from dateutil.parser import parse
 from nexusformat.nexus.tree import string_dtype
 
-
 name_pattern = re.compile('^[a-zA-Z0-9_]([a-zA-Z0-9_.]*[a-zA-Z0-9_])?$')
 
 
@@ -405,6 +405,27 @@ def match_strings(pattern_string, target_string):
     return False
 
 
+def definitions_path(path):
+    """
+    Return the path to the NeXus definitions directory.
+
+    The path is derived from a given path, which may be a string or a
+    MultiplexedPath object. If the given path is a MultiplexedPath
+    object, extract the path from it and return it as a string.
+
+    Parameters
+    ----------
+    path : str or MultiplexedPath
+        The path to the NeXus definitions directory.
+
+    Returns
+    -------
+    Path
+        The path to the NeXus definitions directory.
+    """
+    return Path(re.sub(r"MultiplexedPath\('(.*)'\)", r"\1", str(path)))
+
+
 def check_nametype(item_value):
     """
     Return the value of the 'nameType' attribute for a given item.