fallback-property 0.2.0

需求

• Python 3.6+

这是什么？

fallback_property 将一个函数转换为一个属性，并在属性本身未分配值时使用装饰的函数作为后备。内部使用特殊描述符（fallback_property.FallbackDescriptor）。

如何使用？

只需定义一个函数并使用装饰器 fallback_property

from fallback_property import fallback_property

class Foo:

    @fallback_property()
    def fallback_func(self):
        return 7

使用示例（Django）

假设我们有以下模型

from django.db import models


class Pipeline(model.Model):
    @property
    def total_length(self):
        return sum(self.parts.values_list('length', flat=True))


class Parts(models.Model):
    length = models.PositiveIntegerField()
    pipeline = models.ForeignKey(Pipeline, related_name='parts')

调用 pipline.total_length 将始终触发另一个查询，并且当处理多个对象时，成本更高。这可以通过使用 .annotate() 和 fallback_property() 来优化

from django.db import models, QuerySet
from django.db.functions import Coalesce
from django.db.models import Sum
from fallback_property import fallback_property


class PipelineQuerySet(QuerySet):

    def with_total_length(self):
        return self.annotate(
            total_length=Coalesce(
                Sum('parts__length', output_field=models.IntegerField()),
                0,
            )
        )


class Pipeline(model.Model):

    @fallback_property(logging=True)
    def total_length(self):
        return sum(self.parts.values_list('length', flat=True))

现在您可以直接访问 total_length，而不会触发另一个查询或当使用后备函数时收到警告

pipeline = Pipeline.objects.with_total_length().first()
print(pipeline.total_length)

重要：注解值和属性必须具有相同的名称。

from django.db import models, QuerySet
from django.db.functions import Coalesce
from django.db.models import F
from fallback_property import fallback_property


class PartQuerySet(QuerySet):

    def with_owner(self):
        return self.annotate(
            owner=Coalesce(
                F('_owner'),
                F('pipeline__owner'),
                None,
            )
        )


class Pipeline(model.Model):
    owner = models.ForeignKey(User)


class Parts(models.Model):
    _owner = models.ForeignKey(User, blank=True, null=True, on_delete=models.SET_NULL)
    length = models.PositiveIntegerField()
    pipeline = models.ForeignKey(Pipeline, related_name='parts')

    objects = PartQuerySet()

    @fallback_property()
    def owner(self):
        return self._owner or self.pipline.owner


>>> print(Part.objects.with_owner().first().owner)
>>> 1

开发

此项目使用 poetry 来管理所有开发依赖项。

克隆此存储库并运行

poetry install
poetry run pip install django

以创建具有所有依赖项的虚拟环境。

现在您可以使用以下方式运行测试套件

poetry run pytest

此存储库遵循 angular 提交约定。您可以使用 husky 注册一个 pre-commit 钩子来验证您的提交消息。如果您已安装 nodejs，配置已经就绪。只需运行

npm install

并注册 pre-commit 钩子。