dash/tests/unit/pages/test_pages.py at e5f2ddbdaf92d9f9f5193861ad6a8a621f3b573f · plotly/dash · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
from pathlib import Path

import pytest
import dash
from dash import Dash, _pages
from mock import patch


THIS_DIR = Path(__file__).parent


@pytest.mark.parametrize(
    "module_name, template, pages_folder, expected",
    [
        ("pages.page1", None, str(THIS_DIR / "pages"), "/page1"),
        ("Pages.page1", None, str(THIS_DIR / "Pages"), "/page1"),
        ("custom_pages.page1", None, str(THIS_DIR / "custom_pages"), "/page1"),
        ("custom.pages.page1", None, str(THIS_DIR / "custom.pages"), "/page1"),
        ("custom.pages.page1", None, str(THIS_DIR / "custom" / "pages"), "/page1"),
        (
            "custom_pages.chapter_1.page_1",
            None,
            str(THIS_DIR / "custom_pages"),
            "/chapter-1/page-1",
        ),
        # can this even be called with  CONFIG.pages_folder set to None?
        ("dir.my_page", None, None, "/dir/my-page"),
        # is this behaviour right? why is filename ignored when template has a value?
        ("pages.page1", "/items/<item_id>", str(THIS_DIR / "pages"), "/items/none"),
    ],
)
def test_infer_path(clear_pages_state, module_name, template, pages_folder, expected):
    with patch.dict(_pages.CONFIG, {"pages_folder": pages_folder}, clear=True):
        result = _pages._infer_path(module_name, template)
        assert result == expected


@pytest.mark.parametrize(
    "module_name, expected",
    [
        (__name__, False),
        (__package__, True),
    ],
)
def test_module_name_is_package(module_name, expected):
    assert _pages._module_name_is_package(module_name) == expected


@pytest.mark.parametrize(
    "path, expected",
    [
        ("/page.py", "page"),
        ("/pages/page.py", "pages.page"),
        ("/pages", "pages"),
        ("/sub_dir/pages", "sub_dir.pages"),
    ],
)
def test_path_to_module_name(path, expected):
    assert _pages._path_to_module_name(path) == expected


@pytest.mark.parametrize(
    "name, pages_folder, expected_module_name",
    [
        (__name__, "custom_pages", "custom_pages.page"),
        (__name__, "sub_dir/custom_pages", "sub_dir.custom_pages.page"),
        (__name__, str(THIS_DIR / "custom_pages"), "custom_pages.page"),
        (__package__, "custom_pages", "pages.custom_pages.page"),
    ],
)
def test_import_layouts_from_pages(
    clear_pages_state, name, pages_folder, expected_module_name
):
    _ = Dash(name, use_pages=True, pages_folder=pages_folder)
    assert len(dash.page_registry) == 1

    page_entry = list(dash.page_registry.values())[0]
    assert page_entry["module"] == expected_module_name


def test_import_layouts_from_package(clear_pages_state):
    from . import custom_pages

    _ = Dash(__package__, use_pages=True, pages_folder="", pages_package=custom_pages)
    page_entries = list(dash.page_registry.values())
    assert len(page_entries) == 1
    assert page_entries[0]["module"] == "pages.custom_pages.page"