Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --max-depth option to control diagram complexity #10077

Merged
merged 20 commits into from
Jan 24, 2025
Merged

Add --max-depth option to control diagram complexity #10077

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
af5fc28
Add command line option to limit depth
Julfried Nov 11, 2024
0c159a1
Update writer to only show modules below max depth setting
Julfried Nov 11, 2024
b421afa
Update PyreverseConfig in testutils
Julfried Nov 11, 2024
da49687
Improve depth logic for classes
Julfried Nov 11, 2024
f35d822
Update docs
Julfried Nov 11, 2024
39e0eac
Update docstring for the should_show_node function
Julfried Dec 14, 2024
f2a9299
Add tests for should_show_node method
Julfried Dec 14, 2024
1f31feb
Added a news fragment
Julfried Dec 14, 2024
2006bb7
Remove file extension
Julfried Dec 14, 2024
1c107ee
Fix typo in docstring
Julfried Dec 14, 2024
4be3aa7
Update tests/pyreverse/test_writer.py
Pierre-Sassoulas Dec 25, 2024
6defb5f
Update tests/pyreverse/test_writer.py
Pierre-Sassoulas Dec 25, 2024
88f3a9d
Try to increase test coverage
Julfried Dec 26, 2024
35c062c
Refactor test_depth_limited_write to set max depth in default config
Julfried Jan 5, 2025
907479b
Use proper fixtures to setup depth limited tests
Julfried Jan 5, 2025
012d136
Also assert class diagram
Julfried Jan 5, 2025
24fdc46
Remove old test files
Julfried Jan 5, 2025
59a720e
Test writer with multiple depth limits
Julfried Jan 5, 2025
85722e6
Add subpkg and MyClass to spelling ignore list
Julfried Jan 5, 2025
94a3898
Move --max-depth option to option group "Filtering and Scope"
Julfried Jan 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Also assert class diagram
  • Loading branch information
@Julfried
Julfried committed Jan 5, 2025
commit 012d1361f661f6d754d6235cf0deb6c30765c428
17 changes: 17 additions & 0 deletions tests/pyreverse/data/classes_depth_limited.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
digraph "classes_depth_limited" {
rankdir=BT
charset="utf-8"
"data.clientmodule_test.Ancestor" [color="black", fontcolor="black", label=<{Ancestor|attr : str<br ALIGN="LEFT"/>cls_member<br ALIGN="LEFT"/>|get_value()<br ALIGN="LEFT"/>set_value(value)<br ALIGN="LEFT"/>}>, shape="record", style="solid"];
"data.suppliermodule_test.CustomException" [color="black", fontcolor="red", label=<{CustomException|<br ALIGN="LEFT"/>|}>, shape="record", style="solid"];
"data.suppliermodule_test.DoNothing" [color="black", fontcolor="black", label=<{DoNothing|<br ALIGN="LEFT"/>|}>, shape="record", style="solid"];
"data.suppliermodule_test.DoNothing2" [color="black", fontcolor="black", label=<{DoNothing2|<br ALIGN="LEFT"/>|}>, shape="record", style="solid"];
"data.suppliermodule_test.DoSomething" [color="black", fontcolor="black", label=<{DoSomething|my_int : Optional[int]<br ALIGN="LEFT"/>my_int_2 : Optional[int]<br ALIGN="LEFT"/>my_string : str<br ALIGN="LEFT"/>|do_it(new_int: int): int<br ALIGN="LEFT"/>}>, shape="record", style="solid"];
"data.suppliermodule_test.Interface" [color="black", fontcolor="black", label=<{Interface|<br ALIGN="LEFT"/>|<I>get_value</I>()<br ALIGN="LEFT"/><I>set_value</I>(value)<br ALIGN="LEFT"/>}>, shape="record", style="solid"];
"data.nullable_pattern.NullablePatterns" [color="black", fontcolor="black", label=<{NullablePatterns|<br ALIGN="LEFT"/>|<I>return_nullable_1</I>(): int \| None<br ALIGN="LEFT"/><I>return_nullable_2</I>(): Optional[int]<br ALIGN="LEFT"/>}>, shape="record", style="solid"];
"data.property_pattern.PropertyPatterns" [color="black", fontcolor="black", label=<{PropertyPatterns|prop1<br ALIGN="LEFT"/>prop2<br ALIGN="LEFT"/>|}>, shape="record", style="solid"];
"data.clientmodule_test.Specialization" [color="black", fontcolor="black", label=<{Specialization|TYPE : str<br ALIGN="LEFT"/>relation<br ALIGN="LEFT"/>relation2<br ALIGN="LEFT"/>top : str<br ALIGN="LEFT"/>|from_value(value: int)<br ALIGN="LEFT"/>increment_value(): None<br ALIGN="LEFT"/>transform_value(value: int): int<br ALIGN="LEFT"/>}>, shape="record", style="solid"];
"data.clientmodule_test.Specialization" -> "data.clientmodule_test.Ancestor" [arrowhead="empty", arrowtail="none"];
"data.suppliermodule_test.DoNothing" -> "data.clientmodule_test.Ancestor" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="cls_member", style="solid"];
"data.suppliermodule_test.DoNothing" -> "data.clientmodule_test.Specialization" [arrowhead="diamond", arrowtail="none", fontcolor="green", label="relation", style="solid"];
"data.suppliermodule_test.DoNothing2" -> "data.clientmodule_test.Specialization" [arrowhead="odiamond", arrowtail="none", fontcolor="green", label="relation2", style="solid"];
}
1 change: 1 addition & 0 deletions tests/pyreverse/test_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ def test_colorized_puml_files(generated_file: str) -> None:
def test_depth_limited_write() -> None:
"""Test package diagram generation with a depth limit of 1."""
_assert_files_are_equal("packages_depth_limited.dot")
_assert_files_are_equal("classes_depth_limited.dot")


def _assert_files_are_equal(generated_file: str) -> None:
Expand Down