Upgrading typer 0.2 to 0.3
Review needed0.2.1 → 0.3.2New4Changed4Other16
Review neededUpgrade verdict
4 changed defaults.
In plain terms
- Nothing in this range needs changes to your code. It adds features and fixes.
Must act Nothing to change
No breaking, platform, security or deprecated items in this range.
Nothing in this upgrade needs a code or configuration change.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- added:
class TyperArgument(click.core.Argument) - added:
class TyperCommand(click.core.Command) - added:
constructor TyperArgument(*, param_decls: List[str], type: Optional[Any]=…, required: Optional[bool]=…, default: Optional[Any]=…, callback: Optional[Callable[..., Any]]=…, nargs: Optional[int]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: Union[bool, str]=…, show_choices… - added:
method TyperArgument.get_help_record(ctx: click.Context) -> Optional[Tuple[str, str]] - added:
method TyperArgument.make_metavar() -> str - added:
method TyperCommand.format_options(ctx: click.Context, formatter: click.HelpFormatter) -> None
- changed:
constructor Typer(*, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, opti… → constructor Typer(*, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: O… - changed:
function generate_enum_convertor(enum: Type[Enum]) -> Callable → function generate_enum_convertor(enum: Type[Enum]) -> Callable[..., Any] - changed:
function generate_iter_convertor(convertor: Callable[[Any], Any]) -> Callable → function generate_iter_convertor(convertor: Callable[[Any], Any]) -> Callable[..., Any] - changed:
function get_callback(*, callback: Optional[Callable]=…, params: Sequence[click.Parameter]=…, convertors: Dict[str, Callable[[str], Any]]=…, context_param_name: str=…) -> Optional[Callable] → function get_callback(*, callback: Optional[Callable[..., Any]]=…, params: Sequence[click.Parameter]=…, convertors: Dict[str, Callable[[str], Any]]=…, context_param_name: Optional[str]=…) -> Optional[Callable[..., Any]] - changed:
function get_param_callback(*, callback: Optional[Callable]=…, convertor: Optional[Callable]=…) -> Optional[Callable] → function get_param_callback(*, callback: Optional[Callable[..., Any]]=…, convertor: Optional[Callable[..., Any]]=…) -> Optional[Callable[..., Any]] - changed:
function get_param_completion(callback: Optional[Callable]=…) -> Optional[Callable] → function get_param_completion(callback: Optional[Callable[..., Any]]=…) -> Optional[Callable[..., Any]] - changed:
function run(function: Callable) -> Any → function run(function: Callable[..., Any]) -> Any - changed:
method Typer.add_typer(typer_instance: Typer, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable]=…, help: Optional[str]=…, epilog: Optional[str]=…, short… → method Typer.add_typer(typer_instance: Typer, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…, epilog: Op… - changed:
method Typer.callback(name: Optional[str]=…, *, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable]=…, context_settings: Optional[Dict[Any, Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, options_metavar: str=…, add_help… → method Typer.callback(name: Optional[str]=…, *, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, options_metavar: str=……
- changed:
constructor ArgumentInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable]=…, case_sensitive: bool=…, min: Optional[Union[int, float]]=…, max: Optional[Union[int, float]]=…, clamp: bool=…, formats: Option… → constructor ArgumentInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: Union[bool, str]=…, show_choices: bool=…, show_envvar: bool=…, help: Optional[str]=…, hidden… - changed:
constructor CommandInfo(name: Optional[str]=…, *, cls: Optional[Type[click.Command]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, options_metavar: str=…, add_help_option: bool=…, no_args_is_help: bool=…, hidden: bool=…, deprecated: bool=…) → constructor CommandInfo(name: Optional[str]=…, *, cls: Optional[Type[click.Command]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, options_metavar: str=…, add_help_option: bool=…, no_args_is_help: bool=…, hidden: bool=…, deprecated: bool=…) - changed:
constructor OptionInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable]=…, show_default: bool=…, prompt: Union[bool, str]=…, confirmation_prompt: bool=…, hide_input: bool=…, is_flag: Optional[bool]=…, fl… → constructor OptionInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: bool=…, prompt: Union[bool, str]=…, confirmation_prompt: bool=…, hide_input: bool=…, is_flag:… - changed:
constructor ParameterInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable]=…, case_sensitive: bool=…, min: Optional[Union[int, float]]=…, max: Optional[Union[int, float]]=…, clamp: bool=…, formats: Optio… → constructor ParameterInfo(*, default: Optional[Any]=…, param_decls: Optional[Sequence[str]]=…, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: Union[bool, str]=…, show_choices: bool=…, show_envvar: bool=…, help: Optional[str]=…, hidde… - changed:
constructor TyperInfo(typer_instance: Optional[Typer]=…, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable]=…, help: Optional[str]=…, epilog: Optional[st… → constructor TyperInfo(typer_instance: Optional[Typer]=…, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: Optional[bool]=…, subcommand_metavar: Optional[str]=…, chain: bool=…, result_callback: Optional[Callable[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…,…
- changed:
function Argument(default: Optional[Any], *, callback: Optional[Callable]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable]=…, case_sensitive: bool=…, min: Optional[Union[int, float]]=…, max: Optional[Union[int, float]]=…, clamp: bool=…, formats: Optional[Union[List[str]]]=…, mode: str=…, encoding: Op… → function Argument(default: Optional[Any], *, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: Union[bool, str]=…, show_choices: bool=…, show_envvar: bool=…, help: Optional[str]=…, hidden: bool=…, case_sensitive: bool=…, min: Optional[U… - changed:
function Option(default: Optional[Any], *param_decls: str, callback: Optional[Callable]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable]=…, show_default: bool=…, prompt: Union[bool, str]=…, confirmation_prompt: bool=…, hide_input: bool=…, is_flag: Optional[bool]=…, flag_value: Optional[Any]=…, count:… → function Option(default: Optional[Any], *param_decls: str, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: bool=…, prompt: Union[bool, str]=…, confirmation_prompt: bool=…, hide_input: bool=…, is_flag: Optional[bool]=…, flag_value: Opt…
- changed:
function get_params_from_function(func: Callable) -> Dict[str, ParamMeta] → function get_params_from_function(func: Callable[..., Any]) -> Dict[str, ParamMeta]