# {py:mod}`tdk.dictionaries.kisi` ```{py:module} tdk.dictionaries.kisi ``` ```{autodoc2-docstring} tdk.dictionaries.kisi :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`NameSearchGender ` - * - {py:obj}`NameSearchField ` - * - {py:obj}`NameGender ` - * - {py:obj}`NameEntry ` - ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`search_names ` - ```{autodoc2-docstring} tdk.dictionaries.kisi.search_names :summary: ``` * - {py:obj}`search_names_sync ` - ```{autodoc2-docstring} tdk.dictionaries.kisi.search_names_sync :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`__all__ ` - ```{autodoc2-docstring} tdk.dictionaries.kisi.__all__ :summary: ``` * - {py:obj}`name_list_adapter ` - ```{autodoc2-docstring} tdk.dictionaries.kisi.name_list_adapter :summary: ``` ```` ### API ````{py:data} __all__ :canonical: tdk.dictionaries.kisi.__all__ :value: > ['NameSearchGender', 'NameSearchField', 'NameGender', 'NameEntry', 'search_names', 'search_names_syn... ```{autodoc2-docstring} tdk.dictionaries.kisi.__all__ ``` ```` `````{py:class} NameSearchGender() :canonical: tdk.dictionaries.kisi.NameSearchGender Bases: {py:obj}`enum.IntEnum` ````{py:attribute} FEMALE :canonical: tdk.dictionaries.kisi.NameSearchGender.FEMALE :value: > 1 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchGender.FEMALE ``` ```` ````{py:attribute} MALE :canonical: tdk.dictionaries.kisi.NameSearchGender.MALE :value: > 2 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchGender.MALE ``` ```` ````{py:attribute} UNISEX :canonical: tdk.dictionaries.kisi.NameSearchGender.UNISEX :value: > 3 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchGender.UNISEX ``` ```` ````{py:attribute} EITHER :canonical: tdk.dictionaries.kisi.NameSearchGender.EITHER :value: > 4 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchGender.EITHER ``` ```` ````` `````{py:class} NameSearchField() :canonical: tdk.dictionaries.kisi.NameSearchField Bases: {py:obj}`enum.IntEnum` ````{py:attribute} NAME :canonical: tdk.dictionaries.kisi.NameSearchField.NAME :value: > 1 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchField.NAME ``` ```` ````{py:attribute} MEANING :canonical: tdk.dictionaries.kisi.NameSearchField.MEANING :value: > 2 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameSearchField.MEANING ``` ```` ````` `````{py:class} NameGender() :canonical: tdk.dictionaries.kisi.NameGender Bases: {py:obj}`enum.IntEnum` ````{py:attribute} FEMALE :canonical: tdk.dictionaries.kisi.NameGender.FEMALE :value: > 1 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameGender.FEMALE ``` ```` ````{py:attribute} MALE :canonical: tdk.dictionaries.kisi.NameGender.MALE :value: > 2 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameGender.MALE ``` ```` ````{py:attribute} UNISEX :canonical: tdk.dictionaries.kisi.NameGender.UNISEX :value: > 3 ```{autodoc2-docstring} tdk.dictionaries.kisi.NameGender.UNISEX ``` ```` ````` `````{py:class} NameEntry(/, **data: typing.Any) :canonical: tdk.dictionaries.kisi.NameEntry Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.kisi.NameEntry.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.NameEntry.tdk_id ``` ```` ````{py:attribute} name :canonical: tdk.dictionaries.kisi.NameEntry.name :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.NameEntry.name ``` ```` ````{py:attribute} meaning :canonical: tdk.dictionaries.kisi.NameEntry.meaning :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.NameEntry.meaning ``` ```` ````{py:attribute} origin :canonical: tdk.dictionaries.kisi.NameEntry.origin :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.NameEntry.origin ``` ```` ````{py:attribute} gender :canonical: tdk.dictionaries.kisi.NameEntry.gender :type: tdk.dictionaries.kisi.NameGender :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.NameEntry.gender ``` ```` ````` ````{py:data} name_list_adapter :canonical: tdk.dictionaries.kisi.name_list_adapter :value: > 'TypeAdapter(...)' ```{autodoc2-docstring} tdk.dictionaries.kisi.name_list_adapter ``` ```` ````{py:function} search_names(query: str, *, according_to: tdk.dictionaries.kisi.NameSearchField | typing.Literal[name, meaning], gender: tdk.dictionaries.kisi.NameSearchGender | typing.Literal[female, male, unisex, either], http_session: aiohttp.ClientSession) -> list[tdk.dictionaries.kisi.NameEntry] :canonical: tdk.dictionaries.kisi.search_names :async: ```{autodoc2-docstring} tdk.dictionaries.kisi.search_names ``` ```` ````{py:function} search_names_sync() :canonical: tdk.dictionaries.kisi.search_names_sync ```{autodoc2-docstring} tdk.dictionaries.kisi.search_names_sync ``` ````