Merge pull request #1856 from Watchful1/mod_notes

Mod notes

Author: LilSpazJoekp

CHANGES.rst

@@ -14,6 +14,26 @@ Unreleased
 - :meth:`.SubredditCollectionsModeration.create` keyword argument ``display_layout`` for
   specifying a display layout when creating a :class:`.Collection`.
 - :attr:`~.Message.parent` to get the parent of a :class:`.Message`.
+- :class:`.ModNote` to represent a moderator note.
+- :meth:`.ModNote.delete` to delete a single moderator note.
+- :class:`.RedditModNotes` to interact with moderator notes from a :class:`.Reddit`
+  instance. This provides the ability to create and fetch notes for one or more
+  redditors from one or more subreddits.
+- :class:`.RedditorModNotes` to interact with moderator notes from a :class:`.Redditor`
+  instance.
+- :meth:`.RedditorModNotes.subreddits` to obtain moderator notes from multiple
+  subreddits for a single redditor.
+- :class:`.SubredditModNotes` to interact with moderator notes from a
+  :class:`.Subreddit` instance.
+- :meth:`.SubredditModNotes.redditors` to obtain moderator notes for multiple redditors
+  from a single subreddit.
+- :meth:`~.BaseModNotes.create` to create a moderator note.
+- :attr:`.Redditor.notes` to interact with :class:`.RedditorModNotes`.
+- :attr:`.SubredditModeration.notes` to interact with :class:`.SubredditModNotes`.
+- :meth:`~.ModNoteMixin.create_note` create a moderator note from a :class:`.Comment` or
+  :class:`.Submission`.
+- :meth:`~.ModNoteMixin.author_notes` to view the moderator notes for the author of a
+  :class:`.Comment` or :class:`.Submission`.
 
 **Changed**
 

docs/code_overview/other.rst

@@ -33,6 +33,17 @@ them bound to an attribute of one of the PRAW models.
     other/inlinemedia
     other/inlinevideo
 
+.. toctree::
+    :maxdepth: 2
+    :caption: ModNotes
+
+    other/base_mod_notes
+    other/mod_note
+    other/mod_note_mixin
+    other/reddit_mod_notes
+    other/redditor_mod_notes
+    other/subreddit_mod_notes
+
 .. toctree::
     :maxdepth: 2
     :caption: Moderation Helpers
@@ -121,6 +132,7 @@ them bound to an attribute of one of the PRAW models.
     other/inboxablemixin
     other/listinggenerator
     other/mod_action
+    other/mod_note
     other/moderatedlist
     other/modmail
     other/modmailmessage

docs/code_overview/other/base_mod_notes.rst

@@ -0,0 +1,5 @@
+BaseModNotes
+============
+
+.. autoclass:: praw.models.mod_notes.BaseModNotes
+    :inherited-members:

docs/code_overview/other/mod_note.rst

@@ -0,0 +1,5 @@
+ModNote
+=======
+
+.. autoclass:: praw.models.ModNote
+    :inherited-members:

docs/code_overview/other/mod_note_mixin.rst

@@ -0,0 +1,5 @@
+ModNoteMixin
+============
+
+.. autoclass:: praw.models.reddit.mixins.ModNoteMixin
+    :members:

docs/code_overview/other/reddit_mod_notes.rst

@@ -0,0 +1,5 @@
+RedditModNotes
+==============
+
+.. autoclass:: praw.models.RedditModNotes
+    :inherited-members:

docs/code_overview/other/redditor_mod_notes.rst

@@ -0,0 +1,5 @@
+RedditorModNotes
+================
+
+.. autoclass:: praw.models.RedditorModNotes
+    :inherited-members:

docs/code_overview/other/subreddit_mod_notes.rst

@@ -0,0 +1,5 @@
+SubredditModNotes
+=================
+
+.. autoclass:: praw.models.SubredditModNotes
+    :inherited-members:

praw/endpoints.py

@@ -108,6 +108,8 @@
     "mentions":                "message/mentions",
     "message":                 "message/messages/{id}/",
     "messages":                "message/messages/",
+    "mod_notes":               "api/mod/notes",
+    "mod_notes_bulk":          "api/mod/notes/recent",
     "moderated":               "user/{user}/moderated_subreddits/",
     "moderator_messages":      "r/{subreddit}/message/moderator/",
     "moderator_unread":        "r/{subreddit}/message/moderator/unread/",

praw/models/__init__.py

@@ -11,6 +11,8 @@
 from .listing.generator import ListingGenerator
 from .listing.listing import Listing, ModeratorListing, ModmailConversationsListing
 from .mod_action import ModAction
+from .mod_note import ModNote
+from .mod_notes import RedditModNotes, RedditorModNotes, SubredditModNotes
 from .preferences import Preferences
 from .reddit.collections import Collection
 from .reddit.comment import Comment