Error in Example in Model field reference > Field.choices > Enumeration types

[Lee Hopkins]

The example in the new Field.choices Enumeration types documentation has an error:

class Student(models.Model):

    class YearInSchool(models.TextChoices):
        FRESHMAN = 'FR', _('Freshman')
        SOPHOMORE = 'SO', _('Sophomore')
        JUNIOR = 'JR', _('Junior')
        SENIOR = 'SR', _('Senior')
        GRADUATE = 'GR', _('Graduate')

    year_in_school = models.CharField(
        max_length=2,
        choices=YearInSchool.choices,
        default=YearInSchool.FRESHMAN,
    )

    def is_upperclass(self):
        return self.year_in_school in {YearInSchool.JUNIOR, YearInSchool.SENIOR}

The method is_upperclass() attempts to access the YearInSchool class directly, but cannot. The method should be:

    def is_upperclass(self):
        return self.year_in_school in {self.YearInSchool.JUNIOR, self.YearInSchool.SENIOR}

or:

    def is_upperclass(self):
        return self.year_in_school in {Student.YearInSchool.JUNIOR, Student.YearInSchool.SENIOR}

​https://docs.djangoproject.com/en/3.0/ref/models/fields/#enumeration-types

[Mariusz Felisiak]

​PR

[Mariusz Felisiak <felisiak.mariusz@…>]

In f101681:

Fixed #31313 -- Fixed is_upperclass() example in enumeration types docs.

[Mariusz Felisiak <felisiak.mariusz@…>]

In 59ac25c9:

[3.0.x] Fixed #31313 -- Fixed is_upperclass() example in enumeration types docs.

Backport of f1016814d84b1423cfe0df85644c9870a6bc6b41 from master