Do not overwrite existing yaml files by default.

SINTEF · Oct 27, 2024 · 3c5b097 · 3c5b097
1 parent d29adb8
commit 3c5b097
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/bindings/python/tests/test_storage.py b/bindings/python/tests/test_storage.py
@@ -127,9 +127,9 @@
             location: Path to YAML file.
             options: Supported options:
             - `mode`: Mode for opening.  Valid values are:
-                - `a`: Append to existing file or create new file (default).
-                - `r`: Open existing file for read-only.
-                - `w`: Truncate existing file or create new file.
+                - `a`: Open for writing, add to existing `location` (default).
+                - `r`: Open existing `location` for reading.
+                - `w`: Open for writing. If `location` exists, it is truncated.
             - `soft7`: Whether to save using SOFT7 format.
             - `single`: Whether the input is assumed to be in single-entity form.
               If "auto" (default) the form will be inferred automatically.

diff --git a/storages/python/python-storage-plugins/yaml.py b/storages/python/python-storage-plugins/yaml.py
@@ -24,9 +24,9 @@ def open(self, location: str, options=None):
             location: Path to YAML file.
             options: Supported options:
             - `mode`: Mode for opening.  Valid values are:
-                - `a`: Append to existing file or create new file (default).
-                - `r`: Open existing file for read-only.
-                - `w`: Truncate existing file or create new file.
+                - `a`: Open for writing, add to existing `location` (default).
+                - `r`: Open existing `location` for reading.
+                - `w`: Open for writing. If `location` exists, it is truncated.
             - `soft7`: Whether to save using SOFT7 format.
             - `single`: Whether the input is assumed to be in single-entity form.
               If "auto" (default) the form will be inferred automatically.
@@ -35,13 +35,13 @@ def open(self, location: str, options=None):
         self.options = Options(
             options, defaults="mode=a;soft7=true;single=auto;with_uuid=false"
         )
-        self.readable = "r" in self.options.mode
-        self.writable = "r" != self.options.mode
+        mode = self.options.mode
+        self.writable = "w" in mode or "a" in mode
         self.generic = True
         self.location = location
-        self.flushed = False  # whether buffered data has been written to file
+        self.flushed = True  # whether buffered data has been written to file
         self._data = {}  # data buffer
-        if self.options.mode in ("r", "a", "append"):
+        if "r" in mode or "a" in mode:
             with open(location, "r") as f:
                 data = pyyaml.safe_load(f)
             if data: