Skip to content

validator

django_spire.core.management.commands.spire_startapp_pkg.validator

AppValidator

Validates Django app paths and configurations.

This class performs validation checks to ensure app paths are properly formatted, don't conflict with existing apps, and use valid root apps.

Initializes the validator with required dependencies.

Parameters:

  • reporter (Reporter) –

    Reporter for displaying error messages.

  • registry (AppRegistry) –

    Registry for checking installed apps.

  • path_resolver (PathResolver) –

    Path resolver for determining file locations.

  • filesystem (FileSystem) –

    File system for checking file existence.

Source code in django_spire/core/management/commands/spire_startapp_pkg/validator.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def __init__(
    self,
    reporter: Reporter,
    registry: AppRegistry,
    path_resolver: PathResolver,
    filesystem: FileSystem
):
    """
    Initializes the validator with required dependencies.

    :param reporter: Reporter for displaying error messages.
    :param registry: Registry for checking installed apps.
    :param path_resolver: Path resolver for determining file locations.
    :param filesystem: File system for checking file existence.
    """

    self._filesystem = filesystem
    self._path_resolver = path_resolver
    self._registry = registry
    self._reporter = reporter

validate_app_format

Validates that an app path uses dot notation.

Parameters:

  • app_path (str) –

    App path to validate.

Raises:

  • CommandError –

    If the app path doesn't contain dots.

Source code in django_spire/core/management/commands/spire_startapp_pkg/validator.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
def validate_app_format(self, app_path: str) -> None:
    """
    Validates that an app path uses dot notation.

    :param app_path: App path to validate.
    :raises CommandError: If the app path doesn't contain dots.
    """

    if '.' not in app_path:
        self._reporter.write('\n', self._reporter.style_notice)

        message = 'Invalid app name format. The app path must use dot notation (e.g., "parent.child").'
        raise CommandError(message)

validate_app_path

Validates that an app path doesn't already exist.

Parameters:

  • components (list[str]) –

    List of app path components.

Raises:

  • CommandError –

    If an app already exists at the destination path.

Source code in django_spire/core/management/commands/spire_startapp_pkg/validator.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def validate_app_path(self, components: list[str]) -> None:
    """
    Validates that an app path doesn't already exist.

    :param components: List of app path components.
    :raises CommandError: If an app already exists at the destination path.
    """

    destination = self._path_resolver.get_app_destination(components)

    if self._filesystem.has_content(destination):
        self._reporter.write('\n', self._reporter.style_notice)

        message = (
            f'The app already exists at {destination}. '
            'Please remove the existing app or choose a different name.'
        )

        raise CommandError(message)

validate_root_app

Validates that the root app component is registered in Django.

Parameters:

  • components (list[str]) –

    List of app path components.

Raises:

  • CommandError –

    If the root app is not a valid registered app.

Source code in django_spire/core/management/commands/spire_startapp_pkg/validator.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def validate_root_app(self, components: list[str]) -> None:
    """
    Validates that the root app component is registered in Django.

    :param components: List of app path components.
    :raises CommandError: If the root app is not a valid registered app.
    """

    valid_roots = self._registry.get_valid_root_apps()
    root = components[0]

    if root not in valid_roots:
        self._reporter.write('\n', self._reporter.style_notice)

        message = (
            f'Invalid root app "{root}". '
            f'Valid root apps: {", ".join(sorted(valid_roots))}.'
        )

        raise CommandError(message)