odoo-development-environment-tutorial

建立 odoo 開發環境 ( source code )

本篇文章將教大家如何使用 odoo source code 建立開發環境,

如果你想要用 docker 建立, 可參考利用 docker 快速建立 odoo 環境.

延伸閱讀手把手教大家撰寫 odoo 的 addons - 進階篇

Prepare

需要準備 Ubuntu 18.04 + odoo (source code) + postgresql + wkhtmltopdf + VS Code。

odoo 我們留在最後再安裝:smile:

Ubuntu 18.04

前面說過了, 不推薦 Windows 開發環境, 你會被 debug 搞死, 相信我:smirk:

而且會遇到不少很怪的問題。

注意:exclamation::exclamation: 如果你是使用 Ubuntu 20.04, 預設的 python 是 3.8,

對 odoo 來說太新了, 安裝會有很多問題, 建議安裝 python3.6 (這版本裝 odoo 比較好建立環境)

sudo apt-get install -y python3.6-venv

postgresql

這邊你可以選擇安裝到本機, 但我自己是喜歡把 db 這部份安裝到 docker,

docker-compose.yml

version: '3.5'
services:

  db:
    image: postgres:10.9
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_DB=postgres
      - POSTGRES_USER=odoo
      - POSTGRES_PASSWORD=odoo
      - PGDATA=/var/lib/postgresql/data/pgdata
    volumes:
      - odoo-db-data:/var/lib/postgresql/data/pgdata

volumes:
  odoo-db-data:

直接執行 docker-compose up 即可, 也可以讓他在背景跑 docker-compose up -d。

然後建議依照在 Linux 中自動啟動 docker 讓他開機自動啟動。

(這樣就不用每次都要去啟動 db 了)

pgadmin4

可參考利用 docker 快速建立 pgadmin4 以及 Ubuntu 本機如何安裝 pgadmin4

建議把 postgresql-client-12 安裝起來, 不然 odoo 可能無法還原備份 db.

sudo apt install postgresql-client-12

這邊提醒一下, 主要是看你的 postgresql 是使用哪個版本的,

如果你同時安裝了 postgresql12 以及 postgresql13,

你就再安裝 sudo apt install postgresql-client-13.

可以到 /usr/share/postgresql 確認你安裝了哪些版本.

wkhtmltopdf

尋找對應的版本安裝即可 wkhtmltopdf

wkhtmltopdf --version

這邊推薦的版本為 0.12.5。

如果你在 odoo 列印 PDF 時, 遇到以下的錯誤

Wkhtmltopdf failed (error code: -8). Message: b'' error

這是字型的問題, 請安裝字型

sudo apt install ttf-mscorefonts-installer

odoo

clone odoo repo

git clone https://github.com/odoo/odoo.git

確認是否為 odoo 13 branch ( 預設為 odoo 13 )

接著不要急, 來建立 odoo python 環境

python3 -m venv odoo13

如果出現以下錯誤,

請安裝 python3-venv

sudo apt-get install python3-venv

然後再次執行 python3 -m venv odoo13 即可。

接著啟動環境,

source odoo13/bin/activate

接著是安裝 requirements.txt ( 這個檔案在 odoo 的 source code 中 )

pip3 install -r requirements.txt

我會建議安裝 requirements.txt 前, 先把 wheel 裝起來

pip3 install wheel

安裝 requirements.txt 時, 可能會出現類似下面的錯誤訊息。

可能出現的錯誤一,

error: command 'x86_64-linux-gnu-gcc' failed with exit status 1

執行以下指令即可, 可參考 issues/2115

sudo apt-get install python3 python-dev python3-dev \
     build-essential libssl-dev libffi-dev \
     libxml2-dev libxslt1-dev zlib1g-dev \
     python-pip

這邊補充一下, 建議依照你的 python 版本安裝, 例如你今天安裝了 python3.8,

就執行 sudo apt-get install python3.8-dev

以此類推.

可能出現的錯誤二,

python-ldap 安裝失敗,執行以下指令即可,

sudo apt-get install libsasl2-dev python-dev libldap2-dev libssl-dev

可能出現的錯誤三,

有時候 psycopg2 會安裝失敗(odoo15), 建議可以改安裝 psycopg2-binary.

pip3 install psycopg2-binary

可能出現的錯誤四,

有時候更新 python 時 (自己遇過一次), 某個套件竟然自己壞了,

錯誤訊息如下,

ImportError: /python3.6/site-packages/lxml/etree.cpython-36m-x86_64-linux-gnu.so: undefined symbol: PyFPE_jbuf

解法方法,

pip3 install --upgrade --force-reinstall --no-binary :all: lxml==3.7.1

基本上到這邊可以稍微休息一下。

解決後再重新安裝 requirements.txt 即可。

設定 odoo 環境

先確認 db 有啟動。

設定 odoo.conf, 我會建議建立一個資料夾, 比較好維護,

[options]
addons_path = /home/twtrubiks/work/odoo13/addons
data_dir = /home/twtrubiks/Downloads/odoo-git/odoo-data
db_host = localhost

addons_path 就是 addons 的位置，通常都會有很多，使用逗號隔開即可。

( 我自己是都會給 addons 權限 sudo chmod -R 777 folder , 因為之前有踩過雷 )

data_dir 保存 odoo 資料夾。

db_host 為 db 的 host。

執行以下指令

python3 odoo-bin -w odoo -r odoo -c /home/twtrubiks/work/odoo13/config/odoo.conf

-w db_password。

-r db_user。

-c config 路徑。當然, 你也可以不要用 config , 直接在 command 中下設定。

更多可參考 Command-line interface: odoo-bin。

瀏覽 http://0.0.0.0:8069/, 成功看到畫面了,

Odoo VSCode Debug

Youtube Tutorial - 如何在 VS Code 中 Debug - odoo13

開發環境非常建議使用 Linux , 我使用 Ubuntu 18.04。

( 注意, windows 用戶需要做其他的設定, 否則你會發現無論如何啟用 debug 時, 都會直接關閉 )

如果不懂 VSCode, 可參考 Python in Visual Studio Code。

VSCode 的設定可參考 launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "odoo",
            "type": "python",
            "request": "launch",
            // "stopOnEntry": true,
            "pythonPath": "/home/twtrubiks/Documents/venv/odoo13/bin/python3",
            "program": "${workspaceFolder}/odoo-bin",
            "args": [
                "-w",
                "odoo",
                "-r",
                "odoo",
                // "-d",
                // "odoo",
                "-c",
                "/home/twtrubiks/work/odoo13/config/odoo.conf"
            ]
        }
    ]
}

pythonPath 設定 python 環境 ( venv 的位置 )。

program odoo-bin 的位置。

-d 指定 odoo database。

先把 Expense (hr_expense) 裝起來 (我們將使用它來測試中斷點)，

建立中斷點，中斷位置是 addons/hr_expense/models/hr_expense.py 裡的 def create (當建立檔案時, 會進入這個 function 中)

開啟 VSCode debug ( 快捷按鍵 F5 ),

到 odoo 中建立一筆 hr_expense, 當你要產生一筆 sheet 時,

成功進入中斷點

說明 dbfilter

這邊特別說明一下 odoo.conf 中的 dbfilter

[options]
......
;The '^' means start of line and the '$' end of line,
;so '^%d$' only filter db with name 'hostname' following the example.
;dbfilter = ^%d$

簡單說, 就是可以透過 dbfilter 去選擇(濾)對應的 db (透過網址),

因為一個 odoo 可以有非常多的 db, 但你可能不想讓A客戶看到B客戶的資料庫,

就很適合使用 dbfilter 這個參數.

dbfilter = ^%d$ 這個 ^ 代表的是開始的符號, $ 代表的是結束的符號.

所以如果今天這樣設定, db 名稱有, twtrubiks twtrubiks01 twtrubiks02,

然後你的網址是 www.twtrubiks.com, 當你進去網址時, 只會看到 twtrubiks 這個 db:exclamation:

如果你也想看到 twtrubiks01 twtrubiks02, 這樣要改成 dbfilter = ^%d

也就是把 $ 拿掉.

看文字說明可能很複雜:scream: 大家可以自己玩玩看, 其實是不難的哦:smile:

延伸閱讀手把手教大家撰寫 odoo 的 addons - 進階篇

Reference

Donation

文章都是我自己研究內化後原創，如果有幫助到您，也想鼓勵我的話，歡迎請我喝一杯咖啡:laughing:

綠界科技ECPAY ( 不需註冊會員 )

贊助者付款

歐付寶 ( 需註冊會員 )