python3-cyberfusion-file-support 1.1.1__tar.gz

python3-cyberfusion-file-support-1.1.1/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-file-support
+Version: 1.1.1
+Summary: Library for idempotent writing to files.
+Home-page: https://vcs.cyberfusion.nl/shared/python3-cyberfusion-file-support
+Author: Cyberfusion
+Author-email: support@cyberfusion.io
+Platform: linux
+Description-Content-Type: text/markdown
+
+# python3-cyberfusion-file-support
+
+Library for idempotent writing to files.
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-file-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.QueueSupport import Queue
+from cyberfusion.FileSupport import DestinationFileReplacement
+
+queue = Queue()
+
+tmp_file = DestinationFileReplacement(
+    queue,
+    contents="foobar",
+    destination_file_path="/tmp/foobar.txt",
+    default_comment_character=None,
+    command=["true"],
+)
+
+print(tmp_file.differences)
+
+tmp_file.add_copy_to_queue()
+
+queue.process(preview=...)
+```

python3-cyberfusion-file-support-1.1.1/README.md

@@ -0,0 +1,53 @@
+# python3-cyberfusion-file-support
+
+Library for idempotent writing to files.
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-file-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.QueueSupport import Queue
+from cyberfusion.FileSupport import DestinationFileReplacement
+
+queue = Queue()
+
+tmp_file = DestinationFileReplacement(
+    queue,
+    contents="foobar",
+    destination_file_path="/tmp/foobar.txt",
+    default_comment_character=None,
+    command=["true"],
+)
+
+print(tmp_file.differences)
+
+tmp_file.add_copy_to_queue()
+
+queue.process(preview=...)
+```

python3-cyberfusion-file-support-1.1.1/pyproject.toml

@@ -0,0 +1,21 @@
+[tool.isort]
+profile = "black"
+line_length = 79
+known_first_party = ["cyberfusion"]
+default_section = "THIRDPARTY"
+
+[tool.black]
+line-length = 79
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | venv
+  )/
+)
+'''

python3-cyberfusion-file-support-1.1.1/setup.cfg

@@ -0,0 +1,12 @@
+[aliases]
+test = pytest
+
+[tool:pytest]
+norecursedirs = .git build dist *.egg __pycache__ .cache
+testpaths = tests
+junit_suite_name = python3-cyberfusion-file-support
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

python3-cyberfusion-file-support-1.1.1/setup.py

@@ -0,0 +1,21 @@
+"""A setuptools based setup module."""
+
+from setuptools import setup
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="python3-cyberfusion-file-support",
+    version="1.1.1",
+    description="Library for idempotent writing to files.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Cyberfusion",
+    author_email="support@cyberfusion.io",
+    url="https://vcs.cyberfusion.nl/shared/python3-cyberfusion-file-support",
+    platforms=["linux"],
+    packages=["cyberfusion.FileSupport"],
+    package_dir={"": "src"},
+    data_files=[],
+)

python3-cyberfusion-file-support-1.1.1/src/cyberfusion/FileSupport/__init__.py

@@ -0,0 +1,160 @@
+"""Classes for files."""
+
+import difflib
+import filecmp
+import os
+from typing import List, Optional, Union
+
+from cyberfusion.Common import get_tmp_file
+from cyberfusion.QueueSupport import Queue
+from cyberfusion.QueueSupport.items.command import CommandItem
+from cyberfusion.QueueSupport.items.copy import CopyItem
+from cyberfusion.QueueSupport.items.unlink import UnlinkItem
+
+
+class _DestinationFile:
+    """Represents destination file."""
+
+    def __init__(self, *, path: str) -> None:
+        """Set attributes."""
+        self.path = path
+
+    @property
+    def exists(self) -> bool:
+        """Get if exists."""
+        return os.path.exists(self.path)
+
+    @property
+    def contents(self) -> Optional[str]:
+        """Get contents."""
+        if self.exists:
+            with open(self.path, "r") as f:
+                return f.read()
+
+        return None
+
+
+class DestinationFileReplacement:
+    """Represents file that will replace destination file."""
+
+    def __init__(
+        self,
+        queue: Queue,
+        *,
+        contents: Union[str, bytes],
+        destination_file_path: str,
+        default_comment_character: Optional[str] = None,
+        command: Optional[List[str]] = None,
+        reference: Optional[str] = None,
+    ) -> None:
+        """Set attributes.
+
+        'default_comment_character' has no effect when 'contents' is not string.
+        """
+        self.queue = queue
+        self._contents = contents
+        self.default_comment_character = default_comment_character
+        self.command = command
+        self.reference = reference
+
+        self.tmp_path = get_tmp_file()
+        self.destination_file = _DestinationFile(path=destination_file_path)
+
+        self._write_to_tmp_file()
+
+    @property
+    def contents(self) -> Union[str, bytes]:
+        """Get contents."""
+        if not isinstance(self._contents, str):
+            return self._contents
+
+        if self._contents != "" and not self._contents.endswith(
+            "\n"
+        ):  # Some programs require newline to consider last line completed
+            raise ValueError
+
+        if not self.default_comment_character:
+            return self._contents
+
+        default_comment = f"{self.default_comment_character} Update this file via your management interface.\n"
+        default_comment += f"{self.default_comment_character} Your changes will be overwritten.\n"
+        default_comment += "\n"
+
+        return default_comment + self._contents
+
+    def _write_to_tmp_file(self) -> None:
+        """Write contents to tmp file."""
+        if isinstance(self.contents, bytes):
+            open_mode = "wb"
+        else:
+            open_mode = "w"
+
+        with open(self.tmp_path, open_mode) as f:
+            f.write(self.contents)
+
+    @property
+    def changed(self) -> bool:
+        """Get if destination file will change."""
+        return not self.destination_file.exists or not filecmp.cmp(
+            self.tmp_path, self.destination_file.path
+        )
+
+    @property
+    def differences(self) -> List[str]:
+        """Get differences with destination file.
+
+        No differences are returned when contents is not string.
+        """
+        if not isinstance(self._contents, str):
+            return []
+
+        results = []
+
+        for line in difflib.unified_diff(
+            (
+                self.destination_file.contents.splitlines()
+                if self.destination_file.contents
+                else []
+            ),
+            self.contents.splitlines(),  # type: ignore[arg-type]
+            fromfile=self.tmp_path,
+            tofile=self.destination_file.path,
+            lineterm="",
+            n=0,
+        ):
+            results.append(line)
+
+        return results
+
+    def add_to_queue(self) -> None:
+        """Add items for replacement to queue."""
+        if self.changed:
+            # Copy when changed and always unlink, instead of move when changed
+            # and unlink when changed. MoveItem copies metadata (which means
+            # mode etc. of destination file is incorrect, as set to the tmp file
+            # until corrected by later queue items). CopyItem does not copy
+            # metadata, so if the destination file already exists, its mode
+            # etc. is unchanged.
+
+            self.queue.add(
+                CopyItem(
+                    source=self.tmp_path,
+                    destination=self.destination_file.path,
+                    reference=self.reference,
+                ),
+            )
+
+            if self.command:
+                self.queue.add(
+                    CommandItem(
+                        command=self.command, reference=self.reference
+                    ),
+                )
+
+        self.queue.add(
+            UnlinkItem(
+                path=self.tmp_path,
+                hide_outcomes=True,
+                reference=self.reference,
+            ),
+        )

python3-cyberfusion-file-support-1.1.1/src/python3_cyberfusion_file_support.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-file-support
+Version: 1.1.1
+Summary: Library for idempotent writing to files.
+Home-page: https://vcs.cyberfusion.nl/shared/python3-cyberfusion-file-support
+Author: Cyberfusion
+Author-email: support@cyberfusion.io
+Platform: linux
+Description-Content-Type: text/markdown
+
+# python3-cyberfusion-file-support
+
+Library for idempotent writing to files.
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-file-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.QueueSupport import Queue
+from cyberfusion.FileSupport import DestinationFileReplacement
+
+queue = Queue()
+
+tmp_file = DestinationFileReplacement(
+    queue,
+    contents="foobar",
+    destination_file_path="/tmp/foobar.txt",
+    default_comment_character=None,
+    command=["true"],
+)
+
+print(tmp_file.differences)
+
+tmp_file.add_copy_to_queue()
+
+queue.process(preview=...)
+```

python3-cyberfusion-file-support-1.1.1/src/python3_cyberfusion_file_support.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+src/cyberfusion/FileSupport/__init__.py
+src/python3_cyberfusion_file_support.egg-info/PKG-INFO
+src/python3_cyberfusion_file_support.egg-info/SOURCES.txt
+src/python3_cyberfusion_file_support.egg-info/dependency_links.txt
+src/python3_cyberfusion_file_support.egg-info/top_level.txt

python3-cyberfusion-file-support-1.1.1/src/python3_cyberfusion_file_support.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

python3-cyberfusion-file-support-1.1.1/src/python3_cyberfusion_file_support.egg-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion