-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds types to models/listing/mixins module
- Loading branch information
1 parent
b7256db
commit 4f0e568
Showing
7 changed files
with
119 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,15 @@ | ||
"""Package providing models that pertain to listing mixins.""" | ||
|
||
from .base import BaseListingMixin | ||
from .rising import RisingListingMixin | ||
from asyncpraw.models.listing.mixins.base import BaseListingMixin | ||
from asyncpraw.models.listing.mixins.redditor import RedditorListingMixin | ||
from asyncpraw.models.listing.mixins.rising import RisingListingMixin | ||
from asyncpraw.models.listing.mixins.submission import SubmissionListingMixin | ||
from asyncpraw.models.listing.mixins.subreddit import SubredditListingMixin | ||
|
||
__all__ = ["BaseListingMixin", "RisingListingMixin"] | ||
__all__ = [ | ||
"BaseListingMixin", | ||
"RedditorListingMixin", | ||
"RisingListingMixin", | ||
"SubmissionListingMixin", | ||
"SubredditListingMixin", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
"""Provide the GildedListingMixin class.""" | ||
|
||
from __future__ import annotations | ||
|
||
from typing import Any, AsyncIterator | ||
|
||
from asyncpraw.models.base import AsyncPRAWBase | ||
|
||
class GildedListingMixin(AsyncPRAWBase): | ||
def gilded(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[Any]: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
"""Provide the RedditorListingMixin class.""" | ||
|
||
from __future__ import annotations | ||
|
||
from typing import TYPE_CHECKING, AsyncIterator | ||
|
||
from asyncpraw.models.listing.mixins.base import BaseListingMixin | ||
from asyncpraw.models.listing.mixins.gilded import GildedListingMixin | ||
from asyncpraw.util import cachedproperty | ||
|
||
if TYPE_CHECKING: | ||
import asyncpraw.models | ||
|
||
class SubListing(BaseListingMixin): | ||
def __init__(self, reddit: asyncpraw.Reddit, base_path: str, subpath: str) -> None: ... | ||
|
||
class RedditorListingMixin(BaseListingMixin, GildedListingMixin): | ||
@cachedproperty | ||
def comments(self) -> SubListing: ... | ||
@cachedproperty | ||
def submissions(self) -> SubListing: ... | ||
def downvoted(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment | asyncpraw.models.Submission]: ... | ||
def gildings(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment | asyncpraw.models.Submission]: ... | ||
def hidden(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment | asyncpraw.models.Submission]: ... | ||
def saved(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment | asyncpraw.models.Submission]: ... | ||
def upvoted(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment | asyncpraw.models.Submission]: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
"""Provide the SubmissionListingMixin class.""" | ||
|
||
from __future__ import annotations | ||
|
||
from typing import TYPE_CHECKING, AsyncIterator | ||
|
||
from asyncpraw.models.base import AsyncPRAWBase | ||
|
||
if TYPE_CHECKING: | ||
import asyncpraw.models | ||
|
||
class SubmissionListingMixin(AsyncPRAWBase): | ||
def duplicates(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Submission]: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
"""Provide the SubredditListingMixin class.""" | ||
|
||
from __future__ import annotations | ||
|
||
from typing import TYPE_CHECKING, Any, AsyncIterator | ||
|
||
from asyncpraw.models.base import AsyncPRAWBase | ||
from asyncpraw.models.listing.mixins.base import BaseListingMixin | ||
from asyncpraw.models.listing.mixins.gilded import GildedListingMixin | ||
from asyncpraw.models.listing.mixins.rising import RisingListingMixin | ||
from asyncpraw.util import cachedproperty | ||
|
||
if TYPE_CHECKING: # pragma: no cover | ||
import asyncpraw.models | ||
|
||
class CommentHelper(AsyncPRAWBase): | ||
@property | ||
def _path(self) -> str: ... | ||
def __call__(self, **generator_kwargs: str | int | dict[str, str]) -> AsyncIterator[asyncpraw.models.Comment]: ... | ||
def __init__(self, subreddit: asyncpraw.models.Subreddit | SubredditListingMixin) -> None: ... | ||
|
||
class SubredditListingMixin(BaseListingMixin, GildedListingMixin, RisingListingMixin): | ||
@cachedproperty | ||
def comments(self) -> CommentHelper: ... | ||
def __init__(self, reddit: asyncpraw.Reddit, _data: dict[str, Any] | None) -> None: ... |