click-odoo 1.6.0

快速开始

检查Odoo是否正确安装：从Odoo根目录以外的目录运行时，python -c "import odoo" 必须能正常工作。

安装 click-odoo

pip install click-odoo

假设以下脚本名为 list-users.py。

#!/usr/bin/env python
from __future__ import print_function

for u in env['res.users'].search([]):
    print(u.login, u.name)

可以使用以下方式运行：

python -m click_odoo -d dbname --log-level=error ./list-users.py

或

click-odoo -d dbname --log-level=error ./list-users.py

或

./list-users.py -d dbname --log-level=error

创建脚本的另一种技术如下。假设以下脚本名为 list-users2.py。

#!/usr/bin/env python
from __future__ import print_function
import click

import click_odoo


@click.command()
@click_odoo.env_options(default_log_level='error')
@click.option('--say-hello', is_flag=True)
def main(env, say_hello):
    if say_hello:
        click.echo("Hello!")
    for u in env['res.users'].search([]):
        print(u.login, u.name)


if __name__ == '__main__':
    main()

可以按照以下方式运行：

$ ./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
...

最后，只需输入 python -m click_odoo -d dbname 或 click-odoo -d dbname 即可启动交互式shell。这将启动一个带有Odoo env的全局变量的Python REPL。

支持的Odoo版本

支持Odoo版本11、12、13、14、15和16。

一个重要的设计目标是提供跨Odoo版本的一致行为。

数据库事务

默认情况下，click-odoo 会为您提交事务，除非您的脚本抛出异常。这样，您就不需要在脚本中显式提交，这使得它们在大事务（只要它们传递相同的env）中更容易组合。

使用 --rollback 选项可以强制回滚。

在交互式会话之后总是执行回滚。如果您需要提交在交互式会话之前或期间所做的更改，请使用 env.cr.commit()。

日志记录

日志记录受通常的Odoo日志选项（--log-level，--logfile）或Odoo配置文件的控制。

请注意，--log-level 选项仅适用于 odoo 包。

命令行界面（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.

上面的大多数选项与 odoo 选项相同，行为也相同。可以在配置文件中设置额外的Odoo选项。但是请注意，大多数与服务器相关的选项（工作者、http接口等）都被忽略，因为在运行脚本时实际上不会启动服务器。

与 odoo shell 相比，click-odoo 的一个重要特性是能够向脚本传递参数。

为了避免 click-odoo 选项与您的脚本选项和参数之间的混淆，建议使用 -- 将它们分开。

click-odoo -d dbname -- list-users.py -d a b
./list-users.py -d dbname -- -d a b

在上面的两个示例中，sys.argv[1:] 在脚本中将包含 ['-d', 'a', 'b']。

API

def get_odoo_args(self, ctx: click.Context) -> List[str]:
    ...

from click_odoo import OdooEnvironment


with OdooEnvironment(database='dbname') as env:
    env['res.users'].search([])

开发

要运行测试，请输入 tox。测试使用 pytest 进行。要运行与特定关键字匹配的测试，例如 Odoo 12 和 Python 3.6，请使用 tox -e py36-12.0 -- -k 关键字。

此项目使用 black 作为代码格式规范，以及 isort 和 flake8。在提交之前确保遵守本地编码规范，请安装 pre-commit 并在克隆存储库后运行 pre-commit install。

有用的链接

• pypi 页面: https://pypi.ac.cn/project/click-odoo

• 代码存储库: https://github.com/acsone/click-odoo

• 在以下位置报告问题: https://github.com/acsone/click-odoo/issues

致谢

作者

• Stéphane Bidoul (ACSONE)

贡献者

• Thomas Binsfeld (ACSONE)

• David Arnold (XOE)

• Jairo Llopis (Tecnativa)

灵感来自

• anybox.recipe.odoo

• Camptocamp 的 anthem

• Odoo 自身的 shell 命令

维护者

此项目由 ACSONE SA/NV 维护。

变更