odoo13-addon-base-jsonify 13.0.3.2.1

此模块为ORM的每个模型添加一个“jsonify”方法。它作用于当前记录集，需要一个名为“parser”的单一参数，用于指定要提取的字段。

简单解析器的示例

parser = [
    'name',
    'number',
    'create_date',
    ('partner_id', ['id', 'display_name', 'ref'])
    ('line_id', ['id', ('product_id', ['name']), 'price_unit'])
]

为了与odoo api保持一致，jsonify方法始终返回一个对象列表，即使记录集中只有一个元素也是如此。

默认情况下，json中的键是模型中提取的字段名称。如果您需要指定用作键的备用名称，您可以在解析器定义中定义您的映射

parser = [
    'field_name:json_key'
]

parser = [
    'name',
    'number',
    'create_date:creationDate',
    ('partner_id:partners', ['id', 'display_name', 'ref'])
    ('line_id:lines', ['id', ('product_id', ['name']), 'price_unit'])
]

如果您需要以自定义方式解析字段的值，可以传递一个可调用对象或模型上的方法名称

parser = [
    ('name', "jsonify_name")  # method name
    ('number', lambda rec, field_name: rec[field_name] * 2))  # callable
]

此外，该模块在ir.exports对象上提供了一个名为“get_json_parser”的方法，该方法可以从ir.exports配置生成解析器。

对于高级使用，该模块还提供了一些其他功能。它定义了一个简单的“resolver”模型，该模型具有“python_code”字段和resolve函数，以便可以配置任意函数来转换字段或处理结果字典。也可以指定语言来提取任何给定字段的翻译。

要使用这些功能，完整的解析器应遵循以下结构

parser = {
    "resolver": 3,
    "language_agnostic": True,
    "langs": {
        False: [
            {'name': 'description'},
            {'name': 'number', 'resolver': 5},
            ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'display_name'}])
        ],
        'fr_FR': [
            {'name': 'description', 'target': 'descriptions_fr'},
            ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'description', 'target': 'description_fr'}])
        ],
    }
}

将获得具有此结构的结果（注意，翻译字段合并到同一个字典中）

exported_json == {
    "description": "English description",
    "description_fr": "French description, voilà",
    "number": 42,
    "partner": {
        "display_name": "partner name",
        "description_fr": "French description of that partner",
    },
}

注意，解析器可以作为记录集或id传递，以便完全序列化。如果不需要字段翻译，则可以简化版本，但其他功能（如自定义解析器）仍然可用

parser = {
    "resolver": 3,
    "fields": [
            {'name': 'description'},
            {'name': 'number', 'resolver': 5},
            ({'name': 'partner_id', 'target': 'partners'}, [{'name': 'display_name'}]),
    ],
}

通过传递 fields 键而不是 langs，我们本质上具有与简单解析器相同的行为，并且能够使用解析器。

解析器的标准用例包括：- 为字段提供特定默认值（例如，使用 “” 而不是 None） - 转换字段类型（例如，int()） - 为特定导出别名特定字段 - …

简单解析器在导出时简单地转换为完整解析器。

如果提供了全局解析器，则 json_dict 将通过它传递

resolver.resolve(dict, record)

这允许从上下文中添加外部数据或在必要时转换字典。同样，如果为字段提供了解析器，解析器将评估结果。

目标可以通过以‘=list’结束来具有打包器：在这种情况下，结果将被放入列表中。

parser = {
    fields: [
        {'name': 'name'},
        {'name': 'field_1', 'target': 'customTags=list'},
        {'name': 'field_2', 'target': 'customTags=list'},
    ]
}

将产生以下 JSON 结构

{
    'name': 'record_name',
    'customTags': ['field_1_value', 'field_2_value'],
}

预期的用例是与需要同时导出所有翻译参数的 API 兼容，并要求将自定义属性放在子字典中。由于通常这些要求中的一些是可选的，因此可以在不添加字段或更改任何代码的情况下满足新的要求。

请注意，简单解析器导出的值取决于记录的 lang；这与旨在语言无关的完整解析器形成对比。

目录

鸣谢

作者

• Akretion

贡献者

• BEAU Sébastien <sebastien.beau@akretion.com>

• Raphaël Reverdy <raphael.reverdy@akretion.com>

• Laurent Mignon <laurent.mignon@acsone.eu>

• Nans Lefebvre <nans.lefebvre@acsone.eu>

维护者

此模块由 OCA 维护。

OCA，或 Odoo 社区协会，是一个非营利组织，其使命是支持 Odoo 功能的协作开发并推广其广泛应用。

此模块是 GitHub 上的 OCA/server-tools 项目的一部分。

欢迎您贡献力量。有关如何贡献的信息，请访问 https://odoo-community.org/page/Contribute。