Skip to content

Commit

Permalink
Objectify author, dest, replies, and subreddit Message attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
bboe committed Feb 20, 2017
1 parent 419aaf7 commit c315a7a
Show file tree
Hide file tree
Showing 6 changed files with 167 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Unreleased
* :class:`.Redditor` instances obtained via :attr:`.moderator` (e.g.,
``reddit.subreddit('subreddit').moderator()``) will contain attributes with
the relationship metadata (e.g., ``mod_permissions``).
* :class:`.Message` instances retrieved from the inbox have now have attributes
``author``, ``dest`` ``replies`` and ``subreddit`` properly converted to
their appropriate PRAW model.

4.3.0 (2017/01/19)
------------------
Expand Down
3 changes: 1 addition & 2 deletions praw/models/inbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@ def message(self, message_id):
"""
listing = self._reddit.get(API_PATH['message'].format(id=message_id))
messages = [listing[0]] + list(self._reddit._objector
.objectify(listing[0].replies))
messages = [listing[0]] + listing[0].replies
while messages:
message = messages.pop(0)
if message.id == message_id:
Expand Down
23 changes: 21 additions & 2 deletions praw/models/reddit/message.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
"""Provide the Message class."""
from .base import RedditBase
from ...const import API_PATH
from .base import RedditBase
from .mixins import InboxableMixin, ReplyableMixin
from .redditor import Redditor
from .subreddit import Subreddit


class Message(RedditBase, InboxableMixin, ReplyableMixin):
Expand All @@ -17,8 +19,25 @@ def parse(cls, data, reddit):
:param reddit: An instance of :class:`.Reddit`.
"""
if data.get('subreddit'):
if data['author']:
data['author'] = Redditor(reddit, data['author'])

if data['dest'].startswith('#'):
data['dest'] = Subreddit(reddit, data['dest'][1:])
else:
data['dest'] = Redditor(reddit, data['dest'])

if data['replies']:
replies = data['replies']
data['replies'] = reddit._objector.objectify(
replies['data']['children'])
else:
data['replies'] = []

if data['subreddit']:
data['subreddit'] = Subreddit(reddit, data['subreddit'])
return SubredditMessage(reddit, _data=data)

return cls(reddit, _data=data)

def __init__(self, reddit, _data):
Expand Down
112 changes: 112 additions & 0 deletions tests/integration/cassettes/TestMessage.test_attributes.json

Large diffs are not rendered by default.

25 changes: 24 additions & 1 deletion tests/integration/models/reddit/test_message.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,34 @@
from praw.models import Message, SubredditMessage
from praw.models import Message, Redditor, Subreddit, SubredditMessage
import mock
import pytest

from ... import IntegrationTest


class TestMessage(IntegrationTest):
@mock.patch('time.sleep', return_value=None)
def test_attributes(self, _):
self.reddit.read_only = False
with self.recorder.use_cassette('TestMessage.test_attributes'):
messages = list(self.reddit.inbox.messages())
count = len(messages)
while messages:
message = messages.pop(0)
messages.extend(message.replies)
count -= 1
try:
assert message.author is None \
or isinstance(message.author, Redditor)
assert isinstance(message.dest, (Redditor, Subreddit))
assert isinstance(message.replies, list)
assert message.subreddit is None \
or isinstance(message.subreddit, Subreddit)
except:
import pprint
pprint.pprint(vars(message))
raise
assert count < 0

@mock.patch('time.sleep', return_value=None)
def test_block(self, _):
self.reddit.read_only = False
Expand Down
8 changes: 6 additions & 2 deletions tests/integration/models/test_inbox.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Test praw.models.inbox."""
from praw.models import Comment, Message
from praw.models import Comment, Message, Redditor, Subreddit
from prawcore import Forbidden
import mock
import pytest
Expand Down Expand Up @@ -81,8 +81,12 @@ def test_message(self):
self.reddit.read_only = False
with self.recorder.use_cassette('TestInbox.test_message'):
message = self.reddit.inbox.message('6vzfan')
assert isinstance(message, Message)
assert message.name.split('_', 1)[1] == '6vzfan'
assert isinstance(message, Message)
assert isinstance(message.author, Redditor)
assert isinstance(message.dest, Subreddit)
assert message.replies == []
assert isinstance(message.subreddit, Subreddit)

def test_message__unauthorized(self):
self.reddit.read_only = False
Expand Down

0 comments on commit c315a7a

Please sign in to comment.