Skip to content

Commit a9d8ae8

Browse files
authored
docs: update intersphinx links (#404)
1 parent 34b9948 commit a9d8ae8

File tree

13 files changed

+170
-136
lines changed

13 files changed

+170
-136
lines changed

.kokoro/docs/common.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ env_vars: {
3030

3131
env_vars: {
3232
key: "V2_STAGING_BUCKET"
33-
value: "docs-staging-v2-staging"
33+
value: "docs-staging-v2"
3434
}
3535

3636
# It will upload the docker image after successful builds.

.kokoro/samples/python3.6/common.cfg

+6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ env_vars: {
1313
value: "py-3.6"
1414
}
1515

16+
# Declare build specific Cloud project.
17+
env_vars: {
18+
key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19+
value: "python-docs-samples-tests-py36"
20+
}
21+
1622
env_vars: {
1723
key: "TRAMPOLINE_BUILD_FILE"
1824
value: "github/python-bigquery/.kokoro/test-samples.sh"

.kokoro/samples/python3.7/common.cfg

+6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ env_vars: {
1313
value: "py-3.7"
1414
}
1515

16+
# Declare build specific Cloud project.
17+
env_vars: {
18+
key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19+
value: "python-docs-samples-tests-py37"
20+
}
21+
1622
env_vars: {
1723
key: "TRAMPOLINE_BUILD_FILE"
1824
value: "github/python-bigquery/.kokoro/test-samples.sh"

.kokoro/samples/python3.8/common.cfg

+6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ env_vars: {
1313
value: "py-3.8"
1414
}
1515

16+
# Declare build specific Cloud project.
17+
env_vars: {
18+
key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19+
value: "python-docs-samples-tests-py38"
20+
}
21+
1622
env_vars: {
1723
key: "TRAMPOLINE_BUILD_FILE"
1824
value: "github/python-bigquery/.kokoro/test-samples.sh"

.kokoro/test-samples.sh

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
2828
git checkout $LATEST_RELEASE
2929
fi
3030

31+
# Exit early if samples directory doesn't exist
32+
if [ ! -d "./samples" ]; then
33+
echo "No tests run. `./samples` not found"
34+
exit 0
35+
fi
36+
3137
# Disable buffering, so that the logs stream through.
3238
export PYTHONUNBUFFERED=1
3339

@@ -101,4 +107,4 @@ cd "$ROOT"
101107
# Workaround for Kokoro permissions issue: delete secrets
102108
rm testing/{test-env.sh,client-secrets.json,service-account.json}
103109

104-
exit "$RTN"
110+
exit "$RTN"

CODE_OF_CONDUCT.md

+87-36
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,95 @@
11
<!-- # Generated by synthtool. DO NOT EDIT! !-->
2-
# Contributor Code of Conduct
2+
# Code of Conduct
33

4-
As contributors and maintainers of this project,
5-
and in the interest of fostering an open and welcoming community,
6-
we pledge to respect all people who contribute through reporting issues,
7-
posting feature requests, updating documentation,
8-
submitting pull requests or patches, and other activities.
4+
## Our Pledge
95

10-
We are committed to making participation in this project
11-
a harassment-free experience for everyone,
12-
regardless of level of experience, gender, gender identity and expression,
13-
sexual orientation, disability, personal appearance,
14-
body size, race, ethnicity, age, religion, or nationality.
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to making participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, gender identity and expression, level of
10+
experience, education, socio-economic status, nationality, personal appearance,
11+
race, religion, or sexual identity and orientation.
12+
13+
## Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
1523

1624
Examples of unacceptable behavior by participants include:
1725

18-
* The use of sexualized language or imagery
19-
* Personal attacks
20-
* Trolling or insulting/derogatory comments
21-
* Public or private harassment
22-
* Publishing other's private information,
23-
such as physical or electronic
24-
addresses, without explicit permission
25-
* Other unethical or unprofessional conduct.
26+
* The use of sexualized language or imagery and unwelcome sexual attention or
27+
advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
2640

2741
Project maintainers have the right and responsibility to remove, edit, or reject
28-
comments, commits, code, wiki edits, issues, and other contributions
29-
that are not aligned to this Code of Conduct.
30-
By adopting this Code of Conduct,
31-
project maintainers commit themselves to fairly and consistently
32-
applying these principles to every aspect of managing this project.
33-
Project maintainers who do not follow or enforce the Code of Conduct
34-
may be permanently removed from the project team.
35-
36-
This code of conduct applies both within project spaces and in public spaces
37-
when an individual is representing the project or its community.
38-
39-
Instances of abusive, harassing, or otherwise unacceptable behavior
40-
may be reported by opening an issue
41-
or contacting one or more of the project maintainers.
42-
43-
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
44-
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
This Code of Conduct also applies outside the project spaces when the Project
57+
Steward has a reasonable belief that an individual's behavior may have a
58+
negative impact on the project or its community.
59+
60+
## Conflict Resolution
61+
62+
We do not believe that all conflict is bad; healthy debate and disagreement
63+
often yield positive results. However, it is never okay to be disrespectful or
64+
to engage in behavior that violates the project’s code of conduct.
65+
66+
If you see someone violating the code of conduct, you are encouraged to address
67+
the behavior directly with those involved. Many issues can be resolved quickly
68+
and easily, and this gives people more control over the outcome of their
69+
dispute. If you are unable to resolve the matter for any reason, or if the
70+
behavior is threatening or harassing, report it. We are dedicated to providing
71+
an environment where participants feel welcome and safe.
72+
73+
74+
Reports should be directed to *[email protected]*, the
75+
Project Steward(s) for *Google Cloud Client Libraries*. It is the Project Steward’s duty to
76+
receive and address reported violations of the code of conduct. They will then
77+
work with a committee consisting of representatives from the Open Source
78+
Programs Office and the Google Open Source Strategy team. If for any reason you
79+
are uncomfortable reaching out to the Project Steward, please email
80+
81+
82+
We will investigate every complaint, but you may not receive a direct response.
83+
We will use our discretion in determining when and how to follow up on reported
84+
incidents, which may range from not taking action to permanent expulsion from
85+
the project and project-sponsored spaces. We will notify the accused of the
86+
report and provide them an opportunity to discuss it before any action is taken.
87+
The identity of the reporter will be omitted from the details of the report
88+
supplied to the accused. In potentially harmful situations, such as ongoing
89+
harassment or threats to anyone's safety, we may take action without notice.
90+
91+
## Attribution
92+
93+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
94+
available at
95+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

docs/bigquery_v2/types.rst

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ Types for Google Cloud Bigquery v2 API
33

44
.. automodule:: google.cloud.bigquery_v2.types
55
:members:
6+
:show-inheritance:

docs/conf.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -346,10 +346,11 @@
346346

347347
# Example configuration for intersphinx: refer to the Python standard library.
348348
intersphinx_mapping = {
349-
"python": ("http://python.readthedocs.org/en/latest/", None),
350-
"google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
349+
"python": ("https://python.readthedocs.org/en/latest/", None),
350+
"google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),
351351
"google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,),
352-
"grpc": ("https://grpc.io/grpc/python/", None),
352+
"grpc": ("https://grpc.github.io/grpc/python/", None),
353+
"proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),
353354
}
354355

355356

google/cloud/bigquery_v2/types/model.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1495,7 +1495,7 @@ class PatchModelRequest(proto.Message):
14951495

14961496
model_id = proto.Field(proto.STRING, number=3)
14971497

1498-
model = proto.Field(proto.MESSAGE, number=4, message=Model,)
1498+
model = proto.Field(proto.MESSAGE, number=4, message="Model",)
14991499

15001500

15011501
class DeleteModelRequest(proto.Message):
@@ -1559,7 +1559,7 @@ class ListModelsResponse(proto.Message):
15591559
def raw_page(self):
15601560
return self
15611561

1562-
models = proto.RepeatedField(proto.MESSAGE, number=1, message=Model,)
1562+
models = proto.RepeatedField(proto.MESSAGE, number=1, message="Model",)
15631563

15641564
next_page_token = proto.Field(proto.STRING, number=2)
15651565

google/cloud/bigquery_v2/types/standard_sql.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class StandardSqlField(proto.Message):
9090

9191
name = proto.Field(proto.STRING, number=1)
9292

93-
type = proto.Field(proto.MESSAGE, number=2, message=StandardSqlDataType,)
93+
type = proto.Field(proto.MESSAGE, number=2, message="StandardSqlDataType",)
9494

9595

9696
class StandardSqlStructType(proto.Message):
@@ -101,7 +101,7 @@ class StandardSqlStructType(proto.Message):
101101
102102
"""
103103

104-
fields = proto.RepeatedField(proto.MESSAGE, number=1, message=StandardSqlField,)
104+
fields = proto.RepeatedField(proto.MESSAGE, number=1, message="StandardSqlField",)
105105

106106

107107
__all__ = tuple(sorted(__protobuf__.manifest))

samples/snippets/noxfile.py

+25-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
TEST_CONFIG = {
3939
# You can opt out from the test for specific Python versions.
4040
"ignored_versions": ["2.7"],
41+
# Old samples are opted out of enforcing Python type hints
42+
# All new samples should feature them
43+
"enforce_type_hints": False,
4144
# An envvar key for determining the project id to use. Change it
4245
# to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
4346
# build specific Cloud project. You can also use your own string
@@ -130,7 +133,10 @@ def _determine_local_import_names(start_dir):
130133

131134
@nox.session
132135
def lint(session):
133-
session.install("flake8", "flake8-import-order")
136+
if not TEST_CONFIG["enforce_type_hints"]:
137+
session.install("flake8", "flake8-import-order")
138+
else:
139+
session.install("flake8", "flake8-import-order", "flake8-annotations")
134140

135141
local_names = _determine_local_import_names(".")
136142
args = FLAKE8_COMMON_ARGS + [
@@ -141,6 +147,19 @@ def lint(session):
141147
session.run("flake8", *args)
142148

143149

150+
#
151+
# Black
152+
#
153+
154+
155+
@nox.session
156+
def blacken(session):
157+
session.install("black")
158+
python_files = [path for path in os.listdir(".") if path.endswith(".py")]
159+
160+
session.run("black", *python_files)
161+
162+
144163
#
145164
# Sample Tests
146165
#
@@ -199,6 +218,11 @@ def _get_repo_root():
199218
break
200219
if Path(p / ".git").exists():
201220
return str(p)
221+
# .git is not available in repos cloned via Cloud Build
222+
# setup.py is always in the library's root, so use that instead
223+
# https://github.com/googleapis/synthtool/issues/792
224+
if Path(p / "setup.py").exists():
225+
return str(p)
202226
p = p.parent
203227
raise Exception("Unable to detect repository root.")
204228

0 commit comments

Comments
 (0)