django-modelish 0.1

快速入门

安装django-predicate

pip install django-modelish

然后你可以开始像这样编写模型

Poll:
    doc: This is the poll model
    question:
        type: char
        max_length: 200
    pub_date:
        type: datetime
        args: date published

Choice:
    poll:
        type: fk
        args: [Poll]
    choice_text-char:
        max_length: 200
    votes:
        type: int

然后你只需使用CLI工具

modelish path-to-file.yml

这将生成如下代码

class Poll(models.Model):
    """This is the poll model"""

    pub_date = models.DateTimeField(
        'date published')
    question = models.CharField(
        max_length=200,
        blank=True)

class Choice(models.Model):
    choice_text = models.CharField(
        max_length=200,
        blank=True)
    poll = models.ForeignKey(
        'Poll')
    votes = models.IntegerField()

语法

语法很简单

<ModelName>:
    [doc: docstring]
    <fieldname>[-type-alias]:
        [type: type-alias],
        [args: arglist],
        kwarg: value

字段类型由简短的“类型”别名表示，例如“char”变为“models.CharField”等（请参阅以下语法ish）。

类型可以通过两种方式指定，要么在字段名后跟一个连字符，要么在字段定义中显式声明为“类型”。

模型指定的位置参数以显式列表的形式放在方括号中，或以逗号分隔的字符串形式。

字段定义的剩余部分由kwarg/value对组成。

使用语法ish进行工作

Modelish使用由类型别名和默认值组成的语法。标准类型有

auto: AutoField
bigint: BigIntegerField
bool: BooleanField
char: CharField
date: DateField
datetime: DateTimeField
decimal: DecimalField
email: EmailField
file: FileField
float: FloatField
image: ImageField
int: IntegerField
ip: IPAddressField
gip: GenericIPAddressField
nbool: NullBooleanField
pint: PositiveIntegerField
psint: PositiveSmallIntegerField
slug: SlugField
sint: SmallIntegerField
text: TextField
time: TimeField
url: URLField
fk: ForeignKey
m2m: ManyToManyField
timestamp: DateTimeField

对于每种类型，在语法中定义了一组默认的kwargs作为默认值

defaults:
bool:
    default: true
char:
    max_length: 100
    blank: true
nbool:
    null: true
timestamp:
    auto-now: true

这个默认的语法可以被替换或增强，通过向命令传递自己的yaml文件。使用--grammar来替换默认语法，并使用--extra-grammar来合并并更新默认语法，包括您的添加或更改。

就这些 - 这不是任何一种完整的模型构建器或数据建模工具，它只是一个简单的DSLish引导工具，可以帮助您以更少的输入创建models.py的起点。