Fix Pyreverse: Aggregations aren't filtered according to filter mode (PUB_ONLY, etc.) (#10379) (#10401)

pylint-backport-bot[bot] · pavan-msys · pre-commit-ci[bot] · web-flow · commit 51234e556d7c · 2025-05-21T17:45:16.000Z
* updated diagrams.py file * added tests * updated tests * added test cases * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- (cherry picked from commit ed59632) Co-authored-by: pavan-msys <149513767+pavan-msys@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/doc/whatsnew/fragments/10373.bugfix b/doc/whatsnew/fragments/10373.bugfix
@@ -0,0 +1,3 @@
+Fix a bug in Pyreverse where aggregations and associations were included in diagrams regardless of the selected --filter-mode (such as PUB_ONLY, ALL, etc.).
+
+Closes #10373
diff --git a/pylint/pyreverse/diagrams.py b/pylint/pyreverse/diagrams.py
@@ -221,6 +221,9 @@ def extract_relationships(self) -> None:
             # associations & aggregations links
             for name, values in list(node.aggregations_type.items()):
                 for value in values:
+                    if not self.show_attr(name):
+                        continue
+
                     self.assign_association_relationship(
                         value, obj, name, "aggregation"
                     )
@@ -233,6 +236,9 @@ def extract_relationships(self) -> None:
 
             for name, values in associations.items():
                 for value in values:
+                    if not self.show_attr(name):
+                        continue
+
                     self.assign_association_relationship(
                         value, obj, name, "association"
                     )
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.mmd b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.mmd
@@ -0,0 +1,25 @@
+classDiagram
+  class P {
+    name : str
+    __init__(name: str)
+  }
+  class PrivateAttr {
+    __x
+    __init__()
+  }
+  class ProtectedAttr {
+    _x
+    __init__()
+  }
+  class PublicAttr {
+    x
+    __init__()
+  }
+  class SpecialAttr {
+    __x__
+    __init__()
+  }
+  P --* PrivateAttr : __x
+  P --* ProtectedAttr : _x
+  P --* PublicAttr : x
+  P --* SpecialAttr : __x__
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.py b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.py
@@ -0,0 +1,23 @@
+class P:
+    def __init__(self, name: str):
+        self.name = name
+
+
+class PrivateAttr:
+    def __init__(self):
+        self.__x = P("private")
+
+
+class ProtectedAttr:
+    def __init__(self):
+        self._x = P("protected")
+
+
+class PublicAttr:
+    def __init__(self):
+        self.x = P("public")
+
+
+class SpecialAttr:
+    def __init__(self):
+        self.__x__ = P("special")
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.rc b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/all.rc
@@ -0,0 +1,2 @@
+[testoptions]
+command_line_args=--filter-mode=ALL
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.mmd b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.mmd
@@ -0,0 +1,21 @@
+classDiagram
+  class P {
+    name : str
+    __init__(name: str)
+  }
+  class PrivateAttr {
+    __init__()
+  }
+  class ProtectedAttr {
+    __init__()
+  }
+  class PublicAttr {
+    x
+    __init__()
+  }
+  class SpecialAttr {
+    __x__
+    __init__()
+  }
+  P --* PublicAttr : x
+  P --* SpecialAttr : __x__
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.py b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.py
@@ -0,0 +1,23 @@
+class P:
+    def __init__(self, name: str):
+        self.name = name
+
+
+class PrivateAttr:
+    def __init__(self):
+        self.__x = P("private")
+
+
+class ProtectedAttr:
+    def __init__(self):
+        self._x = P("protected")
+
+
+class PublicAttr:
+    def __init__(self):
+        self.x = P("public")
+
+
+class SpecialAttr:
+    def __init__(self):
+        self.__x__ = P("special")
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.rc b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/other.rc
@@ -0,0 +1,2 @@
+[testoptions]
+command_line_args=--filter-mode=OTHER
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.mmd b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.mmd
@@ -0,0 +1,14 @@
+classDiagram
+  class P {
+    name : str
+  }
+  class PrivateAttr {
+  }
+  class ProtectedAttr {
+  }
+  class PublicAttr {
+    x
+  }
+  class SpecialAttr {
+  }
+  P --* PublicAttr : x
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.py b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.py
@@ -0,0 +1,23 @@
+class P:
+    def __init__(self, name: str):
+        self.name = name
+
+
+class PrivateAttr:
+    def __init__(self):
+        self.__x = P("private")
+
+
+class ProtectedAttr:
+    def __init__(self):
+        self._x = P("protected")
+
+
+class PublicAttr:
+    def __init__(self):
+        self.x = P("public")
+
+
+class SpecialAttr:
+    def __init__(self):
+        self.__x__ = P("special")
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.rc b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/pub_only.rc
@@ -0,0 +1,2 @@
+[testoptions]
+command_line_args=--filter-mode=PUB_ONLY
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.mmd b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.mmd
@@ -0,0 +1,18 @@
+classDiagram
+  class P {
+    name : str
+  }
+  class PrivateAttr {
+    __x
+  }
+  class ProtectedAttr {
+    _x
+  }
+  class PublicAttr {
+    x
+  }
+  class SpecialAttr {
+  }
+  P --* PrivateAttr : __x
+  P --* ProtectedAttr : _x
+  P --* PublicAttr : x
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.py b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.py
@@ -0,0 +1,23 @@
+class P:
+    def __init__(self, name: str):
+        self.name = name
+
+
+class PrivateAttr:
+    def __init__(self):
+        self.__x = P("private")
+
+
+class ProtectedAttr:
+    def __init__(self):
+        self._x = P("protected")
+
+
+class PublicAttr:
+    def __init__(self):
+        self.x = P("public")
+
+
+class SpecialAttr:
+    def __init__(self):
+        self.__x__ = P("special")
diff --git a/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.rc b/tests/pyreverse/functional/class_diagrams/aggregation_filtering/special.rc
@@ -0,0 +1,2 @@
+[testoptions]
+command_line_args=--filter-mode=SPECIAL

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Fix a bug in Pyreverse where aggregations and associations were included in diagrams regardless of the selected --filter-mode (such as PUB_ONLY, ALL, etc.).`
	`2`	`+`
	`3`	`+Closes #10373`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[testoptions]`
	`2`	`+command_line_args=--filter-mode=ALL`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[testoptions]`
	`2`	`+command_line_args=--filter-mode=OTHER`