Upgrading typer 0.3 to 0.4
Unknown0.3.2 → 0.4.2
Fetching 3 releases from GitHub…0 / 3
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
class Shells(str, Enum) - removed:
field Shells.bash - removed:
field Shells.fish - removed:
field Shells.powershell - removed:
field Shells.pwsh - removed:
field Shells.zsh - removed:
function do_bash_complete(cli: click.Command, prog_name: str) -> bool - removed:
function do_fish_complete(cli: click.Command, prog_name: str) -> bool - removed:
function do_powershell_complete(cli: click.Command, prog_name: str) -> bool - removed:
function do_shell_complete(*, cli: click.Command, prog_name: str, shell: str) -> bool - removed:
function do_zsh_complete(cli: click.Command, prog_name: str) -> bool - removed:
function get_completion_script(*, prog_name: str, complete_var: str, shell: str) -> str - removed:
function handle_shell_complete(cli: click.Command, prog_name: str, complete_var: str, complete_instr: str) -> bool - removed:
function install(shell: Optional[str]=…, prog_name: Optional[str]=…, complete_var: Optional[str]=…) -> Tuple[str, Path] - removed:
function install_bash(*, prog_name: str, complete_var: str, shell: str) -> Path - removed:
function install_fish(*, prog_name: str, complete_var: str, shell: str) -> Path - removed:
function install_powershell(*, prog_name: str, complete_var: str, shell: str) -> Path - removed:
function install_zsh(*, prog_name: str, complete_var: str, shell: str) -> Path - removed:
variable COMPLETION_SCRIPT_BASH - removed:
variable COMPLETION_SCRIPT_FISH - removed:
variable COMPLETION_SCRIPT_POWER_SHELL - removed:
variable COMPLETION_SCRIPT_ZSH - added:
function shell_complete(cli: click.BaseCommand, ctx_args: Dict[str, Any], prog_name: str, complete_var: str, instruction: str) -> int
- changed:
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… → 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shel… - added:
class TyperGroup(click.core.Group) - added:
class TyperOption(click.core.Option) - added:
constructor TyperOption(*, param_decls: List[str], type: Optional[Union[click.types.ParamType, 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter,… - added:
method TyperArgument.shell_complete(ctx: click.Context, incomplete: str) -> List[click.shell_completion.CompletionItem] - added:
method TyperGroup.format_options(ctx: click.Context, formatter: click.HelpFormatter) -> None - added:
method TyperOption.get_help_record(ctx: click.Context) -> Optional[Tuple[str, str]] - added:
method TyperOption.shell_complete(ctx: click.Context, incomplete: str) -> List[click.shell_completion.CompletionItem]
- removed:
function generate_iter_convertor(convertor: Callable[[Any], Any]) -> Callable[..., Any] - 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[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: O… → constructor Typer(*, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: 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: Optional[st… - changed:
function generate_enum_convertor(enum: Type[Enum]) -> Callable[..., Any] → function generate_enum_convertor(enum: Type[Enum]) -> 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[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…, epilog: Op… → method Typer.add_typer(typer_instance: Typer, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: 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… - 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[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, help: Optional[str]=…, epilog: Optional[str]=…, short_help: Optional[str]=…, options_metavar: str=…… → method Typer.callback(name: Optional[str]=…, *, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: 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=…, add_help… - added:
function determine_type_convertor(type_: Any) -> Optional[Callable[[Any], Any]] - added:
function generate_list_convertor(convertor: Optional[Callable[[Any], Any]]) -> Callable[[Sequence[Any]], List[Any]] - added:
function generate_tuple_convertor(types: Sequence[Any]) -> Callable[[Tuple[Any, ...]], Tuple[Any, ...]]
- changed:
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… → 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shell_completion.CompletionItem], List[str]]]]=…, autocompletion… - changed:
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:… → 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shell_completion.CompletionItem], List[str]]]]=…, autocompletion:… - changed:
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… → 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shell_completion.CompletionItem], List[str]]]]=…, autocompletio… - 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[..., Any]]=…, context_settings: Optional[Dict[Any, Any]]=…, callback: Optional[Callable[..., Any]]=…, help: Optional[str]=…,… → constructor TyperInfo(typer_instance: Optional[Typer]=…, *, name: Optional[str]=…, cls: Optional[Type[click.Command]]=…, invoke_without_command: bool=…, no_args_is_help: 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: O…
- changed:
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… → function Argument(default: Optional[Any], *, callback: Optional[Callable[..., Any]]=…, metavar: Optional[str]=…, expose_value: bool=…, is_eager: bool=…, envvar: Optional[Union[str, List[str]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shell_completion.CompletionItem], List[str]]]]=…, autocompletion: Optional[Callable[..., Any]]=…, show_default: U… - changed:
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… → 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]]]=…, shell_complete: Optional[Callable[[click.Context, click.Parameter, str], Union[List[click.shell_completion.CompletionItem], List[str]]]]=…, autocompletion: Optional[Callable[..., Any]]=…, s…