pygourmet package

Submodules

pygourmet.client module

class pygourmet.client.Api(keyid: str)[ソース]

ベースクラス: object

APIクライアントクラス

search(option: Option) → list[Shop][ソース]

レストランを検索

パラメータ:: option (Option) -- 検索オプション
戻り値:: 店舗データのリスト
戻り値の型:: list[Shop]
Raises:: SearchError: if failed

async search_async(option: Option) → list[Shop][ソース]

[非同期]レストランを検索

パラメータ:: option (Option) -- 検索オプション
戻り値:: 店舗データのリスト
戻り値の型:: list[Shop]
Raises:: SearchError: if failed

pygourmet.errors module

exception pygourmet.errors.SearchError(message: str)[ソース]

ベースクラス: Exception

raise when search errors

pygourmet.option module

ベースクラス: BaseModel

検索時に指定するパラメータ

address: str | None

band: bool | None

barrier_free: bool | None

budget: str | None

card: bool | None

charter: bool | None

child: bool | None

cocktail: bool | None

count: int | None

course: bool | None

credit_card: str | None

datum: str | None

english: bool | None

equipment: bool | None

free_drink: bool | None

free_food: bool | None

genre: str | None

horigotatsu: bool | None

id: str | None

karaoke: bool | None

keyword: str | None

ktai: bool | None

ktai_coupon: int | None

large_area: str | None

large_service_area: str | None

lat: float | None

lng: float | None

lunch: bool | None

middle_area: str | None

midnight: bool | None

midnight_meal: bool | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name_any: str | None

name_kana: str | None

night_view: bool | None

non_smoking: bool | None

open_air: bool | None

order: int

parking: bool | None

party_capacity: bool | None

pet: bool | None

private_room: bool | None

range: int

sake: bool | None

service_area: str | None

shochu: bool | None

show: bool | None

small_area: str | None

sommelier: bool | None

special: str | None

special_category: str | None

special_category_or: str | None

special_or: str | None

start: int | None

tatami: bool | None

tel: str | None

tv: bool | None

type: str | None

wedding: bool | None

wifi: bool | None

wine: bool | None

pygourmet.shop module

class pygourmet.shop.Budget(*, average: str | None = None, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

average: str | None

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.CouponUrls(*, pc: HttpUrl | None = None, sp: HttpUrl | None = None)[ソース]

ベースクラス: BaseModel

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pc: HttpUrl | None

sp: HttpUrl | None

class pygourmet.shop.Genre(*, code: str | None = None, name: str | None = None, catch: str | None = None)[ソース]

ベースクラス: BaseModel

catch: str | None

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.LargeArea(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.LargeServiceArea(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.MiddleArea(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.Photo(*, pc: PhotoPc | None = None, mobile: PhotoMobile | None = None)[ソース]

ベースクラス: BaseModel

mobile: PhotoMobile | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pc: PhotoPc | None

class pygourmet.shop.PhotoMobile(*, l: HttpUrl | None = None, s: HttpUrl | None = None)[ソース]

ベースクラス: BaseModel

l: HttpUrl | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

s: HttpUrl | None

class pygourmet.shop.PhotoPc(*, l: HttpUrl | None = None, m: HttpUrl | None = None, s: HttpUrl | None = None)[ソース]

ベースクラス: BaseModel

l: HttpUrl | None

m: HttpUrl | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

s: HttpUrl | None

class pygourmet.shop.ServiceArea(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

ベースクラス: BaseModel

お店データを保持するクラス

access: str | None

address: str | None

band: str | None

barrier_free: str | None

budget: Budget | None

budget_memo: str | None

capacity: int | None

card: str | None

catch: str | None

charter: str | None

classmethod check_empty_values(data: dict[str, Any]) → dict[str, Any][ソース]

child: str | None

close: str | None

coupon_urls: CouponUrls | None

course: str | None

english: str | None

equipment: str | None

free_drink: str | None

free_food: str | None

genre: Genre | None

horigotatsu: str | None

id: str | None

karaoke: str | None

ktai: str | None

ktai_coupon: int | None

large_area: LargeArea | None

large_service_area: LargeServiceArea | None

lat: float | None

lng: float | None

logo_image: HttpUrl | None

lunch: str | None

meters_to_point(lat: float, lng: float) → int[ソース]

middle_area: MiddleArea | None

midnight: str | None

mobile_access: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name_kana: str | None

non_smoking: str | None

open: str | None

open_air: str | None

other_memo: str | None

parking: str | None

party_capacity: int | None

pet: str | None

photo: Photo | None

private_room: str | None

service_area: ServiceArea | None

shop_detail_memo: str | None

show: str | None

small_area: SmallArea | None

sommelier: str | None

station_name: str | None

sub_genre: SubGenre | None

tatami: str | None

tv: str | None

urls: Urls | None

wedding: str | None

wifi: str | None

class pygourmet.shop.SmallArea(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.SubGenre(*, code: str | None = None, name: str | None = None)[ソース]

ベースクラス: BaseModel

code: str | None

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

class pygourmet.shop.Urls(*, pc: HttpUrl | None = None)[ソース]

ベースクラス: BaseModel

model_config: ClassVar[ConfigDict] = {'frozen': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pc: HttpUrl | None

pygourmet package

Submodules

pygourmet.client module

pygourmet.errors module

pygourmet.option module

pygourmet.shop module

Module contents