reddit.user

class praw.models.User(reddit)

The user class provides methods for the currently authenticated user.

__init__(reddit)

Initialize a User instance.

This class is intended to be interfaced with through reddit.user.

blocked()

Return a RedditorList of blocked Redditors.

contributor_subreddits(**generator_kwargs)

Return a ListingGenerator of subreddits user is a contributor of.

Additional keyword arguments are passed in the initialization of ListingGenerator.

friends()

Return a RedditorList of friends.

karma()

Return a dictionary mapping subreddits to their karma.

me(use_cache=True)

Return a Redditor instance for the authenticated user.

Parameters:use_cache – When true, and if this function has been previously called, returned the cached version (default: True).

Note

If you change the Reddit instance’s authorization, you might want to refresh the cached value. Prefer using separate Reddit instances, however, for distinct authorizations.

moderator_subreddits(**generator_kwargs)

Return a ListingGenerator of subreddits the user is a moderator of.

Additional keyword arguments are passed in the initialization of ListingGenerator.

multireddits()

Return a list of multireddits belonging to the user.

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
  • data – The structured data.
  • reddit – An instance of Reddit.
preferences

Get an instance of Preferences.

The preferences can be accessed as a dict like so:

preferences = reddit.user.preferences()
print(preferences['show_link_flair'])

Preferences can be updated via:

reddit.user.preferences.update(show_link_flair=True)

The Preferences.update() method returns the new state of the preferences as a dict, which can be used to check whether a change went through. Changes with invalid types or parameter names fail silently.

original_preferences = reddit.user.preferences()
new_preferences = reddit.user.preferences.update(invalid_param=123)
print(original_preferences == new_preferences)  # True, no change
subreddits(**generator_kwargs)

Return a ListingGenerator of subreddits the user is subscribed to.

Additional keyword arguments are passed in the initialization of ListingGenerator.