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

zrb/task_input/base_input.py

@@ -1,17 +1,17 @@
-from zrb.helper.typing import Any, List, Mapping, Optional, Union
+from zrb.config.config import show_prompt
 from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, List, Mapping, Optional, Union
 from zrb.task_input.any_input import AnyInput
 from zrb.task_input.constant import RESERVED_INPUT_NAMES
-from zrb.config.config import show_prompt
 
 # flake8: noqa E501
 
 
 @typechecked
 class BaseInput(AnyInput):
-    '''
+    """
     A concrete implementation of the AnyInput abstract base class, representing a specific type of task input.
-    This class allows for the creation of interactive and configurable inputs for tasks, with various attributes 
+    This class allows for the creation of interactive and configurable inputs for tasks, with various attributes
     to customize its behavior and appearance.
 
     Attributes:
@@ -44,7 +44,7 @@ class BaseInput(AnyInput):
         >>>         Input(name='delay', default=10, description='Delay')
         >>>     ]
         >>> )
-    '''
+    """
 
     def __init__(
         self,
@@ -67,10 +67,10 @@ class BaseInput(AnyInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         if name in RESERVED_INPUT_NAMES:
-            raise ValueError(f'Forbidden input name: {name}')
+            raise ValueError(f"Forbidden input name: {name}")
         self._name = name
         self._shortcut = shortcut
         self._prompt = prompt
@@ -99,32 +99,32 @@ class BaseInput(AnyInput):
         return self._default
 
     def get_param_decl(self) -> List[str]:
-        param_decl: List[str] = [f'--{self._name}']
+        param_decl: List[str] = [f"--{self._name}"]
         if self._shortcut is not None:
-            param_decl.append(f'-{self._shortcut}')
+            param_decl.append(f"-{self._shortcut}")
         return param_decl
 
     def get_options(self) -> Mapping[str, Any]:
         options: Mapping[str, Any] = {
-            'default': self._default,
-            'help': self._help,
-            'type': self._type,
-            'show_default': self._show_default,
-            'confirmation_prompt': self._confirmation_prompt,
-            'prompt_required': self._prompt_required,
-            'hide_input': self._hide_input,
-            'is_flag': self._is_flag,
-            'flag_value': self._flag_value,
-            'multiple': self._multiple,
-            'count': self._count,
-            'allow_from_autoenv': self._allow_from_autoenv,
-            'hidden': self._hidden,
-            'show_choices': self._show_choices,
-            'show_envvar': self._show_envvar,
-            'nargs': self._nargs
+            "default": self._default,
+            "help": self._help,
+            "type": self._type,
+            "show_default": self._show_default,
+            "confirmation_prompt": self._confirmation_prompt,
+            "prompt_required": self._prompt_required,
+            "hide_input": self._hide_input,
+            "is_flag": self._is_flag,
+            "flag_value": self._flag_value,
+            "multiple": self._multiple,
+            "count": self._count,
+            "allow_from_autoenv": self._allow_from_autoenv,
+            "hidden": self._hidden,
+            "show_choices": self._show_choices,
+            "show_envvar": self._show_envvar,
+            "nargs": self._nargs,
         }
         if show_prompt:
-            options['prompt'] = self._prompt
+            options["prompt"] = self._prompt
         return options
 
     def should_render(self) -> bool:

zrb/task_input/bool_input.py

@@ -1,5 +1,5 @@
-from zrb.helper.typing import Any, Optional, Union
 from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
@@ -7,12 +7,12 @@ from zrb.task_input.base_input import BaseInput
 
 @typechecked
 class BoolInput(BaseInput):
-    '''
+    """
     A specialized input class for handling boolean values in a task input context.
 
     This class extends `BaseInput` and provides specific functionality for boolean type inputs,
     including support for default values, prompts, flags, and various customization options.
-    
+
     Args:
         name (str): The name of the input.
         shortcut (Optional[str]): A shortcut string for the input.
@@ -38,7 +38,7 @@ class BoolInput(BaseInput):
         >>> bool_input = BoolInput(name='confirm', prompt='Do you agree?', default=False)
         >>> bool_input.get_default()
         False
-    '''
+    """
 
     def __init__(
         self,
@@ -60,7 +60,7 @@ class BoolInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -83,5 +83,5 @@ class BoolInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )

zrb/task_input/choice_input.py

@@ -1,19 +1,21 @@
-from zrb.helper.typing import Any, Optional, Iterable, Union
+import click
+
 from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Iterable, Optional, Union
 from zrb.task_input.base_input import BaseInput
-import click
 
 # flake8: noqa E501
 
+
 @typechecked
 class ChoiceInput(BaseInput):
-    '''
+    """
     A specialized input class for handling choice-based inputs in a task input context.
 
-    This class extends `BaseInput` and provides functionality for inputs where the user 
-    must select from a predefined set of choices. It includes support for default values, 
+    This class extends `BaseInput` and provides functionality for inputs where the user
+    must select from a predefined set of choices. It includes support for default values,
     prompts, flags, and various customization options.
-    
+
     Args:
         name (str): The name of the input.
         shortcut (Optional[str]): An optional shortcut string for the input.
@@ -40,7 +42,7 @@ class ChoiceInput(BaseInput):
         >>> choice_input = ChoiceInput(name='color', choices=['red', 'green', 'blue'], default='red')
         >>> choice_input.get_default()
         'red'
-    '''
+    """
 
     def __init__(
         self,
@@ -63,7 +65,7 @@ class ChoiceInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -86,5 +88,5 @@ class ChoiceInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )

zrb/task_input/constant.py

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

zrb/task_input/float_input.py

@@ -1,12 +1,13 @@
-from zrb.helper.typing import Any, Optional, Union
 from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
 
+
 @typechecked
 class FloatInput(BaseInput):
-    '''
+    """
      A specialized input class designed to handle floating-point numbers in a task input context.
 
     Extending `BaseInput`, this class facilitates the handling of float-type inputs, accommodating
@@ -37,7 +38,7 @@ class FloatInput(BaseInput):
         >>> float_input = FloatInput(name='threshold', default=0.5, description='Set the threshold value')
         >>> float_input.get_default()
         0.5
-    '''
+    """
 
     def __init__(
         self,
@@ -59,7 +60,7 @@ class FloatInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -82,5 +83,5 @@ class FloatInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )

zrb/task_input/int_input.py

@@ -1,17 +1,17 @@
-from zrb.helper.typing import Any, Optional, Union
 from zrb.helper.typecheck import typechecked
-
+from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
 
+
 @typechecked
 class IntInput(BaseInput):
-    '''
+    """
     A specialized input class for handling integer values in task inputs.
 
-    `IntInput` extends `BaseInput` to specifically handle inputs where integer values are required. 
-    It supports various features like default values, prompts, flags, and other customization options, 
+    `IntInput` extends `BaseInput` to specifically handle inputs where integer values are required.
+    It supports various features like default values, prompts, flags, and other customization options,
     making it suitable for tasks that require numerical input in the form of integers.
 
     Args:
@@ -39,7 +39,7 @@ class IntInput(BaseInput):
         >>> int_input = IntInput(name='age', default=30, description='Enter your age')
         >>> int_input.get_default()
         30
-    '''
+    """
 
     def __init__(
         self,
@@ -61,7 +61,7 @@ class IntInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -84,5 +84,5 @@ class IntInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )

zrb/task_input/password_input.py

@@ -1,18 +1,18 @@
-from zrb.helper.typing import Any, Optional, Union
 from zrb.helper.typecheck import typechecked
-
+from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
 
+
 @typechecked
 class PasswordInput(BaseInput):
-    '''
+    """
     A specialized input class for handling password or sensitive data inputs in tasks.
 
-    `PasswordInput` extends `BaseInput` to manage inputs that should be treated as sensitive, 
-    such as passwords. It ensures that the input is hidden when entered, providing an added 
-    layer of security and privacy. This class supports various features like default values, 
+    `PasswordInput` extends `BaseInput` to manage inputs that should be treated as sensitive,
+    such as passwords. It ensures that the input is hidden when entered, providing an added
+    layer of security and privacy. This class supports various features like default values,
     prompts, and flags, tailored for the safe handling of sensitive information.
 
     Args:
@@ -39,7 +39,7 @@ class PasswordInput(BaseInput):
         >>> password_input = PasswordInput(name='password', description='Enter your password')
         >>> password_input.is_hidden()
         True
-    '''
+    """
 
     def __init__(
         self,
@@ -60,7 +60,7 @@ class PasswordInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -83,7 +83,7 @@ class PasswordInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )
 
     def is_hidden(self) -> bool:

zrb/task_input/str_input.py

@@ -1,17 +1,17 @@
-from zrb.helper.typing import Any, Optional, Union
 from zrb.helper.typecheck import typechecked
-
+from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
 
+
 @typechecked
 class StrInput(BaseInput):
-    '''
+    """
     A specialized input class for handling string-based inputs in various tasks.
 
-    `StrInput` extends `BaseInput` to manage string-type inputs, supporting features like 
-    default values, prompts, flags, and other customization options. This class is useful 
+    `StrInput` extends `BaseInput` to manage string-type inputs, supporting features like
+    default values, prompts, flags, and other customization options. This class is useful
     for tasks requiring textual input, such as names, descriptions, or any other string parameters.
 
     Args:
@@ -39,7 +39,7 @@ class StrInput(BaseInput):
         >>> str_input = StrInput(name='username', default='user123', description='Enter your username')
         >>> str_input.get_default()
         'user123'
-    '''
+    """
 
     def __init__(
         self,
@@ -61,7 +61,7 @@ class StrInput(BaseInput):
         show_choices: bool = True,
         show_envvar: bool = False,
         nargs: int = 1,
-        should_render: bool = True
+        should_render: bool = True,
     ):
         BaseInput.__init__(
             self,
@@ -84,5 +84,5 @@ class StrInput(BaseInput):
             show_choices=show_choices,
             show_envvar=show_envvar,
             nargs=nargs,
-            should_render=should_render
+            should_render=should_render,
         )

zrb/task_input/task_input.py

@@ -2,8 +2,9 @@ from zrb.task_input.base_input import BaseInput
 
 # flake8: noqa E501
 
+
 class Input(BaseInput):
-    '''
+    """
     Alias for BaseInput
 
     Attributes:
@@ -36,5 +37,6 @@ class Input(BaseInput):
         >>>         Input(name='delay', default=10, description='Delay')
         >>>     ]
         >>> )
-    '''
+    """
+
     pass

{zrb-0.6.0.dist-info → zrb-0.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.6.0
+Version: 0.6.1
 Summary: A Framework to Enhance Your Workflow
 Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
 Requires-Python: >=3.10.0
@@ -21,6 +21,8 @@ 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: black~=23.12.1 ; extra == "dev"
+Requires-Dist: isort~=5.13.2 ; extra == "dev"
 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"