如何在Django CMS外部为Page/Title模型添加自定义属性方法？

问题背景 #

Django CMS文档明确包含扩展Page和Title模型的流程，但未提及如何为这些模型添加自定义@property方法。直接修改CMS自带的Page模型虽能生效，但属于不推荐的侵入式修改。

具体需求 #

需要在CMS应用外部，为cms.models.pagemodel.Page（或Title模型，流程一致）添加如下自定义属性方法：

@property
def my_custom_page_property(self):
    try:
        logger.info(f'Working....')
        return {}

    except Exception as e:
        logger.error(f'Error: {e}')
        return {}

尝试过的方案 #

在独立应用中创建了PageExtension子类，其中关联的image字段可正常使用，但自定义的@property方法无返回值：

from cms.extensions import PageExtension
from cms.extensions.extension_pool import extension_pool
from django.db import models
from your_image_app.models import Image

class MyCustomExtension(PageExtension):
    image = models.ForeignKey(Image,
                              on_delete=models.SET_DEFAULT,
                              default=None,
                              blank=True,
                              null=True)

    @property
    def my_custom_page_property(self):
        # 此处逻辑无法通过Page实例直接访问生效
        try:
            logger.info(f'Working....')
            return {}
        except Exception as e:
            logger.error(f'Error: {e}')
            return {}

extension_pool.register(MyCustomExtension)

解决方法 #

PageExtension是与Page关联的扩展模型，你定义的@property属于扩展实例而非Page实例本身。要让Page实例能直接访问该属性，可采用以下两种方案：

方案1：通过扩展实例直接访问 #

从Page实例获取关联的扩展对象后，调用其属性：

# 示例：获取Page实例并访问扩展属性
page = Page.objects.get(pk=1)
custom_property_value = page.my_customextension.my_custom_page_property

注：my_customextension是扩展类名转为小写后的默认关联名，若定义扩展时指定了related_name，需替换为对应名称。

方案2：为Page模型动态添加代理属性（推荐） #

通过应用启动时的钩子，将扩展的属性代理到Page模型上，实现直接访问：

1. 在应用的apps.py中添加配置：

from django.apps import AppConfig
from cms.models.pagemodel import Page
from .models import MyCustomExtension

class YourAppConfig(AppConfig):
    name = 'your_app_name'

    def ready(self):
        # 定义代理属性的获取方法
        def get_my_custom_property(self):
            try:
                return self.my_customextension.my_custom_page_property
            except MyCustomExtension.DoesNotExist:
                # 处理扩展未创建的情况，返回默认值
                return {}

        # 为Page模型添加属性
        if not hasattr(Page, 'my_custom_page_property'):
            Page.my_custom_page_property = property(get_my_custom_property)

2. 在应用的__init__.py中指定配置类：

default_app_config = 'your_app_name.apps.YourAppConfig'

关键注意事项 #

• 必须确保MyCustomExtension已通过extension_pool.register()注册
• 处理扩展不存在的异常，避免运行时抛出DoesNotExist错误
• 若使用自定义related_name，需同步修改代理方法中的关联名称

内容的提问来源于stack exchange，提问作者sitWolf