diff --git a/aiocli/__init__.py b/aiocli/__init__.py index 9cc6694..5ed906d 100644 --- a/aiocli/__init__.py +++ b/aiocli/__init__.py @@ -1,3 +1,3 @@ """Simple and lightweight async console runner.""" -__version__ = '1.6.0' +__version__ = '1.6.1' diff --git a/aiocli/commander.py b/aiocli/commander.py index 383b1f2..e1fbb7d 100644 --- a/aiocli/commander.py +++ b/aiocli/commander.py @@ -5,12 +5,20 @@ from asyncio.events import AbstractEventLoop from typing import Any, Awaitable, Callable, List, Optional, Set, Union, cast -from aiocli.commander_app import Application, Command, Depends, State, command +from aiocli.commander_app import ( + Application, + Command, + CommandArgument, + Depends, + State, + command, +) __all__ = ( # commander_app 'State', 'Depends', + 'CommandArgument', 'Command', 'command', 'Application', diff --git a/aiocli/commander_app.py b/aiocli/commander_app.py index 4955422..7d28fbb 100644 --- a/aiocli/commander_app.py +++ b/aiocli/commander_app.py @@ -1,12 +1,14 @@ -from argparse import ArgumentParser, RawTextHelpFormatter +from argparse import Action, ArgumentParser, RawTextHelpFormatter from inspect import signature from typing import ( Any, Awaitable, Callable, + Container, Coroutine, Dict, List, + NamedTuple, Optional, Sequence, Tuple, @@ -18,13 +20,13 @@ # commander_app 'State', 'Depends', + 'CommandArgument', 'Command', 'command', 'CommandHandler', 'Application', ) - from .helpers import resolve_function from .logger import logger @@ -35,6 +37,7 @@ class State(dict): pass +# dataclass class _Depends: def __init__(self, dependency: Callable[..., Any], cache: bool) -> None: self.dependency = dependency @@ -45,34 +48,88 @@ def Depends(dependency: Callable[..., Any], cache: bool = True) -> Any: return _Depends(dependency=dependency, cache=cache) +# https://docs.python.org/3/library/argparse.html#the-add-argument-method +class CommandArgument(NamedTuple): + name_or_flags: Union[str, List[str]] + action: Optional[Union[str, Action]] = None + nargs: Optional[Union[int, str]] = None + const: Any = None + default: Any = None + type: Union[Type[Any], Callable[[str], Any]] = str + choices: Optional[Container[Any]] = None + required: Optional[bool] = None + help: Optional[str] = None + metavar: Optional[str] = None + dest: Optional[str] = None + + +# dataclass class Command: name: str handler: CommandHandler - positionals: List[Tuple[str, Dict[str, Any]]] - optionals: List[Tuple[str, Dict[str, Any]]] + positionals: List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ] + optionals: List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ] deprecated: Optional[bool] + description: Optional[str] def __init__( self, name: str, handler: CommandHandler, - positionals: List[Tuple[str, Dict[str, Any]]], - optionals: List[Tuple[str, Dict[str, Any]]], + positionals: List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ], + optionals: List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ], deprecated: Optional[bool] = None, + description: Optional[str] = None, ) -> None: self.name = name self.handler = handler # type: ignore self.positionals = positionals self.optionals = optionals self.deprecated = deprecated + self.description = description def command( name: str, handler: CommandHandler, - positionals: Optional[List[Tuple[str, Dict[str, Any]]]] = None, - optionals: Optional[List[Tuple[str, Dict[str, Any]]]] = None, + positionals: Optional[ + List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ] + ] = None, + optionals: Optional[ + List[ + Union[ + Tuple[str, Dict[str, Any]], + CommandArgument, + ] + ] + ] = None, deprecated: Optional[bool] = None, + description: Optional[str] = None, ) -> Command: return Command( name=name, @@ -80,6 +137,7 @@ def command( positionals=positionals or [], optionals=optionals or [], deprecated=deprecated, + description=description, ) @@ -91,6 +149,12 @@ def command( CommandHook = Callable[['Application'], Union[None, Awaitable[None]]] +ArgumentState = Union[ + State, + Dict[str, Any], + Callable[[], Union[State, Dict[str, Any]]], +] + class Application: _parser: ArgumentParser @@ -122,7 +186,7 @@ def __init__( on_shutdown: Optional[Sequence[CommandHook]] = None, on_cleanup: Optional[Sequence[CommandHook]] = None, deprecated: Optional[bool] = None, - state: Optional[Union[State, Dict[str, Any]]] = None, + state: Optional[ArgumentState] = None, ) -> None: self._parser = ArgumentParser( description=description, @@ -160,7 +224,7 @@ async def self_handler() -> int: self._on_cleanup = [] if on_cleanup is None else list(on_cleanup) self._deprecated = bool(deprecated) self._dependencies_cached = {} - self._state = State(state or {}) if not isinstance(state, State) else state + self._set_state(state or State()) async def __call__(self, args: List[str]) -> int: exit_code: Optional[int] = self._exit_code @@ -219,8 +283,8 @@ def decorator(handler: CommandHandler) -> CommandHandler: Command( name=name, handler=handler, - positionals=positionals or [], - optionals=optionals or [], + positionals=positionals or [], # type: ignore + optionals=optionals or [], # type: ignore deprecated=deprecated, ) ) @@ -305,8 +369,13 @@ def _add_command(self, cmd: Command) -> None: if cmd.deprecated is None: cmd.deprecated = self._deprecated self._commands[cmd.name] = cmd - parser = ArgumentParser(prog=cmd.name) - _ = [parser.add_argument(arg[0], **arg[1]) for arg in cmd.positionals + cmd.optionals] + parser = ArgumentParser(description=cmd.description, prog=cmd.name, prefix_chars='-') + args = cmd.positionals + cmd.optionals + for arg in args: + if isinstance(arg, CommandArgument): + arg = (arg.name_or_flags, arg._asdict()) # type: ignore + del arg[1]['name_or_flags'] # type: ignore + parser.add_argument(arg[0], **arg[1]) # type: ignore self._parsers[cmd.name] = parser self._update_parser_description(cmd.name) @@ -432,6 +501,16 @@ async def _execute_command_exception_handler( ) return await resolve_function(exception_handler, err, cmd, kwargs) + def _set_state(self, state: ArgumentState) -> None: + if isinstance(state, State): + self._state = state + elif isinstance(state, dict): + self._state = State(state) + elif callable(state): + self._state = state() # type: ignore + else: + self._state = State() + def _log(self, msg: str) -> None: if self._debug: # print(msg) diff --git a/aiocli/helpers.py b/aiocli/helpers.py index cad34ee..743e40f 100644 --- a/aiocli/helpers.py +++ b/aiocli/helpers.py @@ -1,6 +1,6 @@ import asyncio -import functools -import sys +from functools import partial +from sys import version_info from typing import Any, Callable, Optional, Set @@ -9,17 +9,17 @@ def all_tasks(loop: Optional[asyncio.AbstractEventLoop] = None) -> Set["asyncio. return {t for t in tasks if not t.done()} -if sys.version_info >= (3, 7): +if version_info >= (3, 7): all_tasks = getattr(asyncio, 'all_tasks') def iscoroutinefunction(func: Callable[..., Any]) -> bool: - while isinstance(func, functools.partial): + while isinstance(func, partial): func = func.func return asyncio.iscoroutinefunction(func) -if sys.version_info >= (3, 8): +if version_info >= (3, 8): iscoroutinefunction = asyncio.iscoroutinefunction diff --git a/docs/404.html b/docs/404.html index 0ba7afc..6f40d5a 100644 --- a/docs/404.html +++ b/docs/404.html @@ -126,7 +126,7 @@
  • - es - español + es - Spanish
    • @@ -421,6 +421,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -468,7 +482,7 @@

    404 - Not found

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/advanced/exception_handler/index.html b/docs/advanced/exception_handler/index.html index f0a0425..c7915c2 100644 --- a/docs/advanced/exception_handler/index.html +++ b/docs/advanced/exception_handler/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -433,6 +433,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -526,7 +540,7 @@

    Exception handler

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/advanced/hooks/index.html b/docs/advanced/hooks/index.html index 1b1db8d..603eac7 100644 --- a/docs/advanced/hooks/index.html +++ b/docs/advanced/hooks/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -433,6 +433,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -505,13 +519,13 @@

    Hooks

    -
  • - es - español + es - Spanish
    • @@ -433,6 +433,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -526,7 +540,7 @@

    Middleware

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/advanced/serverless_support/index.html b/docs/advanced/serverless_support/index.html index 70b9704..a3777ed 100644 --- a/docs/advanced/serverless_support/index.html +++ b/docs/advanced/serverless_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -433,6 +433,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -567,7 +581,7 @@

    Serverless support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/advanced/state/index.html b/docs/advanced/state/index.html new file mode 100644 index 0000000..edfa7d2 --- /dev/null +++ b/docs/advanced/state/index.html @@ -0,0 +1,586 @@ + + + + + + + + + + + + + + + + + + + + State - aiocli + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    + + + + + + + +

    State

    + +
      +
    • state...
      • +
    + + +
    +
    +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/advanced/test_support/index.html b/docs/advanced/test_support/index.html index 44018a3..5e7e0e3 100644 --- a/docs/advanced/test_support/index.html +++ b/docs/advanced/test_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -433,6 +433,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -561,7 +575,7 @@

    Test support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/advanced/exception_handler/index.html b/docs/en/advanced/exception_handler/index.html index b29f038..ab2277a 100644 --- a/docs/en/advanced/exception_handler/index.html +++ b/docs/en/advanced/exception_handler/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,7 +495,7 @@

    Exception handler

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/advanced/hooks/index.html b/docs/en/advanced/hooks/index.html index 38928b0..e262759 100644 --- a/docs/en/advanced/hooks/index.html +++ b/docs/en/advanced/hooks/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,7 +495,7 @@

    Hooks

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/advanced/middleware/index.html b/docs/en/advanced/middleware/index.html index 005f6b6..3bb2242 100644 --- a/docs/en/advanced/middleware/index.html +++ b/docs/en/advanced/middleware/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,7 +495,7 @@

    Middleware

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/advanced/serverless_support/index.html b/docs/en/advanced/serverless_support/index.html index 7f97f84..9204e08 100644 --- a/docs/en/advanced/serverless_support/index.html +++ b/docs/en/advanced/serverless_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -522,7 +536,7 @@

    Serverless support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/advanced/state/index.html b/docs/en/advanced/state/index.html new file mode 100644 index 0000000..9ac179f --- /dev/null +++ b/docs/en/advanced/state/index.html @@ -0,0 +1,541 @@ + + + + + + + + + + + + + + + + + + + + State - aiocli + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    + + + + + + + +

    State

    + +
      +
    • state...
      • +
    + + +
    +
    +
    + +
    + +
    + +
    +
    +
    + +
    + Copyright © 2020 - 2022 +
    + + +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/en/advanced/test_support/index.html b/docs/en/advanced/test_support/index.html index d22e14d..eaaba6a 100644 --- a/docs/en/advanced/test_support/index.html +++ b/docs/en/advanced/test_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -516,7 +530,7 @@

    Test support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/features/index.html b/docs/en/features/index.html index aca2d76..df36c62 100644 --- a/docs/en/features/index.html +++ b/docs/en/features/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -619,7 +633,7 @@

    Editor support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/index.html b/docs/en/index.html index 05c6fdf..a349174 100644 --- a/docs/en/index.html +++ b/docs/en/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -591,7 +605,7 @@

    License

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/en/release-notes/index.html b/docs/en/release-notes/index.html index 1904d1e..b47ca90 100644 --- a/docs/en/release-notes/index.html +++ b/docs/en/release-notes/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,6 +495,13 @@ @@ -481,7 +495,7 @@

    Exception handler

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/advanced/hooks/index.html b/docs/es/advanced/hooks/index.html index 199ad65..4645b51 100644 --- a/docs/es/advanced/hooks/index.html +++ b/docs/es/advanced/hooks/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,7 +495,7 @@

    Hooks

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/advanced/middleware/index.html b/docs/es/advanced/middleware/index.html index db9d80d..aa5f612 100644 --- a/docs/es/advanced/middleware/index.html +++ b/docs/es/advanced/middleware/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,7 +495,7 @@

    Middleware

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/advanced/serverless_support/index.html b/docs/es/advanced/serverless_support/index.html index 5c258a2..73e7c63 100644 --- a/docs/es/advanced/serverless_support/index.html +++ b/docs/es/advanced/serverless_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -522,7 +536,7 @@

    Serverless support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/advanced/test_support/index.html b/docs/es/advanced/test_support/index.html index aa124bf..3538a6e 100644 --- a/docs/es/advanced/test_support/index.html +++ b/docs/es/advanced/test_support/index.html @@ -128,7 +128,7 @@
  • - es - español + es - Spanish
    • @@ -423,6 +423,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -516,7 +530,7 @@

    Test support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/features/index.html b/docs/es/features/index.html index af110a7..031a841 100644 --- a/docs/es/features/index.html +++ b/docs/es/features/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -619,7 +633,7 @@

    Soporte para Editores

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/index.html b/docs/es/index.html index da2c182..e6ca67b 100644 --- a/docs/es/index.html +++ b/docs/es/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -592,7 +606,7 @@

    Licencia

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/es/release-notes/index.html b/docs/es/release-notes/index.html index ddb0368..b2c8edd 100644 --- a/docs/es/release-notes/index.html +++ b/docs/es/release-notes/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -481,6 +495,13 @@ @@ -739,7 +753,7 @@

    Editor support

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/index.html b/docs/index.html index e709c46..f209feb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -490,6 +490,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -673,7 +687,7 @@

    License

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/release-notes/index.html b/docs/release-notes/index.html index 17fa70b..c864853 100644 --- a/docs/release-notes/index.html +++ b/docs/release-notes/index.html @@ -133,7 +133,7 @@
  • - es - español + es - Spanish
    • @@ -428,6 +428,20 @@ + + + + + +
  • + + State + +
    • + + + + @@ -479,6 +493,13 @@
    @@ -711,7 +746,7 @@

    1.0.x

    - Copyright © 2020 - 2021 + Copyright © 2020 - 2022
    diff --git a/docs/search/search_index.json b/docs/search/search_index.json index f5fce14..631878d 100644 --- a/docs/search/search_index.json +++ b/docs/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"AIOCLI A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test. Requirements Python 3.6+ Installation python3 -m pip install aiocli Example from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) License MIT","title":"aiocli"},{"location":"#aiocli","text":"A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test.","title":"AIOCLI"},{"location":"#requirements","text":"Python 3.6+","title":"Requirements"},{"location":"#installation","text":"python3 -m pip install aiocli","title":"Installation"},{"location":"#example","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Example"},{"location":"#license","text":"MIT","title":"License"},{"location":"features/","text":"AIOCLI features AIOCLI provides you with the following: Native-based Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly. Async support Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management. Dependency Injection Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance. Serverless support Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else? Test support Provides TestCommander and TestClient utilities. No more excuses not to test. Editor support in Visual Studio Code : in PyCharm :","title":"Features"},{"location":"features/#aiocli-features","text":"AIOCLI provides you with the following:","title":"AIOCLI features"},{"location":"features/#native-based","text":"Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly.","title":"Native-based"},{"location":"features/#async-support","text":"Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management.","title":"Async support"},{"location":"features/#dependency-injection","text":"Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance.","title":"Dependency Injection"},{"location":"features/#serverless-support","text":"Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else?","title":"Serverless support"},{"location":"features/#test-support","text":"Provides TestCommander and TestClient utilities. No more excuses not to test.","title":"Test support"},{"location":"features/#editor-support","text":"in Visual Studio Code : in PyCharm :","title":"Editor support"},{"location":"release-notes/","text":"CHANGELOG 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs. 1.4.x Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs.","title":"1.5.x"},{"location":"release-notes/#14x","text":"Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests.","title":"1.4.x"},{"location":"release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"advanced/serverless_support/","text":"with AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) with Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) with Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"advanced/test_support/","text":"Have you used the pytest-aiohttp plugin? This is inspired on it. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"},{"location":"en/","text":"AIOCLI A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test. Requirements Python 3.6+ Installation python3 -m pip install aiocli Example from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) License MIT","title":"AIOCLI"},{"location":"en/#aiocli","text":"A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test.","title":"AIOCLI"},{"location":"en/#requirements","text":"Python 3.6+","title":"Requirements"},{"location":"en/#installation","text":"python3 -m pip install aiocli","title":"Installation"},{"location":"en/#example","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Example"},{"location":"en/#license","text":"MIT","title":"License"},{"location":"en/features/","text":"AIOCLI features AIOCLI provides you with the following: Native-based Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly. Async support Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management. Dependency Injection Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance. Serverless support Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else? Test support Provides TestCommander and TestClient utilities. No more excuses not to test. Editor support in Visual Studio Code : in PyCharm :","title":"Features"},{"location":"en/features/#aiocli-features","text":"AIOCLI provides you with the following:","title":"AIOCLI features"},{"location":"en/features/#native-based","text":"Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly.","title":"Native-based"},{"location":"en/features/#async-support","text":"Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management.","title":"Async support"},{"location":"en/features/#dependency-injection","text":"Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance.","title":"Dependency Injection"},{"location":"en/features/#serverless-support","text":"Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else?","title":"Serverless support"},{"location":"en/features/#test-support","text":"Provides TestCommander and TestClient utilities. No more excuses not to test.","title":"Test support"},{"location":"en/features/#editor-support","text":"in Visual Studio Code : in PyCharm :","title":"Editor support"},{"location":"en/release-notes/","text":"CHANGELOG 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs. 1.4.x Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"en/release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"en/release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs.","title":"1.5.x"},{"location":"en/release-notes/#14x","text":"Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests.","title":"1.4.x"},{"location":"en/release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"en/release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"en/release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"en/release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"en/advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"en/advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"en/advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"en/advanced/serverless_support/","text":"with AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) with Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) with Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"en/advanced/test_support/","text":"Have you used the pytest-aiohttp plugin? This is inspired on it. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"},{"location":"es/","text":"AIOCLI Un moderno ligero ejecutor de consola as\u00edncrono para construir CLIs con Python 3.6+ basado en el m\u00f3dulo est\u00e1ndar de Python argparse y type hints altamente inspirado en AIOHTTP y FastApi . Caracter\u00edsticas principales: Integraci\u00f3n nativa : Basado en (y totalmente compatible con) el m\u00f3dulo argparse de Python. Soporte as\u00edncrono : Maneja comandos a/s\u00edncronamente para cualquier tipo de aplicaci\u00f3n. Soporte serverless : Integracion con AWS Lambda , Azure Function y Google Cloud Function . Soporte para tests : Dise\u00f1ado para ser f\u00e1cil de ejecutar y probar. Requisitos Python 3.6+ Instalaci\u00f3n python3 -m pip install aiocli Ejemplo from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application () def _get_envs () -> dict [ str , str ]: return { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } def _get_logger ( envs : dict [ str , str ] = Depends ( _get_envs )) -> Logger : logger = getLogger ( envs [ 'LOGGER_NAME' ]) logger . setLevel ( envs [ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) Licencia MIT","title":"AIOCLI"},{"location":"es/#aiocli","text":"Un moderno ligero ejecutor de consola as\u00edncrono para construir CLIs con Python 3.6+ basado en el m\u00f3dulo est\u00e1ndar de Python argparse y type hints altamente inspirado en AIOHTTP y FastApi . Caracter\u00edsticas principales: Integraci\u00f3n nativa : Basado en (y totalmente compatible con) el m\u00f3dulo argparse de Python. Soporte as\u00edncrono : Maneja comandos a/s\u00edncronamente para cualquier tipo de aplicaci\u00f3n. Soporte serverless : Integracion con AWS Lambda , Azure Function y Google Cloud Function . Soporte para tests : Dise\u00f1ado para ser f\u00e1cil de ejecutar y probar.","title":"AIOCLI"},{"location":"es/#requisitos","text":"Python 3.6+","title":"Requisitos"},{"location":"es/#instalacion","text":"python3 -m pip install aiocli","title":"Instalaci\u00f3n"},{"location":"es/#ejemplo","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application () def _get_envs () -> dict [ str , str ]: return { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } def _get_logger ( envs : dict [ str , str ] = Depends ( _get_envs )) -> Logger : logger = getLogger ( envs [ 'LOGGER_NAME' ]) logger . setLevel ( envs [ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Ejemplo"},{"location":"es/#licencia","text":"MIT","title":"Licencia"},{"location":"es/features/","text":"AIOCLI funcionalidades AIOCLI provides you with the following: Integraci\u00f3n nativa Totalmente compatible con el m\u00f3dulo argparse de Python. Nada nuevo que aprender. Completamente tipado basado en el est\u00e1ndar de Python 3.6 type hints . Menos bugs, adaptado a los IDEs. Soporte As\u00edncrono Funciona y se espera gracias al m\u00e9todo run_app(...) como el de la librer\u00eda AIOHTTP . F\u00e1cil de usar. Permite establecer tu event loop , por defecto es get_event_loop() . Mejor integraci\u00f3n con terceros. Maneja las signal\u2019s life-cycle utilizando los CommandHook . Genial manejo de las se\u00f1ales UNIX. Inyecci\u00f3n de Dependencias Siempre deben de ser funciones \"sync\", async o yield . Soluciona varios problemas con aio. Cada dependencia puede a su vez tener dependencias como un \"grafo\". Evita liarla parda. Cada dependencia permite caching . Incre\u00edble rendimiento. Soporte para Serverless Proveedores Cloud: AWS Lambda, Azure Function y Google Cloud Function. Go serverless. A medida: Decorando la funci\u00f3n run_app y cambiando los valores de los argumentos por defecto. \u00bfAlgo m\u00e1s? Soporte para Tests Provee TestCommander y TestClient como utilidades. No hay m\u00e1s excusas para no hacer tests. Soporte para Editores en Visual Studio Code : en PyCharm :","title":"Features"},{"location":"es/features/#aiocli-funcionalidades","text":"AIOCLI provides you with the following:","title":"AIOCLI funcionalidades"},{"location":"es/features/#integracion-nativa","text":"Totalmente compatible con el m\u00f3dulo argparse de Python. Nada nuevo que aprender. Completamente tipado basado en el est\u00e1ndar de Python 3.6 type hints . Menos bugs, adaptado a los IDEs.","title":"Integraci\u00f3n nativa"},{"location":"es/features/#soporte-asincrono","text":"Funciona y se espera gracias al m\u00e9todo run_app(...) como el de la librer\u00eda AIOHTTP . F\u00e1cil de usar. Permite establecer tu event loop , por defecto es get_event_loop() . Mejor integraci\u00f3n con terceros. Maneja las signal\u2019s life-cycle utilizando los CommandHook . Genial manejo de las se\u00f1ales UNIX.","title":"Soporte As\u00edncrono"},{"location":"es/features/#inyeccion-de-dependencias","text":"Siempre deben de ser funciones \"sync\", async o yield . Soluciona varios problemas con aio. Cada dependencia puede a su vez tener dependencias como un \"grafo\". Evita liarla parda. Cada dependencia permite caching . Incre\u00edble rendimiento.","title":"Inyecci\u00f3n de Dependencias"},{"location":"es/features/#soporte-para-serverless","text":"Proveedores Cloud: AWS Lambda, Azure Function y Google Cloud Function. Go serverless. A medida: Decorando la funci\u00f3n run_app y cambiando los valores de los argumentos por defecto. \u00bfAlgo m\u00e1s?","title":"Soporte para Serverless"},{"location":"es/features/#soporte-para-tests","text":"Provee TestCommander y TestClient como utilidades. No hay m\u00e1s excusas para no hacer tests.","title":"Soporte para Tests"},{"location":"es/features/#soporte-para-editores","text":"en Visual Studio Code : en PyCharm :","title":"Soporte para Editores"},{"location":"es/release-notes/","text":"CHANGELOG 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs. 1.4.x Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"es/release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"es/release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve Docs.","title":"1.5.x"},{"location":"es/release-notes/#14x","text":"Add Middleware handlers. Add Exception handlers. Add Docs. More types. More tests.","title":"1.4.x"},{"location":"es/release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"es/release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"es/release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"es/release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"es/advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"es/advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"es/advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"es/advanced/serverless_support/","text":"con AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) con Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) con Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"es/advanced/test_support/","text":"Has utilizado el plugin pytest-aiohttp ? Esto est\u00e1 inspirado en ello. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"AIOCLI A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test. Requirements Python 3.6+ Installation python3 -m pip install aiocli Example from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) License MIT","title":"aiocli"},{"location":"#aiocli","text":"A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test.","title":"AIOCLI"},{"location":"#requirements","text":"Python 3.6+","title":"Requirements"},{"location":"#installation","text":"python3 -m pip install aiocli","title":"Installation"},{"location":"#example","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Example"},{"location":"#license","text":"MIT","title":"License"},{"location":"features/","text":"AIOCLI features AIOCLI provides you with the following: Native-based Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly. Async support Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management. Dependency Injection Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance. Serverless support Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else? Test support Provides TestCommander and TestClient utilities. No more excuses not to test. Editor support in Visual Studio Code : in PyCharm :","title":"Features"},{"location":"features/#aiocli-features","text":"AIOCLI provides you with the following:","title":"AIOCLI features"},{"location":"features/#native-based","text":"Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly.","title":"Native-based"},{"location":"features/#async-support","text":"Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management.","title":"Async support"},{"location":"features/#dependency-injection","text":"Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance.","title":"Dependency Injection"},{"location":"features/#serverless-support","text":"Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else?","title":"Serverless support"},{"location":"features/#test-support","text":"Provides TestCommander and TestClient utilities. No more excuses not to test.","title":"Test support"},{"location":"features/#editor-support","text":"in Visual Studio Code : in PyCharm :","title":"Editor support"},{"location":"release-notes/","text":"CHANGELOG 1.6.x Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs. 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs. 1.4.x Add middleware handlers. Add exception handlers. Add docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"release-notes/#16x","text":"Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs.","title":"1.6.x"},{"location":"release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs.","title":"1.5.x"},{"location":"release-notes/#14x","text":"Add middleware handlers. Add exception handlers. Add docs. More types. More tests.","title":"1.4.x"},{"location":"release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"advanced/serverless_support/","text":"with AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) with Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) with Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"advanced/state/","text":"state...","title":"State"},{"location":"advanced/test_support/","text":"Have you used the pytest-aiohttp plugin? This is inspired on it. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"},{"location":"en/","text":"AIOCLI A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test. Requirements Python 3.6+ Installation python3 -m pip install aiocli Example from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) License MIT","title":"AIOCLI"},{"location":"en/#aiocli","text":"A modern, lightweight, async console runner for building CLIs with Python 3.6+ based on standard Python's argparse module and type hints highly inspired by AIOHTTP and FastApi . Key Features: Native-based : Based on (and fully compatible with) Python's argparse module. Async support : Handle commands completely async thinking in smaller and larger apps. Serverless support : Wrappers for AWS Lambda , Azure Function and Google Cloud Function . Test support : Designed to be easy to execute and test.","title":"AIOCLI"},{"location":"en/#requirements","text":"Python 3.6+","title":"Requirements"},{"location":"en/#installation","text":"python3 -m pip install aiocli","title":"Installation"},{"location":"en/#example","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application ( state = { 'envs' : { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } }) def _get_logger ( state : State ) -> Logger : logger = getLogger ( state . get ( 'envs' )[ 'LOGGER_NAME' ]) logger . setLevel ( state . get ( 'envs' )[ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Example"},{"location":"en/#license","text":"MIT","title":"License"},{"location":"en/features/","text":"AIOCLI features AIOCLI provides you with the following: Native-based Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly. Async support Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management. Dependency Injection Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance. Serverless support Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else? Test support Provides TestCommander and TestClient utilities. No more excuses not to test. Editor support in Visual Studio Code : in PyCharm :","title":"Features"},{"location":"en/features/#aiocli-features","text":"AIOCLI provides you with the following:","title":"AIOCLI features"},{"location":"en/features/#native-based","text":"Full compatible with Python's argparse module . Nothing new to learn. Completely typed based on standard Python 3.6 type hints . Fewer bugs, IDEs friendly.","title":"Native-based"},{"location":"en/features/#async-support","text":"Works and awaited through run_app(...) method like AIOHTTP library. Easy to use. Allow set an event loop , by default get_event_loop() . Better third party integrations. Handle signal\u2019s life-cycle using CommandHook s. Great UNIX signals management.","title":"Async support"},{"location":"en/features/#dependency-injection","text":"Always must be functions whether kind be \"sync\", async or yield . Solves several aio issues. Each dependency can have dependencies like a \"graph\". Avoid making a mess. Each dependency allows caching . Better performance.","title":"Dependency Injection"},{"location":"en/features/#serverless-support","text":"Cloud providers: AWS Lambda, Azure Function and Google Cloud Function. Go serverless. Custom: Wrapping run_app function and changing default argument values. Anything else?","title":"Serverless support"},{"location":"en/features/#test-support","text":"Provides TestCommander and TestClient utilities. No more excuses not to test.","title":"Test support"},{"location":"en/features/#editor-support","text":"in Visual Studio Code : in PyCharm :","title":"Editor support"},{"location":"en/release-notes/","text":"CHANGELOG 1.6.x Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs. 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs. 1.4.x Add middleware handlers. Add exception handlers. Add docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"en/release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"en/release-notes/#16x","text":"Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs.","title":"1.6.x"},{"location":"en/release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs.","title":"1.5.x"},{"location":"en/release-notes/#14x","text":"Add middleware handlers. Add exception handlers. Add docs. More types. More tests.","title":"1.4.x"},{"location":"en/release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"en/release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"en/release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"en/release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"en/advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"en/advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"en/advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"en/advanced/serverless_support/","text":"with AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) with Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) with Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"en/advanced/state/","text":"state...","title":"State"},{"location":"en/advanced/test_support/","text":"Have you used the pytest-aiohttp plugin? This is inspired on it. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"},{"location":"es/","text":"AIOCLI Un moderno ligero ejecutor de consola as\u00edncrono para construir CLIs con Python 3.6+ basado en el m\u00f3dulo est\u00e1ndar de Python argparse y type hints altamente inspirado en AIOHTTP y FastApi . Caracter\u00edsticas principales: Integraci\u00f3n nativa : Basado en (y totalmente compatible con) el m\u00f3dulo argparse de Python. Soporte as\u00edncrono : Maneja comandos a/s\u00edncronamente para cualquier tipo de aplicaci\u00f3n. Soporte serverless : Integracion con AWS Lambda , Azure Function y Google Cloud Function . Soporte para tests : Dise\u00f1ado para ser f\u00e1cil de ejecutar y probar. Requisitos Python 3.6+ Instalaci\u00f3n python3 -m pip install aiocli Ejemplo from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application () def _get_envs () -> dict [ str , str ]: return { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } def _get_logger ( envs : dict [ str , str ] = Depends ( _get_envs )) -> Logger : logger = getLogger ( envs [ 'LOGGER_NAME' ]) logger . setLevel ( envs [ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app ) Licencia MIT","title":"AIOCLI"},{"location":"es/#aiocli","text":"Un moderno ligero ejecutor de consola as\u00edncrono para construir CLIs con Python 3.6+ basado en el m\u00f3dulo est\u00e1ndar de Python argparse y type hints altamente inspirado en AIOHTTP y FastApi . Caracter\u00edsticas principales: Integraci\u00f3n nativa : Basado en (y totalmente compatible con) el m\u00f3dulo argparse de Python. Soporte as\u00edncrono : Maneja comandos a/s\u00edncronamente para cualquier tipo de aplicaci\u00f3n. Soporte serverless : Integracion con AWS Lambda , Azure Function y Google Cloud Function . Soporte para tests : Dise\u00f1ado para ser f\u00e1cil de ejecutar y probar.","title":"AIOCLI"},{"location":"es/#requisitos","text":"Python 3.6+","title":"Requisitos"},{"location":"es/#instalacion","text":"python3 -m pip install aiocli","title":"Instalaci\u00f3n"},{"location":"es/#ejemplo","text":"from logging import getLogger , Logger , StreamHandler from os import getenv from aiocli.commander import run_app , Application , Depends app = Application () def _get_envs () -> dict [ str , str ]: return { 'LOGGER_NAME' : str ( getenv ( 'LOGGER_NAME' , 'example_app' )), 'LOGGER_LEVEL' : str ( getenv ( 'LOGGER_LEVEL' , 'INFO' )), } def _get_logger ( envs : dict [ str , str ] = Depends ( _get_envs )) -> Logger : logger = getLogger ( envs [ 'LOGGER_NAME' ]) logger . setLevel ( envs [ 'LOGGER_LEVEL' ]) handler = StreamHandler () logger . addHandler ( handler ) return logger @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World!' })]) async def handle_greeting ( name : str , logger : Logger = Depends ( _get_logger )) -> int : logger . info ( f 'Hello { name } ' ) return 0 @app . command ( name = 'div' , optionals = [( '--a' , { 'type' : float }), ( '--b' , { 'type' : float })]) async def handle_division ( a : float , b : float , logger : Logger = Depends ( _get_logger )) -> int : try : logger . info ( f 'Result { a } / { b } = { ( a / b ) } ' ) return 0 except BaseException as err : logger . error ( f 'Error: { err } ' ) return 1 # python3 main.py if __name__ == '__main__' : run_app ( app )","title":"Ejemplo"},{"location":"es/#licencia","text":"MIT","title":"Licencia"},{"location":"es/features/","text":"AIOCLI funcionalidades AIOCLI provides you with the following: Integraci\u00f3n nativa Totalmente compatible con el m\u00f3dulo argparse de Python. Nada nuevo que aprender. Completamente tipado basado en el est\u00e1ndar de Python 3.6 type hints . Menos bugs, adaptado a los IDEs. Soporte As\u00edncrono Funciona y se espera gracias al m\u00e9todo run_app(...) como el de la librer\u00eda AIOHTTP . F\u00e1cil de usar. Permite establecer tu event loop , por defecto es get_event_loop() . Mejor integraci\u00f3n con terceros. Maneja las signal\u2019s life-cycle utilizando los CommandHook . Genial manejo de las se\u00f1ales UNIX. Inyecci\u00f3n de Dependencias Siempre deben de ser funciones \"sync\", async o yield . Soluciona varios problemas con aio. Cada dependencia puede a su vez tener dependencias como un \"grafo\". Evita liarla parda. Cada dependencia permite caching . Incre\u00edble rendimiento. Soporte para Serverless Proveedores Cloud: AWS Lambda, Azure Function y Google Cloud Function. Go serverless. A medida: Decorando la funci\u00f3n run_app y cambiando los valores de los argumentos por defecto. \u00bfAlgo m\u00e1s? Soporte para Tests Provee TestCommander y TestClient como utilidades. No hay m\u00e1s excusas para no hacer tests. Soporte para Editores en Visual Studio Code : en PyCharm :","title":"Features"},{"location":"es/features/#aiocli-funcionalidades","text":"AIOCLI provides you with the following:","title":"AIOCLI funcionalidades"},{"location":"es/features/#integracion-nativa","text":"Totalmente compatible con el m\u00f3dulo argparse de Python. Nada nuevo que aprender. Completamente tipado basado en el est\u00e1ndar de Python 3.6 type hints . Menos bugs, adaptado a los IDEs.","title":"Integraci\u00f3n nativa"},{"location":"es/features/#soporte-asincrono","text":"Funciona y se espera gracias al m\u00e9todo run_app(...) como el de la librer\u00eda AIOHTTP . F\u00e1cil de usar. Permite establecer tu event loop , por defecto es get_event_loop() . Mejor integraci\u00f3n con terceros. Maneja las signal\u2019s life-cycle utilizando los CommandHook . Genial manejo de las se\u00f1ales UNIX.","title":"Soporte As\u00edncrono"},{"location":"es/features/#inyeccion-de-dependencias","text":"Siempre deben de ser funciones \"sync\", async o yield . Soluciona varios problemas con aio. Cada dependencia puede a su vez tener dependencias como un \"grafo\". Evita liarla parda. Cada dependencia permite caching . Incre\u00edble rendimiento.","title":"Inyecci\u00f3n de Dependencias"},{"location":"es/features/#soporte-para-serverless","text":"Proveedores Cloud: AWS Lambda, Azure Function y Google Cloud Function. Go serverless. A medida: Decorando la funci\u00f3n run_app y cambiando los valores de los argumentos por defecto. \u00bfAlgo m\u00e1s?","title":"Soporte para Serverless"},{"location":"es/features/#soporte-para-tests","text":"Provee TestCommander y TestClient como utilidades. No hay m\u00e1s excusas para no hacer tests.","title":"Soporte para Tests"},{"location":"es/features/#soporte-para-editores","text":"en Visual Studio Code : en PyCharm :","title":"Soporte para Editores"},{"location":"es/release-notes/","text":"CHANGELOG 1.6.x Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs. 1.5.x Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs. 1.4.x Add middleware handlers. Add exception handlers. Add docs. More types. More tests. 1.3.x Add Dependency Injection. Improve example. Improve README.md. 1.2.x Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests. 1.1.x Fix exports. Improve README.md 1.0.x Add Comander. Add Runner. Add tests.","title":"Release notes"},{"location":"es/release-notes/#changelog","text":"","title":"CHANGELOG"},{"location":"es/release-notes/#16x","text":"Add State. Add CommandArgument based on argparse.add_argument function args. Improve debug traces. Improve docs.","title":"1.6.x"},{"location":"es/release-notes/#15x","text":"Common Serverless wrappers (aws, az and gcp) added. Fix event loop issues closing it. Improve exception handlers matching. Improve docs.","title":"1.5.x"},{"location":"es/release-notes/#14x","text":"Add middleware handlers. Add exception handlers. Add docs. More types. More tests.","title":"1.4.x"},{"location":"es/release-notes/#13x","text":"Add Dependency Injection. Improve example. Improve README.md.","title":"1.3.x"},{"location":"es/release-notes/#12x","text":"Add command decorator. Add startup, shutdown and cleanup handler signals. Fix event loop issues when cancelling tasks. Improve exit code feature support. Fix Python 3.6 support with all_tasks function helper. Add example. Add GitHub actions pipeline. Improve tests.","title":"1.2.x"},{"location":"es/release-notes/#11x","text":"Fix exports. Improve README.md","title":"1.1.x"},{"location":"es/release-notes/#10x","text":"Add Comander. Add Runner. Add tests.","title":"1.0.x"},{"location":"es/advanced/exception_handler/","text":"exception handler...","title":"Exception handler"},{"location":"es/advanced/hooks/","text":"hooks...","title":"Hooks"},{"location":"es/advanced/middleware/","text":"middleware...","title":"Middleware"},{"location":"es/advanced/serverless_support/","text":"con AWS Lambda : from aiocli.commander import Application from aiocli.commander_app_wrappers import aws_run_app app = Application () def _parser ( event , context ) -> list [ str ]: pass handler = aws_run_app ( app , parser = _parser ) con Azure Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import az_run_app app = Application () def _parser ( req , context ) -> list [ str ]: pass handler = az_run_app ( app , parser = _parser ) con Google Cloud Function : from aiocli.commander import Application from aiocli.commander_app_wrappers import gcp_run_app app = Application () def _http_parser ( request ) -> list [ str ]: pass http_handler = gcp_run_app ( app , parser = _http_parser ) def _event_parser ( event_or_data , context ) -> list [ str ]: pass event_handler = gcp_run_app ( app , parser = _event_parser )","title":"Serverless support"},{"location":"es/advanced/test_support/","text":"Has utilizado el plugin pytest-aiohttp ? Esto est\u00e1 inspirado en ello. # code: python3 from aiocli.commander import run_app , Application app = Application ( default_exit_code = 1 ) @app . command ( name = 'greet:to' , positionals = [( '--name' , { 'default' : 'World' })]) async def handle_greeting ( name : str ) -> int : print ( f 'Hello { name } ' ) return 0 if __name__ == '__main__' : run_app ( app ) # test: pytest from aiocli.test_utils import TestClient , TestCommander import pytest @pytest . mark . asyncio async def test_handle_greeting_command () -> None : commander = TestCommander ( app ) client = TestClient ( commander ) try : await commander . start_commander () args = 'greet:to --name aiocli' exit_code = await client . handle ( args . split ( ' ' ), timeout = float ( 1 ), timeout_exit_code = 134 , ) assert exit_code == 0 finally : await commander . close ()","title":"Test support"}]} \ No newline at end of file diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 6cdcee9..4789536 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,122 +2,132 @@ https://aiopy.github.io/python-aiocli/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/features/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/release-notes/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/advanced/exception_handler/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/advanced/hooks/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/advanced/middleware/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/advanced/serverless_support/ - 2022-04-17 + 2022-04-18 + daily + + + https://aiopy.github.io/python-aiocli/advanced/state/ + 2022-04-18 daily https://aiopy.github.io/python-aiocli/advanced/test_support/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/features/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/release-notes/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/advanced/exception_handler/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/advanced/hooks/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/advanced/middleware/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/advanced/serverless_support/ - 2022-04-17 + 2022-04-18 + daily + + + https://aiopy.github.io/python-aiocli/en/advanced/state/ + 2022-04-18 daily https://aiopy.github.io/python-aiocli/en/advanced/test_support/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/features/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/release-notes/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/advanced/exception_handler/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/advanced/hooks/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/advanced/middleware/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/advanced/serverless_support/ - 2022-04-17 + 2022-04-18 daily https://aiopy.github.io/python-aiocli/es/advanced/test_support/ - 2022-04-17 + 2022-04-18 daily \ No newline at end of file diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz index 02148c5..72f4ab5 100644 Binary files a/docs/sitemap.xml.gz and b/docs/sitemap.xml.gz differ diff --git a/docs_src/docs/en/advanced/state.md b/docs_src/docs/en/advanced/state.md new file mode 100644 index 0000000..963fa2f --- /dev/null +++ b/docs_src/docs/en/advanced/state.md @@ -0,0 +1 @@ +- state... \ No newline at end of file diff --git a/docs_src/docs/en/release-notes.md b/docs_src/docs/en/release-notes.md index 4591553..620ec9e 100644 --- a/docs_src/docs/en/release-notes.md +++ b/docs_src/docs/en/release-notes.md @@ -1,17 +1,24 @@ ## CHANGELOG +### **1.6.x** + +* Add State. +* Add CommandArgument based on argparse.add_argument function args. +* Improve debug traces. +* Improve docs. + ### **1.5.x** * Common Serverless wrappers (aws, az and gcp) added. * Fix event loop issues closing it. * Improve exception handlers matching. -* Improve Docs. +* Improve docs. ### **1.4.x** -* Add Middleware handlers. -* Add Exception handlers. -* Add Docs. +* Add middleware handlers. +* Add exception handlers. +* Add docs. * More types. * More tests. @@ -29,7 +36,7 @@ * Improve exit code feature support. * Fix Python 3.6 support with all_tasks function helper. * Add example. -* Add GitHub actions pipeline. +* Add GitHub actions pipeline. * Improve tests. ### **1.1.x** diff --git a/docs_src/mkdocs.yml b/docs_src/mkdocs.yml index 98f4447..0520262 100644 --- a/docs_src/mkdocs.yml +++ b/docs_src/mkdocs.yml @@ -26,6 +26,7 @@ nav: - advanced/middleware.md - advanced/exception_handler.md - advanced/hooks.md + - advanced/state.md - release-notes.md extra: social: @@ -37,9 +38,9 @@ extra: - link: /en/ name: en - English - link: /es/ - name: es - español + name: es - Spanish generator: false -copyright: Copyright © 2020 - 2021 +copyright: Copyright © 2020 - 2022 markdown_extensions: - pymdownx.highlight - pymdownx.superfences diff --git a/pyproject.toml b/pyproject.toml index 5514b07..655e82d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [metadata] name = "aiocli" -version = "1.6.0" +version = "1.6.1" description = "Simple and lightweight async console runner." license = "MIT" authors = ["ticdenis "] diff --git a/requirements-dev.txt b/requirements-dev.txt index 334877b..9f88008 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,6 +1,6 @@ -r requirements.txt autoflake==1.4 -# Due to Python 3.6 +# fixed due to Python 3.6 support bandit>=1.7.1 black==22.3.0 commitizen==2.24.0 @@ -10,21 +10,21 @@ mkdocs==1.3.0 mkdocs-material==8.2.9 mypy==0.942 nest-asyncio==1.5.5 -# Due to Python 3.6 +# fixed due to Python 3.6 support pre-commit>=2.17.0 psutil==5.9.0 pylint==2.13.5 -# Due to Python 3.6 +# fixed due to Python 3.6 support pytest>=6.2.3 -# Due to Python 3.6 +# fixed due to Python 3.6 support pytest-asyncio>=0.16.0 pytest-cov==3.0.0 pytest-xdist==2.5.0 pytoml==0.1.21 -# Due to Python 3.6 +# fixed due to Python 3.6 support setuptools>=59.6.0 -# Due to Python 3.6 +# fixed due to Python 3.6 support shellcheck-py>=0.8.0.3 -# Due to Python 3.6 +# fixed due to Python 3.6 support twine>=3.8.0 wheel==0.37.1