Skip to content

Commit 7f36c2d

Browse files
committed
chore: run librarian generate
1 parent 24d095a commit 7f36c2d

146 files changed

Lines changed: 13832 additions & 398 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.
Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,13 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2024 Google LLC
4-
#
5-
# Licensed under the Apache License, Version 2.0 (the "License");
6-
# you may not use this file except in compliance with the License.
7-
# You may obtain a copy of the License at
8-
#
9-
# https://www.apache.org/licenses/LICENSE-2.0
10-
#
11-
# Unless required by applicable law or agreed to in writing, software
12-
# distributed under the License is distributed on an "AS IS" BASIS,
13-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
# See the License for the specific language governing permissions and
15-
# limitations under the License.
16-
17-
# Generated by synthtool. DO NOT EDIT!
181
[run]
192
branch = True
20-
omit =
21-
google/__init__.py
22-
google/cloud/__init__.py
233

244
[report]
25-
fail_under = 100
265
show_missing = True
6+
omit =
7+
google/cloud/firestore_admin/__init__.py
8+
google/cloud/firestore_admin/gapic_version.py
279
exclude_lines =
2810
# Re-enable the standard pragma
2911
pragma: NO COVER
3012
# Ignore debug-only repr
3113
def __repr__
32-
# Ignore abstract methods
33-
raise NotImplementedError
34-
omit =
35-
*/gapic/*.py
36-
*/proto/*.py
37-
*/core/*.py
38-
*/site-packages/*.py
39-
google/cloud/__init__.py

packages/google-cloud-firestore/.flake8

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
11
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2024 Google LLC
2+
# Copyright 2025 Google LLC
43
#
54
# Licensed under the Apache License, Version 2.0 (the "License");
65
# you may not use this file except in compliance with the License.
76
# You may obtain a copy of the License at
87
#
9-
# https://www.apache.org/licenses/LICENSE-2.0
8+
# http://www.apache.org/licenses/LICENSE-2.0
109
#
1110
# Unless required by applicable law or agreed to in writing, software
1211
# distributed under the License is distributed on an "AS IS" BASIS,
1312
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1413
# See the License for the specific language governing permissions and
1514
# limitations under the License.
16-
17-
# Generated by synthtool. DO NOT EDIT!
15+
#
1816
[flake8]
17+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333):
18+
# Resolve flake8 lint issues
1919
ignore = E203, E231, E266, E501, W503
2020
exclude =
21-
# Exclude generated code.
22-
**/proto/**
21+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333):
22+
# Ensure that generated code passes flake8 lint
2323
**/gapic/**
2424
**/services/**
2525
**/types/**
26+
# Exclude Protobuf gencode
2627
*_pb2.py
2728

2829
# Standard linting exemptions.

packages/google-cloud-firestore/.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "firestore",
3-
"name_pretty": "Cloud Firestore",
3+
"name_pretty": "Cloud Firestore API",
44
"product_documentation": "https://cloud.google.com/firestore",
55
"client_documentation": "https://cloud.google.com/python/docs/reference/firestore/latest",
66
"issue_tracker": "https://issuetracker.google.com/savedsearches/5337669",
Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2024 Google LLC
2+
# Copyright 2025 Google LLC
43
#
54
# Licensed under the Apache License, Version 2.0 (the "License");
65
# you may not use this file except in compliance with the License.
76
# You may obtain a copy of the License at
87
#
9-
# https://www.apache.org/licenses/LICENSE-2.0
8+
# http://www.apache.org/licenses/LICENSE-2.0
109
#
1110
# Unless required by applicable law or agreed to in writing, software
1211
# distributed under the License is distributed on an "AS IS" BASIS,
1312
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1413
# See the License for the specific language governing permissions and
1514
# limitations under the License.
16-
17-
# Generated by synthtool. DO NOT EDIT!
15+
#
1816
include README.rst LICENSE
19-
recursive-include google *.json *.proto py.typed
17+
recursive-include google *.py *.pyi *.json *.proto py.typed
2018
recursive-include tests *
2119
global-exclude *.py[co]
2220
global-exclude __pycache__
23-
24-
# Exclude scripts for samples readmegen
25-
prune scripts/readme-gen

packages/google-cloud-firestore/docs/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Code samples and snippets
5353

5454
Code samples and snippets live in the `samples/`_ folder.
5555

56-
.. _samples/: https://github.com/googleapis/google-cloud-python/packages/google-cloud-firestore/samples
56+
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-firestore/samples
5757

5858

5959
Supported Python Versions

packages/google-cloud-firestore/docs/_templates/layout.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
{% endblock %}
2121

2222
<div class="body" role="main">
23-
<div class="admonition" id="python2-eol">
24-
As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
23+
<div class="admonition" id="python2-eol">
24+
As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
2525
Library versions released prior to that date will continue to be available. For more information please
2626
visit <a href="https://cloud.google.com/python/docs/python2-sunset/">Python 2 support on Google Cloud</a>.
2727
</div>

packages/google-cloud-firestore/docs/conf.py

Lines changed: 58 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# -*- coding: utf-8 -*-
2-
# Copyright 2024 Google LLC
2+
# Copyright 2025 Google LLC
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
66
# You may obtain a copy of the License at
77
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
8+
# http://www.apache.org/licenses/LICENSE-2.0
99
#
1010
# Unless required by applicable law or agreed to in writing, software
1111
# distributed under the License is distributed on an "AS IS" BASIS,
1212
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
15-
#
16-
# google-cloud-firestore documentation build configuration file
15+
##
16+
# google-cloud-firestore-admin documentation build configuration file
1717
#
1818
# This file is execfile()d with the current directory set to its
1919
# containing dir.
@@ -24,9 +24,11 @@
2424
# All configuration values have a default; values that are commented out
2525
# serve to show the default.
2626

27+
import logging
2728
import os
2829
import shlex
2930
import sys
31+
from typing import Any
3032

3133
# If extensions (or modules to document with autodoc) are in another directory,
3234
# add these directories to sys.path here. If the directory is relative to the
@@ -42,7 +44,7 @@
4244
# -- General configuration ------------------------------------------------
4345

4446
# If your documentation needs a minimal Sphinx version, state it here.
45-
needs_sphinx = "1.5.5"
47+
needs_sphinx = "4.5.0"
4648

4749
# Add any Sphinx extension module names here, as strings. They can be
4850
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -80,8 +82,8 @@
8082
root_doc = "index"
8183

8284
# General information about the project.
83-
project = "google-cloud-firestore"
84-
copyright = "2019, Google"
85+
project = "google-cloud-firestore-admin"
86+
copyright = "2025, Google, LLC"
8587
author = "Google APIs"
8688

8789
# The version info for the project you're documenting, acts as replacement for
@@ -109,6 +111,10 @@
109111
# List of patterns, relative to source directory, that match files and
110112
# directories to ignore when looking for source files.
111113
exclude_patterns = [
114+
"**/firestore.rst",
115+
"**/firestore_admin.rst",
116+
"**/services_.rst",
117+
"**/types_.rst",
112118
"_build",
113119
"**/.nox/**/*",
114120
"samples/AUTHORING_GUIDE.md",
@@ -154,7 +160,7 @@
154160
# further. For a list of options available for each theme, see the
155161
# documentation.
156162
html_theme_options = {
157-
"description": "Google Cloud Client Libraries for google-cloud-firestore",
163+
"description": "Google Cloud Client Libraries for google-cloud-firestore-admin",
158164
"github_user": "googleapis",
159165
"github_repo": "google-cloud-python",
160166
"github_banner": True,
@@ -248,7 +254,7 @@
248254
# html_search_scorer = 'scorer.js'
249255

250256
# Output file base name for HTML help builder.
251-
htmlhelp_basename = "google-cloud-firestore-doc"
257+
htmlhelp_basename = "google-cloud-firestore-admin-doc"
252258

253259
# -- Options for warnings ------------------------------------------------------
254260

@@ -266,13 +272,13 @@
266272

267273
latex_elements = {
268274
# The paper size ('letterpaper' or 'a4paper').
269-
#'papersize': 'letterpaper',
275+
# 'papersize': 'letterpaper',
270276
# The font size ('10pt', '11pt' or '12pt').
271-
#'pointsize': '10pt',
277+
# 'pointsize': '10pt',
272278
# Additional stuff for the LaTeX preamble.
273-
#'preamble': '',
279+
# 'preamble': '',
274280
# Latex figure (float) alignment
275-
#'figure_align': 'htbp',
281+
# 'figure_align': 'htbp',
276282
}
277283

278284
# Grouping the document tree into LaTeX files. List of tuples
@@ -281,8 +287,8 @@
281287
latex_documents = [
282288
(
283289
root_doc,
284-
"google-cloud-firestore.tex",
285-
"google-cloud-firestore Documentation",
290+
"google-cloud-firestore-admin.tex",
291+
"google-cloud-firestore-admin Documentation",
286292
author,
287293
"manual",
288294
)
@@ -316,8 +322,8 @@
316322
man_pages = [
317323
(
318324
root_doc,
319-
"google-cloud-firestore",
320-
"google-cloud-firestore Documentation",
325+
"google-cloud-firestore-admin",
326+
"google-cloud-firestore-admin Documentation",
321327
[author],
322328
1,
323329
)
@@ -335,11 +341,11 @@
335341
texinfo_documents = [
336342
(
337343
root_doc,
338-
"google-cloud-firestore",
339-
"google-cloud-firestore Documentation",
344+
"google-cloud-firestore-admin",
345+
"google-cloud-firestore-admin Documentation",
340346
author,
341-
"google-cloud-firestore",
342-
"google-cloud-firestore Library",
347+
"google-cloud-firestore-admin",
348+
"google-cloud-firestore-admin Library",
343349
"APIs",
344350
)
345351
]
@@ -382,3 +388,34 @@
382388
napoleon_use_ivar = False
383389
napoleon_use_param = True
384390
napoleon_use_rtype = True
391+
392+
393+
# Setup for sphinx behaviors such as warning filters.
394+
class UnexpectedUnindentFilter(logging.Filter):
395+
"""Filter out warnings about unexpected unindentation following bullet lists."""
396+
397+
def filter(self, record: logging.LogRecord) -> bool:
398+
"""Filter the log record.
399+
400+
Args:
401+
record (logging.LogRecord): The log record.
402+
403+
Returns:
404+
bool: False to suppress the warning, True to allow it.
405+
"""
406+
msg = record.getMessage()
407+
if "Bullet list ends without a blank line" in msg:
408+
return False
409+
return True
410+
411+
412+
def setup(app: Any) -> None:
413+
"""Setup the Sphinx application.
414+
415+
Args:
416+
app (Any): The Sphinx application.
417+
"""
418+
# Sphinx's logger is hierarchical. Adding a filter to the
419+
# root 'sphinx' logger will catch warnings from all sub-loggers.
420+
logger = logging.getLogger("sphinx")
421+
logger.addFilter(UnexpectedUnindentFilter())
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
FirestoreAdmin
2+
--------------------------------
3+
4+
.. automodule:: google.cloud.firestore_admin_v1.services.firestore_admin
5+
:members:
6+
:inherited-members:
7+
8+
.. automodule:: google.cloud.firestore_admin_v1.services.firestore_admin.pagers
9+
:members:
10+
:inherited-members:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Services for Google Cloud Firestore Admin v1 API
2+
================================================
3+
.. toctree::
4+
:maxdepth: 2
5+
6+
firestore_admin
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Types for Google Cloud Firestore Admin v1 API
2+
=============================================
3+
4+
.. automodule:: google.cloud.firestore_admin_v1.types
5+
:members:
6+
:show-inheritance:

0 commit comments

Comments
 (0)