PRAW

https://praw.readthedocs.io/en/stable/
Admin
PRAW (Python Reddit API Wrapper) is a Python library that provides a simple interface to interact...
Tokens:330,795
Snippets:2,820
Trust Score:8.3
Update:3 days ago
Show doc for...
Tokens:
Raw
### Add Menu widget example

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditwidgetsmoderation.html

Example of creating a menu widget with both direct links and nested sub-menus.

```python
widget_moderation = reddit.subreddit("test").widgets.mod
menu_contents = [
    {"text": "My homepage", "url": "https://example.com"},
    {
        "text": "Python packages",
        "children": [
            {"text": "PRAW", "url": "https://praw.readthedocs.io/"},
            {"text": "requests", "url": "https://docs.python-requests.org/"},
        ],
    },
    {"text": "Reddit homepage", "url": "https://reddit.com"},
]
new_widget = widget_moderation.add_menu(data=menu_contents)
```

--------------------------------

### Install Development Dependencies

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Run this command from the root of the cloned project directory to create a virtual environment and install dependencies using uv.

```bash
uv sync
```

--------------------------------

### Install PRAW with uv

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

The recommended way to install PRAW using the uv package manager.

```bash
uv add praw
```

--------------------------------

### Install Pre-commit Hooks

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Install the pre-commit hooks to automatically run checks when you commit.

```bash
uv run pre-commit install
```

--------------------------------

### Example Subreddit Submit Method

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Example of a method with mandatory positional arguments and sorted keyword-only optional arguments.

```python
class Subreddit:
    def submit(
        self,
        title,
        *,
        collection_id=None,
        discussion_type=None,
        draft_id=None,
        flair_id=None,
        flair_text=None,
        inline_media=None,
        nsfw=False,
        resubmit=True,
        selftext=None,
        send_replies=True,
        spoiler=False,
        url=None,
    ): ...
```

--------------------------------

### Install older PRAW version with uv

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

Install a specific older version of PRAW using uv.

```bash
uv add praw==3.6.0
```

--------------------------------

### Add ImageWidget example

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditwidgetsmoderation.html

Demonstrates how to upload images and add an ImageWidget to a subreddit.

```python
widget_moderation = reddit.subreddit("test").widgets.mod
image_paths = ["/path/to/image1.jpg", "/path/to/image2.png"]
image_data = [
    {
        "width": 600,
        "height": 450,
        "linkUrl": "",
        "url": widget_moderation.upload_image(img_path),
    }
    for img_path in image_paths
]
styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"}
new_widget = widget_moderation.add_image_widget(
    short_name="My cool pictures", data=image_data, styles=styles
)
```

--------------------------------

### Create a Subreddit

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Example of creating a new subreddit using the subreddit helper.

```python
reddit.subreddit.create(name="coolnewsubname")
```

--------------------------------

### Install PRAW development version via git

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

Install the latest development version of PRAW by cloning the repository using git.

```bash
pip install --upgrade git+https://github.com/praw-dev/praw.git
```

--------------------------------

### Example Class Method Positional Arguments

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Example of using positional arguments when the order is clear without documentation.

```python
class ExampleClass:
    def pair(self, left, right): ...
```

--------------------------------

### Add a button widget

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditwidgetsmoderation.html

Example of creating a button widget with both text and image buttons.

```python
widget_moderation = reddit.subreddit("test").widgets.mod
my_image = widget_moderation.upload_image("/path/to/pic.jpg")
buttons = [
    {
        "kind": "text",
        "text": "View source",
        "url": "https://github.com/praw-dev/praw",
        "color": "#FF0000",
        "textColor": "#00FF00",
        "fillColor": "#0000FF",
        "hoverState": {
            "kind": "text",
            "text": "ecruos weiV",
            "color": "#FFFFFF",
            "textColor": "#000000",
            "fillColor": "#0000FF",
        },
    },
    {
        "kind": "image",
        "text": "View documentation",
        "linkUrl": "https://praw.readthedocs.io",
        "url": my_image,
        "height": 200,
        "width": 200,
        "hoverState": {"kind": "image", "url": my_image, "height": 200, "width": 200},
    },
]
styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"}
new_widget = widget_moderation.add_button_widget(
    short_name="Things to click",
    description="Click some of these *cool* links!",
    buttons=buttons,
    styles=styles,
)
```

--------------------------------

### Get stickied post

Source: https://praw.readthedocs.io/en/stable/code_overview/models/subreddit.html

Example of how to retrieve the stickied post on a subreddit.

```python
reddit.subreddit("test").sticky()
```

--------------------------------

### SubredditWiki.__init__(subreddit)

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditwiki.html

Initializes a SubredditWiki instance with the given subreddit.

```APIDOC
## SubredditWiki.__init__(subreddit)

### Description
Initialize a SubredditWiki instance.

### Method
__init__

### Parameters
- **subreddit** (Subreddit) - Required - The subreddit whose wiki to work with.

### Return Type
None
```

--------------------------------

### Get rising submissions for a subreddit

Source: https://praw.readthedocs.io/en/stable/code_overview/models/multireddit.html

Example of iterating over rising submissions for a specific subreddit.

```python
for submission in reddit.subreddit("test").rising():
    print(submission.title)
```

--------------------------------

### Opt-in workflow example

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditquarantine.html

Demonstrates opting into a quarantined subreddit, showing the transition from a Forbidden error to successful access.

```python
subreddit = reddit.subreddit("QUESTIONABLE")
next(subreddit.hot())  # Raises prawcore.Forbidden

subreddit.quaran.opt_in()
next(subreddit.hot())  # Returns Submission
```

--------------------------------

### Get hidden items of the authenticated user

Source: https://praw.readthedocs.io/en/stable/code_overview/models/redditor.html

Example of iterating through items hidden by the authenticated user.

```python
for item in reddit.user.me().hidden():
    print(item.id)
```

--------------------------------

### Reddit Initialization with Keyword Arguments

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/configuration/reddit_initialization.rst.txt

Example of initializing a Reddit instance by passing all configuration options as keyword arguments.

```APIDOC
## Reddit Initialization with Keyword Arguments

### Description
Initializes a PRAW Reddit instance by passing configuration options directly as keyword arguments, bypassing the need for a named site in praw.ini.

### Method
Constructor call

### Endpoint
praw.Reddit()

### Parameters
#### Keyword Arguments
- **client_id** (string) - Required - The client ID for the Reddit application.
- **client_secret** (string) - Required - The client secret for the Reddit application.
- **password** (string) - Required - The password for the Reddit account.
- **user_agent** (string) - Required - A unique user agent string identifying the application.
- **username** (string) - Required - The Reddit username.

### Request Example
```python
reddit = praw.Reddit(
    client_id="SI8pN3DSbt0zor",
    client_secret="xaxkj7HNh8kwg8e5t4m6KvSrbTI",
    password="1guiwevlfo00esyy",
    user_agent="testscript by u/fakebot3",
    username="fakebot3",
)
```

### Response
No explicit response is documented. The constructor returns a Reddit instance.
```

--------------------------------

### Get downvoted items of the authenticated user

Source: https://praw.readthedocs.io/en/stable/code_overview/models/redditor.html

Example of iterating through items downvoted by the authenticated user.

```python
for item in reddit.user.me().downvoted():
    print(item.id)
```

--------------------------------

### DomainListing.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/domainlisting.html

Initializes a DomainListing instance with a Reddit instance and a domain string.

```APIDOC
## DomainListing.__init__()

### Description
Initialize a DomainListing instance.

### Method
Constructor

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **domain** (str) - Required - The domain for which to obtain listings.

### Return Type
None
```

--------------------------------

### Example Class Method Argument Sorting

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Example of sorting arguments alphabetically and marking them as keyword-only.

```python
class ExampleClass:
    def example_method(
        self,
        *,
        arg1,
        arg2,
        optional_arg1=None,
    ): ...
```

--------------------------------

### Initialize Reddit instance with keyword arguments

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/configuration/reddit_initialization.rst.txt

This example demonstrates how to explicitly pass configuration credentials to the Reddit class constructor instead of using a site defined in praw.ini.

```python
reddit = praw.Reddit(
    client_id="SI8pN3DSbt0zor",
    client_secret="xaxkj7HNh8kwg8e5t4m6KvSrbTI",
    password="1guiwevlfo00esyy",
    user_agent="testscript by u/fakebot3",
    username="fakebot3",
)
```

--------------------------------

### Front.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit/front.html

Initializes a Front instance with a Reddit instance.

```APIDOC
## Front.__init__()

### Description
Initialize a `Front` instance.

### Method
Constructor

### Parameters
- **reddit** (praw.Reddit) - Required - An instance of Reddit.

### Return Type
None
```

--------------------------------

### Install older PRAW version with pip

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

Install a specific older version of PRAW using pip.

```bash
pip install praw==3.6.0
```

--------------------------------

### Config.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/config.html

Initializes a Config instance with the given site name, optional config interpolation, and additional settings.

```APIDOC
## Config.__init__()

### Description
Initializes a Config instance with the given site name, optional config interpolation, and additional settings.

### Method
Constructor

### Signature
Config(site_name, config_interpolation=None, **settings)

### Parameters
- **site_name** (str) - Required - The name of the Reddit site.
- **config_interpolation** (str | None) - Optional - The config interpolation method.
- **settings** (str | bool | int | None) - Optional - Additional settings as keyword arguments.

### Return Type
None
```

--------------------------------

### WidgetMedia.__init__(fp, /, name=None)

Source: https://praw.readthedocs.io/en/stable/code_overview/other/widgetmedia.html

Initializes a WidgetMedia instance. The fp parameter can be a path to a media file or bytes content. The name parameter is required when fp is bytes, and is used to infer the MIME type.

```APIDOC
## WidgetMedia.__init__(fp, /, name=None)

### Description
Initializes a WidgetMedia instance. The fp parameter can be a path to a media file or bytes content. The name parameter is required when fp is bytes, and is used to infer the MIME type.

### Method
Constructor

### Parameters
- **fp** (str | bytes) - Required - The path to a media file as a string, or the content of a media file as a bytes object.
- **name** (str | None) - Optional - The name of the media file, e.g., "picture.png". The name is used to infer the media's MIME type. When fp is a path the name is derived from it, otherwise this parameter is required.

### Return Type
None
```

--------------------------------

### SubredditListingMixin.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditlistingmixin.html

Initializes a SubredditListingMixin instance with a Reddit instance and optional data.

```APIDOC
## SubredditListingMixin.__init__()

### Description
Initializes a SubredditListingMixin instance.

### Method
Constructor

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any] | None) - Optional - Structured data.

### Return Type
None
```

--------------------------------

### Install PRAW with pip

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

Install PRAW using pip. Depending on your system, you may need to use pip3.

```bash
pip install praw
```

--------------------------------

### Menu.__init__

Source: https://praw.readthedocs.io/en/stable/code_overview/other/menu.html

Initialize a Widget instance.

```APIDOC
## Menu.__init__

### Description
Initialize a Widget instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any]) - Required - The structured data.

### Return Type
None
```

--------------------------------

### Announcement.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/models/announcement.html

Initializes an Announcement instance.

```APIDOC
## Announcement.__init__()

### Description
Initializes an Announcement instance.

### Method
Constructor

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **id** (str | None) - Optional - The announcement ID.
- **_data** (dict[str, Any] | None) - Optional - Structured data.

### Return Type
None
```

--------------------------------

### InlineVideo.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/inlinevideo.html

Initializes an InlineVideo instance with an optional caption and a required PostMedia object.

```APIDOC
## InlineVideo.__init__()

### Description
Initializes an InlineVideo instance with an optional caption and a required PostMedia object.

### Method
Constructor

### Signature
InlineVideo(*, caption=None, media)

### Parameters
- **caption** (str | None) - Optional - An optional caption to add to the video (default: None).
- **media** (PostMedia) - Required - The PostMedia to embed.

### Return Type
None
```

--------------------------------

### Install PRAW development version from GitHub archive

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/installation.rst.txt

Install the latest development version of PRAW directly from the GitHub main branch archive.

```bash
pip install --upgrade https://github.com/praw-dev/praw/archive/main.zip
```

--------------------------------

### Retrieve new comments starting from stream creation

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditstream.html

Use skip_existing=True to ignore historical comments and only receive new ones starting from the moment the stream is initialized.

```python
subreddit = reddit.subreddit("test")
for comment in subreddit.stream.comments(skip_existing=True):
    print(comment)
```

--------------------------------

### Reddit.info()

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Method to get information about items.

```APIDOC
## Reddit.info()

### Description
Method to get information about items.

### Method
Method

### Endpoint
Reddit.info()

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response documented.
```

--------------------------------

### PostFlairWidget.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/postflairwidget.html

Initialize a PostFlairWidget instance.

```APIDOC
## PostFlairWidget.__init__(reddit, _data)

### Description
Initialize a Widget instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - The Reddit instance.
- **_data** (dict[str, Any]) - The data for the widget.

### Return Type
None
```

--------------------------------

### Reddit.get()

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Method to perform a GET request.

```APIDOC
## Reddit.get()

### Description
Method to perform a GET request.

### Method
Method

### Endpoint
Reddit.get()

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response documented.
```

--------------------------------

### InlineMedia.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/inlinemedia.html

Initializes an InlineMedia instance with an optional caption and a PostMedia object to embed.

```APIDOC
## InlineMedia.__init__()

### Description
Initializes an InlineMedia instance with an optional caption and a PostMedia object to embed.

### Method
Constructor

### Parameters
- **caption** (str | None) - Optional - An optional caption to add to the image (default: None).
- **media** (PostMedia) - Required - The PostMedia to embed.

### Return Type
None
```

--------------------------------

### SubredditRules.__init__(subreddit)

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditrules.html

Initialize a SubredditRules instance with the given subreddit.

```APIDOC
## SubredditRules.__init__(subreddit)

### Description
Initialize a SubredditRules instance.

### Method
__init__

### Parameters
- **subreddit** (Subreddit) - Required - The subreddit whose rules to work with.

### Return Type
None
```

--------------------------------

### Menu.mod

Source: https://praw.readthedocs.io/en/stable/code_overview/other/menu.html

Get an instance of WidgetModeration for this widget.

```APIDOC
## Menu.mod

### Description
Get an instance of WidgetModeration for this widget. Using any of the methods of WidgetModeration will likely make the data in the SubredditWidgets that this widget belongs to outdated. To remedy this, call refresh().

### Method
mod

### Return Type
WidgetModeration
```

--------------------------------

### ImageWidget.mod()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/imagewidget.html

Get an instance of WidgetModeration for this widget.

```APIDOC
## ImageWidget.mod()

### Description
Get an instance of WidgetModeration for this widget. Using any of the methods of WidgetModeration will likely make the data in the SubredditWidgets that this widget belongs to outdated. To remedy this, call refresh().

### Method
mod

### Return Type
WidgetModeration
```

--------------------------------

### ButtonWidget.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/buttonwidget.html

Initialize a Widget instance.

```APIDOC
## ButtonWidget.__init__()

### Description
Initialize a Widget instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - An instance of Reddit.
- **_data** (dict[str, Any]) - The structured data.

### Return Type
None
```

--------------------------------

### Collection.subreddit()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/collection.html

Get the subreddit that this collection belongs to.

```APIDOC
## Collection.subreddit()

### Description
Get the subreddit that this collection belongs to.

### Return Type
`Subreddit`

### Example Usage
```python
collection = reddit.subreddit("test").collections("some_uuid")
subreddit = collection.subreddit
```
```

--------------------------------

### Submenu.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/submenu.html

Initialize a BaseList instance.

```APIDOC
## Submenu.__init__()

### Description
Initialize a BaseList instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any]) - Required - The structured data.

### Return Type
None
```

--------------------------------

### Collection.__len__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/collection.html

Get the number of posts in this Collection.

```APIDOC
## Collection.__len__()

### Description
Get the number of posts in this Collection.

### Return Type
`int`

### Example Usage
```python
collection = reddit.subreddit("test").collections("some_uuid")
print(len(collection))
```
```

--------------------------------

### Run Tox Test Suite

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/contributing.rst.txt

Run all checks and ensure the documentation builds correctly using tox.

```bash
uv run tox
```

--------------------------------

### ButtonWidget.mod()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/buttonwidget.html

Get an instance of WidgetModeration for this widget.

```APIDOC
## ButtonWidget.mod()

### Description
Get an instance of WidgetModeration for this widget. Using any of the methods of WidgetModeration will likely make the data in the SubredditWidgets that this widget belongs to outdated. To remedy this, call refresh().

### Method
mod

### Return Type
WidgetModeration
```

--------------------------------

### Reddit.domain()

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Method to get submissions from a specific domain.

```APIDOC
## Reddit.domain()

### Description
Method to get submissions from a specific domain.

### Method
Method

### Endpoint
Reddit.domain()

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response documented.
```

--------------------------------

### Add TextArea widget example

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditwidgetsmoderation.html

Demonstrates adding a TextArea widget with custom markdown text and styles.

```python
widget_moderation = reddit.subreddit("test").widgets.mod
styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"}
new_widget = widget_moderation.add_text_area(
    short_name="My cool title", text="*Hello* **world**!", styles=styles
)
```

--------------------------------

### LiveThread.discussions(**generator_kwargs)

Source: https://praw.readthedocs.io/en/stable/code_overview/models/livethread.html

Get submissions linking to the thread.

```APIDOC
## LiveThread.discussions(**generator_kwargs)

### Description
Get submissions linking to the thread.

### Method
discussions

### Parameters
- **generator_kwargs** (Any) - Optional - Keyword arguments passed to ListingGenerator constructor.

### Return Type
Iterator[Submission]

### Returns
A ListingGenerator object which yields Submission objects.

### Usage Example
```python
thread = reddit.live("ukaeu1ik4sw5")
for submission in thread.discussions(limit=None):
    print(submission.title)
```
```

--------------------------------

### Styles.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/styles.html

Initializes a Styles instance. This is the constructor for the Styles class.

```APIDOC
## Styles.__init__()

### Description
Initializes a Styles instance. This is the constructor for the Styles class.

### Method
Constructor

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any] | None) - Required - The structured data.

### Return Type
None
```

--------------------------------

### Reddit.auth

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Provides the interface for interacting with installed and web applications.

```APIDOC
## Reddit.auth

### Description
Provides the interface for interacting with installed and web applications.

### Return Type
Auth
```

--------------------------------

### ImageWidget.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/imagewidget.html

Initialize a Widget instance.

```APIDOC
## ImageWidget.__init__()

### Description
Initialize a Widget instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - An instance of Reddit.
- **_data** (dict[str, Any]) - The structured data.

### Return Type
None
```

--------------------------------

### Lock comment or submission

Source: https://praw.readthedocs.io/en/stable/code_overview/other/commentmoderation.html

Example of locking a comment and a submission.

```python
# lock a comment:
comment = reddit.comment("dkk4qjd")
comment.mod.lock()
# lock a submission:
submission = reddit.submission("5or86n")
submission.mod.lock()
```

--------------------------------

### SubredditFlairTemplates.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditflairtemplates.html

Initializes a SubredditFlairTemplates instance. This method should not be called directly; instead, obtain an instance via reddit.subreddit("test").flair.templates or reddit.subreddit("test").flair.link_templates.

```APIDOC
## SubredditFlairTemplates.__init__()

### Description
Initializes a SubredditFlairTemplates instance. This method should not be called directly; instead, obtain an instance via `reddit.subreddit("test").flair.templates` or `reddit.subreddit("test").flair.link_templates`.

### Method
Constructor

### Parameters
- **subreddit** (`Subreddit`) - Required - The subreddit whose flair templates to work with.

### Return Type
`None`
```

--------------------------------

### Search subreddits

Source: https://praw.readthedocs.io/en/stable/code_overview/models/subreddit.html

Example of how to search for a query across all subreddits.

```python
for submission in reddit.subreddit("all").search("praw"):
    print(submission.title)
```

--------------------------------

### SubredditQuarantine.__init__()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditquarantine.html

Initializes a SubredditQuarantine instance with the associated Subreddit object.

```APIDOC
## SubredditQuarantine.__init__()

### Description
Initializes a SubredditQuarantine instance.

### Method
Constructor

### Parameters
- **subreddit** (Subreddit) - Required - The Subreddit associated with the quarantine.

### Return Type
None
```

--------------------------------

### Initialize LiveUpdate

Source: https://praw.readthedocs.io/en/stable/code_overview/models/liveupdate.html

Demonstrates how to instantiate a LiveUpdate object using a thread ID and an update ID.

```python
update = LiveUpdate(reddit, "ukaeu1ik4sw5", "7827987a-c998-11e4-a0b9-22000b6a88d2")
update.thread  # LiveThread(id="ukaeu1ik4sw5")
update.id  # "7827987a-c998-11e4-a0b9-22000b6a88d2"
update.author  # "umbrae"
```

--------------------------------

### SubredditCollections.mod()

Source: https://praw.readthedocs.io/en/stable/code_overview/other/subredditcollections.html

Gets an instance of SubredditCollectionsModeration, which provides the create() method.

```APIDOC
## SubredditCollections.mod()

### Description
Get an instance of SubredditCollectionsModeration. Provides create().

### Method
mod

### Returns
- **SubredditCollectionsModeration** - An instance for moderation.

### Example Usage
```
my_sub = reddit.subreddit("test")
new_collection = my_sub.collections.mod.create(title="Title", description="desc")
```
```

--------------------------------

### Example ratelimit log output

Source: https://praw.readthedocs.io/en/stable/_sources/getting_started/logging.rst.txt

Shows the expected log entry format when a POST action triggers a ratelimit.

```text
Rate limit hit, sleeping for 5.5 seconds
```

--------------------------------

### Check username availability

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Example of checking if a specific username is available.

```python
reddit.username_available("bboe")
```

--------------------------------

### Constructing Media instances

Source: https://praw.readthedocs.io/en/stable/_sources/package_info/praw8_migration.rst.txt

Media instances can be created from a file path or from bytes content with a name, avoiding the need to write to disk.

```python
from praw.models import PostMedia

media_from_path = PostMedia("/path/to/image.png")
media_from_bytes = PostMedia(image_bytes, "image.png")
```

--------------------------------

### Iterate over default subreddits

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Example of iterating over the set of default subreddits.

```python
for subreddit in reddit.subreddits.default(limit=None):
    print(subreddit)
```

--------------------------------

### Leave a moderator position

Source: https://praw.readthedocs.io/en/stable/code_overview/other/moderatorrelationship.html

Example of abdicating a moderator position for a subreddit.

```python
reddit.subreddit("test").moderator.leave()
```

--------------------------------

### AnnouncementListing.__init__(reddit, _data)

Source: https://praw.readthedocs.io/en/stable/code_overview/other/announcementlisting.html

Initializes an AnnouncementListing instance. This constructor is inherited from PRAWBase and sets up the instance with the provided Reddit instance and data dictionary.

```APIDOC
## AnnouncementListing.__init__(reddit, _data)

### Description
Initialize a PRAWBase instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any] | None) - Required - The structured data.

### Return Type
None

```

--------------------------------

### Invite a moderator

Source: https://praw.readthedocs.io/en/stable/code_overview/other/moderatorrelationship.html

Example of inviting a user to be a moderator with specific permissions.

```python
reddit.subreddit("test").moderator.invite("spez", permissions=["posts", "mail"])
```

--------------------------------

### Listing.__init__(reddit, _data)

Source: https://praw.readthedocs.io/en/stable/code_overview/other/listing.html

Initializes a PRAWBase instance with the given reddit instance and data.

```APIDOC
## Listing.__init__(reddit, _data)

### Description
Initialize a PRAWBase instance.

### Method
__init__

### Parameters
- **reddit** (Reddit) - Required - An instance of Reddit.
- **_data** (dict[str, Any] | None) - Required - The data for the instance.

### Return Type
None

```

--------------------------------

### Add a moderator

Source: https://praw.readthedocs.io/en/stable/code_overview/other/moderatorrelationship.html

Example of inviting a user to be a moderator with specific permissions.

```python
reddit.subreddit("test").moderator.add("spez", permissions=["posts", "mail"])
```

--------------------------------

### Create a live thread

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

Use the live helper to create a new live thread.

```python
reddit.live.create(title="title", description="description")
```

--------------------------------

### Initialize a Reddit instance

Source: https://praw.readthedocs.io/en/stable/code_overview/reddit_instance.html

The canonical way to obtain a Reddit instance by providing authentication credentials.

```python
import praw

reddit = praw.Reddit(
    client_id="CLIENT_ID",
    client_secret="CLIENT_SECRET",
    password="PASSWORD",
    user_agent="USERAGENT",
    username="USERNAME",
)
```
Tokens:
Raw