zrb 0.23.4__py3-none-any.whl → 0.26.0__py3-none-any.whl

zrb/builtin/project/add/fastapp/module/_helper/register_migration.py

@@ -0,0 +1,35 @@
+import os
+
+from zrb.helper.codemod.add_import_module import add_import_module
+from zrb.helper.codemod.append_code_to_function import append_code_to_function
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+
+@typechecked
+async def register_migration(
+    task: Task, project_dir: str, app_name: str, module_name: str
+):
+    kebab_app_name = to_kebab_case(app_name)
+    snake_module_name = to_snake_case(module_name)
+    app_migration_file_path = os.path.join(
+        project_dir, "src", kebab_app_name, "src", "migrate.py"
+    )
+    import_module_path = ".".join(["module", snake_module_name, "migrate"])
+    function_name = f"migrate_{snake_module_name}"
+    task.print_out(f"Read code from: {app_migration_file_path}")
+    code = await read_text_file_async(app_migration_file_path)
+    task.print_out(
+        f'Add import "{function_name}" from "{import_module_path}" to the code'
+    )
+    code = add_import_module(
+        code=code, module_path=import_module_path, resource=function_name
+    )
+    task.print_out(f'Add "{function_name}" call to the code')
+    code = append_code_to_function(
+        code=code, function_name="migrate", new_code=f"await {function_name}()"
+    )
+    task.print_out(f"Write modified code to: {app_migration_file_path}")
+    await write_text_file_async(app_migration_file_path, code)

zrb/builtin/project/add/fastapp/module/_helper/register_module.py

@@ -0,0 +1,33 @@
+import os
+
+from zrb.helper.codemod.add_function_call import add_function_call
+from zrb.helper.codemod.add_import_module import add_import_module
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+
+@typechecked
+async def register_module(
+    task: Task, project_dir: str, app_name: str, module_name: str
+):
+    kebab_app_name = to_kebab_case(app_name)
+    snake_module_name = to_snake_case(module_name)
+    app_main_file_path = os.path.join(
+        project_dir, "src", kebab_app_name, "src", "main.py"
+    )
+    import_module_path = ".".join(["module", snake_module_name, "register_module"])
+    function_name = f"register_{snake_module_name}"
+    task.print_out(f"Read code from: {app_main_file_path}")
+    code = await read_text_file_async(app_main_file_path)
+    task.print_out(
+        f'Add import "{function_name}" from "{import_module_path}" to the code'
+    )
+    code = add_import_module(
+        code=code, module_path=import_module_path, resource=function_name
+    )
+    task.print_out(f'Add "{function_name}" call to the code')
+    code = add_function_call(code=code, function_name=function_name, parameters=[])
+    task.print_out(f"Write modified code to: {app_main_file_path}")
+    await write_text_file_async(app_main_file_path, code)

zrb/builtin/project/add/fastapp/module/module.py

@@ -1,5 +1,6 @@
 import asyncio
 import os
+from typing import Any
 
 from zrb.builtin.project._helper import validate_existing_project_dir
 from zrb.builtin.project._input import project_dir_input
@@ -18,7 +19,6 @@ from zrb.builtin.project.add.fastapp.module._helper import (
 from zrb.builtin.project.add.fastapp.module._input import module_name_input
 from zrb.helper import util
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker
@@ -88,57 +88,28 @@ async def add_fastapp_module(*args: Any, **kwargs: Any):
     project_dir = kwargs.get("project_dir", ".")
     app_name = kwargs.get("app_name")
     module_name = kwargs.get("module_name")
-    kebab_app_name = util.to_kebab_case(app_name)
-    snake_app_name = util.to_snake_case(app_name)
-    kebab_module_name = util.to_kebab_case(module_name)
-    snake_module_name = util.to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
     await asyncio.gather(
         asyncio.create_task(
-            create_microservice_config(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_app_name,
-                kebab_module_name,
-                snake_module_name,
-                upper_snake_module_name,
-            )
-        ),
-        asyncio.create_task(
-            register_module(task, project_dir, kebab_app_name, snake_module_name)
+            create_microservice_config(task, project_dir, app_name, module_name)
         ),
+        asyncio.create_task(register_module(task, project_dir, app_name, module_name)),
         asyncio.create_task(
-            register_migration(task, project_dir, kebab_app_name, snake_module_name)
+            register_migration(task, project_dir, app_name, module_name)
         ),
         asyncio.create_task(
-            create_app_config(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_module_name,
-                upper_snake_module_name,
-            )
+            create_app_config(task, project_dir, app_name, module_name)
         ),
         asyncio.create_task(
-            append_all_enabled_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
+            append_all_enabled_env(task, project_dir, app_name, module_name)
         ),
         asyncio.create_task(
-            append_all_disabled_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
+            append_all_disabled_env(task, project_dir, app_name, module_name)
         ),
         asyncio.create_task(
-            append_src_template_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
+            append_src_template_env(task, project_dir, app_name, module_name)
         ),
         asyncio.create_task(
-            append_deployment_template_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
+            append_deployment_template_env(task, project_dir, app_name, module_name)
         ),
     )
     task.print_out(colored("Fastapp crud added", color="yellow"))

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/migrate.py

@@ -1,4 +1,4 @@
-from config import app_enable_snake_zrb_module_name_module
+from config import APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE
 from helper.migration import migrate
 from integration.db_connection import engine
 from integration.log import logger
@@ -6,7 +6,7 @@ from module.snake_zrb_module_name.integration import Base
 
 
 async def migrate_snake_zrb_module_name():
-    if not app_enable_snake_zrb_module_name_module:
+    if not APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE:
         logger.info('🥪 Skip DB migration for "snake_zrb_module_name"')
         return
     logger.info('🥪 Perform DB migration for "snake_zrb_module_name"')

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/register_module.py

@@ -1,8 +1,8 @@
 from config import (
-    app_enable_api,
-    app_enable_event_handler,
-    app_enable_rpc_server,
-    app_enable_snake_zrb_module_name_module,
+    APP_ENABLE_API,
+    APP_ENABLE_EVENT_HANDLER,
+    APP_ENABLE_RPC_SERVER,
+    APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE,
 )
 from integration.app.app import app
 from integration.log import logger
@@ -15,10 +15,10 @@ from module.snake_zrb_module_name.rpc import register_rpc
 
 
 def register_snake_zrb_module_name():
-    if not app_enable_snake_zrb_module_name_module:
+    if not APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE:
         logger.info('🥪 Skip registering "snake_zrb_module_name"')
         return
-    if app_enable_api:
+    if APP_ENABLE_API:
         register_api(
             logger=logger,
             app=app,
@@ -26,11 +26,11 @@ def register_snake_zrb_module_name():
             rpc_caller=rpc_caller,
             publisher=publisher,
         )
-    if app_enable_event_handler:
+    if APP_ENABLE_EVENT_HANDLER:
         register_event(
             logger=logger, consumer=consumer, rpc_caller=rpc_caller, publisher=publisher
         )
-    if app_enable_rpc_server:
+    if APP_ENABLE_RPC_SERVER:
         register_rpc(
             logger=logger,
             rpc_server=rpc_server,

zrb/builtin/project/add/plugin/plugin.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._helper import (
     create_register_module,
@@ -17,9 +18,8 @@ from zrb.builtin.project.add.plugin._input import (
     package_repository_input,
 )
 from zrb.builtin.project.add.project_task import add_project_tasks
-from zrb.config.config import version
+from zrb.config.config import VERSION
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker
@@ -61,7 +61,7 @@ copy_resource = ResourceMaker(
         "zrbPackageDocumentation": "{{input.package_documentation}}",
         "zrbPackageAuthorName": "{{input.package_author_name}}",
         "zrbPackageAuthorEmail": "{{input.package_author_email}}",
-        "zrbVersion": version,
+        "zrbVersion": VERSION,
     },
     template_path=os.path.join(_CURRENT_DIR, "template"),
     destination_path="{{ input.project_dir }}",

zrb/builtin/project/add/project_task/add.py

@@ -1,11 +1,11 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._input import project_dir_input
 from zrb.helper.codemod.add_assert_resource import add_assert_resource
 from zrb.helper.codemod.add_import_module import add_import_module
 from zrb.helper.file.copy_tree import copy_tree
 from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.typing import Any
 from zrb.task.decorator import python_task
 from zrb.task.task import Task
 

zrb/builtin/project/add/project_task/template/_automate/_project/build.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 
 @python_task(

zrb/builtin/project/add/project_task/template/_automate/_project/container/remove.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 from ._group import project_container_group
 

zrb/builtin/project/add/project_task/template/_automate/_project/container/start.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 from ._group import project_container_group
 

zrb/builtin/project/add/project_task/template/_automate/_project/container/stop.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 from ._group import project_container_group
 

zrb/builtin/project/add/project_task/template/_automate/_project/deploy.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 
 @python_task(

zrb/builtin/project/add/project_task/template/_automate/_project/destroy.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 
 @python_task(

zrb/builtin/project/add/project_task/template/_automate/_project/get_env.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import BoolInput, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.env_map.fetch import fetch_env_map_from_group
-from zrb.helper.typing import Any, Mapping
 
 
 @python_task(

zrb/builtin/project/add/project_task/template/_automate/_project/image/build.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 from ._group import project_image_group
 

zrb/builtin/project/add/project_task/template/_automate/_project/image/push.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 from ._group import project_image_group
 

zrb/builtin/project/add/project_task/template/_automate/_project/publish.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 
 @python_task(

zrb/builtin/project/add/project_task/template/_automate/_project/start.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 
 
 @python_task(

zrb/builtin/project/add/task/cmd/add.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._helper import (
     create_register_module,
@@ -8,7 +9,6 @@ from zrb.builtin.project._helper import (
 from zrb.builtin.project._input import project_dir_input
 from zrb.builtin.project.add.task._group import project_add_task_group
 from zrb.builtin.project.add.task._input import task_name_input
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker

zrb/builtin/project/add/task/docker_compose/add.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._helper import (
     create_register_module,
@@ -12,7 +13,6 @@ from zrb.builtin.project.add.task.docker_compose._input import (
     compose_command_input,
     http_port_input,
 )
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker

zrb/builtin/project/add/task/docker_compose/template/src/kebab-zrb-task-name/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 x-logging: &default-logging
   options:
     max-size: "100m"

zrb/builtin/project/add/task/python/add.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._helper import (
     create_register_module,
@@ -8,7 +9,6 @@ from zrb.builtin.project._helper import (
 from zrb.builtin.project._input import project_dir_input
 from zrb.builtin.project.add.task._group import project_add_task_group
 from zrb.builtin.project.add.task._input import task_name_input
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker

zrb/builtin/project/add/task/python/template/_automate/snake_zrb_task_name.py

@@ -1,4 +1,4 @@
-from typing import Any, Mapping
+from typing import Any
 
 from zrb import Task, python_task, runner
 from zrb.builtin import project_group

zrb/builtin/project/create/_helper.py

@@ -1,6 +1,6 @@
 import os
+from collections.abc import Mapping
 
-from zrb.helper.typing import Mapping
 from zrb.task.resource_maker import ResourceMaker
 
 

zrb/builtin/project/create/create.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 from zrb.builtin.project._group import project_group
 from zrb.builtin.project._input import project_dir_input
@@ -10,9 +11,8 @@ from zrb.builtin.project.create._input import (
     project_description_input,
     project_name_input,
 )
-from zrb.config.config import version
+from zrb.config.config import VERSION
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.cmd_task import CmdTask
 from zrb.task.decorator import python_task
@@ -57,7 +57,7 @@ copy_resource = ResourceMaker(
         "zrbProjectAuthorName": "{{input.project_author_name}}",
         "zrbProjectAuthorEmail": "{{input.project_author_email}}",
         "zrbImageDefaultNamespace": _IMAGE_DEFAULT_NAMESPACE,
-        "zrbVersion": version,
+        "zrbVersion": VERSION,
     },
     replacement_mutator=copy_resource_replacement_mutator,
     template_path=os.path.join(_CURRENT_DIR, "template"),

zrb/builtin/say.py

@@ -1,8 +1,8 @@
 import datetime
 import random
+from typing import Any
 
 from zrb.helper.task import show_lines
-from zrb.helper.typing import Any, List
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.int_input import IntInput
@@ -94,7 +94,7 @@ def say(*args: Any, **kwargs: Any):
     show_lines(kwargs["_task"], *lines)
 
 
-def _get_content(text: str, width: int) -> List[str]:
+def _get_content(text: str, width: int) -> list[str]:
     if text == "":
         now = datetime.datetime.now()
         today = "Today is " + now.strftime("%A, %B %d, %Y")
@@ -108,7 +108,7 @@ def _get_content(text: str, width: int) -> List[str]:
     return _split_text_by_width(text, width)
 
 
-def _split_text_by_width(text: str, width: int) -> List[str]:
+def _split_text_by_width(text: str, width: int) -> list[str]:
     original_lines = text.split("\n")
     new_lines = []
     for original_line in original_lines:

zrb/builtin/version.py

@@ -1,5 +1,6 @@
-from zrb.config.config import version
-from zrb.helper.typing import Any
+from typing import Any
+
+from zrb.config.config import VERSION
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.task import Task
@@ -8,5 +9,5 @@ from zrb.task.task import Task
 @python_task(name="version", description="Get Zrb version", runner=runner)
 async def get_version(*args: Any, **kwargs: Any) -> str:
     task: Task = kwargs.get("_task")
-    task.print_out(version)
-    return version
+    task.print_out(VERSION)
+    return VERSION

zrb/config/config.py

@@ -30,19 +30,29 @@ def _get_default_tmp_dir() -> str:
     return os.path.expanduser(os.path.join("~", ".tmp"))
 
 
-tmp_dir = os.getenv("ZRB_TMP_DIR", _get_default_tmp_dir())
-default_shell = os.getenv("ZRB_SHELL", _get_current_shell())
-default_editor = os.getenv("ZRB_EDITOR", "nano")
-init_script_str = os.getenv("ZRB_INIT_SCRIPTS", "")
-init_scripts = init_script_str.split(":") if init_script_str != "" else []
-logging_level = untyped_to_logging_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
-should_load_builtin = untyped_to_boolean(os.getenv("ZRB_SHOULD_LOAD_BUILTIN", "1"))
-env_prefix = os.getenv("ZRB_ENV", "")
-show_advertisement = untyped_to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
-show_prompt = untyped_to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
-show_time = untyped_to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
-version = _get_version()
-container_backend = _get_valid_container_backend(
+TMP_DIR = os.getenv("ZRB_TMP_DIR", _get_default_tmp_dir())
+DEFAULT_SHELL = os.getenv("ZRB_SHELL", _get_current_shell())
+DEFAULT_EDITOR = os.getenv("ZRB_EDITOR", "nano")
+INIT_MODULES_STR = os.getenv("ZRB_INIT_MODULES", "")
+INIT_MODULES = (
+    [module.strip() for module in INIT_MODULES_STR.split(":") if module.strip() != ""]
+    if INIT_MODULES_STR != ""
+    else []
+)
+INIT_SCRIPTS_STR = os.getenv("ZRB_INIT_SCRIPTS", "")
+INIT_SCRIPTS = (
+    [script.strip() for script in INIT_SCRIPTS_STR.split(":") if script.strip() != ""]
+    if INIT_SCRIPTS_STR != ""
+    else []
+)
+LOGGING_LEVEL = untyped_to_logging_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
+SHOULD_LOAD_BUILTIN = untyped_to_boolean(os.getenv("ZRB_SHOULD_LOAD_BUILTIN", "1"))
+ENV_PREFIX = os.getenv("ZRB_ENV", "")
+SHOW_ADVERTISEMENT = untyped_to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
+SHOW_PROMPT = untyped_to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
+SHOW_TIME = untyped_to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
+VERSION = _get_version()
+CONTAINER_BACKEND = _get_valid_container_backend(
     os.getenv("ZRB_CONTAINER_BACKEND", "docker")
 )
-enable_type_checking = untyped_to_boolean(os.getenv("ZRB_ENABLE_TYPE_CHECKING", "1"))
+ENABLE_TYPE_CHECKING = untyped_to_boolean(os.getenv("ZRB_ENABLE_TYPE_CHECKING", "1"))

zrb/helper/accessories/color.py

@@ -1,11 +1,12 @@
 import random
+from collections.abc import Iterable
+from typing import Optional
 
 from termcolor import COLORS
 
 from zrb.helper.accessories.untyped_color import untyped_colored
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Iterable, Optional
 
 logger.debug(untyped_colored("Loading zrb.helper.accessories.color", attrs=["dark"]))
 

zrb/helper/advertisement.py

@@ -2,11 +2,12 @@ import datetime
 import random
 import re
 import sys
+from collections.abc import Iterable
+from typing import Optional
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Iterable, Optional
 
 logger.debug(colored("Loading zrb.helper.advertisement", attrs=["dark"]))
 

zrb/helper/asyncio_task.py

@@ -0,0 +1,23 @@
+import asyncio
+
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.helper.asyncio_task", attrs=["dark"]))
+
+
+async def stop_asyncio():
+    tasks = [task for task in asyncio.all_tasks() if task is not asyncio.current_task()]
+    for task in tasks:
+        task.cancel()
+
+    # Wait until all tasks are cancelled
+    await asyncio.gather(*tasks, return_exceptions=True)
+
+
+def stop_asyncio_sync():
+    loop = asyncio.get_event_loop()
+    if loop.is_running():
+        loop.create_task(stop_asyncio())
+    else:
+        loop.run_until_complete(stop_asyncio())

zrb/helper/callable.py

@@ -1,13 +1,16 @@
 import asyncio
 import inspect
-from typing import Any, Callable
+from collections.abc import Callable
+from typing import Any
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
+from zrb.helper.typecheck import typechecked
 
 logger.debug(colored("Loading zrb.helper.callable", attrs=["dark"]))
 
 
+@typechecked
 async def run_async(fn: Callable, *args: Any, **kwargs: Any) -> Any:
     if inspect.iscoroutinefunction(fn):
         return await fn(*args, **kwargs)