Automatically applied return type of None for functions/methods that don't return anything

Author: tleonhardt

examples/alias_startup.py

@@ -12,11 +12,11 @@
 class AliasAndStartup(cmd2.Cmd):
     """Example cmd2 application where we create commands that just print the arguments they are called with."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         alias_script = os.path.join(os.path.dirname(__file__), '.cmd2rc')
         super().__init__(startup_script=alias_script)
 
-    def do_nothing(self, args):
+    def do_nothing(self, args) -> None:
         """This command does nothing and produces no output."""
 
 

examples/arg_decorators.py

@@ -8,7 +8,7 @@
 
 
 class ArgparsingApp(cmd2.Cmd):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(include_ipy=True)
         self.intro = 'cmd2 has awesome decorators to make it easy to use Argparse to parse command arguments'
 

examples/arg_print.py

@@ -15,26 +15,26 @@
 class ArgumentAndOptionPrinter(cmd2.Cmd):
     """Example cmd2 application where we create commands that just print the arguments they are called with."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Create command shortcuts which are typically 1 character abbreviations which can be used in place of a command
         shortcuts = dict(cmd2.DEFAULT_SHORTCUTS)
         shortcuts.update({'$': 'aprint', '%': 'oprint'})
         super().__init__(shortcuts=shortcuts)
 
-    def do_aprint(self, statement):
+    def do_aprint(self, statement) -> None:
         """Print the argument string this basic command is called with."""
         self.poutput(f'aprint was called with argument: {statement!r}')
         self.poutput(f'statement.raw = {statement.raw!r}')
         self.poutput(f'statement.argv = {statement.argv!r}')
         self.poutput(f'statement.command = {statement.command!r}')
 
     @cmd2.with_argument_list
-    def do_lprint(self, arglist):
+    def do_lprint(self, arglist) -> None:
         """Print the argument list this basic command is called with."""
         self.poutput(f'lprint was called with the following list of arguments: {arglist!r}')
 
     @cmd2.with_argument_list(preserve_quotes=True)
-    def do_rprint(self, arglist):
+    def do_rprint(self, arglist) -> None:
         """Print the argument list this basic command is called with (with quotes preserved)."""
         self.poutput(f'rprint was called with the following list of arguments: {arglist!r}')
 
@@ -45,7 +45,7 @@ def do_rprint(self, arglist):
     oprint_parser.add_argument('words', nargs='+', help='words to print')
 
     @cmd2.with_argparser(oprint_parser)
-    def do_oprint(self, args):
+    def do_oprint(self, args) -> None:
         """Print the options and argument list this options command was called with."""
         self.poutput(f'oprint was called with the following\n\toptions: {args!r}')
 
@@ -55,7 +55,7 @@ def do_oprint(self, args):
     pprint_parser.add_argument('-r', '--repeat', type=int, help='output [n] times')
 
     @cmd2.with_argparser(pprint_parser, with_unknown_args=True)
-    def do_pprint(self, args, unknown):
+    def do_pprint(self, args, unknown) -> None:
         """Print the options and argument list this options command was called with."""
         self.poutput(f'oprint was called with the following\n\toptions: {args!r}\n\targuments: {unknown}')
 

examples/argparse_completion.py

@@ -19,7 +19,7 @@
 
 
 class ArgparseCompletion(Cmd):
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football', 'Space Ball']
 

examples/async_printing.py

@@ -68,7 +68,7 @@ def _postloop_hook(self) -> None:
         if self._alerter_thread.is_alive():
             self._alerter_thread.join()
 
-    def do_start_alerts(self, _):
+    def do_start_alerts(self, _) -> None:
         """Starts the alerter thread"""
         if self._alerter_thread.is_alive():
             print("The alert thread is already started")
@@ -77,7 +77,7 @@ def do_start_alerts(self, _):
             self._alerter_thread = threading.Thread(name='alerter', target=self._alerter_thread_func)
             self._alerter_thread.start()
 
-    def do_stop_alerts(self, _):
+    def do_stop_alerts(self, _) -> None:
         """Stops the alerter thread"""
         self._stop_event.set()
         if self._alerter_thread.is_alive():

examples/basic.py

@@ -19,7 +19,7 @@
 class BasicApp(cmd2.Cmd):
     CUSTOM_CATEGORY = 'My Custom Commands'
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(
             multiline_commands=['echo'],
             persistent_history_file='cmd2_history.dat',
@@ -36,12 +36,12 @@ def __init__(self):
         self.default_category = 'cmd2 Built-in Commands'
 
     @cmd2.with_category(CUSTOM_CATEGORY)
-    def do_intro(self, _):
+    def do_intro(self, _) -> None:
         """Display the intro banner"""
         self.poutput(self.intro)
 
     @cmd2.with_category(CUSTOM_CATEGORY)
-    def do_echo(self, arg):
+    def do_echo(self, arg) -> None:
         """Example of a multiline command"""
         self.poutput(arg)
 

examples/basic_completion.py

@@ -31,10 +31,10 @@
 
 
 class BasicCompletion(cmd2.Cmd):
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
 
-    def do_flag_based(self, statement: cmd2.Statement):
+    def do_flag_based(self, statement: cmd2.Statement) -> None:
         """Tab completes arguments based on a preceding flag using flag_based_complete
         -f, --food [completes food items]
         -s, --sport [completes sports]
@@ -58,7 +58,7 @@ def complete_flag_based(self, text, line, begidx, endidx) -> list[str]:
 
         return self.flag_based_complete(text, line, begidx, endidx, flag_dict=flag_dict)
 
-    def do_index_based(self, statement: cmd2.Statement):
+    def do_index_based(self, statement: cmd2.Statement) -> None:
         """Tab completes first 3 arguments using index_based_complete"""
         self.poutput(f"Args: {statement.args}")
 
@@ -72,14 +72,14 @@ def complete_index_based(self, text, line, begidx, endidx) -> list[str]:
 
         return self.index_based_complete(text, line, begidx, endidx, index_dict=index_dict)
 
-    def do_delimiter_complete(self, statement: cmd2.Statement):
+    def do_delimiter_complete(self, statement: cmd2.Statement) -> None:
         """Tab completes files from a list using delimiter_complete"""
         self.poutput(f"Args: {statement.args}")
 
     # Use a partialmethod to set arguments to delimiter_complete
     complete_delimiter_complete = functools.partialmethod(cmd2.Cmd.delimiter_complete, match_against=file_strs, delimiter='/')
 
-    def do_raise_error(self, statement: cmd2.Statement):
+    def do_raise_error(self, statement: cmd2.Statement) -> None:
         """Demonstrates effect of raising CompletionError"""
         self.poutput(f"Args: {statement.args}")
 

examples/cmd_as_argument.py

@@ -26,7 +26,7 @@ class CmdLineApp(cmd2.Cmd):
     MUMBLE_FIRST = ['so', 'like', 'well']
     MUMBLE_LAST = ['right?']
 
-    def __init__(self):
+    def __init__(self) -> None:
         shortcuts = dict(cmd2.DEFAULT_SHORTCUTS)
         shortcuts.update({'&': 'speak'})
         # Set include_ipy to True to enable the "ipy" command which runs an interactive IPython shell
@@ -44,7 +44,7 @@ def __init__(self):
     speak_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(speak_parser)
-    def do_speak(self, args):
+    def do_speak(self, args) -> None:
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -66,7 +66,7 @@ def do_speak(self, args):
     mumble_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(mumble_parser)
-    def do_mumble(self, args):
+    def do_mumble(self, args) -> None:
         """Mumbles what you tell me to."""
         repetitions = args.repeat or 1
         for i in range(min(repetitions, self.maxrepeats)):

examples/colors.py

@@ -36,7 +36,7 @@
 class CmdLineApp(cmd2.Cmd):
     """Example cmd2 application demonstrating colorized output."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Set include_ipy to True to enable the "ipy" command which runs an interactive IPython shell
         super().__init__(include_ipy=True)
 
@@ -58,7 +58,7 @@ def __init__(self):
     speak_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(speak_parser)
-    def do_speak(self, args):
+    def do_speak(self, args) -> None:
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -78,7 +78,7 @@ def do_speak(self, args):
             # .poutput handles newlines, and accommodates output redirection too
             self.poutput(output_str)
 
-    def do_timetravel(self, _):
+    def do_timetravel(self, _) -> None:
         """A command which always generates an error message, to demonstrate custom error colors"""
         self.perror('Mr. Fusion failed to start. Could not energize flux capacitor.')
 

examples/decorator_example.py

@@ -18,7 +18,7 @@
 class CmdLineApp(cmd2.Cmd):
     """Example cmd2 application."""
 
-    def __init__(self, ip_addr=None, port=None, transcript_files=None):
+    def __init__(self, ip_addr=None, port=None, transcript_files=None) -> None:
         shortcuts = dict(cmd2.DEFAULT_SHORTCUTS)
         shortcuts.update({'&': 'speak'})
         super().__init__(transcript_files=transcript_files, multiline_commands=['orate'], shortcuts=shortcuts)
@@ -41,7 +41,7 @@ def __init__(self, ip_addr=None, port=None, transcript_files=None):
     speak_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(speak_parser)
-    def do_speak(self, args: argparse.Namespace):
+    def do_speak(self, args: argparse.Namespace) -> None:
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -62,7 +62,7 @@ def do_speak(self, args: argparse.Namespace):
     tag_parser.add_argument('content', nargs='+', help='content to surround with tag')
 
     @cmd2.with_argparser(tag_parser)
-    def do_tag(self, args: argparse.Namespace):
+    def do_tag(self, args: argparse.Namespace) -> None:
         """create an html tag"""
         # The Namespace always includes the Statement object created when parsing the command line
         statement = args.cmd2_statement.get()
@@ -72,7 +72,7 @@ def do_tag(self, args: argparse.Namespace):
         self.poutput('<{0}>{1}</{0}>'.format(args.tag, ' '.join(args.content)))
 
     @cmd2.with_argument_list
-    def do_tagg(self, arglist: list[str]):
+    def do_tagg(self, arglist: list[str]) -> None:
         """version of creating an html tag using arglist instead of argparser"""
         if len(arglist) >= 2:
             tag = arglist[0]

examples/default_categories.py

@@ -20,10 +20,10 @@ class ChildInheritsParentCategories(MyBaseCommandSet):
     This subclass doesn't declare any categories so all commands here are also categorized under 'Default Category'
     """
 
-    def do_hello(self, _: cmd2.Statement):
+    def do_hello(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('Hello')
 
-    def do_world(self, _: cmd2.Statement):
+    def do_world(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('World')
 
 
@@ -34,7 +34,7 @@ class ChildOverridesParentCategoriesNonHeritable(MyBaseCommandSet):
     CommandSet will not inherit this category and will, instead, inherit 'Default Category'
     """
 
-    def do_goodbye(self, _: cmd2.Statement):
+    def do_goodbye(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('Goodbye')
 
 
@@ -44,7 +44,7 @@ class GrandchildInheritsGrandparentCategory(ChildOverridesParentCategoriesNonHer
     by the grandparent class.
     """
 
-    def do_aloha(self, _: cmd2.Statement):
+    def do_aloha(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('Aloha')
 
 
@@ -55,7 +55,7 @@ class ChildOverridesParentCategories(MyBaseCommandSet):
     category declaration.
     """
 
-    def do_bonjour(self, _: cmd2.Statement):
+    def do_bonjour(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('Bonjour')
 
 
@@ -65,7 +65,7 @@ class GrandchildInheritsHeritable(ChildOverridesParentCategories):
     CommandSet will be categorized under 'Heritable Category'
     """
 
-    def do_monde(self, _: cmd2.Statement):
+    def do_monde(self, _: cmd2.Statement) -> None:
         self._cmd.poutput('Monde')
 
 
@@ -74,10 +74,10 @@ class ExampleApp(cmd2.Cmd):
     Example to demonstrate heritable default categories
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
-    def do_something(self, arg):
+    def do_something(self, arg) -> None:
         self.poutput('this is the something command')
 
 

examples/dynamic_commands.py

@@ -16,7 +16,7 @@
 class CommandsInLoop(cmd2.Cmd):
     """Example of dynamically adding do_* commands."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Add dynamic commands before calling cmd2.Cmd's init since it validates command names
         for command in COMMAND_LIST:
             # Create command function and add help category to it
@@ -34,11 +34,11 @@ def __init__(self):
 
         super().__init__(include_ipy=True)
 
-    def send_text(self, args: cmd2.Statement, *, text: str):
+    def send_text(self, args: cmd2.Statement, *, text: str) -> None:
         """Simulate sending text to a server and printing the response."""
         self.poutput(text.capitalize())
 
-    def text_help(self, *, text: str):
+    def text_help(self, *, text: str) -> None:
         """Deal with printing help for the dynamically added commands."""
         self.poutput(f"Simulate sending {text!r} to a server and printing the response")
 

examples/environment.py

@@ -9,7 +9,7 @@
 class EnvironmentApp(cmd2.Cmd):
     """Example cmd2 application."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         self.degrees_c = 22
         self.sunny = False
@@ -18,7 +18,7 @@ def __init__(self):
         )
         self.add_settable(cmd2.Settable('sunny', bool, 'Is it sunny outside?', self))
 
-    def do_sunbathe(self, arg):
+    def do_sunbathe(self, arg) -> None:
         """Attempt to sunbathe."""
         if self.degrees_c < 20:
             result = f"It's {self.degrees_c} C - are you a penguin?"
@@ -28,7 +28,7 @@ def do_sunbathe(self, arg):
             result = 'UV is bad for your skin.'
         self.poutput(result)
 
-    def _onchange_degrees_c(self, param_name, old, new):
+    def _onchange_degrees_c(self, param_name, old, new) -> None:
         # if it's over 40C, it's gotta be sunny, right?
         if new > 40:
             self.sunny = True

examples/event_loops.py

@@ -12,7 +12,7 @@
 class Cmd2EventBased(cmd2.Cmd):
     """Basic example of how to run cmd2 without it controlling the main loop."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
     # ... your class code here ...

examples/example.py

@@ -24,7 +24,7 @@ class CmdLineApp(cmd2.Cmd):
     MUMBLE_FIRST = ['so', 'like', 'well']
     MUMBLE_LAST = ['right?']
 
-    def __init__(self):
+    def __init__(self) -> None:
         shortcuts = cmd2.DEFAULT_SHORTCUTS
         shortcuts.update({'&': 'speak'})
         super().__init__(multiline_commands=['orate'], shortcuts=shortcuts)
@@ -40,7 +40,7 @@ def __init__(self):
     speak_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(speak_parser)
-    def do_speak(self, args):
+    def do_speak(self, args) -> None:
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -62,7 +62,7 @@ def do_speak(self, args):
     mumble_parser.add_argument('words', nargs='+', help='words to say')
 
     @cmd2.with_argparser(mumble_parser)
-    def do_mumble(self, args):
+    def do_mumble(self, args) -> None:
         """Mumbles what you tell me to."""
         repetitions = args.repeat or 1
         for _ in range(min(repetitions, self.maxrepeats)):