Update models.py

src/DjangoBlog-master/oauth/models.py

@@ -1,67 +1,101 @@
-# Create your models here.
+# 定义该应用的数据库模型
 from django.conf import settings
-from django.core.exceptions import ValidationError
+from django.core.exceptions import ValidationError  # 用于数据验证，抛出验证异常
 from django.db import models
-from django.utils.timezone import now
-from django.utils.translation import gettext_lazy as _
+from django.utils.timezone import now  # 获取当前时间，用于时间字段默认值
+from django.utils.translation import gettext_lazy as _  # 用于国际化翻译，支持多语言
 
 
+# 定义OAuthUser模型（存储第三方登录用户与本地用户的关联信息）
 class OAuthUser(models.Model):
+    # 关联本地Django用户模型（允许为空，未绑定本地用户时为null）
+    # on_delete=models.CASCADE：本地用户删除时，关联的OAuthUser记录也随之删除
     author = models.ForeignKey(
         settings.AUTH_USER_MODEL,
-        verbose_name=_('author'),
-        blank=True,
-        null=True,
-        on_delete=models.CASCADE)
+        verbose_name=_('author'),  # 字段显示名（支持国际化）
+        blank=True,  # 表单中允许为空
+        null=True,   # 数据库中允许为null
+        on_delete=models.CASCADE
+    )
+    # 第三方平台的唯一标识（如GitHub的OpenID，不可重复）
     openid = models.CharField(max_length=50)
+    # 第三方平台的用户昵称（支持国际化显示）
     nickname = models.CharField(max_length=50, verbose_name=_('nick name'))
+    # 第三方平台的访问令牌（可选，可为空或空白）
     token = models.CharField(max_length=150, null=True, blank=True)
+    # 第三方平台的用户头像URL（可选，可为空或空白）
     picture = models.CharField(max_length=350, blank=True, null=True)
+    # 第三方登录类型（如'weibo'、'github'，不可为空）
     type = models.CharField(blank=False, null=False, max_length=50)
+    # 第三方平台的用户邮箱（可选，可为空或空白）
     email = models.CharField(max_length=50, null=True, blank=True)
+    # 存储第三方平台返回的额外元数据（如用户其他信息，可选）
     metadata = models.TextField(null=True, blank=True)
+    # 记录创建时间（默认值为当前时间，支持国际化显示）
     creation_time = models.DateTimeField(_('creation time'), default=now)
+    # 记录最后修改时间（默认值为当前时间，支持国际化显示）
     last_modify_time = models.DateTimeField(_('last modify time'), default=now)
 
+    # 定义模型实例的字符串表示（在Admin后台或打印时显示昵称）
     def __str__(self):
         return self.nickname
 
+    # 模型元数据配置
     class Meta:
-        verbose_name = _('oauth user')
-        verbose_name_plural = verbose_name
-        ordering = ['-creation_time']
+        verbose_name = _('oauth user')  # 模型单数显示名（支持国际化）
+        verbose_name_plural = verbose_name  # 模型复数显示名（与单数一致）
+        ordering = ['-creation_time']  # 默认排序：按创建时间倒序（新记录在前）
 
 
+# 定义OAuthConfig模型（存储第三方登录平台的配置信息，如AppKey、AppSecret等）
 class OAuthConfig(models.Model):
+    # 定义第三方登录平台的可选类型（元组格式：(数据库存储值, 显示值)）
     TYPE = (
-        ('weibo', _('weibo')),
-        ('google', _('google')),
-        ('github', 'GitHub'),
-        ('facebook', 'FaceBook'),
-        ('qq', 'QQ'),
+        ('weibo', _('weibo')),    # 微博（支持国际化）
+        ('google', _('google')),  # 谷歌（支持国际化）
+        ('github', 'GitHub'),     # GitHub（固定显示名）
+        ('facebook', 'FaceBook'), # FaceBook（固定显示名）
+        ('qq', 'QQ'),             # QQ（固定显示名）
     )
+    # 第三方平台类型（关联TYPE选项，默认值为'a'，支持国际化显示）
     type = models.CharField(_('type'), max_length=10, choices=TYPE, default='a')
+    # 第三方平台的AppKey（API密钥，不可为空）
     appkey = models.CharField(max_length=200, verbose_name='AppKey')
+    # 第三方平台的AppSecret（密钥，不可为空）
     appsecret = models.CharField(max_length=200, verbose_name='AppSecret')
+    # 第三方登录的回调地址（授权后跳转URL，不可为空，默认值为空字符串）
     callback_url = models.CharField(
         max_length=200,
-        verbose_name=_('callback url'),
-        blank=False,
-        default='')
+        verbose_name=_('callback url'),  # 支持国际化显示
+        blank=False,  # 表单中不允许为空
+        default=''
+    )
+    # 是否启用该第三方登录平台（默认启用，不可为空）
     is_enable = models.BooleanField(
-        _('is enable'), default=True, blank=False, null=False)
+        _('is enable'),  # 支持国际化显示
+        default=True,
+        blank=False,
+        null=False
+    )
+    # 配置创建时间（默认值为当前时间，支持国际化显示）
     creation_time = models.DateTimeField(_('creation time'), default=now)
+    # 配置最后修改时间（默认值为当前时间，支持国际化显示）
     last_modify_time = models.DateTimeField(_('last modify time'), default=now)
 
+    # 自定义数据验证方法（保存前触发，确保同一平台类型只存在一条配置）
     def clean(self):
+        # 筛选条件：平台类型与当前一致，且排除当前记录（编辑时不与自身冲突）
         if OAuthConfig.objects.filter(
                 type=self.type).exclude(id=self.id).count():
+            # 抛出验证异常：提示该平台类型已存在配置
             raise ValidationError(_(self.type + _('already exists')))
 
+    # 定义模型实例的字符串表示（在Admin后台或打印时显示平台类型）
     def __str__(self):
         return self.type
 
+    # 模型元数据配置
     class Meta:
-        verbose_name = 'oauth配置'
-        verbose_name_plural = verbose_name
-        ordering = ['-creation_time']
+        verbose_name = 'oauth配置'  # 模型单数显示名（中文固定）
+        verbose_name_plural = verbose_name  # 模型复数显示名（与单数一致）
+        ordering = ['-creation_time']  # 默认排序：按创建时间倒序（新配置在前）