# {py:mod}`tdk.home`

```{py:module} tdk.home
```

```{autodoc2-docstring} tdk.home
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`HomepageMixup <tdk.home.HomepageMixup>`
  -
* - {py:obj}`HomepageProverb <tdk.home.HomepageProverb>`
  -
* - {py:obj}`HomepageFrequentTypos <tdk.home.HomepageFrequentTypos>`
  -
* - {py:obj}`HomepageRule <tdk.home.HomepageRule>`
  -
* - {py:obj}`HomepageWord <tdk.home.HomepageWord>`
  -
* - {py:obj}`HomepageContent <tdk.home.HomepageContent>`
  -
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`get_homepage_content <tdk.home.get_homepage_content>`
  - ```{autodoc2-docstring} tdk.home.get_homepage_content
    :summary:
    ```
* - {py:obj}`get_homepage_content_sync <tdk.home.get_homepage_content_sync>`
  - ```{autodoc2-docstring} tdk.home.get_homepage_content_sync
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <tdk.home.__all__>`
  - ```{autodoc2-docstring} tdk.home.__all__
    :summary:
    ```
* - {py:obj}`ValidatedCounter <tdk.home.ValidatedCounter>`
  - ```{autodoc2-docstring} tdk.home.ValidatedCounter
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: tdk.home.__all__
:value: >
   ['HomepageMixup', 'HomepageProverb', 'HomepageFrequentTypos', 'HomepageRule', 'HomepageWord', 'Homep...

```{autodoc2-docstring} tdk.home.__all__
```

````

`````{py:class} HomepageMixup(/, **data: typing.Any)
:canonical: tdk.home.HomepageMixup

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} tdk_id
:canonical: tdk.home.HomepageMixup.tdk_id
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageMixup.tdk_id
```

````

````{py:attribute} incorrect
:canonical: tdk.home.HomepageMixup.incorrect
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageMixup.incorrect
```

````

````{py:attribute} correct
:canonical: tdk.home.HomepageMixup.correct
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageMixup.correct
```

````

`````

`````{py:class} HomepageProverb(/, **data: typing.Any)
:canonical: tdk.home.HomepageProverb

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} proverb
:canonical: tdk.home.HomepageProverb.proverb
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageProverb.proverb
```

````

````{py:attribute} meaning
:canonical: tdk.home.HomepageProverb.meaning
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageProverb.meaning
```

````

`````

`````{py:class} HomepageFrequentTypos(/, **data: typing.Any)
:canonical: tdk.home.HomepageFrequentTypos

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} tdk_id
:canonical: tdk.home.HomepageFrequentTypos.tdk_id
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageFrequentTypos.tdk_id
```

````

````{py:attribute} incorrect
:canonical: tdk.home.HomepageFrequentTypos.incorrect
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageFrequentTypos.incorrect
```

````

````{py:attribute} correct
:canonical: tdk.home.HomepageFrequentTypos.correct
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageFrequentTypos.correct
```

````

`````

`````{py:class} HomepageRule(/, **data: typing.Any)
:canonical: tdk.home.HomepageRule

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} name
:canonical: tdk.home.HomepageRule.name
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageRule.name
```

````

````{py:attribute} url
:canonical: tdk.home.HomepageRule.url
:type: str
:value: >
   None

```{autodoc2-docstring} tdk.home.HomepageRule.url
```

````

`````

`````{py:class} HomepageWord(/, **data: typing.Any)
:canonical: tdk.home.HomepageWord

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} word
:canonical: tdk.home.HomepageWord.word
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageWord.word
```

````

````{py:attribute} meaning
:canonical: tdk.home.HomepageWord.meaning
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageWord.meaning
```

````

`````

````{py:data} ValidatedCounter
:canonical: tdk.home.ValidatedCounter
:value: >
   None

```{autodoc2-docstring} tdk.home.ValidatedCounter
```

````

`````{py:class} HomepageContent(/, **data: typing.Any)
:canonical: tdk.home.HomepageContent

Bases: {py:obj}`pydantic.BaseModel`

````{py:attribute} counter
:canonical: tdk.home.HomepageContent.counter
:type: tdk.home.ValidatedCounter
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.counter
```

````

````{py:attribute} mixups
:canonical: tdk.home.HomepageContent.mixups
:type: list[tdk.home.HomepageMixup]
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.mixups
```

````

````{py:attribute} proverbs
:canonical: tdk.home.HomepageContent.proverbs
:type: list[tdk.home.HomepageProverb]
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.proverbs
```

````

````{py:attribute} typos
:canonical: tdk.home.HomepageContent.typos
:type: list[tdk.home.HomepageFrequentTypos]
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.typos
```

````

````{py:attribute} rules
:canonical: tdk.home.HomepageContent.rules
:type: list[tdk.home.HomepageRule]
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.rules
```

````

````{py:attribute} loanword
:canonical: tdk.home.HomepageContent.loanword
:type: tdk.dictionaries.ysk.LoanwordEntry
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.loanword
```

````

````{py:attribute} words
:canonical: tdk.home.HomepageContent.words
:type: list[tdk.home.HomepageWord]
:value: >
   'Field(...)'

```{autodoc2-docstring} tdk.home.HomepageContent.words
```

````

`````

````{py:function} get_homepage_content(*, http_session: aiohttp.ClientSession) -> tdk.home.HomepageContent
:canonical: tdk.home.get_homepage_content
:async:

```{autodoc2-docstring} tdk.home.get_homepage_content
```
````

````{py:function} get_homepage_content_sync()
:canonical: tdk.home.get_homepage_content_sync

```{autodoc2-docstring} tdk.home.get_homepage_content_sync
```
````