/
test_subreddit.py
1994 lines (1746 loc) · 77.7 KB
/
test_subreddit.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Test praw.models.subreddit."""
import socket
from json import dumps
from unittest import mock
from unittest.mock import MagicMock
import pytest
import requests
import websocket
from prawcore import BadRequest, Forbidden, NotFound, RequestException, TooLarge
from praw.const import PNG_HEADER
from praw.exceptions import (
ClientException,
InvalidFlairTemplateID,
RedditAPIException,
TooLargeMediaException,
WebSocketException,
)
from praw.models import (
Comment,
InlineGif,
InlineImage,
InlineVideo,
ListingGenerator,
ModAction,
ModmailAction,
ModmailConversation,
ModmailMessage,
Redditor,
Stylesheet,
Submission,
Subreddit,
SubredditMessage,
WikiPage,
)
from ... import IntegrationTest
class TestSubredditFilters(IntegrationTest):
def test__iter__all(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
filters = list(subreddit.filters)
assert len(filters) > 0
assert all(isinstance(x, Subreddit) for x in filters)
def test__iter__mod(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("mod")
filters = list(subreddit.filters)
assert len(filters) > 0
assert all(isinstance(x, Subreddit) for x in filters)
def test_add(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
subreddit.filters.add("redditdev")
def test_add__non_special(self, reddit):
reddit.read_only = False
with pytest.raises(NotFound):
reddit.subreddit("redditdev").filters.add("redditdev")
@pytest.mark.cassette_name("TestSubredditFilters.test_add")
def test_add__subreddit_model(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
subreddit.filters.add(reddit.subreddit("redditdev"))
def test_remove(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("mod")
subreddit.filters.remove("redditdev")
def test_remove__non_special(self, reddit):
reddit.read_only = False
with pytest.raises(NotFound):
reddit.subreddit("redditdev").filters.remove("redditdev")
@pytest.mark.cassette_name("TestSubredditFilters.test_remove")
def test_remove__subreddit_model(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("mod")
subreddit.filters.remove(reddit.subreddit("redditdev"))
class TestSubredditFlair(IntegrationTest):
REDDITOR = pytest.placeholders.username
def test__call(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
mapping = subreddit.flair()
assert len(list(mapping)) > 0
assert all(isinstance(x["user"], Redditor) for x in mapping)
def test__call__user_filter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
mapping = subreddit.flair(redditor=self.REDDITOR)
assert len(list(mapping)) == 1
def test_configure(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.configure(
position=None,
self_assign=True,
link_position=None,
link_self_assign=True,
)
def test_configure__defaults(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.configure()
def test_delete(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.delete(pytest.placeholders.username)
def test_delete_all(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
response = subreddit.flair.delete_all()
assert len(response) > 100
assert all("removed" in x["status"] for x in response)
def test_set__flair_id(self, reddit):
reddit.read_only = False
redditor = reddit.redditor(pytest.placeholders.username)
flair = "11c32eee-1482-11e9-bfc0-0efc81a5e8e8"
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.set(redditor, flair_template_id=flair, text="redditor flair")
def test_set__flair_id_default_text(self, reddit):
reddit.read_only = False
redditor = reddit.redditor(pytest.placeholders.username)
flair = "11c32eee-1482-11e9-bfc0-0efc81a5e8e8"
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.set(redditor, flair_template_id=flair)
def test_set__redditor(self, reddit):
reddit.read_only = False
redditor = reddit.redditor(pytest.placeholders.username)
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.set(redditor, text="redditor flair")
def test_set__redditor_css_only(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.set(pytest.placeholders.username, css_class="some class")
def test_set__redditor_string(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.set(
pytest.placeholders.username, css_class="some class", text="new flair"
)
def test_update(self, reddit):
reddit.read_only = False
redditor = reddit.redditor(pytest.placeholders.username)
flair_list = [
redditor,
"spez",
{"user": "bsimpson"},
{"user": "spladug", "flair_text": "", "flair_css_class": ""},
]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
response = subreddit.flair.update(flair_list, css_class="default")
assert all(x["ok"] for x in response)
assert not any(x["errors"] for x in response)
assert not any(x["warnings"] for x in response)
assert len([x for x in response if "added" in x["status"]]) == 3
assert len([x for x in response if "removed" in x["status"]]) == 1
for i, name in enumerate([str(redditor), "spez", "bsimpson", "spladug"]):
assert name in response[i]["status"]
def test_update__comma_in_text(self, reddit):
reddit.read_only = False
flair_list = [
{"user": "bsimpson"},
{"user": "spladug", "flair_text": "a,b"},
]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
response = subreddit.flair.update(flair_list, css_class="default")
assert all(x["ok"] for x in response)
def test_update_quotes(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
response = subreddit.flair.update(
[reddit.user.me()], css_class="testing", text='"testing"'
)
assert all(x["ok"] for x in response)
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
flair = next(subreddit.flair(reddit.user.me()))
assert flair["flair_text"] == '"testing"'
assert flair["flair_css_class"] == "testing"
class TestSubredditFlairTemplates(IntegrationTest):
def test__iter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
templates = list(subreddit.flair.templates)
assert len(templates) > 100
for flair_template in templates:
assert flair_template["id"]
def test_add(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.add(
"PRAW", background_color="#ABCDEF", css_class="myCSS"
)
def test_clear(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.clear()
def test_delete(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.delete(template["id"])
def test_reorder(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
original = list(subreddit.flair.templates)
flairs = [flair["id"] for flair in subreddit.flair.templates]
subreddit.flair.templates.reorder(list(reversed(flairs)))
assert list(subreddit.flair.templates) == list(reversed(original))
def test_update(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
template["id"],
background_color="#00FFFF",
css_class="myCSS",
text="PRAW updated",
text_color="dark",
)
def test_update_false(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit.flair.templates.update(template["id"], fetch=True, text_editable=True)
subreddit.flair.templates.update(
template["id"], fetch=True, text_editable=False
)
newtemplate = list(
filter(
lambda _template: _template["id"] == template["id"],
subreddit.flair.templates,
)
)[0]
assert newtemplate["text_editable"] is False
def test_update_fetch(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
template["id"],
background_color="#00FFFF",
css_class="myCSS",
fetch=True,
text="PRAW updated",
text_color="dark",
)
def test_update_fetch_no_css_class(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
template["id"],
background_color="#00FFFF",
fetch=True,
text="PRAW updated",
text_color="dark",
)
def test_update_fetch_no_text(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
template["id"],
background_color="#00FFFF",
css_class="myCSS",
fetch=True,
text_color="dark",
)
def test_update_fetch_no_text_or_css_class(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
template["id"],
background_color="#00FFFF",
fetch=True,
text_color="dark",
)
def test_update_fetch_only(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
template = list(subreddit.flair.templates)[0]
subreddit.flair.templates.update(template["id"], fetch=True)
newtemplate = list(
filter(
lambda _template: _template["id"] == template["id"],
subreddit.flair.templates,
)
)[0]
assert newtemplate == template
def test_update_invalid(self, reddit):
reddit.read_only = False
with pytest.raises(InvalidFlairTemplateID):
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.templates.update(
"fake id",
background_color="#00FFFF",
css_class="myCSS",
fetch=True,
text="PRAW updated",
text_color="dark",
)
class TestSubredditLinkFlairTemplates(IntegrationTest):
def test__iter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
templates = list(subreddit.flair.link_templates)
assert len(templates) > 100
for template in templates:
assert template["id"]
assert isinstance(template["richtext"], list)
assert all(isinstance(item, dict) for item in template["richtext"])
def test_add(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.link_templates.add(
"PRAW", css_class="myCSS", text_color="light"
)
def test_clear(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.flair.link_templates.clear()
def test_reorder(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
original = list(subreddit.flair.link_templates)
flairs = [flair["id"] for flair in subreddit.flair.link_templates]
subreddit.flair.link_templates.reorder(list(reversed(flairs)))
assert list(subreddit.flair.link_templates) == list(reversed(original))
def test_user_selectable(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
templates = list(subreddit.flair.link_templates.user_selectable())
assert len(templates) >= 2
for template in templates:
assert template["flair_template_id"]
assert template["flair_text"]
class TestSubredditListings(IntegrationTest):
def test_comments(self, reddit):
subreddit = reddit.subreddit("askreddit")
comments = list(subreddit.comments())
assert len(comments) == 100
def test_controversial(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.controversial())
assert len(submissions) == 100
def test_gilded(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.gilded())
assert len(submissions) >= 50
def test_hot(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.hot())
assert len(submissions) == 100
def test_new(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.new())
assert len(submissions) == 100
def test_random_rising(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.random_rising())
assert len(submissions) == 100
def test_rising(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.rising())
assert len(submissions) == 100
def test_top(self, reddit):
subreddit = reddit.subreddit("askreddit")
submissions = list(subreddit.top())
assert len(submissions) == 100
class TestSubredditModeration(IntegrationTest):
def test_accept_invite__no_invite(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
with pytest.raises(RedditAPIException) as excinfo:
subreddit.mod.accept_invite()
assert excinfo.value.items[0].error_type == "NO_INVITE_FOUND"
def test_edited(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.edited():
assert isinstance(item, (Comment, Submission))
count += 1
assert count == 100
def test_edited__only_comments(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.edited(only="comments"):
assert isinstance(item, Comment)
count += 1
assert count == 100
def test_edited__only_submissions(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.edited(only="submissions"):
assert isinstance(item, Submission)
count += 1
assert count > 0
def test_inbox(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit("all")
for item in subreddit.mod.inbox():
assert isinstance(item, SubredditMessage)
count += 1
assert count == 100
def test_log(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit("mod")
for item in subreddit.mod.log():
assert isinstance(item, ModAction)
count += 1
assert count == 100
def test_log__filters(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit("mod")
redditor = reddit.redditor("bboe_dev")
for item in subreddit.mod.log(action="invitemoderator", mod=redditor):
assert isinstance(item, ModAction)
assert item.action == "invitemoderator"
assert isinstance(item.mod, Redditor)
assert item.mod == "bboe_dev"
count += 1
assert count > 0
def test_modqueue(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.modqueue():
assert isinstance(item, (Comment, Submission))
count += 1
assert count > 0
def test_modqueue__only_comments(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.modqueue(only="comments"):
assert isinstance(item, Comment)
count += 1
assert count > 0
def test_modqueue__only_submissions(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.modqueue(only="submissions"):
assert isinstance(item, Submission)
count += 1
assert count > 0
def test_notes(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
notes = list(subreddit.mod.notes.redditors("Watchful1", "watchful12", "spez"))
assert len(notes) == 3
assert notes[0].user.name.lower() == "watchful1"
assert notes[1].user.name.lower() == "watchful12"
assert notes[2] is None
def test_notes_iterate(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
distinct_ids = set()
count_notes = 0
for note in subreddit.mod.notes.redditors("watchful12", limit=None):
distinct_ids.add(note.id)
count_notes += 1
assert len(distinct_ids) == 359
assert count_notes == 359
def test_reports(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.reports():
assert isinstance(item, (Comment, Submission))
count += 1
assert count == 100
def test_reports__only_comments(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.reports(only="comments"):
assert isinstance(item, Comment)
count += 1
assert count > 0
def test_reports__only_submissions(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.reports(only="submissions"):
assert isinstance(item, Submission)
count += 1
assert count == 100
def test_spam(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.spam():
assert isinstance(item, (Comment, Submission))
count += 1
assert count > 0
def test_spam__only_comments(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.spam(only="comments"):
assert isinstance(item, Comment)
count += 1
assert count > 0
def test_spam__only_submissions(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.spam(only="submissions"):
assert isinstance(item, Submission)
count += 1
assert count > 0
def test_unmoderated(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for item in subreddit.mod.unmoderated():
assert isinstance(item, (Comment, Submission))
count += 1
assert count > 0
def test_unread(self, reddit):
reddit.read_only = False
count = 0
subreddit = reddit.subreddit("all")
for item in subreddit.mod.unread():
assert isinstance(item, SubredditMessage)
count += 1
assert count > 0
def test_update(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
before_settings = subreddit.mod.settings()
new_title = f"{before_settings['title']}x"
new_title = (
"x"
if (len(new_title) >= 20 and "placeholder" not in new_title)
else new_title
)
subreddit.mod.update(title=new_title)
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
assert subreddit.title == new_title
after_settings = subreddit.mod.settings()
# Ensure that nothing has changed besides what was specified.
before_settings["title"] = new_title
assert before_settings == after_settings
class TestSubredditModerationStreams(IntegrationTest):
def test_edited(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.edited()
for i in range(10):
assert isinstance(next(generator), (Comment, Submission))
def test_log(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.log()
for i in range(101):
assert isinstance(next(generator), ModAction)
def test_modmail_conversations(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("mod")
generator = subreddit.mod.stream.modmail_conversations()
for i in range(101):
assert isinstance(next(generator), ModmailConversation)
def test_modqueue(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.modqueue()
for i in range(10):
assert isinstance(next(generator), (Comment, Submission))
def test_reports(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.reports()
for i in range(10):
assert isinstance(next(generator), (Comment, Submission))
def test_spam(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.spam()
for i in range(10):
assert isinstance(next(generator), (Comment, Submission))
def test_unmoderated(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
generator = subreddit.mod.stream.unmoderated()
for i in range(10):
assert isinstance(next(generator), (Comment, Submission))
def test_unread(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("mod")
generator = subreddit.mod.stream.unread()
for i in range(2):
assert isinstance(next(generator), SubredditMessage)
class TestSubredditModmail(IntegrationTest):
def test_bulk_read(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for conversation in subreddit.modmail.bulk_read(state="new"):
assert isinstance(conversation, ModmailConversation)
def test_call(self, reddit):
reddit.read_only = False
conversation_id = "ik72"
subreddit = reddit.subreddit("all")
conversation = subreddit.modmail(conversation_id)
assert isinstance(conversation.user, Redditor)
for message in conversation.messages:
assert isinstance(message, ModmailMessage)
for action in conversation.mod_actions:
assert isinstance(action, ModmailAction)
def test_call__internal(self, reddit):
reddit.read_only = False
conversation_id = "nbhy"
subreddit = reddit.subreddit("all")
conversation = subreddit.modmail(conversation_id)
for message in conversation.messages:
assert isinstance(message, ModmailMessage)
for action in conversation.mod_actions:
assert isinstance(action, ModmailAction)
def test_call__mark_read(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
conversation = subreddit.modmail("o7wz", mark_read=True)
assert conversation.last_unread is None
def test_conversations(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
conversations = subreddit.modmail.conversations()
for conversation in conversations:
assert isinstance(conversation, ModmailConversation)
assert isinstance(conversation.authors[0], Redditor)
def test_conversations__other_subreddits(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("pics")
conversations = subreddit.modmail.conversations(
other_subreddits=["LifeProTips"]
)
assert len(set(list(conversation.owner for conversation in conversations))) > 1
def test_conversations__params(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("all")
conversations = subreddit.modmail.conversations(state="mod")
for conversation in conversations:
assert conversation.is_internal
def test_create(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
redditor = reddit.redditor(pytest.placeholders.username)
conversation = subreddit.modmail.create(
subject="Subject", body="Body", recipient=redditor
)
assert isinstance(conversation, ModmailConversation)
def test_subreddits(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
for subreddit in subreddit.modmail.subreddits():
assert isinstance(subreddit, Subreddit)
def test_unread_count(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
assert isinstance(subreddit.modmail.unread_count(), dict)
class TestSubredditQuarantine(IntegrationTest):
def test_opt_in(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("ferguson")
with pytest.raises(Forbidden):
next(subreddit.hot())
subreddit.quaran.opt_in()
assert isinstance(next(subreddit.hot()), Submission)
def test_opt_out(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit("ferguson")
subreddit.quaran.opt_out()
with pytest.raises(Forbidden):
next(subreddit.hot())
class TestSubredditRelationships(IntegrationTest):
REDDITOR = "pyapitestuser3"
@staticmethod
def _add_remove(base, relationship, user):
relationship = getattr(base, relationship)
relationship.add(user)
relationships = list(relationship())
assert user in relationships
redditor = relationships[relationships.index(user)]
assert isinstance(redditor, Redditor)
assert hasattr(redditor, "date")
relationship.remove(user)
assert user not in list(relationship())
def test_banned(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
self._add_remove(subreddit, "banned", self.REDDITOR)
def test_banned__user_filter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
banned = subreddit.banned(redditor="pyapitestuser3")
assert len(list(banned)) == 1
def test_contributor(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
self._add_remove(subreddit, "contributor", self.REDDITOR)
def test_contributor__user_filter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
contributor = subreddit.contributor(redditor="pyapitestuser3")
assert len(list(contributor)) == 1
def test_contributor_leave(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.contributor.leave()
def test_moderator(self, reddit):
reddit.read_only = False
# Moderators can only be invited.
# As of 2016-03-18 there is no API endpoint to get the moderator
# invite list.
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.add(self.REDDITOR)
assert self.REDDITOR not in subreddit.moderator()
def test_moderator__limited_permissions(self, reddit):
reddit.read_only = False
# Moderators can only be invited.
# As of 2016-03-18 there is no API endpoint to get the moderator
# invite list.
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.add(self.REDDITOR, permissions=["access", "wiki"])
assert self.REDDITOR not in subreddit.moderator()
def test_moderator__user_filter(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
moderator = subreddit.moderator(redditor="pyapitestuser3")
assert len(moderator) == 1
assert "mod_permissions" in moderator[0].__dict__
def test_moderator_invite__invalid_perm(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
with pytest.raises(RedditAPIException) as excinfo:
subreddit.moderator.invite(self.REDDITOR, permissions=["a"])
assert excinfo.value.items[0].error_type == "INVALID_PERMISSIONS"
def test_moderator_invite__no_perms(self, reddit):
reddit.read_only = False
# Moderators can only be invited.
# As of 2016-03-18 there is no API endpoint to get the moderator
# invite list.
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.invite(self.REDDITOR, permissions=[])
assert self.REDDITOR not in subreddit.moderator()
def test_moderator_invited_moderators(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
invited = subreddit.moderator.invited()
assert isinstance(invited, ListingGenerator)
for moderator in invited:
assert isinstance(moderator, Redditor)
def test_moderator_leave(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.leave()
def test_moderator_remove_invite(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.remove_invite(self.REDDITOR)
def test_moderator_update(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.update(self.REDDITOR, permissions=["config"])
def test_moderator_update_invite(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
subreddit.moderator.update_invite(self.REDDITOR, permissions=["mail"])
def test_muted(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
self._add_remove(subreddit, "muted", self.REDDITOR)
def test_wiki_banned(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
self._add_remove(subreddit.wiki, "banned", self.REDDITOR)
def test_wiki_contributor(self, reddit):
reddit.read_only = False
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)
self._add_remove(subreddit.wiki, "contributor", self.REDDITOR)
class TestSubredditStreams(IntegrationTest):
def test_comments(self, reddit):
subreddit = reddit.subreddit("all")
generator = subreddit.stream.comments()
for i in range(400):
assert isinstance(next(generator), Comment)
def test_comments__with_pause(self, reddit):
comment_stream = reddit.subreddit("kakapo").stream.comments(pause_after=0)
comment_count = 1
pause_count = 1
comment = next(comment_stream)
while comment is not None:
comment_count += 1
comment = next(comment_stream)
while comment is None:
pause_count += 1
comment = next(comment_stream)
assert comment_count == 17
assert pause_count == 2
@pytest.mark.cassette_name("TestSubredditStreams.test_comments__with_pause")
def test_comments__with_skip_existing(self, reddit):
subreddit = reddit.subreddit("all")
generator = subreddit.stream.comments(skip_existing=True)
count = 0
try:
for comment in generator:
count += 1
except RequestException:
pass
# This test uses the same cassette as test_comments which shows
# that there are at least 400 comments in the stream.
assert count < 400
def test_comments__with_start_after(self, reddit):
subreddit = reddit.subreddit("kakapo")
initial_stream = subreddit.stream.comments()
first_ten = [next(initial_stream) for _ in range(10)]
generator = subreddit.stream.comments(start_after=first_ten[4].fullname)
for i in range(5):
comment = next(generator)
assert isinstance(comment, Comment)
assert comment.fullname == first_ten[i + 5].fullname
def test_submissions(self, reddit):
subreddit = reddit.subreddit("all")
generator = subreddit.stream.submissions()
for i in range(101):
assert isinstance(next(generator), Submission)
@pytest.mark.cassette_name("TestSubredditStreams.test_submissions")
def test_submissions__with_pause(self, reddit):
subreddit = reddit.subreddit("all")
generator = subreddit.stream.submissions(pause_after=-1)
submission = next(generator)
submission_count = 0
while submission is not None:
submission_count += 1
submission = next(generator)
assert submission_count == 100
@pytest.mark.cassette_name("TestSubredditStreams.test_submissions")
def test_submissions__with_pause_and_skip_after(self, reddit):
subreddit = reddit.subreddit("all")
generator = subreddit.stream.submissions(pause_after=-1, skip_existing=True)
submission = next(generator)
assert submission is None # The first thing yielded should be None
submission_count = 0
submission = next(generator)
while submission is not None:
submission_count += 1
submission = next(generator)
assert submission_count < 100
class TestSubredditStylesheet(IntegrationTest):
def test_call(self, reddit):
subreddit = reddit.subreddit(pytest.placeholders.test_subreddit)