specitems 1.7.4__tar.gz → 1.7.6__tar.gz

{specitems-1.7.4 → specitems-1.7.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: specitems
-Version: 1.7.4
+Version: 1.7.6
 Summary: Provides interfaces to work with specification items.
 Keywords: certification,documentation,markdown,qualification,requirements-management,traceability
 Author: The specitems Authors

{specitems-1.7.4 → specitems-1.7.6}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "specitems"
-version = "1.7.4"
+version = "1.7.6"
 description = "Provides interfaces to work with specification items."
 authors = [
     {name = "The specitems Authors", email = "specthings@embedded-brains.de"}

{specitems-1.7.4 → specitems-1.7.6}/src/specitems/__init__.py

@@ -135,6 +135,7 @@ from .itemmapper import (
     ItemValueProvider,
     SubstitutionError,
     from_clang_variables,
+    get_bool_arg,
     get_value_default,
     to_at_variables,
     to_clang_variables,
@@ -239,6 +240,7 @@ __all__ = [
     "generate_glossary",
     "generate_specification_documentation",
     "get_arguments",
+    "get_bool_arg",
     "get_item_cache_arguments",
     "get_license_list_version",
     "get_reference",

{specitems-1.7.4 → specitems-1.7.6}/src/specitems/itemmapper.py

@@ -344,6 +344,24 @@ def unpack_args(
     return args, kwargs
 
 
+def get_bool_arg(kwargs: dict[str, str],
+                 name: str,
+                 default: bool = False) -> bool:
+    """
+    Get the boolean value of the keyword argument by name.
+
+    The value of the argument shall be "0" or "1".  If the argument is not
+    present, then return the default value.
+    """
+    value = kwargs.get(name)
+    if value is None:
+        return default
+    if value not in ("0", "1"):
+        raise ValueError(f"argument '{name}' has the value '{value}', "
+                         "expected '0' or '1'")
+    return value == "1"
+
+
 def _identity(value: str) -> str:
     return value
 
@@ -372,6 +390,11 @@ class ItemGetValueContext:
             return kwargs[name]
         return kwargs.get(name, value)
 
+    def arg_bool(self, name: str, default: bool = False) -> bool:
+        """ Get the boolean argument value by name. """
+        _, kwargs = self.unpack_args_dict()
+        return get_bool_arg(kwargs, name, default)
+
     def unpack_args_list(self) -> list[str]:
         """ Unpack the context arguments to a list. """
         if self.args is None:

{specitems-1.7.4 → specitems-1.7.6}/src/specitems/items.py

@@ -37,8 +37,8 @@ import logging
 import os
 import pickle
 import re
+import secrets
 import stat
-import tempfile
 from typing import (Any, Callable, Collection, Iterable, Iterator, Match,
                     Optional, Union)
 import json
@@ -753,6 +753,18 @@ def _json_load_data_by_uid(data_by_uid: ItemDataByUID, _cache_dir: str,
                                    path_2)
 
 
+def _create_temporary_file(directory: str, suffix: str) -> tuple[int, str]:
+    while True:
+        path = os.path.join(directory, f".tmp-{secrets.token_hex(8)}{suffix}")
+        try:
+            # The umask applies to this mode, as for a file which open()
+            # creates.
+            return os.open(path, os.O_WRONLY | os.O_CREAT | os.O_EXCL,
+                           0o666), path
+        except FileExistsError:
+            continue
+
+
 def atomic_dump_to_file(path: str, data: Any,
                         dumper: Callable[[Any], str | bytes]) -> None:
     """
@@ -765,6 +777,9 @@ def atomic_dump_to_file(path: str, data: Any,
     as the path.  The temporary file is then renamed to the path.  This way, a
     failure while producing the content cannot truncate or corrupt an already
     existing file at the path.
+
+    A file which exists keeps its permissions.  A new file gets the
+    permissions which the umask leaves of 0o666.
     """
     dumped = dumper(data)
     encoding: Optional[str] = None
@@ -776,13 +791,9 @@ def atomic_dump_to_file(path: str, data: Any,
     directory = os.path.dirname(os.path.abspath(path))
     tmp_path: Optional[str] = None
     try:
-        with tempfile.NamedTemporaryFile(mode=mode,
-                                         encoding=encoding,
-                                         dir=directory,
-                                         prefix=".tmp-",
-                                         suffix=os.path.basename(path),
-                                         delete=False) as out:
-            tmp_path = out.name
+        fd, tmp_path = _create_temporary_file(directory,
+                                              os.path.basename(path))
+        with os.fdopen(fd, mode, encoding=encoding) as out:
             with suppress(OSError):
                 os.chmod(tmp_path, stat.S_IMODE(os.stat(path).st_mode))
             out.write(dumped)