sepehr/chartbastan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
chartbastan/backend/venv/Lib/site-packages/praw/models/reddit/subreddit.py
sepehr e02db93960 Initial commit
2026-02-01 09:31:38 +01:00

4256 lines
150 KiB
Python
Raw Blame History

"""Provide the Subreddit class."""
from __future__ import annotations
import contextlib
from copy import deepcopy
from csv import writer
from io import StringIO
from json import dumps, loads
from pathlib import Path
from typing import TYPE_CHECKING, Any, Generator, Iterator
from urllib.parse import urljoin
from warnings import warn
from xml.etree.ElementTree import XML
import websocket
from prawcore import Redirect
from prawcore.exceptions import ServerError
from requests.exceptions import HTTPError
from ...const import API_PATH, JPEG_HEADER
from ...exceptions import (
ClientException,
InvalidFlairTemplateID,
MediaPostFailed,
RedditAPIException,
TooLargeMediaException,
WebSocketException,
)
from ...util import _deprecate_args, cachedproperty
from ..listing.generator import ListingGenerator
from ..listing.mixins import SubredditListingMixin
from ..util import permissions_string, stream_generator
from .base import RedditBase
from .emoji import SubredditEmoji
from .mixins import FullnameMixin, MessageableMixin
from .modmail import ModmailConversation
from .removal_reasons import SubredditRemovalReasons
from .rules import SubredditRules
from .widgets import SubredditWidgets, WidgetEncoder
from .wikipage import WikiPage
if TYPE_CHECKING: # pragma: no cover
from requests import Response
import praw.models
class Modmail:
"""Provides modmail functions for a :class:`.Subreddit`.
For example, to send a new modmail from r/test to u/spez with the subject ``"test"``
along with a message body of ``"hello"``:
.. code-block:: python
reddit.subreddit("test").modmail.create(subject="test", body="hello", recipient="spez")
"""
def __call__(
self, id: str | None = None, mark_read: bool = False
) -> ModmailConversation:
"""Return an individual conversation.
:param id: A reddit base36 conversation ID, e.g., ``"2gmz"``.
:param mark_read: If ``True``, conversation is marked as read (default:
``False``).
For example:
.. code-block:: python
reddit.subreddit("test").modmail("2gmz", mark_read=True)
To print all messages from a conversation as Markdown source:
.. code-block:: python
conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True)
for message in conversation.messages:
print(message.body_markdown)
``ModmailConversation.user`` is a special instance of :class:`.Redditor` with
extra attributes describing the non-moderator user's recent posts, comments, and
modmail messages within the subreddit, as well as information on active bans and
mutes. This attribute does not exist on internal moderator discussions.
For example, to print the user's ban status:
.. code-block:: python
conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True)
print(conversation.user.ban_status)
To print a list of recent submissions by the user:
.. code-block:: python
conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True)
print(conversation.user.recent_posts)
"""
return ModmailConversation(self.subreddit._reddit, id=id, mark_read=mark_read)
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.Modmail` instance."""
self.subreddit = subreddit
def _build_subreddit_list(
self, other_subreddits: list[praw.models.Subreddit] | None
):
"""Return a comma-separated list of subreddit display names."""
subreddits = [self.subreddit] + (other_subreddits or [])
return ",".join(str(subreddit) for subreddit in subreddits)
@_deprecate_args("other_subreddits", "state")
def bulk_read(
self,
*,
other_subreddits: list[praw.models.Subreddit | str] | None = None,
state: str | None = None,
) -> list[ModmailConversation]:
"""Mark conversations for subreddit(s) as read.
.. note::
Due to server-side restrictions, r/all is not a valid subreddit for this
method. Instead, use :meth:`~.Modmail.subreddits` to get a list of
subreddits using the new modmail.
:param other_subreddits: A list of :class:`.Subreddit` instances for which to
mark conversations (default: ``None``).
:param state: Can be one of: ``"all"``, ``"archived"``, or ``"highlighted"``,
``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``,
``"notifications"``, or ``"appeals"`` (default: ``"all"``). ``"all"`` does
not include internal, archived, or appeals conversations.
:returns: A list of :class:`.ModmailConversation` instances that were marked
read.
For example, to mark all notifications for a subreddit as read:
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.modmail.bulk_read(state="notifications")
"""
params = {"entity": self._build_subreddit_list(other_subreddits)}
if state:
params["state"] = state
response = self.subreddit._reddit.post(
API_PATH["modmail_bulk_read"], params=params
)
return [
self(conversation_id) for conversation_id in response["conversation_ids"]
]
@_deprecate_args("after", "other_subreddits", "sort", "state")
def conversations(
self,
*,
after: str | None = None,
other_subreddits: list[praw.models.Subreddit] | None = None,
sort: str | None = None,
state: str | None = None,
**generator_kwargs: Any,
) -> Iterator[ModmailConversation]:
"""Generate :class:`.ModmailConversation` objects for subreddit(s).
:param after: A base36 modmail conversation id. When provided, the listing
begins after this conversation (default: ``None``).
.. deprecated:: 7.4.0
This parameter is deprecated and will be removed in PRAW 8.0. This
method will automatically fetch the next batch. Please pass it in the
``params`` argument like so:
.. code-block:: python
for convo in subreddit.modmail.conversations(params={"after": "qovbn"}):
# process conversation
...
:param other_subreddits: A list of :class:`.Subreddit` instances for which to
fetch conversations (default: ``None``).
:param sort: Can be one of: ``"mod"``, ``"recent"``, ``"unread"``, or ``"user"``
(default: ``"recent"``).
:param state: Can be one of: ``"all"``, ``"archived"``, ``"highlighted"``,
``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``,
``"notifications"``, or ``"appeals"`` (default: ``"all"``). ``"all"`` does
not include internal, archived, or appeals conversations.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
For example:
.. code-block:: python
conversations = reddit.subreddit("all").modmail.conversations(state="mod")
"""
params = {}
if after:
warn(
"The 'after' argument is deprecated and should be moved to the 'params'"
" dictionary argument.",
category=DeprecationWarning,
stacklevel=3,
)
params["after"] = after
if self.subreddit != "all":
params["entity"] = self._build_subreddit_list(other_subreddits)
Subreddit._safely_add_arguments(
arguments=generator_kwargs, key="params", sort=sort, state=state, **params
)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["modmail_conversations"],
**generator_kwargs,
)
@_deprecate_args("subject", "body", "recipient", "author_hidden")
def create(
self,
*,
author_hidden: bool = False,
body: str,
recipient: str | praw.models.Redditor,
subject: str,
) -> ModmailConversation:
"""Create a new :class:`.ModmailConversation`.
:param author_hidden: When ``True``, author is hidden from non-moderators
(default: ``False``).
:param body: The message body. Cannot be empty.
:param recipient: The recipient; a username or an instance of
:class:`.Redditor`.
:param subject: The message subject. Cannot be empty.
:returns: A :class:`.ModmailConversation` object for the newly created
conversation.
.. code-block:: python
subreddit = reddit.subreddit("test")
redditor = reddit.redditor("bboe")
subreddit.modmail.create(subject="Subject", body="Body", recipient=redditor)
"""
data = {
"body": body,
"isAuthorHidden": author_hidden,
"srName": self.subreddit,
"subject": subject,
"to": recipient,
}
return self.subreddit._reddit.post(API_PATH["modmail_conversations"], data=data)
def subreddits(self) -> Generator[praw.models.Subreddit, None, None]:
"""Yield subreddits using the new modmail that the user moderates.
For example:
.. code-block:: python
subreddits = reddit.subreddit("all").modmail.subreddits()
"""
response = self.subreddit._reddit.get(API_PATH["modmail_subreddits"])
for value in response["subreddits"].values():
subreddit = self.subreddit._reddit.subreddit(value["display_name"])
subreddit.last_updated = value["lastUpdated"]
yield subreddit
def unread_count(self) -> dict[str, int]:
"""Return unread conversation count by conversation state.
At time of writing, possible states are: ``"archived"``, ``"highlighted"``,
``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``,
``"notifications"``, or ``"appeals"``.
:returns: A dict mapping conversation states to unread counts.
For example, to print the count of unread moderator discussions:
.. code-block:: python
subreddit = reddit.subreddit("test")
unread_counts = subreddit.modmail.unread_count()
print(unread_counts["mod"])
"""
return self.subreddit._reddit.get(API_PATH["modmail_unread_count"])
class SubredditFilters:
"""Provide functions to interact with the special :class:`.Subreddit`'s filters.
Members of this class should be utilized via :meth:`.Subreddit.filters`. For
example, to add a filter, run:
.. code-block:: python
reddit.subreddit("all").filters.add("test")
"""
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditFilters` instance.
:param subreddit: The special subreddit whose filters to work with.
As of this writing filters can only be used with the special subreddits ``all``
and ``mod``.
"""
self.subreddit = subreddit
def __iter__(self) -> Generator[praw.models.Subreddit, None, None]:
"""Iterate through the special :class:`.Subreddit`'s filters.
This method should be invoked as:
.. code-block:: python
for subreddit in reddit.subreddit("test").filters:
...
"""
url = API_PATH["subreddit_filter_list"].format(
special=self.subreddit, user=self.subreddit._reddit.user.me()
)
params = {"unique": self.subreddit._reddit._next_unique}
response_data = self.subreddit._reddit.get(url, params=params)
yield from response_data.subreddits
def add(self, subreddit: praw.models.Subreddit | str):
"""Add ``subreddit`` to the list of filtered subreddits.
:param subreddit: The subreddit to add to the filter list.
Items from subreddits added to the filtered list will no longer be included when
obtaining listings for r/all.
Alternatively, you can filter a subreddit temporarily from a special listing in
a manner like so:
.. code-block:: python
reddit.subreddit("all-redditdev-learnpython")
:raises: ``prawcore.NotFound`` when calling on a non-special subreddit.
"""
url = API_PATH["subreddit_filter"].format(
special=self.subreddit,
user=self.subreddit._reddit.user.me(),
subreddit=subreddit,
)
self.subreddit._reddit.put(url, data={"model": dumps({"name": str(subreddit)})})
def remove(self, subreddit: praw.models.Subreddit | str):
"""Remove ``subreddit`` from the list of filtered subreddits.
:param subreddit: The subreddit to remove from the filter list.
:raises: ``prawcore.NotFound`` when calling on a non-special subreddit.
"""
url = API_PATH["subreddit_filter"].format(
special=self.subreddit,
user=self.subreddit._reddit.user.me(),
subreddit=str(subreddit),
)
self.subreddit._reddit.delete(url)
class SubredditFlair:
"""Provide a set of functions to interact with a :class:`.Subreddit`'s flair."""
@cachedproperty
def link_templates(
self,
) -> praw.models.reddit.subreddit.SubredditLinkFlairTemplates:
"""Provide an instance of :class:`.SubredditLinkFlairTemplates`.
Use this attribute for interacting with a :class:`.Subreddit`'s link flair
templates. For example to list all the link flair templates for a subreddit
which you have the ``flair`` moderator permission on try:
.. code-block:: python
for template in reddit.subreddit("test").flair.link_templates:
print(template)
"""
return SubredditLinkFlairTemplates(self.subreddit)
@cachedproperty
def templates(
self,
) -> praw.models.reddit.subreddit.SubredditRedditorFlairTemplates:
"""Provide an instance of :class:`.SubredditRedditorFlairTemplates`.
Use this attribute for interacting with a :class:`.Subreddit`'s flair templates.
For example to list all the flair templates for a subreddit which you have the
``flair`` moderator permission on try:
.. code-block:: python
for template in reddit.subreddit("test").flair.templates:
print(template)
"""
return SubredditRedditorFlairTemplates(self.subreddit)
def __call__(
self,
redditor: praw.models.Redditor | str | None = None,
**generator_kwargs: Any,
) -> Iterator[praw.models.Redditor]:
"""Return a :class:`.ListingGenerator` for Redditors and their flairs.
:param redditor: When provided, yield at most a single :class:`.Redditor`
instance (default: ``None``).
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
Usage:
.. code-block:: python
for flair in reddit.subreddit("test").flair(limit=None):
print(flair)
"""
Subreddit._safely_add_arguments(
arguments=generator_kwargs, key="params", name=redditor
)
generator_kwargs.setdefault("limit", None)
url = API_PATH["flairlist"].format(subreddit=self.subreddit)
return ListingGenerator(self.subreddit._reddit, url, **generator_kwargs)
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditFlair` instance.
:param subreddit: The subreddit whose flair to work with.
"""
self.subreddit = subreddit
@_deprecate_args("position", "self_assign", "link_position", "link_self_assign")
def configure(
self,
*,
link_position: str = "left",
link_self_assign: bool = False,
position: str = "right",
self_assign: bool = False,
**settings: Any,
):
"""Update the :class:`.Subreddit`'s flair configuration.
:param link_position: One of ``"left"``, ``"right"``, or ``False`` to disable
(default: ``"left"``).
:param link_self_assign: Permit self assignment of link flair (default:
``False``).
:param position: One of ``"left"``, ``"right"``, or ``False`` to disable
(default: ``"right"``).
:param self_assign: Permit self assignment of user flair (default: ``False``).
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.flair.configure(link_position="right", self_assign=True)
Additional keyword arguments can be provided to handle new settings as Reddit
introduces them.
"""
data = {
"flair_enabled": bool(position),
"flair_position": position or "right",
"flair_self_assign_enabled": self_assign,
"link_flair_position": link_position or "",
"link_flair_self_assign_enabled": link_self_assign,
}
data.update(settings)
url = API_PATH["flairconfig"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
def delete(self, redditor: praw.models.Redditor | str):
"""Delete flair for a :class:`.Redditor`.
:param redditor: A redditor name or :class:`.Redditor` instance.
.. seealso::
:meth:`~.SubredditFlair.update` to delete the flair of many redditors at
once.
"""
url = API_PATH["deleteflair"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data={"name": str(redditor)})
def delete_all(self) -> list[dict[str, str | bool | dict[str, str]]]:
"""Delete all :class:`.Redditor` flair in the :class:`.Subreddit`.
:returns: List of dictionaries indicating the success or failure of each delete.
"""
return self.update(x["user"] for x in self())
@_deprecate_args("redditor", "text", "css_class", "flair_template_id")
def set( # noqa: A003
self,
redditor: praw.models.Redditor | str,
*,
css_class: str = "",
flair_template_id: str | None = None,
text: str = "",
):
"""Set flair for a :class:`.Redditor`.
:param redditor: A redditor name or :class:`.Redditor` instance.
:param text: The flair text to associate with the :class:`.Redditor` or
:class:`.Submission` (default: ``""``).
:param css_class: The css class to associate with the flair html (default:
``""``). Use either this or ``flair_template_id``.
:param flair_template_id: The ID of the flair template to be used (default:
``None``). Use either this or ``css_class``.
This method can only be used by an authenticated user who is a moderator of the
associated :class:`.Subreddit`.
For example:
.. code-block:: python
reddit.subreddit("test").flair.set("bboe", text="PRAW author", css_class="mods")
template = "6bd28436-1aa7-11e9-9902-0e05ab0fad46"
reddit.subreddit("test").flair.set(
"spez", text="Reddit CEO", flair_template_id=template
)
"""
if css_class and flair_template_id is not None:
msg = "Parameter 'css_class' cannot be used in conjunction with 'flair_template_id'."
raise TypeError(msg)
data = {"name": str(redditor), "text": text}
if flair_template_id is not None:
data["flair_template_id"] = flair_template_id
url = API_PATH["select_flair"].format(subreddit=self.subreddit)
else:
data["css_class"] = css_class
url = API_PATH["flair"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
@_deprecate_args("flair_list", "text", "css_class")
def update(
self,
flair_list: Iterator[
str | praw.models.Redditor | dict[str, str | praw.models.Redditor]
],
*,
text: str = "",
css_class: str = "",
) -> list[dict[str, str | bool | dict[str, str]]]:
"""Set or clear the flair for many redditors at once.
:param flair_list: Each item in this list should be either:
- The name of a redditor.
- An instance of :class:`.Redditor`.
- A dictionary mapping keys ``"user"``, ``"flair_text"``, and
``"flair_css_class"`` to their respective values. The ``"user"`` key
should map to a redditor, as described above. When a dictionary isn't
provided, or the dictionary is missing either ``"flair_text"`` or
``"flair_css_class"`` keys, the default values will come from the other
arguments.
:param css_class: The css class to use when not explicitly provided in
``flair_list`` (default: ``""``).
:param text: The flair text to use when not explicitly provided in
``flair_list`` (default: ``""``).
:returns: List of dictionaries indicating the success or failure of each update.
For example, to clear the flair text, and set the ``"praw"`` flair css class on
a few users try:
.. code-block:: python
subreddit.flair.update(["bboe", "spez", "spladug"], css_class="praw")
"""
temp_lines = StringIO()
for item in flair_list:
if isinstance(item, dict):
writer(temp_lines).writerow(
[
str(item["user"]),
item.get("flair_text", text),
item.get("flair_css_class", css_class),
]
)
else:
writer(temp_lines).writerow([str(item), text, css_class])
lines = temp_lines.getvalue().splitlines()
temp_lines.close()
response = []
url = API_PATH["flaircsv"].format(subreddit=self.subreddit)
while lines:
data = {"flair_csv": "\n".join(lines[:100])}
response.extend(self.subreddit._reddit.post(url, data=data))
lines = lines[100:]
return response
class SubredditFlairTemplates:
"""Provide functions to interact with a :class:`.Subreddit`'s flair templates."""
@staticmethod
def flair_type(is_link: bool) -> str:
"""Return ``"LINK_FLAIR"`` or ``"USER_FLAIR"`` depending on ``is_link`` value."""
return "LINK_FLAIR" if is_link else "USER_FLAIR"
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditFlairTemplates` instance.
:param subreddit: The subreddit whose flair templates to work with.
.. note::
This class should not be initialized directly. Instead, obtain an instance
via: ``reddit.subreddit("test").flair.templates`` or
``reddit.subreddit("test").flair.link_templates``.
"""
self.subreddit = subreddit
def __iter__(self):
"""Abstract method to return flair templates."""
raise NotImplementedError
def _add(
self,
*,
allowable_content: str | None = None,
background_color: str | None = None,
css_class: str = "",
is_link: bool | None = None,
max_emojis: int | None = None,
mod_only: bool | None = None,
text: str,
text_color: str | None = None,
text_editable: bool = False,
):
url = API_PATH["flairtemplate_v2"].format(subreddit=self.subreddit)
data = {
"allowable_content": allowable_content,
"background_color": background_color,
"css_class": css_class,
"flair_type": self.flair_type(is_link),
"max_emojis": max_emojis,
"mod_only": bool(mod_only),
"text": text,
"text_color": text_color,
"text_editable": bool(text_editable),
}
self.subreddit._reddit.post(url, data=data)
def _clear(self, *, is_link: bool | None = None):
url = API_PATH["flairtemplateclear"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data={"flair_type": self.flair_type(is_link)})
def _reorder(self, flair_list: list, *, is_link: bool | None = None):
url = API_PATH["flairtemplatereorder"].format(subreddit=self.subreddit)
self.subreddit._reddit.patch(
url,
params={
"flair_type": self.flair_type(is_link),
"subreddit": self.subreddit.display_name,
},
json=flair_list,
)
def delete(self, template_id: str):
"""Remove a flair template provided by ``template_id``.
For example, to delete the first :class:`.Redditor` flair template listed, try:
.. code-block:: python
template_info = list(subreddit.flair.templates)[0]
subreddit.flair.templates.delete(template_info["id"])
"""
url = API_PATH["flairtemplatedelete"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data={"flair_template_id": template_id})
@_deprecate_args(
"template_id",
"text",
"css_class",
"text_editable",
"background_color",
"text_color",
"mod_only",
"allowable_content",
"max_emojis",
"fetch",
)
def update(
self,
template_id: str,
*,
allowable_content: str | None = None,
background_color: str | None = None,
css_class: str | None = None,
fetch: bool = True,
max_emojis: int | None = None,
mod_only: bool | None = None,
text: str | None = None,
text_color: str | None = None,
text_editable: bool | None = None,
):
"""Update the flair template provided by ``template_id``.
:param template_id: The flair template to update. If not valid then an exception
will be thrown.
:param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``,
or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then
the ``"text"`` param must be a valid emoji string, for example,
``":snoo:"``.
:param background_color: The flair template's new background color, as a hex
color.
:param css_class: The flair template's new css_class (default: ``""``).
:param fetch: Whether PRAW will fetch existing information on the existing flair
before updating (default: ``True``).
:param max_emojis: Maximum emojis in the flair (Reddit defaults this value to
``10``).
:param mod_only: Indicate if the flair can only be used by moderators.
:param text: The flair template's new text.
:param text_color: The flair template's new text color, either ``"light"`` or
``"dark"``.
:param text_editable: Indicate if the flair text can be modified for each
redditor that sets it (default: ``False``).
.. warning::
If parameter ``fetch`` is set to ``False``, all parameters not provided will
be reset to their default (``None`` or ``False``) values.
For example, to make a user flair template text editable, try:
.. code-block:: python
template_info = list(subreddit.flair.templates)[0]
subreddit.flair.templates.update(
template_info["id"],
text=template_info["flair_text"],
text_editable=True,
)
"""
url = API_PATH["flairtemplate_v2"].format(subreddit=self.subreddit)
data = {
"allowable_content": allowable_content,
"background_color": background_color,
"css_class": css_class,
"flair_template_id": template_id,
"max_emojis": max_emojis,
"mod_only": mod_only,
"text": text,
"text_color": text_color,
"text_editable": text_editable,
}
if fetch:
_existing_data = [
template for template in iter(self) if template["id"] == template_id
]
if len(_existing_data) != 1:
raise InvalidFlairTemplateID(template_id)
existing_data = _existing_data[0]
for key, value in existing_data.items():
if data.get(key) is None:
data[key] = value
self.subreddit._reddit.post(url, data=data)
class SubredditModeration:
"""Provides a set of moderation functions to a :class:`.Subreddit`.
For example, to accept a moderation invite from r/test:
.. code-block:: python
reddit.subreddit("test").mod.accept_invite()
"""
@staticmethod
def _handle_only(*, generator_kwargs: dict[str, Any], only: str | None):
if only is not None:
if only == "submissions":
only = "links"
RedditBase._safely_add_arguments(
arguments=generator_kwargs, key="params", only=only
)
@cachedproperty
def notes(self) -> praw.models.SubredditModNotes:
"""Provide an instance of :class:`.SubredditModNotes`.
This provides an interface for managing moderator notes for this subreddit.
For example, all the notes for u/spez in r/test can be iterated through like so:
.. code-block:: python
subreddit = reddit.subreddit("test")
for note in subreddit.mod.notes.redditors("spez"):
print(f"{note.label}: {note.note}")
"""
from praw.models.mod_notes import SubredditModNotes
return SubredditModNotes(self.subreddit._reddit, subreddit=self.subreddit)
@cachedproperty
def removal_reasons(self) -> SubredditRemovalReasons:
"""Provide an instance of :class:`.SubredditRemovalReasons`.
Use this attribute for interacting with a :class:`.Subreddit`'s removal reasons.
For example to list all the removal reasons for a subreddit which you have the
``posts`` moderator permission on, try:
.. code-block:: python
for removal_reason in reddit.subreddit("test").mod.removal_reasons:
print(removal_reason)
A single removal reason can be lazily retrieved via:
.. code-block:: python
reddit.subreddit("test").mod.removal_reasons["reason_id"]
.. note::
Attempting to access attributes of an nonexistent removal reason will result
in a :class:`.ClientException`.
"""
return SubredditRemovalReasons(self.subreddit)
@cachedproperty
def stream(self) -> praw.models.reddit.subreddit.SubredditModerationStream:
"""Provide an instance of :class:`.SubredditModerationStream`.
Streams can be used to indefinitely retrieve Moderator only items from
:class:`.SubredditModeration` made to moderated subreddits, like:
.. code-block:: python
for log in reddit.subreddit("mod").mod.stream.log():
print(f"Mod: {log.mod}, Subreddit: {log.subreddit}")
"""
return SubredditModerationStream(self.subreddit)
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditModeration` instance.
:param subreddit: The subreddit to moderate.
"""
self.subreddit = subreddit
self._stream = None
def accept_invite(self):
"""Accept an invitation as a moderator of the community."""
url = API_PATH["accept_mod_invite"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url)
@_deprecate_args("only")
def edited(
self, *, only: str | None = None, **generator_kwargs: Any
) -> Iterator[praw.models.Comment | praw.models.Submission]:
"""Return a :class:`.ListingGenerator` for edited comments and submissions.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print all items in the edited queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.edited(limit=None):
print(item)
"""
self._handle_only(generator_kwargs=generator_kwargs, only=only)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_edited"].format(subreddit=self.subreddit),
**generator_kwargs,
)
def inbox(self, **generator_kwargs: Any) -> Iterator[praw.models.SubredditMessage]:
"""Return a :class:`.ListingGenerator` for moderator messages.
.. warning::
Legacy modmail is being deprecated in June 2021. Please see
https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/
for more info.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
.. seealso::
:meth:`.unread` for unread moderator messages.
To print the last 5 moderator mail messages and their replies, try:
.. code-block:: python
for message in reddit.subreddit("mod").mod.inbox(limit=5):
print(f"From: {message.author}, Body: {message.body}")
for reply in message.replies:
print(f"From: {reply.author}, Body: {reply.body}")
"""
warn(
"Legacy modmail is being deprecated in June 2021. Please see"
" https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/"
" for more info.",
category=DeprecationWarning,
stacklevel=3,
)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["moderator_messages"].format(subreddit=self.subreddit),
**generator_kwargs,
)
@_deprecate_args("action", "mod")
def log(
self,
*,
action: str | None = None,
mod: praw.models.Redditor | str | None = None,
**generator_kwargs: Any,
) -> Iterator[praw.models.ModAction]:
"""Return a :class:`.ListingGenerator` for moderator log entries.
:param action: If given, only return log entries for the specified action.
:param mod: If given, only return log entries for actions made by the passed in
redditor.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print the moderator and subreddit of the last 5 modlog entries try:
.. code-block:: python
for log in reddit.subreddit("mod").mod.log(limit=5):
print(f"Mod: {log.mod}, Subreddit: {log.subreddit}")
"""
params = {"mod": str(mod) if mod else mod, "type": action}
Subreddit._safely_add_arguments(
arguments=generator_kwargs, key="params", **params
)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_log"].format(subreddit=self.subreddit),
**generator_kwargs,
)
@_deprecate_args("only")
def modqueue(
self, *, only: str | None = None, **generator_kwargs: Any
) -> Iterator[praw.models.Submission | praw.models.Comment]:
"""Return a :class:`.ListingGenerator` for modqueue items.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print all modqueue items try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.modqueue(limit=None):
print(item)
"""
self._handle_only(generator_kwargs=generator_kwargs, only=only)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_modqueue"].format(subreddit=self.subreddit),
**generator_kwargs,
)
@_deprecate_args("only")
def reports(
self, *, only: str | None = None, **generator_kwargs: Any
) -> Iterator[praw.models.Submission | praw.models.Comment]:
"""Return a :class:`.ListingGenerator` for reported comments and submissions.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print the user and mod report reasons in the report queue try:
.. code-block:: python
for reported_item in reddit.subreddit("mod").mod.reports():
print(f"User Reports: {reported_item.user_reports}")
print(f"Mod Reports: {reported_item.mod_reports}")
"""
self._handle_only(generator_kwargs=generator_kwargs, only=only)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_reports"].format(subreddit=self.subreddit),
**generator_kwargs,
)
def settings(self) -> dict[str, str | int | bool]:
"""Return a dictionary of the :class:`.Subreddit`'s current settings."""
url = API_PATH["subreddit_settings"].format(subreddit=self.subreddit)
return self.subreddit._reddit.get(url)["data"]
@_deprecate_args("only")
def spam(
self, *, only: str | None = None, **generator_kwargs: Any
) -> Iterator[praw.models.Submission | praw.models.Comment]:
"""Return a :class:`.ListingGenerator` for spam comments and submissions.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print the items in the spam queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.spam():
print(item)
"""
self._handle_only(generator_kwargs=generator_kwargs, only=only)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_spam"].format(subreddit=self.subreddit),
**generator_kwargs,
)
def unmoderated(self, **generator_kwargs: Any) -> Iterator[praw.models.Submission]:
"""Return a :class:`.ListingGenerator` for unmoderated submissions.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To print the items in the unmoderated queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.unmoderated():
print(item)
"""
return ListingGenerator(
self.subreddit._reddit,
API_PATH["about_unmoderated"].format(subreddit=self.subreddit),
**generator_kwargs,
)
def unread(self, **generator_kwargs: Any) -> Iterator[praw.models.SubredditMessage]:
"""Return a :class:`.ListingGenerator` for unread moderator messages.
.. warning::
Legacy modmail is being deprecated in June 2021. Please see
https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/
for more info.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
.. seealso::
:meth:`.inbox` for all messages.
To print the mail in the unread modmail queue try:
.. code-block:: python
for message in reddit.subreddit("mod").mod.unread():
print(f"From: {message.author}, To: {message.dest}")
"""
warn(
"Legacy modmail is being deprecated in June 2021. Please see"
" https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/"
" for more info.",
category=DeprecationWarning,
stacklevel=3,
)
return ListingGenerator(
self.subreddit._reddit,
API_PATH["moderator_unread"].format(subreddit=self.subreddit),
**generator_kwargs,
)
def update(self, **settings: str | int | bool) -> dict[str, str | int | bool]:
"""Update the :class:`.Subreddit`'s settings.
See https://www.reddit.com/dev/api#POST_api_site_admin for the full list.
:param all_original_content: Mandate all submissions to be original content
only.
:param allow_chat_post_creation: Allow users to create chat submissions.
:param allow_images: Allow users to upload images using the native image
hosting.
:param allow_polls: Allow users to post polls to the subreddit.
:param allow_post_crossposts: Allow users to crosspost submissions from other
subreddits.
:param allow_videos: Allow users to upload videos using the native image
hosting.
:param collapse_deleted_comments: Collapse deleted and removed comments on
comments pages by default.
:param comment_score_hide_mins: The number of minutes to hide comment scores.
:param content_options: The types of submissions users can make. One of
``"any"``, ``"link"``, or ``"self"``.
:param crowd_control_chat_level: Controls the crowd control level for chat
rooms. Goes from 0-3.
:param crowd_control_level: Controls the crowd control level for submissions.
Goes from 0-3.
:param crowd_control_mode: Enables/disables crowd control.
:param default_set: Allow the subreddit to appear on r/all as well as the
default and trending lists.
:param disable_contributor_requests: Specifies whether redditors may send
automated modmail messages requesting approval as a submitter.
:param exclude_banned_modqueue: Exclude posts by site-wide banned users from
modqueue/unmoderated.
:param free_form_reports: Allow users to specify custom reasons in the report
menu.
:param header_hover_text: The text seen when hovering over the snoo.
:param hide_ads: Don't show ads within this subreddit. Only applies to
Premium-user only subreddits.
:param key_color: A 6-digit rgb hex color (e.g., ``"#AABBCC"``), used as a
thematic color for your subreddit on mobile.
:param language: A valid IETF language tag (underscore separated).
:param original_content_tag_enabled: Enables the use of the ``original content``
label for submissions.
:param over_18: Viewers must be over 18 years old (i.e., NSFW).
:param public_description: Public description blurb. Appears in search results
and on the landing page for private subreddits.
:param restrict_commenting: Specifies whether approved users have the ability to
comment.
:param restrict_posting: Specifies whether approved users have the ability to
submit posts.
:param show_media: Show thumbnails on submissions.
:param show_media_preview: Expand media previews on comments pages.
:param spam_comments: Spam filter strength for comments. One of ``"all"``,
``"low"``, or ``"high"``.
:param spam_links: Spam filter strength for links. One of ``"all"``, ``"low"``,
or ``"high"``.
:param spam_selfposts: Spam filter strength for selfposts. One of ``"all"``,
``"low"``, or ``"high"``.
:param spoilers_enabled: Enable marking posts as containing spoilers.
:param submit_link_label: Custom label for submit link button (``None`` for
default).
:param submit_text: Text to show on submission page.
:param submit_text_label: Custom label for submit text post button (``None`` for
default).
:param subreddit_type: One of ``"archived"``, ``"employees_only"``,
``"gold_only"``, ``gold_restricted``, ``"private"``, ``"public"``, or
``"restricted"``.
:param suggested_comment_sort: All comment threads will use this sorting method
by default. Leave ``None``, or choose one of ``"confidence"``,
``"controversial"``, ``"live"``, ``"new"``, ``"old"``, ``"qa"``,
``"random"``, or ``"top"``.
:param title: The title of the subreddit.
:param welcome_message_enabled: Enables the subreddit welcome message.
:param welcome_message_text: The text to be used as a welcome message. A welcome
message is sent to all new subscribers by a Reddit bot.
:param wiki_edit_age: Account age, in days, required to edit and create wiki
pages.
:param wiki_edit_karma: Subreddit karma required to edit and create wiki pages.
:param wikimode: One of ``"anyone"``, ``"disabled"``, or ``"modonly"``.
.. note::
Updating the subreddit sidebar on old reddit (``description``) is no longer
supported using this method. You can update the sidebar by editing the
``"config/sidebar"`` wiki page. For example:
.. code-block:: python
sidebar = reddit.subreddit("test").wiki["config/sidebar"]
sidebar.edit(content="new sidebar content")
Additional keyword arguments can be provided to handle new settings as Reddit
introduces them.
Settings that are documented here and aren't explicitly set by you in a call to
:meth:`.SubredditModeration.update` should retain their current value. If they
do not, please file a bug.
"""
# These attributes come out using different names than they go in.
remap = {
"content_options": "link_type",
"default_set": "allow_top",
"header_hover_text": "header_title",
"language": "lang",
"subreddit_type": "type",
}
settings = {remap.get(key, key): value for key, value in settings.items()}
settings["sr"] = self.subreddit.fullname
return self.subreddit._reddit.patch(API_PATH["update_settings"], json=settings)
class SubredditModerationStream:
"""Provides moderator streams."""
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditModerationStream` instance.
:param subreddit: The moderated subreddit associated with the streams.
"""
self.subreddit = subreddit
@_deprecate_args("only")
def edited(
self, *, only: str | None = None, **stream_options: Any
) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
"""Yield edited comments and submissions as they become available.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Keyword arguments are passed to :func:`.stream_generator`.
For example, to retrieve all new edited submissions/comments made to all
moderated subreddits, try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.stream.edited():
print(item)
"""
return stream_generator(self.subreddit.mod.edited, only=only, **stream_options)
@_deprecate_args("action", "mod")
def log(
self,
*,
action: str | None = None,
mod: str | praw.models.Redditor | None = None,
**stream_options: Any,
) -> Generator[praw.models.ModAction, None, None]:
"""Yield moderator log entries as they become available.
:param action: If given, only return log entries for the specified action.
:param mod: If given, only return log entries for actions made by the passed in
redditor.
For example, to retrieve all new mod actions made to all moderated subreddits,
try:
.. code-block:: python
for log in reddit.subreddit("mod").mod.stream.log():
print(f"Mod: {log.mod}, Subreddit: {log.subreddit}")
"""
return stream_generator(
self.subreddit.mod.log,
attribute_name="id",
action=action,
mod=mod,
**stream_options,
)
@_deprecate_args("other_subreddits", "sort", "state")
def modmail_conversations(
self,
*,
other_subreddits: list[praw.models.Subreddit] | None = None,
sort: str | None = None,
state: str | None = None,
**stream_options: Any,
) -> Generator[ModmailConversation, None, None]:
"""Yield new-modmail conversations as they become available.
:param other_subreddits: A list of :class:`.Subreddit` instances for which to
fetch conversations (default: ``None``).
:param sort: Can be one of: ``"mod"``, ``"recent"``, ``"unread"``, or ``"user"``
(default: ``"recent"``).
:param state: Can be one of: ``"all"``, ``"appeals"``, ``"archived"``,
``"default"``, ``"highlighted"``, ``"inbox"``, ``"inprogress"``,
``"join_requests"``, ``"mod"``, ``"new"``, or ``"notifications"`` (default:
``"all"``). ``"all"`` does not include mod or archived conversations.
``"inbox"`` does not include appeals conversations.
Keyword arguments are passed to :func:`.stream_generator`.
To print new mail in the unread modmail queue try:
.. code-block:: python
subreddit = reddit.subreddit("all")
for message in subreddit.mod.stream.modmail_conversations():
print(f"From: {message.owner}, To: {message.participant}")
"""
if self.subreddit == "mod":
self.subreddit = self.subreddit._reddit.subreddit("all")
return stream_generator(
self.subreddit.modmail.conversations,
attribute_name="id",
exclude_before=True,
other_subreddits=other_subreddits,
sort=sort,
state=state,
**stream_options,
)
@_deprecate_args("only")
def modqueue(
self, *, only: str | None = None, **stream_options: Any
) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
r"""Yield :class:`.Comment`\ s and :class:`.Submission`\ s in the modqueue as they become available.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Keyword arguments are passed to :func:`.stream_generator`.
To print all new modqueue items try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.stream.modqueue():
print(item)
"""
return stream_generator(
self.subreddit.mod.modqueue, only=only, **stream_options
)
@_deprecate_args("only")
def reports(
self, *, only: str | None = None, **stream_options: Any
) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
r"""Yield reported :class:`.Comment`\ s and :class:`.Submission`\ s as they become available.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Keyword arguments are passed to :func:`.stream_generator`.
To print new user and mod report reasons in the report queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.stream.reports():
print(item)
"""
return stream_generator(self.subreddit.mod.reports, only=only, **stream_options)
@_deprecate_args("only")
def spam(
self, *, only: str | None = None, **stream_options: Any
) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
r"""Yield spam :class:`.Comment`\ s and :class:`.Submission`\ s as they become available.
:param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
only results of that type.
Keyword arguments are passed to :func:`.stream_generator`.
To print new items in the spam queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.stream.spam():
print(item)
"""
return stream_generator(self.subreddit.mod.spam, only=only, **stream_options)
def unmoderated(
self, **stream_options: Any
) -> Generator[praw.models.Submission, None, None]:
r"""Yield unmoderated :class:`.Submission`\ s as they become available.
Keyword arguments are passed to :func:`.stream_generator`.
To print new items in the unmoderated queue try:
.. code-block:: python
for item in reddit.subreddit("mod").mod.stream.unmoderated():
print(item)
"""
return stream_generator(self.subreddit.mod.unmoderated, **stream_options)
def unread(
self, **stream_options: Any
) -> Generator[praw.models.SubredditMessage, None, None]:
"""Yield unread old modmail messages as they become available.
Keyword arguments are passed to :func:`.stream_generator`.
.. seealso::
:meth:`.SubredditModeration.inbox` for all messages.
To print new mail in the unread modmail queue try:
.. code-block:: python
for message in reddit.subreddit("mod").mod.stream.unread():
print(f"From: {message.author}, To: {message.dest}")
"""
return stream_generator(self.subreddit.mod.unread, **stream_options)
class SubredditQuarantine:
"""Provides subreddit quarantine related methods.
To opt-in into a quarantined subreddit:
.. code-block:: python
reddit.subreddit("test").quaran.opt_in()
"""
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditQuarantine` instance.
:param subreddit: The :class:`.Subreddit` associated with the quarantine.
"""
self.subreddit = subreddit
def opt_in(self):
"""Permit your user access to the quarantined subreddit.
Usage:
.. code-block:: python
subreddit = reddit.subreddit("QUESTIONABLE")
next(subreddit.hot()) # Raises prawcore.Forbidden
subreddit.quaran.opt_in()
next(subreddit.hot()) # Returns Submission
"""
data = {"sr_name": self.subreddit}
with contextlib.suppress(Redirect):
self.subreddit._reddit.post(API_PATH["quarantine_opt_in"], data=data)
def opt_out(self):
"""Remove access to the quarantined subreddit.
Usage:
.. code-block:: python
subreddit = reddit.subreddit("QUESTIONABLE")
next(subreddit.hot()) # Returns Submission
subreddit.quaran.opt_out()
next(subreddit.hot()) # Raises prawcore.Forbidden
"""
data = {"sr_name": self.subreddit}
with contextlib.suppress(Redirect):
self.subreddit._reddit.post(API_PATH["quarantine_opt_out"], data=data)
class SubredditRelationship:
"""Represents a relationship between a :class:`.Redditor` and :class:`.Subreddit`.
Instances of this class can be iterated through in order to discover the Redditors
that make up the relationship.
For example, banned users of a subreddit can be iterated through like so:
.. code-block:: python
for ban in reddit.subreddit("test").banned():
print(f"{ban}: {ban.note}")
"""
def __call__(
self,
redditor: str | praw.models.Redditor | None = None,
**generator_kwargs: Any,
) -> Iterator[praw.models.Redditor]:
r"""Return a :class:`.ListingGenerator` for :class:`.Redditor`\ s in the relationship.
:param redditor: When provided, yield at most a single :class:`.Redditor`
instance. This is useful to confirm if a relationship exists, or to fetch
the metadata associated with a particular relationship (default: ``None``).
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
"""
Subreddit._safely_add_arguments(
arguments=generator_kwargs, key="params", user=redditor
)
url = API_PATH[f"list_{self.relationship}"].format(subreddit=self.subreddit)
return ListingGenerator(self.subreddit._reddit, url, **generator_kwargs)
def __init__(self, subreddit: praw.models.Subreddit, relationship: str):
"""Initialize a :class:`.SubredditRelationship` instance.
:param subreddit: The :class:`.Subreddit` for the relationship.
:param relationship: The name of the relationship.
"""
self.relationship = relationship
self.subreddit = subreddit
def add(self, redditor: str | praw.models.Redditor, **other_settings: Any):
"""Add ``redditor`` to this relationship.
:param redditor: A redditor name or :class:`.Redditor` instance.
"""
data = {"name": str(redditor), "type": self.relationship}
data.update(other_settings)
url = API_PATH["friend"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
def remove(self, redditor: str | praw.models.Redditor):
"""Remove ``redditor`` from this relationship.
:param redditor: A redditor name or :class:`.Redditor` instance.
"""
data = {"name": str(redditor), "type": self.relationship}
url = API_PATH["unfriend"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
class SubredditStream:
"""Provides submission and comment streams."""
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditStream` instance.
:param subreddit: The subreddit associated with the streams.
"""
self.subreddit = subreddit
def comments(
self, **stream_options: Any
) -> Generator[praw.models.Comment, None, None]:
"""Yield new comments as they become available.
Comments are yielded oldest first. Up to 100 historical comments will initially
be returned.
Keyword arguments are passed to :func:`.stream_generator`.
.. note::
While PRAW tries to catch all new comments, some high-volume streams,
especially the r/all stream, may drop some comments.
For example, to retrieve all new comments made to r/test, try:
.. code-block:: python
for comment in reddit.subreddit("test").stream.comments():
print(comment)
To only retrieve new submissions starting when the stream is created, pass
``skip_existing=True``:
.. code-block:: python
subreddit = reddit.subreddit("test")
for comment in subreddit.stream.comments(skip_existing=True):
print(comment)
"""
return stream_generator(self.subreddit.comments, **stream_options)
def submissions(
self, **stream_options: Any
) -> Generator[praw.models.Submission, None, None]:
r"""Yield new :class:`.Submission`\ s as they become available.
Submissions are yielded oldest first. Up to 100 historical submissions will
initially be returned.
Keyword arguments are passed to :func:`.stream_generator`.
.. note::
While PRAW tries to catch all new submissions, some high-volume streams,
especially the r/all stream, may drop some submissions.
For example, to retrieve all new submissions made to all of Reddit, try:
.. code-block:: python
for submission in reddit.subreddit("all").stream.submissions():
print(submission)
"""
return stream_generator(self.subreddit.new, **stream_options)
class SubredditStylesheet:
"""Provides a set of stylesheet functions to a :class:`.Subreddit`.
For example, to add the css data ``.test{color:blue}`` to the existing stylesheet:
.. code-block:: python
subreddit = reddit.subreddit("test")
stylesheet = subreddit.stylesheet()
stylesheet.stylesheet += ".test{color:blue}"
subreddit.stylesheet.update(stylesheet.stylesheet)
"""
def __call__(self) -> praw.models.Stylesheet:
"""Return the :class:`.Subreddit`'s stylesheet.
To be used as:
.. code-block:: python
stylesheet = reddit.subreddit("test").stylesheet()
"""
url = API_PATH["about_stylesheet"].format(subreddit=self.subreddit)
return self.subreddit._reddit.get(url)
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditStylesheet` instance.
:param subreddit: The :class:`.Subreddit` associated with the stylesheet.
An instance of this class is provided as:
.. code-block:: python
reddit.subreddit("test").stylesheet
"""
self.subreddit = subreddit
def _update_structured_styles(self, style_data: dict[str, str | Any]):
url = API_PATH["structured_styles"].format(subreddit=self.subreddit)
self.subreddit._reddit.patch(url, data=style_data)
def _upload_image(
self, *, data: dict[str, str | Any], image_path: str
) -> dict[str, Any]:
with Path(image_path).open("rb") as image:
header = image.read(len(JPEG_HEADER))
image.seek(0)
data["img_type"] = "jpg" if header == JPEG_HEADER else "png"
url = API_PATH["upload_image"].format(subreddit=self.subreddit)
response = self.subreddit._reddit.post(
url, data=data, files={"file": image}
)
if response["errors"]:
error_type = response["errors"][0]
error_value = response.get("errors_values", [""])[0]
assert error_type in [
"BAD_CSS_NAME",
"IMAGE_ERROR",
], "Please file a bug with PRAW."
raise RedditAPIException([[error_type, error_value, None]])
return response
def _upload_style_asset(self, *, image_path: str, image_type: str) -> str:
file = Path(image_path)
data = {"imagetype": image_type, "filepath": file.name}
data["mimetype"] = "image/jpeg"
if image_path.lower().endswith(".png"):
data["mimetype"] = "image/png"
url = API_PATH["style_asset_lease"].format(subreddit=self.subreddit)
upload_lease = self.subreddit._reddit.post(url, data=data)["s3UploadLease"]
upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
upload_url = f"https:{upload_lease['action']}"
with file.open("rb") as image:
response = self.subreddit._reddit._core._requestor._http.post(
upload_url, data=upload_data, files={"file": image}
)
response.raise_for_status()
return f"{upload_url}/{upload_data['key']}"
def delete_banner(self):
"""Remove the current :class:`.Subreddit` (redesign) banner image.
Succeeds even if there is no banner image.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_banner()
"""
data = {"bannerBackgroundImage": ""}
self._update_structured_styles(data)
def delete_banner_additional_image(self):
"""Remove the current :class:`.Subreddit` (redesign) banner additional image.
Succeeds even if there is no additional image. Will also delete any configured
hover image.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_banner_additional_image()
"""
data = {"bannerPositionedImage": "", "secondaryBannerPositionedImage": ""}
self._update_structured_styles(data)
def delete_banner_hover_image(self):
"""Remove the current :class:`.Subreddit` (redesign) banner hover image.
Succeeds even if there is no hover image.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_banner_hover_image()
"""
data = {"secondaryBannerPositionedImage": ""}
self._update_structured_styles(data)
def delete_header(self):
"""Remove the current :class:`.Subreddit` header image.
Succeeds even if there is no header image.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_header()
"""
url = API_PATH["delete_sr_header"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url)
def delete_image(self, name: str):
"""Remove the named image from the :class:`.Subreddit`.
Succeeds even if the named image does not exist.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_image("smile")
"""
url = API_PATH["delete_sr_image"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data={"img_name": name})
def delete_mobile_banner(self):
"""Remove the current :class:`.Subreddit` (redesign) mobile banner.
Succeeds even if there is no mobile banner.
For example:
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.stylesheet.delete_banner_hover_image()
"""
data = {"mobileBannerImage": ""}
self._update_structured_styles(data)
def delete_mobile_header(self):
"""Remove the current :class:`.Subreddit` mobile header.
Succeeds even if there is no mobile header.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_mobile_header()
"""
url = API_PATH["delete_sr_header"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url)
def delete_mobile_icon(self):
"""Remove the current :class:`.Subreddit` mobile icon.
Succeeds even if there is no mobile icon.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.delete_mobile_icon()
"""
url = API_PATH["delete_sr_icon"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url)
@_deprecate_args("stylesheet", "reason")
def update(self, stylesheet: str, *, reason: str | None = None):
"""Update the :class:`.Subreddit`'s stylesheet.
:param stylesheet: The CSS for the new stylesheet.
:param reason: The reason for updating the stylesheet.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.update(
"p { color: green; }", reason="color text green"
)
"""
data = {"op": "save", "reason": reason, "stylesheet_contents": stylesheet}
url = API_PATH["subreddit_stylesheet"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
@_deprecate_args("name", "image_path")
def upload(self, *, image_path: str, name: str) -> dict[str, str]:
"""Upload an image to the :class:`.Subreddit`.
:param image_path: A path to a jpeg or png image.
:param name: The name to use for the image. If an image already exists with the
same name, it will be replaced.
:returns: A dictionary containing a link to the uploaded image under the key
``img_src``.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.upload(name="smile", image_path="img.png")
"""
return self._upload_image(
data={"name": name, "upload_type": "img"}, image_path=image_path
)
def upload_banner(self, image_path: str):
"""Upload an image for the :class:`.Subreddit`'s (redesign) banner image.
:param image_path: A path to a jpeg or png image.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.upload_banner("banner.png")
"""
image_type = "bannerBackgroundImage"
image_url = self._upload_style_asset(
image_path=image_path, image_type=image_type
)
self._update_structured_styles({image_type: image_url})
@_deprecate_args("image_path", "align")
def upload_banner_additional_image(
self,
image_path: str,
*,
align: str | None = None,
):
"""Upload an image for the :class:`.Subreddit`'s (redesign) additional image.
:param image_path: A path to a jpeg or png image.
:param align: Either ``"left"``, ``"centered"``, or ``"right"``. (default:
``"left"``).
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.stylesheet.upload_banner_additional_image("banner.png")
"""
alignment = {}
if align is not None:
if align not in {"left", "centered", "right"}:
msg = "'align' argument must be either 'left', 'centered', or 'right'"
raise ValueError(msg)
alignment["bannerPositionedImagePosition"] = align
image_type = "bannerPositionedImage"
image_url = self._upload_style_asset(
image_path=image_path, image_type=image_type
)
style_data = {image_type: image_url}
if alignment:
style_data.update(alignment)
self._update_structured_styles(style_data)
def upload_banner_hover_image(self, image_path: str):
"""Upload an image for the :class:`.Subreddit`'s (redesign) additional image.
:param image_path: A path to a jpeg or png image.
Fails if the :class:`.Subreddit` does not have an additional image defined.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.stylesheet.upload_banner_hover_image("banner.png")
"""
image_type = "secondaryBannerPositionedImage"
image_url = self._upload_style_asset(
image_path=image_path, image_type=image_type
)
self._update_structured_styles({image_type: image_url})
def upload_header(self, image_path: str) -> dict[str, str]:
"""Upload an image to be used as the :class:`.Subreddit`'s header image.
:param image_path: A path to a jpeg or png image.
:returns: A dictionary containing a link to the uploaded image under the key
``img_src``.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.upload_header("header.png")
"""
return self._upload_image(data={"upload_type": "header"}, image_path=image_path)
def upload_mobile_banner(self, image_path: str):
"""Upload an image for the :class:`.Subreddit`'s (redesign) mobile banner.
:param image_path: A path to a JPEG or PNG image.
For example:
.. code-block:: python
subreddit = reddit.subreddit("test")
subreddit.stylesheet.upload_mobile_banner("banner.png")
Fails if the :class:`.Subreddit` does not have an additional image defined.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
"""
image_type = "mobileBannerImage"
image_url = self._upload_style_asset(
image_path=image_path, image_type=image_type
)
self._update_structured_styles({image_type: image_url})
def upload_mobile_header(self, image_path: str) -> dict[str, str]:
"""Upload an image to be used as the :class:`.Subreddit`'s mobile header.
:param image_path: A path to a jpeg or png image.
:returns: A dictionary containing a link to the uploaded image under the key
``img_src``.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.upload_mobile_header("header.png")
"""
return self._upload_image(data={"upload_type": "banner"}, image_path=image_path)
def upload_mobile_icon(self, image_path: str) -> dict[str, str]:
"""Upload an image to be used as the :class:`.Subreddit`'s mobile icon.
:param image_path: A path to a jpeg or png image.
:returns: A dictionary containing a link to the uploaded image under the key
``img_src``.
:raises: ``prawcore.TooLarge`` if the overall request body is too large.
:raises: :class:`.RedditAPIException` if there are other issues with the
uploaded image. Unfortunately the exception info might not be very specific,
so try through the website with the same image to see what the problem
actually might be.
For example:
.. code-block:: python
reddit.subreddit("test").stylesheet.upload_mobile_icon("icon.png")
"""
return self._upload_image(data={"upload_type": "icon"}, image_path=image_path)
class SubredditWiki:
"""Provides a set of wiki functions to a :class:`.Subreddit`."""
def __getitem__(self, page_name: str) -> WikiPage:
"""Lazily return the :class:`.WikiPage` for the :class:`.Subreddit` named ``page_name``.
This method is to be used to fetch a specific wikipage, like so:
.. code-block:: python
wikipage = reddit.subreddit("test").wiki["proof"]
print(wikipage.content_md)
"""
return WikiPage(self.subreddit._reddit, self.subreddit, page_name.lower())
def __init__(self, subreddit: praw.models.Subreddit):
"""Initialize a :class:`.SubredditWiki` instance.
:param subreddit: The subreddit whose wiki to work with.
"""
self.banned = SubredditRelationship(subreddit, "wikibanned")
self.contributor = SubredditRelationship(subreddit, "wikicontributor")
self.subreddit = subreddit
def __iter__(self) -> Generator[WikiPage, None, None]:
"""Iterate through the pages of the wiki.
This method is to be used to discover all wikipages for a subreddit:
.. code-block:: python
for wikipage in reddit.subreddit("test").wiki:
print(wikipage)
"""
response = self.subreddit._reddit.get(
API_PATH["wiki_pages"].format(subreddit=self.subreddit),
params={"unique": self.subreddit._reddit._next_unique},
)
for page_name in response["data"]:
yield WikiPage(self.subreddit._reddit, self.subreddit, page_name)
@_deprecate_args("name", "content", "reason")
def create(
self,
*,
content: str,
name: str,
reason: str | None = None,
**other_settings: Any,
) -> WikiPage:
"""Create a new :class:`.WikiPage`.
:param name: The name of the new :class:`.WikiPage`. This name will be
normalized.
:param content: The content of the new :class:`.WikiPage`.
:param reason: The reason for the creation.
:param other_settings: Additional keyword arguments to pass.
To create the wiki page ``"praw_test"`` in r/test try:
.. code-block:: python
reddit.subreddit("test").wiki.create(
name="praw_test", content="wiki body text", reason="PRAW Test Creation"
)
"""
name = name.replace(" ", "_").lower()
new = WikiPage(self.subreddit._reddit, self.subreddit, name)
new.edit(content=content, reason=reason, **other_settings)
return new
def revisions(self, **generator_kwargs: Any) -> Generator[
dict[str, praw.models.Redditor | WikiPage | str | int | bool | None],
None,
None,
]:
"""Return a :class:`.ListingGenerator` for recent wiki revisions.
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
To view the wiki revisions for ``"praw_test"`` in r/test try:
.. code-block:: python
for item in reddit.subreddit("test").wiki["praw_test"].revisions():
print(item)
"""
url = API_PATH["wiki_revisions"].format(subreddit=self.subreddit)
return WikiPage._revision_generator(
generator_kwargs=generator_kwargs, subreddit=self.subreddit, url=url
)
class ContributorRelationship(SubredditRelationship):
r"""Provides methods to interact with a :class:`.Subreddit`'s contributors.
Contributors are also known as approved submitters.
Contributors of a subreddit can be iterated through like so:
.. code-block:: python
for contributor in reddit.subreddit("test").contributor():
print(contributor)
"""
def leave(self):
"""Abdicate the contributor position."""
self.subreddit._reddit.post(
API_PATH["leavecontributor"], data={"id": self.subreddit.fullname}
)
class ModeratorRelationship(SubredditRelationship):
r"""Provides methods to interact with a :class:`.Subreddit`'s moderators.
Moderators of a subreddit can be iterated through like so:
.. code-block:: python
for moderator in reddit.subreddit("test").moderator():
print(moderator)
"""
PERMISSIONS = {
"access",
"chat_config",
"chat_operator",
"config",
"flair",
"mail",
"posts",
"wiki",
}
@staticmethod
def _handle_permissions(
*,
other_settings: dict | None = None,
permissions: list[str] | None = None,
) -> dict[str, Any]:
other_settings = deepcopy(other_settings) if other_settings else {}
other_settings["permissions"] = permissions_string(
known_permissions=ModeratorRelationship.PERMISSIONS, permissions=permissions
)
return other_settings
def __call__(
self, redditor: str | praw.models.Redditor | None = None
) -> list[praw.models.Redditor]:
r"""Return a list of :class:`.Redditor`\ s who are moderators.
:param redditor: When provided, return a list containing at most one
:class:`.Redditor` instance. This is useful to confirm if a relationship
exists, or to fetch the metadata associated with a particular relationship
(default: ``None``).
.. note::
To help mitigate targeted moderator harassment, this call requires the
:class:`.Reddit` instance to be authenticated i.e., :attr:`.read_only` must
return ``False``. This call, however, only makes use of the ``read`` scope.
For more information on why the moderator list is hidden can be found here:
https://reddit.zendesk.com/hc/en-us/articles/360049499032-Why-is-the-moderator-list-hidden-
.. note::
Unlike other relationship callables, this relationship is not paginated.
Thus, it simply returns the full list, rather than an iterator for the
results.
To be used like:
.. code-block:: python
moderators = reddit.subreddit("test").moderator()
For example, to list the moderators along with their permissions try:
.. code-block:: python
for moderator in reddit.subreddit("test").moderator():
print(f"{moderator}: {moderator.mod_permissions}")
"""
params = {} if redditor is None else {"user": redditor}
url = API_PATH[f"list_{self.relationship}"].format(subreddit=self.subreddit)
return self.subreddit._reddit.get(url, params=params)
@_deprecate_args("redditor", "permissions")
def add(
self,
redditor: str | praw.models.Redditor,
*,
permissions: list[str] | None = None,
**other_settings: Any,
):
"""Add or invite ``redditor`` to be a moderator of the :class:`.Subreddit`.
:param redditor: A redditor name or :class:`.Redditor` instance.
:param permissions: When provided (not ``None``), permissions should be a list
of strings specifying which subset of permissions to grant. An empty list
``[]`` indicates no permissions, and when not provided ``None``, indicates
full permissions (default: ``None``).
An invite will be sent unless the user making this call is an admin user.
For example, to invite u/spez with ``"posts"`` and ``"mail"`` permissions to
r/test, try:
.. code-block:: python
reddit.subreddit("test").moderator.add("spez", permissions=["posts", "mail"])
"""
other_settings = self._handle_permissions(
other_settings=other_settings, permissions=permissions
)
super().add(redditor, **other_settings)
@_deprecate_args("redditor", "permissions")
def invite(
self,
redditor: str | praw.models.Redditor,
*,
permissions: list[str] | None = None,
**other_settings: Any,
):
"""Invite ``redditor`` to be a moderator of the :class:`.Subreddit`.
:param redditor: A redditor name or :class:`.Redditor` instance.
:param permissions: When provided (not ``None``), permissions should be a list
of strings specifying which subset of permissions to grant. An empty list
``[]`` indicates no permissions, and when not provided ``None``, indicates
full permissions (default: ``None``).
For example, to invite u/spez with ``"posts"`` and ``"mail"`` permissions to
r/test, try:
.. code-block:: python
reddit.subreddit("test").moderator.invite("spez", permissions=["posts", "mail"])
"""
data = self._handle_permissions(
other_settings=other_settings, permissions=permissions
)
data.update({"name": str(redditor), "type": "moderator_invite"})
url = API_PATH["friend"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
@_deprecate_args("redditor")
def invited(
self,
*,
redditor: str | praw.models.Redditor | None = None,
**generator_kwargs: Any,
) -> Iterator[praw.models.Redditor]:
r"""Return a :class:`.ListingGenerator` for :class:`.Redditor`\ s invited to be moderators.
:param redditor: When provided, return a list containing at most one
:class:`.Redditor` instance. This is useful to confirm if a relationship
exists, or to fetch the metadata associated with a particular relationship
(default: ``None``).
Additional keyword arguments are passed in the initialization of
:class:`.ListingGenerator`.
.. note::
Unlike other usages of :class:`.ListingGenerator`, ``limit`` has no effect
in the quantity returned. This endpoint always returns moderators in batches
of 25 at a time regardless of what ``limit`` is set to.
Usage:
.. code-block:: python
for invited_mod in reddit.subreddit("test").moderator.invited():
print(invited_mod)
"""
generator_kwargs["params"] = {"username": redditor} if redditor else None
url = API_PATH["list_invited_moderator"].format(subreddit=self.subreddit)
return ListingGenerator(self.subreddit._reddit, url, **generator_kwargs)
def leave(self):
"""Abdicate the moderator position (use with care).
For example:
.. code-block:: python
reddit.subreddit("test").moderator.leave()
"""
self.remove(
self.subreddit._reddit.config.username or self.subreddit._reddit.user.me()
)
def remove_invite(self, redditor: str | praw.models.Redditor):
"""Remove the moderator invite for ``redditor``.
:param redditor: A redditor name or :class:`.Redditor` instance.
For example:
.. code-block:: python
reddit.subreddit("test").moderator.remove_invite("spez")
"""
data = {"name": str(redditor), "type": "moderator_invite"}
url = API_PATH["unfriend"].format(subreddit=self.subreddit)
self.subreddit._reddit.post(url, data=data)
@_deprecate_args("redditor", "permissions")
def update(
self,
redditor: str | praw.models.Redditor,
*,
permissions: list[str] | None = None,
):
"""Update the moderator permissions for ``redditor``.
:param redditor: A redditor name or :class:`.Redditor` instance.
:param permissions: When provided (not ``None``), permissions should be a list
of strings specifying which subset of permissions to grant. An empty list
``[]`` indicates no permissions, and when not provided, ``None``, indicates
full permissions (default: ``None``).
For example, to add all permissions to the moderator, try:
.. code-block:: python
subreddit.moderator.update("spez")
To remove all permissions from the moderator, try:
.. code-block:: python
subreddit.moderator.update("spez", permissions=[])
"""
url = API_PATH["setpermissions"].format(subreddit=self.subreddit)
data = self._handle_permissions(
other_settings={"name": str(redditor), "type": "moderator"},
permissions=permissions,
)
self.subreddit._reddit.post(url, data=data)
@_deprecate_args("redditor", "permissions")
def update_invite(
self,
redditor: str | praw.models.Redditor,
*,
permissions: list[str] | None = None,
):
"""Update the moderator invite permissions for ``redditor``.
:param redditor: A redditor name or :class:`.Redditor` instance.
:param permissions: When provided (not ``None``), permissions should be a list
of strings specifying which subset of permissions to grant. An empty list
``[]`` indicates no permissions, and when not provided, ``None``, indicates
full permissions (default: ``None``).
For example, to grant the ``"flair"`` and ``"mail"`` permissions to the
moderator invite, try:
.. code-block:: python
subreddit.moderator.update_invite("spez", permissions=["flair", "mail"])
"""
url = API_PATH["setpermissions"].format(subreddit=self.subreddit)
data = self._handle_permissions(
other_settings={"name": str(redditor), "type": "moderator_invite"},
permissions=permissions,
)
self.subreddit._reddit.post(url, data=data)
class Subreddit(MessageableMixin, SubredditListingMixin, FullnameMixin, RedditBase):
"""A class for Subreddits.
To obtain an instance of this class for r/test execute:
.. code-block:: python
subreddit = reddit.subreddit("test")
While r/all is not a real subreddit, it can still be treated like one. The following
outputs the titles of the 25 hottest submissions in r/all:
.. code-block:: python
for submission in reddit.subreddit("all").hot(limit=25):
print(submission.title)
Multiple subreddits can be combined with a ``+`` like so:
.. code-block:: python
for submission in reddit.subreddit("redditdev+learnpython").top(time_filter="all"):
print(submission)
Subreddits can be filtered from combined listings as follows.
.. note::
These filters are ignored by certain methods, including :attr:`.comments`,
:meth:`.gilded`, and :meth:`.SubredditStream.comments`.
.. code-block:: python
for submission in reddit.subreddit("all-redditdev").new():
print(submission)
.. include:: ../../typical_attributes.rst
========================= ==========================================================
Attribute Description
========================= ==========================================================
``can_assign_link_flair`` Whether users can assign their own link flair.
``can_assign_user_flair`` Whether users can assign their own user flair.
``created_utc`` Time the subreddit was created, represented in `Unix
Time`_.
``description`` Subreddit description, in Markdown.
``description_html`` Subreddit description, in HTML.
``display_name`` Name of the subreddit.
``icon_img`` The URL of the subreddit icon image.
``id`` ID of the subreddit.
``name`` Fullname of the subreddit.
``over18`` Whether the subreddit is NSFW.
``public_description`` Description of the subreddit, shown in searches and on the
"You must be invited to visit this community" page (if
applicable).
``spoilers_enabled`` Whether the spoiler tag feature is enabled.
``subscribers`` Count of subscribers.
``user_is_banned`` Whether the authenticated user is banned.
``user_is_moderator`` Whether the authenticated user is a moderator.
``user_is_subscriber`` Whether the authenticated user is subscribed.
========================= ==========================================================
.. note::
Trying to retrieve attributes of quarantined or private subreddits will result
in a 403 error. Trying to retrieve attributes of a banned subreddit will result
in a 404 error.
.. _unix time: https://en.wikipedia.org/wiki/Unix_time
"""
STR_FIELD = "display_name"
MESSAGE_PREFIX = "#"
@staticmethod
def _create_or_update(
*,
_reddit: praw.Reddit,
allow_images: bool | None = None,
allow_post_crossposts: bool | None = None,
allow_top: bool | None = None,
collapse_deleted_comments: bool | None = None,
comment_score_hide_mins: int | None = None,
description: str | None = None,
domain: str | None = None,
exclude_banned_modqueue: bool | None = None,
header_hover_text: str | None = None,
hide_ads: bool | None = None,
lang: str | None = None,
key_color: str | None = None,
link_type: str | None = None,
name: str | None = None,
over_18: bool | None = None,
public_description: str | None = None,
public_traffic: bool | None = None,
show_media: bool | None = None,
show_media_preview: bool | None = None,
spam_comments: bool | None = None,
spam_links: bool | None = None,
spam_selfposts: bool | None = None,
spoilers_enabled: bool | None = None,
sr: str | None = None,
submit_link_label: str | None = None,
submit_text: str | None = None,
submit_text_label: str | None = None,
subreddit_type: str | None = None,
suggested_comment_sort: str | None = None,
title: str | None = None,
wiki_edit_age: int | None = None,
wiki_edit_karma: int | None = None,
wikimode: str | None = None,
**other_settings: Any,
):
model = {
"allow_images": allow_images,
"allow_post_crossposts": allow_post_crossposts,
"allow_top": allow_top,
"collapse_deleted_comments": collapse_deleted_comments,
"comment_score_hide_mins": comment_score_hide_mins,
"description": description,
"domain": domain,
"exclude_banned_modqueue": exclude_banned_modqueue,
"header-title": header_hover_text, # Remap here - better name
"hide_ads": hide_ads,
"key_color": key_color,
"lang": lang,
"link_type": link_type,
"name": name,
"over_18": over_18,
"public_description": public_description,
"public_traffic": public_traffic,
"show_media": show_media,
"show_media_preview": show_media_preview,
"spam_comments": spam_comments,
"spam_links": spam_links,
"spam_selfposts": spam_selfposts,
"spoilers_enabled": spoilers_enabled,
"sr": sr,
"submit_link_label": submit_link_label,
"submit_text": submit_text,
"submit_text_label": submit_text_label,
"suggested_comment_sort": suggested_comment_sort,
"title": title,
"type": subreddit_type,
"wiki_edit_age": wiki_edit_age,
"wiki_edit_karma": wiki_edit_karma,
"wikimode": wikimode,
}
model.update(other_settings)
_reddit.post(API_PATH["site_admin"], data=model)
@staticmethod
def _subreddit_list(
*,
other_subreddits: list[str | praw.models.Subreddit],
subreddit: praw.models.Subreddit,
) -> str:
if other_subreddits:
return ",".join([str(subreddit)] + [str(x) for x in other_subreddits])
return str(subreddit)
@staticmethod
def _validate_gallery(images: list[dict[str, str]]):
for image in images:
image_path = image.get("image_path", "")
if image_path:
if not Path(image_path).is_file():
msg = f"{image_path!r} is not a valid image path."
raise TypeError(msg)
else:
msg = "'image_path' is required."
raise TypeError(msg)
if not len(image.get("caption", "")) <= 180:
msg = "Caption must be 180 characters or less."
raise TypeError(msg)
@staticmethod
def _validate_inline_media(inline_media: praw.models.InlineMedia):
if not Path(inline_media.path).is_file():
msg = f"{inline_media.path!r} is not a valid file path."
raise ValueError(msg)
@cachedproperty
def banned(self) -> praw.models.reddit.subreddit.SubredditRelationship:
"""Provide an instance of :class:`.SubredditRelationship`.
For example, to ban a user try:
.. code-block:: python
reddit.subreddit("test").banned.add("spez", ban_reason="...")
To list the banned users along with any notes, try:
.. code-block:: python
for ban in reddit.subreddit("test").banned():
print(f"{ban}: {ban.note}")
"""
return SubredditRelationship(self, "banned")
@cachedproperty
def collections(self) -> praw.models.reddit.collections.SubredditCollections:
r"""Provide an instance of :class:`.SubredditCollections`.
To see the permalinks of all :class:`.Collection`\ s that belong to a subreddit,
try:
.. code-block:: python
for collection in reddit.subreddit("test").collections:
print(collection.permalink)
To get a specific :class:`.Collection` by its UUID or permalink, use one of the
following:
.. code-block:: python
collection = reddit.subreddit("test").collections("some_uuid")
collection = reddit.subreddit("test").collections(
permalink="https://reddit.com/r/SUBREDDIT/collection/some_uuid"
)
"""
return self._subreddit_collections_class(self._reddit, self)
@cachedproperty
def contributor(self) -> praw.models.reddit.subreddit.ContributorRelationship:
"""Provide an instance of :class:`.ContributorRelationship`.
Contributors are also known as approved submitters.
To add a contributor try:
.. code-block:: python
reddit.subreddit("test").contributor.add("spez")
"""
return ContributorRelationship(self, "contributor")
@cachedproperty
def emoji(self) -> SubredditEmoji:
"""Provide an instance of :class:`.SubredditEmoji`.
This attribute can be used to discover all emoji for a subreddit:
.. code-block:: python
for emoji in reddit.subreddit("test").emoji:
print(emoji)
A single emoji can be lazily retrieved via:
.. code-block:: python
reddit.subreddit("test").emoji["emoji_name"]
.. note::
Attempting to access attributes of a nonexistent emoji will result in a
:class:`.ClientException`.
"""
return SubredditEmoji(self)
@cachedproperty
def filters(self) -> praw.models.reddit.subreddit.SubredditFilters:
"""Provide an instance of :class:`.SubredditFilters`.
For example, to add a filter, run:
.. code-block:: python
reddit.subreddit("all").filters.add("test")
"""
return SubredditFilters(self)
@cachedproperty
def flair(self) -> praw.models.reddit.subreddit.SubredditFlair:
"""Provide an instance of :class:`.SubredditFlair`.
Use this attribute for interacting with a :class:`.Subreddit`'s flair. For
example, to list all the flair for a subreddit which you have the ``flair``
moderator permission on try:
.. code-block:: python
for flair in reddit.subreddit("test").flair():
print(flair)
Flair templates can be interacted with through this attribute via:
.. code-block:: python
for template in reddit.subreddit("test").flair.templates:
print(template)
"""
return SubredditFlair(self)
@cachedproperty
def mod(self) -> SubredditModeration:
"""Provide an instance of :class:`.SubredditModeration`.
For example, to accept a moderation invite from r/test:
.. code-block:: python
reddit.subreddit("test").mod.accept_invite()
"""
return SubredditModeration(self)
@cachedproperty
def moderator(self) -> praw.models.reddit.subreddit.ModeratorRelationship:
"""Provide an instance of :class:`.ModeratorRelationship`.
For example, to add a moderator try:
.. code-block:: python
reddit.subreddit("test").moderator.add("spez")
To list the moderators along with their permissions try:
.. code-block:: python
for moderator in reddit.subreddit("test").moderator():
print(f"{moderator}: {moderator.mod_permissions}")
"""
return ModeratorRelationship(self, "moderator")
@cachedproperty
def modmail(self) -> praw.models.reddit.subreddit.Modmail:
"""Provide an instance of :class:`.Modmail`.
For example, to send a new modmail from r/test to u/spez with the subject
``"test"`` along with a message body of ``"hello"``:
.. code-block:: python
reddit.subreddit("test").modmail.create(subject="test", body="hello", recipient="spez")
"""
return Modmail(self)
@cachedproperty
def muted(self) -> praw.models.reddit.subreddit.SubredditRelationship:
"""Provide an instance of :class:`.SubredditRelationship`.
For example, muted users can be iterated through like so:
.. code-block:: python
for mute in reddit.subreddit("test").muted():
print(f"{mute}: {mute.date}")
"""
return SubredditRelationship(self, "muted")
@cachedproperty
def quaran(self) -> praw.models.reddit.subreddit.SubredditQuarantine:
"""Provide an instance of :class:`.SubredditQuarantine`.
This property is named ``quaran`` because ``quarantine`` is a subreddit
attribute returned by Reddit to indicate whether or not a subreddit is
quarantined.
To opt-in into a quarantined subreddit:
.. code-block:: python
reddit.subreddit("test").quaran.opt_in()
"""
return SubredditQuarantine(self)
@cachedproperty
def rules(self) -> SubredditRules:
"""Provide an instance of :class:`.SubredditRules`.
Use this attribute for interacting with a :class:`.Subreddit`'s rules.
For example, to list all the rules for a subreddit:
.. code-block:: python
for rule in reddit.subreddit("test").rules:
print(rule)
Moderators can also add rules to the subreddit. For example, to make a rule
called ``"No spam"`` in r/test:
.. code-block:: python
reddit.subreddit("test").rules.mod.add(
short_name="No spam", kind="all", description="Do not spam. Spam bad"
)
"""
return SubredditRules(self)
@cachedproperty
def stream(self) -> praw.models.reddit.subreddit.SubredditStream:
"""Provide an instance of :class:`.SubredditStream`.
Streams can be used to indefinitely retrieve new comments made to a subreddit,
like:
.. code-block:: python
for comment in reddit.subreddit("test").stream.comments():
print(comment)
Additionally, new submissions can be retrieved via the stream. In the following
example all submissions are fetched via the special r/all:
.. code-block:: python
for submission in reddit.subreddit("all").stream.submissions():
print(submission)
"""
return SubredditStream(self)
@cachedproperty
def stylesheet(self) -> praw.models.reddit.subreddit.SubredditStylesheet:
"""Provide an instance of :class:`.SubredditStylesheet`.
For example, to add the css data ``.test{color:blue}`` to the existing
stylesheet:
.. code-block:: python
subreddit = reddit.subreddit("test")
stylesheet = subreddit.stylesheet()
stylesheet.stylesheet += ".test{color:blue}"
subreddit.stylesheet.update(stylesheet.stylesheet)
"""
return SubredditStylesheet(self)
@cachedproperty
def widgets(self) -> praw.models.SubredditWidgets:
"""Provide an instance of :class:`.SubredditWidgets`.
**Example usage**
Get all sidebar widgets:
.. code-block:: python
for widget in reddit.subreddit("test").widgets.sidebar:
print(widget)
Get ID card widget:
.. code-block:: python
print(reddit.subreddit("test").widgets.id_card)
"""
return SubredditWidgets(self)
@cachedproperty
def wiki(self) -> praw.models.reddit.subreddit.SubredditWiki:
"""Provide an instance of :class:`.SubredditWiki`.
This attribute can be used to discover all wikipages for a subreddit:
.. code-block:: python
for wikipage in reddit.subreddit("test").wiki:
print(wikipage)
To fetch the content for a given wikipage try:
.. code-block:: python
wikipage = reddit.subreddit("test").wiki["proof"]
print(wikipage.content_md)
"""
return SubredditWiki(self)
@property
def _kind(self) -> str:
"""Return the class's kind."""
return self._reddit.config.kinds["subreddit"]
def __init__(
self,
reddit: praw.Reddit,
display_name: str | None = None,
_data: dict[str, Any] | None = None,
):
"""Initialize a :class:`.Subreddit` instance.
:param reddit: An instance of :class:`.Reddit`.
:param display_name: The name of the subreddit.
.. note::
This class should not be initialized directly. Instead, obtain an instance
via:
.. code-block:: python
subreddit = reddit.subreddit("test")
"""
if (display_name, _data).count(None) != 1:
msg = "Either 'display_name' or '_data' must be provided."
raise TypeError(msg)
if display_name:
self.display_name = display_name
super().__init__(reddit, _data=_data)
self._path = API_PATH["subreddit"].format(subreddit=self)
def _convert_to_fancypants(self, markdown_text: str) -> dict:
"""Convert a Markdown string to a dict for use with the ``richtext_json`` param.
:param markdown_text: A Markdown string to convert.
:returns: A dict in ``richtext_json`` format.
"""
text_data = {"output_mode": "rtjson", "markdown_text": markdown_text}
return self._reddit.post(API_PATH["convert_rte_body"], data=text_data)["output"]
def _fetch(self):
data = self._fetch_data()
data = data["data"]
other = type(self)(self._reddit, _data=data)
self.__dict__.update(other.__dict__)
super()._fetch()
def _fetch_info(self):
return "subreddit_about", {"subreddit": self}, None
def _parse_xml_response(self, response: Response):
"""Parse the XML from a response and raise any errors found."""
xml = response.text
root = XML(xml)
tags = [element.tag for element in root]
if tags[:4] == ["Code", "Message", "ProposedSize", "MaxSizeAllowed"]:
# Returned if image is too big
code, message, actual, maximum_size = (element.text for element in root[:4])
raise TooLargeMediaException(
actual=int(actual), maximum_size=int(maximum_size)
)
def _read_and_post_media(
self, file: Path, upload_url: str, upload_data: dict[str, Any]
) -> Response:
with file.open("rb") as media:
return self._reddit._core._requestor._http.post(
upload_url, data=upload_data, files={"file": media}
)
def _submit_media(
self, *, data: dict[Any, Any], timeout: int, without_websockets: bool
):
"""Submit and return an ``image``, ``video``, or ``videogif``.
This is a helper method for submitting posts that are not link posts or self
posts.
"""
response = self._reddit.post(API_PATH["submit"], data=data)
websocket_url = response["json"]["data"]["websocket_url"]
connection = None
if websocket_url is not None and not without_websockets:
try:
connection = websocket.create_connection(websocket_url, timeout=timeout)
except (
OSError,
websocket.WebSocketException,
BlockingIOError,
) as ws_exception:
msg = "Error establishing websocket connection."
raise WebSocketException(msg, ws_exception) from None
if connection is None:
return None
try:
ws_update = loads(connection.recv())
connection.close()
except (OSError, websocket.WebSocketException, BlockingIOError) as ws_exception:
msg = "Websocket error. Check your media file. Your post may still have been created."
raise WebSocketException(
msg,
ws_exception,
) from None
if ws_update.get("type") == "failed":
raise MediaPostFailed
url = ws_update["payload"]["redirect"]
return self._reddit.submission(url=url)
def _upload_inline_media(self, inline_media: praw.models.InlineMedia):
"""Upload media for use in self posts and return ``inline_media``.
:param inline_media: An :class:`.InlineMedia` object to validate and upload.
"""
self._validate_inline_media(inline_media)
inline_media.media_id = self._upload_media(
media_path=inline_media.path, upload_type="selfpost"
)
return inline_media
def _upload_media(
self,
*,
expected_mime_prefix: str | None = None,
media_path: str,
upload_type: str = "link",
):
"""Upload media and return its URL and a websocket (Undocumented endpoint).
:param expected_mime_prefix: If provided, enforce that the media has a mime type
that starts with the provided prefix.
:param upload_type: One of ``"link"``, ``"gallery"'', or ``"selfpost"``
(default: ``"link"``).
:returns: A tuple containing ``(media_url, websocket_url)`` for the piece of
media. The websocket URL can be used to determine when media processing is
finished, or it can be ignored.
"""
if media_path is None:
file = Path(__file__).absolute()
media_path = file.parent.parent.parent / "images" / "PRAW logo.png"
else:
file = Path(media_path)
file_name = file.name.lower()
file_extension = file_name.rpartition(".")[2]
mime_type = {
"png": "image/png",
"mov": "video/quicktime",
"mp4": "video/mp4",
"jpg": "image/jpeg",
"jpeg": "image/jpeg",
"gif": "image/gif",
}.get(
file_extension, "image/jpeg"
) # default to JPEG
if (
expected_mime_prefix is not None
and mime_type.partition("/")[0] != expected_mime_prefix
):
msg = f"Expected a mimetype starting with {expected_mime_prefix!r} but got mimetype {mime_type!r} (from file extension {file_extension!r})."
raise ClientException(msg)
img_data = {"filepath": file_name, "mimetype": mime_type}
url = API_PATH["media_asset"]
# until we learn otherwise, assume this request always succeeds
upload_response = self._reddit.post(url, data=img_data)
upload_lease = upload_response["args"]
upload_url = f"https:{upload_lease['action']}"
upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
response = self._read_and_post_media(file, upload_url, upload_data)
if not response.ok:
self._parse_xml_response(response)
try:
response.raise_for_status()
except HTTPError as err:
raise ServerError(response=err.response) from None
upload_response["asset"]["websocket_url"]
if upload_type == "link":
return f"{upload_url}/{upload_data['key']}"
return upload_response["asset"]["asset_id"]
def post_requirements(self) -> dict[str, str | int | bool]:
"""Get the post requirements for a subreddit.
:returns: A dict with the various requirements.
The returned dict contains the following keys:
- ``domain_blacklist``
- ``body_restriction_policy``
- ``domain_whitelist``
- ``title_regexes``
- ``body_blacklisted_strings``
- ``body_required_strings``
- ``title_text_min_length``
- ``is_flair_required``
- ``title_text_max_length``
- ``body_regexes``
- ``link_repost_age``
- ``body_text_min_length``
- ``link_restriction_policy``
- ``body_text_max_length``
- ``title_required_strings``
- ``title_blacklisted_strings``
- ``guidelines_text``
- ``guidelines_display_policy``
For example, to fetch the post requirements for r/test:
.. code-block:: python
print(reddit.subreddit("test").post_requirements)
"""
return self._reddit.get(
API_PATH["post_requirements"].format(subreddit=str(self))
)
def random(self) -> praw.models.Submission | None:
"""Return a random :class:`.Submission`.
Returns ``None`` on subreddits that do not support the random feature. One
example, at the time of writing, is r/wallpapers.
For example, to get a random submission off of r/AskReddit:
.. code-block:: python
submission = reddit.subreddit("AskReddit").random()
print(submission.title)
"""
url = API_PATH["subreddit_random"].format(subreddit=self)
try:
self._reddit.get(url, params={"unique": self._reddit._next_unique})
except Redirect as redirect:
path = redirect.path
try:
return self._submission_class(
self._reddit, url=urljoin(self._reddit.config.reddit_url, path)
)
except ClientException:
return None
@_deprecate_args("query", "sort", "syntax", "time_filter")
def search(
self,
query: str,
*,
sort: str = "relevance",
syntax: str = "lucene",
time_filter: str = "all",
**generator_kwargs: Any,
) -> Iterator[praw.models.Submission]:
"""Return a :class:`.ListingGenerator` for items that match ``query``.
:param query: The query string to search for.
:param sort: Can be one of: ``"relevance"``, ``"hot"``, ``"top"``, ``"new"``, or
``"comments"``. (default: ``"relevance"``).
:param syntax: Can be one of: ``"cloudsearch"``, ``"lucene"``, or ``"plain"``
(default: ``"lucene"``).
:param time_filter: Can be one of: ``"all"``, ``"day"``, ``"hour"``,
``"month"``, ``"week"``, or ``"year"`` (default: ``"all"``).
For more information on building a search query see:
https://www.reddit.com/wiki/search
For example, to search all subreddits for ``"praw"`` try:
.. code-block:: python
for submission in reddit.subreddit("all").search("praw"):
print(submission.title)
"""
self._validate_time_filter(time_filter)
not_all = self.display_name.lower() != "all"
self._safely_add_arguments(
arguments=generator_kwargs,
key="params",
q=query,
restrict_sr=not_all,
sort=sort,
syntax=syntax,
t=time_filter,
)
url = API_PATH["search"].format(subreddit=self)
return ListingGenerator(self._reddit, url, **generator_kwargs)
@_deprecate_args("number")
def sticky(self, *, number: int = 1) -> praw.models.Submission:
"""Return a :class:`.Submission` object for a sticky of the subreddit.
:param number: Specify which sticky to return. 1 appears at the top (default:
``1``).
:raises: ``prawcore.NotFound`` if the sticky does not exist.
For example, to get the stickied post on r/test:
.. code-block:: python
reddit.subreddit("test").sticky()
"""
url = API_PATH["about_sticky"].format(subreddit=self)
try:
self._reddit.get(url, params={"num": number})
except Redirect as redirect:
path = redirect.path
return self._submission_class(
self._reddit, url=urljoin(self._reddit.config.reddit_url, path)
)
@_deprecate_args(
"title",
"selftext",
"url",
"flair_id",
"flair_text",
"resubmit",
"send_replies",
"nsfw",
"spoiler",
"collection_id",
"discussion_type",
"inline_media",
"draft_id",
)
def submit(
self,
title: str,
*,
collection_id: str | None = None,
discussion_type: str | None = None,
draft_id: str | None = None,
flair_id: str | None = None,
flair_text: str | None = None,
inline_media: dict[str, praw.models.InlineMedia] | None = None,
nsfw: bool = False,
resubmit: bool = True,
selftext: str | None = None,
send_replies: bool = True,
spoiler: bool = False,
url: str | None = None,
) -> praw.models.Submission:
r"""Add a submission to the :class:`.Subreddit`.
:param title: The title of the submission.
:param collection_id: The UUID of a :class:`.Collection` to add the
newly-submitted post to.
:param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of
traditional comments (default: ``None``).
:param draft_id: The ID of a draft to submit.
:param flair_id: The flair template to select (default: ``None``).
:param flair_text: If the template's ``flair_text_editable`` value is ``True``,
this value will set a custom text (default: ``None``). ``flair_id`` is
required when ``flair_text`` is provided.
:param inline_media: A dict of :class:`.InlineMedia` objects where the key is
the placeholder name in ``selftext``.
:param nsfw: Whether the submission should be marked NSFW (default: ``False``).
:param resubmit: When ``False``, an error will occur if the URL has already been
submitted (default: ``True``).
:param selftext: The Markdown formatted content for a ``text`` submission. Use
an empty string, ``""``, to make a title-only submission.
:param send_replies: When ``True``, messages will be sent to the submission
author when comments are made to the submission (default: ``True``).
:param spoiler: Whether the submission should be marked as a spoiler (default:
``False``).
:param url: The URL for a ``link`` submission.
:returns: A :class:`.Submission` object for the newly created submission.
Either ``selftext`` or ``url`` can be provided, but not both.
For example, to submit a URL to r/test do:
.. code-block:: python
title = "PRAW documentation"
url = "https://praw.readthedocs.io"
reddit.subreddit("test").submit(title, url=url)
For example, to submit a self post with inline media do:
.. code-block:: python
from praw.models import InlineGif, InlineImage, InlineVideo
gif = InlineGif(path="path/to/image.gif", caption="optional caption")
image = InlineImage(path="path/to/image.jpg", caption="optional caption")
video = InlineVideo(path="path/to/video.mp4", caption="optional caption")
selftext = "Text with a gif {gif1} an image {image1} and a video {video1} inline"
media = {"gif1": gif, "image1": image, "video1": video}
reddit.subreddit("test").submit("title", inline_media=media, selftext=selftext)
.. note::
Inserted media will have a padding of ``\\n\\n`` automatically added. This
is due to the weirdness with Reddit's API. Using the example above, the
result selftext body will look like so:
.. code-block::
Text with a gif
![gif](u1rchuphryq51 "optional caption")
an image
![img](srnr8tshryq51 "optional caption")
and video
![video](gmc7rvthryq51 "optional caption")
inline
.. note::
To submit a post to a subreddit with the ``"news"`` flair, you can get the
flair id like this:
.. code-block::
choices = list(subreddit.flair.link_templates.user_selectable())
template_id = next(x for x in choices if x["flair_text"] == "news")["flair_template_id"]
subreddit.submit("title", flair_id=template_id, url="https://www.news.com/")
.. seealso::
- :meth:`~.Subreddit.submit_gallery` to submit more than one image in the
same post
- :meth:`~.Subreddit.submit_image` to submit images
- :meth:`~.Subreddit.submit_poll` to submit polls
- :meth:`~.Subreddit.submit_video` to submit videos and videogifs
"""
if (bool(selftext) or selftext == "") == bool(url):
msg = "Either 'selftext' or 'url' must be provided."
raise TypeError(msg)
data = {
"sr": str(self),
"resubmit": bool(resubmit),
"sendreplies": bool(send_replies),
"title": title,
"nsfw": bool(nsfw),
"spoiler": bool(spoiler),
"validate_on_submit": self._reddit.validate_on_submit,
}
for key, value in (
("flair_id", flair_id),
("flair_text", flair_text),
("collection_id", collection_id),
("discussion_type", discussion_type),
("draft_id", draft_id),
):
if value is not None:
data[key] = value
if selftext is not None:
data.update(kind="self")
if inline_media:
body = selftext.format(
**{
placeholder: self._upload_inline_media(media)
for placeholder, media in inline_media.items()
}
)
converted = self._convert_to_fancypants(body)
data.update(richtext_json=dumps(converted))
else:
data.update(text=selftext)
else:
data.update(kind="link", url=url)
return self._reddit.post(API_PATH["submit"], data=data)
@_deprecate_args(
"title",
"images",
"collection_id",
"discussion_type",
"flair_id",
"flair_text",
"nsfw",
"send_replies",
"spoiler",
)
def submit_gallery(
self,
title: str,
images: list[dict[str, str]],
*,
collection_id: str | None = None,
discussion_type: str | None = None,
flair_id: str | None = None,
flair_text: str | None = None,
nsfw: bool = False,
send_replies: bool = True,
spoiler: bool = False,
) -> praw.models.Submission:
"""Add an image gallery submission to the subreddit.
:param title: The title of the submission.
:param images: The images to post in dict with the following structure:
``{"image_path": "path", "caption": "caption", "outbound_url": "url"}``,
only ``image_path`` is required.
:param collection_id: The UUID of a :class:`.Collection` to add the
newly-submitted post to.
:param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of
traditional comments (default: ``None``).
:param flair_id: The flair template to select (default: ``None``).
:param flair_text: If the template's ``flair_text_editable`` value is ``True``,
this value will set a custom text (default: ``None``). ``flair_id`` is
required when ``flair_text`` is provided.
:param nsfw: Whether the submission should be marked NSFW (default: ``False``).
:param send_replies: When ``True``, messages will be sent to the submission
author when comments are made to the submission (default: ``True``).
:param spoiler: Whether the submission should be marked asa spoiler (default:
``False``).
:returns: A :class:`.Submission` object for the newly created submission.
:raises: :class:`.ClientException` if ``image_path`` in ``images`` refers to a
file that is not an image.
For example, to submit an image gallery to r/test do:
.. code-block:: python
title = "My favorite pictures"
image = "/path/to/image.png"
image2 = "/path/to/image2.png"
image3 = "/path/to/image3.png"
images = [
{"image_path": image},
{
"image_path": image2,
"caption": "Image caption 2",
},
{
"image_path": image3,
"caption": "Image caption 3",
"outbound_url": "https://example.com/link3",
},
]
reddit.subreddit("test").submit_gallery(title, images)
.. seealso::
- :meth:`~.Subreddit.submit` to submit url posts and selftexts
- :meth:`~.Subreddit.submit_image` to submit single images
- :meth:`~.Subreddit.submit_poll` to submit polls
- :meth:`~.Subreddit.submit_video` to submit videos and videogifs
"""
self._validate_gallery(images)
data = {
"api_type": "json",
"items": [],
"nsfw": bool(nsfw),
"sendreplies": bool(send_replies),
"show_error_list": True,
"spoiler": bool(spoiler),
"sr": str(self),
"title": title,
"validate_on_submit": self._reddit.validate_on_submit,
}
for key, value in (
("flair_id", flair_id),
("flair_text", flair_text),
("collection_id", collection_id),
("discussion_type", discussion_type),
):
if value is not None:
data[key] = value
for image in images:
data["items"].append(
{
"caption": image.get("caption", ""),
"outbound_url": image.get("outbound_url", ""),
"media_id": self._upload_media(
expected_mime_prefix="image",
media_path=image["image_path"],
upload_type="gallery",
),
}
)
response = self._reddit.request(
json=data, method="POST", path=API_PATH["submit_gallery_post"]
)["json"]
if response["errors"]:
raise RedditAPIException(response["errors"])
return self._reddit.submission(url=response["data"]["url"])
@_deprecate_args(
"title",
"image_path",
"flair_id",
"flair_text",
"resubmit",
"send_replies",
"nsfw",
"spoiler",
"timeout",
"collection_id",
"without_websockets",
"discussion_type",
)
def submit_image(
self,
title: str,
image_path: str,
*,
collection_id: str | None = None,
discussion_type: str | None = None,
flair_id: str | None = None,
flair_text: str | None = None,
nsfw: bool = False,
resubmit: bool = True,
send_replies: bool = True,
spoiler: bool = False,
timeout: int = 10,
without_websockets: bool = False,
) -> praw.models.Submission | None:
"""Add an image submission to the subreddit.
:param collection_id: The UUID of a :class:`.Collection` to add the
newly-submitted post to.
:param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of
traditional comments (default: ``None``).
:param flair_id: The flair template to select (default: ``None``).
:param flair_text: If the template's ``flair_text_editable`` value is ``True``,
this value will set a custom text (default: ``None``). ``flair_id`` is
required when ``flair_text`` is provided.
:param image_path: The path to an image, to upload and post.
:param nsfw: Whether the submission should be marked NSFW (default: ``False``).
:param resubmit: When ``False``, an error will occur if the URL has already been
submitted (default: ``True``).
:param send_replies: When ``True``, messages will be sent to the submission
author when comments are made to the submission (default: ``True``).
:param spoiler: Whether the submission should be marked as a spoiler (default:
``False``).
:param timeout: Specifies a particular timeout, in seconds. Use to avoid
"Websocket error" exceptions (default: ``10``).
:param title: The title of the submission.
:param without_websockets: Set to ``True`` to disable use of WebSockets (see
note below for an explanation). If ``True``, this method doesn't return
anything (default: ``False``).
:returns: A :class:`.Submission` object for the newly created submission, unless
``without_websockets`` is ``True``.
:raises: :class:`.ClientException` if ``image_path`` refers to a file that is
not an image.
.. note::
Reddit's API uses WebSockets to respond with the link of the newly created
post. If this fails, the method will raise :class:`.WebSocketException`.
Occasionally, the Reddit post will still be created. More often, there is an
error with the image file. If you frequently get exceptions but successfully
created posts, try setting the ``timeout`` parameter to a value above 10.
To disable the use of WebSockets, set ``without_websockets=True``. This will
make the method return ``None``, though the post will still be created. You
may wish to do this if you are running your program in a restricted network
environment, or using a proxy that doesn't support WebSockets connections.
For example, to submit an image to r/test do:
.. code-block:: python
title = "My favorite picture"
image = "/path/to/image.png"
reddit.subreddit("test").submit_image(title, image)
.. seealso::
- :meth:`~.Subreddit.submit` to submit url posts and selftexts
- :meth:`~.Subreddit.submit_gallery` to submit more than one image in the
same post
- :meth:`~.Subreddit.submit_poll` to submit polls
- :meth:`~.Subreddit.submit_video` to submit videos and videogifs
"""
data = {
"sr": str(self),
"resubmit": bool(resubmit),
"sendreplies": bool(send_replies),
"title": title,
"nsfw": bool(nsfw),
"spoiler": bool(spoiler),
"validate_on_submit": self._reddit.validate_on_submit,
}
for key, value in (
("flair_id", flair_id),
("flair_text", flair_text),
("collection_id", collection_id),
("discussion_type", discussion_type),
):
if value is not None:
data[key] = value
image_url = self._upload_media(
expected_mime_prefix="image", media_path=image_path
)
data.update(kind="image", url=image_url)
return self._submit_media(
data=data, timeout=timeout, without_websockets=without_websockets
)
@_deprecate_args(
"title",
"selftext",
"options",
"duration",
"flair_id",
"flair_text",
"resubmit",
"send_replies",
"nsfw",
"spoiler",
"collection_id",
"discussion_type",
)
def submit_poll(
self,
title: str,
*,
collection_id: str | None = None,
discussion_type: str | None = None,
duration: int,
flair_id: str | None = None,
flair_text: str | None = None,
nsfw: bool = False,
options: list[str],
resubmit: bool = True,
selftext: str,
send_replies: bool = True,
spoiler: bool = False,
) -> praw.models.Submission:
"""Add a poll submission to the subreddit.
:param title: The title of the submission.
:param collection_id: The UUID of a :class:`.Collection` to add the
newly-submitted post to.
:param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of
traditional comments (default: ``None``).
:param duration: The number of days the poll should accept votes, as an ``int``.
Valid values are between ``1`` and ``7``, inclusive.
:param flair_id: The flair template to select (default: ``None``).
:param flair_text: If the template's ``flair_text_editable`` value is ``True``,
this value will set a custom text (default: ``None``). ``flair_id`` is
required when ``flair_text`` is provided.
:param nsfw: Whether the submission should be marked NSFW (default: ``False``).
:param options: A list of two to six poll options as ``str``.
:param resubmit: When ``False``, an error will occur if the URL has already been
submitted (default: ``True``).
:param selftext: The Markdown formatted content for the submission. Use an empty
string, ``""``, to make a submission with no text contents.
:param send_replies: When ``True``, messages will be sent to the submission
author when comments are made to the submission (default: ``True``).
:param spoiler: Whether the submission should be marked as a spoiler (default:
``False``).
:returns: A :class:`.Submission` object for the newly created submission.
For example, to submit a poll to r/test do:
.. code-block:: python
title = "Do you like PRAW?"
reddit.subreddit("test").submit_poll(
title, selftext="", options=["Yes", "No"], duration=3
)
.. seealso::
- :meth:`~.Subreddit.submit` to submit url posts and selftexts
- :meth:`~.Subreddit.submit_gallery` to submit more than one image in the
same post
- :meth:`~.Subreddit.submit_image` to submit single images
- :meth:`~.Subreddit.submit_video` to submit videos and videogifs
"""
data = {
"sr": str(self),
"text": selftext,
"options": options,
"duration": duration,
"resubmit": bool(resubmit),
"sendreplies": bool(send_replies),
"title": title,
"nsfw": bool(nsfw),
"spoiler": bool(spoiler),
"validate_on_submit": self._reddit.validate_on_submit,
}
for key, value in (
("flair_id", flair_id),
("flair_text", flair_text),
("collection_id", collection_id),
("discussion_type", discussion_type),
):
if value is not None:
data[key] = value
return self._reddit.post(API_PATH["submit_poll_post"], json=data)
@_deprecate_args(
"title",
"video_path",
"videogif",
"thumbnail_path",
"flair_id",
"flair_text",
"resubmit",
"send_replies",
"nsfw",
"spoiler",
"timeout",
"collection_id",
"without_websockets",
"discussion_type",
)
def submit_video(
self,
title: str,
video_path: str,
*,
collection_id: str | None = None,
discussion_type: str | None = None,
flair_id: str | None = None,
flair_text: str | None = None,
nsfw: bool = False,
resubmit: bool = True,
send_replies: bool = True,
spoiler: bool = False,
thumbnail_path: str | None = None,
timeout: int = 10,
videogif: bool = False,
without_websockets: bool = False,
) -> praw.models.Submission | None:
"""Add a video or videogif submission to the subreddit.
:param title: The title of the submission.
:param video_path: The path to a video, to upload and post.
:param collection_id: The UUID of a :class:`.Collection` to add the
newly-submitted post to.
:param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of
traditional comments (default: ``None``).
:param flair_id: The flair template to select (default: ``None``).
:param flair_text: If the template's ``flair_text_editable`` value is ``True``,
this value will set a custom text (default: ``None``). ``flair_id`` is
required when ``flair_text`` is provided.
:param nsfw: Whether the submission should be marked NSFW (default: ``False``).
:param resubmit: When ``False``, an error will occur if the URL has already been
submitted (default: ``True``).
:param send_replies: When ``True``, messages will be sent to the submission
author when comments are made to the submission (default: ``True``).
:param spoiler: Whether the submission should be marked as a spoiler (default:
``False``).
:param thumbnail_path: The path to an image, to be uploaded and used as the
thumbnail for this video. If not provided, the PRAW logo will be used as the
thumbnail.
:param timeout: Specifies a particular timeout, in seconds. Use to avoid
"Websocket error" exceptions (default: ``10``).
:param videogif: If ``True``, the video is uploaded as a videogif, which is
essentially a silent video (default: ``False``).
:param without_websockets: Set to ``True`` to disable use of WebSockets (see
note below for an explanation). If ``True``, this method doesn't return
anything (default: ``False``).
:returns: A :class:`.Submission` object for the newly created submission, unless
``without_websockets`` is ``True``.
:raises: :class:`.ClientException` if ``video_path`` refers to a file that is
not a video.
.. note::
Reddit's API uses WebSockets to respond with the link of the newly created
post. If this fails, the method will raise :class:`.WebSocketException`.
Occasionally, the Reddit post will still be created. More often, there is an
error with the image file. If you frequently get exceptions but successfully
created posts, try setting the ``timeout`` parameter to a value above 10.
To disable the use of WebSockets, set ``without_websockets=True``. This will
make the method return ``None``, though the post will still be created. You
may wish to do this if you are running your program in a restricted network
environment, or using a proxy that doesn't support WebSockets connections.
For example, to submit a video to r/test do:
.. code-block:: python
title = "My favorite movie"
video = "/path/to/video.mp4"
reddit.subreddit("test").submit_video(title, video)
.. seealso::
- :meth:`~.Subreddit.submit` to submit url posts and selftexts
- :meth:`~.Subreddit.submit_image` to submit images
- :meth:`~.Subreddit.submit_gallery` to submit more than one image in the
same post
- :meth:`~.Subreddit.submit_poll` to submit polls
"""
data = {
"sr": str(self),
"resubmit": bool(resubmit),
"sendreplies": bool(send_replies),
"title": title,
"nsfw": bool(nsfw),
"spoiler": bool(spoiler),
"validate_on_submit": self._reddit.validate_on_submit,
}
for key, value in (
("flair_id", flair_id),
("flair_text", flair_text),
("collection_id", collection_id),
("discussion_type", discussion_type),
):
if value is not None:
data[key] = value
video_url = self._upload_media(
expected_mime_prefix="video", media_path=video_path
)
data.update(
kind="videogif" if videogif else "video",
url=video_url,
# if thumbnail_path is None, it uploads the PRAW logo
video_poster_url=self._upload_media(media_path=thumbnail_path),
)
return self._submit_media(
data=data, timeout=timeout, without_websockets=without_websockets
)
@_deprecate_args("other_subreddits")
def subscribe(self, *, other_subreddits: list[praw.models.Subreddit] | None = None):
"""Subscribe to the subreddit.
:param other_subreddits: When provided, also subscribe to the provided list of
subreddits.
For example, to subscribe to r/test:
.. code-block:: python
reddit.subreddit("test").subscribe()
"""
data = {
"action": "sub",
"skip_inital_defaults": True,
"sr_name": self._subreddit_list(
other_subreddits=other_subreddits, subreddit=self
),
}
self._reddit.post(API_PATH["subscribe"], data=data)
def traffic(self) -> dict[str, list[list[int]]]:
"""Return a dictionary of the :class:`.Subreddit`'s traffic statistics.
:raises: ``prawcore.NotFound`` when the traffic stats aren't available to the
authenticated user, that is, they are not public and the authenticated user
is not a moderator of the subreddit.
The traffic method returns a dict with three keys. The keys are ``day``,
``hour`` and ``month``. Each key contains a list of lists with 3 or 4 values.
The first value is a timestamp indicating the start of the category (start of
the day for the ``day`` key, start of the hour for the ``hour`` key, etc.). The
second, third, and fourth values indicate the unique pageviews, total pageviews,
and subscribers, respectively.
.. note::
The ``hour`` key does not contain subscribers, and therefore each sub-list
contains three values.
For example, to get the traffic stats for r/test:
.. code-block:: python
stats = reddit.subreddit("test").traffic()
"""
return self._reddit.get(API_PATH["about_traffic"].format(subreddit=self))
@_deprecate_args("other_subreddits")
def unsubscribe(
self, *, other_subreddits: list[praw.models.Subreddit] | None = None
):
"""Unsubscribe from the subreddit.
:param other_subreddits: When provided, also unsubscribe from the provided list
of subreddits.
To unsubscribe from r/test:
.. code-block:: python
reddit.subreddit("test").unsubscribe()
"""
data = {
"action": "unsub",
"sr_name": self._subreddit_list(
other_subreddits=other_subreddits, subreddit=self
),
}
self._reddit.post(API_PATH["subscribe"], data=data)
WidgetEncoder._subreddit_class = Subreddit
class SubredditLinkFlairTemplates(SubredditFlairTemplates):
"""Provide functions to interact with link flair templates."""
def __iter__(
self,
) -> Generator[dict[str, str | int | bool | list[dict[str, str]]], None, None]:
"""Iterate through the link flair templates as a moderator.
For example:
.. code-block:: python
for template in reddit.subreddit("test").flair.link_templates:
print(template)
"""
url = API_PATH["link_flair"].format(subreddit=self.subreddit)
yield from self.subreddit._reddit.get(url)
@_deprecate_args(
"text",
"css_class",
"text_editable",
"background_color",
"text_color",
"mod_only",
"allowable_content",
"max_emojis",
)
def add(
self,
text: str,
*,
allowable_content: str | None = None,
background_color: str | None = None,
css_class: str = "",
max_emojis: int | None = None,
mod_only: bool | None = None,
text_color: str | None = None,
text_editable: bool = False,
):
"""Add a link flair template to the associated subreddit.
:param text: The flair template's text.
:param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``,
or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then
the ``"text"`` param must be a valid emoji string, for example,
``":snoo:"``.
:param background_color: The flair template's new background color, as a hex
color.
:param css_class: The flair template's css_class (default: ``""``).
:param max_emojis: Maximum emojis in the flair (Reddit defaults this value to
``10``).
:param mod_only: Indicate if the flair can only be used by moderators.
:param text_color: The flair template's new text color, either ``"light"`` or
``"dark"``.
:param text_editable: Indicate if the flair text can be modified for each
redditor that sets it (default: ``False``).
For example, to add an editable link flair try:
.. code-block:: python
reddit.subreddit("test").flair.link_templates.add(
"PRAW",
css_class="praw",
text_editable=True,
)
"""
self._add(
allowable_content=allowable_content,
background_color=background_color,
css_class=css_class,
is_link=True,
max_emojis=max_emojis,
mod_only=mod_only,
text=text,
text_color=text_color,
text_editable=text_editable,
)
def clear(self):
"""Remove all link flair templates from the subreddit.
For example:
.. code-block:: python
reddit.subreddit("test").flair.link_templates.clear()
"""
self._clear(is_link=True)
def reorder(self, flair_list: list[str]):
"""Reorder a list of flairs.
:param flair_list: A list of flair IDs.
For example, to reverse the order of the link flair list try:
.. code-block:: python
subreddit = reddit.subreddit("test")
flairs = [flair["id"] for flair in subreddit.flair.link_templates]
subreddit.flair.link_templates.reorder(list(reversed(flairs)))
"""
self._reorder(flair_list, is_link=True)
def user_selectable(
self,
) -> Generator[dict[str, str | bool], None, None]:
"""Iterate through the link flair templates as a regular user.
For example:
.. code-block:: python
for template in reddit.subreddit("test").flair.link_templates.user_selectable():
print(template)
"""
url = API_PATH["flairselector"].format(subreddit=self.subreddit)
yield from self.subreddit._reddit.post(url, data={"is_newlink": True})[
"choices"
]
class SubredditRedditorFlairTemplates(SubredditFlairTemplates):
"""Provide functions to interact with :class:`.Redditor` flair templates."""
def __iter__(
self,
) -> Generator[dict[str, str | int | bool | list[dict[str, str]]], None, None]:
"""Iterate through the user flair templates.
For example:
.. code-block:: python
for template in reddit.subreddit("test").flair.templates:
print(template)
"""
url = API_PATH["user_flair"].format(subreddit=self.subreddit)
params = {"unique": self.subreddit._reddit._next_unique}
yield from self.subreddit._reddit.get(url, params=params)
@_deprecate_args(
"text",
"css_class",
"text_editable",
"background_color",
"text_color",
"mod_only",
"allowable_content",
"max_emojis",
)
def add(
self,
text: str,
*,
allowable_content: str | None = None,
background_color: str | None = None,
css_class: str = "",
max_emojis: int | None = None,
mod_only: bool | None = None,
text_color: str | None = None,
text_editable: bool = False,
):
"""Add a redditor flair template to the associated subreddit.
:param text: The flair template's text.
:param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``,
or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then
the ``"text"`` param must be a valid emoji string, for example,
``":snoo:"``.
:param background_color: The flair template's new background color, as a hex
color.
:param css_class: The flair template's css_class (default: ``""``).
:param max_emojis: Maximum emojis in the flair (Reddit defaults this value to
``10``).
:param mod_only: Indicate if the flair can only be used by moderators.
:param text_color: The flair template's new text color, either ``"light"`` or
``"dark"``.
:param text_editable: Indicate if the flair text can be modified for each
redditor that sets it (default: ``False``).
For example, to add an editable redditor flair try:
.. code-block:: python
reddit.subreddit("test").flair.templates.add(
"PRAW",
css_class="praw",
text_editable=True,
)
"""
self._add(
allowable_content=allowable_content,
background_color=background_color,
css_class=css_class,
is_link=False,
max_emojis=max_emojis,
mod_only=mod_only,
text=text,
text_color=text_color,
text_editable=text_editable,
)
def clear(self):
"""Remove all :class:`.Redditor` flair templates from the subreddit.
For example:
.. code-block:: python
reddit.subreddit("test").flair.templates.clear()
"""
self._clear(is_link=False)
def reorder(self, flair_list: list[str]):
"""Reorder a list of flairs.
:param flair_list: A list of flair IDs.
For example, to reverse the order of the :class:`.Redditor` flair templates list
try:
.. code-block:: python
subreddit = reddit.subreddit("test")
flairs = [flair["id"] for flair in subreddit.flair.templates]
subreddit.flair.templates.reorder(list(reversed(flairs)))
"""
self._reorder(flair_list, is_link=False)
Reference in New Issue View Git Blame Copy Permalink