Rename multiple_separator to separator.

Author: libklein

docs/tutorial/multiple-values/multiple-options.md

@@ -91,7 +91,7 @@ The sum is 9.5
 ## Passing multiple values in a single argument
 
 Many users expect to be able to pass multiple arguments with a single .
-**Typer** supports this with the `multiple_separator` option for `typing.List[T]` types:
+**Typer** supports this with the `separator` option for `typing.List[T]` types:
 
 === "Python 3.7+"
 

docs_src/multiple_values/multiple_options/tutorial003.py

@@ -3,7 +3,7 @@
 import typer
 
 
-def main(number: List[float] = typer.Option([], multiple_separator=",")):
+def main(number: List[float] = typer.Option([], separator=",")):
     print(f"The sum is {sum(number)}")
 
 

docs_src/multiple_values/multiple_options/tutorial003_an.py

@@ -4,7 +4,7 @@
 from typing_extensions import Annotated
 
 
-def main(number: Annotated[List[float], typer.Option(multiple_separator=",")] = []):
+def main(number: Annotated[List[float], typer.Option(separator=",")] = []):
     print(f"The sum is {sum(number)}")
 
 

tests/test_others.py

@@ -262,10 +262,10 @@ def test_multiple_options_separator_1_unsupported_separator():
     app = typer.Typer()
 
     @app.command()
-    def main(names: typing.List[str] = typer.Option(..., multiple_separator="\t \n")):
+    def main(names: typing.List[str] = typer.Option(..., separator="\t \n")):
         pass  # pragma: no cover
 
-    with pytest.raises(typer.UnsupportedMultipleSeparatorError) as exc_info:
+    with pytest.raises(typer.UnsupportedSeparatorError) as exc_info:
         runner.invoke(app, [])
     assert (
         str(exc_info.value)
@@ -277,10 +277,10 @@ def test_multiple_options_separator_2_non_list_type():
     app = typer.Typer()
 
     @app.command()
-    def main(names: str = typer.Option(..., multiple_separator=",")):
+    def main(names: str = typer.Option(..., separator=",")):
         pass  # pragma: no cover
 
-    with pytest.raises(typer.MultipleSeparatorForNonListTypeError) as exc_info:
+    with pytest.raises(typer.SeparatorForNonListTypeError) as exc_info:
         runner.invoke(app, [])
     assert (
         str(exc_info.value)

typer/__init__.py

@@ -38,8 +38,8 @@
 from .params import Argument as Argument
 from .params import Option as Option
 from .utils import (
-    MultipleSeparatorForNonListTypeError as MultipleSeparatorForNonListTypeError,
+    SeparatorForNonListTypeError as SeparatorForNonListTypeError,
 )
 from .utils import (
-    UnsupportedMultipleSeparatorError as UnsupportedMultipleSeparatorError,
+    UnsupportedSeparatorError as UnsupportedSeparatorError,
 )

typer/core.py

@@ -421,7 +421,7 @@ def __init__(
         show_envvar: bool = False,
         # Rich settings
         rich_help_panel: Union[str, None] = None,
-        multiple_separator: Optional[str] = None,
+        separator: Optional[str] = None,
     ):
         super().__init__(
             param_decls=param_decls,
@@ -453,16 +453,16 @@ def __init__(
         _typer_param_setup_autocompletion_compat(self, autocompletion=autocompletion)
         self.rich_help_panel = rich_help_panel
         self.original_type = type
-        self.multiple_separator = multiple_separator
+        self.separator = separator
 
     def _parse_separated_parameter_list(self, parameter_values: List[str]) -> List[str]:
         values = []
         for param_str_list in parameter_values:
-            values.extend(param_str_list.split(self.multiple_separator))
+            values.extend(param_str_list.split(self.separator))
         return values
 
     def process_value(self, ctx: Context, value: t.Any) -> t.Any:
-        if self.multiple_separator is not None:
+        if self.separator is not None:
             value = self._parse_separated_parameter_list(value)
         return super().process_value(ctx, value)
 

typer/main.py

@@ -35,8 +35,8 @@
     TyperInfo,
 )
 from .utils import (
-    MultipleSeparatorForNonListTypeError,
-    UnsupportedMultipleSeparatorError,
+    SeparatorForNonListTypeError,
+    UnsupportedSeparatorError,
     get_params_from_function,
 )
 
@@ -890,17 +890,15 @@ def get_click_param(
             param_decls.append(default_option_declaration)
 
         # Check the multiple separator option for validity
-        multiple_separator = None
-        if parameter_info.multiple_separator:
-            multiple_separator = parameter_info.multiple_separator.strip()
+        separator = None
+        if parameter_info.separator:
+            separator = parameter_info.separator.strip()
 
             if not is_list:
-                raise MultipleSeparatorForNonListTypeError(param.name, main_type)
+                raise SeparatorForNonListTypeError(param.name, main_type)
 
-            if len(multiple_separator) != 1:
-                raise UnsupportedMultipleSeparatorError(
-                    param.name, parameter_info.multiple_separator
-                )
+            if len(separator) != 1:
+                raise UnsupportedSeparatorError(param.name, parameter_info.separator)
 
         return (
             TyperOption(
@@ -935,7 +933,7 @@ def get_click_param(
                 autocompletion=get_param_completion(parameter_info.autocompletion),
                 # Rich settings
                 rich_help_panel=parameter_info.rich_help_panel,
-                multiple_separator=multiple_separator,
+                separator=separator,
             ),
             convertor,
         )

typer/models.py

@@ -331,7 +331,7 @@ def __init__(
         path_type: Union[None, Type[str], Type[bytes]] = None,
         # Rich settings
         rich_help_panel: Union[str, None] = None,
-        multiple_separator: Optional[str] = None,
+        separator: Optional[str] = None,
     ):
         super().__init__(
             default=default,
@@ -387,7 +387,7 @@ def __init__(
         self.flag_value = flag_value
         self.count = count
         self.allow_from_autoenv = allow_from_autoenv
-        self.multiple_separator = multiple_separator
+        self.separator = separator
 
 
 class ArgumentInfo(ParameterInfo):

typer/params.py

@@ -196,7 +196,7 @@ def Option(
     # Rich settings
     rich_help_panel: Union[str, None] = None,
     # Multiple values
-    multiple_separator: Optional[str] = None,
+    separator: Optional[str] = None,
 ) -> Any:
     return OptionInfo(
         # Parameter
@@ -252,7 +252,7 @@ def Option(
         path_type=path_type,
         # Rich settings
         rich_help_panel=rich_help_panel,
-        multiple_separator=multiple_separator,
+        separator=separator,
     )
 
 

typer/utils.py

@@ -192,7 +192,7 @@ def get_params_from_function(func: Callable[..., Any]) -> Dict[str, ParamMeta]:
     return params
 
 
-class MultipleSeparatorForNonListTypeError(Exception):
+class SeparatorForNonListTypeError(Exception):
     argument_name: str
     argument_type: Type[Any]
 
@@ -204,7 +204,7 @@ def __str__(self) -> str:
         return f"Multiple values are supported for List[T] types only. Annotate {self.argument_name!r} as List[{self.argument_type.__name__}] to support multiple values."
 
 
-class UnsupportedMultipleSeparatorError(Exception):
+class UnsupportedSeparatorError(Exception):
     argument_name: str
     separator: str