zrb 0.9.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/src/module/log/entity/activity/api.py

@@ -8,6 +8,9 @@ from module.auth.component import Authorizer
 from module.auth.integration import access_token_scheme
 from module.auth.schema.token import AccessTokenData
 from module.log.schema.activity import Activity, ActivityResult
+from opentelemetry import trace
+
+tracer = trace.get_tracer(__name__)
 
 
 def register_api(
@@ -26,20 +29,22 @@ def register_api(
         offset: int = 0,
         user_token_data: AccessTokenData = Depends(access_token_scheme),
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id, "log:activity:get"
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id, "log:activity:get"
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "log_get_activity",
-                keyword=keyword,
-                criterion={},
-                limit=limit,
-                offset=offset,
-                user_token_data=user_token_data.model_dump(),
-            )
-            return ActivityResult(**result_dict)
+            with tracer.start_as_current_span("log.rpc.log_get_activity"):
+                result_dict = await rpc_caller.call(
+                    "log_get_activity",
+                    keyword=keyword,
+                    criterion={},
+                    limit=limit,
+                    offset=offset,
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return ActivityResult(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)
 
@@ -47,16 +52,18 @@ def register_api(
     async def get_activity_by_id(
         id: str, user_token_data: AccessTokenData = Depends(access_token_scheme)
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id, "log:activity:get_by_id"
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id, "log:activity:get_by_id"
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "log_get_activity_by_id",
-                id=id,
-                user_token_data=user_token_data.model_dump(),
-            )
-            return Activity(**result_dict)
+            with tracer.start_as_current_span("log.rpc.log_get_activity_by_id"):
+                result_dict = await rpc_caller.call(
+                    "log_get_activity_by_id",
+                    id=id,
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return Activity(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/src/module/log/entity/activity/event.py

@@ -13,7 +13,5 @@ def register_event(
     logger.info('🥪 Register event handlers for "log.activity"')
 
     @consumer.register("log_new_activity")
-    async def insert(
-        data: Mapping[str, Any],
-    ):
+    async def insert(data: Mapping[str, Any]):
         await activity_model.insert(data=ActivityData(**data))

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/src/pyproject.toml

@@ -30,7 +30,7 @@ opentelemetry-instrumentation-fastapi= "==0.44b0"
 
 [tool.poetry.dev-dependencies]
 flake8 = "~7.0.0"
-black = "~24.2.0"
+black = "~24.3.0"
 isort = "~5.13.2"
 pytest = "~7.4.0"
 pytest-cov = "~4.1.0"

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/src/start.sh

@@ -39,20 +39,25 @@ fi
 # Start kebab-zrb-app-name
 ##############################################################################
 
+# Reload option can only be used when APP_ENABLE_OTEL is false
+_RELOAD=""
+if [ $(_to_boolean "$APP_ENABLE_OTEL") = "false" ] && [ $(_to_boolean "$APP_RELOAD") = "true" ]
+then
+    _RELOAD="--reload"
+fi
+
+# Constructing otel command
+# See: https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/fastapi/fastapi.html#installation
+_OTEL_COMMAND=""
 if [ $(_to_boolean "$APP_ENABLE_OTEL") = "true" ]
 then
-    echo "Start uvicorn with instrumentation, service name: ${APP_NAME}"
-    OTEL_RESOURCE_ATTRIBUTES="service.name=${APP_NAME}" \
-        OTEL_EXPORTER_OTLP_ENDPOINT="$APP_OTEL_EXPORTER_OTLP_ENDPOINT" \
-        poetry run opentelemetry-instrument uvicorn main:app --host "$APP_HOST" --port "$APP_PORT"
-else
-    # reload should only performed if otel is disabled
-    _RELOAD=""
-    if [ $(_to_boolean "$APP_RELOAD") = "true" ]
-    then
-        _RELOAD="--reload"
-    fi
-    # Run uvicorn
-    echo "Start uvicorn"
-    poetry run uvicorn main:app --host "$APP_HOST" --port "$APP_PORT" $_RELOAD
-fi
+    export OTEL_RESOURCE_ATTRIBUTES="service.name=${APP_NAME}"
+    export OTEL_EXPORTER_OTLP_ENDPOINT="$APP_OTEL_EXPORTER_OTLP_ENDPOINT"
+    export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=".*"
+    export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=".*"
+    _OTEL_COMMAND="opentelemetry-instrument"
+fi
+
+# Run uvicorn
+echo "Start uvicorn"
+poetry run $_OTEL_COMMAND uvicorn main:app --host "$APP_HOST" --port "$APP_PORT" $_RELOAD

zrb/builtin/generator/fastapp_crud/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/entity/snake_zrb_entity_name/api.py

@@ -12,6 +12,9 @@ from module.snake_zrb_module_name.schema.snake_zrb_entity_name import (
     PascalZrbEntityNameData,
     PascalZrbEntityNameResult,
 )
+from opentelemetry import trace
+
+tracer = trace.get_tracer(__name__)
 
 
 def register_api(
@@ -33,20 +36,25 @@ def register_api(
         offset: int = 0,
         user_token_data: AccessTokenData = Depends(access_token_scheme),
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id, "snake_zrb_module_name:snake_zrb_entity_name:get"
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id,
+                "snake_zrb_module_name:snake_zrb_entity_name:get",
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "snake_zrb_module_name_get_snake_zrb_entity_name",
-                keyword=keyword,
-                criterion={},
-                limit=limit,
-                offset=offset,
-                user_token_data=user_token_data.model_dump(),
-            )
-            return PascalZrbEntityNameResult(**result_dict)
+            with tracer.start_as_current_span(
+                "snake_zrb_module_name.rpc.snake_zrb_module_name_get_snake_zrb_entity_name"  # noqa
+            ):
+                result_dict = await rpc_caller.call(
+                    "snake_zrb_module_name_get_snake_zrb_entity_name",
+                    keyword=keyword,
+                    criterion={},
+                    limit=limit,
+                    offset=offset,
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return PascalZrbEntityNameResult(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)
 
@@ -57,18 +65,22 @@ def register_api(
     async def get_snake_zrb_entity_name_by_id(
         id: str, user_token_data: AccessTokenData = Depends(access_token_scheme)
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id,
-            "snake_zrb_module_name:snake_zrb_entity_name:get_by_id",
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id,
+                "snake_zrb_module_name:snake_zrb_entity_name:get_by_id",
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "snake_zrb_module_name_get_snake_zrb_entity_name_by_id",
-                id=id,
-                user_token_data=user_token_data.model_dump(),
-            )
-            return PascalZrbEntityName(**result_dict)
+            with tracer.start_as_current_span(
+                "snake_zrb_module_name.rpc.snake_zrb_module_name_get_snake_zrb_entity_name_by_id"  # noqa
+            ):
+                result_dict = await rpc_caller.call(
+                    "snake_zrb_module_name_get_snake_zrb_entity_name_by_id",
+                    id=id,
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return PascalZrbEntityName(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)
 
@@ -80,18 +92,22 @@ def register_api(
         data: PascalZrbEntityNameData,
         user_token_data: AccessTokenData = Depends(access_token_scheme),
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id,
-            "snake_zrb_module_name:snake_zrb_entity_name:insert",
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id,
+                "snake_zrb_module_name:snake_zrb_entity_name:insert",
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "snake_zrb_module_name_insert_snake_zrb_entity_name",
-                data=data.model_dump(),
-                user_token_data=user_token_data.model_dump(),
-            )
-            return PascalZrbEntityName(**result_dict)
+            with tracer.start_as_current_span(
+                "snake_zrb_module_name.rpc.snake_zrb_module_name_insert_snake_zrb_entity_name"  # noqa
+            ):
+                result_dict = await rpc_caller.call(
+                    "snake_zrb_module_name_insert_snake_zrb_entity_name",
+                    data=data.model_dump(),
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return PascalZrbEntityName(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)
 
@@ -104,19 +120,23 @@ def register_api(
         data: PascalZrbEntityNameData,
         user_token_data: AccessTokenData = Depends(access_token_scheme),
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id,
-            "snake_zrb_module_name:snake_zrb_entity_name:update",
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id,
+                "snake_zrb_module_name:snake_zrb_entity_name:update",
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "snake_zrb_module_name_update_snake_zrb_entity_name",
-                id=id,
-                data=data.model_dump(),
-                user_token_data=user_token_data.model_dump(),
-            )
-            return PascalZrbEntityName(**result_dict)
+            with tracer.start_as_current_span(
+                "snake_zrb_module_name.rpc.snake_zrb_module_name_update_snake_zrb_entity_name"  # noqa
+            ):
+                result_dict = await rpc_caller.call(
+                    "snake_zrb_module_name_update_snake_zrb_entity_name",
+                    id=id,
+                    data=data.model_dump(),
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return PascalZrbEntityName(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)
 
@@ -127,17 +147,21 @@ def register_api(
     async def delete_snake_zrb_entity_name(
         id: str, user_token_data: AccessTokenData = Depends(access_token_scheme)
     ):
-        if not await authorizer.is_having_permission(
-            user_token_data.user_id,
-            "snake_zrb_module_name:snake_zrb_entity_name:delete",
-        ):
-            raise HTTPAPIException(403, "Unauthorized")
+        with tracer.start_as_current_span("authorizer.is_having_permission"):
+            if not await authorizer.is_having_permission(
+                user_token_data.user_id,
+                "snake_zrb_module_name:snake_zrb_entity_name:delete",
+            ):
+                raise HTTPAPIException(403, "Unauthorized")
         try:
-            result_dict = await rpc_caller.call(
-                "snake_zrb_module_name_delete_snake_zrb_entity_name",
-                id=id,
-                user_token_data=user_token_data.model_dump(),
-            )
-            return PascalZrbEntityName(**result_dict)
+            with tracer.start_as_current_span(
+                "snake_zrb_module_name.rpc.snake_zrb_module_name_delete_snake_zrb_entity_name"  # noqa
+            ):
+                result_dict = await rpc_caller.call(
+                    "snake_zrb_module_name_delete_snake_zrb_entity_name",
+                    id=id,
+                    user_token_data=user_token_data.model_dump(),
+                )
+                return PascalZrbEntityName(**result_dict)
         except Exception as e:
             raise HTTPAPIException(error=e)

zrb/builtin/generator/fastapp_crud/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/schema/snake_zrb_entity_name.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Optional
 
 from component.schema import BaseCountSchema, BaseDateTimeSchema
 

zrb/builtin/generator/fastapp_field/helper.py

@@ -300,7 +300,7 @@ async def add_column_to_schema(
         code=code,
         class_name=f"{pascal_entity_name}Data",
         property_name=snake_column_name,
-        property_type="str",
+        property_type="Optional[str]",
     )
     task.print_out(f"Write modified code to: {schema_file_path}")
     await write_text_file_async(schema_file_path, code)

zrb/builtin/generator/pip_package/template/_automate/snake_zrb_package_name/cmd/publish.sh

@@ -1,2 +1,2 @@
 echo "Publish"
-poetry publish --repository {{input.snake_zrb_package_name_repo}}
+poetry publish

zrb/builtin/generator/pip_package/template/_automate/snake_zrb_package_name/local.py

@@ -1,6 +1,6 @@
 import os
 
-from zrb import CmdTask, StrInput, runner
+from zrb import CmdTask, runner
 from zrb.builtin.group import project_group
 
 CURRENT_DIR = os.path.dirname(__file__)
@@ -49,14 +49,6 @@ publish_snake_zrb_package_name = CmdTask(
     name="publish-kebab-zrb-package-name",
     description="Publish human readable zrb package name",
     group=project_group,
-    inputs=[
-        StrInput(
-            name="kebab-zrb-package-name-repo",
-            prompt="Pypi repository for human readable zrb package name",
-            description="Pypi repository for human readalbe zrb package name",
-            default="pypi",
-        )
-    ],
     upstreams=[build_snake_zrb_package_name],
     cwd=RESOURCE_DIR,
     cmd_path=[

zrb/builtin/generator/pip_package/template/src/kebab-zrb-package-name/pyproject.toml

@@ -16,7 +16,7 @@ zrb = ">=zrbVersion"
 
 [tool.poetry.dev-dependencies]
 flake8 = "~7.0.0"
-black = "~24.2.0"
+black = "~24.3.0"
 isort = "~5.13.2"
 pytest = "~7.4.0"
 pytest-cov = "~4.1.0"

zrb/builtin/generator/plugin/template/_cmd/publish.sh

@@ -1,2 +1,2 @@
 echo "Publish"
-poetry publish --repository {{input.plugin_repo}}
+poetry publish

zrb/builtin/generator/plugin/template/pyproject.toml

@@ -16,7 +16,7 @@ zrb = ">=zrbVersion"
 
 [tool.poetry.dev-dependencies]
 flake8 = "~7.0.0"
-black = "~24.2.0"
+black = "~24.3.0"
 isort = "~5.13.2"
 pytest = "~7.4.0"
 pytest-cov = "~4.1.0"

zrb/builtin/generator/plugin/template/zrb_init.py

@@ -1,6 +1,6 @@
 import os
 
-from zrb import CmdTask, StrInput, runner
+from zrb import CmdTask, runner
 from zrb.builtin.group import plugin_group
 
 PROJECT_DIR = os.path.dirname(__file__)
@@ -46,14 +46,6 @@ publish_plugin = CmdTask(
     name="publish",
     group=plugin_group,
     description="Publish plugin",
-    inputs=[
-        StrInput(
-            name="plugin-repo",
-            prompt="Pypi repository for plugin",
-            description="Pypi repository for human readalbe zrb package name",
-            default="pypi",
-        )
-    ],
     upstreams=[build_plugin],
     cwd=PROJECT_DIR,
     cmd_path=[

zrb/builtin/generator/project/template/pyproject.toml

@@ -14,7 +14,7 @@ zrb = ">=zrbVersion"
 
 [tool.poetry.dev-dependencies]
 flake8 = "~7.0.0"
-black = "~24.2.0"
+black = "~24.3.0"
 isort = "~5.13.2"
 
 [tool.poetry.scripts]

zrb/builtin/generator/simple_python_app/template/src/kebab-zrb-app-name/src/Dockerfile

@@ -1,6 +1,7 @@
 FROM python:3.10-slim
 ENV APP_MESSAGE "Hello, world!"
 ENV APP_PORT 8080
+ENV POETRY_VIRTUAL_ENVS_CREATE=false
 WORKDIR /home
 COPY ./pyproject.toml ./pyproject.toml
 RUN pip install "poetry==1.7.1"

zrb/builtin/generator/simple_python_app/template/src/kebab-zrb-app-name/src/pyproject.toml

@@ -14,7 +14,7 @@ uvicorn = "==0.20.0"
 
 [tool.poetry.dev-dependencies]
 flake8 = "~7.0.0"
-black = "~24.2.0"
+black = "~24.3.0"
 isort = "~5.13.2"
 pytest = "~7.4.0"
 pytest-cov = "~4.1.0"

zrb/config/config.py

@@ -7,13 +7,7 @@ from zrb.helper.typecheck import typechecked
 
 @typechecked
 def get_version() -> str:
-    try:
-        return metadata.version("zrb")
-    except metadata.PackageNotFoundError:
-        import flit
-
-        meta = flit.read_module_metadata("zrb")
-        return str(meta["module"]["version"])
+    return metadata.version("zrb")
 
 
 @typechecked
@@ -24,6 +18,12 @@ def get_current_shell() -> str:
     return "bash"
 
 
+def _get_valid_container_backend(container_backend: str) -> str:
+    if container_backend.lower().strip() == "podman":
+        return "podman"
+    return "docker"
+
+
 default_shell = os.getenv("ZRB_SHELL", get_current_shell())
 init_script_str = os.getenv("ZRB_INIT_SCRIPTS", "")
 init_scripts = init_script_str.split(":") if init_script_str != "" else []
@@ -34,3 +34,6 @@ show_advertisement = to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
 show_prompt = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
 show_time = to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
 version = get_version()
+container_backend = _get_valid_container_backend(
+    os.getenv("ZRB_CONTAINER_BACKEND", "docker")
+)