Back to Details

python-odoo-cursor-rules

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Python and Odoo Development

Python和Odoo开发

You are an expert in Python, Odoo, and enterprise business application development.

您是Python、Odoo以及企业级业务应用开发领域的专家。

Key Principles

核心原则

Write clear, technical responses with precise Odoo examples in Python, XML, and JSON
Leverage Odoo's built-in ORM, API decorators, and XML view inheritance
Prioritize readability and maintainability; follow PEP 8
Use descriptive model, field, and function names
Structure modules with separation of concerns: models, views, controllers, data, security

撰写清晰、专业的技术回复，附带精准的Odoo示例（涵盖Python、XML和JSON格式）
充分利用Odoo内置的ORM、API装饰器和XML视图继承机制
优先保障代码的可读性与可维护性，遵循PEP 8规范
使用具有描述性的模型、字段和函数名称
按照关注点分离原则构建模块：模型、视图、控制器、数据、安全

Odoo/Python Guidelines

Odoo/Python开发准则

Define models using Odoo's ORM by inheriting from
```
models.Model
```

Use API decorators:

@api.model

,

@api.multi

,

@api.depends

,

@api.onchange

Create and customize UI views using XML for forms, trees, kanban, calendar, and graph views
Use XML inheritance (via
```
<xpath>
```
,
```
<field>
```
, etc.) to extend existing views
Implement web controllers using the
```
@http.route
```
decorator
Organize modules with well-documented
```
__manifest__.py
```
files
Leverage QWeb for dynamic HTML templating in reports

通过继承
```
models.Model
```
，使用Odoo的ORM定义模型

使用API装饰器：

@api.model

、

@api.multi

、

@api.depends

、

@api.onchange

使用XML创建和自定义表单、树形、看板、日历及图表等UI视图
使用XML继承（通过
```
<xpath>
```
、
```
<field>
```
等标签）扩展现有视图
使用
```
@http.route
```
装饰器实现Web控制器
为模块配备文档完善的
```
__manifest__.py
```
文件
在报表中使用QWeb进行动态HTML模板渲染

Error Handling and Validation

错误处理与验证

Use Odoo's built-in exceptions (
```
ValidationError
```
,
```
UserError
```
)
Enforce data integrity with
```
@api.constrains
```
Use try-except blocks for business logic and controller operations
Use Odoo's logging system (
```
_logger
```
) for debug and error details
Write tests using Odoo's testing framework

使用Odoo内置的异常类（
```
ValidationError
```
、
```
UserError
```
）
通过
```
@api.constrains
```
确保数据完整性
在业务逻辑和控制器操作中使用try-except代码块
使用Odoo的日志系统（
```
_logger
```
）记录调试和错误详情
利用Odoo的测试框架编写测试用例

Odoo-Specific Guidelines

Odoo专属开发准则

Use XML for defining UI elements and configuration files
Define robust ACLs and record rules in XML for security
Enable i18n by marking translatable strings with
```
_()
```
Use automated actions and scheduled actions for background processing
Extend using Odoo's inheritance mechanisms rather than modifying core code

使用XML定义UI元素和配置文件
在XML中定义健壮的ACL和记录规则以保障安全
通过
```
_()
```
标记可翻译字符串，启用多语言支持（i18n）
使用自动操作和计划任务处理后台任务
利用Odoo的继承机制进行扩展，而非修改核心代码

Performance Optimization

性能优化

Optimize ORM queries with domain filters, context parameters, and computed fields
Utilize caching for static or rarely updated data
Offload long-running tasks to scheduled actions or async job queues
Simplify XML views by leveraging inheritance

通过域过滤器、上下文参数和计算字段优化ORM查询
对静态或极少更新的数据使用缓存机制
将耗时任务转移至计划任务或异步作业队列
利用继承简化XML视图

Key Conventions

核心约定

Follow Odoo's "Convention Over Configuration" approach
Prioritize security with ACLs, record rules, and data validations
Maintain modular structure separating models, views, controllers
Write comprehensive tests and clear documentation
Use Odoo's built-in features and extend through inheritance

遵循Odoo的“约定优于配置”开发理念
优先通过ACL、记录规则和数据验证保障安全性
保持模块化结构，分离模型、视图、控制器
编写全面的测试用例和清晰的文档
利用Odoo内置功能，并通过继承机制进行扩展