Add missing type hints - Part 1

pyproject.toml

@@ -64,6 +64,7 @@ pytest-sugar = "^0.9"
 httpretty = "^1.0"
 zipp = { version = "^3.4", python = "<3.8"}
 deepdiff = "^5.0"
+typing-extensions = {version = "^4.0.0", python = "<3.8"}
 
 [tool.poetry.scripts]
 poetry = "poetry.console.application:main"

src/poetry/plugins/application_plugin.py

@@ -1,12 +1,18 @@
+from typing import TYPE_CHECKING
+
 from poetry.plugins.base_plugin import BasePlugin
 
 
+if TYPE_CHECKING:
+    from poetry.console.application import Application
+
+
 class ApplicationPlugin(BasePlugin):
     """
     Base class for plugins.
     """
 
     type = "application.plugin"
 
-    def activate(self, application):
+    def activate(self, application: "Application") -> None:
         raise NotImplementedError()

src/poetry/plugins/plugin.py

@@ -1,6 +1,14 @@
+from typing import TYPE_CHECKING
+
 from poetry.plugins.base_plugin import BasePlugin
 
 
+if TYPE_CHECKING:
+    from cleo.io.io import IO
+
+    from poetry.poetry import Poetry
+
+
 class Plugin(BasePlugin):
     """
     Generic plugin not related to the console application.
@@ -10,5 +18,5 @@ class Plugin(BasePlugin):
 
     type = "plugin"
 
-    def activate(self, poetry, io):
+    def activate(self, poetry: "Poetry", io: "IO") -> None:
         raise NotImplementedError()

src/poetry/plugins/plugin_manager.py

@@ -1,5 +1,6 @@
 import logging
 
+from typing import Any
 from typing import List
 
 import entrypoints
@@ -41,7 +42,7 @@ def add_plugin(self, plugin: Plugin) -> None:
 
         self._plugins.append(plugin)
 
-    def activate(self, *args, **kwargs):
+    def activate(self, *args: Any, **kwargs: Any) -> None:
         for plugin in self._plugins:
             plugin.activate(*args, **kwargs)
 

src/poetry/utils/_compat.py

@@ -1,5 +1,8 @@
 import sys
 
+from typing import List
+from typing import Optional
+
 
 try:
     from importlib import metadata
@@ -10,7 +13,7 @@
 WINDOWS = sys.platform == "win32"
 
 
-def decode(string, encodings=None):
+def decode(string: str, encodings: Optional[List[str]] = None) -> str:
     if not isinstance(string, bytes):
         return string
 
@@ -25,7 +28,7 @@ def decode(string, encodings=None):
     return string.decode(encodings[0], errors="ignore")
 
 
-def encode(string, encodings=None):
+def encode(string: str, encodings: Optional[List[str]] = None) -> bytes:
     if isinstance(string, bytes):
         return string
 
@@ -40,11 +43,11 @@ def encode(string, encodings=None):
     return string.encode(encodings[0], errors="ignore")
 
 
-def to_str(string):
+def to_str(string: str) -> str:
     return decode(string)
 
 
-def list_to_shell_command(cmd):
+def list_to_shell_command(cmd: List[str]) -> str:
     return " ".join(
         f'"{token}"' if " " in token and token[0] not in {"'", '"'} else token
         for token in cmd

src/poetry/utils/env.py

@@ -1168,7 +1168,7 @@ def find_executables(self) -> None:
 
             self._pip_executable = pip_executable
 
-    def get_embedded_wheel(self, distribution):
+    def get_embedded_wheel(self, distribution: str) -> Path:
         return get_embed_wheel(
             distribution, f"{self.version_info[0]}.{self.version_info[1]}"
         ).path
@@ -1785,7 +1785,7 @@ def _bin(self, bin: str) -> str:
 
 @contextmanager
 def ephemeral_environment(
-    executable=None,
+    executable: Optional[Union[str, Path]] = None,
     flags: Dict[str, bool] = None,
     with_pip: bool = False,
     with_wheel: Optional[bool] = None,

tests/compat.py

@@ -2,3 +2,8 @@
     import zipp
 except ImportError:
     import zipfile as zipp  # noqa: F401, TC002
+
+try:
+    from typing import Protocol
+except ImportError:
+    from typing_extensions import Protocol  # noqa: F401, TC002

tests/config/test_config.py

@@ -1,12 +1,23 @@
 import os
 import re
 
+from typing import TYPE_CHECKING
+from typing import Any
+from typing import Dict
+from typing import Iterator
+from typing import Optional
+from typing import Tuple
+
 import pytest
 
 from poetry.config.config import Config
 
 
-def get_boolean_options(config=None):
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+def get_boolean_options(config: Optional[Dict[str, Any]] = None) -> str:
     if config is None:
         config = Config.default_config
 
@@ -21,27 +32,34 @@ def get_boolean_options(config=None):
 @pytest.mark.parametrize(
     ("name", "value"), [("installer.parallel", True), ("virtualenvs.create", True)]
 )
-def test_config_get_default_value(config, name, value):
+def test_config_get_default_value(config: Config, name: str, value: bool):
     assert config.get(name) is value
 
 
-def test_config_get_processes_depended_on_values(config, config_cache_dir):
+def test_config_get_processes_depended_on_values(
+    config: Config, config_cache_dir: "Path"
+):
     assert str(config_cache_dir / "virtualenvs") == config.get("virtualenvs.path")
 
 
-def generate_environment_variable_tests():
+def generate_environment_variable_tests() -> Iterator[Tuple[str, str, str, bool]]:
     for env_value, value in [("true", True), ("false", False)]:
         for name in get_boolean_options():
             env_var = "POETRY_{}".format(re.sub("[.-]+", "_", name).upper())
-            yield (name, env_var, env_value, value)
+            yield name, env_var, env_value, value
 
 
 @pytest.mark.parametrize(
     ("name", "env_var", "env_value", "value"),
     list(generate_environment_variable_tests()),
 )
 def test_config_get_from_environment_variable(
-    config, environ, name, env_var, env_value, value
+    config: Config,
+    environ: Iterator[None],
+    name: str,
+    env_var: str,
+    env_value: str,
+    value: bool,
 ):
     os.environ[env_var] = env_value
     assert config.get(name) is value