[IMP] base: "--shell-file" option override for $PYTHONSTARTUP

The $PYTHONSTARTUP env variable can contain a python script that is used
by Python shell at the start of any interactive session.

- fix this feature from being broken in python and ptpython
- include a new --shell-file= shell parameter to override the env
  variable $PYTHONSTARTUP
- group the two shell parameters in a new options group
- remove custom python shells' banners from the start of the session
- shell options can now be saved in the configuration file.

Python docs: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP

Documentation PR: odoo/documentation#11334
task-4306704

odoo/addons/base/tests/config/save_posix.conf

@@ -48,6 +48,8 @@ reportgz = False
 screencasts = 
 screenshots = /tmp/odoo_tests
 server_wide_modules = base,rpc,web
+shell_file = 
+shell_interface = None
 smtp_password = False
 smtp_port = 25
 smtp_server = localhost

odoo/addons/base/tests/test_cli.py

@@ -1,6 +1,10 @@
+import contextlib
+import os
 import re
 import sys
 import subprocess as sp
+import tempfile
+import unittest
 
 from odoo.cli.command import commands, load_addons_commands, load_internal_commands
 from odoo.tools import config
@@ -14,21 +18,26 @@ def setUpClass(cls):
         super().setUpClass()
         cls.odoo_bin = sys.argv[0]
         assert 'odoo-bin' in cls.odoo_bin
+        cls.run_args = (sys.executable, cls.odoo_bin, f'--addons-path={config["addons_path"]}')
 
     def run_command(self, *args, check=True, capture_output=True, text=True, **kwargs):
         return sp.run(
-            [
-                sys.executable,
-                self.odoo_bin,
-                f'--addons-path={config["addons_path"]}',
-                *args,
-            ],
+            [*self.run_args, *args],
             capture_output=capture_output,
             check=check,
             text=text,
             **kwargs
         )
 
+    def popen_command(self, *args, capture_output=True, text=True, **kwargs):
+        if capture_output:
+            kwargs['stdout'] = kwargs['stderr'] = sp.PIPE
+        return sp.Popen(
+            [*self.run_args, *args],
+            text=text,
+            **kwargs
+        )
+
     def test_docstring(self):
         load_internal_commands()
         load_addons_commands()
@@ -60,3 +69,45 @@ def test_help(self):
                     if line.startswith("   ") and (result := re.search(r'    (\w+)\s+(\w.*)$', line)):
                         actual.add(result.groups()[0])
                 self.assertGreaterEqual(actual, expected, msg="Help is not showing required commands")
+
+    @unittest.skipIf(os.name != 'posix', '`os.openpty` only available on POSIX systems')
+    def test_shell(self):
+
+        @contextlib.contextmanager
+        def closing_pty():
+            main, sub = os.openpty()
+            try:
+                yield main, sub
+            finally:
+                for file_descriptor in (main, sub):
+                    with contextlib.suppress(OSError):
+                        os.close(file_descriptor)
+
+        # Write the temp PYTHONSTARTUP file
+        with tempfile.NamedTemporaryFile(mode="w+", encoding="utf-8") as startup_file:
+            startup_file.write("shell_name = f'Hello from {shell_name}'")
+            startup_file.flush()
+
+            with (
+                closing_pty() as (stdin_main_desc, stdin_sub_desc),
+                open(stdin_main_desc, "w", encoding="utf-8") as stdin_file
+            ):
+                # Open `stdin` as a TTY
+                shell = self.popen_command(
+                    'shell',
+                    '--shell-interface=python',
+                    f'--shell-file={startup_file.name}',
+                    stdin=stdin_sub_desc,
+                )
+
+                # Communicate some input
+                stdin_file.write(
+                    'print(shell_name)\n'
+                    'exit()\n'
+                )
+                stdin_file.flush()
+
+                # Fetch the output
+                actual = shell.communicate(timeout=5)[0].splitlines()[-2]
+
+            self.assertEqual(actual, ">>> Hello from python")

odoo/addons/base/tests/test_configmanager.py

@@ -117,9 +117,12 @@ def test_01_default_config(self):
             # security
             'list_db': True,
 
+            # shell
+            'shell_interface': None,
+            'shell_file': '',
+
             # advanced
             'dev_mode': [],
-            'shell_interface': None,
             'stop_after_init': False,
             'osv_memory_count_limit': 0,
             'transient_age_limit': 1.0,
@@ -236,7 +239,8 @@ def test_02_default_config_file(self):
 
             # advanced
             'dev_mode': [],  # blacklist for save, ignored from the config file
-            'shell_interface': 'ipython',  # blacklist for save, read from the config file
+            'shell_interface': 'ipython',
+            'shell_file': '',
             'stop_after_init': True,  # blacklist for save, read from the config file
             'osv_memory_count_limit': 71,
             'transient_age_limit': 4.0,
@@ -357,6 +361,7 @@ def test_04_odoo16_config_file(self):
             'db_maxconn_gevent': False,
             'db_replica_host': False,
             'db_replica_port': False,
+            'shell_file': '',
             'geoip_country_db': '/usr/share/GeoIP/GeoLite2-Country.mmdb',
             'from_filter': False,
             'gevent_port': 8072,

odoo/cli/shell.py

@@ -1,6 +1,6 @@
-# Part of Odoo. See LICENSE file for full copyright and licensing details.
 import code
 import logging
+import optparse
 import os
 import signal
 import sys
@@ -39,15 +39,15 @@ def raise_keyboard_interrupt(*a):
 
 
 class Console(code.InteractiveConsole):
-    def __init__(self, locals=None, filename="<console>"):
-        code.InteractiveConsole.__init__(self, locals, filename)
+    def __init__(self, local_vars=None, filename="<console>"):
+        code.InteractiveConsole.__init__(self, locals=local_vars, filename=filename)
         try:
             import readline
             import rlcompleter
         except ImportError:
             print('readline or rlcompleter not available, autocomplete disabled.')
         else:
-            readline.set_completer(rlcompleter.Completer(locals).complete)
+            readline.set_completer(rlcompleter.Completer(local_vars).complete)
             readline.parse_and_bind("tab: complete")
 
 
@@ -57,6 +57,19 @@ class Shell(Command):
 
     def init(self, args):
         config.parser.prog = f'{Path(sys.argv[0]).name} {self.name}'
+
+        group = optparse.OptionGroup(config.parser, "Shell options")
+        group.add_option(
+            '--shell-file', dest='shell_file', type="string", default='', my_default='',
+            help="Specify a python script to be run after the start of the shell. "
+                 "Overrides the env variable PYTHONSTARTUP."
+        )
+        group.add_option(
+            '--shell-interface', dest='shell_interface', type="string",
+            help="Specify a preferred REPL to use in shell mode. "
+                 "Supported REPLs are: [ipython|ptpython|bpython|python]"
+        )
+        config.parser.add_option_group(group)
         config.parse_config(args, setup_logging=True)
         cli_server.report_configuration()
         server.start(preload=[], stop=True)
@@ -72,6 +85,8 @@ def console(self, local_vars):
             for i in sorted(local_vars):
                 print('%s: %s' % (i, local_vars[i]))
 
+            pythonstartup = config.options.get('shell_file') or os.environ.get('PYTHONSTARTUP')
+
             preferred_interface = config.options.get('shell_interface')
             if preferred_interface:
                 shells_to_try = [preferred_interface, 'python']
@@ -80,27 +95,37 @@ def console(self, local_vars):
 
             for shell in shells_to_try:
                 try:
-                    return getattr(self, shell)(local_vars)
+                    local_vars['shell_name'] = shell
+                    shell_func = getattr(self, shell)
+                    return shell_func(local_vars, pythonstartup)
                 except ImportError:
                     pass
                 except Exception:
-                    _logger.warning("Could not start '%s' shell." % shell)
+                    _logger.warning("Could not start '%s' shell.", shell)
                     _logger.debug("Shell error:", exc_info=True)
 
-    def ipython(self, local_vars):
-        from IPython import start_ipython
-        start_ipython(argv=[], user_ns=local_vars)
-
-    def ptpython(self, local_vars):
-        from ptpython.repl import embed
-        embed({}, local_vars)
-
-    def bpython(self, local_vars):
-        from bpython import embed
-        embed(local_vars)
-
-    def python(self, local_vars):
-        Console(locals=local_vars).interact()
+    def ipython(self, local_vars, pythonstartup=None):
+        from IPython import start_ipython  # noqa: PLC0415
+        argv = (
+            ["--TerminalIPythonApp.display_banner=False"]
+            + [f"--TerminalIPythonApp.exec_files={pythonstartup}"] if pythonstartup else []
+        )
+        start_ipython(argv=argv, user_ns=local_vars)
+
+    def ptpython(self, local_vars, pythonstartup=None):
+        from ptpython.repl import embed  # noqa: PLC0415
+        embed({}, local_vars, startup_paths=[pythonstartup] if pythonstartup else False)
+
+    def bpython(self, local_vars, pythonstartup=None):
+        from bpython import embed  # noqa: PLC0415
+        embed(local_vars, args=['-q', '-i', pythonstartup] if pythonstartup else None)
+
+    def python(self, local_vars, pythonstartup=None):
+        console = Console(local_vars)
+        if pythonstartup:
+            with open(pythonstartup, encoding="utf-8") as f:
+                console.runsource(f.read(), filename=pythonstartup, symbol="exec")
+        console.interact(banner='')
 
     def shell(self, dbname):
         local_vars = {

odoo/tools/config.py

@@ -311,9 +311,6 @@ def _build_cli(self):
         group.add_option('--dev', dest='dev_mode', type="string", file_exportable=False,
                          help="Enable developer mode. Param: List of options separated by comma. "
                               "Options : all, reload, qweb, xml")
-        group.add_option('--shell-interface', dest='shell_interface', type="string", file_exportable=False,
-                         help="Specify a preferred REPL to use in shell mode. Supported REPLs are: "
-                              "[ipython|ptpython|bpython|python]")
         group.add_option("--stop-after-init", action="store_true", dest="stop_after_init", my_default=False, file_exportable=False,
                          help="stop the server after its initialization")
         group.add_option("--osv-memory-count-limit", dest="osv_memory_count_limit", my_default=0,

test.py

@@ -0,0 +1 @@
+print(1)