beanhub-cli 1.2.1__tar.gz → 1.2.3__tar.gz

{beanhub_cli-1.2.1 → beanhub_cli-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: beanhub-cli
-Version: 1.2.1
+Version: 1.2.3
 Summary: Command line tools for BeanHub
 License: MIT
 Author: Fang-Pen Lin
@@ -15,7 +15,7 @@ Requires-Dist: beancount-black (>=1.0.1,<2.0.0)
 Requires-Dist: beancount-parser (>=1.2.3,<1.3.0)
 Requires-Dist: beanhub-extract (>=0.1.0,<1.0.0)
 Requires-Dist: beanhub-forms (>=0.1.3,<0.2.0)
-Requires-Dist: beanhub-import (>=0.3.0,<1.0.0)
+Requires-Dist: beanhub-import (>=0.3.4,<1.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: fastapi (>=0.98.0,<1.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
@@ -105,8 +105,12 @@ You can run [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 bh format main.bean
 ```
 
-Currently, the formatter works mostly the same as beancount-black, except it doesn't create a backup file by default.
-We are working on adding new features, such as making it possible to follow Beancount include statements to format all Beancount files.
+Without the file arguments, the format command will try to format `main.bean` in the current folder, and it will recursively follow all the `include` statements to format all the bean files.
+Like this:
+
+```bash
+bh format
+```
 
 ### More features to come
 

{beanhub_cli-1.2.1 → beanhub_cli-1.2.3}/README.md

@@ -76,8 +76,12 @@ You can run [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 bh format main.bean
 ```
 
-Currently, the formatter works mostly the same as beancount-black, except it doesn't create a backup file by default.
-We are working on adding new features, such as making it possible to follow Beancount include statements to format all Beancount files.
+Without the file arguments, the format command will try to format `main.bean` in the current folder, and it will recursively follow all the `include` statements to format all the bean files.
+Like this:
+
+```bash
+bh format
+```
 
 ### More features to come
 

{beanhub_cli-1.2.1 → beanhub_cli-1.2.3}/beanhub_cli/format.py

@@ -7,6 +7,9 @@ import typing
 import click
 from beancount_black.formatter import Formatter
 from beancount_parser.parser import make_parser
+from beancount_parser.parser import traverse
+from lark import Lark
+from lark import Tree
 
 from .cli import cli
 from .environment import Environment
@@ -32,6 +35,16 @@ def create_backup(src: pathlib.Path, suffix: str) -> pathlib.Path:
         return backup_path
 
 
+def file_tree_iterator(
+    parser: Lark, filenames: list[pathlib.Path]
+) -> typing.Generator[tuple[pathlib.Path, Tree], None, None]:
+    for filename in filenames:
+        with open(filename, "rt") as input_file:
+            input_content = input_file.read()
+            tree = parser.parse(input_content)
+            yield filename, tree
+
+
 @cli.command(name="format", help="Format Beancount files with beancount-black")
 @click.argument("filename", type=click.Path(exists=False, dir_okay=False), nargs=-1)
 @click.option(
@@ -53,33 +66,43 @@ def main(
     backup: bool,
 ):
     # TODO: support follow include statements
-
     parser = make_parser()
-    formatter = Formatter()
     if stdin_mode:
         env.logger.info("Processing in stdin mode")
         input_content = sys.stdin.read()
         tree = parser.parse(input_content)
+        formatter = Formatter()
         formatter.format(tree, sys.stdout)
     else:
-        for name in filename:
-            env.logger.info("Processing file %s", name)
-            with open(name, "rt") as input_file:
-                input_content = input_file.read()
-                tree = parser.parse(input_content)
+        if filename:
+            iterator = file_tree_iterator(
+                parser=parser,
+                filenames=map(lambda item: pathlib.Path(str(item)), filename),
+            )
+        else:
+            env.logger.info("No files provided, traverse starting from main.bean")
+            iterator = traverse(
+                parser=parser,
+                bean_file=pathlib.Path("main.bean"),
+                root_dir=pathlib.Path.cwd(),
+            )
+        for filepath, tree in iterator:
+            env.logger.info("Processing file %s", filepath)
             with tempfile.NamedTemporaryFile(mode="wt+", suffix=".bean") as output_file:
+                formatter = Formatter()
                 formatter.format(tree, output_file)
                 output_file.seek(0)
                 output_content = output_file.read()
+                input_content = filepath.read_text()
                 if input_content == output_content:
-                    env.logger.info("File %s is not changed, skip", name)
+                    env.logger.info("File %s is not changed, skip", filepath)
                     continue
                 if backup:
-                    backup_path = create_backup(
-                        src=pathlib.Path(str(name)), suffix=backup_suffix
+                    backup_path = create_backup(src=filepath, suffix=backup_suffix)
+                    env.logger.info(
+                        "File %s changed, backup to %s", filepath, backup_path
                     )
-                    env.logger.info("File %s changed, backup to %s", name, backup_path)
                 output_file.seek(0)
-                with open(name, "wt") as input_file:
+                with open(filepath, "wt") as input_file:
                     shutil.copyfileobj(output_file, input_file)
     env.logger.info("done")

{beanhub_cli-1.2.1 → beanhub_cli-1.2.3}/beanhub_cli/import_cli.py

@@ -8,6 +8,7 @@ from beancount_black.formatter import Formatter
 from beancount_parser.parser import make_parser
 from beanhub_extract.data_types import Transaction
 from beanhub_extract.utils import strip_base_path
+from beanhub_import.data_types import BeancountTransaction
 from beanhub_import.data_types import DeletedTransaction
 from beanhub_import.data_types import GeneratedTransaction
 from beanhub_import.data_types import ImportDoc
@@ -55,8 +56,15 @@ TABLE_COLUMN_STYLE = "cyan"
     default="main.bean",
     help="The path to main entry beancount file",
 )
+@click.option(
+    "--remove-dangling",
+    is_flag=True,
+    help="Remove dangling transactions (existing imported transactions in Beancount files without corresponding generated transactions)",
+)
 @pass_env
-def main(env: Environment, config: str, workdir: str, beanfile: str):
+def main(
+    env: Environment, config: str, workdir: str, beanfile: str, remove_dangling: bool
+):
     config_path = pathlib.Path(config)
     with config_path.open("rt") as fo:
         doc_payload = yaml.safe_load(fo)
@@ -146,14 +154,18 @@ def main(env: Environment, config: str, workdir: str, beanfile: str):
             new_tree = parser.parse(bean_content)
         else:
             env.logger.info(
-                "Applying change sets (add=%s, update=%s, remove=%s) to %s",
+                "Applying change sets (add=%s, update=%s, remove=%s, dangling=%s) with remove_dangling=%s to %s",
                 len(change_set.add),
                 len(change_set.update),
                 len(change_set.remove),
+                len(change_set.dangling),
+                remove_dangling,
                 target_file,
             )
             tree = parser.parse(target_file.read_text())
-            new_tree = apply_change_set(tree=tree, change_set=change_set)
+            new_tree = apply_change_set(
+                tree=tree, change_set=change_set, remove_dangling=remove_dangling
+            )
 
         with target_file.open("wt") as fo:
             formatter = Formatter()
@@ -173,7 +185,24 @@ def main(env: Environment, config: str, workdir: str, beanfile: str):
             if txn.id not in deleted_txn_ids:
                 continue
             table.add_row(
-                escape(str(target_file)),
+                escape(str(target_file)) + f":{txn.lineno}",
+                str(txn.id),
+            )
+    rich.print(Padding(table, (1, 0, 0, 4)))
+
+    dangling_action = "Delete" if remove_dangling else "Ignored"
+    table = Table(
+        title=f"Dangling Transactions ({dangling_action})",
+        box=box.SIMPLE,
+        header_style=TABLE_HEADER_STYLE,
+        expand=True,
+    )
+    table.add_column("File", style=TABLE_COLUMN_STYLE)
+    table.add_column("Id", style=TABLE_COLUMN_STYLE)
+    for target_file, change_set in change_sets.items():
+        for txn in change_set.dangling:
+            table.add_row(
+                escape(str(target_file)) + f":{txn.lineno}",
                 str(txn.id),
             )
     rich.print(Padding(table, (1, 0, 0, 4)))

{beanhub_cli-1.2.1 → beanhub_cli-1.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beanhub-cli"
-version = "1.2.1"
+version = "1.2.3"
 description = "Command line tools for BeanHub"
 authors = ["Fang-Pen Lin <fangpen@launchplatform.com>"]
 license = "MIT"
@@ -22,7 +22,7 @@ uvicorn = ">=0.23.2, <1.0.0"
 beanhub-forms = "^0.1.3"
 pydantic-settings = "^2.0.3"
 rich = "^13.6.0"
-beanhub-import = ">= 0.3.0, <1.0.0"
+beanhub-import = ">= 0.3.4, <1.0.0"
 beanhub-extract = ">= 0.1.0, <1.0.0"
 beancount-parser = ">= 1.2.3, <1.3.0"