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.

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

Move PyreverseConfig to pylint.testutil #5013

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions pylint/testutils/pyreverse.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE

from typing import List, Optional, Tuple


# This class could and should be replaced with a simple dataclass when support for Python < 3.7 is dropped.
# A NamedTuple is not possible as some tests need to modify attributes during the test.
class PyreverseConfig: # pylint: disable=too-many-instance-attributes, too-many-arguments
"""Holds the configuration options for Pyreverse.
The default values correspond to the defaults of the options parser."""

def __init__(
self,
mode: str = "PUB_ONLY",
classes: Optional[List[str]] = None,
show_ancestors: Optional[int] = None,
all_ancestors: Optional[bool] = None,
show_associated: Optional[int] = None,
all_associated: Optional[bool] = None,
show_builtin: bool = False,
module_names: Optional[bool] = None,
only_classnames: bool = False,
output_format: str = "dot",
colorized: bool = False,
max_color_depth: int = 2,
ignore_list: Tuple = tuple(),
project: str = "",
output_directory: str = "",
):
self.mode = mode
if classes:
self.classes = classes
else:
self.classes = []
self.show_ancestors = show_ancestors
self.all_ancestors = all_ancestors
self.show_associated = show_associated
self.all_associated = all_associated
self.show_builtin = show_builtin
self.module_names = module_names
self.only_classnames = only_classnames
self.output_format = output_format
self.colorized = colorized
self.max_color_depth = max_color_depth
self.ignore_list = ignore_list
self.project = project
self.output_directory = output_directory
47 changes: 2 additions & 45 deletions tests/pyreverse/conftest.py
Original file line number Diff line number Diff line change
@@ -1,53 +1,10 @@
from typing import Callable, List, Optional, Tuple
from typing import Callable, Optional

import pytest
from astroid.nodes.scoped_nodes import Module

from pylint.pyreverse.inspector import Project, project_from_files


# This class could and should be replaced with a simple dataclass when support for Python < 3.7 is dropped.
# A NamedTuple is not possible as some tests need to modify attributes during the test.
class PyreverseConfig: # pylint: disable=too-many-instance-attributes, too-many-arguments
"""Holds the configuration options for Pyreverse.
The default values correspond to the defaults of the options parser."""

def __init__(
self,
mode: str = "PUB_ONLY",
classes: Optional[List[str]] = None,
show_ancestors: Optional[int] = None,
all_ancestors: Optional[bool] = None,
show_associated: Optional[int] = None,
all_associated: Optional[bool] = None,
show_builtin: bool = False,
module_names: Optional[bool] = None,
only_classnames: bool = False,
output_format: str = "dot",
colorized: bool = False,
max_color_depth: int = 2,
ignore_list: Tuple = tuple(),
project: str = "",
output_directory: str = "",
):
self.mode = mode
if classes:
self.classes = classes
else:
self.classes = []
self.show_ancestors = show_ancestors
self.all_ancestors = all_ancestors
self.show_associated = show_associated
self.all_associated = all_associated
self.show_builtin = show_builtin
self.module_names = module_names
self.only_classnames = only_classnames
self.output_format = output_format
self.colorized = colorized
self.max_color_depth = max_color_depth
self.ignore_list = ignore_list
self.project = project
self.output_directory = output_directory
from pylint.testutils.pyreverse import PyreverseConfig


@pytest.fixture()
Expand Down
2 changes: 1 addition & 1 deletion tests/pyreverse/test_diadefs.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@

import pytest
from astroid import nodes
from tests.pyreverse.conftest import PyreverseConfig

from pylint.pyreverse.diadefslib import (
ClassDiadefGenerator,
Expand All @@ -36,6 +35,7 @@
)
from pylint.pyreverse.diagrams import DiagramEntity, Relationship
from pylint.pyreverse.inspector import Linker, Project
from pylint.testutils.pyreverse import PyreverseConfig


def _process_classes(classes: List[DiagramEntity]) -> List[Tuple[bool, str]]:
Expand Down
2 changes: 1 addition & 1 deletion tests/pyreverse/test_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
from unittest.mock import Mock

import pytest
from tests.pyreverse.conftest import PyreverseConfig

from pylint.pyreverse.diadefslib import DefaultDiadefGenerator, DiadefsHandler
from pylint.pyreverse.inspector import Linker, Project
from pylint.pyreverse.writer import DiagramWriter
from pylint.testutils.pyreverse import PyreverseConfig

_DEFAULTS = {
"all_ancestors": None,
Expand Down