1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
BSON Type Information.
Utilities for validating bson types, etc.
"""
from __future__ import absolute_import, print_function, unicode_literals
from typing import Dict, List
# Dictionary of BSON type Information
# scalar: True if the type is not an array or object
# bson_type_enum: The BSONType enum value for the given type
_BSON_TYPE_INFORMATION = {
"double": {
'scalar': True,
'bson_type_enum': 'NumberDouble'
},
"string": {
'scalar': True,
'bson_type_enum': 'String'
},
"object": {
'scalar': False,
'bson_type_enum': 'Object'
},
# TODO: add support: "array" : { 'scalar' : False, 'bson_type_enum' : 'Array'},
"bindata": {
'scalar': True,
'bson_type_enum': 'BinData'
},
"undefined": {
'scalar': True,
'bson_type_enum': 'Undefined'
},
"objectid": {
'scalar': True,
'bson_type_enum': 'jstOID'
},
"bool": {
'scalar': True,
'bson_type_enum': 'Bool'
},
"date": {
'scalar': True,
'bson_type_enum': 'Date'
},
"null": {
'scalar': True,
'bson_type_enum': 'jstNULL'
},
"regex": {
'scalar': True,
'bson_type_enum': 'RegEx'
},
"int": {
'scalar': True,
'bson_type_enum': 'NumberInt'
},
"timestamp": {
'scalar': True,
'bson_type_enum': 'bsonTimestamp'
},
"long": {
'scalar': True,
'bson_type_enum': 'NumberLong'
},
"decimal": {
'scalar': True,
'bson_type_enum': 'NumberDecimal'
},
}
# Dictionary of BinData subtype type Information
# scalar: True if the type is not an array or object
# bindata_enum: The BinDataType enum value for the given type
_BINDATA_SUBTYPE = {
"generic": {
'scalar': True,
'bindata_enum': 'BinDataGeneral'
},
"function": {
'scalar': True,
'bindata_enum': 'Function'
},
# Also simply known as type 2, deprecated, and requires special handling
#"binary": {
# 'scalar': False,
# 'bindata_enum': 'ByteArrayDeprecated'
#},
# Deprecated
# "uuid_old": {
# 'scalar': False,
# 'bindata_enum': 'bdtUUID'
# },
"uuid": {
'scalar': True,
'bindata_enum': 'newUUID'
},
"md5": {
'scalar': True,
'bindata_enum': 'MD5Type'
},
}
def is_valid_bson_type(name):
# type: (unicode) -> bool
"""Return True if this is a valid bson type."""
return name in _BSON_TYPE_INFORMATION
def is_scalar_bson_type(name):
# type: (unicode) -> bool
"""Return True if this bson type is a scalar."""
assert is_valid_bson_type(name)
return _BSON_TYPE_INFORMATION[name]['scalar'] # type: ignore
def cpp_bson_type_name(name):
# type: (unicode) -> unicode
"""Return the C++ type name for a bson type."""
assert is_valid_bson_type(name)
return _BSON_TYPE_INFORMATION[name]['bson_type_enum'] # type: ignore
def list_valid_types():
# type: () -> List[unicode]
"""Return a list of supported bson types."""
return [a for a in _BSON_TYPE_INFORMATION.iterkeys()]
def is_valid_bindata_subtype(name):
# type: (unicode) -> bool
"""Return True if this bindata subtype is valid."""
return name in _BINDATA_SUBTYPE
def cpp_bindata_subtype_type_name(name):
# type: (unicode) -> unicode
"""Return the C++ type name for a bindata subtype."""
assert is_valid_bindata_subtype(name)
return _BINDATA_SUBTYPE[name]['bindata_enum'] # type: ignore
|
