Skip to content

builder

django_spire.core.management.commands.spire_startapp_pkg.builder

TemplateBuilder

Builds and displays tree structures for app and template creation.

This class generates visual representations of the file structure that will be created for new apps and their associated templates.

Initializes the TemplateBuilder with a reporter for output.

Parameters:

  • reporter (Reporter) –

    Reporter instance for displaying output to the user.

Source code in django_spire/core/management/commands/spire_startapp_pkg/builder.py 
21
22
23
24
25
26
27
28
def __init__(self, reporter: Reporter):
    """
    Initializes the TemplateBuilder with a reporter for output.

    :param reporter: Reporter instance for displaying output to the user.
    """

    self._reporter = reporter

build_app_tree_structure

Displays a tree structure of the app files that will be created.

This method shows the user what Python files, directories, and modules will be generated for the new Django app before creation.

Parameters:

  • base (Path) –

    Base directory where the app will be created.

  • components (list[str]) –

    List of app path components (e.g., ['app', 'human_resource', 'employee']).

  • registry (list[str]) –

    List of already registered apps in the Django project.

  • template (Path) –

    Path to the app template directory.

Source code in django_spire/core/management/commands/spire_startapp_pkg/builder.py 
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
def build_app_tree_structure(
    self,
    base: Path,
    components: list[str],
    registry: list[str],
    template: Path
) -> None:
    """
    Displays a tree structure of the app files that will be created.

    This method shows the user what Python files, directories, and modules
    will be generated for the new Django app before creation.

    :param base: Base directory where the app will be created.
    :param components: List of app path components (e.g., ['app', 'human_resource', 'employee']).
    :param registry: List of already registered apps in the Django project.
    :param template: Path to the app template directory.
    """

    self._reporter.report_tree_structure(
        title='\nThe following app(s) will be created:\n\n',
        base=base,
        components=components,
        registry=registry,
        template=template,
        formatter=self._reporter.format_app_item,
        transformation=self._reporter.transform_app_component,
    )

build_html_tree_structure

Displays a tree structure of the HTML template files that will be created.

This method shows the user what HTML templates, cards, forms, and pages will be generated for the new Django app before creation.

Parameters:

  • base (Path) –

    Base directory where templates will be created.

  • components (list[str]) –

    List of app path components.

  • registry (list[str]) –

    List of already registered apps in the Django project.

  • template (Path) –

    Path to the HTML template directory.

Source code in django_spire/core/management/commands/spire_startapp_pkg/builder.py 
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
88
89
90
91
def build_html_tree_structure(
    self,
    base: Path,
    components: list[str],
    registry: list[str],
    template: Path
) -> None:
    """
    Displays a tree structure of the HTML template files that will be created.

    This method shows the user what HTML templates, cards, forms, and pages
    will be generated for the new Django app before creation.

    :param base: Base directory where templates will be created.
    :param components: List of app path components.
    :param registry: List of already registered apps in the Django project.
    :param template: Path to the HTML template directory.
    """

    replacement = generate_replacement_map(components)

    def html_formatter_with_replacement(item: Path) -> str:
        return self._reporter.format_html_item(item, replacement)

    self._reporter.report_tree_structure(
        title='\nThe following template(s) will be created:\n\n',
        base=base,
        components=components,
        registry=registry,
        template=template,
        formatter=html_formatter_with_replacement,
        transformation=self._reporter.transform_html_component,
    )