Skip to content

Commit 875c84e

Browse files
henribruhenribru
authored
Add recursive types (#27)
1 parent ebe5300 commit 875c84e

66 files changed

Lines changed: 6144 additions & 551 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,7 @@ If autocompleting import paths doesn't work you can find the correct path by usi
4444
on the thing you want to explicitly annotate. For `TypedDict`s this will also give you useful info about the structure of the dictionary.
4545

4646
### Recursive types
47-
Mypy unfortunately doesn't support [recursive types](https://github.com/python/mypy/issues/731).
48-
Some of Google's APIs have recursive type definitions in their schemas. Due to the lack of support these
49-
are only annotated as regular dictionaries, so the validity of the keys and values won't be checked.
47+
The stubs previously didn't include recursive type definitions due to a lack of type checker support, but this is now included. Note that if you're using Mypy, v0.990 or higher is required for this to work.
5048

5149
### Stubs for non-API-specific parts
5250
There are detailed stubs for the API services, but other parts of the library have only been annotated with [stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html),

‎googleapiclient-stubs/_apis/admin/directory_v1/schemas.pyi‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,14 @@ class PrinterModel(typing_extensions.TypedDict, total=False):
582582
manufacturer: str
583583

584584
@typing.type_check_only
585-
class Privilege(dict[str, typing.Any]): ...
585+
class Privilege(typing_extensions.TypedDict, total=False):
586+
childPrivileges: _list[Privilege]
587+
etag: str
588+
isOuScopable: bool
589+
kind: str
590+
privilegeName: str
591+
serviceId: str
592+
serviceName: str
586593

587594
@typing.type_check_only
588595
class Privileges(typing_extensions.TypedDict, total=False):

‎googleapiclient-stubs/_apis/analyticsadmin/v1alpha/schemas.pyi‎

Lines changed: 64 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,19 @@ class GoogleAnalyticsAdminV1alphaAccessFilter(typing_extensions.TypedDict, total
4545
stringFilter: GoogleAnalyticsAdminV1alphaAccessStringFilter
4646

4747
@typing.type_check_only
48-
class GoogleAnalyticsAdminV1alphaAccessFilterExpression(dict[str, typing.Any]): ...
48+
class GoogleAnalyticsAdminV1alphaAccessFilterExpression(
49+
typing_extensions.TypedDict, total=False
50+
):
51+
accessFilter: GoogleAnalyticsAdminV1alphaAccessFilter
52+
andGroup: GoogleAnalyticsAdminV1alphaAccessFilterExpressionList
53+
notExpression: GoogleAnalyticsAdminV1alphaAccessFilterExpression
54+
orGroup: GoogleAnalyticsAdminV1alphaAccessFilterExpressionList
4955

5056
@typing.type_check_only
51-
class GoogleAnalyticsAdminV1alphaAccessFilterExpressionList(dict[str, typing.Any]): ...
57+
class GoogleAnalyticsAdminV1alphaAccessFilterExpressionList(
58+
typing_extensions.TypedDict, total=False
59+
):
60+
expressions: _list[GoogleAnalyticsAdminV1alphaAccessFilterExpression]
5261

5362
@typing.type_check_only
5463
class GoogleAnalyticsAdminV1alphaAccessInListFilter(
@@ -320,26 +329,71 @@ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger(
320329
]
321330

322331
@typing.type_check_only
323-
class GoogleAnalyticsAdminV1alphaAudienceFilterClause(dict[str, typing.Any]): ...
332+
class GoogleAnalyticsAdminV1alphaAudienceFilterClause(
333+
typing_extensions.TypedDict, total=False
334+
):
335+
clauseType: typing_extensions.Literal[
336+
"AUDIENCE_CLAUSE_TYPE_UNSPECIFIED", "INCLUDE", "EXCLUDE"
337+
]
338+
sequenceFilter: GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
339+
simpleFilter: GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
324340

325341
@typing.type_check_only
326-
class GoogleAnalyticsAdminV1alphaAudienceFilterExpression(dict[str, typing.Any]): ...
342+
class GoogleAnalyticsAdminV1alphaAudienceFilterExpression(
343+
typing_extensions.TypedDict, total=False
344+
):
345+
andGroup: GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
346+
dimensionOrMetricFilter: GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
347+
eventFilter: GoogleAnalyticsAdminV1alphaAudienceEventFilter
348+
notExpression: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
349+
orGroup: GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
327350

328351
@typing.type_check_only
329352
class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList(
330-
dict[str, typing.Any]
331-
): ...
353+
typing_extensions.TypedDict, total=False
354+
):
355+
filterExpressions: _list[GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
332356

333357
@typing.type_check_only
334-
class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter(dict[str, typing.Any]): ...
358+
class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter(
359+
typing_extensions.TypedDict, total=False
360+
):
361+
scope: typing_extensions.Literal[
362+
"AUDIENCE_FILTER_SCOPE_UNSPECIFIED",
363+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT",
364+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION",
365+
"AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS",
366+
]
367+
sequenceMaximumDuration: str
368+
sequenceSteps: _list[
369+
GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
370+
]
335371

336372
@typing.type_check_only
337373
class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep(
338-
dict[str, typing.Any]
339-
): ...
374+
typing_extensions.TypedDict, total=False
375+
):
376+
constraintDuration: str
377+
filterExpression: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
378+
immediatelyFollows: bool
379+
scope: typing_extensions.Literal[
380+
"AUDIENCE_FILTER_SCOPE_UNSPECIFIED",
381+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT",
382+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION",
383+
"AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS",
384+
]
340385

341386
@typing.type_check_only
342-
class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter(dict[str, typing.Any]): ...
387+
class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter(
388+
typing_extensions.TypedDict, total=False
389+
):
390+
filterExpression: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
391+
scope: typing_extensions.Literal[
392+
"AUDIENCE_FILTER_SCOPE_UNSPECIFIED",
393+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT",
394+
"AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION",
395+
"AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS",
396+
]
343397

344398
@typing.type_check_only
345399
class GoogleAnalyticsAdminV1alphaAuditUserLink(

‎googleapiclient-stubs/_apis/analyticsdata/v1alpha/schemas.pyi‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,15 @@ class Filter(typing_extensions.TypedDict, total=False):
116116
stringFilter: StringFilter
117117

118118
@typing.type_check_only
119-
class FilterExpression(dict[str, typing.Any]): ...
119+
class FilterExpression(typing_extensions.TypedDict, total=False):
120+
andGroup: FilterExpressionList
121+
filter: Filter
122+
notExpression: FilterExpression
123+
orGroup: FilterExpressionList
120124

121125
@typing.type_check_only
122-
class FilterExpressionList(dict[str, typing.Any]): ...
126+
class FilterExpressionList(typing_extensions.TypedDict, total=False):
127+
expressions: _list[FilterExpression]
123128

124129
@typing.type_check_only
125130
class InListFilter(typing_extensions.TypedDict, total=False):
@@ -262,7 +267,18 @@ class Row(typing_extensions.TypedDict, total=False):
262267
metricValues: _list[MetricValue]
263268

264269
@typing.type_check_only
265-
class RunPivotReportRequest(dict[str, typing.Any]): ...
270+
class RunPivotReportRequest(typing_extensions.TypedDict, total=False):
271+
cohortSpec: CohortSpec
272+
currencyCode: str
273+
dateRanges: _list[DateRange]
274+
dimensionFilter: FilterExpression
275+
dimensions: _list[Dimension]
276+
entity: Entity
277+
keepEmptyRows: bool
278+
metricFilter: FilterExpression
279+
metrics: _list[Metric]
280+
pivots: _list[Pivot]
281+
returnPropertyQuota: bool
266282

267283
@typing.type_check_only
268284
class RunPivotReportResponse(typing_extensions.TypedDict, total=False):
@@ -297,7 +313,21 @@ class RunRealtimeReportResponse(typing_extensions.TypedDict, total=False):
297313
totals: _list[Row]
298314

299315
@typing.type_check_only
300-
class RunReportRequest(dict[str, typing.Any]): ...
316+
class RunReportRequest(typing_extensions.TypedDict, total=False):
317+
cohortSpec: CohortSpec
318+
currencyCode: str
319+
dateRanges: _list[DateRange]
320+
dimensionFilter: FilterExpression
321+
dimensions: _list[Dimension]
322+
entity: Entity
323+
keepEmptyRows: bool
324+
limit: str
325+
metricAggregations: _list[str]
326+
metricFilter: FilterExpression
327+
metrics: _list[Metric]
328+
offset: str
329+
orderBys: _list[OrderBy]
330+
returnPropertyQuota: bool
301331

302332
@typing.type_check_only
303333
class RunReportResponse(typing_extensions.TypedDict, total=False):

‎googleapiclient-stubs/_apis/analyticsdata/v1beta/schemas.pyi‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,15 @@ class Filter(typing_extensions.TypedDict, total=False):
140140
stringFilter: StringFilter
141141

142142
@typing.type_check_only
143-
class FilterExpression(dict[str, typing.Any]): ...
143+
class FilterExpression(typing_extensions.TypedDict, total=False):
144+
andGroup: FilterExpressionList
145+
filter: Filter
146+
notExpression: FilterExpression
147+
orGroup: FilterExpressionList
144148

145149
@typing.type_check_only
146-
class FilterExpressionList(dict[str, typing.Any]): ...
150+
class FilterExpressionList(typing_extensions.TypedDict, total=False):
151+
expressions: _list[FilterExpression]
147152

148153
@typing.type_check_only
149154
class InListFilter(typing_extensions.TypedDict, total=False):
@@ -308,7 +313,18 @@ class Row(typing_extensions.TypedDict, total=False):
308313
metricValues: _list[MetricValue]
309314

310315
@typing.type_check_only
311-
class RunPivotReportRequest(dict[str, typing.Any]): ...
316+
class RunPivotReportRequest(typing_extensions.TypedDict, total=False):
317+
cohortSpec: CohortSpec
318+
currencyCode: str
319+
dateRanges: _list[DateRange]
320+
dimensionFilter: FilterExpression
321+
dimensions: _list[Dimension]
322+
keepEmptyRows: bool
323+
metricFilter: FilterExpression
324+
metrics: _list[Metric]
325+
pivots: _list[Pivot]
326+
property: str
327+
returnPropertyQuota: bool
312328

313329
@typing.type_check_only
314330
class RunPivotReportResponse(typing_extensions.TypedDict, total=False):
@@ -346,7 +362,21 @@ class RunRealtimeReportResponse(typing_extensions.TypedDict, total=False):
346362
totals: _list[Row]
347363

348364
@typing.type_check_only
349-
class RunReportRequest(dict[str, typing.Any]): ...
365+
class RunReportRequest(typing_extensions.TypedDict, total=False):
366+
cohortSpec: CohortSpec
367+
currencyCode: str
368+
dateRanges: _list[DateRange]
369+
dimensionFilter: FilterExpression
370+
dimensions: _list[Dimension]
371+
keepEmptyRows: bool
372+
limit: str
373+
metricAggregations: _list[str]
374+
metricFilter: FilterExpression
375+
metrics: _list[Metric]
376+
offset: str
377+
orderBys: _list[OrderBy]
378+
property: str
379+
returnPropertyQuota: bool
350380

351381
@typing.type_check_only
352382
class RunReportResponse(typing_extensions.TypedDict, total=False):

‎googleapiclient-stubs/_apis/androidenterprise/v1/schemas.pyi‎

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,24 @@ class AppRestrictionsSchemaChangeEvent(typing_extensions.TypedDict, total=False)
6060
productId: str
6161

6262
@typing.type_check_only
63-
class AppRestrictionsSchemaRestriction(dict[str, typing.Any]): ...
63+
class AppRestrictionsSchemaRestriction(typing_extensions.TypedDict, total=False):
64+
defaultValue: AppRestrictionsSchemaRestrictionRestrictionValue
65+
description: str
66+
entry: _list[str]
67+
entryValue: _list[str]
68+
key: str
69+
nestedRestriction: _list[AppRestrictionsSchemaRestriction]
70+
restrictionType: typing_extensions.Literal[
71+
"bool",
72+
"string",
73+
"integer",
74+
"choice",
75+
"multiselect",
76+
"hidden",
77+
"bundle",
78+
"bundleArray",
79+
]
80+
title: str
6481

6582
@typing.type_check_only
6683
class AppRestrictionsSchemaRestrictionRestrictionValue(
@@ -291,10 +308,18 @@ class ManagedConfigurationsSettingsListResponse(
291308
managedConfigurationsSettings: _list[ManagedConfigurationsSettings]
292309

293310
@typing.type_check_only
294-
class ManagedProperty(dict[str, typing.Any]): ...
311+
class ManagedProperty(typing_extensions.TypedDict, total=False):
312+
key: str
313+
valueBool: bool
314+
valueBundle: ManagedPropertyBundle
315+
valueBundleArray: _list[ManagedPropertyBundle]
316+
valueInteger: int
317+
valueString: str
318+
valueStringArray: _list[str]
295319

296320
@typing.type_check_only
297-
class ManagedPropertyBundle(dict[str, typing.Any]): ...
321+
class ManagedPropertyBundle(typing_extensions.TypedDict, total=False):
322+
managedProperty: _list[ManagedProperty]
298323

299324
@typing.type_check_only
300325
class NewDeviceEvent(typing_extensions.TypedDict, total=False):
@@ -352,7 +377,18 @@ class Permission(typing_extensions.TypedDict, total=False):
352377
permissionId: str
353378

354379
@typing.type_check_only
355-
class Policy(dict[str, typing.Any]): ...
380+
class Policy(typing_extensions.TypedDict, total=False):
381+
autoUpdatePolicy: typing_extensions.Literal[
382+
"autoUpdatePolicyUnspecified", "choiceToTheUser", "never", "wifiOnly", "always"
383+
]
384+
deviceReportPolicy: typing_extensions.Literal[
385+
"deviceReportPolicyUnspecified", "deviceReportDisabled", "deviceReportEnabled"
386+
]
387+
maintenanceWindow: MaintenanceWindow
388+
productAvailabilityPolicy: typing_extensions.Literal[
389+
"productAvailabilityPolicyUnspecified", "whitelist", "all"
390+
]
391+
productPolicy: _list[ProductPolicy]
356392

357393
@typing.type_check_only
358394
class Product(typing_extensions.TypedDict, total=False):
@@ -411,7 +447,19 @@ class ProductPermissions(typing_extensions.TypedDict, total=False):
411447
productId: str
412448

413449
@typing.type_check_only
414-
class ProductPolicy(dict[str, typing.Any]): ...
450+
class ProductPolicy(typing_extensions.TypedDict, total=False):
451+
autoInstallPolicy: AutoInstallPolicy
452+
autoUpdateMode: typing_extensions.Literal[
453+
"autoUpdateModeUnspecified",
454+
"autoUpdateDefault",
455+
"autoUpdatePostponed",
456+
"autoUpdateHighPriority",
457+
]
458+
enterpriseAuthenticationAppLinkConfigs: _list[EnterpriseAuthenticationAppLinkConfig]
459+
managedConfiguration: ManagedConfiguration
460+
productId: str
461+
trackIds: _list[str]
462+
tracks: _list[str]
415463

416464
@typing.type_check_only
417465
class ProductSet(typing_extensions.TypedDict, total=False):

‎googleapiclient-stubs/_apis/androidmanagement/v1/schemas.pyi‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,24 @@ class ManagedConfigurationTemplate(typing_extensions.TypedDict, total=False):
625625
templateId: str
626626

627627
@typing.type_check_only
628-
class ManagedProperty(dict[str, typing.Any]): ...
628+
class ManagedProperty(typing_extensions.TypedDict, total=False):
629+
defaultValue: typing.Any
630+
description: str
631+
entries: _list[ManagedPropertyEntry]
632+
key: str
633+
nestedProperties: _list[ManagedProperty]
634+
title: str
635+
type: typing_extensions.Literal[
636+
"MANAGED_PROPERTY_TYPE_UNSPECIFIED",
637+
"BOOL",
638+
"STRING",
639+
"INTEGER",
640+
"CHOICE",
641+
"MULTISELECT",
642+
"HIDDEN",
643+
"BUNDLE",
644+
"BUNDLE_ARRAY",
645+
]
629646

630647
@typing.type_check_only
631648
class ManagedPropertyEntry(typing_extensions.TypedDict, total=False):

‎googleapiclient-stubs/_apis/beyondcorp/v1/schemas.pyi‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,16 @@ class GoogleCloudBeyondcorpAppconnectorsV1ResolveInstanceConfigResponse(
331331
instanceConfig: GoogleCloudBeyondcorpAppconnectorsV1AppConnectorInstanceConfig
332332

333333
@typing.type_check_only
334-
class GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo(dict[str, typing.Any]): ...
334+
class GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo(
335+
typing_extensions.TypedDict, total=False
336+
):
337+
id: str
338+
resource: dict[str, typing.Any]
339+
status: typing_extensions.Literal[
340+
"HEALTH_STATUS_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "UNRESPONSIVE", "DEGRADED"
341+
]
342+
sub: _list[GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo]
343+
time: str
335344

336345
@typing.type_check_only
337346
class GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorOperationMetadata(

0 commit comments

Comments
 (0)