zrb 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

zrb/builtin/generator/common/task_factory.py

@@ -1,17 +1,19 @@
-from zrb.helper.typing import Any, List, Optional
-from zrb.helper.typecheck import typechecked
-from zrb.builtin.generator.common.task_input import project_dir_input
+import os
+
 from zrb.builtin.generator.common.helper import (
-    validate_existing_project_dir, register_module_to_project
+    register_module_to_project,
+    validate_existing_project_dir,
 )
-from zrb.task.decorator import python_task
+from zrb.builtin.generator.common.task_input import project_dir_input
+from zrb.helper.codemod.add_import_module import add_import_module
+from zrb.helper.codemod.add_upstream_to_task import add_upstream_to_task
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, List, Optional
 from zrb.task.any_task import AnyTask
+from zrb.task.decorator import python_task
 from zrb.task.task import Task
 from zrb.task_input.any_input import AnyInput
-from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.codemod.add_import_module import add_import_module
-from zrb.helper.codemod.add_upstream_to_task import add_upstream_to_task
-import os
 
 
 @typechecked
@@ -19,30 +21,32 @@ def create_register_module(
     module_path: str,
     inputs: Optional[List[AnyInput]] = None,
     upstreams: Optional[List[AnyTask]] = None,
-    alias: Optional[str] = None
+    alias: Optional[str] = None,
 ) -> Task:
     @python_task(
-        name='register-module',
+        name="register-module",
         inputs=[project_dir_input] + inputs if inputs is not None else [],
-        upstreams=upstreams if upstreams is not None else []
+        upstreams=upstreams if upstreams is not None else [],
     )
     async def register_module(*args: Any, **kwargs: Any):
-        task: Task = kwargs.get('_task')
-        project_dir = kwargs.get('project_dir')
+        task: Task = kwargs.get("_task")
+        project_dir = kwargs.get("project_dir")
         validate_existing_project_dir(project_dir)
         rendered_module_path = task.render_str(module_path)
         rendered_alias: Optional[str] = None
         if alias is not None:
             rendered_alias = task.render_str(alias)
         task.print_out(
-            f'Register module: {rendered_module_path}' +
-            f' as {rendered_alias}' if rendered_alias is not None else ''
+            f"Register module: {rendered_module_path}" + f" as {rendered_alias}"
+            if rendered_alias is not None
+            else ""
         )
         await register_module_to_project(
             project_dir=project_dir,
             module_path=rendered_module_path,
-            alias=rendered_alias
+            alias=rendered_alias,
         )
+
     return register_module
 
 
@@ -53,32 +57,31 @@ def create_add_upstream(
     upstream_module: str,
     upstream_task_var: str,
     inputs: Optional[List[AnyInput]] = None,
-    upstreams: Optional[List[AnyTask]] = None
+    upstreams: Optional[List[AnyTask]] = None,
 ) -> Task:
     @python_task(
-        name='register-upstream',
+        name="register-upstream",
         inputs=[project_dir_input] + inputs if inputs is not None else [],
-        upstreams=upstreams if upstreams is not None else []
+        upstreams=upstreams if upstreams is not None else [],
     )
     async def register_upstream(*args: Any, **kwargs: Any):
-        task: Task = kwargs.get('_task')
-        project_dir = kwargs.get('project_dir', '.')
+        task: Task = kwargs.get("_task")
+        project_dir = kwargs.get("project_dir", ".")
         rendered_task_file_name = task.render_str(task_file_name)
         rendered_task_name = task.render_str(task_name)
         rendered_upstream_module_path = task.render_str(upstream_module)
         rendered_upstream_task_var = task.render_str(upstream_task_var)
         if not os.path.isabs(rendered_task_file_name):
-            rendered_task_file_name = os.path.join(
-                project_dir, rendered_task_file_name
-            )
+            rendered_task_file_name = os.path.join(project_dir, rendered_task_file_name)
         code = await read_text_file_async(rendered_task_file_name)
         code = add_import_module(
             code=code,
             module_path=rendered_upstream_module_path,
-            resource=rendered_upstream_task_var
+            resource=rendered_upstream_task_var,
         )
         code = add_upstream_to_task(
             code, rendered_task_name, rendered_upstream_task_var
         )
         await write_text_file_async(rendered_task_file_name, code)
+
     return register_upstream

zrb/builtin/generator/common/task_input.py

@@ -1,154 +1,160 @@
-from zrb.task_input.str_input import StrInput
-from zrb.task_input.int_input import IntInput
-from zrb.helper.accessories.name import get_random_name
 import os
 
-SYSTEM_USER = os.getenv('USER', 'incognito')
+from zrb.helper.accessories.name import get_random_name
+from zrb.task_input.int_input import IntInput
+from zrb.task_input.str_input import StrInput
+
+SYSTEM_USER = os.getenv("USER", "incognito")
 
 project_dir_input = StrInput(
-    name='project-dir',
-    shortcut='d',
-    description='Project directory',
-    prompt='Project directory',
-    default='.',
+    name="project-dir",
+    shortcut="d",
+    description="Project directory",
+    prompt="Project directory",
+    default=".",
 )
 
 project_name_input = StrInput(
-    name='project-name',
-    shortcut='n',
-    description='Project name',
-    prompt='Project name (can be empty)',
-    default='',
+    name="project-name",
+    shortcut="n",
+    description="Project name",
+    prompt="Project name (can be empty)",
+    default="",
 )
 
 app_name_input = StrInput(
-    name='app-name',
-    shortcut='a',
-    description='App name',
-    prompt='App name',
-    default='app',
+    name="app-name",
+    shortcut="a",
+    description="App name",
+    prompt="App name",
+    default="app",
 )
 
 app_image_default_namespace = os.getenv(
-    'PROJECT_IMAGE_DEFAULT_NAMESPACE',
-    'docker.io/' + SYSTEM_USER
+    "PROJECT_IMAGE_DEFAULT_NAMESPACE", "docker.io/" + SYSTEM_USER
 )
 app_image_name_input = StrInput(
-    name='app-image-name',
-    description='App image name',
-    prompt='App image name',
-    default=app_image_default_namespace + '/' + '{{util.to_kebab_case(input.app_name)}}',  # noqa
+    name="app-image-name",
+    description="App image name",
+    prompt="App image name",
+    default=app_image_default_namespace
+    + "/"
+    + "{{util.to_kebab_case(input.app_name)}}",  # noqa
 )
 
 module_name_input = StrInput(
-    name='module-name',
-    shortcut='m',
-    description='module name',
-    prompt='module name',
-    default='library',
+    name="module-name",
+    shortcut="m",
+    description="module name",
+    prompt="module name",
+    default="library",
 )
 
 entity_name_input = StrInput(
-    name='entity-name',
-    shortcut='e',
-    description='Singular entity name',
-    prompt='Singular entity name',
-    default='book'
+    name="entity-name",
+    shortcut="e",
+    description="Singular entity name",
+    prompt="Singular entity name",
+    default="book",
 )
 
 plural_entity_name_input = StrInput(
-    name='plural-entity-name',
-    description='Plural entity name',
-    prompt='Plural entity name',
-    default='books'
+    name="plural-entity-name",
+    description="Plural entity name",
+    prompt="Plural entity name",
+    default="books",
 )
 
 main_column_name_input = StrInput(
-    name='column-name',
-    shortcut='c',
-    description='Main column name',
-    prompt='Main column name',
-    default='code'
+    name="column-name",
+    shortcut="c",
+    description="Main column name",
+    prompt="Main column name",
+    default="code",
 )
 
 column_name_input = StrInput(
-    name='column-name',
-    shortcut='c',
-    description='Column name',
-    prompt='Column name',
-    default='title'
+    name="column-name",
+    shortcut="c",
+    description="Column name",
+    prompt="Column name",
+    default="title",
 )
 
 column_type_input = StrInput(
-    name='column-type',
-    shortcut='t',
-    description='Column type',
-    prompt='Column type',
-    default='str'
+    name="column-type",
+    shortcut="t",
+    description="Column type",
+    prompt="Column type",
+    default="str",
 )
 
 task_name_input = StrInput(
-    name='task-name',
-    shortcut='t',
-    description='Task name',
-    prompt='Task name',
-    default=f'run-{get_random_name()}',
+    name="task-name",
+    shortcut="t",
+    description="Task name",
+    prompt="Task name",
+    default=f"run-{get_random_name()}",
 )
 
 http_port_input = IntInput(
-    name='http-port',
-    shortcut='p',
-    description='HTTP port',
-    prompt='HTTP port',
+    name="http-port",
+    shortcut="p",
+    description="HTTP port",
+    prompt="HTTP port",
     default=8080,
 )
 
 env_prefix_input = StrInput(
-    name='env-prefix',
-    description='OS environment prefix',
-    prompt='OS environment prefix',
+    name="env-prefix",
+    description="OS environment prefix",
+    prompt="OS environment prefix",
     default='{{util.to_snake_case(util.coalesce(input.app_name, input.task_name, "MY")).upper()}}',  # noqa
 )
 
 package_name_input = StrInput(
-    name='package-name',
-    shortcut='p',
-    description='Package name',
-    prompt='Package name',
-    default=get_random_name()
+    name="package-name",
+    shortcut="p",
+    description="Package name",
+    prompt="Package name",
+    default=get_random_name(),
 )
 
 package_description_input = StrInput(
-    name='package-description',
-    description='Package description',
-    prompt='Package description',
-    default='My super package'
+    name="package-description",
+    description="Package description",
+    prompt="Package description",
+    default="My super package",
 )
 
 package_homepage_input = StrInput(
-    name='package-homepage',
-    description='Package homepage',
-    prompt='Package homepage',
-    default='https://github.com/' + SYSTEM_USER + '/{{util.to_kebab_case(input.package_name)}}'  # noqa
+    name="package-homepage",
+    description="Package homepage",
+    prompt="Package homepage",
+    default="https://github.com/"
+    + SYSTEM_USER
+    + "/{{util.to_kebab_case(input.package_name)}}",  # noqa
 )
 
 package_bug_tracker_input = StrInput(
-    name='package-bug-tracker',
-    description='Package bug tracker',
-    prompt='Package bug tracker',
-    default='https://github.com/' + SYSTEM_USER + '/{{util.to_kebab_case(input.package_name)}}/issues' # noqa
+    name="package-bug-tracker",
+    description="Package bug tracker",
+    prompt="Package bug tracker",
+    default="https://github.com/"
+    + SYSTEM_USER
+    + "/{{util.to_kebab_case(input.package_name)}}/issues",  # noqa
 )
 
 package_author_name_input = StrInput(
-    name='package-author-name',
-    prompt='Package author name',
-    description='Package author name',
-    default=SYSTEM_USER
+    name="package-author-name",
+    prompt="Package author name",
+    description="Package author name",
+    default=SYSTEM_USER,
 )
 
 package_author_email_input = StrInput(
-    name='package-author-email',
-    prompt='Package author email',
-    description='Package author email',
-    default=f'{SYSTEM_USER}@gmail.com'
+    name="package-author-email",
+    prompt="Package author email",
+    description="Package author email",
+    default=f"{SYSTEM_USER}@gmail.com",
 )

zrb/builtin/generator/docker_compose_task/add.py

@@ -1,20 +1,24 @@
-from zrb.helper.typing import Any
-from zrb.builtin.generator.common.task_input import (
-   project_dir_input, task_name_input, http_port_input, env_prefix_input
-)
+import os
+
 from zrb.builtin.generator.common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
+    validate_existing_project_dir,
+    validate_inexisting_automation,
 )
 from zrb.builtin.generator.common.task_factory import create_register_module
+from zrb.builtin.generator.common.task_input import (
+    env_prefix_input,
+    http_port_input,
+    project_dir_input,
+    task_name_input,
+)
 from zrb.builtin.group import project_add_group
-from zrb.task.task import Task
+from zrb.helper import util
+from zrb.helper.typing import Any
+from zrb.runner import runner
 from zrb.task.decorator import python_task
-from zrb.task_input.str_input import StrInput
 from zrb.task.resource_maker import ResourceMaker
-from zrb.runner import runner
-from zrb.helper import util
-
-import os
+from zrb.task.task import Task
+from zrb.task_input.str_input import StrInput
 
 CURRENT_DIR = os.path.dirname(__file__)
 
@@ -24,62 +28,57 @@ CURRENT_DIR = os.path.dirname(__file__)
 
 
 @python_task(
-    name='validate',
-    inputs=[
-        project_dir_input,
-        task_name_input
-    ],
+    name="validate",
+    inputs=[project_dir_input, task_name_input],
 )
 async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get('project_dir')
+    project_dir = kwargs.get("project_dir")
     validate_existing_project_dir(project_dir)
-    task_name = kwargs.get('task_name')
+    task_name = kwargs.get("task_name")
     validate_inexisting_automation(project_dir, task_name)
-    source_dir = os.path.join(
-        project_dir, 'src', f'{util.to_kebab_case(task_name)}'
-    )
+    source_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(task_name)}")
     if os.path.exists(source_dir):
-        raise Exception(f'Source already exists: {source_dir}')
+        raise Exception(f"Source already exists: {source_dir}")
 
 
 copy_resource = ResourceMaker(
-    name='copy-resource',
+    name="copy-resource",
     inputs=[
         project_dir_input,
         task_name_input,
         http_port_input,
         StrInput(
-            name='compose-command',
-            description='Compose command (e.g., up, down, start, remove, etc)',
-            prompt='Compose command (e.g., up, down, start, remove, etc)',
-            default='up'
+            name="compose-command",
+            description="Compose command (e.g., up, down, start, remove, etc)",
+            prompt="Compose command (e.g., up, down, start, remove, etc)",
+            default="up",
         ),
         env_prefix_input,
     ],
     upstreams=[validate],
     replacements={
-        'zrbTaskName': '{{input.task_name}}',
-        'zrbHttpPort': '{{util.coalesce(input.http_port, "3001")}}',
-        'zrbComposeCommand': '{{ util.coalesce(input.compose_command, "up") }}', # noqa
-        'ZRB_ENV_PREFIX': '{{ util.coalesce(input.env_prefix, "MY").upper() }}', # noqa
+        "zrbTaskName": "{{input.task_name}}",
+        "zrbHttpPort": '{{util.coalesce(input.http_port, "3001")}}',
+        "zrbComposeCommand": '{{ util.coalesce(input.compose_command, "up") }}',  # noqa
+        "ZRB_ENV_PREFIX": '{{ util.coalesce(input.env_prefix, "MY").upper() }}',  # noqa
     },
-    template_path=os.path.join(CURRENT_DIR, 'template'),
-    destination_path='{{ input.project_dir }}',
+    template_path=os.path.join(CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
 )
 
 register_module = create_register_module(
-    module_path='_automate.{{util.to_snake_case(input.task_name)}}',
+    module_path="_automate.{{util.to_snake_case(input.task_name)}}",
     inputs=[task_name_input],
-    upstreams=[copy_resource]
+    upstreams=[copy_resource],
 )
 
 
 @python_task(
-    name='docker-compose-task',
+    name="docker-compose-task",
     group=project_add_group,
     upstreams=[register_module],
-    runner=runner
+    runner=runner,
 )
 async def add_docker_compose_task(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get('_task')
-    task.print_out('Success')
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

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

@@ -1,44 +1,38 @@
-from zrb import DockerComposeTask, HTTPChecker, Env, EnvFile, runner
-from zrb.builtin.group import project_group
 import os
 
+from zrb import DockerComposeTask, Env, EnvFile, HTTPChecker, runner
+from zrb.builtin.group import project_group
+
 ###############################################################################
 # 🏔️ Constants
 ###############################################################################
 
 CURRENT_DIR = os.path.dirname(__file__)
-PROJECT_DIR = os.path.abspath(os.path.join(CURRENT_DIR, '..'))
-RESOURCE_DIR = os.path.join(PROJECT_DIR, 'src', 'kebab-zrb-task-name')
+PROJECT_DIR = os.path.abspath(os.path.join(CURRENT_DIR, ".."))
+RESOURCE_DIR = os.path.join(PROJECT_DIR, "src", "kebab-zrb-task-name")
 
 ###############################################################################
 # ⚙️ kebab-zrb-task-name
 ###############################################################################
 
 snake_zrb_task_name = DockerComposeTask(
-    name='kebab-zrb-task-name',
-    description='human readable zrb task name',
+    name="kebab-zrb-task-name",
+    description="human readable zrb task name",
     group=project_group,
     cwd=RESOURCE_DIR,
-    compose_cmd='zrbComposeCommand',
-    compose_env_prefix='ZRB_ENV_PREFIX',
+    compose_cmd="zrbComposeCommand",
+    compose_env_prefix="ZRB_ENV_PREFIX",
     env_files=[
         EnvFile(
-            path=os.path.join(RESOURCE_DIR, 'docker-compose.env'),
-            prefix='ZRB_ENV_PREFIX'
+            path=os.path.join(RESOURCE_DIR, "docker-compose.env"),
+            prefix="ZRB_ENV_PREFIX",
         )
     ],
     envs=[
         Env(
-            name='HOST_PORT',
-            os_name='ZRB_ENV_PREFIX_HOST_PORT',
-            default='zrbHttpPort'
+            name="HOST_PORT", os_name="ZRB_ENV_PREFIX_HOST_PORT", default="zrbHttpPort"
         ),
     ],
-    checkers=[
-        HTTPChecker(
-            name='check-kebab-zrb-task-name',
-            port='{{env.HOST_PORT}}'
-        )
-    ]
+    checkers=[HTTPChecker(name="check-kebab-zrb-task-name", port="{{env.HOST_PORT}}")],
 )
 runner.register(snake_zrb_task_name)

zrb/builtin/generator/docker_compose_task/template/src/kebab-zrb-task-name/image/main.py

@@ -1,20 +1,24 @@
 import os
 
-MESSAGE = os.getenv('APP_MESSAGE', 'Hello, world!')
-PORT = int(os.getenv('APP_PORT', '8000'))
+MESSAGE = os.getenv("APP_MESSAGE", "Hello, world!")
+PORT = int(os.getenv("APP_PORT", "8000"))
 
 
 async def app(scope, receive, send):
-    assert scope['type'] == 'http'
+    assert scope["type"] == "http"
 
-    await send({
-        'type': 'http.response.start',
-        'status': 200,
-        'headers': [
-            [b'content-type', b'text/plain'],
-        ],
-    })
-    await send({
-        'type': 'http.response.body',
-        'body': bytes(MESSAGE, 'utf-8'),
-    })
+    await send(
+        {
+            "type": "http.response.start",
+            "status": 200,
+            "headers": [
+                [b"content-type", b"text/plain"],
+            ],
+        }
+    )
+    await send(
+        {
+            "type": "http.response.body",
+            "body": bytes(MESSAGE, "utf-8"),
+        }
+    )