Add type hints for twisted.application.twist._twist

debugmm · Sep 30, 2020 · bed789a · bed789a
1 parent 406861a
commit bed789a
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 31 deletions.
diff --git a/mypy.ini b/mypy.ini
@@ -52,9 +52,6 @@ check_untyped_defs = False
 [mypy-twisted.application.test.test_service]
 allow_untyped_defs = True
 
-[mypy-twisted.application.twist._twist]
-allow_untyped_defs = True
-
 [mypy-twisted.application.twist.test.test_options]
 allow_untyped_defs = True
 check_untyped_defs = False

diff --git a/src/twisted/application/twist/_options.py b/src/twisted/application/twist/_options.py
@@ -8,7 +8,16 @@
 
 from sys import stdout, stderr
 from textwrap import dedent
-from typing import Callable, Iterable, List, Mapping, NoReturn, Optional, Tuple, cast
+from typing import (
+    Callable,
+    Iterable,
+    Mapping,
+    NoReturn,
+    Optional,
+    Sequence,
+    Tuple,
+    cast,
+)
 
 from twisted.copyright import version
 from twisted.internet.interfaces import IReactorCore
@@ -152,7 +161,7 @@ def selectDefaultLogObserver(self) -> None:
                 self["fileLogObserverFactory"] = jsonFileLogObserver
                 self["logFormat"] = "json"
 
-    def parseOptions(self, options: Optional[List[str]] = None) -> None:
+    def parseOptions(self, options: Optional[Sequence[str]] = None) -> None:
         self.selectDefaultLogObserver()
 
         Options.parseOptions(self, options=options)
@@ -161,14 +170,14 @@ def parseOptions(self, options: Optional[List[str]] = None) -> None:
             self["reactor"] = self.installReactor(self["reactorName"])
 
     @property
-    def plugins(self) -> Mapping[str, IServiceMaker]:
+    def plugins(self) -> Mapping[Optional[str], IServiceMaker]:
         if "plugins" not in self:
             plugins = {}
             for plugin in getPlugins(IServiceMaker):
                 plugins[plugin.tapname] = plugin
             self["plugins"] = plugins
 
-        return cast(Mapping[str, IServiceMaker], self["plugins"])
+        return cast(Mapping[Optional[str], IServiceMaker], self["plugins"])
 
     @property
     def subCommands(

diff --git a/src/twisted/application/twist/_twist.py b/src/twisted/application/twist/_twist.py
@@ -7,14 +7,16 @@
 """
 
 import sys
+from typing import Sequence
+
+from twisted.application.app import _exitWithSignal
+from twisted.internet.interfaces import _ISupportsExitSignalCapturing, IReactorCore
+from twisted.python.usage import Options, UsageError
 
-from twisted.python.usage import UsageError
-from ..service import Application, IService
 from ..runner._exit import exit, ExitStatus
 from ..runner._runner import Runner
+from ..service import Application, IService, IServiceMaker
 from ._options import TwistOptions
-from twisted.application.app import _exitWithSignal
-from twisted.internet.interfaces import _ISupportsExitSignalCapturing
 
 
 class Twist:
@@ -23,15 +25,12 @@ class Twist:
     """
 
     @staticmethod
-    def options(argv):
+    def options(argv: Sequence[str]) -> TwistOptions:
         """
         Parse command line options.
 
         @param argv: Command line arguments.
-        @type argv: L{list}
-
         @return: The parsed options.
-        @rtype: L{TwistOptions}
         """
         options = TwistOptions()
 
@@ -43,19 +42,14 @@ def options(argv):
         return options
 
     @staticmethod
-    def service(plugin, options):
+    def service(plugin: IServiceMaker, options: Options) -> IService:
         """
         Create the application service.
 
         @param plugin: The name of the plugin that implements the service
             application to run.
-        @type plugin: L{str}
-
         @param options: Options to pass to the application.
-        @type options: L{twisted.python.usage.Options}
-
         @return: The created application service.
-        @rtype: L{IService}
         """
         service = plugin.makeService(options)
         application = Application(plugin.tapname)
@@ -64,29 +58,25 @@ def service(plugin, options):
         return IService(application)
 
     @staticmethod
-    def startService(reactor, service):
+    def startService(reactor: IReactorCore, service: IService) -> None:
         """
         Start the application service.
 
         @param reactor: The reactor to run the service with.
-        @type reactor: L{twisted.internet.interfaces.IReactorCore}
-
         @param service: The application service to run.
-        @type service: L{IService}
         """
         service.startService()
 
         # Ask the reactor to stop the service before shutting down
         reactor.addSystemEventTrigger("before", "shutdown", service.stopService)
 
     @staticmethod
-    def run(twistOptions):
+    def run(twistOptions: TwistOptions) -> None:
         """
         Run the application service.
 
         @param twistOptions: Command line options to convert to runner
             arguments.
-        @type twistOptions: L{TwistOptions}
         """
         runner = Runner(
             reactor=twistOptions["reactor"],
@@ -101,7 +91,7 @@ def run(twistOptions):
                 _exitWithSignal(reactor._exitSignal)
 
     @classmethod
-    def main(cls, argv=sys.argv):
+    def main(cls, argv: Sequence[str] = sys.argv) -> None:
         """
         Executable entry point for L{Twist}.
         Processes options and run a twisted reactor with a service.

diff --git a/src/twisted/python/usage.py b/src/twisted/python/usage.py
@@ -149,9 +149,9 @@ class Options(dict):
     or doc/core/howto/options.xhtml in your Twisted directory.
     """
 
-    subCommand = None
-    defaultSubCommand = None
-    parent = None
+    subCommand = None  # type: Optional[str]
+    defaultSubCommand = None  # type: Optional[str]
+    parent = None  # type: Optional[Options]
     completionData = None
     _shellCompFile = sys.stdout  # file to use if shell completion is requested