Skip to content

Documentation for users.py

sankaku.models.users.BaseUser

Bases: SankakuResponseModel

User profile with a minimum amount of information.

id: int instance-attribute

name: str instance-attribute

avatar: str instance-attribute

avatar_rating: types.Rating instance-attribute


sankaku.models.users.Author

Bases: BaseUser

Model that describes users who are the authors of posts or wiki pages.


sankaku.models.users.User

Bases: BaseUser

User profile model for any user that has an account on website.

level: int instance-attribute

upload_limit: int instance-attribute

created_at: datetime instance-attribute

favs_are_private: bool instance-attribute

avatar: str = Field(alias='avatar_url') class-attribute instance-attribute

post_upload_count: int instance-attribute

pool_upload_count: int instance-attribute

comment_count: int instance-attribute

post_update_count: int instance-attribute

note_update_count: int instance-attribute

wiki_update_count: int instance-attribute

forum_post_count: int instance-attribute

pool_update_count: int instance-attribute

series_update_count: int instance-attribute

tag_update_count: int instance-attribute

artist_update_count: int instance-attribute

last_logged_in_at: Optional[datetime] = None class-attribute instance-attribute

favorite_count: Optional[int] = None class-attribute instance-attribute

post_favorite_count: Optional[int] = None class-attribute instance-attribute

pool_favorite_count: Optional[int] = None class-attribute instance-attribute

vote_count: Optional[int] = None class-attribute instance-attribute

post_vote_count: Optional[int] = None class-attribute instance-attribute

pool_vote_count: Optional[int] = None class-attribute instance-attribute

recommended_posts_for_user: Optional[int] = None class-attribute instance-attribute

subscriptions: List[str] = [] class-attribute instance-attribute


sankaku.models.users.ExtendedUser

Bases: User

Profile of the currently logged-in user.

email: str instance-attribute

hide_ads: bool instance-attribute

subscription_level: int instance-attribute

filter_content: bool instance-attribute

receive_dmails: bool instance-attribute

email_verification_status: str instance-attribute

is_verified: bool instance-attribute

verifications_count: int instance-attribute

blacklist_is_hidden: bool instance-attribute

blacklisted_tags: List[str] instance-attribute

blacklisted: List[str] instance-attribute

mfa_method: int instance-attribute

show_popup_version: Optional[int] instance-attribute

credits: Optional[int] instance-attribute

credits_subs: Optional[int] instance-attribute