zrb 0.0.108__py3-none-any.whl → 0.0.109__py3-none-any.whl

zrb/action/runner.py

@@ -27,10 +27,10 @@ class Runner():
         logger.info(colored('Runner created', attrs=['dark']))
 
     def register(self, task: AnyTask):
+        task.set_has_cli_interface()
         cmd_name = task.get_complete_cmd_name()
         logger.debug(colored(f'Register task: {cmd_name}', attrs=['dark']))
         self._tasks.append(task)
-        task.set_has_cli_interface()
         logger.debug(colored(f'Task registered: {cmd_name}', attrs=['dark']))
 
     def serve(self, cli: click.Group) -> click.Group:

zrb/task/any_task.py

@@ -80,6 +80,10 @@ class AnyTask(ABC):
     def add_env_files(self, *env_files: EnvFile):
         pass
 
+    @abstractmethod
+    def set_execution_id(self, execution_id: str):
+        pass
+
     @abstractmethod
     def set_name(self, new_name: str):
         pass
@@ -114,6 +118,10 @@ class AnyTask(ABC):
     def set_checking_interval(self, new_checking_interval: Union[float, int]):
         pass
 
+    @abstractmethod
+    def get_execution_id(self) -> str:
+        pass
+
     @abstractmethod
     def get_icon(self) -> str:
         pass

zrb/task/base_task.py

@@ -12,11 +12,13 @@ from zrb.task.base_task_composite import (
 )
 from zrb.advertisement import advertisements
 from zrb.task_group.group import Group
+from zrb.task_env.constant import RESERVED_ENV_NAMES
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
 from zrb.task_input.any_input import AnyInput
 from zrb.task_input.constant import RESERVED_INPUT_NAMES
 from zrb.helper.accessories.color import colored
+from zrb.helper.accessories.name import get_random_name
 from zrb.helper.advertisement import get_advertisement
 from zrb.helper.string.modification import double_quote
 from zrb.helper.string.conversion import to_variable_name
@@ -281,6 +283,8 @@ class BaseTask(
         self._allow_add_env_files = False
         all_envs: Mapping[str, Env] = {}
         for env_name in os.environ:
+            if env_name in RESERVED_ENV_NAMES:
+                continue
             all_envs[env_name] = Env(
                 name=env_name, os_name=env_name, renderable=False
             )
@@ -305,6 +309,8 @@ class BaseTask(
     ):
         try:
             self._start_timer()
+            if self.get_execution_id() == '':
+                self.set_execution_id(get_random_name())
             self.log_info('Set input and env map')
             await self._set_keyval(kwargs=kwargs, env_prefix=env_prefix)
             self.log_info('Set run kwargs')
@@ -357,6 +363,11 @@ class BaseTask(
         if you want to show the result differently.
         '''
         print(result)
+    
+    def set_execution_id(self, execution_id: str):
+        super().set_execution_id(execution_id)
+        self._set_env_map('_ZRB_EXECUTION_ID', execution_id)
+        self._set_input_map('_execution_id', execution_id)
 
     async def _loop_check(self, show_done: bool = False) -> bool:
         self.log_info('Start readiness checking')
@@ -426,6 +437,7 @@ class BaseTask(
             await asyncio.sleep(0.1)
         check_coroutines: Iterable[asyncio.Task] = []
         for checker_task in self._checkers:
+            checker_task.set_execution_id(self.get_execution_id())
             check_coroutines.append(
                 asyncio.create_task(checker_task._run_all())
             )
@@ -438,6 +450,7 @@ class BaseTask(
         # Add upstream tasks to processes
         self._allow_add_upstreams = False
         for upstream_task in self._upstreams:
+            upstream_task.set_execution_id(self.get_execution_id())
             coroutines.append(asyncio.create_task(
                 upstream_task._run_all(**kwargs)
             ))

zrb/task/base_task_composite.py

@@ -66,6 +66,10 @@ class CommonTaskModel():
         self._allow_add_envs = True
         self._allow_add_env_files = True
         self._allow_add_inputs = True
+        self._execution_id = ''
+
+    def set_execution_id(self, execution_id: str):
+        self._execution_id = execution_id
 
     def set_name(self, new_name: str):
         if self._description == self._name:
@@ -110,6 +114,9 @@ class CommonTaskModel():
             raise Exception(f'Cannot add env_files on `{self._name}`')
         self._env_files += env_files
 
+    def get_execution_id(self) -> str:
+        return self._execution_id
+
     def get_icon(self) -> str:
         return self._icon
 

zrb/task/docker_compose_task.py

@@ -7,6 +7,7 @@ from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnTriggered, OnWaiting, OnSkipped, OnStarted, OnReady, OnRetry, OnFailed
 )
+from zrb.task_env.constant import RESERVED_ENV_NAMES
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
@@ -187,18 +188,18 @@ class DockerComposeTask(CmdTask):
         # compose envs
         data = read_compose_file(self._compose_template_file)
         env_map = fetch_compose_file_env_map(data)
-        registered_env_map: Mapping[str, bool] = {}
+        added_env_map: Mapping[str, bool] = {}
         for key, value in env_map.items():
             # Need to get this everytime because we only want
             # the first compose file env value for a certain key
-            if key in registered_env_map:
+            if key in RESERVED_ENV_NAMES or key in added_env_map:
                 continue
             os_name = key
             if self._compose_env_prefix != '':
                 os_name = f'{self._compose_env_prefix}_{os_name}'
             compose_env = Env(name=key, os_name=os_name, default=value)
             additional_envs.append(compose_env)
-            registered_env_map[key] = True
+            added_env_map[key] = True
         # Add additional envs and addition env files to this task
         self._envs = additional_envs + list(self._envs)
         self._env_files = additional_env_files + list(self._env_files)

zrb/task_env/constant.py

@@ -0,0 +1 @@
+RESERVED_ENV_NAMES = ('_ZRB_EXECUTION_ID',)

zrb/task_env/env.py

@@ -1,5 +1,6 @@
 from zrb.helper.typing import Optional
 from zrb.helper.typecheck import typechecked
+from zrb.task_env.constant import RESERVED_ENV_NAMES
 import os
 
 
@@ -16,6 +17,8 @@ class Env():
         default: str = '',
         renderable: bool = True,
     ):
+        if name in RESERVED_ENV_NAMES:
+            raise ValueError(f'Forbidden input name: {name}')
         self.name: str = name
         self.os_name: str = os_name if os_name is not None else name
         self.default: str = default

zrb/task_env/env_file.py

@@ -1,6 +1,7 @@
 from zrb.helper.typing import List, Optional
 from zrb.helper.typecheck import typechecked
 from dotenv import dotenv_values
+from zrb.task_env.constant import RESERVED_ENV_NAMES
 from zrb.task_env.env import Env
 
 
@@ -25,6 +26,8 @@ class EnvFile():
         env_list: List[Env] = []
         env_map = dotenv_values(self.env_file)
         for key, value in env_map.items():
+            if key in RESERVED_ENV_NAMES:
+                continue
             os_name: Optional[str] = None
             if self.prefix is not None and self.prefix != '':
                 os_name = f'{self.prefix}_{key}'

zrb/task_input/constant.py

@@ -1 +1 @@
-RESERVED_INPUT_NAMES = ('_task', '_args')
+RESERVED_INPUT_NAMES = ('_task', '_args', '_execution_id')

{zrb-0.0.108.dist-info → zrb-0.0.109.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.0.108
+Version: 0.0.109
 Summary: Super framework for your super app
 Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
 Requires-Python: >=3.10.0
@@ -30,9 +30,9 @@ Provides-Extra: test
 
 # 🤖 Zrb (Read: Zaruba) : A Super Framework for Your Super App
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/zrb/android-chrome-192x192.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
 
-[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Oops, I did it Again](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md)| [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
+[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Oops, I did it Again](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
 Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, Zrb will help you automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
 
@@ -40,7 +40,7 @@ To use Zrb, you need to be familiar with CLI.
 
 Zrb task definitions are written in [Python](https://www.python.org/), and we have a [very good reason](https://github.com/state-alchemists/zrb/blob/main/docs/faq/why-python.md) behind the decision.
 
-## Zrb as a low-code framework
+## Zrb is A Low-Code Framework
 
 Let's see how you can build and run a [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) application.
 
@@ -69,9 +69,9 @@ zrb project start-fastapp --fastapp-run-mode "monolith"
 
 You will be able to access the application by pointing your browser to [http://localhost:3000](http://localhost:3000)
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/fastapp.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/fastapp.png)
 
-Furthermore, you can also run the same application as `microservices`, run the application as `docker containers`, and even doing some deployments into your `kubernetes cluster`.
+Furthermore, you can run the same application as `microservices`, run the application as `docker containers`, and even do some deployments into your `kubernetes cluster`.
 
 
 ```bash
@@ -90,9 +90,9 @@ zrb project deploy-fastapp --fastapp-deploy-mode "microservices"
 You can visit [our tutorials](https://github.com/state-alchemists/zrb/blob/main/docs/tutorials/README.md) to see more cool tricks.
 
 
-## Zrb as a task-automation framework
+## Zrb is A Task-Automation Tool
 
-Aside from the builtin capabilities, Zrb also allows you to define your automation commands in Python. To do so, you need to create/modify a file named `zrb_init.py`.
+Aside from the built-in capabilities, Zrb also allows you to define your automation commands in Python. To do so, you must create/modify a file named `zrb_init.py`.
 
 ```python
 # filename: zrb_init.py
@@ -133,7 +133,7 @@ To learn more about this, you can visit [our getting started guide](https://gith
 
 # 🫰 Installation
 
-## ⚙️ In local machine
+## ⚙️ In Local Machine
 
 Installing Zrb in your system is as easy as typing the following command in your terminal:
 
@@ -141,11 +141,11 @@ Installing Zrb in your system is as easy as typing the following command in your
 pip install zrb
 ```
 
-Just like any other Python package, you can also install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
+Like any other Python package, you can install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
 
 > ⚠️ If the command doesn't work, you probably don't have Pip/Python on your computer. See `Main prerequisites` subsection to install them.
 
-## 🐋 With docker
+## 🐋 With Docker
 
 If you prefer to work with Docker, you can create a file named `docker-compose.yml`
 
@@ -184,7 +184,7 @@ You will be able to access Zrb by using docker exec:
 docker exec -it zrb zsh
 ```
 
-# ✅ Main prerequisites
+# ✅ Main Prerequisites
 
 Since Zrb is written in Python, you need to install a few things before installing Zrb:
 
@@ -209,11 +209,11 @@ ln -s venv/bin/python3 /usr/local/bin/python
 
 If you prefer Python distribution like [conda](https://docs.conda.io/en/latest/), that might work as well.
 
-# ✔️ Other prerequisites
+# ✔️ Other Prerequisites
 
 If you want to generate applications using Zrb and run them on your computer, you will also need:
 
-- 🐸 `Node.Js` and `Npm`. 
+- 🐸 `Node.Js` and `Npm`.
     - You need Node.Js to modify/transpile frontend code into static files.
     - You can visit the [Node.Js website](https://nodejs.org/en) for installation instructions.
 - 🐋 `Docker` and `Docker-compose` plugin.
@@ -228,9 +228,9 @@ If you want to generate applications using Zrb and run them on your computer, yo
 - 🦆 `Pulumi`
     - You need Pulumi to deploy your applications
 
-# 🏁 Getting started
+# 🏁 Getting Started
 
-We have a nice [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
+We have an excellent [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
 
 # 📖 Documentation
 
@@ -240,11 +240,11 @@ You can visit [Zrb documentation](https://github.com/state-alchemists/zrb/blob/m
 
 Help Red Skull to click the donation button:
 
-[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/donator.png)](https://stalchmst.com/donation)
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
 
-# 🎉 Fun fact
+# 🎉 Fun Fact
 
 > Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. [(Garo Wiki | Fandom)](https://garo.fandom.com/wiki/Zaruba)
 
-![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/madou-ring-zaruba.jpg)
+![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/madou-ring-zaruba.jpg)
 

{zrb-0.0.108.dist-info → zrb-0.0.109.dist-info}/RECORD

@@ -3,7 +3,7 @@ zrb/__main__.py,sha256=CdfuYSxqlJhnsJPOBOL2_uzEaTZHC3MtpyTuz8QUfUI,314
 zrb/advertisement.py,sha256=e-1tFPlmEuz8IqaIJ_9-2p9x5cuGsxssJGu5F0wHthI,505
 zrb/runner.py,sha256=MPCNPMCyiYNZeubSxd1eM2Zr6PCIKF-9pkG385AXElw,118
 zrb/action/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/action/runner.py,sha256=-bDR_dmsgKO_enhJ7xPE83MhU7-xpakxUtfNgNXdw-U,4474
+zrb/action/runner.py,sha256=AtGiru_OJcdX8en18jysVqr26nWl6bfV0M5GLpk7dYc,4474
 zrb/builtin/__init__.py,sha256=VpmpsDJmL2Qe1MDiVTaGgGgW9MxRz8sR21Blclg6MDE,580
 zrb/builtin/base64.py,sha256=_Ff8eQi0pMa4qqDUqZqA-u-2LpSA5s3AN0Nj2M7ibnQ,1318
 zrb/builtin/env.py,sha256=hEjQios0i-3DantczxQnZnolzwZAGIQOE0Ygka330EU,1146
@@ -1140,14 +1140,14 @@ zrb/shell-scripts/ensure-ssh-is-installed.sh,sha256=TM0PLXT2vNfgv2ffcW_l-IqtMqHI
 zrb/shell-scripts/rsync-util.sh,sha256=E4Of-AugCFKabQvk-mC0RrQ4JexS7JLT5p6Ux92ETcY,326
 zrb/shell-scripts/ssh-util.sh,sha256=9lXDzw6oO8HuA4vdbfps_uQMMwKyNYX9fZkZgpK52g8,401
 zrb/task/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task/any_task.py,sha256=bG4nVYmEqsf3Kbl78RjIAEv1YHUArpWGMXKiOzIkXa4,5646
+zrb/task/any_task.py,sha256=nygWeqJw2zVIvbGBU4j24MvJzrHnAKLQ-nrFZlCWc98,5804
 zrb/task/any_task_event_handler.py,sha256=vpO9t0fck8-oFu1KYptfcg2hXKRsk6V5je4Dg-Bl21o,359
 zrb/task/base_remote_cmd_task.py,sha256=mRizRbkvZwWeBU_MO7qiF89co5Y30ICpxD7cwbpRN3Y,8033
-zrb/task/base_task.py,sha256=yuKfsPzIDHNFd5AUjr9rCStUryHYA_N-R-abJ5c8S38,20878
-zrb/task/base_task_composite.py,sha256=lpckzR6CWmjrGheSBnR1127DTYxk_iqGOPS72bz5F0U,16099
+zrb/task/base_task.py,sha256=cxPRuAA87BTcF9ppRdpwh7BAQTEeLCxUOIlSkEAMaMU,21520
+zrb/task/base_task_composite.py,sha256=nKgnm9YyXfIlA0UYdI7dHYT9r9S66vvzhIkGDUxJbhc,16299
 zrb/task/cmd_task.py,sha256=zpoLkwt77PPeVc1YZCzjq1Kg4jUZ84OR6TpVPK166CM,12804
 zrb/task/decorator.py,sha256=6mJuDhmyHnVwx8SzBf8el5KwYJdA06VTeb1BABgLmTc,2399
-zrb/task/docker_compose_task.py,sha256=crvPId3c5hJ0kub1pg1DuQigzvMehYva3APRA_jg3HE,13785
+zrb/task/docker_compose_task.py,sha256=GjpWYPyY_3B9rLEUmbTEECkvXixKaZ_FF6UZnqCwWgM,13852
 zrb/task/flow_task.py,sha256=w5MaHCQ5KGyongjLo6YjLy9GYM0rTF6yEBGQ4GqbRp0,3933
 zrb/task/http_checker.py,sha256=ajsBDRgpp2OMeLlgyCL15UECYr2SoKAWfU3PGOJY24Q,5519
 zrb/task/path_checker.py,sha256=EhPJHDPYGAJG3XPUaiN_iN9Y-vtf96gEsWwqagy4IIM,3879
@@ -1156,8 +1156,9 @@ zrb/task/remote_cmd_task.py,sha256=LYWmnZ4mPsU-RIdAUyhui7mlIunx4vY8upwjhctnkEs,3
 zrb/task/resource_maker.py,sha256=QwB4S7aFjxX52onCqIu5OOMnm5omoZBl6OqZz9TqSOs,6379
 zrb/task/rsync_task.py,sha256=3vxENH-unD1VLgZI09Ts_lAQRMi2i1UiJpsaI1dltzI,3966
 zrb/task/task.py,sha256=aOwBVPl3U_dXCMcnrtcN0wPR8cDKbYkzgwa86BZMqBE,236
-zrb/task_env/env.py,sha256=1m1GUK4RhdCRfKtEfuCazppQceVAIO05UhJ5Xp-0FOk,1800
-zrb/task_env/env_file.py,sha256=Ku7WnPu-IkWi0fdjjXjTEvleYHfXO5v-g-0RUO2vVk4,1359
+zrb/task_env/constant.py,sha256=JdPhtZCTZlbW-jzG5vyFtpEXgTJ-Yx863LcrX_LiURY,44
+zrb/task_env/env.py,sha256=4oS4Y6_qwbzFqO08fzLb0TcSDAe9kxCW5cmbOFO1PSs,1954
+zrb/task_env/env_file.py,sha256=wQQmIQeK8-bRyl3KYe1xSFfebgHVFjXoXm8mQoVk7dY,1479
 zrb/task_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/task_group/group.py,sha256=qPZ79UZzLh5UPqsu2NflE6QAQzV568OPtXHcWloZX1o,1420
 zrb/task_input/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1165,14 +1166,14 @@ zrb/task_input/any_input.py,sha256=pLHMnH8VteIXS1ZBuBAVz8_WlAcikTUk1WyU_EEXxX4,5
 zrb/task_input/base_input.py,sha256=98z4bQDvgKlhf8CFMtakbWjvFwn_Y4XKb4YdSB-OTwE,3144
 zrb/task_input/bool_input.py,sha256=8-Kc4Rdc1dykMHxGUuAnRdnRcyEYfVM8ECtZqT071Fc,1594
 zrb/task_input/choice_input.py,sha256=V7BvsI-cI1CCX1DrQQY9bvwEHBYfNvS1WW5QWreMF_0,1672
-zrb/task_input/constant.py,sha256=yvYY-Cc5eRAUQbe5aJcVVy846yyQYYg7v1hgiFyNikg,42
+zrb/task_input/constant.py,sha256=QgG5alvaRVQYQ5yFNEwj_1DvSmebW0xEDU1JXktSlO4,59
 zrb/task_input/float_input.py,sha256=flaZvFY55us8vtYuBxuAvvr4mTTAVZ-S8uTUt9AGfNg,1595
 zrb/task_input/int_input.py,sha256=mtNrgs65SL0GCzW5qr6c869UjiJ__zJaiXmJZCaqIJs,1592
 zrb/task_input/password_input.py,sha256=5bkUWyPumryigIy-S_z3nBDCo8sQB8_5PeS_gvPI0HQ,1611
 zrb/task_input/str_input.py,sha256=7cubJJKLCWRoGIRIM0_0WUhya18wvURoytrhVZA4xYI,1592
 zrb/task_input/task_input.py,sha256=HotqM1iYSzwE4PIj8grnEUsvJqjx1dS6Ek7i6ZJLq2Y,83
-zrb-0.0.108.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
-zrb-0.0.108.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
-zrb-0.0.108.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-zrb-0.0.108.dist-info/METADATA,sha256=6y-CGLAw5EcdsecZEIUXHvoAAKMOkedsEg1rNZaEjCk,9755
-zrb-0.0.108.dist-info/RECORD,,
+zrb-0.0.109.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
+zrb-0.0.109.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
+zrb-0.0.109.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+zrb-0.0.109.dist-info/METADATA,sha256=JVZQiW3JECOeGOHZpVyAJioJreEe8Q_O1WV6TbDlUgU,9740
+zrb-0.0.109.dist-info/RECORD,,