如何修改Django中Python Social Auth的GitHub认证以使用主邮箱？

方法1：自定义Pipeline函数 #

Python Social Auth的pipeline支持自定义用户数据处理逻辑，你可以添加一个步骤来筛选GitHub返回的邮箱列表，仅保留标记为primary的主邮箱。

1. 在你的Django项目中创建yourapp/pipeline.py文件，添加以下函数：

def get_primary_email(backend, user, response, details, *args, **kwargs):
    # 仅针对GitHub认证场景处理
    if backend.name == 'github':
        # 从GitHub返回的邮箱列表中筛选主邮箱
        emails = response.get('emails', [])
        primary_email = next((email['email'] for email in emails if email.get('primary')), None)
        if primary_email:
            # 更新用户邮箱并保存
            user.email = primary_email
            user.save()
    return kwargs

2. 在项目settings.py中更新SOCIAL_AUTH_PIPELINE配置，将自定义函数插入到合适的执行位置（推荐放在social_core.pipeline.user.user_details之后）：

SOCIAL_AUTH_PIPELINE = (
    'social_core.pipeline.social_auth.social_details',
    'social_core.pipeline.social_auth.social_uid',
    'social_core.pipeline.social_auth.auth_allowed',
    'social_core.pipeline.social_auth.social_user',
    'social_core.pipeline.user.get_username',
    'social_core.pipeline.user.create_user',
    'social_core.pipeline.social_auth.associate_user',
    'social_core.pipeline.social_auth.load_extra_data',
    'social_core.pipeline.user.user_details',
    # 插入自定义pipeline函数
    'yourapp.pipeline.get_primary_email',
)

方法2：自定义用户详情策略 #

通过覆盖默认的用户详情策略，直接修改邮箱获取逻辑：

1. 创建yourapp/strategies.py文件，定义自定义策略类：

from social_core.strategies.django_strategy import DjangoStrategy

class PrimaryEmailDjangoStrategy(DjangoStrategy):
    def user_details(self, response, details, backend, user=None, *args, **kwargs):
        details = super().user_details(response, details, backend, user, *args, **kwargs)
        if backend.name == 'github':
            emails = response.get('emails', [])
            # 优先取主邮箱，无主邮箱则保留原邮箱值
            primary_email = next((email['email'] for email in emails if email.get('primary')), details.get('email'))
            details['email'] = primary_email
        return details

2. 在settings.py中指定使用该策略：

SOCIAL_AUTH_STRATEGY = 'yourapp.strategies.PrimaryEmailDjangoStrategy'

关键注意事项 #

• 确保GitHub OAuth应用已申请user:email权限：在GitHub应用设置的Scopes中勾选user:email，同时在settings.py中配置：

SOCIAL_AUTH_GITHUB_SCOPE = ['user:email']

• 测试前请清除已关联的GitHub账号，重新完成认证流程验证效果。

内容的提问来源于stack exchange，提问作者Tiago Peres