Skip to content

Commit cacd00a

Browse files
henribruhenribru
committed
Initial commit
0 parents  commit cacd00a

1,075 files changed

Lines changed: 205501 additions & 0 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.

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
*
2+
!/.gitignore
3+
!/googleapiclient-stubs/
4+
!/googleapiclient-stubs/**
5+
!/apiclient-stubs/
6+
!/apiclient-stubs/**
7+
!/pyproject.toml
8+
!/README.md
9+
!/LICENSE

‎LICENSE‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Type stubs for google-api-python-client
2+
3+
[![PyPI version](https://badge.fury.io/py/google-api-python-client-stubs.svg)](https://badge.fury.io/py/google-api-python-client-stubs)
4+
5+
This package provides type stubs for the [google-api-python-client](https://github.com/googleapis/google-api-python-client) library.
6+
It allows you to type check usage of the library with e.g. [mypy](http://mypy-lang.org/) and will also improve autocomplete in many editors.
7+
8+
**This is in no way affiliated with Google.**
9+
10+
The stubs were generated automatically based on Google's [Discovery Documents](https://developers.google.com/discovery/v1/reference/apis).
11+
12+
If you find incorrect annotations, please create an issue.
13+
14+
## Installation
15+
16+
```shell script
17+
$ pip install google-api-python-client-stubs
18+
```
19+
20+
## Caveats
21+
22+
### Performance
23+
The stubs contain a separate overload of `googleapiclient.discovery.build` for each service and version (see `discovery.pyi`).
24+
This can lead to slow type inference for this function. Mypy will generally be pretty fast after the first run,
25+
but you might experience slow autocomplete. If you're experiencing this problem you can bypass type inference with explicit annotations,
26+
e.g. `sheets_service: SheetsResource = build("sheets", "v4")` instead of `sheets_service = build("sheets", "v4")`.
27+
See the next section for some caveats to this approach.
28+
29+
### Explicit annotations
30+
The `google-api-python-client-stubs` is quite dynamic.
31+
All resources are just instances of a single class with dynamically attached methods
32+
and the requests and responses are just dictionaries. The way this is annotated is with
33+
classes and [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict)
34+
that don't exist in the actual library, only in the stub files. This means you *cannot* use any of these types at runtime, it *will* cause your code to crash.
35+
If you rely solely on type inference, this is not an issue, but as soon as you want to explicitly
36+
annotate a variable, argument or return type in your code with one of these types, you must follow these rules:
37+
1. Put `from __future__ import annotations` at the top of your file. This ensures that annotations are not evaluated at runtime.
38+
This is only supported in 3.7 and up, so for earlier version of Python you need to stick to type inference.
39+
2. Only import the types inside an `if typing.TYPE_CHECKING` block. This ensures that the imports are only evaluated during
40+
type checking. Note that any type not available at runtime is located under the `googleapiclient._apis` package.
41+
For example, `SheetsResource` should be imported from `googleapiclient._apis.sheets.v4.resources`.
42+
If autocompleting import paths doesn't work you can find the correct path by using Mypy's [reveal_type](https://mypy.readthedocs.io/en/stable/common_issues.html#reveal-type)
43+
on the thing you want to explicitly annotate. For `TypedDict`s this will also give you useful info about the structure of the dictionary.
44+
45+
### Recursive types
46+
Mypy unfortunately doesn't support [recursive types](https://github.com/python/mypy/issues/731).
47+
Some of Google's APIs have recursive type definitions in their schemas. Due to the lack of support these
48+
are only annotated as regular dictionaries, so the validity of the keys and values won't be checked.
49+
50+
### Stubs for non-API-specific parts
51+
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),
52+
so they're mostly typed as `Any`. I believe these parts are mostly used internally by the library itself,
53+
so for most users this should be fine. Contributions to improve these stubs are welcome, though.

‎apiclient-stubs/__init__.pyi‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
from googleapiclient import (
2+
channel as channel,
3+
discovery as discovery,
4+
errors as errors,
5+
http as http,
6+
mimeparse as mimeparse,
7+
model as model,
8+
sample_tools as sample_tools,
9+
schema as schema,
10+
)

‎apiclient-stubs/py.typed‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
partial

‎googleapiclient-stubs/__init__.pyi‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import logging
2+
from typing import Any
3+
4+
class NullHandler(logging.Handler):
5+
def emit(self, record: Any) -> None: ...

‎googleapiclient-stubs/_apis/__init__.py‎

Whitespace-only changes.

‎googleapiclient-stubs/_apis/abusiveexperiencereport/__init__.pyi‎

Whitespace-only changes.

‎googleapiclient-stubs/_apis/abusiveexperiencereport/v1/__init__.pyi‎

Whitespace-only changes.

‎googleapiclient-stubs/_apis/abusiveexperiencereport/v1/resources.pyi‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import typing
2+
3+
import httplib2 # type: ignore
4+
import typing_extensions
5+
6+
import googleapiclient.discovery
7+
import googleapiclient.http # type: ignore
8+
9+
from .schemas import *
10+
11+
class AbusiveExperienceReportResource(googleapiclient.discovery.Resource):
12+
class SitesResource(googleapiclient.discovery.Resource):
13+
def get(
14+
self, *, name: str, **kwargs: typing.Any
15+
) -> SiteSummaryResponseHttpRequest: ...
16+
class ViolatingSitesResource(googleapiclient.discovery.Resource):
17+
def list(self, **kwargs: typing.Any) -> ViolatingSitesResponseHttpRequest: ...
18+
def sites(self) -> SitesResource: ...
19+
def violatingSites(self) -> ViolatingSitesResource: ...
20+
21+
class SiteSummaryResponseHttpRequest(googleapiclient.http.HttpRequest):
22+
def execute(
23+
self, http: typing.Optional[httplib2.Http] = ..., num_retries: int = ...
24+
) -> SiteSummaryResponse: ...
25+
26+
class ViolatingSitesResponseHttpRequest(googleapiclient.http.HttpRequest):
27+
def execute(
28+
self, http: typing.Optional[httplib2.Http] = ..., num_retries: int = ...
29+
) -> ViolatingSitesResponse: ...

0 commit comments

Comments
 (0)