Package: click-odoo
click-odoohelps you create and run beautiful and robust command line scripts
for Odoo. It is based on the excellentClicklibrary.Useful community-managed scripts can be found inclick-odoo-contrib.ContentsQuick startSupported Odoo versionsDatabase transactionsLoggingCommand line interface (click-odoo)APIclick_odoo.env_options decoratorCustomizing click_odoo.env_options (experimental)click_odoo.odoo namespaceOdooEnvironment context manager (experimental)DevelopementUseful linksCreditsMaintainerChanges1.6.0 (2022-09-21)1.5.0 (2021-10-08)1.4.3 (2020-09-30)1.4.2 (2019-10-01)1.4.1 (2019-01-24)1.4.0 (pulled)1.3.0 (2018-11-21)1.2.0 (2018-11-18)1.1.1 (2018-11-01)1.1.0 (2018-10-31)1.0.4 (2018-10-07)1.0.3 (2018-06-05)1.0.2 (2018-06-01)1.0.1 (2018-05-27)1.0.0 (2018-05-20)1.0.0b4 (2018-05-17)1.0.0b3 (2018-03-22)1.0.0b2 (2018-03-21)1.0.0b1 (2018-03-20)1.0.0a2 (2018-03-19)1.0.0a1 (2018-03-19)Quick startCheck Odoo is correctly installed:python-c"import odoo"must
work when run from another directory than the Odoo root directory.Installclick-odoo:pip install click-odooAssuming the following script namedlist-users.py.#!/usr/bin/env pythonfrom__future__importprint_functionforuinenv['res.users'].search([]):print(u.login,u.name)It can be run with:python -m click_odoo -d dbname --log-level=error ./list-users.pyor:click-odoo -d dbname --log-level=error ./list-users.pyor:./list-users.py -d dbname --log-level=errorThe other technique to create scripts looks like this. Assuming
the following script namedlist-users2.py.#!/usr/bin/env pythonfrom__future__importprint_functionimportclickimportclick_odoo@click.command()@click_odoo.env_options(default_log_level='error')@click.option('--say-hello',is_flag=True)defmain(env,say_hello):ifsay_hello:click.echo("Hello!")foruinenv['res.users'].search([]):print(u.login,u.name)if__name__=='__main__':main()It can be run like this:$ ./list-users2.py --help
Usage: list-users2.py [OPTIONS]

Options:
  -c, --config PATH    Specify the Odoo configuration file. Other ways to
                       provide it are with the ODOO_RC or OPENERP_SERVER
                       environment variables, or ~/.odoorc (Odoo >= 10) or
                       ~/.openerp_serverrc.
  -d, --database TEXT  Specify the database name. If present, this
                       parameter takes precedence over the database
                       provided in the Odoo configuration file.
  --log-level TEXT     Specify the logging level. Accepted values depend on
                       the Odoo version, and include debug, info, warn,
                       error, critical. [default: error]
  --logfile PATH       Specify the log file.
  --rollback           Rollback the transaction even if the script
                       does not raise an exception. Note that if
                       the script itself commits, this option has no
                       effect, this is why it is not named dry run.
                       This option is implied when an interactive
                       console is started.
  --say-hello
  --help               Show this message and exit.

$ ./list-users2.py --say-hello -d dbname
Hello!
admin Administrator
...Finally, you can start an interactive shell by simply typingpython-mclick_odoo-ddbnameorclick-odoo-ddbname.
This will launch the python REPL with an Odooenvavailable
as a global variable.Supported Odoo versionsOdoo version 11, 12, 13, 14, 15 and 16 are supported.An important design goal is to provide a consistent behaviour
across Odoo versions.Noteclick-odoodoes not mandate any particular method of installing odoo. The only
prerequisiste is thatimport odoomust work when run from another directory than
the Odoo root directory.You may also rely on the fact that python adds the current directory tosys.path, soimport odooworks from the Odoo root directory.
In such case, the only working invocation method may bepython-mclick_odoo.Database transactionsBy defaultclick-odoocommits the transaction for you, unless your script
raises an exception. This is so that you don’t need to put explicit commits
in your scripts, which are therefore easier to compose in larger transactions
(provided they pass around the same env).There is a--rollbackoption to force a rollback.A rollback is always performed after an interactive session. If you need to
commit changes made before or during an interactive session, useenv.cr.commit().LoggingLogging is controlled by the usual Odoo logging options (--log-level,--logfile) or the Odoo configuration file.Note the--log-leveloption applies to theodoopackage only.Command line interface (click-odoo)Usage: click-odoo [OPTIONS] [SCRIPT] [SCRIPT_ARGS]...

  Execute a python script in an initialized Odoo environment. The script has
  access to a 'env' global variable which is an odoo.api.Environment
  initialized for the given database. If no script is provided, the script
  is read from stdin or an interactive console is started if stdin appears
  to be a terminal.

Options:
  -c, --config FILE               Specify the Odoo configuration file. Other
                                  ways to provide it are with the ODOO_RC or
                                  OPENERP_SERVER environment variables, or
                                  ~/.odoorc (Odoo >= 10) or
                                  ~/.openerp_serverrc.
  --addons-path TEXT              Specify the addons path. If present, this
                                  parameter takes precedence over the addons
                                  path provided in the Odoo configuration
                                  file.
  -d, --database TEXT             Specify the database name. If present, this
                                  parameter takes precedence over the database
                                  provided in the Odoo configuration file.
  --log-level TEXT                Specify the logging level. Accepted values
                                  depend on the Odoo version, and include
                                  debug, info, warn, error.  [default: info]
  --logfile FILE                  Specify the log file.
  --rollback                      Rollback the transaction even if the script
                                  does not raise an exception. Note that if
                                  the script itself commits, this option has
                                  no effect. This is why it is not named dry
                                  run. This option is implied when an
                                  interactive console is started.
  -i, --interactive / --no-interactive
                                  Inspect interactively after running the
                                  script.
  --shell-interface TEXT          Preferred shell interface for interactive
                                  mode. Accepted values are ipython, ptpython,
                                  bpython, python. If not provided they are
                                  tried in this order.
  --help                          Show this message and exit.Most options above are the same asodoooptions and behave identically.
Additional Odoo options can be set in the the configuration file.
Note however that most server-related options (workers, http interface etc)
are ignored because no server is actually started when running a script.An important feature ofclick-odoocompared to, say,odoo shellis
the capability to pass arguments to scripts.In order to avoid confusion betweenclick-odoooptions and your script
options and arguments, it is recommended to separate them with--:click-odoo -d dbname -- list-users.py -d a b
./list-users.py -d dbname -- -d a bIn both examples above,sys.argv[1:]will contain['-d','a', 'b']in the script.APIclick_odoo.env_options decorator@click_odoo.env_options()is a decorator that is used very much like@click.option()and inserts the list of predefinedclick-odoooptions. Instead of passing down these options to the command, it prepares
an odooEnvironmentand passes it as aenvparameter.It is configurable with the following keyword arguments:default_log_levelThe default value for the--log-leveloption (default: ‘info’).with_rollbackControls the presence of the--rollbackoption (default: True).
This is useful for creating commands that commit and leave no possibility
for rollback.with_databaseControls the presence of the--databaseoption (default: True).
This is useful to create scripts that have access to a pre-loaded Odoo
configuration, without any database. In such case, the environment
is not set (env is None). Ifwith_databaseis False,database_requiredis implied to be False too.database_requiredControls if a database must be provided through the--databaseoption or the Odoo configuration file (default: True).database_must_existIf this flag is False and the selected database does not exist
do not fail and pass env=None instead (default: True).with_addons_pathControls the presence of the--addons-pathoption (default: False).environment_managerexperimental featureA context manager that yields an intializedodoo.api.Environment.
It is invoked after Odoo configuration parsing and initialization.
It must have the following signature (identical toOdooEnvironmentbelow, plus the clickctxas well as**kwargsfor future proofing):environment_manager(database,rollback,ctx,**kwargs)Customizing click_odoo.env_options (experimental)click_odoo.env_optionsis a class that can be extended for customization
purposes.It currently has one method that is intended to be overridden, with the
following signature:defget_odoo_args(self,ctx:click.Context)->List[str]:...It must return a list of Odoo command line arguments computed
from the Click context. It will be called after parsing all parameters
of the command, and before initializing Odoo and invoking the command function.click_odoo.odoo namespaceAs a convenienceclick_odooexports theodoonamespace, sofrom click_odoo import odoois an alias forimport odoo.OdooEnvironment context manager (experimental)This package also provides an experimentalOdooEnvironmentcontext manager.
It is meant to be used in after properly intializing Odoo (ie parsing the
configuration file etc).WarningThis API is considered experimental, contrarily to the scripting mechanism
(ie passingenvto scripts) andenv_optionsdecorator which are
stable features. Should you have a specific usage for this API and would
like it to become stable, get it touch to discuss your requirements.Example:fromclick_odooimportOdooEnvironmentwithOdooEnvironment(database='dbname')asenv:env['res.users'].search([])DevelopementTo run tests, typetox. Tests are made using pytest. To run tests matching
a specific keyword for, say, Odoo 12 and python 3.6, usetox-epy36-12.0---kkeyword.This project usesblackas code formatting convention, as well as isort and flake8.
To make sure local coding convention are respected before
you commit, installpre-commitand
runpre-commitinstallafter cloning the repository.Useful linkspypi page:https://pypi.org/project/click-odoocode repository:https://github.com/acsone/click-odooreport issues at:https://github.com/acsone/click-odoo/issuesCreditsAuthor:Stéphane Bidoul (ACSONE)Contributors:Thomas Binsfeld (ACSONE)David Arnold (XOE)Jairo Llopis (Tecnativa)Inspiration has been drawn from:anybox.recipe.odooanthem by Camptocampodoo’s own shell commandMaintainerThis project is maintained by ACSONE SA/NV.Changes1.6.0 (2022-09-21)FeatureAdd CI tests for Odoo 16 and Python 3.10. (#51)Deprecations and RemovalsDrop support for python < 3.6 and Odoo 8, 9, 10. (#48)1.5.0 (2021-10-08)FeaturesSilenced a noisy warning about Environment.manage() being a no-op in Odoo 15. (#43)1.4.3 (2020-09-30)FeaturesRefined ImportError detection infrom click_odoo import odoo, for
easier diagnostic of Odoo installation issues. (#36)1.4.2 (2019-10-01)Odoo 8 unconditionally registers wsgi handlers, which has the surprising
side effect to start a server in some circumstances, for instance when
callingenv["ir.module.module"].update_list()inclick-odoo-initdb.
Disable them in click-odoo initialization, since they are useless and
other Odoo version do not install them.Support Odoo saas versions.1.4.1 (2019-01-24)revert change to logging made in 1.4.01.4.0 (pulled)add support for launching withpython-mclick_odoo. Fixes #20.apply--log-levelto the root logger, so it works more
intuitively by applying to the script too, and not only to theodoonamespace.This may change the log output of some scripts.
In particular,--log-level=debugwill now apply debug logging
to every python library used, and not only to Odoo.
Fine tuning is available through thelog_handlerconfiguration item.support Odoo config files with multiple comma separate databases names
in db_name config entry.1.3.0 (2018-11-21)pass click ctx to environment_manager1.2.0 (2018-11-18)refactor@click_odoo.env_optionsto allow propagatingenvto subcommands through the click context. Fixes #16.do not log click Exit exception, which may be raised by subcommands as
a result of –help.Upgrading:
- click-odoo now requires click>=71.1.1 (2018-11-01)addwith_addons_pathoption to@click_odoo.env_optionsto control the presence of the--addons-pathoption. Defaults to False.
Enabled for theclick-odooCLI.1.1.0 (2018-10-31)addenvironment_managerto@click_odoo.env_options, providing
a hook onodoo.api.Environmentcreation.add--addons-pathoption to the CLI.adddatabase_must_existoption to@click_odoo.env_optionsso scripts can behave how they please in case the database is absent.1.0.4 (2018-10-07)silence deprecation warningadapt tests for Odoo 121.0.3 (2018-06-05)clarify the behaviour of@env_optionwith_databaseanddatabase_requiredparameters; in particular, whenwith_databaseanddatabase_requiredare both set (the default), the--databaseoption can be omitted
as long as a database is declared in the Odoo configuration file.1.0.2 (2018-06-01)refactor the OdooEnvironment class: it is much cleaner when
it leaves the global Odoo config alone, so we completely move
responsibility to initialize the Odoo config to the CLI part.1.0.1 (2018-05-27)better error logging and handling: all exceptions occuring
in scripts under click_odoo.env_options are logged and converted
to ClickException so we are sure they are both in the log file
and on the console (handled by click) for the user to see.
The OdooEnvironment context manager does not do additional logging,
leaving that responsibility to the caller.1.0.0 (2018-05-20)close db connections when releasing OdooEnvironmentexpose click_odoo.odoo_bin (odoo or openerp-server depending on Odoo series).
not documented yet, because it should ideally be a full path corresponding
to the installed click_odoo.odoo, and I’m not sure how best to detect it yet.1.0.0b4 (2018-05-17)minor documentation improvementsadd the possibility to run script without--database(ie without env,
but with a properly initialized Odoo library such as addons path)be more resilient in case we can’t obtain a context for the user1.0.0b3 (2018-03-22)click_odoo now exports the odoo namespace:from click_odoo import odoois an alias forimport odoo(>9) orimport openerp as odoo(<=9)add awith_rollbackoption to theenv_optionsdecorator, to control
the presence of the rollback optiondocument theenv_optionsdecorator1.0.0b2 (2018-03-21)commit in case of success, so users do not need to commit in their
scripts, therefore making scripts easier to compose in larger transactionsadd a –rollback optioninteractive mode forces –rollback1.0.0b1 (2018-03-20)clear cache when starting environment (mostly useful for tests)simplify and test transaction and exception handlingwhen leaving the env, log the exception to be sure it is visible
when using--logfile1.0.0a2 (2018-03-19)improve transaction management: avoid some rare deadlockavoid masking original exception in case of error during rollbackmake sure scripts launched by click-odoo have__name__ == '__main__'add--logfileoption1.0.0a1 (2018-03-19)first alpha