Skip to content

Commit

Permalink
[IMP] developer: added "--shell-file" CLI option
Browse files Browse the repository at this point in the history
Added the description for the new '--shell-file' option, which overrides
the the $PYTHONSTARTUP env variable to initialize the shell session with
a startup Python script.

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

Community PR: odoo/odoo#185075
task-4306704
  • Loading branch information
lordkrandel committed Nov 20, 2024
1 parent bd285ab commit e4c6445
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions content/developer/reference/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -695,10 +695,16 @@ interaction with the :ref:`orm <reference/orm>` and its functionalities.
By default, the shell is running in transaction mode. This means that any change made to the
database is rolled back when exiting the shell. To commit changes, use `env.cr.commit()`.


.. option:: --shell-file <init_script.py>

Specify a Python script to be run after the start of the shell. Overrides the environment
variable `PYTHONSTARTUP`.

.. option:: --shell-interface (ipython|ptpython|bpython|python)

Specify a preferred REPL to use in shell mode. This shell is started with the `env` variable
already initialized to be able to access the ORM and other Odoo modules.
Specify a preferred `REPL` to use in shell mode. This shell is started with the `env` variable
already initialized to be able to access the `ORM` and other Odoo modules.

.. seealso::
:ref:`reference/orm/environment`
Expand Down

0 comments on commit e4c6445

Please sign in to comment.