From 665eaf7d2a9a236c6a86697f2598f2e9a8626212 Mon Sep 17 00:00:00 2001 From: LudoBroche Date: Thu, 8 Oct 2026 14:12:06 +0200 Subject: [PATCH] Issue #14 Renamed module to make them private --- examples/convert_ewoks_to_elk_graph.py | 16 ++++++------ examples/cubic_bezier_link.py | 10 +++---- pyproject.toml | 4 +-- src/ewoksdraw/{config => _config}/__init__.py | 0 .../{config => _config}/constants.py | 0 .../css_background.css | 0 .../css_link_cubic_bezier.css | 0 .../css_task_anchor_link.css | 0 .../css_task_box.css | 0 .../css_task_line.css | 0 .../css_task_text_io.css | 0 .../css_task_title.css | 0 .../{css_styles => _css_styles}/root.css | 0 .../{geometry => _geometry}/__init__.py | 0 .../cubic_bezier_path.py | 0 src/ewoksdraw/{layout => _layout}/__init__.py | 0 .../{layout => _layout}/elk_backend.py | 2 +- .../{layout => _layout}/elk_converter.py | 24 ++++++++--------- .../elk_link_group_builder.py | 14 +++++----- src/ewoksdraw/{models.py => _models.py} | 0 src/ewoksdraw/{svg => _svg}/__init__.py | 0 src/ewoksdraw/{svg => _svg}/svg_background.py | 2 +- src/ewoksdraw/{svg => _svg}/svg_canvas.py | 0 src/ewoksdraw/{svg => _svg}/svg_element.py | 2 +- src/ewoksdraw/{svg => _svg}/svg_group.py | 0 .../{svg => _svg}/svg_link_cubic_bezier.py | 2 +- src/ewoksdraw/{svg => _svg}/svg_task.py | 4 +-- .../{svg => _svg}/svg_task_anchor_link.py | 0 src/ewoksdraw/{svg => _svg}/svg_task_box.py | 4 +-- src/ewoksdraw/{svg => _svg}/svg_task_group.py | 0 src/ewoksdraw/{svg => _svg}/svg_task_io.py | 8 +++--- src/ewoksdraw/{svg => _svg}/svg_task_line.py | 0 src/ewoksdraw/{svg => _svg}/svg_task_title.py | 8 +++--- src/ewoksdraw/{svg => _svg}/svg_text.py | 0 src/ewoksdraw/{svg => _svg}/utils.py | 2 +- src/ewoksdraw/{tests => _tests}/__init__.py | 0 .../resources/workflow1.json | 0 .../test_cubic_bezier_path.py | 14 +++++----- .../{tests => _tests}/test_elk_backend.py | 4 +-- .../{tests => _tests}/test_elk_converter.py | 26 +++++++++---------- .../{tests => _tests}/test_elk_rs_binding.py | 8 +++--- .../{tests => _tests}/test_graph_to_svg.py | 0 .../test_svg_link_cubic_bezier.py | 6 ++--- .../test_svg_path_integration.py | 10 +++---- .../{tests => _tests}/test_svg_task.py | 2 +- src/ewoksdraw/{tests => _tests}/test_utils.py | 8 +++--- src/ewoksdraw/{utils.py => _utils.py} | 2 +- src/ewoksdraw/graph_to_svg.py | 26 +++++++++---------- 48 files changed, 104 insertions(+), 104 deletions(-) rename src/ewoksdraw/{config => _config}/__init__.py (100%) rename src/ewoksdraw/{config => _config}/constants.py (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_background.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_link_cubic_bezier.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_task_anchor_link.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_task_box.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_task_line.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_task_text_io.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/css_task_title.css (100%) rename src/ewoksdraw/{css_styles => _css_styles}/root.css (100%) rename src/ewoksdraw/{geometry => _geometry}/__init__.py (100%) rename src/ewoksdraw/{geometry => _geometry}/cubic_bezier_path.py (100%) rename src/ewoksdraw/{layout => _layout}/__init__.py (100%) rename src/ewoksdraw/{layout => _layout}/elk_backend.py (94%) rename src/ewoksdraw/{layout => _layout}/elk_converter.py (91%) rename src/ewoksdraw/{layout => _layout}/elk_link_group_builder.py (86%) rename src/ewoksdraw/{models.py => _models.py} (100%) rename src/ewoksdraw/{svg => _svg}/__init__.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_background.py (85%) rename src/ewoksdraw/{svg => _svg}/svg_canvas.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_element.py (97%) rename src/ewoksdraw/{svg => _svg}/svg_group.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_link_cubic_bezier.py (97%) rename src/ewoksdraw/{svg => _svg}/svg_task.py (98%) rename src/ewoksdraw/{svg => _svg}/svg_task_anchor_link.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_task_box.py (90%) rename src/ewoksdraw/{svg => _svg}/svg_task_group.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_task_io.py (97%) rename src/ewoksdraw/{svg => _svg}/svg_task_line.py (100%) rename src/ewoksdraw/{svg => _svg}/svg_task_title.py (87%) rename src/ewoksdraw/{svg => _svg}/svg_text.py (100%) rename src/ewoksdraw/{svg => _svg}/utils.py (88%) rename src/ewoksdraw/{tests => _tests}/__init__.py (100%) rename src/ewoksdraw/{tests => _tests}/resources/workflow1.json (100%) rename src/ewoksdraw/{tests => _tests}/test_cubic_bezier_path.py (87%) rename src/ewoksdraw/{tests => _tests}/test_elk_backend.py (88%) rename src/ewoksdraw/{tests => _tests}/test_elk_converter.py (94%) rename src/ewoksdraw/{tests => _tests}/test_elk_rs_binding.py (97%) rename src/ewoksdraw/{tests => _tests}/test_graph_to_svg.py (100%) rename src/ewoksdraw/{tests => _tests}/test_svg_link_cubic_bezier.py (92%) rename src/ewoksdraw/{tests => _tests}/test_svg_path_integration.py (82%) rename src/ewoksdraw/{tests => _tests}/test_svg_task.py (91%) rename src/ewoksdraw/{tests => _tests}/test_utils.py (72%) rename src/ewoksdraw/{utils.py => _utils.py} (98%) diff --git a/examples/convert_ewoks_to_elk_graph.py b/examples/convert_ewoks_to_elk_graph.py index 44bcf60..1e4037d 100644 --- a/examples/convert_ewoks_to_elk_graph.py +++ b/examples/convert_ewoks_to_elk_graph.py @@ -3,18 +3,18 @@ from ewokscore import load_graph from ewokscore.tests.examples.graphs import get_graph -from ewoksdraw.graph_to_svg import build_svg_task_group -from ewoksdraw.layout.elk_converter import ElkGraphBeforeLayout -from ewoksdraw.layout.elk_converter import convert_ewoks_to_elk_graph -from ewoksdraw.svg.svg_task_group import SvgTaskGroup -from ewoksdraw.svg.svg_task_group import TaskInputPositions -from ewoksdraw.svg.svg_task_group import TaskOutputPositions -from ewoksdraw.svg.svg_task_group import TaskSizes +from ewoksdraw._layout.elk_converter import ElkGraphBeforeLayout +from ewoksdraw._layout.elk_converter import convert_ewoks_to_elk_graph +from ewoksdraw._svg.svg_task_group import SvgTaskGroup +from ewoksdraw._svg.svg_task_group import TaskInputPositions +from ewoksdraw._svg.svg_task_group import TaskOutputPositions +from ewoksdraw._svg.svg_task_group import TaskSizes +from ewoksdraw.graph_to_svg import _build_svg_task_group graph_description, _ = get_graph("acyclic1") ewoks_graph = load_graph(graph_description) -svg_task_group: SvgTaskGroup = build_svg_task_group(ewoks_graph) +svg_task_group: SvgTaskGroup = _build_svg_task_group(ewoks_graph) task_sizes: TaskSizes = svg_task_group.extract_task_sizes() task_input_positions: TaskInputPositions = svg_task_group.extract_input_positions() task_output_positions: TaskOutputPositions = svg_task_group.extract_output_positions() diff --git a/examples/cubic_bezier_link.py b/examples/cubic_bezier_link.py index 3ccceaf..cc2d6d7 100644 --- a/examples/cubic_bezier_link.py +++ b/examples/cubic_bezier_link.py @@ -1,11 +1,11 @@ import copy from pathlib import Path -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierPath -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierSegment -from ewoksdraw.svg.svg_canvas import SvgCanvas -from ewoksdraw.svg.svg_group import SvgGroup -from ewoksdraw.svg.svg_link_cubic_bezier import SvgLinkCubicBezier +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierPath +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierSegment +from ewoksdraw._svg.svg_canvas import SvgCanvas +from ewoksdraw._svg.svg_group import SvgGroup +from ewoksdraw._svg.svg_link_cubic_bezier import SvgLinkCubicBezier output_path = Path(__file__).with_suffix(".svg") diff --git a/pyproject.toml b/pyproject.toml index a5446e7..9e751a9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,7 +68,7 @@ include = [ ] [tool.coverage.run] -omit = ["*/tests/*"] +omit = ["*/_tests/*"] [tool.ruff] src = ["."] @@ -83,7 +83,7 @@ select = [ ] [tool.ruff.lint.per-file-ignores] -"src/ewoksdraw/tests/*.py" = [ +"src/ewoksdraw/_tests/*.py" = [ "S101", # allow asserts ] diff --git a/src/ewoksdraw/config/__init__.py b/src/ewoksdraw/_config/__init__.py similarity index 100% rename from src/ewoksdraw/config/__init__.py rename to src/ewoksdraw/_config/__init__.py diff --git a/src/ewoksdraw/config/constants.py b/src/ewoksdraw/_config/constants.py similarity index 100% rename from src/ewoksdraw/config/constants.py rename to src/ewoksdraw/_config/constants.py diff --git a/src/ewoksdraw/css_styles/css_background.css b/src/ewoksdraw/_css_styles/css_background.css similarity index 100% rename from src/ewoksdraw/css_styles/css_background.css rename to src/ewoksdraw/_css_styles/css_background.css diff --git a/src/ewoksdraw/css_styles/css_link_cubic_bezier.css b/src/ewoksdraw/_css_styles/css_link_cubic_bezier.css similarity index 100% rename from src/ewoksdraw/css_styles/css_link_cubic_bezier.css rename to src/ewoksdraw/_css_styles/css_link_cubic_bezier.css diff --git a/src/ewoksdraw/css_styles/css_task_anchor_link.css b/src/ewoksdraw/_css_styles/css_task_anchor_link.css similarity index 100% rename from src/ewoksdraw/css_styles/css_task_anchor_link.css rename to src/ewoksdraw/_css_styles/css_task_anchor_link.css diff --git a/src/ewoksdraw/css_styles/css_task_box.css b/src/ewoksdraw/_css_styles/css_task_box.css similarity index 100% rename from src/ewoksdraw/css_styles/css_task_box.css rename to src/ewoksdraw/_css_styles/css_task_box.css diff --git a/src/ewoksdraw/css_styles/css_task_line.css b/src/ewoksdraw/_css_styles/css_task_line.css similarity index 100% rename from src/ewoksdraw/css_styles/css_task_line.css rename to src/ewoksdraw/_css_styles/css_task_line.css diff --git a/src/ewoksdraw/css_styles/css_task_text_io.css b/src/ewoksdraw/_css_styles/css_task_text_io.css similarity index 100% rename from src/ewoksdraw/css_styles/css_task_text_io.css rename to src/ewoksdraw/_css_styles/css_task_text_io.css diff --git a/src/ewoksdraw/css_styles/css_task_title.css b/src/ewoksdraw/_css_styles/css_task_title.css similarity index 100% rename from src/ewoksdraw/css_styles/css_task_title.css rename to src/ewoksdraw/_css_styles/css_task_title.css diff --git a/src/ewoksdraw/css_styles/root.css b/src/ewoksdraw/_css_styles/root.css similarity index 100% rename from src/ewoksdraw/css_styles/root.css rename to src/ewoksdraw/_css_styles/root.css diff --git a/src/ewoksdraw/geometry/__init__.py b/src/ewoksdraw/_geometry/__init__.py similarity index 100% rename from src/ewoksdraw/geometry/__init__.py rename to src/ewoksdraw/_geometry/__init__.py diff --git a/src/ewoksdraw/geometry/cubic_bezier_path.py b/src/ewoksdraw/_geometry/cubic_bezier_path.py similarity index 100% rename from src/ewoksdraw/geometry/cubic_bezier_path.py rename to src/ewoksdraw/_geometry/cubic_bezier_path.py diff --git a/src/ewoksdraw/layout/__init__.py b/src/ewoksdraw/_layout/__init__.py similarity index 100% rename from src/ewoksdraw/layout/__init__.py rename to src/ewoksdraw/_layout/__init__.py diff --git a/src/ewoksdraw/layout/elk_backend.py b/src/ewoksdraw/_layout/elk_backend.py similarity index 94% rename from src/ewoksdraw/layout/elk_backend.py rename to src/ewoksdraw/_layout/elk_backend.py index dc3ad5d..5707e21 100644 --- a/src/ewoksdraw/layout/elk_backend.py +++ b/src/ewoksdraw/_layout/elk_backend.py @@ -2,7 +2,7 @@ from typing import cast from ewoksdraw import _elk_rs -from ewoksdraw.config.constants import ELK_LAYOUT_OPTIONS +from ewoksdraw._config.constants import ELK_LAYOUT_OPTIONS from .elk_converter import ElkGraph from .elk_converter import ElkGraphBeforeLayout diff --git a/src/ewoksdraw/layout/elk_converter.py b/src/ewoksdraw/_layout/elk_converter.py similarity index 91% rename from src/ewoksdraw/layout/elk_converter.py rename to src/ewoksdraw/_layout/elk_converter.py index 82c0484..a000abc 100644 --- a/src/ewoksdraw/layout/elk_converter.py +++ b/src/ewoksdraw/_layout/elk_converter.py @@ -8,18 +8,18 @@ from ewokscore.graph import TaskGraph -from ewoksdraw.config.constants import ELK_LAYOUT_OPTIONS - -from ..geometry.cubic_bezier_path import Point -from ..svg.svg_task import TaskIOPosition -from ..svg.svg_task import TaskPosition -from ..svg.svg_task_group import TaskInputPositions -from ..svg.svg_task_group import TaskOutputPositions -from ..svg.svg_task_group import TaskPositions -from ..svg.svg_task_group import TaskSizes -from ..utils import get_edge_source_id -from ..utils import get_edge_target_id -from ..utils import get_valid_data_mappings +from ewoksdraw._config.constants import ELK_LAYOUT_OPTIONS + +from .._geometry.cubic_bezier_path import Point +from .._svg.svg_task import TaskIOPosition +from .._svg.svg_task import TaskPosition +from .._svg.svg_task_group import TaskInputPositions +from .._svg.svg_task_group import TaskOutputPositions +from .._svg.svg_task_group import TaskPositions +from .._svg.svg_task_group import TaskSizes +from .._utils import get_edge_source_id +from .._utils import get_edge_target_id +from .._utils import get_valid_data_mappings class ElkPort(TypedDict): diff --git a/src/ewoksdraw/layout/elk_link_group_builder.py b/src/ewoksdraw/_layout/elk_link_group_builder.py similarity index 86% rename from src/ewoksdraw/layout/elk_link_group_builder.py rename to src/ewoksdraw/_layout/elk_link_group_builder.py index c7a0f91..9d4a0ef 100644 --- a/src/ewoksdraw/layout/elk_link_group_builder.py +++ b/src/ewoksdraw/_layout/elk_link_group_builder.py @@ -1,10 +1,10 @@ -from ..config.constants import LINK_TURN_RADIUS -from ..geometry.cubic_bezier_path import CubicBezierPath -from ..geometry.cubic_bezier_path import Point -from ..svg.svg_group import SvgGroup -from ..svg.svg_link_cubic_bezier import SvgLinkCubicBezier -from ..utils import get_task_id_from_source_id -from ..utils import get_task_id_from_target_id +from .._config.constants import LINK_TURN_RADIUS +from .._geometry.cubic_bezier_path import CubicBezierPath +from .._geometry.cubic_bezier_path import Point +from .._svg.svg_group import SvgGroup +from .._svg.svg_link_cubic_bezier import SvgLinkCubicBezier +from .._utils import get_task_id_from_source_id +from .._utils import get_task_id_from_target_id from .elk_converter import ElkEdge from .elk_converter import ElkGraph from .elk_converter import ElkSection diff --git a/src/ewoksdraw/models.py b/src/ewoksdraw/_models.py similarity index 100% rename from src/ewoksdraw/models.py rename to src/ewoksdraw/_models.py diff --git a/src/ewoksdraw/svg/__init__.py b/src/ewoksdraw/_svg/__init__.py similarity index 100% rename from src/ewoksdraw/svg/__init__.py rename to src/ewoksdraw/_svg/__init__.py diff --git a/src/ewoksdraw/svg/svg_background.py b/src/ewoksdraw/_svg/svg_background.py similarity index 85% rename from src/ewoksdraw/svg/svg_background.py rename to src/ewoksdraw/_svg/svg_background.py index 02b0c4c..af15292 100644 --- a/src/ewoksdraw/svg/svg_background.py +++ b/src/ewoksdraw/_svg/svg_background.py @@ -4,7 +4,7 @@ class SvgBackground(SvgElement): """ Represents a background rectangle element in SVG. - Color can be set using the ./css_styles/css_background.css + Color can be set using the ./_css_styles/css_background.css style. """ diff --git a/src/ewoksdraw/svg/svg_canvas.py b/src/ewoksdraw/_svg/svg_canvas.py similarity index 100% rename from src/ewoksdraw/svg/svg_canvas.py rename to src/ewoksdraw/_svg/svg_canvas.py diff --git a/src/ewoksdraw/svg/svg_element.py b/src/ewoksdraw/_svg/svg_element.py similarity index 97% rename from src/ewoksdraw/svg/svg_element.py rename to src/ewoksdraw/_svg/svg_element.py index db86be0..15908ff 100644 --- a/src/ewoksdraw/svg/svg_element.py +++ b/src/ewoksdraw/_svg/svg_element.py @@ -16,7 +16,7 @@ class SvgElement: :param tag: The SVG tag (e.g., 'rect', 'circle', 'text'). :param css_class: The CSS class to apply to the SVG element. - Should match a CSS file in the css_styles directory. + Should match a CSS file in the _css_styles directory. :param attr: A dictionary of svg attributes """ diff --git a/src/ewoksdraw/svg/svg_group.py b/src/ewoksdraw/_svg/svg_group.py similarity index 100% rename from src/ewoksdraw/svg/svg_group.py rename to src/ewoksdraw/_svg/svg_group.py diff --git a/src/ewoksdraw/svg/svg_link_cubic_bezier.py b/src/ewoksdraw/_svg/svg_link_cubic_bezier.py similarity index 97% rename from src/ewoksdraw/svg/svg_link_cubic_bezier.py rename to src/ewoksdraw/_svg/svg_link_cubic_bezier.py index f612bcc..554736c 100644 --- a/src/ewoksdraw/svg/svg_link_cubic_bezier.py +++ b/src/ewoksdraw/_svg/svg_link_cubic_bezier.py @@ -1,4 +1,4 @@ -from ..geometry.cubic_bezier_path import CubicBezierPath +from .._geometry.cubic_bezier_path import CubicBezierPath from .svg_element import SvgElement diff --git a/src/ewoksdraw/svg/svg_task.py b/src/ewoksdraw/_svg/svg_task.py similarity index 98% rename from src/ewoksdraw/svg/svg_task.py rename to src/ewoksdraw/_svg/svg_task.py index 99372f2..baa9ca4 100644 --- a/src/ewoksdraw/svg/svg_task.py +++ b/src/ewoksdraw/_svg/svg_task.py @@ -1,7 +1,7 @@ from typing import NamedTuple -from ..config.constants import IO_INTER_IO_MARGIN -from ..config.constants import IO_TOP_MARGIN +from .._config.constants import IO_INTER_IO_MARGIN +from .._config.constants import IO_TOP_MARGIN from .svg_group import SvgGroup from .svg_task_box import SvgTaskBox from .svg_task_io import SvgTaskIOGroup diff --git a/src/ewoksdraw/svg/svg_task_anchor_link.py b/src/ewoksdraw/_svg/svg_task_anchor_link.py similarity index 100% rename from src/ewoksdraw/svg/svg_task_anchor_link.py rename to src/ewoksdraw/_svg/svg_task_anchor_link.py diff --git a/src/ewoksdraw/svg/svg_task_box.py b/src/ewoksdraw/_svg/svg_task_box.py similarity index 90% rename from src/ewoksdraw/svg/svg_task_box.py rename to src/ewoksdraw/_svg/svg_task_box.py index bca00df..2e28809 100644 --- a/src/ewoksdraw/svg/svg_task_box.py +++ b/src/ewoksdraw/_svg/svg_task_box.py @@ -1,5 +1,5 @@ -from ..config.constants import BOX_MAX_WIDTH -from ..config.constants import BOX_MIN_WIDTH +from .._config.constants import BOX_MAX_WIDTH +from .._config.constants import BOX_MIN_WIDTH from .svg_element import SvgElement diff --git a/src/ewoksdraw/svg/svg_task_group.py b/src/ewoksdraw/_svg/svg_task_group.py similarity index 100% rename from src/ewoksdraw/svg/svg_task_group.py rename to src/ewoksdraw/_svg/svg_task_group.py diff --git a/src/ewoksdraw/svg/svg_task_io.py b/src/ewoksdraw/_svg/svg_task_io.py similarity index 97% rename from src/ewoksdraw/svg/svg_task_io.py rename to src/ewoksdraw/_svg/svg_task_io.py index 79eca92..36eb15c 100644 --- a/src/ewoksdraw/svg/svg_task_io.py +++ b/src/ewoksdraw/_svg/svg_task_io.py @@ -1,9 +1,9 @@ from typing import Literal -from ..config.constants import ANCHOR_LINKS_RADIUS -from ..config.constants import IO_ANCHOR_TEXT_MARGIN -from ..config.constants import IO_MIN_FONT_SIZE -from ..config.constants import IO_TARGET_FONT_SIZE +from .._config.constants import ANCHOR_LINKS_RADIUS +from .._config.constants import IO_ANCHOR_TEXT_MARGIN +from .._config.constants import IO_MIN_FONT_SIZE +from .._config.constants import IO_TARGET_FONT_SIZE from .svg_element import SvgElement from .svg_group import SvgGroup from .svg_task_anchor_link import SvgTaskAnchorLink diff --git a/src/ewoksdraw/svg/svg_task_line.py b/src/ewoksdraw/_svg/svg_task_line.py similarity index 100% rename from src/ewoksdraw/svg/svg_task_line.py rename to src/ewoksdraw/_svg/svg_task_line.py diff --git a/src/ewoksdraw/svg/svg_task_title.py b/src/ewoksdraw/_svg/svg_task_title.py similarity index 87% rename from src/ewoksdraw/svg/svg_task_title.py rename to src/ewoksdraw/_svg/svg_task_title.py index fc791f1..63313bc 100644 --- a/src/ewoksdraw/svg/svg_task_title.py +++ b/src/ewoksdraw/_svg/svg_task_title.py @@ -1,10 +1,10 @@ from typing import Optional from typing import Union -from ..config.constants import TITLE_HORIZONTAL_MARGIN -from ..config.constants import TITLE_MIN_FONT_SIZE -from ..config.constants import TITLE_TARGET_FONT_SIZE -from ..config.constants import TITLE_VERTICAL_MARGIN +from .._config.constants import TITLE_HORIZONTAL_MARGIN +from .._config.constants import TITLE_MIN_FONT_SIZE +from .._config.constants import TITLE_TARGET_FONT_SIZE +from .._config.constants import TITLE_VERTICAL_MARGIN from .svg_text import SvgText Number = Union[int, float] diff --git a/src/ewoksdraw/svg/svg_text.py b/src/ewoksdraw/_svg/svg_text.py similarity index 100% rename from src/ewoksdraw/svg/svg_text.py rename to src/ewoksdraw/_svg/svg_text.py diff --git a/src/ewoksdraw/svg/utils.py b/src/ewoksdraw/_svg/utils.py similarity index 88% rename from src/ewoksdraw/svg/utils.py rename to src/ewoksdraw/_svg/utils.py index db523f5..2971dba 100644 --- a/src/ewoksdraw/svg/utils.py +++ b/src/ewoksdraw/_svg/utils.py @@ -1,7 +1,7 @@ from pathlib import Path from xml.etree.ElementTree import Element -CSS_DIR = Path(__file__).parent.parent / "css_styles" +CSS_DIR = Path(__file__).parent.parent / "_css_styles" def generate_style_element(css_file_name: str) -> None | Element: diff --git a/src/ewoksdraw/tests/__init__.py b/src/ewoksdraw/_tests/__init__.py similarity index 100% rename from src/ewoksdraw/tests/__init__.py rename to src/ewoksdraw/_tests/__init__.py diff --git a/src/ewoksdraw/tests/resources/workflow1.json b/src/ewoksdraw/_tests/resources/workflow1.json similarity index 100% rename from src/ewoksdraw/tests/resources/workflow1.json rename to src/ewoksdraw/_tests/resources/workflow1.json diff --git a/src/ewoksdraw/tests/test_cubic_bezier_path.py b/src/ewoksdraw/_tests/test_cubic_bezier_path.py similarity index 87% rename from src/ewoksdraw/tests/test_cubic_bezier_path.py rename to src/ewoksdraw/_tests/test_cubic_bezier_path.py index 1e6b2b1..5eb5b13 100644 --- a/src/ewoksdraw/tests/test_cubic_bezier_path.py +++ b/src/ewoksdraw/_tests/test_cubic_bezier_path.py @@ -1,12 +1,12 @@ import pytest -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierPath -from ewoksdraw.geometry.cubic_bezier_path import Point -from ewoksdraw.geometry.cubic_bezier_path import Vector -from ewoksdraw.geometry.cubic_bezier_path import _direction -from ewoksdraw.geometry.cubic_bezier_path import _l1_distance -from ewoksdraw.geometry.cubic_bezier_path import _move -from ewoksdraw.geometry.cubic_bezier_path import _straight_segment +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierPath +from ewoksdraw._geometry.cubic_bezier_path import Point +from ewoksdraw._geometry.cubic_bezier_path import Vector +from ewoksdraw._geometry.cubic_bezier_path import _direction +from ewoksdraw._geometry.cubic_bezier_path import _l1_distance +from ewoksdraw._geometry.cubic_bezier_path import _move +from ewoksdraw._geometry.cubic_bezier_path import _straight_segment def _point(x: float, y: float) -> Point: diff --git a/src/ewoksdraw/tests/test_elk_backend.py b/src/ewoksdraw/_tests/test_elk_backend.py similarity index 88% rename from src/ewoksdraw/tests/test_elk_backend.py rename to src/ewoksdraw/_tests/test_elk_backend.py index aa7c738..4132225 100644 --- a/src/ewoksdraw/tests/test_elk_backend.py +++ b/src/ewoksdraw/_tests/test_elk_backend.py @@ -1,8 +1,8 @@ from typing import Any from typing import cast -from ewoksdraw.layout.elk_backend import layout -from ewoksdraw.layout.elk_converter import ElkGraphBeforeLayout +from ewoksdraw._layout.elk_backend import layout +from ewoksdraw._layout.elk_converter import ElkGraphBeforeLayout def test_layout() -> None: diff --git a/src/ewoksdraw/tests/test_elk_converter.py b/src/ewoksdraw/_tests/test_elk_converter.py similarity index 94% rename from src/ewoksdraw/tests/test_elk_converter.py rename to src/ewoksdraw/_tests/test_elk_converter.py index 6e419a3..64becc0 100644 --- a/src/ewoksdraw/tests/test_elk_converter.py +++ b/src/ewoksdraw/_tests/test_elk_converter.py @@ -4,18 +4,18 @@ from ewokscore.tests.examples.graphs import get_graph from ewokscore.tests.examples.graphs import graph_names -from ewoksdraw.config.constants import ELK_LAYOUT_OPTIONS -from ewoksdraw.graph_to_svg import build_svg_task_group -from ewoksdraw.layout.elk_backend import layout -from ewoksdraw.layout.elk_converter import ElkGraph -from ewoksdraw.layout.elk_converter import convert_ewoks_to_elk_graph -from ewoksdraw.layout.elk_converter import extract_task_positions_from_elk_graph -from ewoksdraw.svg.svg_task import TaskIOPosition -from ewoksdraw.svg.svg_task import TaskPosition -from ewoksdraw.svg.svg_task_group import TaskInputPositions -from ewoksdraw.svg.svg_task_group import TaskOutputPositions -from ewoksdraw.svg.svg_task_group import TaskSize -from ewoksdraw.svg.svg_task_group import TaskSizes +from ewoksdraw._config.constants import ELK_LAYOUT_OPTIONS +from ewoksdraw._layout.elk_backend import layout +from ewoksdraw._layout.elk_converter import ElkGraph +from ewoksdraw._layout.elk_converter import convert_ewoks_to_elk_graph +from ewoksdraw._layout.elk_converter import extract_task_positions_from_elk_graph +from ewoksdraw._svg.svg_task import TaskIOPosition +from ewoksdraw._svg.svg_task import TaskPosition +from ewoksdraw._svg.svg_task_group import TaskInputPositions +from ewoksdraw._svg.svg_task_group import TaskOutputPositions +from ewoksdraw._svg.svg_task_group import TaskSize +from ewoksdraw._svg.svg_task_group import TaskSizes +from ewoksdraw.graph_to_svg import _build_svg_task_group _TASK_TYPE = "ewokscore.tests.examples.tasks.sumtask.SumTask" @@ -441,7 +441,7 @@ def test_output_is_accepted_by_the_rust_layout(graph_name: str) -> None: graph_description, _ = get_graph(graph_name) graph = load_graph(graph_description) - task_group = build_svg_task_group(graph) + task_group = _build_svg_task_group(graph) elk_graph = convert_ewoks_to_elk_graph( graph, diff --git a/src/ewoksdraw/tests/test_elk_rs_binding.py b/src/ewoksdraw/_tests/test_elk_rs_binding.py similarity index 97% rename from src/ewoksdraw/tests/test_elk_rs_binding.py rename to src/ewoksdraw/_tests/test_elk_rs_binding.py index 38c9eec..b7657e9 100644 --- a/src/ewoksdraw/tests/test_elk_rs_binding.py +++ b/src/ewoksdraw/_tests/test_elk_rs_binding.py @@ -6,10 +6,10 @@ import pytest from ewoksdraw import _elk_rs -from ewoksdraw.layout.elk_backend import ElkLayoutError -from ewoksdraw.layout.elk_backend import layout -from ewoksdraw.layout.elk_converter import ElkGraph -from ewoksdraw.layout.elk_converter import ElkGraphBeforeLayout +from ewoksdraw._layout.elk_backend import ElkLayoutError +from ewoksdraw._layout.elk_backend import layout +from ewoksdraw._layout.elk_converter import ElkGraph +from ewoksdraw._layout.elk_converter import ElkGraphBeforeLayout NODE_WIDTH = 100 NODE_HEIGHT = 60 diff --git a/src/ewoksdraw/tests/test_graph_to_svg.py b/src/ewoksdraw/_tests/test_graph_to_svg.py similarity index 100% rename from src/ewoksdraw/tests/test_graph_to_svg.py rename to src/ewoksdraw/_tests/test_graph_to_svg.py diff --git a/src/ewoksdraw/tests/test_svg_link_cubic_bezier.py b/src/ewoksdraw/_tests/test_svg_link_cubic_bezier.py similarity index 92% rename from src/ewoksdraw/tests/test_svg_link_cubic_bezier.py rename to src/ewoksdraw/_tests/test_svg_link_cubic_bezier.py index a57690e..165fd33 100644 --- a/src/ewoksdraw/tests/test_svg_link_cubic_bezier.py +++ b/src/ewoksdraw/_tests/test_svg_link_cubic_bezier.py @@ -1,8 +1,8 @@ import pytest -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierPath -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierSegment -from ewoksdraw.svg.svg_link_cubic_bezier import SvgLinkCubicBezier +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierPath +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierSegment +from ewoksdraw._svg.svg_link_cubic_bezier import SvgLinkCubicBezier SIMPLE_PATH = CubicBezierPath( start={"x": 0, "y": 0}, diff --git a/src/ewoksdraw/tests/test_svg_path_integration.py b/src/ewoksdraw/_tests/test_svg_path_integration.py similarity index 82% rename from src/ewoksdraw/tests/test_svg_path_integration.py rename to src/ewoksdraw/_tests/test_svg_path_integration.py index 3f091c1..44fab28 100644 --- a/src/ewoksdraw/tests/test_svg_path_integration.py +++ b/src/ewoksdraw/_tests/test_svg_path_integration.py @@ -2,11 +2,11 @@ from defusedxml import ElementTree -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierPath -from ewoksdraw.geometry.cubic_bezier_path import CubicBezierSegment -from ewoksdraw.svg.svg_canvas import SvgCanvas -from ewoksdraw.svg.svg_group import SvgGroup -from ewoksdraw.svg.svg_link_cubic_bezier import SvgLinkCubicBezier +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierPath +from ewoksdraw._geometry.cubic_bezier_path import CubicBezierSegment +from ewoksdraw._svg.svg_canvas import SvgCanvas +from ewoksdraw._svg.svg_group import SvgGroup +from ewoksdraw._svg.svg_link_cubic_bezier import SvgLinkCubicBezier PATH = CubicBezierPath( start={"x": 0, "y": 0}, diff --git a/src/ewoksdraw/tests/test_svg_task.py b/src/ewoksdraw/_tests/test_svg_task.py similarity index 91% rename from src/ewoksdraw/tests/test_svg_task.py rename to src/ewoksdraw/_tests/test_svg_task.py index b3255c5..8103642 100644 --- a/src/ewoksdraw/tests/test_svg_task.py +++ b/src/ewoksdraw/_tests/test_svg_task.py @@ -1,4 +1,4 @@ -from ewoksdraw.svg.svg_task import SvgTask +from ewoksdraw._svg.svg_task import SvgTask def test_io_positions_keep_original_names() -> None: diff --git a/src/ewoksdraw/tests/test_utils.py b/src/ewoksdraw/_tests/test_utils.py similarity index 72% rename from src/ewoksdraw/tests/test_utils.py rename to src/ewoksdraw/_tests/test_utils.py index 662a949..315841c 100644 --- a/src/ewoksdraw/tests/test_utils.py +++ b/src/ewoksdraw/_tests/test_utils.py @@ -1,7 +1,7 @@ -from ..utils import get_edge_source_id -from ..utils import get_edge_target_id -from ..utils import get_task_id_from_source_id -from ..utils import get_task_id_from_target_id +from .._utils import get_edge_source_id +from .._utils import get_edge_target_id +from .._utils import get_task_id_from_source_id +from .._utils import get_task_id_from_target_id def test_edge_source_task_id_roundtrip() -> None: diff --git a/src/ewoksdraw/utils.py b/src/ewoksdraw/_utils.py similarity index 98% rename from src/ewoksdraw/utils.py rename to src/ewoksdraw/_utils.py index 073fe89..e6fd7c0 100644 --- a/src/ewoksdraw/utils.py +++ b/src/ewoksdraw/_utils.py @@ -3,7 +3,7 @@ from ewokscore.graph import TaskGraph -from .models import DataMapping +from ._models import DataMapping def get_valid_data_mappings(ewoks_graph: TaskGraph) -> list[DataMapping]: diff --git a/src/ewoksdraw/graph_to_svg.py b/src/ewoksdraw/graph_to_svg.py index 8e8781a..d0ad1ab 100644 --- a/src/ewoksdraw/graph_to_svg.py +++ b/src/ewoksdraw/graph_to_svg.py @@ -3,20 +3,20 @@ from ewokscore.graph import TaskGraph from ewokscore.node.signature import node_signature -from .config.constants import TASK_GROUP_HORIZONTAL_GAP -from .layout.elk_backend import layout -from .layout.elk_converter import ElkGraph -from .layout.elk_converter import ElkGraphBeforeLayout -from .layout.elk_converter import convert_ewoks_to_elk_graph -from .layout.elk_converter import extract_task_positions_from_elk_graph -from .layout.elk_link_group_builder import build_svg_link_group -from .svg.svg_canvas import SvgCanvas -from .svg.svg_task import SvgTask -from .svg.svg_task_group import SvgTaskGroup -from .utils import get_edge_sources_and_targets +from ._config.constants import TASK_GROUP_HORIZONTAL_GAP +from ._layout.elk_backend import layout +from ._layout.elk_converter import ElkGraph +from ._layout.elk_converter import ElkGraphBeforeLayout +from ._layout.elk_converter import convert_ewoks_to_elk_graph +from ._layout.elk_converter import extract_task_positions_from_elk_graph +from ._layout.elk_link_group_builder import build_svg_link_group +from ._svg.svg_canvas import SvgCanvas +from ._svg.svg_task import SvgTask +from ._svg.svg_task_group import SvgTaskGroup +from ._utils import get_edge_sources_and_targets -def build_svg_task_group(graph: TaskGraph) -> SvgTaskGroup: +def _build_svg_task_group(graph: TaskGraph) -> SvgTaskGroup: """Build an SVG task group from an Ewoks task graph.""" source_outputs_per_node, target_inputs_per_node = get_edge_sources_and_targets( graph @@ -49,7 +49,7 @@ def build_svg_task_group(graph: TaskGraph) -> SvgTaskGroup: def graph_to_svg(graph: TaskGraph, output_path: str | Path) -> None: - task_group = build_svg_task_group(graph) + task_group = _build_svg_task_group(graph) elk_graph_before_layout: ElkGraphBeforeLayout = convert_ewoks_to_elk_graph( graph, task_group.extract_task_sizes(),