Skip to content

base

django_spire.contrib.seeding.model.base

classproperty

Source code in django_spire/contrib/seeding/model/base.py 
17
18
def __init__(self, fget: Any) -> None:
    self.fget = fget

fget = fget instance-attribute

__get__

Source code in django_spire/contrib/seeding/model/base.py 
20
21
def __get__(self, instance: Any, owner: Any) -> Any:
    return self.fget(owner)

BaseModelSeeder

Bases: ABC

model_class = None class-attribute instance-attribute

fields = None class-attribute instance-attribute

field_config_class = FieldsConfig class-attribute instance-attribute

default_to = 'llm' class-attribute instance-attribute

cache_seed = True class-attribute instance-attribute

cache_name = 'model_seeder' class-attribute instance-attribute

cache_limit = 1000 class-attribute instance-attribute

override_class = FieldOverride class-attribute instance-attribute

override

Source code in django_spire/contrib/seeding/model/base.py 
41
42
43
@classproperty
def override(cls) -> FieldOverride:
    return cls.override_class(seeder_class=cls)

get_field_config classmethod

Source code in django_spire/contrib/seeding/model/base.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@classmethod
def get_field_config(cls) -> FieldsConfig:
    if cls._field_config is None:
        if cls.model_class is None:
            message = 'model_class must be defined before using seeder.'
            raise ValueError(message)

        raw_fields = cls.__dict__.get('fields', {})

        cls._field_config = cls.field_config_class(
            raw_fields=raw_fields,
            field_names=cls.field_names(),
            default_to=cls.default_to,
            model_class=cls.model_class,
        )

    return cls._field_config

resolved_fields classmethod

Source code in django_spire/contrib/seeding/model/base.py 
63
64
65
@classmethod
def resolved_fields(cls) -> dict:
    return cls.get_field_config().fields

clear_cache classmethod

Source code in django_spire/contrib/seeding/model/base.py 
67
68
69
@classmethod
def clear_cache(cls) -> None:
    SqliteCache.clear(cache_name=cls.cache_name)

field_names abstractmethod classmethod

Source code in django_spire/contrib/seeding/model/base.py 
71
72
73
74
@classmethod
@abstractmethod
def field_names(cls) -> list[str]:
    pass

seed_data classmethod

Source code in django_spire/contrib/seeding/model/base.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@classmethod
@recorder_to_html_file('model_seeder')
def seed_data(
    cls,
    count: int = 1,
    fields: dict | None = None,
) -> list[dict]:
    field_config = (
        cls.get_field_config().override(fields)
        if fields
        else cls.get_field_config()
    )

    if cls.cache_seed:
        cache_key = generate_cache_key(
            cls.seed_data, count=count, fields=field_config.fields
        )

        cache = SqliteCache(cache_name=cls.cache_name, limit=cls.cache_limit)
        formatted_seed_data = cache.get(cache_key)

        if formatted_seed_data:
            return formatted_seed_data

    seed_data = []

    for seeder_cls in cls._field_seeders:
        seeder = seeder_cls(field_config.fields, field_config.default_to)

        if len(seeder.seeder_fields) > 0:
            seed_data.append(seeder.seed(cls, count))

    formatted_seed_data = [
        {} for _ in range(max(len(sublist) for sublist in seed_data))
    ]
    for sublist in seed_data:
        for i, d in enumerate(sublist):
            formatted_seed_data[i].update(d)

    if cls.cache_seed:
        cache.set(cache_key, formatted_seed_data)

    return formatted_seed_data

seed classmethod

Source code in django_spire/contrib/seeding/model/base.py 
120
121
122
123
124
125
126
127
128
@classmethod
def seed(
    cls,
    count: int = 1,
    fields: dict | None = None,
) -> list:
    return [
        cls.model_class(**seed_data) for seed_data in cls.seed_data(count, fields)
    ]