zrb 0.0.86__py3-none-any.whl → 0.0.88__py3-none-any.whl

zrb/builtin/generator/{_common → common}/helper.py

@@ -1,4 +1,5 @@
 from typing import Optional
+from typeguard import typechecked
 from ....helper.codemod.add_assert_resource import add_assert_resource
 from ....helper.codemod.add_import_module import add_import_module
 from ....helper.file.text import read_text_file_async, write_text_file_async
@@ -6,16 +7,19 @@ from ....helper import util
 import os
 
 
+@typechecked
 def validate_existing_project_dir(project_dir: str):
     if not os.path.isfile(os.path.join(project_dir, 'zrb_init.py')):
         raise Exception(f'Not a project: {project_dir}')
 
 
+@typechecked
 def validate_inexisting_automation(project_dir: str, automation_name: str):
     validate_inexisting_automation_package(project_dir, automation_name)
     validate_inexisting_automation_module(project_dir, automation_name)
 
 
+@typechecked
 def validate_inexisting_automation_package(
     project_dir: str, package_name: str
 ):
@@ -26,6 +30,7 @@ def validate_inexisting_automation_package(
         raise Exception(f'Automation package already exists: {package_dir}')
 
 
+@typechecked
 def validate_inexisting_automation_module(project_dir: str, module_name: str):
     module_file = os.path.join(
         project_dir, '_automate', f'{util.to_snake_case(module_name)}.py'
@@ -34,6 +39,7 @@ def validate_inexisting_automation_module(project_dir: str, module_name: str):
         raise Exception(f'Automation module already exists: {module_file}')
 
 
+@typechecked
 async def register_module_to_project(
     project_dir: str, module_path: str, alias: Optional[str] = None
 ):

zrb/builtin/generator/{_common → common}/task_factory.py

@@ -1,19 +1,22 @@
 from typing import Any, List, Optional
+from typeguard import typechecked
 from .task_input import project_dir_input
 from .helper import validate_existing_project_dir, register_module_to_project
 from ....task.decorator import python_task
+from ....task.any_task import AnyTask
 from ....task.task import Task
-from ....task_input.task_input import Input
+from ....task_input.any_input import AnyInput
 from ....helper.file.text import read_text_file_async, write_text_file_async
 from ....helper.codemod.add_import_module import add_import_module
 from ....helper.codemod.add_upstream_to_task import add_upstream_to_task
 import os
 
 
+@typechecked
 def create_register_module(
     module_path: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None,
     alias: Optional[str] = None
 ) -> Task:
     @python_task(
@@ -41,13 +44,14 @@ def create_register_module(
     return register_module
 
 
+@typechecked
 def create_add_upstream(
     task_file_name: str,
     task_name: str,
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     @python_task(
         name='register-upstream',

zrb/builtin/generator/docker_compose_task/add.py

@@ -1,17 +1,17 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import (
+   project_dir_input, task_name_input, http_port_input, env_prefix_input
+)
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
+from ...group import project_add_group
 from ....task.task import Task
 from ....task.decorator import python_task
 from ....task_input.str_input import StrInput
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
-from .._common.task_input import (
-   project_dir_input, task_name_input, http_port_input, env_prefix_input
-)
-from .._common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
-)
-from .._common.task_factory import create_register_module
 from ....helper import util
 
 import os

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

@@ -1,5 +1,5 @@
 from zrb import DockerComposeTask, HTTPChecker, Env, EnvFile, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 import os
 
 ###############################################################################

zrb/builtin/generator/fastapp/add.py

@@ -1,17 +1,12 @@
 from typing import Any
-from ..._group import project_add_group
-from ....task.task import Task
-from ....task.decorator import python_task
-from ....task.resource_maker import ResourceMaker
-from ....runner import runner
-from .._common.task_input import (
+from ..common.task_input import (
     project_dir_input, app_name_input, app_image_name_input, http_port_input,
     env_prefix_input
 )
-from .._common.helper import (
+from ..common.helper import (
     validate_existing_project_dir, validate_inexisting_automation
 )
-from .._common.task_factory import create_register_module
+from ..common.task_factory import create_register_module
 from ..project_task.task_factory import (
     create_ensure_project_tasks, create_add_build_images_upstream,
     create_add_deploy_upstream, create_add_destroy_upstream,
@@ -19,6 +14,11 @@ from ..project_task.task_factory import (
     create_add_start_containers_upstream, create_add_start_upstream,
     create_add_stop_containers_upstream
 )
+from ...group import project_add_group
+from ....task.task import Task
+from ....task.decorator import python_task
+from ....task.resource_maker import ResourceMaker
+from ....runner import runner
 from ....helper import util
 
 import os
@@ -123,56 +123,56 @@ ensure_project_tasks = create_ensure_project_tasks(
     upstreams=[copy_resource]
 )
 
-add_start = create_add_start_upstream(
+add_start_upstream = create_add_start_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.local',
     upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_start_container = create_add_start_containers_upstream(
+add_start_container_upstream = create_add_start_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_stop_container = create_add_stop_containers_upstream(
+add_stop_container_upstream = create_add_stop_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'stop_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_remove_container = create_add_remove_containers_upstream(
+add_remove_container_upstream = create_add_remove_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'remove_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_build_image = create_add_build_images_upstream(
+add_build_image_upstream = create_add_build_images_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
     upstream_task_var=f'build_{SNAKE_APP_NAME_TPL}_image',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_push_image = create_add_push_images_upstream(
+add_push_image_upstream = create_add_push_images_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
     upstream_task_var=f'push_{SNAKE_APP_NAME_TPL}_image',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_deploy = create_add_deploy_upstream(
+add_deploy_upstream = create_add_deploy_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
     upstream_task_var=f'deploy_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
     inputs=[app_name_input]
 )
 
-add_destroy = create_add_destroy_upstream(
+add_destroy_upstream = create_add_destroy_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
     upstream_task_var=f'destroy_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
@@ -190,14 +190,14 @@ add_destroy = create_add_destroy_upstream(
         register_deployment_module,
         register_test_module,
         register_load_test_module,
-        add_start,
-        add_start_container,
-        add_stop_container,
-        add_remove_container,
-        add_build_image,
-        add_push_image,
-        add_deploy,
-        add_destroy
+        add_start_upstream,
+        add_start_container_upstream,
+        add_stop_container_upstream,
+        add_remove_container_upstream,
+        add_build_image_upstream,
+        add_push_image_upstream,
+        add_deploy_upstream,
+        add_destroy_upstream
     ],
     runner=runner
 )

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/_common.py

@@ -33,7 +33,8 @@ MODULES = jsons.loads(MODULE_JSON_STR)
 def skip_local_microservices_execution(*args: Any, **kwargs: Any) -> bool:
     if not kwargs.get('local_snake_zrb_app_name', True):
         return True
-    return kwargs.get('snake_zrb_app_name_run_mode', 'monolith') != 'microservices'
+    run_mode = kwargs.get('snake_zrb_app_name_run_mode', 'monolith')
+    return run_mode != 'microservices'
 
 
 ###############################################################################

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/container.py

@@ -1,7 +1,7 @@
 from typing import Mapping, Any, List
 from zrb import DockerComposeTask, Env, ServiceConfig, EnvFile, runner, Task
 from zrb.helper.util import to_kebab_case
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     APP_TEMPLATE_ENV_FILE_NAME, RESOURCE_DIR, MODULES, app_container_checker,
     rabbitmq_checker, rabbitmq_management_checker, redpanda_console_checker,

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/deployment.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, Env, EnvFile, StrInput, ChoiceInput, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from .image import push_snake_zrb_app_name_image
 from ._common import (
     CURRENT_DIR, DEPLOYMENT_DIR, APP_TEMPLATE_ENV_FILE_NAME,

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/frontend.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, Env, EnvFile, PathChecker, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     APP_FRONTEND_DIR, APP_FRONTEND_BUILD_DIR, CURRENT_DIR,
     APP_TEMPLATE_ENV_FILE_NAME

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/image.py

@@ -1,5 +1,5 @@
 from zrb import DockerComposeTask, Env, StrInput, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import RESOURCE_DIR, local_input
 
 ###############################################################################

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/load_test.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, EnvFile, BoolInput, StrInput, IntInput, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import CURRENT_DIR, RESOURCE_DIR
 import os
 
@@ -54,7 +54,8 @@ url_input = StrInput(
 ###############################################################################
 
 load_test_env_file = EnvFile(
-    env_file=LOAD_TEST_TEMPLATE_ENV_FILE_NAME, prefix='LOAD_TEST_ZRB_ENV_PREFIX'
+    env_file=LOAD_TEST_TEMPLATE_ENV_FILE_NAME,
+    prefix='LOAD_TEST_ZRB_ENV_PREFIX'
 )
 
 ###############################################################################

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/local.py

@@ -1,6 +1,6 @@
 from typing import Any, List
 from zrb import CmdTask, DockerComposeTask, Task, Env, EnvFile, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     CURRENT_DIR, APP_DIR, APP_TEMPLATE_ENV_FILE_NAME, RESOURCE_DIR,
     skip_local_microservices_execution, rabbitmq_checker,

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/test.py

@@ -1,8 +1,6 @@
 from zrb import CmdTask, StrInput, Env, EnvFile, runner, python_task
-from zrb.builtin._group import project_group
-from ._common import (
-    CURRENT_DIR, RESOURCE_DIR, APP_TEMPLATE_ENV_FILE_NAME,
-)
+from zrb.builtin.group import project_group
+from ._common import CURRENT_DIR, RESOURCE_DIR, APP_TEMPLATE_ENV_FILE_NAME
 from .frontend import build_snake_zrb_app_name_frontend_once
 from .local import prepare_snake_zrb_app_name_backend
 import os

zrb/builtin/generator/fastapp_crud/add.py

@@ -1,20 +1,18 @@
 from typing import Any
-from ..._group import project_add_group
+from .task_factory import create_add_navigation_task
+from .helper import register_api, register_permission, register_rpc
+from ..common.task_input import (
+    project_dir_input, app_name_input, module_name_input, entity_name_input,
+    plural_entity_name_input, main_column_name_input
+)
+from ..common.helper import validate_existing_project_dir
+from ...group import project_add_group
 from ....task.task import Task
 from ....task.decorator import python_task
 from ....task.cmd_task import CmdTask
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
 from ....helper import util
-from ....helper.codemod.add_import_module import add_import_module
-from ....helper.codemod.append_code_to_function import append_code_to_function
-from ....helper.file.text import read_text_file_async, write_text_file_async
-from .._common.task_input import (
-    project_dir_input, app_name_input, module_name_input, entity_name_input,
-    plural_entity_name_input, main_column_name_input
-)
-from .._common.helper import validate_existing_project_dir
-from .add_navigation import create_add_navigation_task
 
 import asyncio
 import os
@@ -155,114 +153,3 @@ add_navigation = create_add_navigation_task(
 async def add_fastapp_crud(*args: Any, **kwargs: Any):
     task: Task = kwargs.get('_task')
     task.print_out('Success')
-
-
-###############################################################################
-# Helper Definitions
-###############################################################################
-
-
-async def register_api(
-    task: Task,
-    project_dir: str,
-    kebab_app_name: str,
-    snake_module_name: str,
-    snake_entity_name: str
-):
-    module_api_file_path = os.path.join(
-        project_dir, 'src', kebab_app_name, 'src', 'module', snake_module_name,
-        'api.py'
-    )
-    register_function_path = '.'.join([
-        'module', snake_module_name, 'entity', snake_entity_name, 'api'
-    ])
-    register_function = f'register_{snake_entity_name}_api'
-    task.print_out(f'Read code from: {module_api_file_path}')
-    code = await read_text_file_async(module_api_file_path)
-    task.print_out(
-        f'Add import "register_api" as "{register_function}" ' +
-        f'from "{register_function_path}" to the code'
-    )
-    code = add_import_module(
-        code=code,
-        module_path=register_function_path,
-        resource='register_api',
-        alias=register_function
-    )
-    task.print_out(f'Add "{register_function}" call to the code')
-    code = append_code_to_function(
-        code=code,
-        function_name='register_api',
-        new_code=f'{register_function}(logger, app, authorizer, rpc_caller, publisher)' # noqa
-    )
-    task.print_out(f'Write modified code to: {module_api_file_path}')
-    await write_text_file_async(module_api_file_path, code)
-
-
-async def register_rpc(
-    task: Task,
-    project_dir: str,
-    kebab_app_name: str,
-    snake_module_name: str,
-    snake_entity_name: str
-):
-    module_rpc_file_path = os.path.join(
-        project_dir, 'src', kebab_app_name, 'src', 'module', snake_module_name,
-        'rpc.py'
-    )
-    register_function_path = '.'.join([
-        'module', snake_module_name, 'entity', snake_entity_name, 'rpc'
-    ])
-    register_function = f'register_{snake_entity_name}_rpc'
-    task.print_out(f'Read code from: {module_rpc_file_path}')
-    code = await read_text_file_async(module_rpc_file_path)
-    task.print_out(
-        f'Add import "register_rpc" as "{register_function}" ' +
-        f'from "{register_function_path}" to the code'
-    )
-    code = add_import_module(
-        code=code,
-        module_path=register_function_path,
-        resource='register_rpc',
-        alias=register_function
-    )
-    task.print_out(f'Add "{register_function}" call to the code')
-    code = append_code_to_function(
-        code=code,
-        function_name='register_rpc',
-        new_code=f'{register_function}(logger, rpc_server, rpc_caller, publisher)' # noqa
-    )
-    task.print_out(f'Write modified code to: {module_rpc_file_path}')
-    await write_text_file_async(module_rpc_file_path, code)
-
-
-async def register_permission(
-    task: Task,
-    project_dir: str,
-    kebab_app_name: str,
-    snake_module_name: str,
-    snake_entity_name: str
-):
-    module_register_permission_file_path = os.path.join(
-        project_dir, 'src', kebab_app_name, 'src', 'module', 'auth',
-        'register_permission.py'
-    )
-    task.print_out(f'Read code from: {module_register_permission_file_path}')
-    code = await read_text_file_async(module_register_permission_file_path)
-    code = append_code_to_function(
-        code=code,
-        function_name='register_permission',
-        new_code='\n'.join([
-            'await ensure_entity_permission(',
-            f"    module_name='{snake_module_name}', entity_name='{snake_entity_name}'", # noqa
-            ')'
-        ])
-    )
-    task.print_out(
-        f'Add "ensure_entity_permission" call for {snake_entity_name} ' +
-        'to the code'
-    )
-    task.print_out(
-        f'Write modified code to: {module_register_permission_file_path}'
-    )
-    await write_text_file_async(module_register_permission_file_path, code)

zrb/builtin/generator/fastapp_crud/helper.py

@@ -0,0 +1,115 @@
+from typeguard import typechecked
+from ....task.task import Task
+from ....helper.codemod.add_import_module import add_import_module
+from ....helper.codemod.append_code_to_function import append_code_to_function
+from ....helper.file.text import read_text_file_async, write_text_file_async
+import os
+
+
+@typechecked
+async def register_api(
+    task: Task,
+    project_dir: str,
+    kebab_app_name: str,
+    snake_module_name: str,
+    snake_entity_name: str
+):
+    module_api_file_path = os.path.join(
+        project_dir, 'src', kebab_app_name, 'src', 'module', snake_module_name,
+        'api.py'
+    )
+    register_function_path = '.'.join([
+        'module', snake_module_name, 'entity', snake_entity_name, 'api'
+    ])
+    register_function = f'register_{snake_entity_name}_api'
+    task.print_out(f'Read code from: {module_api_file_path}')
+    code = await read_text_file_async(module_api_file_path)
+    task.print_out(
+        f'Add import "register_api" as "{register_function}" ' +
+        f'from "{register_function_path}" to the code'
+    )
+    code = add_import_module(
+        code=code,
+        module_path=register_function_path,
+        resource='register_api',
+        alias=register_function
+    )
+    task.print_out(f'Add "{register_function}" call to the code')
+    code = append_code_to_function(
+        code=code,
+        function_name='register_api',
+        new_code=f'{register_function}(logger, app, authorizer, rpc_caller, publisher)' # noqa
+    )
+    task.print_out(f'Write modified code to: {module_api_file_path}')
+    await write_text_file_async(module_api_file_path, code)
+
+
+@typechecked
+async def register_rpc(
+    task: Task,
+    project_dir: str,
+    kebab_app_name: str,
+    snake_module_name: str,
+    snake_entity_name: str
+):
+    module_rpc_file_path = os.path.join(
+        project_dir, 'src', kebab_app_name, 'src', 'module', snake_module_name,
+        'rpc.py'
+    )
+    register_function_path = '.'.join([
+        'module', snake_module_name, 'entity', snake_entity_name, 'rpc'
+    ])
+    register_function = f'register_{snake_entity_name}_rpc'
+    task.print_out(f'Read code from: {module_rpc_file_path}')
+    code = await read_text_file_async(module_rpc_file_path)
+    task.print_out(
+        f'Add import "register_rpc" as "{register_function}" ' +
+        f'from "{register_function_path}" to the code'
+    )
+    code = add_import_module(
+        code=code,
+        module_path=register_function_path,
+        resource='register_rpc',
+        alias=register_function
+    )
+    task.print_out(f'Add "{register_function}" call to the code')
+    code = append_code_to_function(
+        code=code,
+        function_name='register_rpc',
+        new_code=f'{register_function}(logger, rpc_server, rpc_caller, publisher)' # noqa
+    )
+    task.print_out(f'Write modified code to: {module_rpc_file_path}')
+    await write_text_file_async(module_rpc_file_path, code)
+
+
+@typechecked
+async def register_permission(
+    task: Task,
+    project_dir: str,
+    kebab_app_name: str,
+    snake_module_name: str,
+    snake_entity_name: str
+):
+    module_register_permission_file_path = os.path.join(
+        project_dir, 'src', kebab_app_name, 'src', 'module', 'auth',
+        'register_permission.py'
+    )
+    task.print_out(f'Read code from: {module_register_permission_file_path}')
+    code = await read_text_file_async(module_register_permission_file_path)
+    code = append_code_to_function(
+        code=code,
+        function_name='register_permission',
+        new_code='\n'.join([
+            'await ensure_entity_permission(',
+            f"    module_name='{snake_module_name}', entity_name='{snake_entity_name}'", # noqa
+            ')'
+        ])
+    )
+    task.print_out(
+        f'Add "ensure_entity_permission" call for {snake_entity_name} ' +
+        'to the code'
+    )
+    task.print_out(
+        f'Write modified code to: {module_register_permission_file_path}'
+    )
+    await write_text_file_async(module_register_permission_file_path, code)

zrb/builtin/generator/fastapp_crud/{add_navigation.py → task_factory.py}

@@ -1,7 +1,8 @@
 from typing import List
-from ....task.task import Task
+from typeguard import typechecked
+from ....task.any_task import AnyTask
 from ....task.cmd_task import CmdTask
-from .._common.task_input import (
+from ..common.task_input import (
     project_dir_input, app_name_input, module_name_input, entity_name_input,
 )
 
@@ -17,7 +18,8 @@ NAV_URL = '/{{util.to_kebab_case(input.module_name)}}/{{util.to_kebab_case(input
 NAV_PERMISSION = '{{util.to_snake_case(input.module_name)}}:{{util.to_snake_case(input.entity_name)}}:get' # noqa
 
 
-def create_add_navigation_task(upstreams: List[Task]) -> Task:
+@typechecked
+def create_add_navigation_task(upstreams: List[AnyTask]) -> AnyTask:
     return CmdTask(
         name='add-navigation',
         inputs=[