reddit.front
************

class praw.models.Front(reddit: Reddit)

   Front is a Listing class that represents the front page.

   __init__(reddit: Reddit)

      Initialize a Front instance.

   best(**generator_kwargs: Union[str, int]) -> Iterator[praw.models.reddit.submission.Submission]

      Return a "ListingGenerator" for best items.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

   comments()

      Provide an instance of "CommentHelper".

      For example, to output the author of the 25 most recent comments
      of "r/redditdev" execute:

         for comment in reddit.subreddit("redditdev").comments(limit=25):
             print(comment.author)

   controversial(time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Any]

      Return a "ListingGenerator" for controversial submissions.

      Parameters:
         **time_filter** – Can be one of: all, day, hour, month, week,
         year (default: all).

      Raises:
         "ValueError" if "time_filter" is invalid.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      This method can be used like:

         reddit.domain("imgur.com").controversial("week")
         reddit.multireddit("samuraisam", "programming").controversial("day")
         reddit.redditor("spez").controversial("month")
         reddit.redditor("spez").comments.controversial("year")
         reddit.redditor("spez").submissions.controversial("all")
         reddit.subreddit("all").controversial("hour")

   gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Any]

      Return a "ListingGenerator" for gilded items.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      For example, to get gilded items in subreddit "r/test":

         for item in reddit.subreddit("test").gilded():
             print(item.id)

   hot(**generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Any]

      Return a "ListingGenerator" for hot items.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      This method can be used like:

         reddit.domain("imgur.com").hot()
         reddit.multireddit("samuraisam", "programming").hot()
         reddit.redditor("spez").hot()
         reddit.redditor("spez").comments.hot()
         reddit.redditor("spez").submissions.hot()
         reddit.subreddit("all").hot()

   new(**generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Any]

      Return a "ListingGenerator" for new items.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      This method can be used like:

         reddit.domain("imgur.com").new()
         reddit.multireddit("samuraisam", "programming").new()
         reddit.redditor("spez").new()
         reddit.redditor("spez").comments.new()
         reddit.redditor("spez").submissions.new()
         reddit.subreddit("all").new()

   classmethod parse(data: Dict[str, Any], reddit: Reddit) -> Any

      Return an instance of "cls" from "data".

      Parameters:
         * **data** – The structured data.

         * **reddit** – An instance of "Reddit".

   random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Submission]

      Return a "ListingGenerator" for random rising submissions.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      For example, to get random rising submissions for subreddit
      "r/test":

         for submission in reddit.subreddit("test").random_rising():
             print(submission.title)

   rising(**generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Submission]

      Return a "ListingGenerator" for rising submissions.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      For example, to get rising submissions for subreddit "r/test":

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

   top(time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) -> Iterator[Any]

      Return a "ListingGenerator" for top submissions.

      Parameters:
         **time_filter** – Can be one of: all, day, hour, month, week,
         year (default: all).

      Raises:
         "ValueError" if "time_filter" is invalid.

      Additional keyword arguments are passed in the initialization of
      "ListingGenerator".

      This method can be used like:

         reddit.domain("imgur.com").top("week")
         reddit.multireddit("samuraisam", "programming").top("day")
         reddit.redditor("spez").top("month")
         reddit.redditor("spez").comments.top("year")
         reddit.redditor("spez").submissions.top("all")
         reddit.subreddit("all").top("hour")
