redditwarp.pushshift.siteprocs.ASYNC#

class redditwarp.pushshift.siteprocs.ASYNC.Procedures(client: Client)[source]#

Bases: object

bulk_fetch_submissions(ids: Iterable[int], *, fields: Collection[str] | None = None) → CallChunkChainingAsyncIterator[Document][source]#

Bulk fetch submission documents by ID.

Parameters:

  • ids (Iterable[int]) – Submission IDs.

  • fields (Optional[Collection[str]]) – Return only specific fields.

Return type:

~.iterators.call_chunk_chaining_async_iterator.CallChunkChainingAsyncIterator[Document]

async count_search_submissions(*, query: str | None = None, query_title: str | None = None, query_body: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None) → int[source]#

Return the number of expected entries for a submission search.

(parameters):

Similar to page_search_submissions().

Return type:

int

page_search_submissions(*, query: str | None = None, query_title: str | None = None, query_body: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None, fields: Collection[str] | None = None, descending: bool = False) → DocumentAsyncPaginator[source]#

Return a paginator for a submission search.

Parameters:

  • query (Optional[str]) – Filter by title and body.

  • query_title (Optional[str]) – Filter by title.

  • query_body (Optional[str]) – Filter by body.

  • subreddit (Optional[str]) –

    Filter by specific subreddits.

    A comma-separated list is accepted.

  • author (Optional[str]) –

    Filter by specific authors.

    A comma-separated list is accepted.

  • time_range (Optional[tuple[Optional[int], Optional[int]]]) –

    Filter by time.

    Takes a time range tuple of (since, until). The since value is inclusive. The until value is exclusive.

    The until value should always be greater than since.

    This parameter cannot be used with since or until.

  • since (Optional[int]) –

  • until (Optional[int]) –

  • fields (Optional[Collection[str]]) –

    Return only specific fields.

    Values id and created_utc MUST be included otherwise the pagination logic will error out.

  • descending (Optional[str]) –

    Return results in descending order.

    Note, this only controls the order of the entries according to the created_utc field and not the id field. The order of ids is never guarented. This means that if you collect, reverse and compare the order of entries’ id fields with a different descending value, they may not be equal.

Return type:

DocumentAsyncPaginator

pull_search_submissions(*, amount: int | None = None, query: str | None = None, query_title: str | None = None, query_body: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None, fields: Collection[str] | None = None, descending: bool = False) → PaginatorChainingAsyncIterator[Document][source]#

Pull entries from a submission search.

Using a paginator object directly is generally recommended. I.e., page_search_submissions() is preferred over this method.

bulk_fetch_comments(ids: Iterable[int], *, fields: Collection[str] | None = None) → CallChunkChainingAsyncIterator[Document][source]#

Bulk fetch comment documents by ID.

Behaves similarly to bulk_fetch_submissions().

async count_search_comments(*, query: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None) → int[source]#

Return the number of expected entries for a submission search.

Behaves similarly to count_search_submissions().

page_search_comments(*, query: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None, fields: Collection[str] | None = None, descending: bool = False) → DocumentAsyncPaginator[source]#

Return a paginator for a comment search.

Behaves similarly to page_search_submissions().

pull_search_comments(*, amount: int | None = None, query: str | None = None, subreddit: str | None = None, author: str | None = None, time_range: tuple[Optional[int], Optional[int]] | None = None, since: int | None = None, until: int | None = None, fields: Collection[str] | None = None, descending: bool = False) → PaginatorChainingAsyncIterator[Document][source]#

Pull entries from a comment search.

Behaves similarly to pull_search_submissions().