Enable ruff RET ruleset

Author: tleonhardt

cmd2/clipboard.py

@@ -10,8 +10,7 @@ def get_paste_buffer() -> str:
 
     :return: contents of the clipboard
     """
-    pb_str = typing.cast(str, pyperclip.paste())
-    return pb_str
+    return typing.cast(str, pyperclip.paste())
 
 
 def write_to_paste_buffer(txt: str) -> None:

cmd2/parsing.py

@@ -154,8 +154,7 @@ def __new__(cls, value: object, *pos_args: Any, **kw_args: Any) -> 'Statement':
         NOTE:  @dataclass takes care of initializing other members in the __init__ it
         generates.
         """
-        stmt = super().__new__(cls, value)
-        return stmt
+        return super().__new__(cls, value)
 
     @property
     def command_and_args(self) -> str:
@@ -382,8 +381,7 @@ def tokenize(self, line: str) -> list[str]:
             raise Cmd2ShlexError(ex)
 
         # custom lexing
-        tokens = self.split_on_punctuation(tokens)
-        return tokens
+        return self.split_on_punctuation(tokens)
 
     def parse(self, line: str) -> Statement:
         """Tokenize the input and parse it into a [cmd2.parsing.Statement][] object,
@@ -515,7 +513,7 @@ def parse(self, line: str) -> Statement:
             multiline_command = ''
 
         # build the statement
-        statement = Statement(
+        return Statement(
             args,
             raw=line,
             command=command,
@@ -527,7 +525,6 @@ def parse(self, line: str) -> Statement:
             output=output,
             output_to=output_to,
         )
-        return statement
 
     def parse_command_only(self, rawinput: str) -> Statement:
         """Partially parse input into a [cmd2.Statement][] object.
@@ -589,8 +586,7 @@ def parse_command_only(self, rawinput: str) -> Statement:
             multiline_command = ''
 
         # build the statement
-        statement = Statement(args, raw=rawinput, command=command, multiline_command=multiline_command)
-        return statement
+        return Statement(args, raw=rawinput, command=command, multiline_command=multiline_command)
 
     def get_command_arg_list(
         self, command_name: str, to_parse: Union[Statement, str], preserve_quotes: bool

cmd2/py_bridge.py

@@ -137,10 +137,9 @@ def __call__(self, command: str, *, echo: Optional[bool] = None) -> CommandResul
                 self.stop = stop or self.stop
 
         # Save the result
-        result = CommandResult(
+        return CommandResult(
             stdout=copy_cmd_stdout.getvalue(),
             stderr=copy_stderr.getvalue(),
             stop=stop,
             data=self._cmd2_app.last_result,
         )
-        return result

plugins/template/tests/test_myplugin.py

@@ -35,8 +35,7 @@ def do_empty(self, args) -> None:
 
 
 def init_app():
-    app = MyApp()
-    return app
+    return MyApp()
 
 
 #####

pyproject.toml

@@ -203,7 +203,7 @@ select = [
     # "PTH", # flake8-use-pathlib (force use of pathlib instead of os.path)
     "PYI", # flake8-pyi (warnings related to type hint best practices)
     "Q",   # flake8-quotes (force double quotes)
-    # "RET",  # flake8-return (various warnings related to implicit vs explicit return statements)
+    "RET", # flake8-return (various warnings related to implicit vs explicit return statements)
     "RSE", # flake8-raise (warn about unnecessary parentheses on raised exceptions)
     # "RUF", # Ruff-specific rules (miscellaneous grab bag of lint checks specific to Ruff)
     # "S", # flake8-bandit (security oriented checks, but extremely pedantic - do not attempt to apply to unit test files)

tests/test_argparse.py

@@ -122,8 +122,7 @@ def do_test_argparse_with_list_ns(self, args, extra) -> None:
 
 @pytest.fixture
 def argparse_app():
-    app = ArgparseApp()
-    return app
+    return ArgparseApp()
 
 
 def test_invalid_syntax(argparse_app) -> None:
@@ -324,8 +323,7 @@ def helpless_subcmd_func(self, args: argparse.Namespace) -> None:
 
 @pytest.fixture
 def subcommand_app():
-    app = SubcommandApp()
-    return app
+    return SubcommandApp()
 
 
 def test_subcommand_foo(subcommand_app) -> None:

tests/test_argparse_completer.py

@@ -1268,8 +1268,7 @@ def _subcmd_custom(self, args: argparse.Namespace) -> None:
 
 @pytest.fixture
 def custom_completer_app():
-    app = CustomCompleterApp()
-    return app
+    return CustomCompleterApp()
 
 
 def test_default_custom_completer_type(custom_completer_app: CustomCompleterApp) -> None:

tests/test_cmd2.py

@@ -280,8 +280,7 @@ def _onchange_quiet(self, name, old, new) -> None:
 
 @pytest.fixture
 def onchange_app():
-    app = OnChangeHookApp()
-    return app
+    return OnChangeHookApp()
 
 
 def test_set_onchange_hook(onchange_app) -> None:
@@ -847,15 +846,13 @@ def _expected_no_editor_error():
     if hasattr(sys, "pypy_translation_info"):
         expected_exception = 'EnvironmentError'
 
-    expected_text = normalize(
+    return normalize(
         f"""
 EXCEPTION of type '{expected_exception}' occurred with message: Please use 'set editor' to specify your text editing program of choice.
 To enable full traceback, run the following command: 'set debug true'
 """
     )
 
-    return expected_text
-
 
 def test_base_debug(base_app) -> None:
     # Purposely set the editor to None
@@ -1086,8 +1083,7 @@ def postparsing_precmd(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.P
 
 @pytest.fixture
 def hook_failure():
-    app = HookFailureApp()
-    return app
+    return HookFailureApp()
 
 
 def test_precmd_hook_success(base_app) -> None:
@@ -1211,8 +1207,7 @@ def do_parser_cmd(self, args) -> None:
 
 @pytest.fixture
 def help_app():
-    app = HelpApp()
-    return app
+    return HelpApp()
 
 
 def test_custom_command_help(help_app) -> None:
@@ -1285,8 +1280,7 @@ def do_undoc(self, arg) -> None:
 
 @pytest.fixture
 def helpcat_app():
-    app = HelpCategoriesApp()
-    return app
+    return HelpCategoriesApp()
 
 
 def test_help_cat_base(helpcat_app) -> None:
@@ -1342,8 +1336,7 @@ def do_return_type(self, arg) -> None:
 
 @pytest.fixture
 def select_app():
-    app = SelectApp()
-    return app
+    return SelectApp()
 
 
 def test_select_options(select_app, monkeypatch) -> None:
@@ -1592,8 +1585,7 @@ def do_orate(self, opts, arg) -> None:
 
 @pytest.fixture
 def multiline_app():
-    app = MultilineApp()
-    return app
+    return MultilineApp()
 
 
 def test_multiline_complete_empty_statement_raises_exception(multiline_app) -> None:
@@ -1759,8 +1751,7 @@ def do_negative_no_data(self, arg) -> None:
 
 @pytest.fixture
 def commandresult_app():
-    app = CommandResultApp()
-    return app
+    return CommandResultApp()
 
 
 def test_commandresult_truthy(commandresult_app) -> None:
@@ -2813,8 +2804,7 @@ def do_has_no_helper_funcs(self, arg) -> None:
 
 @pytest.fixture
 def disable_commands_app():
-    app = DisableCommandsApp()
-    return app
+    return DisableCommandsApp()
 
 
 def test_disable_and_enable_category(disable_commands_app) -> None:

tests/test_completion.py

@@ -122,8 +122,7 @@ def completedefault(self, *ignored):
 
 @pytest.fixture
 def cmd2_app():
-    c = CompletionsExample()
-    return c
+    return CompletionsExample()
 
 
 def test_cmd2_command_completion_single(cmd2_app) -> None:
@@ -1261,8 +1260,7 @@ def do_base(self, args) -> None:
 @pytest.fixture
 def scu_app():
     """Declare test fixture for with_argparser decorator"""
-    app = SubcommandsWithUnknownExample()
-    return app
+    return SubcommandsWithUnknownExample()
 
 
 def test_subcmd_with_unknown_completion_single_end(scu_app) -> None:

tests/test_history.py

@@ -56,15 +56,14 @@ def hist():
         Statement,
     )
 
-    h = History(
+    return History(
         [
             HistoryItem(Statement('', raw='first')),
             HistoryItem(Statement('', raw='second')),
             HistoryItem(Statement('', raw='third')),
             HistoryItem(Statement('', raw='fourth')),
         ]
     )
-    return h
 
 
 # Represents the hist fixture's JSON
@@ -381,8 +380,7 @@ def histitem():
         command='help',
         arg_list=['history'],
     )
-    histitem = HistoryItem(statement)
-    return histitem
+    return HistoryItem(statement)
 
 
 @pytest.fixture
@@ -391,7 +389,7 @@ def parser():
         StatementParser,
     )
 
-    parser = StatementParser(
+    return StatementParser(
         terminators=[';', '&'],
         multiline_commands=['multiline'],
         aliases={
@@ -403,7 +401,6 @@ def parser():
         },
         shortcuts={'?': 'help', '!': 'shell'},
     )
-    return parser
 
 
 def test_multiline_histitem(parser) -> None:

tests/test_parsing.py

@@ -19,7 +19,7 @@
 
 @pytest.fixture
 def parser():
-    parser = StatementParser(
+    return StatementParser(
         terminators=[';', '&'],
         multiline_commands=['multiline'],
         aliases={
@@ -31,13 +31,11 @@ def parser():
         },
         shortcuts={'?': 'help', '!': 'shell'},
     )
-    return parser
 
 
 @pytest.fixture
 def default_parser():
-    parser = StatementParser()
-    return parser
+    return StatementParser()
 
 
 def test_parse_empty_string(parser) -> None:

tests/test_utils.py

@@ -142,8 +142,7 @@ def test_quote_string_if_needed_no() -> None:
 
 @pytest.fixture
 def stdout_sim():
-    stdsim = cu.StdSim(sys.stdout, echo=True)
-    return stdsim
+    return cu.StdSim(sys.stdout, echo=True)
 
 
 def test_stdsim_write_str(stdout_sim) -> None:
@@ -279,8 +278,7 @@ def pr_none():
         kwargs['start_new_session'] = True
 
     proc = subprocess.Popen(command, shell=True, **kwargs)
-    pr = cu.ProcReader(proc, None, None)
-    return pr
+    return cu.ProcReader(proc, None, None)
 
 
 def test_proc_reader_send_sigint(pr_none) -> None:

tests_isolated/test_commandset/conftest.py

@@ -180,11 +180,9 @@ def __init__(self, *args, **kwargs) -> None:
 
 @pytest.fixture
 def command_sets_app():
-    app = WithCommandSets()
-    return app
+    return WithCommandSets()
 
 
 @pytest.fixture
 def command_sets_manual():
-    app = WithCommandSets(auto_load_commands=False)
-    return app
+    return WithCommandSets(auto_load_commands=False)

tests_isolated/test_commandset/test_argparse_subcommands.py

@@ -62,8 +62,7 @@ def do_base(self, args) -> None:
 
 @pytest.fixture
 def subcommand_app():
-    app = WithCommandSets(auto_load_commands=False, command_sets=[SubcommandSet(1)])
-    return app
+    return WithCommandSets(auto_load_commands=False, command_sets=[SubcommandSet(1)])
 
 
 def test_subcommand_foo(subcommand_app) -> None:

tests_isolated/test_commandset/test_commandset.py

@@ -748,8 +748,7 @@ def cut_bokchoy(self, _: argparse.Namespace) -> None:
 
 @pytest.fixture
 def static_subcommands_app():
-    app = AppWithSubCommands()
-    return app
+    return AppWithSubCommands()
 
 
 def test_static_subcommands(static_subcommands_app) -> None: