Setup guide

根据预期的使用情况，有多种安装Odoo的方法。对于Odoo社区的开发人员和Odoo员工来说，首选的方法是执行源代码安装（从源代码运行Odoo）。

重要

Follow the 环境设置 section of the contributing guide to prepare your environment for pushing local changes to the Odoo repositories.

Adapt the environment for the tutorials

By now, you should have downloaded the source code into two local repositories, one for odoo/odoo and one for odoo/enterprise. These repositories are set up to push changes to pre-defined forks on GitHub. This will prove to be convenient when you start contributing to the codebase, but in the scope of following a tutorial, we want to avoid polluting them with training material. Let’s then push your changes in a third repository: odoo/tutorials. Like the first two repositories, it will be part of the addons-path that references all directories containing Odoo modules.

注解

Depending on the tutorial that you are following, you might not need to install all the modules that this repository contains.

1. Following the same process as with the odoo/odoo and odoo/enterprise repositories, clone the odoo/tutorials repository on your machine with:

   $ git clone git@github.com:odoo/tutorials.git
   

2. Configure your fork and Git to push changes to your fork rather than to the main codebase. If you work at Odoo, configure Git to push changes to the shared fork created on the account odoo-dev.

   Link Git with your forkLink Git with odoo-dev

   1. Visit github.com/odoo/tutorials and click the Fork button to create a fork of the repository on your account.

   2. 在下面的命令中，将 <your_github_account> 替换为您创建 fork 的 GitHub 账户名。

      $ cd /TutorialsPath
      $ git remote add dev git@github.com:<your_github_account>/tutorials.git
      

就是这样！您的环境现在已经准备好从源代码运行Odoo，并且您已经成功创建了一个用作插件目录的存储库。这将允许您将您的工作推送到GitHub。

重要

For Odoo employees only:

1. Make sure to read very carefully 进行你的第一次贡献. In particular, your branch name must follow our conventions.

2. Once you have pushed your first change to the shared fork on odoo-dev, create a PR. Please put your quadrigram in the PR title (e.g., “abcd - Technical Training”).

   This will enable you to share your upcoming work and receive feedback from your coaches. To ensure a continuous feedback loop, we recommend pushing a new commit as soon as you complete a chapter of the tutorial. Note that the PR is automatically updated with commits you push to odoo-dev, you don’t need to open multiple PRs.

3. At Odoo we use Runbot extensively for our CI tests. When you push your changes to odoo-dev, Runbot creates a new build and test your code. Once logged in, you will be able to see your branches Tutorials project.

注解

您的文件系统上存储库的具体位置并不重要。但是，为了简单起见，我们假设您已经将所有存储库克隆到同一个目录下。如果不是这种情况，请确保相应地调整以下命令，提供从 odoo/odoo 存储库到 odoo/technical-training-sandbox 存储库的适当相对路径。

运行服务器

使用 odoo-bin 启动

一旦所有依赖项都设置好，可以通过运行 odoo-bin 来启动 Odoo，这是服务器的命令行界面。

$ cd $HOME/src/odoo/
$ ./odoo-bin --addons-path="addons/,../enterprise/,../tutorials" -d rd-demo

有多个 命令行参数 可用于运行服务器。在本培训中，您只需要其中一些。

-d <database>

将要使用的数据库。

--addons-path <directories>

存储模块的目录列表，用逗号分隔。这些目录将被扫描以查找模块。

--limit-time-cpu <limit>

限制每个请求的工作进程使用不超过<limit> CPU秒。

--limit-time-real <limit>

防止工作进程在处理请求时超过<limit>秒。

小技巧

• The --limit-time-cpu and --limit-time-real arguments can be used to prevent the worker from being killed when debugging the source code.

• 您可能会遇到类似的错误 AttributeError: module '<MODULE_NAME>' has no attribute '<$ATTRIBUTE'>。在这种情况下，您可能需要使用 $ pip install --upgrade --force-reinstall <MODULE_NAME> 重新安装模块。

  如果此错误发生在多个模块上，您可能需要使用 $ pip install --upgrade --force-reinstall -r requirements.txt 重新安装所有的要求。

  您也可以清除Python缓存来解决此问题：

  $ cd $HOME/.local/lib/python3.8/site-packages/
  $ find -name '*.pyc' -type f -delete
  

• 其他常用的参数包括：

  • -i: Install some modules before running the server (comma-separated list). This is equivalent to going to Apps in the user interface, and installing the module from there.

  • -u: Update some modules before running the server (comma-separated list). This is equivalent to going to Apps in the user interface, selecting a module, and upgrading it from there.

登录Odoo

打开 http://localhost:8069/ 在你的浏览器上。我们推荐使用 Chrome <https://www.google.com/intl/en/chrome/> _， Firefox <https://www.mozilla.org/firefox/new/> _，或者任何其他带有开发工具的浏览器。

要登录管理员用户，请使用以下凭据：

• email: admin

• 密码： admin

启用开发者模式

The developer or debug mode is useful for training as it gives access to additional (advanced) tools. Enable the developer mode now. Choose the method that you prefer; they are all equivalent.

额外工具

有用的 Git 命令

以下是一些日常工作中有用的 Git 命令。

• 切换分支：

  当您切换分支时，两个仓库（odoo 和 enterprise）必须同步，即两者都需要在同一个分支中。

  $ cd $HOME/src/odoo
  $ git switch 18.0
  
  $ cd $HOME/src/enterprise
  $ git switch 18.0
  

• 获取并变基：

  $ cd $HOME/src/odoo
  $ git fetch --all --prune
  $ git rebase --autostash odoo/18.0
  
  $ cd $HOME/src/enterprise
  $ git fetch --all --prune
  $ git rebase --autostash enterprise/18.0
  

代码编辑器

如果你在Odoo工作，你的许多同事都在使用 VSCode <https://code.visualstudio.com> _， VSCodium <https://vscodium.com> _（开源的等效品）， PyCharm <https://www.jetbrains.com/pycharm/download/#section=linux> _，或者 Sublime Text <https://www.sublimetext.com> _。然而，你可以自由选择你喜欢的编辑器。

配置您的 Linter 是非常重要的。使用 Linter 可以帮助您显示语法和语义警告或错误。Odoo 源代码尽力遵守 Python 和 JavaScript 的标准，但有些标准可以忽略。

对于Python，我们使用PEP8，忽略这些选项：

• E501: line too long

• E301: expected 1 blank line, found 0

• E302: expected 2 blank lines, found 1

对于JavaScript，我们使用ESLint，你可以在这里找到一个 配置文件示例。

PostgreSQL的管理员工具

你可以使用命令行来管理你的PostgreSQL数据库，就像之前演示的那样，或者使用图形用户界面应用程序，比如 pgAdmin 或者 DBeaver。

我们建议您使用Unix套接字连接来连接GUI应用程序和数据库。

• 主机名/地址： /var/run/postgresql

• 端口： 5432

• 用户名: $USER

Python调试

当面对错误或者试图理解代码运行时，简单地打印输出可以解决很多问题，但是一个合适的调试器可以节省很多时间。

You can use a classic Python library debugger (pdb, pudb or ipdb), or you can use your editor’s debugger.

在下面的例子中，我们使用ipdb，但使用其他库的过程类似。

1. 安装库：

   pip install ipdb
   

2. 放置触发器（断点）：

   import ipdb; ipdb.set_trace()
   

   Example

   def copy(self, default=None):
       import ipdb; ipdb.set_trace()
       self.ensure_one()
       chosen_name = default.get('name') if default else ''
       new_name = chosen_name or _('%s (copy)') % self.name
       default = dict(default or {}, name=new_name)
       return super(Partner, self).copy(default)
   

这是一份命令列表：

h(elp) [command]

如果没有提供参数，则打印可用命令的列表。如果提供了命令作为参数，则打印有关该命令的帮助信息。

pp expression

使用 pprint 模块对 expression 的值进行漂亮的打印。

w(here)

打印堆栈跟踪，最近的帧在底部。

d(own)

将当前帧在堆栈跟踪中向下移动一级（到一个较新的帧）。

u(p)

将当前帧在堆栈跟踪中向上移动一级（到旧帧）。

n(ext)

继续执行，直到当前函数中的下一行被执行或函数返回。

c(ontinue)

继续执行，只有在遇到断点时才停止。

s(tep)

执行当前行。在可能的第一个机会停止（在被调用的函数中或在当前函数的下一行）。

q(uit)

退出调试器。正在执行的程序被中止。