odoo开发规范

2024-06-22 06:36
文章标签 开发 odoo 规范

本文主要是介绍odoo开发规范，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

命名规范

所有模型用tx开头：tx业务，如tx_study

文件名规范

models/<main_model>.py 

views/<main_model>_views.xml 

views/<main_model>_menu.xml 

views/<main_model>_templates.xml 

wizard/<main_transient>.py 

wizard/<main_transient>_views.py 

security/<main_model>_security.xml 

data/<main_model>__data.xml 

report/<print_report_name>_reports.py 

report/<print_report_name>_templates.xml 

  •  下面以tx_study为例：

models/tx_study.py views/tx_study_views.xml 

views/tx_study_menu.xml 

views/tx_study_templates_xml 

wizard/tx_study_wizard.py 

wizard/tx_study_wizard.xml 

security/tx_study_security.xml 

data/tx_study_data.xml 

report/tx_study_something_report.py 

report/tx_study_something_templates.xml

 xml_id命名

  • 视图（view）：<model_name>_ view _ <view_type>,view_type可能的取值有：kanban, form, tree, search等 
  • 动作（action）：action _ <model_name> 
  • 菜单（menu）: menu _ <model_name> 
  • 权限分类(category): module_category_ <category_name> 
  • 权限组(group)：<model_name>_ group _ <group_name>，group_name为组名，可能的 取值包括:user, manager。在权限细分的情况下，可以细分为增删改查，并且具体到页面上 的按钮等。 
  • 记录规则(rule) : <model_name>_ rule _ <concerned_group>，concerned_group 是相关权 限组的缩写，如 (‘user’ for the ‘model_name_group_user’). 报表（report）：report_ <print_report_name>
  • 所有的菜单项统一放在menu.xml文件中
  • 每个菜单项都需要配置权限组  
  • 菜单项要设置sequence，sequence的间隔预留大一些，如10、20、30... ，sequence越小菜单越靠前
  • 每个模型都要配置search视图
  • 动作窗口要指定视图，特别是在模型在同类型的视图中不止有一个时  

例如

<record id="tx_study_view_tree" model="ir.ui.view">... </record> <record id="tx_study_view_form" model="ir.ui.view"> ... </record> <record id="tx_study_view_search" model="ir.ui.view">... </record> <record id="action_tx_study" model="ir.actions.act_window"> .... <field name="view_ids" eval="[(5, 0, 0), (0, 0, {'view_mode': 'tree', 'view_id': ref('tx_study_view_tree')}), 指定tree视图 (0, 0, {'view_mode': 'form', 'view_id': ref('tx_study_view_form')})]"/> 指定form视图 <field name="search_view_id" ref="tx_study_view_search"/> 指定search视图 </record> <menuitem id="menu_tx_study" name="Study" sequence="10" action="action_tx_study" groups="base.group_user"/> <record id="reports_tx_study_something" model="ir.actions.report">... </record> <record model="ir.module.category" id="module_category_Tx_Study">... </record> <record model="res.groups" id="tx_study_user">... </record> <record id="tx_study_rule_public" model="ir.rule">... </record>

权限细分

<!--增删改查--> <record model="res.groups" id="tx_study_read"> <field name="name">Study Read</field> ...</record><record model="res.groups" id="tx_study_write"> <field name="name">Study Write</field>... </record>  <record model="res.groups" id="tx_study_create"> <field name="name">Study Create</field>... </record> <record model="res.groups" id="tx_study_unlink"> <field name="name">Study Delete</field>... </record><!--按钮--> <record model="res.groups" id="tx_study_btn_action_submit"> <field name="name">Study btn Submit</field> ... </record> <button name="action_submit" string="Submit" class="oe_highlight" confirm="Are you sure you want to submit?" type="object" groups="tx_study_btn_action_submit" /> <!--page--> <record model="res.groups" id="tx_study_page_basic_info"> <field name="name">Study Page Basic Info</field> </record> ... <page name="basic" string="Basic "groups="tx_study_page_basic_info"> ... </page>

 

继承xml命名

<record id="tx_study_view_tree_inherit" model="ir.ui.view"> <field name="inherit_id" ref="tx_study.tx_study_view_tree"> ... </record>

权限文件编写

ir.model.access.csv文件：文件名固定

1. id:权限的ID (access+模型名+角色名) 

2. name:权限的name (模型+角色名) 

3. model_id:id;模型的ID (model_+模型名) 

4. group_id:id;群组的ID (模型名+group+用户名) 

5. perm_read:查看权限 

6. perm_write:修改权限 

7. perm_create:增加数据权限

8. perm_unlink:删除权  

id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
access_tx_study_user,tx.study.user,model_tx_study,group_tx_study_user,1,1,1,1权限细分： id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink 
access_01,tx.study,model_tx_study,tx_study_read,1,0,0,0 
access_02,tx.study,model_tx_study,tx_study_write,0,1,0,0 
access_03,tx.study,model_tx_study,tx_study_create,0,0,1,0 
access_04,tx.study,model_tx_study,tx_study_unlink,0,0,0,1  

manifest清单文件编写

模块名，以tx_开头 

author：作者，固定为 广东同欣智能科技有限公司 

website：网址，固定为 Home | 同欣精益 (beauty-lean.com)

version：版本，固定为 当前odoo开发版本 

summary：模块简述，尽可能简洁 

description：模块描述，尽可能全面描述模块功能 

maintainer：运维者，开发者名称 

category：分类

{ 
'name': "tx_study", 'summary': """ study """, 'description': """ study """, 'author': "广东同欣智能科技有限公司", 'website': "https://www.beauty-lean.com/", 'maintainer': "your name" 'category': '', 'version': '16.0.1', 'installable': True, 'depends': ['base'], 'data': [ 'security/ir.model.access.csv', 'views/tx_study_views.xml', 'views/tx_study_menu.xml',  ... ], ... }

 odoo编码规范

官方编码定义顺序

在模型属性中，顺序应为 

1. 私有属性 _name _description _inherit _sql_constraints 

2. 默认方法和 default_get 

3. 字段声明 

4. 计算方法、反向方法和搜索方法的顺序与字段声明相同 

5. 选择方法（用于返回选择字段的计算值的方法） 

6. 约束方法 （） 和 onchange 方法 （ @api.constrains @api.onchange ) 7. CRUD 方法（ORM 覆盖） 

8. 操作方法 

9. 最后，其他商业方法。  

One2Many， Many2Many字段一般以ids作为后缀如：sale_order_line_ids Many2One 一般以_id为后缀如：partner_id, user_id

class TxStudy(models.Model)：_name = 'tx.study' _description = 'Tx Study' _order = 'id desc' def _default_name(self): ... name = field.Char(string='Name', default=_default_name) area = field.Float(string='Area', compute='_compute_area')... @api.depends('width', 'length') def _compute_area(self): ... @api.constrains('name') def _check_name(self): ... @api.onchange('name') def _onchange_name(self): ... def create(self, values):...  def action_validate(self): self.ensure_one() ...def do_something(self): ...

 继承model

class TxStudy(models.Model)： _inherit = 'tx.study'...  

wizard向导：

class TxCreateStudyWizard(models.TransientModel):_name = "tx.create.study.wizard" _description = "Create Study" 

report报表  

class ReportTxStudySomething(models.AbstractModel): _name = 'report.tx_study.something'_description = "Study Something" def _get_report_values(self, docids, data=None): docs = self.env['tx.study'].sudo().browse(docids) docargs = { 'docs': docs, } return docargs

使用write进行赋值，而不是直接用等于。

# 隐式调用

write def action_to_done(self): 

self.state = 'done' 

# 推荐写法， 显式调用 

def action_to_done(self): self.write.({"state": 'done'})

使用ensure_one()确保是单实例方法  

def action_to_record(self): 

self.ensure_one()

这篇关于odoo开发规范的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1083553。

相关文章

基于Python开发电脑定时关机工具

基于Python开发电脑定时关机工具

《基于Python开发电脑定时关机工具》这篇文章主要为大家详细介绍了如何基于Python开发一个电脑定时关机工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 简介2. 运行效果3. 相关源码1. 简介这个程序就像一个“忠实的管家”，帮你按时关掉电脑，而且全程不需要你多做
阅读更多...
Java中的Opencv简介与开发环境部署方法

Java中的Opencv简介与开发环境部署方法

《Java中的Opencv简介与开发环境部署方法》OpenCV是一个开源的计算机视觉和图像处理库,提供了丰富的图像处理算法和工具,它支持多种图像处理和计算机视觉算法,可以用于物体识别与跟踪、图像分割与... 目录1.Opencv简介Opencv的应用2.Java使用OpenCV进行图像操作opencv安装j
阅读更多...
基于Qt开发一个简单的OFD阅读器

基于Qt开发一个简单的OFD阅读器

《基于Qt开发一个简单的OFD阅读器》这篇文章主要为大家详细介绍了如何使用Qt框架开发一个功能强大且性能优异的OFD阅读器,文中的示例代码讲解详细,有需要的小伙伴可以参考一下... 目录摘要引言一、OFD文件格式解析二、文档结构解析三、页面渲染四、用户交互五、性能优化六、示例代码七、未来发展方向八、结论摘要
阅读更多...
在 VSCode 中配置 C++ 开发环境的详细教程

在 VSCode 中配置 C++ 开发环境的详细教程

《在VSCode中配置C++开发环境的详细教程》本文详细介绍了如何在VisualStudioCode（VSCode）中配置C++开发环境,包括安装必要的工具、配置编译器、设置调试环境等步骤,通... 目录如何在 VSCode 中配置 C++ 开发环境：详细教程1. 什么是 VSCode？2. 安装 VSCo
阅读更多...
C#图表开发之Chart详解

C#图表开发之Chart详解

《C#图表开发之Chart详解》C#中的Chart控件用于开发图表功能,具有Series和ChartArea两个重要属性,Series属性是SeriesCollection类型,包含多个Series对... 目录OverviChina编程ewSeries类总结OverviewC#中，开发图表功能的控件是Char
阅读更多...
鸿蒙开发搭建flutter适配的开发环境

鸿蒙开发搭建flutter适配的开发环境

《鸿蒙开发搭建flutter适配的开发环境》文章详细介绍了在Windows系统上如何创建和运行鸿蒙Flutter项目,包括使用flutterdoctor检测环境、创建项目、编译HAP包以及在真机上运... 目录环境搭建创建运行项目打包项目总结环境搭建1.安装 DevEco Studio NEXT IDE
阅读更多...
Python开发围棋游戏的实例代码（实现全部功能）

Python开发围棋游戏的实例代码（实现全部功能）

《Python开发围棋游戏的实例代码（实现全部功能）》围棋是一种古老而复杂的策略棋类游戏,起源于中国,已有超过2500年的历史,本文介绍了如何用Python开发一个简单的围棋游戏,实例代码涵盖了游戏的... 目录1. 围棋游戏概述1.1 游戏规则1.2 游戏设计思路2. 环境准备3. 创建棋盘3.1 棋盘类
阅读更多...
这15个Vue指令，让你的项目开发爽到爆

这15个Vue指令，让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件，按住 Control 和回车键再显示它吗？小菜一碟： <template
阅读更多...
Hadoop企业开发案例调优场景

Hadoop企业开发案例调优场景

需求 （1）需求：从1G数据中，统计每个单词出现次数。服务器3台，每台配置4G内存，4核CPU，4线程。 （2）需求分析： 1G / 128m = 8个MapTask；1个ReduceTask；1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务（4    3    3） HDFS参数调优 （1）修改：hadoop-env.sh export HDFS_NAMENOD
阅读更多...
嵌入式QT开发：构建高效智能的嵌入式系统

嵌入式QT开发：构建高效智能的嵌入式系统

摘要： 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发，详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程，包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发，涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用，以及嵌入式 QT 与硬件设备的交互，包括输入输出设
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2