Skip to content

Commit ed7c0cb

Browse files
author
Kevin Kirsche
committed
Fix a few typos
1 parent cc6623c commit ed7c0cb

File tree

4 files changed

+40
-40
lines changed

4 files changed

+40
-40
lines changed

docs/help-typer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Here's what to have in mind and how to review a pull request:
147147

148148
* Don't worry too much about things like commit message styles, I will squash and merge customizing the commit manually.
149149

150-
* Also don't worry about style rules, there are already automatized tools checking that.
150+
* Also don't worry about style rules, there are already automated tools checking that.
151151

152152
And if there's any other style or consistency need, I'll ask directly for that, or I'll add commits on top with the needed changes.
153153

docs/tutorial/options/required.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The same way as with `typer.Argument()`, the old style of using the function par
3131

3232
////
3333

34-
Or you can explictily pass `...` to `typer.Option(default=...)`:
34+
Or you can explicitly pass `...` to `typer.Option(default=...)`:
3535

3636
//// tab | Python 3.7+ non-Annotated
3737

tests/test_tutorial/test_subcommands/test_tutorial003.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def test_items_create(app):
4949
result = runner.invoke(app, ["items", "create", "Wand"])
5050
assert result.exit_code == 0
5151
assert "Creating item: Wand" in result.output
52-
# For coverage, becauses the monkeypatch above sometimes confuses coverage
52+
# For coverage, because the monkeypatch above sometimes confuses coverage
5353
result = runner.invoke(items.app, ["create", "Wand"])
5454
assert result.exit_code == 0
5555
assert "Creating item: Wand" in result.output
@@ -59,7 +59,7 @@ def test_items_sell(app):
5959
result = runner.invoke(app, ["items", "sell", "Vase"])
6060
assert result.exit_code == 0
6161
assert "Selling item: Vase" in result.output
62-
# For coverage, becauses the monkeypatch above sometimes confuses coverage
62+
# For coverage, because the monkeypatch above sometimes confuses coverage
6363
result = runner.invoke(items.app, ["sell", "Vase"])
6464
assert result.exit_code == 0
6565
assert "Selling item: Vase" in result.output
@@ -69,7 +69,7 @@ def test_items_delete(app):
6969
result = runner.invoke(app, ["items", "delete", "Vase"])
7070
assert result.exit_code == 0
7171
assert "Deleting item: Vase" in result.output
72-
# For coverage, becauses the monkeypatch above sometimes confuses coverage
72+
# For coverage, because the monkeypatch above sometimes confuses coverage
7373
result = runner.invoke(items.app, ["delete", "Vase"])
7474
assert result.exit_code == 0
7575
assert "Deleting item: Vase" in result.output
@@ -89,7 +89,7 @@ def test_users_create(app):
8989
result = runner.invoke(app, ["users", "create", "Camila"])
9090
assert result.exit_code == 0
9191
assert "Creating user: Camila" in result.output
92-
# For coverage, becauses the monkeypatch above sometimes confuses coverage
92+
# For coverage, because the monkeypatch above sometimes confuses coverage
9393
result = runner.invoke(users.app, ["create", "Camila"])
9494
assert result.exit_code == 0
9595
assert "Creating user: Camila" in result.output
@@ -99,7 +99,7 @@ def test_users_delete(app):
9999
result = runner.invoke(app, ["users", "delete", "Camila"])
100100
assert result.exit_code == 0
101101
assert "Deleting user: Camila" in result.output
102-
# For coverage, becauses the monkeypatch above sometimes confuses coverage
102+
# For coverage, because the monkeypatch above sometimes confuses coverage
103103
result = runner.invoke(users.app, ["delete", "Camila"])
104104
assert result.exit_code == 0
105105
assert "Deleting user: Camila" in result.output

typer/main.py

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ def get_group_from_info(
512512
solved_info = solve_typer_info_defaults(group_info)
513513
(
514514
params,
515-
convertors,
515+
converters,
516516
context_param_name,
517517
) = get_params_convertors_ctx_param_name_from_function(solved_info.callback)
518518
cls = solved_info.cls or TyperGroup
@@ -529,7 +529,7 @@ def get_group_from_info(
529529
callback=get_callback(
530530
callback=solved_info.callback,
531531
params=params,
532-
convertors=convertors,
532+
converters=converters,
533533
context_param_name=context_param_name,
534534
pretty_exceptions_short=pretty_exceptions_short,
535535
),
@@ -556,19 +556,19 @@ def get_params_convertors_ctx_param_name_from_function(
556556
callback: Optional[Callable[..., Any]],
557557
) -> Tuple[List[Union[click.Argument, click.Option]], Dict[str, Any], Optional[str]]:
558558
params = []
559-
convertors = {}
559+
converters = {}
560560
context_param_name = None
561561
if callback:
562562
parameters = get_params_from_function(callback)
563563
for param_name, param in parameters.items():
564564
if lenient_issubclass(param.annotation, click.Context):
565565
context_param_name = param_name
566566
continue
567-
click_param, convertor = get_click_param(param)
568-
if convertor:
569-
convertors[param_name] = convertor
567+
click_param, converter = get_click_param(param)
568+
if converter:
569+
converters[param_name] = converter
570570
params.append(click_param)
571-
return params, convertors, context_param_name
571+
return params, converters, context_param_name
572572

573573

574574
def get_command_from_info(
@@ -586,7 +586,7 @@ def get_command_from_info(
586586
use_help = inspect.cleandoc(use_help)
587587
(
588588
params,
589-
convertors,
589+
converters,
590590
context_param_name,
591591
) = get_params_convertors_ctx_param_name_from_function(command_info.callback)
592592
cls = command_info.cls or TyperCommand
@@ -596,7 +596,7 @@ def get_command_from_info(
596596
callback=get_callback(
597597
callback=command_info.callback,
598598
params=params,
599-
convertors=convertors,
599+
converters=converters,
600600
context_param_name=context_param_name,
601601
pretty_exceptions_short=pretty_exceptions_short,
602602
),
@@ -617,12 +617,12 @@ def get_command_from_info(
617617

618618

619619
def determine_type_convertor(type_: Any) -> Optional[Callable[[Any], Any]]:
620-
convertor: Optional[Callable[[Any], Any]] = None
620+
converter: Optional[Callable[[Any], Any]] = None
621621
if lenient_issubclass(type_, Path):
622-
convertor = param_path_convertor
622+
converter = param_path_convertor
623623
if lenient_issubclass(type_, Enum):
624-
convertor = generate_enum_convertor(type_)
625-
return convertor
624+
converter = generate_enum_convertor(type_)
625+
return converter
626626

627627

628628
def param_path_convertor(value: Optional[str] = None) -> Optional[Path]:
@@ -634,40 +634,40 @@ def param_path_convertor(value: Optional[str] = None) -> Optional[Path]:
634634
def generate_enum_convertor(enum: Type[Enum]) -> Callable[[Any], Any]:
635635
val_map = {str(val.value): val for val in enum}
636636

637-
def convertor(value: Any) -> Any:
637+
def converter(value: Any) -> Any:
638638
if value is not None:
639639
val = str(value)
640640
if val in val_map:
641641
key = val_map[val]
642642
return enum(key)
643643

644-
return convertor
644+
return converter
645645

646646

647647
def generate_list_convertor(
648-
convertor: Optional[Callable[[Any], Any]], default_value: Optional[Any]
648+
converter: Optional[Callable[[Any], Any]], default_value: Optional[Any]
649649
) -> Callable[[Sequence[Any]], Optional[List[Any]]]:
650650
def internal_convertor(value: Sequence[Any]) -> Optional[List[Any]]:
651651
if default_value is None and len(value) == 0:
652652
return None
653-
return [convertor(v) if convertor else v for v in value]
653+
return [converter(v) if converter else v for v in value]
654654

655655
return internal_convertor
656656

657657

658658
def generate_tuple_convertor(
659659
types: Sequence[Any],
660660
) -> Callable[[Optional[Tuple[Any, ...]]], Optional[Tuple[Any, ...]]]:
661-
convertors = [determine_type_convertor(type_) for type_ in types]
661+
converters = [determine_type_convertor(type_) for type_ in types]
662662

663663
def internal_convertor(
664664
param_args: Optional[Tuple[Any, ...]],
665665
) -> Optional[Tuple[Any, ...]]:
666666
if param_args is None:
667667
return None
668668
return tuple(
669-
convertor(arg) if convertor else arg
670-
for (convertor, arg) in zip(convertors, param_args)
669+
converter(arg) if converter else arg
670+
for (converter, arg) in zip(converters, param_args)
671671
)
672672

673673
return internal_convertor
@@ -677,11 +677,11 @@ def get_callback(
677677
*,
678678
callback: Optional[Callable[..., Any]] = None,
679679
params: Sequence[click.Parameter] = [],
680-
convertors: Optional[Dict[str, Callable[[str], Any]]] = None,
680+
converters: Optional[Dict[str, Callable[[str], Any]]] = None,
681681
context_param_name: Optional[str] = None,
682682
pretty_exceptions_short: bool,
683683
) -> Optional[Callable[..., Any]]:
684-
use_convertors = convertors or {}
684+
use_convertors = converters or {}
685685
if not callback:
686686
return None
687687
parameters = get_params_from_function(callback)
@@ -872,13 +872,13 @@ def get_click_param(
872872
parameter_type = get_click_type(
873873
annotation=main_type, parameter_info=parameter_info
874874
)
875-
convertor = determine_type_convertor(main_type)
875+
converter = determine_type_convertor(main_type)
876876
if is_list:
877-
convertor = generate_list_convertor(
878-
convertor=convertor, default_value=default_value
877+
converter = generate_list_convertor(
878+
converter=converter, default_value=default_value
879879
)
880880
if is_tuple:
881-
convertor = generate_tuple_convertor(get_args(main_type))
881+
converter = generate_tuple_convertor(get_args(main_type))
882882
if isinstance(parameter_info, OptionInfo):
883883
if main_type is bool and parameter_info.is_flag is not False:
884884
is_flag = True
@@ -920,7 +920,7 @@ def get_click_param(
920920
required=required,
921921
default=default_value,
922922
callback=get_param_callback(
923-
callback=parameter_info.callback, convertor=convertor
923+
callback=parameter_info.callback, converter=converter
924924
),
925925
metavar=parameter_info.metavar,
926926
expose_value=parameter_info.expose_value,
@@ -931,7 +931,7 @@ def get_click_param(
931931
# Rich settings
932932
rich_help_panel=parameter_info.rich_help_panel,
933933
),
934-
convertor,
934+
converter,
935935
)
936936
elif isinstance(parameter_info, ArgumentInfo):
937937
param_decls = [param.name]
@@ -954,7 +954,7 @@ def get_click_param(
954954
# Parameter
955955
default=default_value,
956956
callback=get_param_callback(
957-
callback=parameter_info.callback, convertor=convertor
957+
callback=parameter_info.callback, converter=converter
958958
),
959959
metavar=parameter_info.metavar,
960960
expose_value=parameter_info.expose_value,
@@ -965,15 +965,15 @@ def get_click_param(
965965
# Rich settings
966966
rich_help_panel=parameter_info.rich_help_panel,
967967
),
968-
convertor,
968+
converter,
969969
)
970970
raise AssertionError("A click.Parameter should be returned") # pragma: no cover
971971

972972

973973
def get_param_callback(
974974
*,
975975
callback: Optional[Callable[..., Any]] = None,
976-
convertor: Optional[Callable[..., Any]] = None,
976+
converter: Optional[Callable[..., Any]] = None,
977977
) -> Optional[Callable[..., Any]]:
978978
if not callback:
979979
return None
@@ -1011,8 +1011,8 @@ def wrapper(ctx: click.Context, param: click.Parameter, value: Any) -> Any:
10111011
if click_param_name:
10121012
use_params[click_param_name] = param
10131013
if value_name:
1014-
if convertor:
1015-
use_value = convertor(value)
1014+
if converter:
1015+
use_value = converter(value)
10161016
else:
10171017
use_value = value
10181018
use_params[value_name] = use_value

0 commit comments

Comments
 (0)