updating unit tests and implementing a bunch of things

Author: MattReimer

.vscode/launch.json

@@ -10,20 +10,11 @@
       "request": "launch",
       "program": "${file}",
       "env": {
-        "PYTHONPATH": "${workspaceFolder}/../../lib/commons"
+        "PYTHONPATH": "${workspaceFolder}/src"
       },
       "console": "integratedTerminal",
       "envFile": "${workspaceFolder}/.env",
       "justMyCode": true
-    },
-    {
-      // You need to enable QGIS VSCode debugger plugin 
-      // Before this will work
-      "name": "QGIS Debug",
-      "type": "debugpy",
-      "request": "attach",
-      "port": 5678,
-      "host": "localhost",
-    },
+    }
   ]
 }

RSXML-RiverscapesXML.code-workspace

@@ -10,14 +10,13 @@
     "[python]": {
       "editor.tabSize": 4,
       "editor.formatOnSave": true,
+      "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit",
+        "source.organizeImports": "explicit"
+      }
     },
-    "autopep8.args": [
-      "--max-line-length=240",
-    ],
-    "pylint.args": [
-      "--extension-pkg-whitelist=pygeoprocessing",
-      "--disable=C0301,C0114,C0103,W0719,W0718",
-      "--max-line-length=240"
+    "python.analysis.extraPaths": [
+      "./src"
     ],
     "python.terminal.activateEnvironment": true,
     "python.testing.pytestEnabled": true,

examples/project_01_basic.py

@@ -45,7 +45,7 @@ def main(filepath: str):
             bounding_box=BoundingBox(-22, -21, 114, 116),
             filepath="project_bounds.json",
         ),
-        meta_data=MetaData(values=[Meta("Test", "Test Value")]),
+        meta_data=MetaData(values=[Meta("Test", "Test Value"), Meta("LockedMeta", "Locked Value", locked=True)]),
         realizations=[
             Realization(
                 xml_id="test",
@@ -63,6 +63,7 @@ def main(filepath: str):
                         ds_type=GeoPackageDatasetTypes.RASTER,
                         summary="This is a input dataset",
                         description="This is a input dataset",
+                        url="https://example.com/dataset",
                     )
                 ],
                 intermediates=[

noxfile.py

@@ -1,13 +1,27 @@
 import nox
 
+# This file defines the automation tasks for the project using Nox.
+# Nox is a command-line tool that automates testing in multiple Python environments.
+# To run all sessions: uv run nox
+# To run a specific session: uv run nox -s lint
+
 
 @nox.session(python=["3.10", "3.11", "3.12"])
 def tests(session):
+    """
+    Run the test suite using pytest.
+    This session installs the package in editable mode with dev dependencies
+    and runs the tests across the specified Python versions.
+    """
     session.install(".[dev]")
     session.run("pytest")
 
 
 @nox.session
 def lint(session):
+    """
+    Run linting checks using ruff.
+    Ruff is a fast Python linter and code formatter.
+    """
     session.install("ruff")
     session.run("ruff", "check", ".")

src/rsxml/project_xml/Dataset.py

@@ -62,6 +62,7 @@ class Dataset(RSObj):
     path: str
     ds_type: str
     ext_ref: str
+    url: str
 
     def __init__(
         self,
@@ -75,6 +76,7 @@ def __init__(
         description: str = None,
         citation: str = None,
         meta_data: MetaData = None,
+        url: str = None,
     ) -> None:
         """
         Initializes a Dataset instance.
@@ -89,6 +91,7 @@ def __init__(
             description (str, optional): A detailed description of the dataset. Defaults to None.
             citation (str, optional): The citation information for the dataset. Defaults to None.
             meta_data (MetaData, optional): The metadata associated with the dataset. Defaults to None.
+            url (str, optional): The URL for the dataset. Defaults to None.
 
         Returns:
             None
@@ -109,7 +112,8 @@ def __init__(
                             summary="A summary of the dataset",
                             description="A detailed description of the dataset",
                             citation="Citation information",
-                            meta_data=MetaData(...))
+                            meta_data=MetaData(...),
+                            url="https://example.com/dataset")
         """
 
         super().__init__(
@@ -135,6 +139,7 @@ def __init__(
         self.ds_type = ds_type.strip() if ds_type else None
         self.ds_type_attr = ds_type_attr.strip() if ds_type_attr else None
         self.ext_ref = ext_ref.strip() if ext_ref else None
+        self.url = url.strip() if url else None
 
     def __eq__(self, other: RSObj) -> bool:
         if not isinstance(other, Dataset):
@@ -143,7 +148,12 @@ def __eq__(self, other: RSObj) -> bool:
         if not super(Dataset, self).__eq__(other):
             return False
 
-        return self.path == other.path and self.ds_type == other.ds_type and self.ext_ref == other.ext_ref
+        return (
+            self.path == other.path
+            and self.ds_type == other.ds_type
+            and self.ext_ref == other.ext_ref
+            and self.url == other.url
+        )
 
     @staticmethod
     def from_xml(xml_node: ET.Element) -> Dataset:
@@ -169,6 +179,7 @@ def from_xml(xml_node: ET.Element) -> Dataset:
             description=rsobj.description,
             citation=rsobj.citation,
             meta_data=rsobj.meta_data,
+            url=xml_node.find("URL").text if xml_node.find("URL") is not None else None,
         )
         return dataset
 
@@ -188,6 +199,8 @@ def to_xml(self) -> ET.Element:
             xml_node.set("type", self.ds_type_attr)
 
         ET.SubElement(xml_node, "Path").text = self.path
+        if self.url:
+            ET.SubElement(xml_node, "URL").text = self.url
         return xml_node
 
 

src/rsxml/project_xml/MetaData.py

@@ -44,6 +44,7 @@ class Meta(NamedTuple):
     value: MetaValue
     type: str = None  # optional
     ext: str = None  # optional
+    locked: bool = False  # optional
 
 
 class MetaData:
@@ -113,7 +114,7 @@ def _validate_ext_type(self, ext: str) -> None:
         if ext not in EXT_TYPES:
             raise ValueError(f"Invalid ext type {ext}. Valid types are {EXT_TYPES}")
 
-    def add_meta(self, name: str, value, meta_type: str = None, ext: str = None) -> None:
+    def add_meta(self, name: str, value, meta_type: str = None, ext: str = None, locked: bool = False) -> None:
         """
         Add a metadata item to the collection.
         The name must be unique and cannot be empty.
@@ -131,7 +132,7 @@ def add_meta(self, name: str, value, meta_type: str = None, ext: str = None) ->
         if ext is not None:
             self._validate_ext_type(ext)
 
-        self._values.append(Meta(name, value, meta_type, ext))
+        self._values.append(Meta(name, value, meta_type, ext, locked))
 
     def find_meta(self, name: str) -> Meta:
         """
@@ -181,6 +182,7 @@ def from_xml(xml_node: ET.Element) -> MetaData:
                 meta.text.strip() if meta.text else "",
                 meta.get("type"),
                 meta.get("ext"),
+                meta.get("locked") == "true",
             )
         return meta_data
 
@@ -201,10 +203,15 @@ def to_xml(self) -> ET.Element:
                     "name": meta.name,
                 },
             )
-            if meta.type is not None:
-                meta_node.set("type", meta.type)
-            if meta.ext is not None:
-                meta_node.set("ext", meta.ext)
+            # Metric tags do not support type or ext attributes
+            if self.inner_tag != "Metric":
+                if meta.type is not None:
+                    meta_node.set("type", meta.type)
+                if meta.ext is not None:
+                    meta_node.set("ext", meta.ext)
+
+            if meta.locked:
+                meta_node.set("locked", "true")
 
             meta_node.text = str(meta.value)
             meta_data.append(meta_node)