Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/google/cloud/firestore_v1/__init__.py: 100%

1# -*- coding: utf-8 -*- 

2 

3# Copyright 2019 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# http://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 

18 

19"""Python idiomatic client for Google Cloud Firestore.""" 

20 

21 

22from google.cloud.firestore_v1 import gapic_version as package_version 

23 

24__version__ = package_version.__version__ 

25 

26from google.cloud.firestore_v1 import types 

27from google.cloud.firestore_v1._helpers import GeoPoint 

28from google.cloud.firestore_v1._helpers import ExistsOption 

29from google.cloud.firestore_v1._helpers import LastUpdateOption 

30from google.cloud.firestore_v1._helpers import ReadAfterWriteError 

31from google.cloud.firestore_v1._helpers import WriteOption 

32from google.cloud.firestore_v1.base_aggregation import CountAggregation 

33from google.cloud.firestore_v1.base_query import And 

34from google.cloud.firestore_v1.base_query import FieldFilter 

35from google.cloud.firestore_v1.base_query import Or 

36from google.cloud.firestore_v1.async_batch import AsyncWriteBatch 

37from google.cloud.firestore_v1.async_client import AsyncClient 

38from google.cloud.firestore_v1.async_collection import AsyncCollectionReference 

39from google.cloud.firestore_v1.async_document import AsyncDocumentReference 

40from google.cloud.firestore_v1.async_query import AsyncQuery 

41from google.cloud.firestore_v1.async_transaction import async_transactional 

42from google.cloud.firestore_v1.async_transaction import AsyncTransaction 

43from google.cloud.firestore_v1.base_document import DocumentSnapshot 

44from google.cloud.firestore_v1.batch import WriteBatch 

45from google.cloud.firestore_v1.client import Client 

46from google.cloud.firestore_v1.collection import CollectionReference 

47from google.cloud.firestore_v1.document import DocumentReference 

48from google.cloud.firestore_v1.query import CollectionGroup 

49from google.cloud.firestore_v1.query import Query 

50from google.cloud.firestore_v1.transaction import Transaction 

51from google.cloud.firestore_v1.transaction import transactional 

52from google.cloud.firestore_v1.transforms import ArrayRemove 

53from google.cloud.firestore_v1.transforms import ArrayUnion 

54from google.cloud.firestore_v1.transforms import DELETE_FIELD 

55from google.cloud.firestore_v1.transforms import Increment 

56from google.cloud.firestore_v1.transforms import Maximum 

57from google.cloud.firestore_v1.transforms import Minimum 

58from google.cloud.firestore_v1.transforms import SERVER_TIMESTAMP 

59from google.cloud.firestore_v1.watch import Watch 

60 

61 

62# TODO(https://github.com/googleapis/python-firestore/issues/93): this is all on the generated surface. We require this to match 

63# firestore.py. So comment out until needed on customer level for certain. 

64# from .services.firestore import FirestoreClient 

65# from .types.common import DocumentMask 

66# from .types.common import Precondition 

67# from .types.common import TransactionOptions 

68# from .types.document import ArrayValue 

69# from .types.document import Document 

70# from .types.document import MapValue 

71# from .types.document import Value 

72# from .types.firestore import BatchGetDocumentsRequest 

73# from .types.firestore import BatchGetDocumentsResponse 

74# from .types.firestore import BatchWriteRequest 

75# from .types.firestore import BatchWriteResponse 

76# from .types.firestore import BeginTransactionRequest 

77# from .types.firestore import BeginTransactionResponse 

78# from .types.firestore import CommitRequest 

79# from .types.firestore import CommitResponse 

80# from .types.firestore import CreateDocumentRequest 

81# from .types.firestore import DeleteDocumentRequest 

82# from .types.firestore import GetDocumentRequest 

83# from .types.firestore import ListCollectionIdsRequest 

84# from .types.firestore import ListCollectionIdsResponse 

85# from .types.firestore import ListDocumentsRequest 

86# from .types.firestore import ListDocumentsResponse 

87# from .types.firestore import ListenRequest 

88# from .types.firestore import ListenResponse 

89# from .types.firestore import PartitionQueryRequest 

90# from .types.firestore import PartitionQueryResponse 

91# from .types.firestore import RollbackRequest 

92# from .types.firestore import RunQueryRequest 

93# from .types.firestore import RunQueryResponse 

94# from .types.firestore import Target 

95# from .types.firestore import TargetChange 

96# from .types.firestore import UpdateDocumentRequest 

97# from .types.firestore import WriteRequest 

98# from .types.firestore import WriteResponse 

99# from .types.query import Cursor 

100# from .types.query import StructuredQuery 

101# from .types.write import DocumentChange 

102# from .types.write import DocumentDelete 

103# from .types.write import DocumentRemove 

104from .types.write import DocumentTransform 

105from typing import List 

106 

107 

108# from .types.write import ExistenceFilter 

109# from .types.write import Write 

110# from .types.write import WriteResult 

111 

112__all__: List[str] = [ 

113 "__version__", 

114 "And", 

115 "ArrayRemove", 

116 "ArrayUnion", 

117 "AsyncClient", 

118 "AsyncCollectionReference", 

119 "AsyncDocumentReference", 

120 "AsyncQuery", 

121 "async_transactional", 

122 "AsyncTransaction", 

123 "AsyncWriteBatch", 

124 "Client", 

125 "CountAggregation", 

126 "CollectionGroup", 

127 "CollectionReference", 

128 "DELETE_FIELD", 

129 "DocumentReference", 

130 "DocumentSnapshot", 

131 "DocumentTransform", 

132 "ExistsOption", 

133 "FieldFilter", 

134 "GeoPoint", 

135 "Increment", 

136 "LastUpdateOption", 

137 "Maximum", 

138 "Minimum", 

139 "Or", 

140 "Query", 

141 "ReadAfterWriteError", 

142 "SERVER_TIMESTAMP", 

143 "Transaction", 

144 "transactional", 

145 "types", 

146 "Watch", 

147 "WriteBatch", 

148 "WriteOption", 

149]