NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] developer: added "--shell-file" CLI option

Browse Source 
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

closes odoo/documentation#11334

Signed-off-by: Paolo Gatti (pgi) <pgi@odoo.com>
This commit is contained in:
Paolo Gatti 2024-11-06 11:51:45 +01:00
parent 112551a0f7
commit 096d17c474
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/developer/reference/cli.rst
View File

@ -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`