Skip to content

Commit 5d13465

Browse files
tiangolotiangolo
committed
💡 Add extra TODO comments to remind us in the future to remove shell_complete
1 parent 37cbc85 commit 5d13465

3 files changed

Lines changed: 11 additions & 0 deletions

File tree

‎typer/core.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,7 @@ def __init__(
269269
is_eager: bool = False,
270270
envvar: Optional[Union[str, List[str]]] = None,
271271
# Note that shell_complete is not fully supported and will be removed in future versions
272+
# TODO: Remove shell_complete in a future version (after 0.16.0)
272273
shell_complete: Optional[
273274
Callable[
274275
[click.Context, click.Parameter, str],
@@ -409,6 +410,7 @@ def __init__(
409410
is_eager: bool = False,
410411
envvar: Optional[Union[str, List[str]]] = None,
411412
# Note that shell_complete is not fully supported and will be removed in future versions
413+
# TODO: Remove shell_complete in a future version (after 0.16.0)
412414
shell_complete: Optional[
413415
Callable[
414416
[click.Context, click.Parameter, str],

‎typer/models.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ def __init__(
174174
is_eager: bool = False,
175175
envvar: Optional[Union[str, List[str]]] = None,
176176
# Note that shell_complete is not fully supported and will be removed in future versions
177+
# TODO: Remove shell_complete in a future version (after 0.16.0)
177178
shell_complete: Optional[
178179
Callable[
179180
[click.Context, click.Parameter, str],
@@ -283,6 +284,7 @@ def __init__(
283284
is_eager: bool = False,
284285
envvar: Optional[Union[str, List[str]]] = None,
285286
# Note that shell_complete is not fully supported and will be removed in future versions
287+
# TODO: Remove shell_complete in a future version (after 0.16.0)
286288
shell_complete: Optional[
287289
Callable[
288290
[click.Context, click.Parameter, str],
@@ -411,6 +413,7 @@ def __init__(
411413
is_eager: bool = False,
412414
envvar: Optional[Union[str, List[str]]] = None,
413415
# Note that shell_complete is not fully supported and will be removed in future versions
416+
# TODO: Remove shell_complete in a future version (after 0.16.0)
414417
shell_complete: Optional[
415418
Callable[
416419
[click.Context, click.Parameter, str],

‎typer/params.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ def Option(
2020
is_eager: bool = False,
2121
envvar: Optional[Union[str, List[str]]] = None,
2222
# Note that shell_complete is not fully supported and will be removed in future versions
23+
# TODO: Remove shell_complete in a future version (after 0.16.0)
2324
shell_complete: Optional[
2425
Callable[
2526
[click.Context, click.Parameter, str],
@@ -85,6 +86,7 @@ def Option(
8586
is_eager: bool = False,
8687
envvar: Optional[Union[str, List[str]]] = None,
8788
# Note that shell_complete is not fully supported and will be removed in future versions
89+
# TODO: Remove shell_complete in a future version (after 0.16.0)
8890
shell_complete: Optional[
8991
Callable[
9092
[click.Context, click.Parameter, str],
@@ -148,6 +150,7 @@ def Option(
148150
is_eager: bool = False,
149151
envvar: Optional[Union[str, List[str]]] = None,
150152
# Note that shell_complete is not fully supported and will be removed in future versions
153+
# TODO: Remove shell_complete in a future version (after 0.16.0)
151154
shell_complete: Optional[
152155
Callable[
153156
[click.Context, click.Parameter, str],
@@ -269,6 +272,7 @@ def Argument(
269272
is_eager: bool = False,
270273
envvar: Optional[Union[str, List[str]]] = None,
271274
# Note that shell_complete is not fully supported and will be removed in future versions
275+
# TODO: Remove shell_complete in a future version (after 0.16.0)
272276
shell_complete: Optional[
273277
Callable[
274278
[click.Context, click.Parameter, str],
@@ -325,6 +329,7 @@ def Argument(
325329
is_eager: bool = False,
326330
envvar: Optional[Union[str, List[str]]] = None,
327331
# Note that shell_complete is not fully supported and will be removed in future versions
332+
# TODO: Remove shell_complete in a future version (after 0.16.0)
328333
shell_complete: Optional[
329334
Callable[
330335
[click.Context, click.Parameter, str],
@@ -379,6 +384,7 @@ def Argument(
379384
is_eager: bool = False,
380385
envvar: Optional[Union[str, List[str]]] = None,
381386
# Note that shell_complete is not fully supported and will be removed in future versions
387+
# TODO: Remove shell_complete in a future version (after 0.16.0)
382388
shell_complete: Optional[
383389
Callable[
384390
[click.Context, click.Parameter, str],

0 commit comments

Comments
 (0)