Skip to content

Change envvar type from list[str] to Sequence[str] #1610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thakoreh wants to merge 4 commits into
base: master
Choose a base branch
from
+12 −12
Open

Change envvar type from list[str] to Sequence[str] #1610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac4a6c0
Change envvar type from list[str] to Sequence[str]
thakoreh Feb 24, 2026
1514fb3
Fix mypy error: update implementation type annotations for envvar
thakoreh Feb 24, 2026
e5eb792
Fix mypy: update OptionInfo and ArgumentInfo envvar types
thakoreh Feb 24, 2026
ce75516
Fix mypy: update TyperOption and TyperArgument envvar types
thakoreh Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions typer/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ def __init__(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -413,7 +413,7 @@ def __init__(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down
6 changes: 3 additions & 3 deletions typer/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def __init__(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -391,7 +391,7 @@ def __init__(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -519,7 +519,7 @@ def __init__(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down
14 changes: 7 additions & 7 deletions typer/params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Callable
from collections.abc import Callable, Sequence
from typing import TYPE_CHECKING, Annotated, Any, overload

import click
Expand All @@ -20,7 +20,7 @@ def Option(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -85,7 +85,7 @@ def Option(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -246,7 +246,7 @@ def main(user: Annotated[str, typer.Option(metavar="User name")]):
),
] = False,
envvar: Annotated[
str | list[str] | None,
str | Sequence[str] | None,
Doc(
"""
Configure a CLI Option to read its value from an environment variable if it is not provided in the command line.
Expand Down Expand Up @@ -1010,7 +1010,7 @@ def Argument(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -1066,7 +1066,7 @@ def Argument(
metavar: str | None = None,
expose_value: bool = True,
is_eager: bool = False,
envvar: str | list[str] | None = None,
envvar: str | Sequence[str] | None = None,
# Note that shell_complete is not fully supported and will be removed in future versions
# TODO: Remove shell_complete in a future version (after 0.16.0)
shell_complete: Callable[
Expand Down Expand Up @@ -1200,7 +1200,7 @@ def main(name: Annotated[str, typer.Argument(metavar="✨username✨")]):
),
] = False,
envvar: Annotated[
str | list[str] | None,
str | Sequence[str] | None,
Doc(
"""
Configure an argument to read a value from an environment variable if it is not provided in the command line as a CLI argument.
Expand Down
Loading