Skip to content

Documentation for tags.py

sankaku.models.tags.BaseTag

Bases: SankakuResponseModel

Model that contains minimum amount of information that all tags have.

id: int instance-attribute

name: str instance-attribute

name_en: str instance-attribute

name_ja: Optional[str] instance-attribute

type: types.TagType instance-attribute

post_count: int instance-attribute

pool_count: int instance-attribute

series_count: int instance-attribute

rating: Optional[types.Rating] instance-attribute


sankaku.models.tags.GenerationDirectivesTag

Bases: BaseTag

count: int instance-attribute

tag_name: str = Field(alias='tagName') class-attribute instance-attribute

translations: List[str] = Field(alias='tag_translations') class-attribute instance-attribute


sankaku.models.tags.TagMixin

Bases: SankakuResponseModel

Additional data that certain tags have.

count: int instance-attribute

tag_name: str = Field(alias='tagName') class-attribute instance-attribute

total_post_count: int instance-attribute

total_pool_count: int instance-attribute


sankaku.models.tags.PostTag

Bases: BaseTag, TagMixin

Model that describes tags related to posts.

locale: Optional[str] instance-attribute

version: Optional[int] instance-attribute


sankaku.models.tags.NestedTag

Bases: BaseTag

Model that describes tags with specific relation to certain tag on tag page.

post_count: int = Field(alias='postCount') class-attribute instance-attribute

type: types.TagType = Field(alias='tagType') class-attribute instance-attribute

name_en: str = Field(alias='nameEn') class-attribute instance-attribute

name_ja: Optional[str] = Field(alias='nameJa') class-attribute instance-attribute

popularity_all: Optional[float] = Field(alias='scTagPopularityAll') class-attribute instance-attribute

quality_all: Optional[float] = Field(alias='scTagQualityAll') class-attribute instance-attribute

popularity_ero: Optional[float] = Field(alias='scTagPopularityEro') class-attribute instance-attribute

popularity_safe: Optional[float] = Field(alias='scTagPopularitySafe') class-attribute instance-attribute

quality_ero: Optional[float] = Field(alias='scTagQualityEro') class-attribute instance-attribute

quality_safe: Optional[float] = Field(alias='scTagQualitySafe') class-attribute instance-attribute

parent_tags: Optional[List[int]] = Field(alias='parentTags') class-attribute instance-attribute

child_tags: Optional[List[int]] = Field(alias='childTags') class-attribute instance-attribute

pool_count: int = Field(alias='poolCount') class-attribute instance-attribute

premium_post_count: int = Field(alias='premPostCount') class-attribute instance-attribute

non_premium_post_count: int = Field(alias='nonPremPostCount') class-attribute instance-attribute

premium_pool_count: int = Field(alias='premPoolCount') class-attribute instance-attribute

non_premium_pool_count: int = Field(alias='nonPremPoolCount') class-attribute instance-attribute

series_count: int = Field(alias='seriesCount') class-attribute instance-attribute

premium_series_count: int = Field(alias='premSeriesCount') class-attribute instance-attribute

non_premium_series_count: int = Field(alias='nonPremSeriesCount') class-attribute instance-attribute

is_trained: bool = Field(alias='isTrained') class-attribute instance-attribute

child: int instance-attribute

parent: int instance-attribute

version: Optional[int] instance-attribute


sankaku.models.tags.BaseTranslations

Bases: SankakuResponseModel

Model that contain minimum information about tag translations.

lang: str instance-attribute

translation: str instance-attribute


sankaku.models.tags.PageTagTranslations

Bases: BaseTranslations

Model that describes page tag translations.

root_id: int = Field(alias='rootId') class-attribute instance-attribute


sankaku.models.tags.WikiTagTranslations

Bases: BaseTranslations

Model that describes wiki tag translations.

status: int instance-attribute

opacity: float instance-attribute

id: Optional[int] = None class-attribute instance-attribute


sankaku.models.tags.PageTag

Bases: PostTag

Model that describes tags on tag page.

translations: List[PageTagTranslations] instance-attribute

related_tags: List[NestedTag] instance-attribute

child_tags: List[NestedTag] instance-attribute

parent_tags: List[NestedTag] instance-attribute


sankaku.models.tags.Wiki

Bases: SankakuResponseModel

Model that describes wiki information for specific tag.

id: int instance-attribute

title: str instance-attribute

body: str instance-attribute

created_at: datetime instance-attribute

updated_at: Optional[datetime] instance-attribute

author: Author = Field(alias='user') class-attribute instance-attribute

is_locked: bool instance-attribute

version: int instance-attribute


sankaku.models.tags.WikiTag

Bases: BaseTag, TagMixin

Model that describes tag on wiki page.

related_tags: List[PostTag] instance-attribute

child_tags: List[PostTag] instance-attribute

parent_tags: List[PostTag] instance-attribute

alias_tags: List[PostTag] instance-attribute

implied_tags: List[PostTag] instance-attribute

translations: List[WikiTagTranslations] instance-attribute

wiki: Wiki instance-attribute