zrb 0.0.85__py3-none-any.whl → 0.0.87__py3-none-any.whl

zrb/builtin/generator/project/create.py

@@ -1,22 +1,24 @@
 from typing import Any, Mapping
-from ..._group import project_group
+from typeguard import typechecked
+from ..common.task_input import project_dir_input, project_name_input
+from ..project_task.task_factory import create_ensure_project_tasks
+from ...group import project_group
 from ....task.cmd_task import CmdTask
 from ....task.decorator import python_task
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
 from ....config.config import version
-from .._common.input import project_dir_input, project_name_input
-from ..project_task.task_factory import create_add_project_automation_task
 
 import os
 
-current_dir = os.path.dirname(__file__)
+CURRENT_DIR = os.path.dirname(__file__)
 
 ###############################################################################
 # Replacement Mutator Definitions
 ###############################################################################
 
 
+@typechecked
 def copy_resource_replacement_mutator(
     task: ResourceMaker, replacements: Mapping[str, str]
 ) -> Mapping[str, str]:
@@ -24,7 +26,9 @@ def copy_resource_replacement_mutator(
         replacements.get('zrbProjectDir', '')
     )
     if replacements.get('zrbProjectName', '') == '':
-        replacements['zrbProjectName'] = replacements.get('zrbBaseProjectDir', '')
+        replacements['zrbProjectName'] = replacements.get(
+            'zrbBaseProjectDir', ''
+        )
     return replacements
 
 
@@ -57,21 +61,21 @@ copy_resource = ResourceMaker(
         'zrbVersion': version,
     },
     replacement_mutator=copy_resource_replacement_mutator,
-    template_path=os.path.join(current_dir, 'template'),
+    template_path=os.path.join(CURRENT_DIR, 'template'),
     destination_path='{{input.project_dir}}',
     excludes=[
         '*/__pycache__',
     ]
 )
 
-add_project_task = create_add_project_automation_task(
+ensure_project_tasks = create_ensure_project_tasks(
     upstreams=[copy_resource]
 )
 
 create_project = CmdTask(
     name='create',
     group=project_group,
-    upstreams=[add_project_task],
+    upstreams=[ensure_project_tasks],
     inputs=[project_dir_input],
     cmd=[
         'set -e',

zrb/builtin/generator/project_task/task_factory.py

@@ -1,108 +1,192 @@
 from typing import Any, List, Optional
-from .._common.input import project_dir_input, app_name_input
+from typeguard import typechecked
+from ..common.task_input import project_dir_input
+from ..common.task_factory import create_add_upstream
 from ....task.decorator import python_task
+from ....task.any_task import AnyTask
 from ....task.task import Task
-from ....helper import util
+from ....task_input.any_input import AnyInput
 from ....helper.codemod.add_import_module import add_import_module
-from ....helper.codemod.add_upstream_to_task import add_upstream_to_task
 from ....helper.codemod.add_assert_resource import add_assert_resource
 from ....helper.file.copy_tree import copy_tree
 from ....helper.file.text import read_text_file_async, write_text_file_async
 import os
 
-current_dir = os.path.dirname(__file__)
+CURRENT_DIR = os.path.dirname(__file__)
 
 
-def create_add_project_automation_task(
-    upstreams: Optional[List[Task]] = None
+@typechecked
+def create_ensure_project_tasks(
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
+    '''
+    Create a task to ensure there are project tasks under `_automate/_project`
+    '''
     @python_task(
-        name='add-project-automation',
+        name='ensure-project-tasks',
         inputs=[project_dir_input],
         upstreams=[] if upstreams is None else upstreams
     )
     async def _task(*args: Any, **kwargs: Any):
         task: Task = kwargs.get('_task')
         project_dir = kwargs.get('project_dir', '.')
-        task.print_out('Create project automation modules if not exist')
-        await _add_project_automation(project_dir)
+        task.print_out('Create project tasks if not exist')
+        if os.path.exists(os.path.join(project_dir, '_automate', '_project')):
+            return
+        await copy_tree(
+            src=os.path.join(CURRENT_DIR, 'template'),
+            dst=project_dir
+        )
+        project_task_module_path = '_automate._project'
+        zrb_init_path = os.path.join(project_dir, 'zrb_init.py')
+        code = await read_text_file_async(zrb_init_path)
+        import_alias = project_task_module_path.split('.')[-1]
+        code = add_import_module(
+            code=code,
+            module_path=project_task_module_path,
+            alias=import_alias
+        )
+        code = add_assert_resource(code, import_alias)
+        await write_text_file_async(zrb_init_path, code)
     return _task
 
 
-async def _add_project_automation(project_dir: str):
-    if os.path.exists(os.path.join(project_dir, '_automate', '_project')):
-        return
-    await copy_tree(
-        src=os.path.join(current_dir, 'template'),
-        dst=project_dir
+@typechecked
+def create_add_build_images_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('build_project_images.py'),
+        task_name='build-images',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
     )
-    project_task_module_path = '_automate._project'
-    zrb_init_path = os.path.join(project_dir, 'zrb_init.py')
-    code = await read_text_file_async(zrb_init_path)
-    import_alias = project_task_module_path.split('.')[-1]
-    code = add_import_module(
-        code=code,
-        module_path=project_task_module_path,
-        alias=import_alias
+
+
+@typechecked
+def create_add_deploy_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('deploy_project.py'),
+        task_name='deploy',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
     )
-    code = add_assert_resource(code, import_alias)
-    await write_text_file_async(zrb_init_path, code)
-
-
-def create_register_app_task(
-    task_name: str,
-    project_automation_file_name: str,
-    project_automation_task_name: str,
-    app_automation_file_name: str,
-    app_automation_task_var_name_tpl: str,
-    upstreams: Optional[List[Task]] = None,
-):
-    @python_task(
-        name=task_name,
-        inputs=[project_dir_input, app_name_input],
-        upstreams=[] if upstreams is None else upstreams
+
+
+@typechecked
+def create_add_destroy_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('destroy_project.py'),
+        task_name='destroy',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
     )
-    async def _task(*args: Any, **kwargs: Any):
-        task: Task = kwargs.get('_task')
-        project_dir = kwargs.get('project_dir', '.')
-        app_name = kwargs.get('app_name')
-        snake_app_name = util.to_snake_case(app_name)
-        abs_app_automation_file_name = os.path.join(
-            project_dir, '_automate', snake_app_name, app_automation_file_name
-        )
-        app_automation_task_var_name = app_automation_task_var_name_tpl.format(
-            snake_app_name=snake_app_name
-        )
-        project_automation_dir = os.path.join(
-            project_dir, '_automate', '_project'
-        )
-        project_automation_path = os.path.join(
-            project_automation_dir, f'{project_automation_file_name}'
-        )
-        upstream_task_rel_file_path = os.path.relpath(
-            abs_app_automation_file_name, project_automation_path
-        )
-        # normalize `..` parts
-        upstream_module_parts = [
-            part if part != '..' else ''
-            for part in upstream_task_rel_file_path.split(os.path.sep)
-        ]
-        # remove .py extenstion
-        last_part = upstream_module_parts[-1]
-        upstream_module_parts[-1] = os.path.splitext(last_part)[0]
-        # turn into module path
-        upstream_module_path = '.'.join(upstream_module_parts)
-        task.print_out(
-            f'Add {app_automation_task_var_name} to project automation'
-        )
-        code = await read_text_file_async(project_automation_path)
-        code = add_import_module(
-            code=code,
-            module_path=upstream_module_path,
-            resource=app_automation_task_var_name
-        )
-        code = add_upstream_to_task(
-            code, project_automation_task_name, app_automation_task_var_name
-        )
-        await write_text_file_async(project_automation_path, code)
-    return _task
+
+
+@typechecked
+def create_add_push_images_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('push_project_images.py'),
+        task_name='push-images',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
+    )
+
+
+@typechecked
+def create_add_remove_containers_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('remove_project_containers.py'),
+        task_name='remove-containers',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
+    )
+
+
+@typechecked
+def create_add_start_containers_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('start_project_containers.py'),
+        task_name='start-containers',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
+    )
+
+
+@typechecked
+def create_add_start_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('start_project.py'),
+        task_name='start',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
+    )
+
+
+@typechecked
+def create_add_stop_containers_upstream(
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    return create_add_upstream(
+        task_file_name=_get_project_task_file('stop_project_containers.py'),
+        task_name='stop-containers',
+        upstream_module=upstream_module,
+        upstream_task_var=upstream_task_var,
+        inputs=inputs,
+        upstreams=upstreams
+    )
+
+
+@typechecked
+def _get_project_task_file(task_file_name: str) -> str:
+    return os.path.join('_automate', '_project', task_file_name)

zrb/builtin/generator/project_task/template/_automate/_project/build_project_images.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 build_project_images = Task(

zrb/builtin/generator/project_task/template/_automate/_project/deploy_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 deploy_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/destroy_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 destroy_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/push_project_images.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 push_project_images = Task(

zrb/builtin/generator/project_task/template/_automate/_project/remove_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 remove_project_containers = Task(

zrb/builtin/generator/project_task/template/_automate/_project/start_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 start_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/start_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 start_project_containers = Task(

zrb/builtin/generator/project_task/template/_automate/_project/stop_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 stop_project_containers = Task(

zrb/builtin/generator/python_task/add.py

@@ -1,18 +1,18 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import project_dir_input, task_name_input
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
 from ....task.decorator import python_task
 from ....task.task import Task
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
-from .._common.input import (
-    project_dir_input, task_name_input
-)
-from .._common.helper import validate_project_dir, create_register_task_module
-from ....helper import util
+from ...group import project_add_group
 
 import os
 
-current_dir = os.path.dirname(__file__)
+CURRENT_DIR = os.path.dirname(__file__)
 
 ###############################################################################
 # Task Definitions
@@ -28,13 +28,9 @@ current_dir = os.path.dirname(__file__)
 )
 async def validate(*args: Any, **kwargs: Any):
     project_dir = kwargs.get('project_dir')
-    validate_project_dir(project_dir)
+    validate_existing_project_dir(project_dir)
     task_name = kwargs.get('task_name')
-    automation_file = os.path.join(
-        project_dir, '_automate', f'{util.to_snake_case(task_name)}.py'
-    )
-    if os.path.exists(automation_file):
-        raise Exception(f'Automation file already exists: {automation_file}')
+    validate_inexisting_automation(project_dir, task_name)
 
 
 copy_resource = ResourceMaker(
@@ -47,14 +43,16 @@ copy_resource = ResourceMaker(
     replacements={
         'zrbTaskName': '{{input.task_name}}',
     },
-    template_path=os.path.join(current_dir, 'template'),
+    template_path=os.path.join(CURRENT_DIR, 'template'),
     destination_path='{{ input.project_dir }}',
     excludes=[
         '*/__pycache__',
     ]
 )
 
-register_task_module = create_register_task_module(
+register_module = create_register_module(
+    module_path='_automate.{{util.to_snake_case(input.task_name)}}',
+    inputs=[task_name_input],
     upstreams=[copy_resource]
 )
 
@@ -62,7 +60,7 @@ register_task_module = create_register_task_module(
 @python_task(
     name='python-task',
     group=project_add_group,
-    upstreams=[register_task_module],
+    upstreams=[register_module],
     runner=runner
 )
 async def add_python_task(*args: Any, **kwargs: Any):

zrb/builtin/generator/python_task/template/_automate/snake_zrb_task_name.py

@@ -1,6 +1,6 @@
 from typing import Any, Mapping
 from zrb import Task, python_task, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 
 ###############################################################################
 # Task Definitions