odoo-addon-jsonifier 17.0.1.0.0.6

此模块为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'}]),
    ],
}

通过传递字段键而不是语言，我们基本上具有与简单解析器相同的行为，同时增加了使用解析器的优势。

解析器的标准用例包括：- 提供字段特定默认值（例如，“”而不是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兼容，并要求将自定义属性放在子字典中。由于通常这些要求是可选的，因此无需添加字段或更改任何代码即可满足新的要求。

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

注意：该模块在14.0.1.5.0版本之前命名为base_jsonify。

目录

鸣谢

作者

• Akretion

• ACSONE

• Camptocamp

贡献者

• 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>

• Simone Orsi <simone.orsi@camptocamp.com>

• Iván Todorovich <ivan.todorovich@camptocamp.com>

• Nguyen Minh Chien <chien@trobz.com>

维护者

此模块由OCA维护。

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

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

欢迎您贡献。要了解如何进行，请访问https://odoo-community.org/page/Contribute。