update textfield with new example

mattmakai · mattmakai · commit 71817d4aefe7 · 2019-10-23T06:41:32.000-04:00
diff --git a/content/pages/examples/django/django-db-models-textfield.markdown b/content/pages/examples/django/django-db-models-textfield.markdown
@@ -329,3 +329,249 @@ class Migration(migrations.Migration):
         ),
     ]
 ```
+
+
+## Example 3 from AuditLog
+[Auditlog](https://github.com/jjkester/django-auditlog)
+([project documentation](https://django-auditlog.readthedocs.io/en/latest/))
+is a [Django](/django.html) app that logs changes to Python objects,
+similar to the Django admin's logs but with more details and
+output formats. Auditlog's source code is provided as open source under the
+[MIT license](https://github.com/jjkester/django-auditlog/blob/master/LICENSE).
+
+[**AuditLog / src / auditlog_tests / models.py**](https://github.com/jjkester/django-auditlog/blob/master/src/auditlog_tests/models.py)
+
+```python
+import uuid
+
+from django.contrib.postgres.fields import ArrayField
+~~from django.db import models
+from auditlog.models import AuditlogHistoryField
+from auditlog.registry import auditlog
+
+from multiselectfield import MultiSelectField
+
+
+@auditlog.register()
+class SimpleModel(models.Model):
+    """
+    A simple model with no special things going on.
+    """
+
+~~    text = models.TextField(blank=True)
+    boolean = models.BooleanField(default=False)
+    integer = models.IntegerField(blank=True, null=True)
+    datetime = models.DateTimeField(auto_now=True)
+
+    history = AuditlogHistoryField()
+
+
+class AltPrimaryKeyModel(models.Model):
+    """
+    A model with a non-standard primary key.
+    """
+
+    key = models.CharField(max_length=100, primary_key=True)
+
+~~    text = models.TextField(blank=True)
+    boolean = models.BooleanField(default=False)
+    integer = models.IntegerField(blank=True, null=True)
+    datetime = models.DateTimeField(auto_now=True)
+
+    history = AuditlogHistoryField(pk_indexable=False)
+
+
+class UUIDPrimaryKeyModel(models.Model):
+    """
+    A model with a UUID primary key.
+    """
+
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+
+~~    text = models.TextField(blank=True)
+    boolean = models.BooleanField(default=False)
+    integer = models.IntegerField(blank=True, null=True)
+    datetime = models.DateTimeField(auto_now=True)
+
+    history = AuditlogHistoryField(pk_indexable=False)
+
+
+class ProxyModel(SimpleModel):
+    """
+    A model that is a proxy for another model.
+    """
+
+    class Meta:
+        proxy = True
+
+
+class RelatedModel(models.Model):
+    """
+    A model with a foreign key.
+    """
+
+    related = models.ForeignKey(to='self', on_delete=models.CASCADE)
+
+    history = AuditlogHistoryField()
+
+
+class ManyRelatedModel(models.Model):
+    """
+    A model with a many to many relation.
+    """
+
+    related = models.ManyToManyField('self')
+
+    history = AuditlogHistoryField()
+
+
+@auditlog.register(include_fields=['label'])
+class SimpleIncludeModel(models.Model):
+    """
+    A simple model used for register's include_fields kwarg
+    """
+
+    label = models.CharField(max_length=100)
+~~    text = models.TextField(blank=True)
+
+    history = AuditlogHistoryField()
+
+
+class SimpleExcludeModel(models.Model):
+    """
+    A simple model used for register's exclude_fields kwarg
+    """
+
+    label = models.CharField(max_length=100)
+~~    text = models.TextField(blank=True)
+
+    history = AuditlogHistoryField()
+
+
+class SimpleMappingModel(models.Model):
+    """
+    A simple model used for register's mapping_fields kwarg
+    """
+
+    sku = models.CharField(max_length=100)
+    vtxt = models.CharField(verbose_name='Version', max_length=100)
+    not_mapped = models.CharField(max_length=100)
+
+    history = AuditlogHistoryField()
+
+
+class AdditionalDataIncludedModel(models.Model):
+    """
+    A model where get_additional_data is defined which allows for logging extra
+    information about the model in JSON
+    """
+
+    label = models.CharField(max_length=100)
+~~    text = models.TextField(blank=True)
+    related = models.ForeignKey(to=SimpleModel, on_delete=models.CASCADE)
+
+    history = AuditlogHistoryField()
+
+    def get_additional_data(self):
+        """
+        Returns JSON that captures a snapshot of additional details of the
+        model instance. This method, if defined, is accessed by auditlog
+        manager and added to each logentry instance on creation.
+        """
+        object_details = {
+            'related_model_id': self.related.id,
+            'related_model_text': self.related.text
+        }
+        return object_details
+
+
+class DateTimeFieldModel(models.Model):
+    """
+    A model with a DateTimeField, used to test DateTimeField
+    changes are detected properly.
+    """
+    label = models.CharField(max_length=100)
+    timestamp = models.DateTimeField()
+    date = models.DateField()
+    time = models.TimeField()
+    naive_dt = models.DateTimeField(null=True, blank=True)
+
+    history = AuditlogHistoryField()
+
+
+class ChoicesFieldModel(models.Model):
+    """
+    A model with a CharField restricted to a set of choices.
+    This model is used to test the changes_display_dict method.
+    """
+    RED = 'r'
+    YELLOW = 'y'
+    GREEN = 'g'
+
+    STATUS_CHOICES = (
+        (RED, 'Red'),
+        (YELLOW, 'Yellow'),
+        (GREEN, 'Green'),
+    )
+
+    status = models.CharField(max_length=1, choices=STATUS_CHOICES)
+    multiselect = MultiSelectField(max_length=3, choices=STATUS_CHOICES, max_choices=3)
+    multiplechoice = models.CharField(max_length=3, choices=STATUS_CHOICES)
+
+    history = AuditlogHistoryField()
+
+
+class CharfieldTextfieldModel(models.Model):
+    """
+    A model with a max length CharField and a Textfield.
+    This model is used to test the changes_display_dict
+    method's ability to truncate long text.
+    """
+
+    longchar = models.CharField(max_length=255)
+~~    longtextfield = models.TextField()
+
+    history = AuditlogHistoryField()
+
+
+class PostgresArrayFieldModel(models.Model):
+    """
+    Test auditlog with Postgres's ArrayField
+    """
+    RED = 'r'
+    YELLOW = 'y'
+    GREEN = 'g'
+
+    STATUS_CHOICES = (
+        (RED, 'Red'),
+        (YELLOW, 'Yellow'),
+        (GREEN, 'Green'),
+    )
+
+    arrayfield = ArrayField(models.CharField(max_length=1, choices=STATUS_CHOICES), size=3)
+
+    history = AuditlogHistoryField()
+
+
+class NoDeleteHistoryModel(models.Model):
+    integer = models.IntegerField(blank=True, null=True)
+
+    history = AuditlogHistoryField(delete_related=False)
+
+
+auditlog.register(AltPrimaryKeyModel)
+auditlog.register(UUIDPrimaryKeyModel)
+auditlog.register(ProxyModel)
+auditlog.register(RelatedModel)
+auditlog.register(ManyRelatedModel)
+auditlog.register(ManyRelatedModel.related.through)
+auditlog.register(SimpleExcludeModel, exclude_fields=['text'])
+auditlog.register(SimpleMappingModel, mapping_fields={'sku': 'Product No.'})
+auditlog.register(AdditionalDataIncludedModel)
+auditlog.register(DateTimeFieldModel)
+auditlog.register(ChoicesFieldModel)
+auditlog.register(CharfieldTextfieldModel)
+auditlog.register(PostgresArrayFieldModel)
+auditlog.register(NoDeleteHistoryModel)
+```
+
diff --git a/content/pages/meta/00-change-log.markdown b/content/pages/meta/00-change-log.markdown
@@ -23,6 +23,8 @@ on GitHub.
   [String Data Type in Python 3](/blog/python-basic-data-types-strings.html).
 * Added new Django code example pages:
     * [django.db.models FileField](/django-db-models-filefield-examples.html)
+* Updated code examples on the following pages:
+    * [django.db.models TextField](/django-db-models-textfield-examples.html)
 * Rewrote some parts of the [Python 2 or 3](/python-2-or-3.html) page to
   make it more clear that 3 is now the mandatory way to get started.
 * Updated [best videos](/best-python-videos.html) page with new EuroPython links.
