entangled-cli 2.1.7__tar.gz → 2.1.9__tar.gz

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: entangled-cli
-Version: 2.1.7
+Version: 2.1.9
 Summary: Literate Programming toolbox
 Home-page: https://entangled.github.io/
 License: Apache 2
@@ -26,6 +26,7 @@ Project-URL: Repository, https://github.com/entangled/entangled.py
 Description-Content-Type: text/markdown
 
 # Entangled
+
 [![Upload Python Package](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml)
 [![Python package](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml)
 
@@ -43,6 +44,7 @@ We’re trying to increase the visibility of Entangled. If you like Entangled, p
 ```
 
 ## Get started
+
 To install Entangled, all you need is a Python (version ≥3.11) installation. If you use [`poetry`](https://python-poetry.org), and you start a new project,
 
 ```
@@ -59,6 +61,7 @@ pip install entangled-cli
 ```
 
 ## Use
+
 Run the `entangled watch` daemon in the root of your project folder. By default all Markdown files are monitored for fenced code blocks like so:
 
 ~~~markdown
@@ -70,6 +73,7 @@ Run the `entangled watch` daemon in the root of your project folder. By default
 The syntax of code block properties is the same as CSS properties: `#hello` gives the block the `hello` identifier, `.rust` adds the `rust` class and the `file` attribute is set to `src/world.rs` (quotes are optional). For Entangled to know how to tangle this block, you need to specify a language and a target file. However, now comes the cool stuff. We can split our code in meaningful components by cross-refrences.
 
 ### Hello World in C++
+
 The combined code-blocks in this example compose a compilable source code for "Hello World". For didactic reasons we don't always give the listing of an entire source file in one go. In stead, we use a system of references known as *noweb* (after Ramsey 1994).
 
 Inside source fragments you may encounter a line with `<<...>>` marks like,
@@ -113,6 +117,7 @@ return EXIT_SUCCESS;
 These blocks of code can be *tangled* into source files.
 
 ### Configuring
+
 Entangled is configured by putting a `entangled.toml` in the root of your project.
 
 ```toml
@@ -176,7 +181,38 @@ identifiers = ["java"]
 comment = { open = "//" }
 ```
 
+## Working with Git
+
+When using Entangled in conjunction with Git, there are a few tricks that you may want to know about.
+
+### Restoring files when both Markdown and code have changed
+
+When you edited both Markdown and code without the daemon running, you may need to do some tricks to get back into a consistent state.
+
+```shell
+git add .
+git commit -m 'fixed everything'   # save everything you did
+entangled tangle --force           # overwrites some changes you made
+git restore src/brilliant_code.c   # retrieve from latest commit
+entangled stitch                   # apply changes back to markdown
+git add .
+git commit --amend                 # amend your commit to perfection
+```
+
+There may be better/faster ways to do this.
+
+### Entangled conflicts after merging branches
+
+Entangled can get confused when you merge, and there is a conflict on `.entangled/filedb.json`. This file keeps track of which files are sources for Entangled and which ones are generated by Entangled. That way, Entangled will never overwrite files it isn't supposed to, and the other way around, when you rename a target, the old one gets removed. It is very hard to merge this file though. When you need to, you can regenerate this file using:
+
+```shell
+entangled tangle -r
+```
+
+This will perform the tangle as if it is the first time, but it won't actually write files.
+
 ## Hooks
+
 Entangled has a system of *hooks*: these add actions to the tangling process:
 
 - `build` trigger actions in a generated `Makefile`
@@ -185,6 +221,7 @@ Entangled has a system of *hooks*: these add actions to the tangling process:
 - `shebang` takes the first line if it starts with `#!` and puts it at the top of the file.
 
 ### `build` hook
+
 You can enable this hook in `entangled.toml`:
 
 ```toml
@@ -253,6 +290,7 @@ plot.savefig("fig/plot.svg")
 The snippet for generating the data is given as a dependency for that data; to generate the figure, both `result.csv` and the code snippet are dependencies.
 
 ### `quarto_attributes` hook
+
 Sometimes using the `build` hook (or the `brei` hook, see below), leads to long header lines. It is then better to specify attributes in a header section of your code. The Quarto project came up with a syntax, having the header be indicated by a comment with a vertical bar, e.g. `#|` or `//|` etc. The `quarto_attributes` hook reads those attributes and adds them to the properties of the code block.
 
 Example with the `brei` hook:
@@ -301,6 +339,7 @@ if __name__ == "__main__":
 The `id` attribute is reserved for the code's identifier (normally indicated with `#`) and the `classes` attribute can be used to indicate a list of classes in addition to the language class already given.
 
 ## Brei
+
 Entangled has a small build engine (similar to GNU Make) embedded, called Brei. You may give it a list of tasks (specified in TOML) that may depend on one another. Brei will run these when dependencies are newer than the target. Execution is lazy and in parallel. Brei supports:
 
 - Running tasks by passing a script to any configured interpreter, e.g. Bash, Python, Lua etc.
@@ -313,6 +352,7 @@ Entangled has a small build engine (similar to GNU Make) embedded, called Brei.
 Brei is available as a separate package, see [the Brei documentation](https://entangled.github.io/brei).
 
 ### Examples
+
 To write out "Hello, World!" to a file `msg.txt`, we may do the following,
 
 ```toml
@@ -351,7 +391,8 @@ requires = ["msg.txt"]
 ```
 
 ### The `brei` hook
-The following example uses both `brei` and `quatro_attributes` hooks. To add a Brei task, tag a code block with the `.task` class. 
+
+The following example uses both `brei` and `quatro_attributes` hooks. To add a Brei task, tag a code block with the `.task` class.
 
 ~~~markdown
 First we generate some data.
@@ -403,9 +444,11 @@ entangled brei figures
 You can use `${variable}` syntax inside Brei tasks just as you would in a stand-alone Brei script.
 
 ## Support for Document Generators
+
 Entangled has been used successfully with the following document generators. Note that some of these examples were built using older versions of Entangled, but they should work just the same.
 
 ### Pandoc
+
 [Pandoc](https://pandoc.org/) is a very versatile tool for converting documents in any format. It specifically has very wide support for different forms of Markdown syntax out in the wild, including a filter system that lets you extend the workings of Pandoc. Those filters can be written in any language through an API, for instance Python filters can be written using `panflute`, but there is also native support for Lua.
 
 To work with Entangled style literate documents, there is a set of [Pandoc filters](https://github.com/entangled/filters) available. The major downside of Pandoc, is that it offers no help in making your output HTML look beautiful. One option is to use the [Bootstrap template](https://github.com/entangled/bootstrap), but you may wan't to try out others as well, or design your own. These days a lot can be done with a single well designed CSS file.
@@ -420,6 +463,7 @@ To work with Entangled style literate documents, there is a set of [Pandoc filte
 Example: [Hello World in C++](https://entangled.github.io/examples/hello-world.html)
 
 ### MkDocs
+
 [MkDocs](https://www.mkdocs.org/) is specifically taylored towards converting Markdown into good looking, easy to navigate HTML, especially when used in combination with the [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/) theme. To use Entangled style code blocks with MkDocs, you'll need to install the [`mkdocs-entangled-plugin`](https://github.com/entangled/mkdocs-plugin) as well.
 
 - :heavy_plus_sign: specifically designed for Markdown to HTML, i.e. software documentation
@@ -431,6 +475,7 @@ Example: [Hello World in C++](https://entangled.github.io/examples/hello-world.h
 Example: TBD
 
 ### Typst
+
 [Typst](https://typst.app/) has a syntax that is similar to Markdown when it comes to code blocks. Set the code block markers in `entangled.toml` like so:
 
 ```toml
@@ -444,27 +489,32 @@ close="^(?P<indent>\\s*)```\\s*$"
 ```
 
 ### Documenter.jl
+
 [Documenter.jl]() is the standard tool to write Julia documention in. It has internal support for evaluating code block contents.
 
 Example: [Intro to code generation in Julia](https://jhidding.github.io/MacroExercises.jl/dev/)
 
 ### PDoc
+
 [PDoc]() is a tool for documenting smaller Python projects. It grabs all documentation from the doc-strings in your Python library and generates a page from that. To have it include its own literate source, I had to use some very ugly hacks.
 
 Example: [check-deps, a Universal dependency checker in Python](https://jhidding.github.io/check-deps/checkdeps.html)
 
 ### Docsify
+
 [Docsify](https://docsify.js.org/#/) serves the markdown files and does the conversion to HTML in a Javascript library (in browser).
 
 Example: [Guide to C++ on the web through WASM](https://nlesc-jcer.github.io/cpp2wasm/#/)
 
 ## History
+
 This is a rewrite of Entangled in Python. Older versions were written in Haskell. The rewrite in Python was motivated by ease of installation, larger community and quite frankly, a fit of mental derangement.
 
 ## Contributing
+
 If you have an idea for improving Entangled, please file an issue before creating a pull request. Code in this repository is formatted using `black` and type checked using `mypy`.
 
 ## License
-Copyright 2023 Netherlands eScience Center, written by Johan Hidding, licensed under the Apache 2 license, see LICENSE.
 
+Copyright 2023 Netherlands eScience Center, written by Johan Hidding, licensed under the Apache 2 license, see LICENSE.
 

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/README.md

@@ -1,4 +1,5 @@
 # Entangled
+
 [![Upload Python Package](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml)
 [![Python package](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml)
 
@@ -16,6 +17,7 @@ We’re trying to increase the visibility of Entangled. If you like Entangled, p
 ```
 
 ## Get started
+
 To install Entangled, all you need is a Python (version ≥3.11) installation. If you use [`poetry`](https://python-poetry.org), and you start a new project,
 
 ```
@@ -32,6 +34,7 @@ pip install entangled-cli
 ```
 
 ## Use
+
 Run the `entangled watch` daemon in the root of your project folder. By default all Markdown files are monitored for fenced code blocks like so:
 
 ~~~markdown
@@ -43,6 +46,7 @@ Run the `entangled watch` daemon in the root of your project folder. By default
 The syntax of code block properties is the same as CSS properties: `#hello` gives the block the `hello` identifier, `.rust` adds the `rust` class and the `file` attribute is set to `src/world.rs` (quotes are optional). For Entangled to know how to tangle this block, you need to specify a language and a target file. However, now comes the cool stuff. We can split our code in meaningful components by cross-refrences.
 
 ### Hello World in C++
+
 The combined code-blocks in this example compose a compilable source code for "Hello World". For didactic reasons we don't always give the listing of an entire source file in one go. In stead, we use a system of references known as *noweb* (after Ramsey 1994).
 
 Inside source fragments you may encounter a line with `<<...>>` marks like,
@@ -86,6 +90,7 @@ return EXIT_SUCCESS;
 These blocks of code can be *tangled* into source files.
 
 ### Configuring
+
 Entangled is configured by putting a `entangled.toml` in the root of your project.
 
 ```toml
@@ -149,7 +154,38 @@ identifiers = ["java"]
 comment = { open = "//" }
 ```
 
+## Working with Git
+
+When using Entangled in conjunction with Git, there are a few tricks that you may want to know about.
+
+### Restoring files when both Markdown and code have changed
+
+When you edited both Markdown and code without the daemon running, you may need to do some tricks to get back into a consistent state.
+
+```shell
+git add .
+git commit -m 'fixed everything'   # save everything you did
+entangled tangle --force           # overwrites some changes you made
+git restore src/brilliant_code.c   # retrieve from latest commit
+entangled stitch                   # apply changes back to markdown
+git add .
+git commit --amend                 # amend your commit to perfection
+```
+
+There may be better/faster ways to do this.
+
+### Entangled conflicts after merging branches
+
+Entangled can get confused when you merge, and there is a conflict on `.entangled/filedb.json`. This file keeps track of which files are sources for Entangled and which ones are generated by Entangled. That way, Entangled will never overwrite files it isn't supposed to, and the other way around, when you rename a target, the old one gets removed. It is very hard to merge this file though. When you need to, you can regenerate this file using:
+
+```shell
+entangled tangle -r
+```
+
+This will perform the tangle as if it is the first time, but it won't actually write files.
+
 ## Hooks
+
 Entangled has a system of *hooks*: these add actions to the tangling process:
 
 - `build` trigger actions in a generated `Makefile`
@@ -158,6 +194,7 @@ Entangled has a system of *hooks*: these add actions to the tangling process:
 - `shebang` takes the first line if it starts with `#!` and puts it at the top of the file.
 
 ### `build` hook
+
 You can enable this hook in `entangled.toml`:
 
 ```toml
@@ -226,6 +263,7 @@ plot.savefig("fig/plot.svg")
 The snippet for generating the data is given as a dependency for that data; to generate the figure, both `result.csv` and the code snippet are dependencies.
 
 ### `quarto_attributes` hook
+
 Sometimes using the `build` hook (or the `brei` hook, see below), leads to long header lines. It is then better to specify attributes in a header section of your code. The Quarto project came up with a syntax, having the header be indicated by a comment with a vertical bar, e.g. `#|` or `//|` etc. The `quarto_attributes` hook reads those attributes and adds them to the properties of the code block.
 
 Example with the `brei` hook:
@@ -274,6 +312,7 @@ if __name__ == "__main__":
 The `id` attribute is reserved for the code's identifier (normally indicated with `#`) and the `classes` attribute can be used to indicate a list of classes in addition to the language class already given.
 
 ## Brei
+
 Entangled has a small build engine (similar to GNU Make) embedded, called Brei. You may give it a list of tasks (specified in TOML) that may depend on one another. Brei will run these when dependencies are newer than the target. Execution is lazy and in parallel. Brei supports:
 
 - Running tasks by passing a script to any configured interpreter, e.g. Bash, Python, Lua etc.
@@ -286,6 +325,7 @@ Entangled has a small build engine (similar to GNU Make) embedded, called Brei.
 Brei is available as a separate package, see [the Brei documentation](https://entangled.github.io/brei).
 
 ### Examples
+
 To write out "Hello, World!" to a file `msg.txt`, we may do the following,
 
 ```toml
@@ -324,7 +364,8 @@ requires = ["msg.txt"]
 ```
 
 ### The `brei` hook
-The following example uses both `brei` and `quatro_attributes` hooks. To add a Brei task, tag a code block with the `.task` class. 
+
+The following example uses both `brei` and `quatro_attributes` hooks. To add a Brei task, tag a code block with the `.task` class.
 
 ~~~markdown
 First we generate some data.
@@ -376,9 +417,11 @@ entangled brei figures
 You can use `${variable}` syntax inside Brei tasks just as you would in a stand-alone Brei script.
 
 ## Support for Document Generators
+
 Entangled has been used successfully with the following document generators. Note that some of these examples were built using older versions of Entangled, but they should work just the same.
 
 ### Pandoc
+
 [Pandoc](https://pandoc.org/) is a very versatile tool for converting documents in any format. It specifically has very wide support for different forms of Markdown syntax out in the wild, including a filter system that lets you extend the workings of Pandoc. Those filters can be written in any language through an API, for instance Python filters can be written using `panflute`, but there is also native support for Lua.
 
 To work with Entangled style literate documents, there is a set of [Pandoc filters](https://github.com/entangled/filters) available. The major downside of Pandoc, is that it offers no help in making your output HTML look beautiful. One option is to use the [Bootstrap template](https://github.com/entangled/bootstrap), but you may wan't to try out others as well, or design your own. These days a lot can be done with a single well designed CSS file.
@@ -393,6 +436,7 @@ To work with Entangled style literate documents, there is a set of [Pandoc filte
 Example: [Hello World in C++](https://entangled.github.io/examples/hello-world.html)
 
 ### MkDocs
+
 [MkDocs](https://www.mkdocs.org/) is specifically taylored towards converting Markdown into good looking, easy to navigate HTML, especially when used in combination with the [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/) theme. To use Entangled style code blocks with MkDocs, you'll need to install the [`mkdocs-entangled-plugin`](https://github.com/entangled/mkdocs-plugin) as well.
 
 - :heavy_plus_sign: specifically designed for Markdown to HTML, i.e. software documentation
@@ -404,6 +448,7 @@ Example: [Hello World in C++](https://entangled.github.io/examples/hello-world.h
 Example: TBD
 
 ### Typst
+
 [Typst](https://typst.app/) has a syntax that is similar to Markdown when it comes to code blocks. Set the code block markers in `entangled.toml` like so:
 
 ```toml
@@ -417,26 +462,31 @@ close="^(?P<indent>\\s*)```\\s*$"
 ```
 
 ### Documenter.jl
+
 [Documenter.jl]() is the standard tool to write Julia documention in. It has internal support for evaluating code block contents.
 
 Example: [Intro to code generation in Julia](https://jhidding.github.io/MacroExercises.jl/dev/)
 
 ### PDoc
+
 [PDoc]() is a tool for documenting smaller Python projects. It grabs all documentation from the doc-strings in your Python library and generates a page from that. To have it include its own literate source, I had to use some very ugly hacks.
 
 Example: [check-deps, a Universal dependency checker in Python](https://jhidding.github.io/check-deps/checkdeps.html)
 
 ### Docsify
+
 [Docsify](https://docsify.js.org/#/) serves the markdown files and does the conversion to HTML in a Javascript library (in browser).
 
 Example: [Guide to C++ on the web through WASM](https://nlesc-jcer.github.io/cpp2wasm/#/)
 
 ## History
+
 This is a rewrite of Entangled in Python. Older versions were written in Haskell. The rewrite in Python was motivated by ease of installation, larger community and quite frankly, a fit of mental derangement.
 
 ## Contributing
+
 If you have an idea for improving Entangled, please file an issue before creating a pull request. Code in this repository is formatted using `black` and type checked using `mypy`.
 
 ## License
-Copyright 2023 Netherlands eScience Center, written by Johan Hidding, licensed under the Apache 2 license, see LICENSE.
 
+Copyright 2023 Netherlands eScience Center, written by Johan Hidding, licensed under the Apache 2 license, see LICENSE.

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/entangled/commands/__init__.py

@@ -6,7 +6,6 @@ from .tangle import tangle
 from .watch import watch
 from .brei import brei
 
-
 __all__ = [
     "new",
     "brei",

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/entangled/commands/tangle.py

@@ -12,6 +12,17 @@ from ..hooks import get_hooks
 from ..errors.user import UserError
 
 
+def get_input_files() -> list[Path]:
+    include_file_list = chain.from_iterable(map(Path(".").glob, config.watch_list))
+    exclude_file_list = list(
+        chain.from_iterable(map(Path(".").glob, config.ignore_list))
+    )
+    input_file_list = [
+        path for path in include_file_list if not path in exclude_file_list
+    ]
+    return input_file_list
+
+
 @argh.arg(
     "-a",
     "--annotate",
@@ -20,7 +31,8 @@ from ..errors.user import UserError
 )
 @argh.arg("--force", help="force overwrite on conflict")
 @argh.arg("-s", "--show", help="only show, don't act")
-def tangle(*, annotate: Optional[str] = None, force: bool = False, show: bool = False):
+@argh.arg("-r", "--reset-db", help="resets database")
+def tangle(*, annotate: Optional[str] = None, force: bool = False, show: bool = False, reset_db = False):
     """Tangle codes from Markdown"""
     config.read()
 
@@ -33,13 +45,7 @@ def tangle(*, annotate: Optional[str] = None, force: bool = False, show: bool =
     else:
         annotation_method = AnnotationMethod[annotate.upper()]
 
-    include_file_list = chain.from_iterable(map(Path(".").glob, config.watch_list))
-    exclude_file_list = list(
-        chain.from_iterable(map(Path(".").glob, config.ignore_list))
-    )
-    input_file_list = [
-        path for path in include_file_list if not path in exclude_file_list
-    ]
+    input_file_list = get_input_files()
 
     refs = ReferenceMap()
     hooks = get_hooks()
@@ -47,6 +53,8 @@ def tangle(*, annotate: Optional[str] = None, force: bool = False, show: bool =
 
     if show:
         mode = TransactionMode.SHOW
+    elif reset_db:
+        mode = TransactionMode.RESETDB
     elif force:
         mode = TransactionMode.FORCE
     else:

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/entangled/filedb.py

@@ -103,8 +103,19 @@ class FileDB:
             set(map(Path, raw["target"])),
         )
 
+    def clear(self):
+        self._files = {}
+        self._source = set()
+        self._target = set()
+
     @property
     def managed(self) -> set[Path]:
+        """List all managed files. These are files that can be reconstructed
+        from the sources, at least when things are in a consistent state.
+
+        For example: markdown sources cannot be reconstructed, so are not
+        listed here. However, generated code is first constructed from
+        the markdown, so is considered to be managed."""
         return self._target
 
     def write(self):
@@ -155,12 +166,17 @@ class FileDB:
             db = FileDB.read()
             undead = list(filter(lambda p: not p.exists(), db.files))
             for path in undead:
-                logging.warning(
-                    "File `%s` in DB doesn't exist. Removing entry from DB.", path
-                )
-                del db[path]
-            if len(undead) > 0:
-                db.write()
+                if path in db.managed:
+                    logging.warning(
+                        "File `%s` in DB seems not to exist, but this file is managed.\n"
+                        "This may happen every now and then with certain editors that "
+                        "delete a file before writing.", path
+                    )
+                else:
+                    logging.warning(
+                        "File `%s` is in database but doesn't seem to exist.\n"
+                        "Run `entangled tangle -r` to recreate the database.", path
+                    )
             return db
 
         FileDB.path().parent.mkdir(parents=True, exist_ok=True)

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/entangled/hooks/task.py

@@ -18,6 +18,10 @@ log = logger()
 
 
 def ensure_list(strs: str | list[str]) -> list[str]:
+    """Some options may be given either as a list or as a single string,
+    where the string is supposed to have a whitespace separated list.
+    This function converts from either to a list of strings.
+    """
     if isinstance(strs, str):
         return strs.split()
     elif isinstance(strs, list):

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/entangled/transaction.py

@@ -30,6 +30,10 @@ class Action:
         a file that is not managed by Entangled."""
         raise NotImplementedError()
 
+    def add_to_db(self, _: FileDB):
+        """Only perform the corresponding database action."""
+        raise NotImplementedError()
+
     def run(self, _: FileDB):
         """Run the action, if `interact` is `True` then confirmation is
         asked in case of a conflict."""
@@ -54,6 +58,11 @@ class Create(Action):
             return f"{self.target} is not managed by Entangled"
         return None
 
+    def add_to_db(self, db: FileDB):
+        db.update(self.target, self.sources)
+        if self.sources != []:
+            db.managed.add(self.target)
+
     def run(self, db: FileDB):
         self.target.parent.mkdir(parents=True, exist_ok=True)
         # Write to tmp file then replace with file name
@@ -67,9 +76,7 @@ class Create(Action):
                 os.chmod(f.name, self.mode)
             os.fsync(f.fileno())
         os.replace(f.name, self.target)
-        db.update(self.target, self.sources)
-        if self.sources != []:
-            db.managed.add(self.target)
+        self.add_to_db(db)
 
     def __str__(self):
         return f"create `{self.target}`"
@@ -98,6 +105,9 @@ class Write(Action):
                 return f"`{self.target}` seems to be newer than `{newest_src.path}`"
         return None
 
+    def add_to_db(self, db: FileDB):
+        db.update(self.target, self.sources)
+
     def run(self, db: FileDB):
         # Write to tmp file then replace with file name
         tmp_dir = Path() / ".entangled" / "tmp"
@@ -110,7 +120,7 @@ class Write(Action):
                 os.chmod(f.name, self.mode)
             os.fsync(f.fileno())
         os.replace(f.name, self.target)
-        db.update(self.target, self.sources)
+        self.add_to_db(db)
 
     def __str__(self):
         return f"write `{self.target}`"
@@ -126,13 +136,16 @@ class Delete(Action):
             )
         return None
 
+    def add_to_db(self, db: FileDB):
+        del db[self.target]
+
     def run(self, db: FileDB):
         self.target.unlink()
         parent = self.target.parent
         while list(parent.iterdir()) == []:
             parent.rmdir()
             parent = parent.parent
-        del db[self.target]
+        self.add_to_db(db)
 
     def __str__(self):
         return f"delete `{self.target}`"
@@ -190,17 +203,27 @@ class Transaction:
         for f in self.updates:
             self.db.update(f)
 
+    def updatedb(self):
+        for a in self.actions:
+            a.add_to_db(self.db)
+        for f in self.updates:
+            self.db.update(f)
+
 
 class TransactionMode(Enum):
     SHOW = 1
     FAIL = 2
     CONFIRM = 3
     FORCE = 4
+    RESETDB = 5
 
 
 @contextmanager
 def transaction(mode: TransactionMode = TransactionMode.FAIL):
     with file_db() as db:
+        if mode == TransactionMode.RESETDB:
+            db.clear()
+
         tr = Transaction(db)
 
         logging.debug("Open transaction")
@@ -212,17 +235,25 @@ def transaction(mode: TransactionMode = TransactionMode.FAIL):
             case TransactionMode.SHOW:
                 logging.info("nothing is done")
                 return
+
+            case TransactionMode.RESETDB:
+                logging.info("rebuilding database")
+                tr.updatedb()
+                return
+
             case TransactionMode.FAIL:
                 if not tr.all_ok():
                     logging.error(
                         "conflicts found, breaking off (use `--force` to run anyway)"
                     )
                     return
+
             case TransactionMode.CONFIRM:
                 if not tr.all_ok():
                     reply = input("Ok to continue? (y/n) ")
                     if not (reply == "y" or reply == "yes"):
                         return
+
             case TransactionMode.FORCE:
                 logging.warning("conflicts found, but continuing anyway")
 

{entangled_cli-2.1.7 → entangled_cli-2.1.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "entangled-cli"
-version = "2.1.7"
+version = "2.1.9"
 description = "Literate Programming toolbox"
 repository = "https://github.com/entangled/entangled.py"
 homepage = "https://entangled.github.io/"