Add custom __contains__ types (#41)

Author: henribru

google-stubs/ads/googleads/v13/common/types/ad_asset.pyi

@@ -1,8 +1,9 @@
 from collections.abc import Mapping
-from typing import Any, TypeVar
+from typing import Any, NoReturn, TypeVar
 
 import google.protobuf.message
 import proto
+from typing_extensions import Literal
 
 from google.ads.googleads.v13.common.types.asset_policy import AdAssetPolicySummary
 from google.ads.googleads.v13.enums.types.asset_performance_label import (
@@ -23,6 +24,7 @@ class AdDiscoveryCarouselCardAsset(proto.Message):
         ignore_unknown_fields: bool = False,
         asset: str = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["asset"]) -> bool: ...  # type: ignore[override]
 
 class AdImageAsset(proto.Message):
     asset: str
@@ -33,6 +35,7 @@ class AdImageAsset(proto.Message):
         ignore_unknown_fields: bool = False,
         asset: str = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["asset"]) -> bool: ...  # type: ignore[override]
 
 class AdMediaBundleAsset(proto.Message):
     asset: str
@@ -43,6 +46,7 @@ class AdMediaBundleAsset(proto.Message):
         ignore_unknown_fields: bool = False,
         asset: str = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["asset"]) -> bool: ...  # type: ignore[override]
 
 class AdTextAsset(proto.Message):
     text: str
@@ -59,6 +63,7 @@ class AdTextAsset(proto.Message):
         asset_performance_label: AssetPerformanceLabelEnum.AssetPerformanceLabel = ...,
         policy_summary_info: AdAssetPolicySummary = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["text", "pinned_field", "asset_performance_label", "policy_summary_info"]) -> bool: ...  # type: ignore[override]
 
 class AdVideoAsset(proto.Message):
     asset: str
@@ -69,3 +74,4 @@ class AdVideoAsset(proto.Message):
         ignore_unknown_fields: bool = False,
         asset: str = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["asset"]) -> bool: ...  # type: ignore[override]

google-stubs/ads/googleads/v13/common/types/ad_type_infos.pyi

@@ -1,8 +1,9 @@
 from collections.abc import Mapping, MutableSequence
-from typing import Any, TypeVar
+from typing import Any, NoReturn, TypeVar
 
 import google.protobuf.message
 import proto
+from typing_extensions import Literal
 
 from google.ads.googleads.v13.common.types.ad_asset import (
     AdDiscoveryCarouselCardAsset,
@@ -47,6 +48,7 @@ class AppAdInfo(proto.Message):
         youtube_videos: MutableSequence[AdVideoAsset] = ...,
         html5_media_bundles: MutableSequence[AdMediaBundleAsset] = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["mandatory_ad_text", "headlines", "descriptions", "images", "youtube_videos", "html5_media_bundles"]) -> bool: ...  # type: ignore[override]
 
 class AppEngagementAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -63,6 +65,7 @@ class AppEngagementAdInfo(proto.Message):
         images: MutableSequence[AdImageAsset] = ...,
         videos: MutableSequence[AdVideoAsset] = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "descriptions", "images", "videos"]) -> bool: ...  # type: ignore[override]
 
 class AppPreRegistrationAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -79,6 +82,7 @@ class AppPreRegistrationAdInfo(proto.Message):
         images: MutableSequence[AdImageAsset] = ...,
         youtube_videos: MutableSequence[AdVideoAsset] = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "descriptions", "images", "youtube_videos"]) -> bool: ...  # type: ignore[override]
 
 class CallAdInfo(proto.Message):
     country_code: str
@@ -115,6 +119,7 @@ class CallAdInfo(proto.Message):
         path1: str = ...,
         path2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["country_code", "phone_number", "business_name", "headline1", "headline2", "description1", "description2", "call_tracked", "disable_call_conversion", "phone_number_verification_url", "conversion_action", "conversion_reporting_state", "path1", "path2"]) -> bool: ...  # type: ignore[override]
 
 class DiscoveryCarouselAdInfo(proto.Message):
     business_name: str
@@ -135,6 +140,7 @@ class DiscoveryCarouselAdInfo(proto.Message):
         call_to_action_text: str = ...,
         carousel_cards: MutableSequence[AdDiscoveryCarouselCardAsset] = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["business_name", "logo_image", "headline", "description", "call_to_action_text", "carousel_cards"]) -> bool: ...  # type: ignore[override]
 
 class DiscoveryMultiAssetAdInfo(proto.Message):
     marketing_images: MutableSequence[AdImageAsset]
@@ -161,6 +167,7 @@ class DiscoveryMultiAssetAdInfo(proto.Message):
         call_to_action_text: str = ...,
         lead_form_only: bool = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["marketing_images", "square_marketing_images", "portrait_marketing_images", "logo_images", "headlines", "descriptions", "business_name", "call_to_action_text", "lead_form_only"]) -> bool: ...  # type: ignore[override]
 
 class DisplayUploadAdInfo(proto.Message):
     display_upload_product_type: DisplayUploadProductTypeEnum.DisplayUploadProductType
@@ -173,6 +180,7 @@ class DisplayUploadAdInfo(proto.Message):
         display_upload_product_type: DisplayUploadProductTypeEnum.DisplayUploadProductType = ...,
         media_bundle: AdMediaBundleAsset = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["display_upload_product_type", "media_bundle"]) -> bool: ...  # type: ignore[override]
 
 class ExpandedDynamicSearchAdInfo(proto.Message):
     description: str
@@ -185,6 +193,7 @@ class ExpandedDynamicSearchAdInfo(proto.Message):
         description: str = ...,
         description2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["description", "description2"]) -> bool: ...  # type: ignore[override]
 
 class ExpandedTextAdInfo(proto.Message):
     headline_part1: str
@@ -207,6 +216,7 @@ class ExpandedTextAdInfo(proto.Message):
         path1: str = ...,
         path2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headline_part1", "headline_part2", "headline_part3", "description", "description2", "path1", "path2"]) -> bool: ...  # type: ignore[override]
 
 class HotelAdInfo(proto.Message):
     def __init__(
@@ -215,6 +225,7 @@ class HotelAdInfo(proto.Message):
         *,
         ignore_unknown_fields: bool = False,
     ) -> None: ...
+    def __contains__(self, key: NoReturn) -> bool: ...  # type: ignore[override]
 
 class ImageAdInfo(proto.Message):
     pixel_width: int
@@ -245,6 +256,7 @@ class ImageAdInfo(proto.Message):
         data: bytes = ...,
         ad_id_to_copy_image_from: int = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["pixel_width", "pixel_height", "image_url", "preview_pixel_width", "preview_pixel_height", "preview_image_url", "mime_type", "name", "media_file", "data", "ad_id_to_copy_image_from"]) -> bool: ...  # type: ignore[override]
 
 class InFeedVideoAdInfo(proto.Message):
     headline: str
@@ -261,6 +273,7 @@ class InFeedVideoAdInfo(proto.Message):
         description2: str = ...,
         thumbnail: VideoThumbnailEnum.VideoThumbnail = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headline", "description1", "description2", "thumbnail"]) -> bool: ...  # type: ignore[override]
 
 class LegacyAppInstallAdInfo(proto.Message):
     app_id: str
@@ -279,6 +292,7 @@ class LegacyAppInstallAdInfo(proto.Message):
         description1: str = ...,
         description2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["app_id", "app_store", "headline", "description1", "description2"]) -> bool: ...  # type: ignore[override]
 
 class LegacyResponsiveDisplayAdInfo(proto.Message):
     short_headline: str
@@ -317,6 +331,7 @@ class LegacyResponsiveDisplayAdInfo(proto.Message):
         price_prefix: str = ...,
         promo_text: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["short_headline", "long_headline", "description", "business_name", "allow_flexible_color", "accent_color", "main_color", "call_to_action_text", "logo_image", "square_logo_image", "marketing_image", "square_marketing_image", "format_setting", "price_prefix", "promo_text"]) -> bool: ...  # type: ignore[override]
 
 class LocalAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -341,6 +356,7 @@ class LocalAdInfo(proto.Message):
         path1: str = ...,
         path2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "descriptions", "call_to_actions", "marketing_images", "logo_images", "videos", "path1", "path2"]) -> bool: ...  # type: ignore[override]
 
 class ResponsiveDisplayAdControlSpec(proto.Message):
     enable_asset_enhancements: bool
@@ -353,6 +369,7 @@ class ResponsiveDisplayAdControlSpec(proto.Message):
         enable_asset_enhancements: bool = ...,
         enable_autogen_video: bool = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["enable_asset_enhancements", "enable_autogen_video"]) -> bool: ...  # type: ignore[override]
 
 class ResponsiveDisplayAdInfo(proto.Message):
     marketing_images: MutableSequence[AdImageAsset]
@@ -395,6 +412,7 @@ class ResponsiveDisplayAdInfo(proto.Message):
         format_setting: DisplayAdFormatSettingEnum.DisplayAdFormatSetting = ...,
         control_spec: ResponsiveDisplayAdControlSpec = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["marketing_images", "square_marketing_images", "logo_images", "square_logo_images", "headlines", "long_headline", "descriptions", "youtube_videos", "business_name", "main_color", "accent_color", "allow_flexible_color", "call_to_action_text", "price_prefix", "promo_text", "format_setting", "control_spec"]) -> bool: ...  # type: ignore[override]
 
 class ResponsiveSearchAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -411,6 +429,7 @@ class ResponsiveSearchAdInfo(proto.Message):
         path1: str = ...,
         path2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "descriptions", "path1", "path2"]) -> bool: ...  # type: ignore[override]
 
 class ShoppingComparisonListingAdInfo(proto.Message):
     headline: str
@@ -421,6 +440,7 @@ class ShoppingComparisonListingAdInfo(proto.Message):
         ignore_unknown_fields: bool = False,
         headline: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headline"]) -> bool: ...  # type: ignore[override]
 
 class ShoppingProductAdInfo(proto.Message):
     def __init__(
@@ -429,6 +449,7 @@ class ShoppingProductAdInfo(proto.Message):
         *,
         ignore_unknown_fields: bool = False,
     ) -> None: ...
+    def __contains__(self, key: NoReturn) -> bool: ...  # type: ignore[override]
 
 class ShoppingSmartAdInfo(proto.Message):
     def __init__(
@@ -437,6 +458,7 @@ class ShoppingSmartAdInfo(proto.Message):
         *,
         ignore_unknown_fields: bool = False,
     ) -> None: ...
+    def __contains__(self, key: NoReturn) -> bool: ...  # type: ignore[override]
 
 class SmartCampaignAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -449,6 +471,7 @@ class SmartCampaignAdInfo(proto.Message):
         headlines: MutableSequence[AdTextAsset] = ...,
         descriptions: MutableSequence[AdTextAsset] = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "descriptions"]) -> bool: ...  # type: ignore[override]
 
 class TextAdInfo(proto.Message):
     headline: str
@@ -463,6 +486,7 @@ class TextAdInfo(proto.Message):
         description1: str = ...,
         description2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headline", "description1", "description2"]) -> bool: ...  # type: ignore[override]
 
 class TravelAdInfo(proto.Message):
     def __init__(
@@ -471,6 +495,7 @@ class TravelAdInfo(proto.Message):
         *,
         ignore_unknown_fields: bool = False,
     ) -> None: ...
+    def __contains__(self, key: NoReturn) -> bool: ...  # type: ignore[override]
 
 class VideoAdInfo(proto.Message):
     video: AdVideoAsset
@@ -491,6 +516,7 @@ class VideoAdInfo(proto.Message):
         non_skippable: VideoNonSkippableInStreamAdInfo = ...,
         in_feed: InFeedVideoAdInfo = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["video", "in_stream", "bumper", "out_stream", "non_skippable", "in_feed"]) -> bool: ...  # type: ignore[override]
 
 class VideoBumperInStreamAdInfo(proto.Message):
     companion_banner: AdImageAsset
@@ -505,6 +531,7 @@ class VideoBumperInStreamAdInfo(proto.Message):
         action_button_label: str = ...,
         action_headline: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["companion_banner", "action_button_label", "action_headline"]) -> bool: ...  # type: ignore[override]
 
 class VideoNonSkippableInStreamAdInfo(proto.Message):
     companion_banner: AdImageAsset
@@ -519,6 +546,7 @@ class VideoNonSkippableInStreamAdInfo(proto.Message):
         action_button_label: str = ...,
         action_headline: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["companion_banner", "action_button_label", "action_headline"]) -> bool: ...  # type: ignore[override]
 
 class VideoOutstreamAdInfo(proto.Message):
     headline: str
@@ -531,6 +559,7 @@ class VideoOutstreamAdInfo(proto.Message):
         headline: str = ...,
         description: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headline", "description"]) -> bool: ...  # type: ignore[override]
 
 class VideoResponsiveAdInfo(proto.Message):
     headlines: MutableSequence[AdTextAsset]
@@ -555,6 +584,7 @@ class VideoResponsiveAdInfo(proto.Message):
         breadcrumb1: str = ...,
         breadcrumb2: str = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["headlines", "long_headlines", "descriptions", "call_to_actions", "videos", "companion_banners", "breadcrumb1", "breadcrumb2"]) -> bool: ...  # type: ignore[override]
 
 class VideoTrueViewInStreamAdInfo(proto.Message):
     action_button_label: str
@@ -569,3 +599,4 @@ class VideoTrueViewInStreamAdInfo(proto.Message):
         action_headline: str = ...,
         companion_banner: AdImageAsset = ...,
     ) -> None: ...
+    def __contains__(self, key: Literal["action_button_label", "action_headline", "companion_banner"]) -> bool: ...  # type: ignore[override]

google-stubs/ads/googleads/v13/common/types/asset_policy.pyi

@@ -1,8 +1,9 @@
 from collections.abc import Mapping, MutableSequence
-from typing import Any, TypeVar
+from typing import Any, NoReturn, TypeVar
 
 import google.protobuf.message
 import proto
+from typing_extensions import Literal
 
 from google.ads.googleads.v13.common.types.policy import PolicyTopicEntry
 from google.ads.googleads.v13.enums.types.asset_link_primary_status import (
@@ -36,6 +37,7 @@ class AdAssetPolicySummary(proto.Message):
         review_status: PolicyReviewStatusEnum.PolicyReviewStatus = ...,
         approval_status: PolicyApprovalStatusEnum.PolicyApprovalStatus = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["policy_topic_entries", "review_status", "approval_status"]) -> bool: ...  # type: ignore[override]
 
 class AssetDisapproved(proto.Message):
     offline_evaluation_error_reasons: MutableSequence[
@@ -50,6 +52,7 @@ class AssetDisapproved(proto.Message):
             AssetOfflineEvaluationErrorReasonsEnum.AssetOfflineEvaluationErrorReasons
         ] = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["offline_evaluation_error_reasons"]) -> bool: ...  # type: ignore[override]
 
 class AssetLinkPrimaryStatusDetails(proto.Message):
     reason: AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason
@@ -64,3 +67,4 @@ class AssetLinkPrimaryStatusDetails(proto.Message):
         status: AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus = ...,
         asset_disapproved: AssetDisapproved = ...
     ) -> None: ...
+    def __contains__(self, key: Literal["reason", "status", "asset_disapproved"]) -> bool: ...  # type: ignore[override]