Snippet

Dekonstruktion benutzerdefinierter Django-Modellfelder für Migrationen

Beim Erstellen eigener Django-Modellfelder teilt die Implementierung der deconstruct()-Methode dem Migration-Framework mit, wie benutzerdefinierte Argumente in Migrationsdateien serialisiert werden.

snippet.py

python

from django.db import models
from typing import Any, Tuple, Dict
 
class EncryptedCharField(models.CharField):
    def __init__(self, *args: Any, secret_key_name: str = "DEFAULT_KEY", **kwargs: Any) -> None:
        self.secret_key_name = secret_key_name
        super().__init__(*args, **kwargs)
 
    def deconstruct(self) -> Tuple[str, str, list, Dict[str, Any]]:
        name, path, args, kwargs = super().deconstruct()
        kwargs["secret_key_name"] = self.secret_key_name
        return name, path, args, kwargs

django

Erklärung

class EncryptedCharField(models.CharField):

Defines ein benutzerdefiniertes Modellfeld, das von Djangos CharField erbt.

def __init__(self, *args: Any, secret_key_name: str = "DEFAULT_KEY", **kwargs: Any) -> None:

Akzeptiert den eigenen Parameter secret_key_name zusätzlich zu Standard-Field-Argumenten.

def deconstruct(self) -> Tuple[str, str, list, Dict[str, Any]]:

Implementiert die deconstruct-Methode zur Rückgabe von 4 Elementen für die Migrations-Serialisierung.

name, path, args, kwargs = super().deconstruct()

Ruft die dekonstruierten Werte der Elternklasse ab.

kwargs["secret_key_name"] = self.secret_key_name

Fügt den eigenen Parameter in das Keyword-Arguments-Dict ein, damit Migrationen ihn wiederaufbauen können.

Vorheriges Snippet Nächstes Snippet

Mehr Python-Übungen für Fortgeschrittene →

Dekonstruktion benutzerdefinierter Django-Modellfelder für Migrationen

Verwandt