feat(poly deps, info, libs): save contents to file command option (#372)

* feat(poly deps): save command output to file

* feat(poly info): save command output to file

* refactor(poetry): command options with less duplications

* feat(poly libs): save command output to file

* fix(poly sync): remove unused 'strict' option

* bump the Poetry plugin to 1.42.0

* bump the CLI to 1.35.0

* bump the PDM Polylith bricks hook to 1.3.3

* bump the PDM Polylith workspace hook to 1.3.3

Author: DavidVujic

bases/polylith/cli/core.py

@@ -59,9 +59,20 @@ def enriched_with_lock_files_data(
 
 
 @app.command("info")
-def info_command(short: Annotated[bool, options.short_workspace] = False):
+def info_command(
+    short: Annotated[bool, options.short_workspace] = False,
+    save: Annotated[bool, options.save] = False,
+):
     """Info about the Polylith workspace."""
-    commands.info.run(short)
+    root = repo.get_workspace_root(Path.cwd())
+    output = configuration.get_output_dir(root, "info") if save else None
+
+    cli_options = {
+        "short": short,
+        "save": save,
+        "output": output,
+    }
+    commands.info.run(root, cli_options)
 
 
 @app.command("check")
@@ -120,17 +131,21 @@ def libs_command(
     directory: Annotated[str, options.directory] = "",
     alias: Annotated[str, options.alias] = "",
     short: Annotated[bool, options.short] = False,
+    save: Annotated[bool, options.save] = False,
 ):
     """Show third-party libraries used in the workspace."""
     root = repo.get_workspace_root(Path.cwd())
     ns = configuration.get_namespace_from_config(root)
 
     all_projects_data = info.get_projects_data(root, ns)
+    output = configuration.get_output_dir(root, "libs") if save else None
 
     cli_options = {
         "strict": strict,
         "alias": str.split(alias, ",") if alias else [],
         "short": short,
+        "save": save,
+        "output": output,
     }
 
     projects_data = filtered_projects_data(all_projects_data, directory)
@@ -145,7 +160,6 @@ def libs_command(
 
 @app.command("sync")
 def sync_command(
-    strict: Annotated[bool, options.strict] = False,
     quiet: Annotated[bool, options.quiet] = False,
     directory: Annotated[str, options.directory] = "",
     verbose: Annotated[bool, options.verbose] = False,
@@ -157,7 +171,6 @@ def sync_command(
     all_projects_data = info.get_projects_data(root, ns)
 
     cli_options = {
-        "strict": strict,
         "quiet": quiet,
         "verbose": verbose,
     }
@@ -172,14 +185,23 @@ def sync_command(
 def deps_command(
     directory: Annotated[str, options.directory] = "",
     brick: Annotated[str, options.brick] = "",
+    save: Annotated[bool, options.save] = False,
 ):
     """Visualize the dependencies between bricks."""
     root = repo.get_workspace_root(Path.cwd())
     ns = configuration.get_namespace_from_config(root)
 
     dir_path = Path(directory).as_posix() if directory else None
+    output = configuration.get_output_dir(root, "deps") if save else None
+
+    cli_options = {
+        "directory": dir_path,
+        "brick": brick or None,
+        "save": save,
+        "output": output,
+    }
 
-    commands.deps.run(root, ns, dir_path, brick or None)
+    commands.deps.run(root, ns, cli_options)
 
 
 if __name__ == "__main__":

bases/polylith/cli/options.py

@@ -18,3 +18,4 @@
 quiet = Option(help="Do not output any messages.")
 
 brick = Option(help="Shows dependencies for selected brick.")
+save = Option(help="Store the contents of this command to file.")

components/polylith/commands/deps.py

@@ -1,10 +1,12 @@
 from pathlib import Path
-from typing import List, Set, Union
+from typing import List, Set
 
 from polylith import bricks, deps, info
 
 
-def get_imports(root: Path, ns: str, bases: Set[str], components: Set[str]) -> dict:
+def get_imports(root: Path, ns: str, bricks: dict) -> dict:
+    bases = bricks["bases"]
+    components = bricks["components"]
     brick_imports = deps.get_brick_imports(root, ns, bases, components)
 
     return {**brick_imports["bases"], **brick_imports["components"]}
@@ -28,17 +30,22 @@ def get_components(root: Path, ns: str, project_data: dict) -> Set[str]:
     return pick_name(bricks.get_components_data(root, ns))
 
 
-def run(root: Path, ns: str, directory: Union[str, None], brick: Union[str, None]):
+def run(root: Path, ns: str, options: dict):
+    directory = options.get("directory")
+    brick = options.get("brick")
+
     projects_data = info.get_projects_data(root, ns) if directory else []
     project = next((p for p in projects_data if directory in p["path"].as_posix()), {})
 
-    bases = get_bases(root, ns, project)
-    components = get_components(root, ns, project)
+    bricks = {
+        "bases": get_bases(root, ns, project),
+        "components": get_components(root, ns, project),
+    }
 
-    imports = get_imports(root, ns, bases, components)
+    imports = get_imports(root, ns, bricks)
 
     if brick and imports.get(brick):
-        deps.print_brick_deps(brick, bases, components, imports)
+        deps.print_brick_deps(brick, bricks, imports, options)
         return
 
-    deps.print_deps(bases, components, imports)
+    deps.print_deps(bricks, imports, options)

components/polylith/commands/info.py

@@ -1,24 +1,17 @@
 from pathlib import Path
 
-from polylith import configuration, info, repo
+from polylith import configuration, info
 
 
-def run(short: bool):
-    root = repo.get_workspace_root(Path.cwd())
-
+def run(root: Path, options: dict):
     ns = configuration.get_namespace_from_config(root)
     bases = info.get_bases(root, ns)
     components = info.get_components(root, ns)
     projects_data = info.get_bricks_in_projects(root, components, bases, ns)
 
-    info.print_workspace_summary(projects_data, bases, components)
+    info.print_workspace_summary(projects_data, bases, components, options)
 
     if not components and not bases:
         return
 
-    if short:
-        info.print_compressed_view_for_bricks_in_projects(
-            projects_data, bases, components
-        )
-    else:
-        info.print_bricks_in_projects(projects_data, bases, components)
+    info.print_bricks_in_projects(projects_data, bases, components, options)

components/polylith/commands/libs.py

@@ -61,6 +61,6 @@ def run(
     flattened: dict = reduce(flatten_imports, imports.values(), {})
 
     report.print_libs_summary()
-    report.print_libs_in_bricks(flattened)
+    report.print_libs_in_bricks(flattened, options)
 
     return {missing_libs(p, imports, options) for p in projects_data}

components/polylith/configuration/__init__.py

@@ -1,6 +1,7 @@
 from polylith.configuration.core import (
     get_brick_structure_from_config,
     get_namespace_from_config,
+    get_output_dir,
     get_resources_structure_from_config,
     get_tag_pattern_from_config,
     get_tag_sort_options_from_config,
@@ -13,6 +14,7 @@
 __all__ = [
     "get_brick_structure_from_config",
     "get_namespace_from_config",
+    "get_output_dir",
     "get_resources_structure_from_config",
     "get_tag_pattern_from_config",
     "get_tag_sort_options_from_config",

components/polylith/configuration/core.py

@@ -81,3 +81,18 @@ def get_resources_structure_from_config(path: Path) -> str:
         return "{brick}/{namespace}/{package}"
 
     return "{brick}/{package}"
+
+
+def get_output_dir(path: Path, command_name: str) -> str:
+    toml: dict = repo.load_workspace_config(path)
+
+    key = "output"
+
+    tool = toml["tool"]["polylith"]
+    commands = tool.get("commands", {})
+    command = commands.get(command_name, {})
+
+    output = command.get(key) or commands.get(key)
+    fallback = f"{repo.development_dir}/poly"
+
+    return output or fallback

components/polylith/deps/report.py

@@ -1,7 +1,8 @@
 from functools import reduce
 from itertools import zip_longest
-from typing import List, Set, Tuple
+from typing import List, Set, Tuple, Union
 
+from polylith import output
 from polylith.reporting import theme
 from rich import box
 from rich.console import Console
@@ -57,15 +58,33 @@ def create_rows(
     return comp_rows + base_rows
 
 
-def print_deps(bases: Set[str], components: Set[str], import_data: dict):
+def find_longest_brick_name(bases: Set[str], components: Set[str]) -> str:
+    bricks = set().union(bases, components)
+
+    return max(bricks, key=len)
+
+
+def calculate_brick_column_width(
+    bases: Set[str], components: Set[str]
+) -> Union[int, None]:
+    longest = find_longest_brick_name(bases, components)
+
+    return len(longest)
+
+
+def print_deps(bricks: dict, import_data: dict, options: dict):
+    bases = bricks["bases"]
+    components = bricks["components"]
     flattened = flatten_imports(import_data)
 
     imported_bases = sorted({b for b in flattened if b in bases})
     imported_components = sorted({c for c in flattened if c in components})
     imported_bricks = imported_components + imported_bases
+    save = options.get("save", False)
 
     table = Table(box=box.SIMPLE_HEAD)
-    table.add_column("[data]brick[/]")
+    brick_width = calculate_brick_column_width(bases, components)
+    table.add_column("[data]brick[/]", width=brick_width)
 
     cols = create_columns(imported_bases, imported_components)
     rows = create_rows(bases, components, import_data, imported_bricks)
@@ -79,6 +98,9 @@ def print_deps(bases: Set[str], components: Set[str], import_data: dict):
     console = Console(theme=theme.poly_theme)
     console.print(table, overflow="ellipsis")
 
+    if save:
+        output.save(table, options, "deps")
+
 
 def without(key: str, bricks: Set[str]) -> Set[str]:
     return {b for b in bricks if b != key}
@@ -111,9 +133,12 @@ def calculate_tag(brick: str, bases: Set[str]) -> str:
     return "base" if brick in bases else "comp"
 
 
-def print_brick_deps(
-    brick: str, bases: Set[str], components: Set[str], import_data: dict
-):
+def print_brick_deps(brick: str, bricks: dict, import_data: dict, options: dict):
+    bases = bricks["bases"]
+    components = bricks["components"]
+
+    save = options.get("save", False)
+
     brick_used_by = sorted_used_by(brick, bases, components, import_data)
     brick_uses = sorted_uses(brick, bases, components, import_data)
 
@@ -142,3 +167,6 @@ def print_brick_deps(
         table.add_row(*row)
 
     console.print(table, overflow="ellipsis")
+
+    if save:
+        output.save(table, options, f"deps_{brick}")

components/polylith/info/__init__.py

@@ -8,7 +8,6 @@
 from polylith.info.report import (
     is_project,
     print_bricks_in_projects,
-    print_compressed_view_for_bricks_in_projects,
     print_workspace_summary,
 )
 
@@ -20,6 +19,5 @@
     "get_projects_data",
     "is_project",
     "print_bricks_in_projects",
-    "print_compressed_view_for_bricks_in_projects",
     "print_workspace_summary",
 ]

components/polylith/info/report.py

@@ -1,5 +1,6 @@
 from typing import List
 
+from polylith import output
 from polylith.reporting import theme
 from rich import box
 from rich.console import Console
@@ -67,34 +68,31 @@ def build_bricks_in_projects_table(
     return table
 
 
-def print_table(table: Table) -> None:
-    console = Console(theme=theme.poly_theme)
-
-    console.print(table, overflow="ellipsis")
-
-
-def print_compressed_view_for_bricks_in_projects(
-    projects_data: List[dict], bases: List[str], components: List[str]
+def print_bricks_in_projects(
+    projects_data: List[dict],
+    bases: List[str],
+    components: List[str],
+    options: dict,
 ) -> None:
-    options = {"short": True}
     table = build_bricks_in_projects_table(projects_data, bases, components, options)
 
-    print_table(table)
-
+    save = options.get("save", False)
+    console = Console(theme=theme.poly_theme)
 
-def print_bricks_in_projects(
-    projects_data: List[dict], bases: List[str], components: List[str]
-) -> None:
-    options = {"short": False}
-    table = build_bricks_in_projects_table(projects_data, bases, components, options)
+    console.print(table, overflow="ellipsis")
 
-    print_table(table)
+    if save:
+        output.save(table, options, "info")
 
 
 def print_workspace_summary(
-    projects_data: List[dict], bases: List[str], components: List[str]
+    projects_data: List[dict],
+    bases: List[str],
+    components: List[str],
+    options: dict,
 ) -> None:
-    console = Console(theme=theme.poly_theme)
+    save = options.get("save", False)
+    console = Console(theme=theme.poly_theme, record=save)
 
     console.print(Padding("[data]Workspace summary[/]", (1, 0, 1, 0)))
 
@@ -107,3 +105,6 @@ def print_workspace_summary(
     console.print(f"[comp]components[/]: [data]{number_of_components}[/]")
     console.print(f"[base]bases[/]: [data]{number_of_bases}[/]")
     console.print(f"[data]development[/]: [data]{number_of_dev}[/]")
+
+    if save:
+        output.save_recorded(console, options, "workspace_summary")