My favorites | 中文(简体) | Sign in

User 类

User 类的实例代表具有 Google 帐户的一个用户。

Usergoogle.appengine.api.users 模块提供。

简介

User 类的一个实例代表具有 Google 帐户的一个用户。通过在没有参数的情况下调用构造函数或调用 users.get_current_user() 函数,应用程序可获取代表当前登录到该应用程序的用户的 User 实例。如果该当前用户未登录,User 构造函数将抛出 UserNotFoundError。(如果该用户未登录,users.get_current_user() 将不会抛出异常。)

User 对象是可比较的。如果两个 User 对象相同,那么这两个对象代表同一用户。

User 对象可以是数据库实体属性的值。请参阅类型和 Property 类

注意:用户可以更改 Google 帐户的电子邮件地址。请参阅 User 对象中的注释。

构造函数

class User(email=None)

代表具有 Google 帐户的用户。

参数:

email

期望的用户的电子邮件地址。如果忽略此项,该对象将代表当前用户(发出请求的用户)。如果未指定任何电子邮件地址,且当前用户未登录,将抛出 UserNotFoundError

创建 User 对象时,不会检查该电子邮件地址是否有效。如果 User 对象具有的电子邮件地址与有效 Google 帐户不相符,则该 User 对象仍可存储在数据库中,但其永远不会与真正的用户相匹配。

实例方法

User 实例可提供以下方法:

nickname()

返回用户的 [昵称],这是一个可显示的名称。用户更改其昵称的功能尚未实现,但应用程序目前可使用此功能更改可显示的名称并能通过实现此功能获益。

对于没有自定义昵称的用户,如果用户的电子邮件地址与应用程序位于同一域内,则其昵称将为该电子邮件地址的 [名称] 部分,否则将为该用户的完整电子邮件地址。

email()

返回用户的电子邮件地址。应用程序应使用昵称作为可显示的名称。