Redditor¶

class asyncpraw.models.Redditor(reddit, name=None, fullname=None, _data=None)¶

A class representing the users of Reddit.

Typical Attributes

Note

This table describes attributes that typically belong to objects of this class. Async PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, Async PRAW makes no effort to document any new/removed/changed attributes, other than to instruct you on how to discover what is available. As a result, this table of attributes may not be complete. See Determine Available Attributes of an Object for detailed information.

If you would like to add an attribute to this table, feel free to open a pull request.

Note

Shadowbanned accounts are treated the same as non-existent accounts, meaning that they will not have any attributes.

Note

Suspended/banned accounts will only return the name and is_suspended attributes.

Attribute	Description
`comment_karma`	The comment karma for the `Redditor`.
`comments`	Provide an instance of `SubListing` for comment access.
`submissions`	Provide an instance of `SubListing` for submission access.
`created_utc`	Time the account was created, represented in Unix Time.
`has_verified_email`	Whether or not the `Redditor` has verified their email.
`icon_img`	The url of the Redditors’ avatar.
`id`	The ID of the `Redditor`.
`is_employee`	Whether or not the `Redditor` is a Reddit employee.
`is_friend`	Whether or not the `Redditor` is friends with the authenticated user.
`is_mod`	Whether or not the `Redditor` mods any subreddits.
`is_gold`	Whether or not the `Redditor` has active Reddit Premium status.
`is_suspended`	Whether or not the `Redditor` is currently suspended.
`link_karma`	The link karma for the `Redditor`.
`name`	The Redditor’s username.
`subreddit`	If the `Redditor` has created a user-subreddit, provides a `UserSubreddit` with additional attributes.

Parameters:

reddit (asyncpraw.Reddit)
name (str | None)
fullname (str | None)
_data (dict[str, Any] | None)

__init__(reddit, name=None, fullname=None, _data=None)¶

Initialize a Redditor instance.

Parameters:

reddit (Reddit) – An instance of Reddit.
name (str | None) – The name of the redditor.
fullname (str | None) – The fullname of the redditor, starting with t2_.
_data (dict[str, Any] | None)

Return type:

None

Exactly one of name, fullname or _data must be provided.

await block()¶

Block the Redditor.

For example, to block Redditor u/spez:

redditor = await reddit.redditor("spez")
await redditor.block()

Note

Blocking a trusted user will remove that user from your trusted list.

See also

trust()

Return type:: None

comments()¶

Provide an instance of SubListing for comment access.

For example, to output the first line of all new comments by u/spez try:

redditor = await reddit.redditor("spez")
async for comment in redditor.comments.new(limit=None):
    print(comment.body.split("\\n", 1)[0][:79])

Return type:: SubListing

controversial(*, time_filter='all', **generator_kwargs)¶

Return a ListingGenerator for controversial items.

Parameters:

time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year" (default: "all").
generator_kwargs (Unpack[ListingGeneratorKwargs])

Raises:

ValueError if time_filter is invalid.

Return type:

AsyncIterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").controversial(time_filter="week")

multireddit = await reddit.multireddit(redditor="samuraisam", name="programming")
multireddit.controversial(time_filter="day")

redditor = await reddit.redditor("spez")
redditor.controversial(time_filter="month")

redditor = await reddit.redditor("spez")
redditor.comments.controversial(time_filter="year")

redditor = await reddit.redditor("spez")
redditor.submissions.controversial(time_filter="all")

subreddit = await reddit.subreddit("all")
subreddit.controversial(time_filter="hour")

property created_datetime: datetime¶

Return the creation time as a timezone-aware datetime.datetime.

The returned object is localized to the system’s timezone.

await distrust()¶

Remove the Redditor from your whitelist of trusted users.

For example, to remove Redditor u/spez from your whitelist:

redditor = await reddit.redditor("spez")
await redditor.distrust()

See also

trust()

Return type:: None

downvoted(**generator_kwargs)¶

Return a ListingGenerator for items the user has downvoted.

Return type:: AsyncIterator[Comment | Submission]
Returns:: A ListingGenerator object which yields Comment or Submission objects the user has downvoted.
Raises:: asyncprawcore.Forbidden if the user is not authorized to access the list.

Note

Since this function returns a ListingGenerator the exception may not occur until sometime after this function has returned.
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

Additional keyword arguments are passed in the initialization of ListingGenerator.

For example, to get all downvoted items of the authenticated user:

current_user = await reddit.user.me()
async for item in current_user.downvoted():
    print(item.id)

await friend(*, note=None)¶

Friend the Redditor.

Parameters:: note (str | None) – A note to save along with the relationship. Requires Reddit Premium (default: None).
Return type:: None

Calling this method subsequent times will update the note.

For example, to friend u/spez:

redditor = await reddit.redditor("spez")
await redditor.friend()

To add a note to the friendship (requires Reddit Premium):

redditor = await reddit.redditor("spez")
await redditor.friend(note="My favorite admin")

await friend_info()¶

Return a Redditor instance with specific friend-related attributes.

Return type:: Redditor
Returns:: A Redditor instance with fields date, id, and possibly note if the authenticated user has Reddit Premium.

For example, to get the friendship information of Redditor u/spez:

redditor = await reddit.redditor("spez")
info = await redditor.friend_info
friend_data = info.date

classmethod from_data(reddit, data)¶

Return an instance of Redditor, or None from data.

Return type:

Redditor | None

Parameters:

reddit (Reddit)
data (str)

property fullname: str¶

Return the object’s fullname.

A fullname is an object’s kind mapping like t3 followed by an underscore and the object’s base36 ID, e.g., t1_c5s96e0.

hidden(**generator_kwargs)¶

Return a ListingGenerator for items the user has hidden.

Return type:: AsyncIterator[Comment | Submission]
Returns:: A ListingGenerator object which yields Comment or Submission objects the user has hid.
Raises:: asyncprawcore.Forbidden if the user is not authorized to access the list.

Note

Since this function returns a ListingGenerator the exception may not occur until sometime after this function has returned.
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

Additional keyword arguments are passed in the initialization of ListingGenerator.

For example, to get all hidden items of the authenticated user:

current_user = await reddit.user.me()
async for item in current_user.hidden():
    print(item.id)

hot(**generator_kwargs)¶

Return a ListingGenerator for hot items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").hot()

multireddit = await reddit.multireddit(redditor="samuraisam", name="programming")
multireddit.hot()

redditor = await reddit.redditor("spez")
redditor.hot()

redditor = await reddit.redditor("spez")
redditor.comments.hot()

redditor = await reddit.redditor("spez")
redditor.submissions.hot()

subreddit = await reddit.subreddit("all")
subreddit.hot()

Return type:: AsyncIterator[Any]
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

await load()¶

Re-fetches the object.

This is used to explicitly fetch or re-fetch the object from reddit. This method can be used on any RedditBase object.

await reddit_base_object.load()

Return type:: None

await message(*, from_subreddit=None, message, subject)¶

Send a message to a Redditor or a Subreddit’s moderators (modmail).

Parameters:

from_subreddit (Subreddit | str | None) –
A Subreddit instance or string to send the message from. When provided, messages are sent from the subreddit rather than from the authenticated user.

Note

The authenticated user must be a moderator of the subreddit and have the mail moderator permission.
message (str) – The message content.
subject (str) – The subject of the message.

Return type:

None

For example, to send a private message to u/spez, try:

redditor = await reddit.redditor("spez", fetch=False)
await redditor.message(subject="TEST", message="test message from Async PRAW")

To send a message to u/spez from the moderators of r/test try:

redditor = await reddit.redditor("spez", fetch=False)
await redditor.message(
    subject="TEST", message="test message from r/test", from_subreddit="test"
)

To send a message to the moderators of r/test, try:

subreddit = await reddit.subreddit("test")
await subreddit.message(subject="TEST", message="test PM from Async PRAW")

await moderated()¶

Return a list of the redditor’s moderated subreddits.

Return type:: list[Subreddit]
Returns:: A list of Subreddit objects. Return [] if the redditor has no moderated subreddits.
Raises:: asyncprawcore.ServerError in certain circumstances. See the note below.

Note

The redditor’s own user profile subreddit will not be returned, but other user profile subreddits they moderate will be returned.

Usage:

redditor = await reddit.redditor("spez")
async for subreddit in redditor.moderated():
    print(subreddit.display_name)
    print(subreddit.title)

Note

A asyncprawcore.ServerError exception may be raised if the redditor moderates a large number of subreddits. If that happens, try switching to read-only mode. For example,

reddit.read_only = True
redditor = await reddit.redditor("reddit")
async for subreddit in redditor.moderated():
    print(str(subreddit))

It is possible that requests made in read-only mode will also raise a asyncprawcore.ServerError exception.

When used in read-only mode, this method does not retrieve information about subreddits that require certain special permissions to access, e.g., private subreddits and premium-only subreddits.

See also

User.moderator_subreddits()

await multireddits()¶

Return a list of the redditor’s public multireddits.

For example, to to get Redditor u/spez’s multireddits:

redditor = await reddit.redditor("spez")
multireddits = await redditor.multireddits()

Return type:: list[Multireddit]

new(**generator_kwargs)¶

Return a ListingGenerator for new items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").new()

multireddit = await reddit.multireddit(redditor="samuraisam", name="programming")
multireddit.new()

redditor = await reddit.redditor("spez")
redditor.new()

redditor = await reddit.redditor("spez")
redditor.comments.new()

redditor = await reddit.redditor("spez")
redditor.submissions.new()

subreddit = await reddit.subreddit("all")
subreddit.new()

Return type:: AsyncIterator[Any]
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

notes()¶

Provide an instance of RedditorModNotes.

This provides an interface for managing moderator notes for a redditor.

Note

The authenticated user must be a moderator of the provided subreddit(s).

For example, all the notes for u/spez in r/test can be iterated through like so:

redditor = await reddit.redditor("spez")

async for note in redditor.notes.subreddits("test"):
    print(f"{note.label}: {note.note}")

Return type:: RedditorModNotes

overview()¶

Provide an instance of SubListing for overview access.

The overview combines a Redditor’s comments and submissions, mirroring the user overview page on Reddit.

For example, to output the first line of all top items by u/spez try:

redditor = await reddit.redditor("spez")
async for item in redditor.overview.top(time_filter="all"):
    print(str(item)[:79])

Return type:: SubListing

classmethod parse(data, reddit)¶

Return an instance of cls from data.

Parameters:

data (dict[str, Any]) – The structured data.
reddit (Reddit) – An instance of Reddit.

Return type:

AsyncPRAWBase

saved(**generator_kwargs)¶

Return a ListingGenerator for items the user has saved.

Return type:: AsyncIterator[Comment | Submission]
Returns:: A ListingGenerator object which yields Comment or Submission objects the user has saved.
Raises:: asyncprawcore.Forbidden if the user is not authorized to access the list.

Note

Since this function returns a ListingGenerator the exception may not occur until sometime after this function has returned.
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

Additional keyword arguments are passed in the initialization of ListingGenerator.

For example, to get all saved items of the authenticated user:

current_user = await reddit.user.me()
async for item in current_user.saved(limit=None):
    print(item.id)

stream()¶

Provide an instance of RedditorStream.

Streams can be used to indefinitely retrieve new comments made by a redditor, like:

redditor = await reddit.redditor("spez")
async for comment in redditor.stream.comments():
    print(comment)

Additionally, new submissions can be retrieved via the stream. In the following example all submissions are fetched via the redditor u/spez:

redditor = await reddit.redditor("spez")
async for submission in redditor.stream.submissions():
    print(submission)

Return type:: RedditorStream

submissions()¶

Provide an instance of SubListing for submission access.

For example, to output the title’s of top 100 of all time submissions for u/spez try:

redditor = await reddit.redditor("spez")
async for submission in redditor.submissions.top(time_filter="all"):
    print(submission.title)

Return type:: SubListing

top(*, time_filter='all', **generator_kwargs)¶

Return a ListingGenerator for top items.

Parameters:

time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year "``(default: ``"all").
generator_kwargs (Unpack[ListingGeneratorKwargs])

Raises:

ValueError if time_filter is invalid.

Return type:

AsyncIterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").top(time_filter="week")

multireddit = await reddit.multireddit(redditor="samuraisam", name="programming")
multireddit.top(time_filter="day")

redditor = await reddit.redditor("spez")
redditor.top(time_filter="month")

redditor = await reddit.redditor("spez")
redditor.comments.top(time_filter="year")

redditor = await reddit.redditor("spez")
redditor.submissions.top(time_filter="all")

subreddit = await reddit.subreddit("all")
subreddit.top(time_filter="hour")

await trophies()¶

Return a list of the redditor’s trophies.

Return type:: list[Trophy]
Returns:: A list of Trophy objects. Return [] if the redditor has no trophies.
Raises:: RedditAPIException if the redditor doesn’t exist.

Usage:

redditor = await reddit.redditor("spez")
async for trophy in redditor.trophies():
    print(trophy.name)
    print(trophy.description)

await trust()¶

Add the Redditor to your whitelist of trusted users.

Trusted users will always be able to send you PMs.

Example usage:

redditor = await reddit.redditor("AaronSw")
await redditor.trust()

Use the accept_pms parameter of Preferences.update() to toggle your accept_pms setting between "everyone" and "whitelisted". For example:

# Accept private messages from everyone:
await reddit.user.preferences.update(accept_pms="everyone")
# Only accept private messages from trusted users:
await reddit.user.preferences.update(accept_pms="whitelisted")

You may trust a user even if your accept_pms setting is switched to "everyone".

Note

You are allowed to have a user on your blocked list and your friends list at the same time. However, you cannot trust a user who is on your blocked list.

See also

Return type:: None

await unblock()¶

Unblock the Redditor.

For example, to unblock Redditor u/spez:

redditor = await reddit.redditor("spez")
await redditor.unblock()

Return type:: None

await unfriend()¶

Unfriend the Redditor.

For example, to unfriend Redditor u/spez:

redditor = await reddit.redditor("spez")
await redditor.unfriend()

Return type:: None

upvoted(**generator_kwargs)¶

Return a ListingGenerator for items the user has upvoted.

Return type:: AsyncIterator[Comment | Submission]
Returns:: A ListingGenerator object which yields Comment or Submission objects the user has upvoted.
Raises:: asyncprawcore.Forbidden if the user is not authorized to access the list.

Note

Since this function returns a ListingGenerator the exception may not occur until sometime after this function has returned.
Parameters:: generator_kwargs (Unpack[ListingGeneratorKwargs])

Additional keyword arguments are passed in the initialization of ListingGenerator.

For example, to get all upvoted items of the authenticated user:

current_user = await reddit.user.me()
async for item in current_user.upvoted():
    print(item.id)