Skip to content

Commit 8c0d03f

Browse files
yoshi-automationyoshi-automation
authored
docs: update intersphinx links (#78)
* changes without context autosynth cannot find the source of changes triggered by earlier changes in this repository, or by version upgrades to tools such as linters. * docs(python): update intersphinx for grpc and auth * docs(python): update intersphinx for grpc and auth * use https for python intersphinx Co-authored-by: Tim Swast <swast@google.com> Source-Author: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Source-Date: Wed Nov 18 14:37:25 2020 -0700 Source-Repo: googleapis/synthtool Source-Sha: 9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9 Source-Link: googleapis/synthtool@9a7d9fb * docs(python): fix intersphinx link for google-auth Source-Author: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Source-Date: Thu Nov 19 10:16:05 2020 -0700 Source-Repo: googleapis/synthtool Source-Sha: a073c873f3928c561bdf87fdfbf1d081d1998984 Source-Link: googleapis/synthtool@a073c87 * chore: add config / docs for 'pre-commit' support Source-Author: Tres Seaver <tseaver@palladion.com> Source-Date: Tue Dec 1 16:01:20 2020 -0500 Source-Repo: googleapis/synthtool Source-Sha: 32af6da519a6b042e3da62008e2a75e991efb6b4 Source-Link: googleapis/synthtool@32af6da * chore(deps): update precommit hook pre-commit/pre-commit-hooks to v3.3.0 Source-Author: WhiteSource Renovate <bot@renovateapp.com> Source-Date: Wed Dec 2 17:18:24 2020 +0100 Source-Repo: googleapis/synthtool Source-Sha: 69629b64b83c6421d616be2b8e11795738ec8a6c Source-Link: googleapis/synthtool@69629b6 * test(python): give filesystem paths to pytest-cov https://pytest-cov.readthedocs.io/en/latest/config.html The pytest-cov docs seem to suggest a filesystem path is expected. Source-Author: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Source-Date: Wed Dec 2 09:28:04 2020 -0700 Source-Repo: googleapis/synthtool Source-Sha: f94318521f63085b9ccb43d42af89f153fb39f15 Source-Link: googleapis/synthtool@f943185 * chore: update noxfile.py.j2 * Update noxfile.py.j2 add changes from @glasnt to the template template to ensure that enforcing type hinting doesn't fail for repos with the sample noxfile (aka all samples repos) See https://github.com/GoogleCloudPlatform/python-docs-samples/pull/4869/files for context * fix typo Source-Author: Leah E. Cole <6719667+leahecole@users.noreply.github.com> Source-Date: Thu Dec 3 13:44:30 2020 -0800 Source-Repo: googleapis/synthtool Source-Sha: 18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1 Source-Link: googleapis/synthtool@18c5dbd
1 parent f06019c commit 8c0d03f

7 files changed

Lines changed: 53 additions & 24 deletions

File tree

‎packages/google-cloud-bigquery-datatransfer/.pre-commit-config.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v3.3.0
6+
hooks:
7+
- id: trailing-whitespace
8+
- id: end-of-file-fixer
9+
- id: check-yaml
10+
- repo: https://github.com/psf/black
11+
rev: 19.10b0
12+
hooks:
13+
- id: black
14+
- repo: https://gitlab.com/pycqa/flake8
15+
rev: 3.8.4
16+
hooks:
17+
- id: flake8

‎packages/google-cloud-bigquery-datatransfer/CONTRIBUTING.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,16 @@ Coding Style
111111
should point to the official ``googleapis`` checkout and the
112112
the branch should be the main branch on that remote (``master``).
113113

114+
- This repository contains configuration for the
115+
`pre-commit <https://pre-commit.com/>`__ tool, which automates checking
116+
our linters during a commit. If you have it installed on your ``$PATH``,
117+
you can enable enforcing those checks via:
118+
119+
.. code-block:: bash
120+
121+
$ pre-commit install
122+
pre-commit installed at .git/hooks/pre-commit
123+
114124
Exceptions to PEP8:
115125

116126
- Many unit tests use a helper method, ``_call_fut`` ("FUT" is short for

‎packages/google-cloud-bigquery-datatransfer/docs/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,10 @@
345345

346346
# Example configuration for intersphinx: refer to the Python standard library.
347347
intersphinx_mapping = {
348-
"python": ("http://python.readthedocs.org/en/latest/", None),
349-
"google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
348+
"python": ("https://python.readthedocs.org/en/latest/", None),
349+
"google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),
350350
"google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,),
351-
"grpc": ("https://grpc.io/grpc/python/", None),
351+
"grpc": ("https://grpc.github.io/grpc/python/", None),
352352
"proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),
353353
}
354354

‎packages/google-cloud-bigquery-datatransfer/noxfile.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,8 @@ def default(session):
8181
session.run(
8282
"py.test",
8383
"--quiet",
84-
"--cov=google.cloud.bigquerydatatransfer",
85-
"--cov=google.cloud",
86-
"--cov=tests.unit",
84+
"--cov=google/cloud",
85+
"--cov=tests/unit",
8786
"--cov-append",
8887
"--cov-config=.coveragerc",
8988
"--cov-report=",

‎packages/google-cloud-bigquery-datatransfer/samples/noxfile.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import os
1818
from pathlib import Path
1919
import sys
20+
from typing import Callable, Dict, List, Optional
2021

2122
import nox
2223

@@ -68,7 +69,7 @@
6869
TEST_CONFIG.update(TEST_CONFIG_OVERRIDE)
6970

7071

71-
def get_pytest_env_vars():
72+
def get_pytest_env_vars() -> Dict[str, str]:
7273
"""Returns a dict for pytest invocation."""
7374
ret = {}
7475

@@ -97,7 +98,7 @@ def get_pytest_env_vars():
9798
#
9899

99100

100-
def _determine_local_import_names(start_dir):
101+
def _determine_local_import_names(start_dir: str) -> List[str]:
101102
"""Determines all import names that should be considered "local".
102103
103104
This is used when running the linter to insure that import order is
@@ -135,7 +136,7 @@ def _determine_local_import_names(start_dir):
135136

136137

137138
@nox.session
138-
def lint(session):
139+
def lint(session: nox.sessions.Session) -> None:
139140
if not TEST_CONFIG['enforce_type_hints']:
140141
session.install("flake8", "flake8-import-order")
141142
else:
@@ -154,7 +155,7 @@ def lint(session):
154155

155156

156157
@nox.session
157-
def blacken(session):
158+
def blacken(session: nox.sessions.Session) -> None:
158159
session.install("black")
159160
python_files = [path for path in os.listdir(".") if path.endswith(".py")]
160161

@@ -168,7 +169,7 @@ def blacken(session):
168169
PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"]
169170

170171

171-
def _session_tests(session, post_install=None):
172+
def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
172173
"""Runs py.test for a particular project."""
173174
if os.path.exists("requirements.txt"):
174175
session.install("-r", "requirements.txt")
@@ -194,7 +195,7 @@ def _session_tests(session, post_install=None):
194195

195196

196197
@nox.session(python=ALL_VERSIONS)
197-
def py(session):
198+
def py(session: nox.sessions.Session) -> None:
198199
"""Runs py.test for a sample using the specified version of Python."""
199200
if session.python in TESTED_VERSIONS:
200201
_session_tests(session)
@@ -209,7 +210,7 @@ def py(session):
209210
#
210211

211212

212-
def _get_repo_root():
213+
def _get_repo_root() -> Optional[str]:
213214
""" Returns the root folder of the project. """
214215
# Get root of this repository. Assume we don't have directories nested deeper than 10 items.
215216
p = Path(os.getcwd())
@@ -232,7 +233,7 @@ def _get_repo_root():
232233

233234
@nox.session
234235
@nox.parametrize("path", GENERATED_READMES)
235-
def readmegen(session, path):
236+
def readmegen(session: nox.sessions.Session, path: str) -> None:
236237
"""(Re-)generates the readme for a sample."""
237238
session.install("jinja2", "pyyaml")
238239
dir_ = os.path.dirname(path)

‎packages/google-cloud-bigquery-datatransfer/samples/snippets/noxfile.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import os
1818
from pathlib import Path
1919
import sys
20+
from typing import Callable, Dict, List, Optional
2021

2122
import nox
2223

@@ -68,7 +69,7 @@
6869
TEST_CONFIG.update(TEST_CONFIG_OVERRIDE)
6970

7071

71-
def get_pytest_env_vars():
72+
def get_pytest_env_vars() -> Dict[str, str]:
7273
"""Returns a dict for pytest invocation."""
7374
ret = {}
7475

@@ -97,7 +98,7 @@ def get_pytest_env_vars():
9798
#
9899

99100

100-
def _determine_local_import_names(start_dir):
101+
def _determine_local_import_names(start_dir: str) -> List[str]:
101102
"""Determines all import names that should be considered "local".
102103
103104
This is used when running the linter to insure that import order is
@@ -135,7 +136,7 @@ def _determine_local_import_names(start_dir):
135136

136137

137138
@nox.session
138-
def lint(session):
139+
def lint(session: nox.sessions.Session) -> None:
139140
if not TEST_CONFIG['enforce_type_hints']:
140141
session.install("flake8", "flake8-import-order")
141142
else:
@@ -154,7 +155,7 @@ def lint(session):
154155

155156

156157
@nox.session
157-
def blacken(session):
158+
def blacken(session: nox.sessions.Session) -> None:
158159
session.install("black")
159160
python_files = [path for path in os.listdir(".") if path.endswith(".py")]
160161

@@ -168,7 +169,7 @@ def blacken(session):
168169
PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"]
169170

170171

171-
def _session_tests(session, post_install=None):
172+
def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
172173
"""Runs py.test for a particular project."""
173174
if os.path.exists("requirements.txt"):
174175
session.install("-r", "requirements.txt")
@@ -194,7 +195,7 @@ def _session_tests(session, post_install=None):
194195

195196

196197
@nox.session(python=ALL_VERSIONS)
197-
def py(session):
198+
def py(session: nox.sessions.Session) -> None:
198199
"""Runs py.test for a sample using the specified version of Python."""
199200
if session.python in TESTED_VERSIONS:
200201
_session_tests(session)
@@ -209,7 +210,7 @@ def py(session):
209210
#
210211

211212

212-
def _get_repo_root():
213+
def _get_repo_root() -> Optional[str]:
213214
""" Returns the root folder of the project. """
214215
# Get root of this repository. Assume we don't have directories nested deeper than 10 items.
215216
p = Path(os.getcwd())
@@ -232,7 +233,7 @@ def _get_repo_root():
232233

233234
@nox.session
234235
@nox.parametrize("path", GENERATED_READMES)
235-
def readmegen(session, path):
236+
def readmegen(session: nox.sessions.Session, path: str) -> None:
236237
"""(Re-)generates the readme for a sample."""
237238
session.install("jinja2", "pyyaml")
238239
dir_ = os.path.dirname(path)

‎packages/google-cloud-bigquery-datatransfer/synth.metadata‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
"git": {
2020
"name": "synthtool",
2121
"remote": "https://github.com/googleapis/synthtool.git",
22-
"sha": "e89175cf074dccc4babb4eca66ae913696e47a71"
22+
"sha": "18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1"
2323
}
2424
},
2525
{
2626
"git": {
2727
"name": "synthtool",
2828
"remote": "https://github.com/googleapis/synthtool.git",
29-
"sha": "e89175cf074dccc4babb4eca66ae913696e47a71"
29+
"sha": "18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1"
3030
}
3131
}
3232
],
@@ -85,6 +85,7 @@
8585
".kokoro/test-samples.sh",
8686
".kokoro/trampoline.sh",
8787
".kokoro/trampoline_v2.sh",
88+
".pre-commit-config.yaml",
8889
".trampolinerc",
8990
"CODE_OF_CONDUCT.md",
9091
"CONTRIBUTING.rst",

0 commit comments

Comments
 (0)