from __future__ import annotations from typing import TYPE_CHECKING import pytest from pipdeptree._models import PackageDAG from pipdeptree._models.package import Package from pipdeptree._render.text import render_text if TYPE_CHECKING: from collections.abc import Callable, Iterator from unittest.mock import Mock from tests.our_types import MockGraph @pytest.mark.parametrize( ("list_all", "reverse", "unicode", "expected_output"), [ ( True, False, True, [ "a==3.4.0", "├── b [required: >=2.0.0, installed: 2.3.1]", "│ └── d [required: >=2.30,<2.42, installed: 2.35]", "│ └── e [required: >=0.9.0, installed: 0.12.1]", "└── c [required: >=5.7.1, installed: 5.10.0]", " ├── d [required: >=2.30, installed: 2.35]", " │ └── e [required: >=0.9.0, installed: 0.12.1]", " └── e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", "└── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", "├── d [required: >=2.30, installed: 2.35]", "│ └── e [required: >=0.9.0, installed: 0.12.1]", "└── e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", "└── e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", "└── b [required: >=2.1.0, installed: 2.3.1]", " └── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", "g==6.8.3rc1", "├── e [required: >=0.9.0, installed: 0.12.1]", "└── f [required: >=3.0.0, installed: 3.1]", " └── b [required: >=2.1.0, installed: 2.3.1]", " └── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", ], ), ( True, True, True, [ "a==3.4.0", "b==2.3.1", "├── a==3.4.0 [requires: b>=2.0.0]", "└── f==3.1 [requires: b>=2.1.0]", " └── g==6.8.3rc1 [requires: f>=3.0.0]", "c==5.10.0", "└── a==3.4.0 [requires: c>=5.7.1]", "d==2.35", "├── b==2.3.1 [requires: d>=2.30,<2.42]", "│ ├── a==3.4.0 [requires: b>=2.0.0]", "│ └── f==3.1 [requires: b>=2.1.0]", "│ └── g==6.8.3rc1 [requires: f>=3.0.0]", "└── c==5.10.0 [requires: d>=2.30]", " └── a==3.4.0 [requires: c>=5.7.1]", "e==0.12.1", "├── c==5.10.0 [requires: e>=0.12.1]", "│ └── a==3.4.0 [requires: c>=5.7.1]", "├── d==2.35 [requires: e>=0.9.0]", "│ ├── b==2.3.1 [requires: d>=2.30,<2.42]", "│ │ ├── a==3.4.0 [requires: b>=2.0.0]", "│ │ └── f==3.1 [requires: b>=2.1.0]", "│ │ └── g==6.8.3rc1 [requires: f>=3.0.0]", "│ └── c==5.10.0 [requires: d>=2.30]", "│ └── a==3.4.0 [requires: c>=5.7.1]", "└── g==6.8.3rc1 [requires: e>=0.9.0]", "f==3.1", "└── g==6.8.3rc1 [requires: f>=3.0.0]", "g==6.8.3rc1", ], ), ( False, False, True, [ "a==3.4.0", "├── b [required: >=2.0.0, installed: 2.3.1]", "│ └── d [required: >=2.30,<2.42, installed: 2.35]", "│ └── e [required: >=0.9.0, installed: 0.12.1]", "└── c [required: >=5.7.1, installed: 5.10.0]", " ├── d [required: >=2.30, installed: 2.35]", " │ └── e [required: >=0.9.0, installed: 0.12.1]", " └── e [required: >=0.12.1, installed: 0.12.1]", "g==6.8.3rc1", "├── e [required: >=0.9.0, installed: 0.12.1]", "└── f [required: >=3.0.0, installed: 3.1]", " └── b [required: >=2.1.0, installed: 2.3.1]", " └── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", ], ), ( False, True, True, [ "e==0.12.1", "├── c==5.10.0 [requires: e>=0.12.1]", "│ └── a==3.4.0 [requires: c>=5.7.1]", "├── d==2.35 [requires: e>=0.9.0]", "│ ├── b==2.3.1 [requires: d>=2.30,<2.42]", "│ │ ├── a==3.4.0 [requires: b>=2.0.0]", "│ │ └── f==3.1 [requires: b>=2.1.0]", "│ │ └── g==6.8.3rc1 [requires: f>=3.0.0]", "│ └── c==5.10.0 [requires: d>=2.30]", "│ └── a==3.4.0 [requires: c>=5.7.1]", "└── g==6.8.3rc1 [requires: e>=0.9.0]", ], ), ( True, False, False, [ "a==3.4.0", " - b [required: >=2.0.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - c [required: >=5.7.1, installed: 5.10.0]", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", " - e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", " - b [required: >=2.1.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", "g==6.8.3rc1", " - e [required: >=0.9.0, installed: 0.12.1]", " - f [required: >=3.0.0, installed: 3.1]", " - b [required: >=2.1.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", ], ), ( True, True, False, [ "a==3.4.0", "b==2.3.1", " - a==3.4.0 [requires: b>=2.0.0]", " - f==3.1 [requires: b>=2.1.0]", " - g==6.8.3rc1 [requires: f>=3.0.0]", "c==5.10.0", " - a==3.4.0 [requires: c>=5.7.1]", "d==2.35", " - b==2.3.1 [requires: d>=2.30,<2.42]", " - a==3.4.0 [requires: b>=2.0.0]", " - f==3.1 [requires: b>=2.1.0]", " - g==6.8.3rc1 [requires: f>=3.0.0]", " - c==5.10.0 [requires: d>=2.30]", " - a==3.4.0 [requires: c>=5.7.1]", "e==0.12.1", " - c==5.10.0 [requires: e>=0.12.1]", " - a==3.4.0 [requires: c>=5.7.1]", " - d==2.35 [requires: e>=0.9.0]", " - b==2.3.1 [requires: d>=2.30,<2.42]", " - a==3.4.0 [requires: b>=2.0.0]", " - f==3.1 [requires: b>=2.1.0]", " - g==6.8.3rc1 [requires: f>=3.0.0]", " - c==5.10.0 [requires: d>=2.30]", " - a==3.4.0 [requires: c>=5.7.1]", " - g==6.8.3rc1 [requires: e>=0.9.0]", "f==3.1", " - g==6.8.3rc1 [requires: f>=3.0.0]", "g==6.8.3rc1", ], ), ( False, False, False, [ "a==3.4.0", " - b [required: >=2.0.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - c [required: >=5.7.1, installed: 5.10.0]", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - e [required: >=0.12.1, installed: 0.12.1]", "g==6.8.3rc1", " - e [required: >=0.9.0, installed: 0.12.1]", " - f [required: >=3.0.0, installed: 3.1]", " - b [required: >=2.1.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", ], ), ( False, True, False, [ "e==0.12.1", " - c==5.10.0 [requires: e>=0.12.1]", " - a==3.4.0 [requires: c>=5.7.1]", " - d==2.35 [requires: e>=0.9.0]", " - b==2.3.1 [requires: d>=2.30,<2.42]", " - a==3.4.0 [requires: b>=2.0.0]", " - f==3.1 [requires: b>=2.1.0]", " - g==6.8.3rc1 [requires: f>=3.0.0]", " - c==5.10.0 [requires: d>=2.30]", " - a==3.4.0 [requires: c>=5.7.1]", " - g==6.8.3rc1 [requires: e>=0.9.0]", ], ), ], ) def test_render_text( example_dag: PackageDAG, capsys: pytest.CaptureFixture[str], list_all: bool, reverse: bool, unicode: bool, expected_output: list[str], ) -> None: tree = example_dag.reverse() if reverse else example_dag encoding = "utf-8" if unicode else "ascii" render_text(tree, max_depth=float("inf"), encoding=encoding, list_all=list_all) captured = capsys.readouterr() assert "\n".join(expected_output).strip() == captured.out.strip() @pytest.mark.parametrize( ("unicode", "level", "expected_output"), [ ( True, 0, [ "a==3.4.0", "b==2.3.1", "c==5.10.0", "d==2.35", "e==0.12.1", "f==3.1", "g==6.8.3rc1", ], ), ( False, 0, [ "a==3.4.0", "b==2.3.1", "c==5.10.0", "d==2.35", "e==0.12.1", "f==3.1", "g==6.8.3rc1", ], ), ( True, 2, [ "a==3.4.0", "├── b [required: >=2.0.0, installed: 2.3.1]", "│ └── d [required: >=2.30,<2.42, installed: 2.35]", "└── c [required: >=5.7.1, installed: 5.10.0]", " ├── d [required: >=2.30, installed: 2.35]", " └── e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", "└── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", "├── d [required: >=2.30, installed: 2.35]", "│ └── e [required: >=0.9.0, installed: 0.12.1]", "└── e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", "└── e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", "└── b [required: >=2.1.0, installed: 2.3.1]", " └── d [required: >=2.30,<2.42, installed: 2.35]", "g==6.8.3rc1", "├── e [required: >=0.9.0, installed: 0.12.1]", "└── f [required: >=3.0.0, installed: 3.1]", " └── b [required: >=2.1.0, installed: 2.3.1]", ], ), ( False, 2, [ "a==3.4.0", " - b [required: >=2.0.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - c [required: >=5.7.1, installed: 5.10.0]", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", " - e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", " - b [required: >=2.1.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", "g==6.8.3rc1", " - e [required: >=0.9.0, installed: 0.12.1]", " - f [required: >=3.0.0, installed: 3.1]", " - b [required: >=2.1.0, installed: 2.3.1]", ], ), ], ) def test_render_text_given_depth( capsys: pytest.CaptureFixture[str], unicode: str, level: int, expected_output: list[str], example_dag: PackageDAG, ) -> None: render_text(example_dag, max_depth=level, encoding="utf-8" if unicode else "ascii") captured = capsys.readouterr() assert "\n".join(expected_output).strip() == captured.out.strip() @pytest.mark.parametrize( ("level", "encoding", "expected_output"), [ ( 0, "utf-8", [ "a==3.4.0", "b==2.3.1", "c==5.10.0", "d==2.35", "e==0.12.1", "f==3.1", "g==6.8.3rc1", ], ), ( 2, "utf-8", [ "a==3.4.0", "├── b [required: >=2.0.0, installed: 2.3.1]", "│ └── d [required: >=2.30,<2.42, installed: 2.35]", "└── c [required: >=5.7.1, installed: 5.10.0]", " ├── d [required: >=2.30, installed: 2.35]", " └── e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", "└── d [required: >=2.30,<2.42, installed: 2.35]", " └── e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", "├── d [required: >=2.30, installed: 2.35]", "│ └── e [required: >=0.9.0, installed: 0.12.1]", "└── e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", "└── e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", "└── b [required: >=2.1.0, installed: 2.3.1]", " └── d [required: >=2.30,<2.42, installed: 2.35]", "g==6.8.3rc1", "├── e [required: >=0.9.0, installed: 0.12.1]", "└── f [required: >=3.0.0, installed: 3.1]", " └── b [required: >=2.1.0, installed: 2.3.1]", ], ), ( 2, "ascii", [ "a==3.4.0", " - b [required: >=2.0.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", " - c [required: >=5.7.1, installed: 5.10.0]", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.12.1, installed: 0.12.1]", "b==2.3.1", " - d [required: >=2.30,<2.42, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", "c==5.10.0", " - d [required: >=2.30, installed: 2.35]", " - e [required: >=0.9.0, installed: 0.12.1]", " - e [required: >=0.12.1, installed: 0.12.1]", "d==2.35", " - e [required: >=0.9.0, installed: 0.12.1]", "e==0.12.1", "f==3.1", " - b [required: >=2.1.0, installed: 2.3.1]", " - d [required: >=2.30,<2.42, installed: 2.35]", "g==6.8.3rc1", " - e [required: >=0.9.0, installed: 0.12.1]", " - f [required: >=3.0.0, installed: 3.1]", " - b [required: >=2.1.0, installed: 2.3.1]", ], ), ], ) def test_render_text_encoding( capsys: pytest.CaptureFixture[str], level: int, encoding: str, expected_output: list[str], example_dag: PackageDAG, ) -> None: render_text(example_dag, max_depth=level, encoding=encoding, list_all=True) captured = capsys.readouterr() assert "\n".join(expected_output).strip() == captured.out.strip() def test_render_text_list_all_and_packages_options_used( capsys: pytest.CaptureFixture[str], mock_pkgs: Callable[[MockGraph], Iterator[Mock]], ) -> None: graph: MockGraph = { ("examplePy", "1.2.3"): [("hellopy", [(">=", "2.0.0")]), ("worldpy", [(">=", "0.0.2")])], ("HelloPy", "2.0.0"): [], ("worldpy", "0.0.2"): [], ("anotherpy", "0.1.2"): [("hellopy", [(">=", "2.0.0")])], ("YetAnotherPy", "3.1.2"): [], } package_dag = PackageDAG.from_pkgs(list(mock_pkgs(graph))) # NOTE: Mimicking the --packages option being used here. package_dag = package_dag.filter_nodes(["examplePy"], None) render_text(package_dag, max_depth=float("inf"), encoding="utf-8", list_all=True) captured = capsys.readouterr() expected_output = [ "examplePy==1.2.3", "├── HelloPy [required: >=2.0.0, installed: 2.0.0]", "└── worldpy [required: >=0.0.2, installed: 0.0.2]", "HelloPy==2.0.0", "worldpy==0.0.2", ] assert "\n".join(expected_output).strip() == captured.out.strip() @pytest.mark.parametrize( ("encoding", "expected_output"), [ ( "utf-8", [ "a==3.4.0 (TEST)", "└── c [required: ==1.0.0, installed: 1.0.0]", "b==2.3.1 (TEST)", "c==1.0.0 (TEST)", ], ), ( "ascii", [ "a==3.4.0 (TEST)", " - c [required: ==1.0.0, installed: 1.0.0]", "b==2.3.1 (TEST)", "c==1.0.0 (TEST)", ], ), ], ) def test_render_text_with_license_info( encoding: str, expected_output: str, mock_pkgs: Callable[[MockGraph], Iterator[Mock]], capsys: pytest.CaptureFixture[str], monkeypatch: pytest.MonkeyPatch, ) -> None: graph: MockGraph = { ("a", "3.4.0"): [("c", [("==", "1.0.0")])], ("b", "2.3.1"): [], ("c", "1.0.0"): [], } dag = PackageDAG.from_pkgs(list(mock_pkgs(graph))) monkeypatch.setattr(Package, "licenses", lambda _: "(TEST)") render_text(dag, max_depth=float("inf"), encoding=encoding, include_license=True) captured = capsys.readouterr() assert "\n".join(expected_output).strip() == captured.out.strip() @pytest.mark.parametrize( ("encoding", "expected_output"), [ ( "utf-8", [ "a==3.4.0 (TEST)", "b==2.3.1 (TEST)", "└── a==3.4.0 [requires: b==2.3.1]", "c==1.0.0 (TEST)", "├── a==3.4.0 [requires: c==1.0.0]", "└── b==2.3.1 [requires: c==1.0.0]", " └── a==3.4.0 [requires: b==2.3.1]", ], ), ( "ascii", [ "a==3.4.0 (TEST)", "b==2.3.1 (TEST)", " - a==3.4.0 [requires: b==2.3.1]", "c==1.0.0 (TEST)", " - a==3.4.0 [requires: c==1.0.0]", " - b==2.3.1 [requires: c==1.0.0]", " - a==3.4.0 [requires: b==2.3.1]", ], ), ], ) def test_render_text_with_license_info_and_reversed_tree( encoding: str, expected_output: str, mock_pkgs: Callable[[MockGraph], Iterator[Mock]], capsys: pytest.CaptureFixture[str], monkeypatch: pytest.MonkeyPatch, ) -> None: graph: MockGraph = { ("a", "3.4.0"): [("b", [("==", "2.3.1")]), ("c", [("==", "1.0.0")])], ("b", "2.3.1"): [("c", [("==", "1.0.0")])], ("c", "1.0.0"): [], } dag = PackageDAG.from_pkgs(list(mock_pkgs(graph))) dag = dag.reverse() monkeypatch.setattr(Package, "licenses", lambda _: "(TEST)") render_text(dag, max_depth=float("inf"), encoding=encoding, include_license=True) captured = capsys.readouterr() assert "\n".join(expected_output).strip() == captured.out.strip()