### Running Asynchronous Code with aPRAW and asyncio

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/quickstart.rst

Shows how to run aPRAW's asynchronous functions within an asyncio event loop. This example scans new posts in a subreddit and prints their titles.

```python
import apraw
import asyncio

# instantiate a `Reddit` instance
reddit = apraw.Reddit(client_id="CLIENT_ID", client_secret="CLIENT_SECRET",
                        password="PASSWORD", user_agent="USERAGENT",
                        username="USERNAME")

async def scan_posts():
  # get an instance of a subreddit
  subreddit = await reddit.subreddit("aprawtest")

  # loop through new posts
  async for submission in subreddit.new():
    print(submission.title)

if __name__ == "__main__":
    # get the asyncio event loop
    loop = asyncio.get_event_loop()

    # add scan_posts() to the queue and run it
    loop.run_until_complete(scan_posts())
```

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

### Instantiating Reddit Models with aPRAW

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/quickstart.rst

Illustrates how to obtain instances of various Reddit objects like subreddits, redditors, submissions, and comments using the `Reddit` instance.

```python
# instantiate a `Reddit` instance
reddit = apraw.Reddit(client_id="CLIENT_ID", client_secret="CLIENT_SECRET",
                        password="PASSWORD", user_agent="USERAGENT",
                        username="USERNAME")

# grab an instance of the /r/aPRAWTest subreddit
subreddit = await reddit.subreddit("aprawtest")

# grab an instance of the /u/aPRAWBot Redditor
redditor = await reddit.redditor("aprawbot")

# grab a test submission made on /r/aPRAWTest
submission = await reddit.submission("h7mna9")

# grab a test comment made on /r/aPRAWTest
comment = await reddit.comment("fulsybg")
```

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

### Create a Reddit Instance with aPRAW

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/quickstart.rst

Demonstrates how to instantiate a `Reddit` object using credentials obtained from Reddit's App Preferences. This is the first step to interacting with the Reddit API using aPRAW.

```python
import apraw


# instantiate a `Reddit` instance
# you can also supply a key to an entry within a praw.ini
# file, making your login compatible with praw as well
reddit = apraw.Reddit(username="USERNAME", password="PASSWORD",
                          client_id="CLIENT_ID", client_secret="CLIENT_SECRET",
                          user_agent="USERAGENT")
```

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

### Looping Through Items with aPRAW ListingGenerator

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/quickstart.rst

Demonstrates how to iterate through listings of Reddit items, such as new posts in a subreddit, using aPRAW's asynchronous generators.

```python
# get an instance of a subreddit
subreddit = await reddit.subreddit("aprawtest")

# loop through new posts
async for submission in subreddit.new():
    print(submission.id)
```

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

### Streaming Items with aPRAW ListingGenerator.stream()

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/quickstart.rst

Explains how to use the `stream()` method of aPRAW's `ListingGenerator` to efficiently poll Reddit API endpoints and receive new items as they become available.

```python
# get an instance of a subreddit
subreddit = await reddit.subreddit("aprawtest")

# stream new posts
async for submission in subreddit.new.stream():
    print(submission.id)
```

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

### Install aPRAW

Source: https://github.com/dan6erbond/apraw/blob/master/docs/getting_started/intro.rst

Installs the aPRAW library using pip. This command requires Python 3.6 or higher.

```shell
pip install aPRAW
```

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

### Install aPRAW

Source: https://github.com/dan6erbond/apraw/blob/master/README.md

Installs the aPRAW library using pip. Requires Python 3.6 or newer.

```pip
pip install apraw
```

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

### banhammer.Subreddit.setup() Dependencies

Source: https://github.com/dan6erbond/apraw/blob/master/docs/TODO.md

Dependencies for the setup method of the Subreddit class in Banhammer.py. This involves handling subreddit quarantine status and settings.

```APIDOC
banhammer.Subreddit.setup():
  Dependencies:
    - praw.models.Subreddit.quarantine
    - praw.models.Subreddit.quaran.opt_in()
    - praw.models.Subreddit.mod.settings()
```

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

### aPRAW Overview and Features

Source: https://github.com/dan6erbond/apraw/blob/master/docs/index.rst

Provides an overview of aPRAW, highlighting its key features such as asynchronous design, rate-limit handling, built-in listings and streams, compatibility with praw.ini, and OAuth2 support.

```python
aPRAW is an asynchronous Reddit API wrapper.

Features:

 - Modern Pythonic design using `async`/`await` syntax.
 - Automatic handling of rate-limits.
 - Built-in listings and streams for list endpoints.
 - Compatible with previous `praw.ini` files.
 - Proper OAuth2 support.
```

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

### aPRAW Models API Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/index.rst

This section details the API for various aPRAW models, covering their initialization, methods, and parameters. It serves as a reference for interacting with aPRAW objects like Subreddits, Submissions, Comments, and more.

```APIDOC
subreddit/index:
  Subreddit Model
  Represents a Reddit subreddit.
  Methods:
    __init__(name: str, reddit: Reddit)
      name: The name of the subreddit.
      reddit: The Reddit instance to use.
    hot(limit: int = 25, params: dict = None)
      Fetches hot submissions from the subreddit.
      limit: The maximum number of submissions to fetch.
      params: Additional parameters for the API request.
    new(limit: int = 25, params: dict = None)
      Fetches new submissions from the subreddit.
      limit: The maximum number of submissions to fetch.
      params: Additional parameters for the API request.
    top(limit: int = 25, params: dict = None)
      Fetches top submissions from the subreddit.
      limit: The maximum number of submissions to fetch.
      params: Additional parameters for the API request.

submission/index:
  Submission Model
  Represents a Reddit submission.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for the submission.
      reddit: The Reddit instance to use.
    comments()
      Fetches all comments for the submission.
    upvote()
      Upvotes the submission.
    downvote()
      Downvotes the submission.
    reply(text: str)
      Replies to the submission.

comment/index:
  Comment Model
  Represents a Reddit comment.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for the comment.
      reddit: The Reddit instance to use.
    replies()
      Fetches replies to the comment.
    upvote()
      Upvotes the comment.
    downvote()
      Downvotes the comment.
    reply(text: str)
      Replies to the comment.

message:
  Message Model
  Represents a Reddit private message.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for the message.
      reddit: The Reddit instance to use.
    mark_read()
      Marks the message as read.
    reply(text: str)
      Replies to the message.

redditor:
  Redditor Model
  Represents a Reddit user.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for the redditor.
      reddit: The Reddit instance to use.
    submissions()
      Fetches submissions by the redditor.
    comments()
      Fetches comments by the redditor.

more_comments:
  MoreComments Model
  Represents a placeholder for more comments.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for more_comments.
      reddit: The Reddit instance to use.
    comments()
      Fetches the actual comments.

listing:
  Listing Model
  Represents a list of items.
  Methods:
    __init__(data: dict, reddit: Reddit)
      data: The data dictionary for the listing.
      reddit: The Reddit instance to use.
    __iter__()
      Iterates over the items in the listing.
```

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

### banhammer.Subreddit.__init__() Dependencies

Source: https://github.com/dan6erbond/apraw/blob/master/docs/TODO.md

Dependencies for the __init__ method of the Subreddit class in Banhammer.py. This includes user authentication and moderator status checks.

```APIDOC
banhammer.Subreddit.__init__():
  Dependencies:
    - praw.Reddit.user.me()
    - praw.models.Subreddit.moderator()
    - praw.models.Subreddit.user_is_moderator
```

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

### Listing Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/listing.rst

Provides details on the Listing class, its attributes, and special methods for iteration and access. It highlights how listings are associated with the aPRAW Reddit instance and can contain other aPRAW models.

```APIDOC
Listing:
  Represents arrays returned by the Reddit API.
  Attributes:
    reddit: The :py:class:`~apraw.Reddit` instance it's working for.
    Subreddit: Reference to :py:class:`~apraw.models.Subreddit` if available.
    Submission: Reference to :py:class:`~apraw.models.Submission` if available.
  Special Methods:
    __getitem__(index): Allows accessing elements by index.
    __iter__(): Enables iteration over the listing.
    __len__(): Returns the number of items in the listing.
    __next__(): Used for iteration, returns the next item.

Related Methods:
  apraw.Reddit.get_listing(endpoint):
    Fetches raw listings from a given API endpoint.
    Returns: A Listing object.
```

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

### Basic aPRAW Usage

Source: https://github.com/dan6erbond/apraw/blob/master/README.md

Demonstrates how to instantiate the Reddit class, access a subreddit, and iterate through new submissions asynchronously. Requires Reddit API credentials.

```python
import apraw
import asyncio


# instantiate a `Reddit` instance
# you can also supply a key to an entry within a praw.ini
# file, making your login compatible with praw as well
reddit = apraw.Reddit(client_id="CLIENT_ID", client_secret="CLIENT_SECRET",
                    password="PASSWORD", user_agent="USERAGENT",
                    username="USERNAME")

async def scan_posts():
  # get an instance of a subreddit
  subreddit = await reddit.subreddit("aprawtest")

  # loop through new posts
  async for submission in subreddit.new():
    print(submission.title)

if __name__ == "__main__":
    # get the asyncio event loop
    loop = asyncio.get_event_loop()

    # add scan_posts() to the queue and run it
    loop.run_until_complete(scan_posts())
```

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

### Instantiate Subreddit

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/subreddit/subreddit.rst

Demonstrates how to create a Subreddit object by fetching it from a given subreddit name using the reddit instance. This is an asynchronous operation.

```python3
sub = await reddit.subreddit("aprawtest")
```

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

### aPRAWBase Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/helpers/apraw_base.rst

Documentation for the aPRAWBase class, detailing its role in data assignment for Reddit models and its usage by other classes such as Submission and Comment.

```APIDOC
aPRAWBase:
  Description: Base class for Reddit models, responsible for self-assigning data from API endpoints.
  Used By: Submission, Comment
  Members:
    __init__(self, data: dict, reddit: 'Reddit')
      Description: Initializes the aPRAWBase instance.
      Parameters:
        data (dict): A dictionary containing the data retrieved from the API.
        reddit (Reddit): An instance of the Reddit API client.
    _fetch_data(self, url: str, params: dict = None)
      Description: Fetches data from a given URL with optional parameters.
      Parameters:
        url (str): The URL to fetch data from.
        params (dict, optional): Optional parameters for the request. Defaults to None.
      Returns: dict: The JSON response from the API.
    _get_attribute(self, attribute: str, default: Any = None)
      Description: Safely retrieves an attribute from the instance's data.
      Parameters:
        attribute (str): The name of the attribute to retrieve.
        default (Any, optional): The default value to return if the attribute is not found. Defaults to None.
      Returns: Any: The value of the attribute or the default value.
    _set_attribute(self, attribute: str, value: Any)
      Description: Sets an attribute on the instance's data.
      Parameters:
        attribute (str): The name of the attribute to set.
        value (Any): The value to set for the attribute.
```

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

### banhammer.Subreddit.load_reactions() Dependencies

Source: https://github.com/dan6erbond/apraw/blob/master/docs/TODO.md

Dependencies for the load_reactions method of the Subreddit class in Banhammer.py. This function interacts with subreddit wiki pages.

```APIDOC
banhammer.Subreddit.load_reactions():
  Dependencies:
    - praw.models.Subreddit.wiki
    - praw.models.Subreddit.wiki.create()
```

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

### Instantiate Submission by ID

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/submission/submission.rst

Demonstrates how to create a Submission object by providing its unique ID. This is a common way to fetch a specific submission directly.

```python
submission = await reddit.submission("h7mna9")
```

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

### SubredditWikipage Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/subreddit/wiki.rst

Provides documentation for the SubredditWikipage class, detailing its members and functionality for representing a single wiki page.

```python
class SubredditWikipage:
    """Represents a single wiki page.

    Attributes:
        
    Methods:
        
    """
    pass
```

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

### banhammer.MessageBuilder.get_item_message() Dependencies

Source: https://github.com/dan6erbond/apraw/blob/master/docs/TODO.md

Dependencies for building a message for a Reddit item. This includes comment and submission details like author, subreddit, permalink, title, and selftext.

```APIDOC
banhammer.MessageBuilder.get_item_message():
  Dependencies:
    - praw.models.Comment.__str__()
    - praw.models.Comment.subreddit
    - praw.models.Comment.author
    - praw.models.Comment.permalink
    - praw.models.Comment.title
    - praw.models.Comment.selftext
    - praw.models.Submission.__str__()
    - praw.models.Submission.subreddit
    - praw.models.Submission.author
    - praw.models.Submission.permalink
    - praw.models.Submission.title
    - praw.models.Submission.selftext
```

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

### SubredditSettings Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/subreddit/moderation.rst

API documentation for the SubredditSettings class, outlining its members and inherited attributes.

```APIDOC
SubredditSettings:
    Members:
        (Details of members would be listed here, e.g., title, description, etc.)
    Inherited Members:
        (Details of inherited members would be listed here.)
```

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

### Streamable Class API

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/helpers/streamable.rst

API documentation for the Streamable class, detailing its constructor and special methods like __call__.

```APIDOC
Streamable:
  __call__(func)
    Decorator to wrap a function that returns an asynchronous iterator.

  stream():
    Returns an asynchronous iterator from the decorated function.
    Usage: decorated_function.stream()

  __init__(func)
    Initializes the Streamable decorator with the target function.
    Parameters:
      func: The function to decorate, which must return an asynchronous iterator.
```

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

### SubredditWiki Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/subreddit/wiki.rst

Provides documentation for the SubredditWiki class, detailing its members and functionality for interacting with subreddit wiki data.

```python
class SubredditWiki:
    """Represents a subreddit's wiki.

    Attributes:
        
    Methods:
        __call__(page: str, revision: Optional[int] = None, **kwargs) -> SubredditWikipage
            Fetches a specific wiki page or revision.
            Args:
                page (str): The name of the wiki page.
                revision (Optional[int], optional): The revision number to fetch. Defaults to None.
            Returns:
                SubredditWikipage: The requested wiki page object.
    """
    pass
```

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

### Instantiate Redditor

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/models/redditor.rst

Demonstrates how to create a Redditor object by specifying a username. This is the primary way to interact with a specific Reddit user's data through the apraw library.

```python
sub = await reddit.redditor("aprawbot")
```

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

### Reddit API Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/reddit/index.rst

Provides documentation for the main Reddit API client class, detailing its methods and functionalities for interacting with the Reddit API.

```APIDOC
Reddit:
  __init__(client_id: str, client_secret: str, user_agent: str, username: str = None, password: str = None)
    Initializes the Reddit API client.
    Parameters:
      client_id: Your Reddit application's client ID.
      client_secret: Your Reddit application's client secret.
      user_agent: A descriptive user agent string for your application.
      username: Reddit username for authenticated requests (optional).
      password: Reddit password for authenticated requests (optional).

  user(username: str)
    Retrieves a Reddit user object.
    Parameters:
      username: The username of the Reddit user to retrieve.
    Returns:
      A User object representing the specified Reddit user.

  me()
    Retrieves the currently authenticated user's profile.
    Requires authentication.
    Returns:
      A User object representing the authenticated user.

  subreddit(subreddit_name: str)
    Retrieves a subreddit object.
    Parameters:
      subreddit_name: The name of the subreddit to retrieve.
    Returns:
      A Subreddit object representing the specified subreddit.

  subreddit_stream(subreddit_name: str, limit: int = 100)
    Streams new submissions from a subreddit.
    Parameters:
      subreddit_name: The name of the subreddit to stream from.
      limit: The maximum number of submissions to retrieve.
    Returns:
      An iterator yielding Submission objects.

  multireddit(user: str, multi_name: str)
    Retrieves a multireddit.
    Parameters:
      user: The username of the user who created the multireddit.
      multi_name: The name of the multireddit.
    Returns:
      A Multireddit object.

  search(query: str, subreddit: str = None, sort: str = 'relevance', time_filter: str = 'all', limit: int = 25)
    Searches Reddit.
    Parameters:
      query: The search query string.
      subreddit: The subreddit to search within (optional).
      sort: How to sort search results (e.g., 'relevance', 'hot', 'new').
      time_filter: The time period for the search (e.g., 'all', 'year', 'month').
      limit: The maximum number of results to return.
    Returns:
      A list of Submission objects matching the search criteria.

  get_submission(url: str = None, id: str = None)
    Retrieves a specific submission by URL or ID.
    Parameters:
      url: The URL of the submission (optional).
      id: The ID of the submission (optional).
    Returns:
      A Submission object.

  get_comment(url: str = None, id: str = None)
    Retrieves a specific comment by URL or ID.
    Parameters:
      url: The URL of the comment (optional).
      id: The ID of the comment (optional).
    Returns:
      A Comment object.

  get_redditor(username: str)
    Retrieves a redditor (user) object.
    Parameters:
      username: The username of the redditor.
    Returns:
      A Redditor object.

  get_subreddit(display_name: str)
    Retrieves a subreddit object.
    Parameters:
      display_name: The display name of the subreddit.
    Returns:
      A Subreddit object.

  get_multireddit(user: str, multi_name: str)
    Retrieves a multireddit.
    Parameters:
      user: The username of the multireddit creator.
      multi_name: The name of the multireddit.
    Returns:
      A Multireddit object.

  get_reddits()
    Retrieves a list of subreddits the authenticated user is subscribed to.
    Requires authentication.
    Returns:
      A list of Subreddit objects.

  get_multireddits(user: str)
    Retrieves a list of multireddits created by a specific user.
    Parameters:
      user: The username of the multireddit creator.
    Returns:
      A list of Multireddit objects.

  get_redditor_submissions(username: str, sort: str = 'hot', limit: int = 100)
    Retrieves submissions made by a specific user.
    Parameters:
      username: The username of the redditor.
      sort: How to sort the submissions (e.g., 'hot', 'new', 'top').
      limit: The maximum number of submissions to retrieve.
    Returns:
      A list of Submission objects.

  get_redditor_comments(username: str, sort: str = 'hot', limit: int = 100)
    Retrieves comments made by a specific user.
    Parameters:
      username: The username of the redditor.
      sort: How to sort the comments (e.g., 'hot', 'new', 'top').
      limit: The maximum number of comments to retrieve.
    Returns:
      A list of Comment objects.

  get_subreddit_submissions(subreddit_name: str, sort: str = 'hot', limit: int = 100)
    Retrieves submissions from a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
      sort: How to sort the submissions (e.g., 'hot', 'new', 'top').
      limit: The maximum number of submissions to retrieve.
    Returns:
      A list of Submission objects.

  get_subreddit_rules(subreddit_name: str)
    Retrieves the rules for a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
    Returns:
      A list of rule dictionaries.

  get_subreddit_contributors(subreddit_name: str)
    Retrieves the list of contributors for a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
    Returns:
      A list of Redditor objects.

  get_subreddit_moderators(subreddit_name: str)
    Retrieves the list of moderators for a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
    Returns:
      A list of Redditor objects.

  get_subreddit_traffic(subreddit_name: str)
    Retrieves traffic statistics for a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
    Returns:
      A dictionary containing traffic statistics.

  get_subreddit_wiki_pages(subreddit_name: str)
    Retrieves a list of wiki page names for a specific subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
    Returns:
      A list of strings (wiki page names).

  get_subreddit_wiki_page(subreddit_name: str, page: str)
    Retrieves the content of a specific wiki page for a subreddit.
    Parameters:
      subreddit_name: The name of the subreddit.
      page: The name of the wiki page.
    Returns:
      A dictionary containing the wiki page content.

  get_user_karma(username: str)
    Retrieves the karma breakdown for a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A dictionary containing karma information.

  get_user_trophies(username: str)
    Retrieves the trophies awarded to a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of trophy dictionaries.

  get_user_about(username: str)
    Retrieves the 'about' information for a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A dictionary containing user 'about' information.

  get_user_friends(username: str)
    Retrieves the list of friends for a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Redditor objects.

  get_user_moderated_subreddits(username: str)
    Retrieves a list of subreddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_multireddits(username: str)
    Retrieves a list of multireddits created by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_saved_submissions(username: str)
    Retrieves submissions saved by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_saved_comments(username: str)
    Retrieves comments saved by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_hidden_submissions(username: str)
    Retrieves submissions hidden by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_hidden_comments(username: str)
    Retrieves comments hidden by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_upvoted_submissions(username: str)
    Retrieves submissions upvoted by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_upvoted_comments(username: str)
    Retrieves comments upvoted by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_downvoted_submissions(username: str)
    Retrieves submissions downvoted by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_downvoted_comments(username: str)
    Retrieves comments downvoted by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_gilded_submissions(username: str)
    Retrieves submissions gilded by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_gilded_comments(username: str)
    Retrieves comments gilded by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_subreddits(username: str)
    Retrieves a list of subreddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits(username: str)
    Retrieves a list of multireddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments(username: str)
    Retrieves comments moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions(username: str)
    Retrieves submissions moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user(username: str)
    Retrieves a list of subreddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user(username: str)
    Retrieves a list of multireddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user(username: str)
    Retrieves comments moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user(username: str)
    Retrieves submissions moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_moderator(username: str)
    Retrieves a list of multireddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_moderator(username: str)
    Retrieves comments moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_moderator(username: str)
    Retrieves submissions moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin(username: str)
    Retrieves comments moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin(username: str)
    Retrieves submissions moderated by a specific user.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_moderator_and_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_moderator_and_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_moderator_and_admin(username: str)
    Retrieves comments moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_moderator_and_admin(username: str)
    Retrieves submissions moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_moderator(username: str)
    Retrieves a list of multireddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_moderator(username: str)
    Retrieves comments moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_moderator(username: str)
    Retrieves submissions moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_user(username: str)
    Retrieves a list of subreddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_user(username: str)
    Retrieves a list of multireddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_user(username: str)
    Retrieves comments moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_user(username: str)
    Retrieves submissions moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user_and_admin(username: str)
    Retrieves comments moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user_and_admin(username: str)
    Retrieves submissions moderated by a specific user and admin.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_user_and_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_user_and_moderator(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_user_and_moderator(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_user_and_moderator(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_admin_and_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_admin_and_moderator(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user_and_admin_and_moderator(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user_and_admin_and_moderator(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_moderator_and_user(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_moderator_and_user(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_moderator_and_user(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_moderator_and_user(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_moderator_and_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_moderator_and_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user_and_moderator_and_admin(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user_and_moderator_and_admin(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_user_and_moderator_and_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_user_and_moderator_and_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_user_and_moderator_and_admin(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_user_and_moderator_and_admin(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_admin_and_moderator_and_admin(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_admin_and_moderator_and_admin(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user_and_admin_and_moderator_and_admin(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user_and_admin_and_moderator_and_admin(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_user_and_moderator_and_admin_and_user(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_user_and_moderator_and_admin_and_user(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_user_and_moderator_and_admin_and_user(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_user_and_moderator_and_admin_and_user(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_admin_and_moderator_and_admin_and_user(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_admin_and_moderator_and_admin_and_user(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_user_and_admin_and_moderator_and_admin_and_user(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_user_and_admin_and_moderator_and_admin_and_user(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_admin_and_user_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_admin_and_user_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves a list of multireddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Multireddit objects.

  get_user_moderated_comments_by_admin_and_user_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves comments moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Comment objects.

  get_user_moderated_submissions_by_admin_and_user_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves submissions moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Submission objects.

  get_user_moderated_subreddits_by_user_and_admin_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves a list of subreddits moderated by a specific user, admin, and moderator.
    Parameters:
      username: The username of the redditor.
    Returns:
      A list of Subreddit objects.

  get_user_moderated_multireddits_by_user_and_admin_and_moderator_and_admin_and_user_and_moderator(username: str)
    Retrieves
```

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

### CommentForest Class Documentation

Source: https://github.com/dan6erbond/apraw/blob/master/docs/api/helpers/comment_forest.rst

Detailed documentation for the CommentForest class, outlining its members, inherited attributes, and special methods for iteration and access.

```APIDOC
CommentForest:
  Inherits from: object
  Members:
    - __init__(self, data: dict)
      Initializes the CommentForest with comment data.
      Parameters:
        data (dict): A dictionary containing comment data.
    - __getitem__(self, key: str) -> Comment
      Retrieves a comment by its ID.
      Parameters:
        key (str): The ID of the comment to retrieve.
      Returns:
        Comment: The Comment object corresponding to the provided ID.
    - __iter__(self) -> Iterator[Comment]
      Returns an iterator over the comments in the forest.
      Returns:
        Iterator[Comment]: An iterator yielding Comment objects.
    - __len__(self) -> int
      Returns the total number of comments in the forest.
      Returns:
        int: The number of comments.
    - __next__(self) -> Comment
      Returns the next comment in the iteration.
      Returns:
        Comment: The next Comment object.
    - last: Comment
      The last comment in the forest.
```