zrb 0.1.1__tar.gz → 0.2.0__tar.gz

zrb-0.2.0/.github/issue_template.md

@@ -0,0 +1,24 @@
+# Summary
+
+> Description of the issue.
+
+# Environment
+
+- __OS__: Windows/Mac/Linux + the version of your OS.
+- __Python Version__: Run `python --version` to make sure.
+- __Zrb Version__: Run `zrb version` to make sure.
+
+# Action
+
+- I set the following environment variables
+- I run the following command
+- etc.
+
+
+# Expected Result
+
+> Description of your expectation.
+
+# Actual Result
+
+> Description of actual result. Put output/screenshots.

zrb-0.2.0/.github/pull_request_template.md

@@ -0,0 +1,16 @@
+# Summary
+
+> Description of the PR.
+
+# Checklist
+
+- [ ] The PR is compatible with Zrb's license
+- [ ] The PR is ready for review
+
+# Ticket or Issue
+
+> Ticket or issue number if applicable.
+
+# How to Test
+
+> How to test that this PR works.

{zrb-0.1.1 → zrb-0.2.0}/.github/workflows/_zrb.yml

@@ -17,7 +17,7 @@ jobs:
   Run-command:
     runs-on: ubuntu-latest
     container:
-      image: stalchmst/zrb:0.1.0
+      image: stalchmst/zrb:0.2.0
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3

{zrb-0.1.1 → zrb-0.2.0}/.gitignore

@@ -4,6 +4,8 @@ playground
 .pytest_cache
 .coverage
 .coverage.*
+.cprofile.prof
+.cprofile.svg
 .env
 .venv
 docker/._docker-compose.*.runtime.yml

{zrb-0.1.1 → zrb-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.1.1
+Version: 0.2.0
 Summary: A Framework to Enhance Your Workflow
 Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
 Requires-Python: >=3.10.0
@@ -21,13 +21,13 @@ Requires-Dist: setuptools ~= 68.0.0
 Requires-Dist: autopep8 ~= 2.0.2
 Requires-Dist: croniter ~= 2.0.1
 Requires-Dist: flake8 ~= 6.0.0 ; extra == "dev"
-Requires-Dist: pytest ~= 7.4.0 ; extra == "test"
-Requires-Dist: pytest-cov ~= 4.1.0 ; extra == "test"
-Requires-Dist: pytest-asyncio ~= 0.21.0 ; extra == "test"
+Requires-Dist: pytest ~= 7.4.0 ; extra == "dev"
+Requires-Dist: pytest-cov ~= 4.1.0 ; extra == "dev"
+Requires-Dist: pytest-asyncio ~= 0.21.0 ; extra == "dev"
+Requires-Dist: flameprof ~= 0.4 ; extra == "dev"
 Project-URL: Bug Tracker, https://github.com/state-alchemists/zrb/issues
 Project-URL: Homepage, https://github.com/state-alchemists/zrb
 Provides-Extra: dev
-Provides-Extra: test
 
 ![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
 

{zrb-0.1.1 → zrb-0.2.0}/docs/concepts/task/README.md

@@ -103,11 +103,6 @@ No documentation available.
 No documentation available.
 
 
-### `Task._BaseTaskModel__get_executable_name`
-
-No documentation available.
-
-
 ### `Task._BaseTaskModel__get_log_prefix`
 
 No documentation available.
@@ -118,11 +113,6 @@ No documentation available.
 No documentation available.
 
 
-### `Task._BaseTaskModel__get_rjust_full_cli_name`
-
-No documentation available.
-
-
 ### `Task._Renderer__ensure_cached_render_data`
 
 No documentation available.
@@ -214,17 +204,6 @@ __Returns:__
 
 `List[Env]`: A list of `Env` instances representing the environment variables of the task.
 
-### `Task._get_full_cli_name`
-
-Retrieves the full command-line interface (CLI) name of the task.
-
-Intended for internal use, this method provides the complete CLI name, including any
-prefixes or namespaces, used primarily for logging or debugging purposes.
-
-__Returns:__
-
-`str`: The full CLI name of the task.
-
 ### `Task._get_inputs`
 
 Retrieves the list of inputs associated with the task.
@@ -304,7 +283,7 @@ No documentation available.
 
 For internal use.
 
-Directly call `print_result`
+Call `print_result` or print values based on result type and other conditions.
 
 ### `Task._propagate_execution_id`
 
@@ -324,8 +303,7 @@ No documentation available.
 
 ### `Task._set_args`
 
-No documentation available.
-
+Set args that will be shown at the end of the execution
 
 ### `Task._set_env_map`
 
@@ -365,10 +343,14 @@ Set current task's key values.
 
 ### `Task._set_kwargs`
 
+Set kwargs that will be shown at the end of the execution
+
+### `Task._set_local_keyval`
+
 No documentation available.
 
 
-### `Task._set_local_keyval`
+### `Task._set_task`
 
 No documentation available.
 
@@ -403,6 +385,27 @@ No documentation available.
 No documentation available.
 
 
+### `Task.add_checker`
+
+Adds one or more `AnyTask` instances to the end of the current task's checker list.
+
+This method appends tasks to the checker list, indicating that these tasks should be executed
+before the current task, but after any tasks already in the checker list.
+
+__Arguments:__
+
+- `checkers` (`TAnyTask`): One or more task instances to be added to the checker list.
+
+__Examples:__
+
+```python
+from zrb import Task
+task = Task(name='task')
+checker_task = Task(name='checker-task')
+task.add_checker(checker_task)
+```
+
+
 ### `Task.add_env`
 
 Adds one or more `Env` instances to the end of the current task's environment variable list.
@@ -516,6 +519,11 @@ class MyTask(Task):
 ```
 
 
+### `Task.clear_xcom`
+
+No documentation available.
+
+
 ### `Task.copy`
 
 Creates and returns a copy of the current task.
@@ -629,6 +637,35 @@ def task(*args, **kwargs):
 ```
 
 
+### `Task.get_name`
+
+Get task name
+
+__Returns:__
+
+`str`: name of the task
+
+### `Task.get_xcom`
+
+Get xcom value for cross task communication.
+
+Argss:
+key (str): Xcom key
+
+__Returns:__
+
+`str`: Value of xcom
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        return self.get_xcom('magic_word')
+```
+
+
 ### `Task.inject_checkers`
 
 Injects custom checkers into the task.
@@ -711,6 +748,28 @@ class MyTask(Task):
 ```
 
 
+### `Task.insert_checker`
+
+Inserts one or more `AnyTask` instances at the beginning of the current task's checker list.
+
+This method is used to define dependencies for the current task. Tasks in the checker list are
+executed before the current task. Adding a task to the beginning of the list means it will be
+executed earlier than those already in the list.
+
+__Arguments:__
+
+- `checkers` (`TAnyTask`): One or more task instances to be added to the checker list.
+
+__Examples:__
+
+```python
+from zrb import Task
+task = Task(name='task')
+checker_task = Task(name='checker-task')
+task.insert_checker(checker_task)
+```
+
+
 ### `Task.insert_env`
 
 Inserts one or more `Env` instances at the beginning of the current task's environment variable list.
@@ -973,7 +1032,7 @@ Print message to stdout and style it as faint.
 
 ### `Task.print_result`
 
-Outputs the task result to stdout for further processing.
+Print the task result to stdout for further processing.
 
 Override this method in subclasses to customize how the task result is displayed
 or processed. Useful for integrating the task output with other systems or
@@ -1137,6 +1196,54 @@ __Arguments:__
 
 - `should_execute` (`Union[bool, str, Callable[..., bool]]`): The condition to determine if the task should execute.
 
+### `Task.set_task_xcom`
+
+Set task xcom for cross task communication.
+
+Argss:
+key (str): Xcom key
+value (str): The value of the xcom
+
+__Returns:__
+
+`str`: Empty string
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        self.set_task_xcom('magic_word', 'hello')
+        magic_word = self.get_xcom(f'{self.get_name()}.magic_word')
+        return 42
+```
+
+
+### `Task.set_xcom`
+
+Set xcom for cross task communication.
+
+Argss:
+key (str): Xcom key
+value (str): The value of the xcom
+
+__Returns:__
+
+`str`: Empty string
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        self.set_xcom('magic_word', 'hello')
+        magic_word = self.get_xcom('magic_word')
+        return 42
+```
+
+
 ### `Task.to_function`
 
 Converts the current task into a callable function.

{zrb-0.1.1 → zrb-0.2.0}/docs/concepts/task/base-remote-cmd-task.md

@@ -25,11 +25,6 @@ No documentation available.
 No documentation available.
 
 
-### `BaseRemoteCmdTask._BaseTaskModel__get_executable_name`
-
-No documentation available.
-
-
 ### `BaseRemoteCmdTask._BaseTaskModel__get_log_prefix`
 
 No documentation available.
@@ -40,11 +35,6 @@ No documentation available.
 No documentation available.
 
 
-### `BaseRemoteCmdTask._BaseTaskModel__get_rjust_full_cli_name`
-
-No documentation available.
-
-
 ### `BaseRemoteCmdTask._Renderer__ensure_cached_render_data`
 
 No documentation available.
@@ -136,17 +126,6 @@ __Returns:__
 
 `List[Env]`: A list of `Env` instances representing the environment variables of the task.
 
-### `BaseRemoteCmdTask._get_full_cli_name`
-
-Retrieves the full command-line interface (CLI) name of the task.
-
-Intended for internal use, this method provides the complete CLI name, including any
-prefixes or namespaces, used primarily for logging or debugging purposes.
-
-__Returns:__
-
-`str`: The full CLI name of the task.
-
 ### `BaseRemoteCmdTask._get_inputs`
 
 Retrieves the list of inputs associated with the task.
@@ -226,7 +205,7 @@ No documentation available.
 
 For internal use.
 
-Directly call `print_result`
+Call `print_result` or print values based on result type and other conditions.
 
 ### `BaseRemoteCmdTask._propagate_execution_id`
 
@@ -246,8 +225,7 @@ No documentation available.
 
 ### `BaseRemoteCmdTask._set_args`
 
-No documentation available.
-
+Set args that will be shown at the end of the execution
 
 ### `BaseRemoteCmdTask._set_env_map`
 
@@ -287,10 +265,14 @@ Set current task's key values.
 
 ### `BaseRemoteCmdTask._set_kwargs`
 
+Set kwargs that will be shown at the end of the execution
+
+### `BaseRemoteCmdTask._set_local_keyval`
+
 No documentation available.
 
 
-### `BaseRemoteCmdTask._set_local_keyval`
+### `BaseRemoteCmdTask._set_task`
 
 No documentation available.
 
@@ -325,6 +307,27 @@ No documentation available.
 No documentation available.
 
 
+### `BaseRemoteCmdTask.add_checker`
+
+Adds one or more `AnyTask` instances to the end of the current task's checker list.
+
+This method appends tasks to the checker list, indicating that these tasks should be executed
+before the current task, but after any tasks already in the checker list.
+
+__Arguments:__
+
+- `checkers` (`TAnyTask`): One or more task instances to be added to the checker list.
+
+__Examples:__
+
+```python
+from zrb import Task
+task = Task(name='task')
+checker_task = Task(name='checker-task')
+task.add_checker(checker_task)
+```
+
+
 ### `BaseRemoteCmdTask.add_env`
 
 Adds one or more `Env` instances to the end of the current task's environment variable list.
@@ -438,6 +441,11 @@ class MyTask(Task):
 ```
 
 
+### `BaseRemoteCmdTask.clear_xcom`
+
+No documentation available.
+
+
 ### `BaseRemoteCmdTask.copy`
 
 Creates and returns a copy of the current task.
@@ -551,6 +559,35 @@ def task(*args, **kwargs):
 ```
 
 
+### `BaseRemoteCmdTask.get_name`
+
+Get task name
+
+__Returns:__
+
+`str`: name of the task
+
+### `BaseRemoteCmdTask.get_xcom`
+
+Get xcom value for cross task communication.
+
+Argss:
+key (str): Xcom key
+
+__Returns:__
+
+`str`: Value of xcom
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        return self.get_xcom('magic_word')
+```
+
+
 ### `BaseRemoteCmdTask.inject_checkers`
 
 Injects custom checkers into the task.
@@ -633,6 +670,28 @@ class MyTask(Task):
 ```
 
 
+### `BaseRemoteCmdTask.insert_checker`
+
+Inserts one or more `AnyTask` instances at the beginning of the current task's checker list.
+
+This method is used to define dependencies for the current task. Tasks in the checker list are
+executed before the current task. Adding a task to the beginning of the list means it will be
+executed earlier than those already in the list.
+
+__Arguments:__
+
+- `checkers` (`TAnyTask`): One or more task instances to be added to the checker list.
+
+__Examples:__
+
+```python
+from zrb import Task
+task = Task(name='task')
+checker_task = Task(name='checker-task')
+task.insert_checker(checker_task)
+```
+
+
 ### `BaseRemoteCmdTask.insert_env`
 
 Inserts one or more `Env` instances at the beginning of the current task's environment variable list.
@@ -895,7 +954,7 @@ Print message to stdout and style it as faint.
 
 ### `BaseRemoteCmdTask.print_result`
 
-Outputs the task result to stdout for further processing.
+Print the task result to stdout for further processing.
 
 Override this method in subclasses to customize how the task result is displayed
 or processed. Useful for integrating the task output with other systems or
@@ -1059,6 +1118,54 @@ __Arguments:__
 
 - `should_execute` (`Union[bool, str, Callable[..., bool]]`): The condition to determine if the task should execute.
 
+### `BaseRemoteCmdTask.set_task_xcom`
+
+Set task xcom for cross task communication.
+
+Argss:
+key (str): Xcom key
+value (str): The value of the xcom
+
+__Returns:__
+
+`str`: Empty string
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        self.set_task_xcom('magic_word', 'hello')
+        magic_word = self.get_xcom(f'{self.get_name()}.magic_word')
+        return 42
+```
+
+
+### `BaseRemoteCmdTask.set_xcom`
+
+Set xcom for cross task communication.
+
+Argss:
+key (str): Xcom key
+value (str): The value of the xcom
+
+__Returns:__
+
+`str`: Empty string
+
+__Examples:__
+
+```python
+from zrb import Task
+class MyTask(Task):
+    async def run(self, *args: Any, **kwargs: Any) -> int:
+        self.set_xcom('magic_word', 'hello')
+        magic_word = self.get_xcom('magic_word')
+        return 42
+```
+
+
 ### `BaseRemoteCmdTask.to_function`
 
 Converts the current task into a callable function.