from __future__ import annotations
from typing import TYPE_CHECKING, Optional
if TYPE_CHECKING:
from ...client_SYNC import Client
from ...models.submission_SYNC import Submission
from ...models.comment_SYNC import Comment
from functools import cached_property
from ...pagination.paginator_chaining_iterator import ImpartedPaginatorChainingIterator
from ...pagination.paginators.moderation.sync1 import (
ModQueueListingPaginator,
ModQueueSubmissionListingPaginator,
ModQueueCommentListingPaginator,
ReportsListingPaginator,
ReportsSubmissionListingPaginator,
ReportsCommentListingPaginator,
SpamListingPaginator,
SpamSubmissionListingPaginator,
SpamCommentListingPaginator,
EditedListingPaginator,
EditedSubmissionListingPaginator,
EditedCommentListingPaginator,
UnmoderatedSubmissionListingPaginator,
)
[docs]class Pull:
def __init__(self, client: Client) -> None:
self._client = client
[docs] class ModQueue:
def __init__(self, outer: Pull) -> None:
self._outer = outer
self._client = outer._client
def __call__(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[ModQueueListingPaginator, object]:
p = ModQueueListingPaginator(self._client, f'/r/{sr}/about/modqueue')
return ImpartedPaginatorChainingIterator(p, amount)
[docs] def submissions(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[ModQueueSubmissionListingPaginator, Submission]:
p = ModQueueSubmissionListingPaginator(self._client, f'/r/{sr}/about/modqueue')
return ImpartedPaginatorChainingIterator(p, amount)
modqueue: cached_property[ModQueue] = cached_property(ModQueue)
("""
Retrieve submissions/comments relevant to moderators.
.. .PARAMETERS
:param `str` sr:
:param `Optional[int]` amount:
.. .RETURNS
:returns:
A paginator iterator of either :class:`~.models.submission_SYNC.Submission`
or :class:`~.models.comment_SYNC.Comment` objects.
:rtype: :class:`~.pagination.paginator_chaining_iterator.ImpartedPaginatorChainingIterator`\\[:class:`~.pagination.paginators.moderation.sync1.ModQueueListingPaginator`, `object`]
.. .RAISES
:raises redditwarp.http.exceptions.StatusCodeException:
+ `403`:
- You don't have access to the subreddit.
- You don't have the 'posts' moderator permission.
+ `403`:
The specified subreddit name is too long (over 21 characters)
or contains invalid characters.
""")
[docs] class Reported:
def __init__(self, outer: Pull) -> None:
self._outer = outer
self._client = outer._client
def __call__(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[ReportsListingPaginator, object]:
p = ReportsListingPaginator(self._client, f'/r/{sr}/about/reports')
return ImpartedPaginatorChainingIterator(p, amount)
[docs] def submissions(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[ReportsSubmissionListingPaginator, Submission]:
p = ReportsSubmissionListingPaginator(self._client, f'/r/{sr}/about/reports')
return ImpartedPaginatorChainingIterator(p, amount)
reported: cached_property[Reported] = cached_property(Reported)
("""
Behaves similarly to :meth:`.modqueue`.
""")
[docs] class Spam:
def __init__(self, outer: Pull) -> None:
self._outer = outer
self._client = outer._client
def __call__(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[SpamListingPaginator, object]:
p = SpamListingPaginator(self._client, f'/r/{sr}/about/spam')
return ImpartedPaginatorChainingIterator(p, amount)
[docs] def submissions(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[SpamSubmissionListingPaginator, Submission]:
p = SpamSubmissionListingPaginator(self._client, f'/r/{sr}/about/spam')
return ImpartedPaginatorChainingIterator(p, amount)
spam: cached_property[Spam] = cached_property(Spam)
("""
Behaves similarly to :meth:`.modqueue`.
""")
[docs] class Edited:
def __init__(self, outer: Pull) -> None:
self._outer = outer
self._client = outer._client
def __call__(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[EditedListingPaginator, object]:
p = EditedListingPaginator(self._client, f'/r/{sr}/about/edited')
return ImpartedPaginatorChainingIterator(p, amount)
[docs] def submissions(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[EditedSubmissionListingPaginator, Submission]:
p = EditedSubmissionListingPaginator(self._client, f'/r/{sr}/about/edited')
return ImpartedPaginatorChainingIterator(p, amount)
edited: cached_property[Edited] = cached_property(Edited)
("""
Behaves similarly to :meth:`.modqueue`.
""")
[docs] def unmoderated(self, sr: str, amount: Optional[int] = None,
) -> ImpartedPaginatorChainingIterator[UnmoderatedSubmissionListingPaginator, Submission]:
"""
Behaves similarly to :meth:`.modqueue`.
"""
p = UnmoderatedSubmissionListingPaginator(self._client, f'/r/{sr}/about/unmoderated')
return ImpartedPaginatorChainingIterator(p, amount)