/praw-stubs

PEP 484 annotations for the "praw" library

Primary LanguagePythonMIT LicenseMIT

praw-stubs

Overview

A collection of PEP 484 type hint stubs for the praw library.

This is a work-in-progress: the majority of the library is currently unannotated.

Todo list

Modules that need annotations:

  • praw.__init__
  • praw.config (almost done; Config.CONFIG needs a more precise type)
  • praw.const
  • praw.exceptions
  • praw.objector (partially done; needs validation)
  • praw.reddit
  • praw.models.__init__.pyi
  • praw.models.auth
  • praw.models.base
  • praw.models.comment_forest
  • praw.models.front
  • praw.models.helpers
  • praw.models.inbox
  • praw.models.modaction
  • praw.models.preferences
  • praw.models.stylesheet
  • praw.models.subreddits
  • praw.models.trophy
  • praw.models.user
  • praw.models.util.pyi (partially done; stream_generator needs more precise types)
  • praw.models.list.__init__
  • praw.models.list.base
  • praw.models.list.redditor
  • praw.models.list.trophy
  • praw.models.listing.__init__
  • praw.models.listing.domain
  • praw.models.listing.generator
  • praw.models.listing.listing
  • praw.models.listing.mixins.__init__
  • praw.models.listing.mixins.base (need to investigate cleaning up generator args)
  • praw.models.listing.mixins.gilded
  • praw.models.listing.mixins.redditor
  • praw.models.listing.mixins.rising
  • praw.models.listing.mixins.submission
  • praw.models.listing.mixins.subreddit
  • praw.models.reddit.__init__
  • praw.models.reddit.base
  • praw.models.reddit.comment
  • praw.models.reddit.emoji
  • praw.models.reddit.live
  • praw.models.reddit.message
  • praw.models.reddit.modmail
  • praw.models.reddit.more
  • praw.models.reddit.multi
  • praw.models.reddit.redditor (partially done; RedditorStream is incomplete)
  • praw.models.reddit.submission
  • praw.models.reddit.subreddit
  • praw.models.reddit.widgets
  • praw.models.reddit.wikipage
  • praw.models.reddit.mixins.__init__
  • praw.models.reddit.mixins.editable
  • praw.models.reddit.mixins.gildable
  • praw.models.reddit.mixins.inboxable
  • praw.models.reddit.mixins.inboxtoggleable
  • praw.models.reddit.mixins.messageable
  • praw.models.reddit.mixins.replyable
  • praw.models.reddit.mixins.reportable
  • praw.models.reddit.mixins.savable
  • praw.models.reddit.mixins.votable

Potential extensions:

  • Consider removing some of the duplicate signatures using whatever mechanism emerges out of python/typing#270, if that ever moves forward.