angular¶
Angular command resolution and execution helpers.
- class django_angular3.angular.AngularInvocation(command_name, argv, cwd)[source]¶
Bases:
objectA single Angular CLI invocation and the directory it should run from.
- Parameters:
command_name (str)
argv (tuple[str, ...])
cwd (Path)
- argv: tuple[str, ...]¶
- command_name: str¶
- cwd: Path¶
- django_angular3.angular.build_ng_add_invocations(config, settings, *, package=None, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
package (str | None)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_build_invocations(config, settings, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_config_invocations(config, settings, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_gen_app_invocations(config, settings, *, app_name=None, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
app_name (str | None)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_new_invocations(config, settings, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_openapi_gen_invocations(config, settings, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_workspace_delete_invocations(config, _settings, **_)[source]¶
Delete the entire workspace folder using Python’s native cross-platform shutil.
- Parameters:
config (ProjectConfig)
_settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_workspace_invocations(config, settings, **_)[source]¶
Create and bootstrap an Angular workspace with angular-django2 defaults.
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_workspace_modify_invocations(config, settings, **_)[source]¶
Reapply workspace defaults, collection registration, and workspace scaffolding.
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.build_ng_workspace_schematic_invocations(config, settings, **_)[source]¶
- Parameters:
config (ProjectConfig)
settings (AngularSettings)
_ (Any)
- Return type:
list[AngularInvocation]
- django_angular3.angular.execute_invocations(invocations, settings=None)[source]¶
Run a previously resolved ordered list of subprocess calls.
- Parameters:
invocations (list[AngularInvocation])
settings (AngularSettings | None)
- Return type:
None
- django_angular3.angular.format_invocations(invocations)[source]¶
Serialize resolved subprocess calls for dry-run output.
- Parameters:
invocations (list[AngularInvocation])
- Return type:
str
- django_angular3.angular.resolve_angular_command(command_name, config_path=None, **options)[source]¶
Resolve one logical djng command into an ordered list of subprocess calls.
This function does not execute Angular or Node tooling. It loads the project configuration and Angular settings, chooses the matching command builder, and returns the concrete
AngularInvocationlist that a dry run can print orexecute_invocationscan later run.- Parameters:
command_name (str)
config_path (str | Path | None)
options (Any)
- Return type:
list[AngularInvocation]