diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 16:40:54 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 16:40:54 +0000 |
| commit | 12e37d485b07672d82c1df5b8756aaaa27a535d5 (patch) | |
| tree | 111392860ee91d92dcab930309c4863584b56c86 | |
| parent | 8c3f6112f5dcd38917c841956083b08c226731f4 (diff) | |
automatic import of python-google-api-python-client-stubs
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-google-api-python-client-stubs.spec | 230 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 232 insertions, 0 deletions
@@ -0,0 +1 @@ +/google_api_python_client_stubs-1.16.0.tar.gz diff --git a/python-google-api-python-client-stubs.spec b/python-google-api-python-client-stubs.spec new file mode 100644 index 0000000..287b71c --- /dev/null +++ b/python-google-api-python-client-stubs.spec @@ -0,0 +1,230 @@ +%global _empty_manifest_terminate_build 0 +Name: python-google-api-python-client-stubs +Version: 1.16.0 +Release: 1 +Summary: Type stubs for google-api-python-client +License: Apache-2.0 +URL: https://github.com/henribru/google-api-python-client-stubs +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/4b/e1/022e79e79c311b5f1517ff8904e003385c19d24d11b218704cdad96c3f36/google_api_python_client_stubs-1.16.0.tar.gz +BuildArch: noarch + +Requires: python3-google-api-python-client +Requires: python3-typing-extensions + +%description +# Type stubs for google-api-python-client + +[](https://badge.fury.io/py/google-api-python-client-stubs) + +This package provides type stubs for the [google-api-python-client](https://github.com/googleapis/google-api-python-client) library. +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. + +**This is in no way affiliated with Google.** + +The stubs were generated automatically based on Google's [Discovery Documents](https://developers.google.com/discovery/v1/reference/apis), that are bundled with google-api-python-client as of v2. + +If you find incorrect annotations, please create an issue. + +## Installation + +```shell script +$ pip install google-api-python-client-stubs +``` + +## Caveats + +### Performance +The stubs contain a separate overload of `googleapiclient.discovery.build` for each service and version (see `discovery.pyi`). +This can lead to slow type inference for this function. Mypy will generally be pretty fast after the first run, +but you might experience slow autocomplete. If you're experiencing this problem you can bypass type inference with explicit annotations, +e.g. `sheets_service: SheetsResource = build("sheets", "v4")` instead of `sheets_service = build("sheets", "v4")`. +See the next section for some caveats to this approach. + +### Explicit annotations +The `google-api-python-client-stubs` is quite dynamic. +All resources are just instances of a single class with dynamically attached methods +and the requests and responses are just dictionaries. The way this is annotated is with +classes and [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict) +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. +If you rely solely on type inference, this is not an issue, but as soon as you want to explicitly +annotate a variable, argument or return type in your code with one of these types, you must follow these rules: +1. Either put `from __future__ import annotations` at the top of your file or surround the annotations with quotes. +This ensures that Python doesn't attempt to evaluate the types at runtime. +Note that the import is only supported in Python 3.7 and above. +2. Only import the types inside an `if typing.TYPE_CHECKING` block. This ensures that the imports are only evaluated during +type checking. Note that any type not available at runtime is located under the `googleapiclient._apis` package. +For example, `SheetsResource` should be imported from `googleapiclient._apis.sheets.v4.resources`. +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) +on the thing you want to explicitly annotate. For `TypedDict`s this will also give you useful info about the structure of the dictionary. + +### Recursive types +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. + +### Stubs for non-API-specific parts +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), +so they're mostly typed as `Any`. I believe these parts are mostly used internally by the library itself, +so for most users this should be fine. Contributions to improve these stubs are welcome, though. + + +%package -n python3-google-api-python-client-stubs +Summary: Type stubs for google-api-python-client +Provides: python-google-api-python-client-stubs +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-google-api-python-client-stubs +# Type stubs for google-api-python-client + +[](https://badge.fury.io/py/google-api-python-client-stubs) + +This package provides type stubs for the [google-api-python-client](https://github.com/googleapis/google-api-python-client) library. +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. + +**This is in no way affiliated with Google.** + +The stubs were generated automatically based on Google's [Discovery Documents](https://developers.google.com/discovery/v1/reference/apis), that are bundled with google-api-python-client as of v2. + +If you find incorrect annotations, please create an issue. + +## Installation + +```shell script +$ pip install google-api-python-client-stubs +``` + +## Caveats + +### Performance +The stubs contain a separate overload of `googleapiclient.discovery.build` for each service and version (see `discovery.pyi`). +This can lead to slow type inference for this function. Mypy will generally be pretty fast after the first run, +but you might experience slow autocomplete. If you're experiencing this problem you can bypass type inference with explicit annotations, +e.g. `sheets_service: SheetsResource = build("sheets", "v4")` instead of `sheets_service = build("sheets", "v4")`. +See the next section for some caveats to this approach. + +### Explicit annotations +The `google-api-python-client-stubs` is quite dynamic. +All resources are just instances of a single class with dynamically attached methods +and the requests and responses are just dictionaries. The way this is annotated is with +classes and [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict) +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. +If you rely solely on type inference, this is not an issue, but as soon as you want to explicitly +annotate a variable, argument or return type in your code with one of these types, you must follow these rules: +1. Either put `from __future__ import annotations` at the top of your file or surround the annotations with quotes. +This ensures that Python doesn't attempt to evaluate the types at runtime. +Note that the import is only supported in Python 3.7 and above. +2. Only import the types inside an `if typing.TYPE_CHECKING` block. This ensures that the imports are only evaluated during +type checking. Note that any type not available at runtime is located under the `googleapiclient._apis` package. +For example, `SheetsResource` should be imported from `googleapiclient._apis.sheets.v4.resources`. +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) +on the thing you want to explicitly annotate. For `TypedDict`s this will also give you useful info about the structure of the dictionary. + +### Recursive types +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. + +### Stubs for non-API-specific parts +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), +so they're mostly typed as `Any`. I believe these parts are mostly used internally by the library itself, +so for most users this should be fine. Contributions to improve these stubs are welcome, though. + + +%package help +Summary: Development documents and examples for google-api-python-client-stubs +Provides: python3-google-api-python-client-stubs-doc +%description help +# Type stubs for google-api-python-client + +[](https://badge.fury.io/py/google-api-python-client-stubs) + +This package provides type stubs for the [google-api-python-client](https://github.com/googleapis/google-api-python-client) library. +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. + +**This is in no way affiliated with Google.** + +The stubs were generated automatically based on Google's [Discovery Documents](https://developers.google.com/discovery/v1/reference/apis), that are bundled with google-api-python-client as of v2. + +If you find incorrect annotations, please create an issue. + +## Installation + +```shell script +$ pip install google-api-python-client-stubs +``` + +## Caveats + +### Performance +The stubs contain a separate overload of `googleapiclient.discovery.build` for each service and version (see `discovery.pyi`). +This can lead to slow type inference for this function. Mypy will generally be pretty fast after the first run, +but you might experience slow autocomplete. If you're experiencing this problem you can bypass type inference with explicit annotations, +e.g. `sheets_service: SheetsResource = build("sheets", "v4")` instead of `sheets_service = build("sheets", "v4")`. +See the next section for some caveats to this approach. + +### Explicit annotations +The `google-api-python-client-stubs` is quite dynamic. +All resources are just instances of a single class with dynamically attached methods +and the requests and responses are just dictionaries. The way this is annotated is with +classes and [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict) +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. +If you rely solely on type inference, this is not an issue, but as soon as you want to explicitly +annotate a variable, argument or return type in your code with one of these types, you must follow these rules: +1. Either put `from __future__ import annotations` at the top of your file or surround the annotations with quotes. +This ensures that Python doesn't attempt to evaluate the types at runtime. +Note that the import is only supported in Python 3.7 and above. +2. Only import the types inside an `if typing.TYPE_CHECKING` block. This ensures that the imports are only evaluated during +type checking. Note that any type not available at runtime is located under the `googleapiclient._apis` package. +For example, `SheetsResource` should be imported from `googleapiclient._apis.sheets.v4.resources`. +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) +on the thing you want to explicitly annotate. For `TypedDict`s this will also give you useful info about the structure of the dictionary. + +### Recursive types +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. + +### Stubs for non-API-specific parts +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), +so they're mostly typed as `Any`. I believe these parts are mostly used internally by the library itself, +so for most users this should be fine. Contributions to improve these stubs are welcome, though. + + +%prep +%autosetup -n google-api-python-client-stubs-1.16.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-google-api-python-client-stubs -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.16.0-1 +- Package Spec generated @@ -0,0 +1 @@ +27ba42faa6265d4c3b161fa28d66dd75 google_api_python_client_stubs-1.16.0.tar.gz |
