PYTHON-2504 ruff --fix-only --select ALL --fixable ALL --target-version py37 --line-length=100 --unfixable COM812,D400,D415,ERA001,RUF100,SIM108,D211,D212,SIM105,SIM,PT,ANN204 bson/*.py pymongo/*.py gridfs/*.py test/*.py test/*/*.py

Author: ShaneHarvey

bson/__init__.py

@@ -236,10 +236,8 @@ def get_data_and_view(data: Any) -> Tuple[Any, memoryview]:
 
 def _raise_unknown_type(element_type: int, element_name: str) -> NoReturn:
     """Unknown type helper."""
-    raise InvalidBSON(
-        "Detected unknown BSON type %r for fieldname '%s'. Are "
-        "you using the latest driver version?" % (chr(element_type).encode(), element_name)
-    )
+    msg = f"Detected unknown BSON type {chr(element_type).encode()!r} for fieldname '{element_name}'. Are you using the latest driver version?"
+    raise InvalidBSON(msg)
 
 
 def _get_int(
@@ -269,10 +267,12 @@ def _get_string(
     length = _UNPACK_INT_FROM(data, position)[0]
     position += 4
     if length < 1 or obj_end - position < length:
-        raise InvalidBSON("invalid string length")
+        msg = "invalid string length"
+        raise InvalidBSON(msg)
     end = position + length - 1
     if data[end] != 0:
-        raise InvalidBSON("invalid end of string")
+        msg = "invalid end of string"
+        raise InvalidBSON(msg)
     return _utf_8_decode(view[position:end], opts.unicode_decode_error_handler, True)[0], end + 1
 
 
@@ -284,12 +284,15 @@ def _get_object_size(data: Any, position: int, obj_end: int) -> Tuple[int, int]:
         raise InvalidBSON(str(exc))
     end = position + obj_size - 1
     if data[end] != 0:
-        raise InvalidBSON("bad eoo")
+        msg = "bad eoo"
+        raise InvalidBSON(msg)
     if end >= obj_end:
-        raise InvalidBSON("invalid object length")
+        msg = "invalid object length"
+        raise InvalidBSON(msg)
     # If this is the top-level document, validate the total size too.
     if position == 0 and obj_size != obj_end:
-        raise InvalidBSON("invalid object length")
+        msg = "invalid object length"
+        raise InvalidBSON(msg)
     return obj_size, end
 
 
@@ -321,7 +324,8 @@ def _get_array(
     size = _UNPACK_INT_FROM(data, position)[0]
     end = position + size - 1
     if data[end] != 0:
-        raise InvalidBSON("bad eoo")
+        msg = "bad eoo"
+        raise InvalidBSON(msg)
 
     position += 4
     end -= 1
@@ -352,7 +356,8 @@ def _get_array(
         append(value)
 
     if position != end + 1:
-        raise InvalidBSON("bad array length")
+        msg = "bad array length"
+        raise InvalidBSON(msg)
     return result, position + 1
 
 
@@ -366,11 +371,13 @@ def _get_binary(
         length2 = _UNPACK_INT_FROM(data, position)[0]
         position += 4
         if length2 != length - 4:
-            raise InvalidBSON("invalid binary (st 2) - lengths don't match!")
+            msg = "invalid binary (st 2) - lengths don't match!"
+            raise InvalidBSON(msg)
         length = length2
     end = position + length
     if length < 0 or end > obj_end:
-        raise InvalidBSON("bad binary object length")
+        msg = "bad binary object length"
+        raise InvalidBSON(msg)
 
     # Convert UUID subtypes to native UUIDs.
     if subtype in ALL_UUID_SUBTYPES:
@@ -437,7 +444,8 @@ def _get_code_w_scope(
     code, position = _get_string(data, view, position + 4, code_end, opts, element_name)
     scope, position = _get_object(data, view, position, code_end, opts, element_name)
     if position != code_end:
-        raise InvalidBSON("scope outside of javascript code boundaries")
+        msg = "scope outside of javascript code boundaries"
+        raise InvalidBSON(msg)
     return Code(code, scope), position
 
 
@@ -587,7 +595,8 @@ def _elements_to_dict(
         )
         result[key] = value
     if position != obj_end:
-        raise InvalidBSON("bad object or element length")
+        msg = "bad object or element length"
+        raise InvalidBSON(msg)
     return result
 
 
@@ -637,15 +646,17 @@ def _make_c_string_check(string: Union[str, bytes]) -> bytes:
     """Make a 'C' string, checking for embedded NUL characters."""
     if isinstance(string, bytes):
         if b"\x00" in string:
-            raise InvalidDocument("BSON keys / regex patterns must not contain a NUL character")
+            msg = "BSON keys / regex patterns must not contain a NUL character"
+            raise InvalidDocument(msg)
         try:
             _utf_8_decode(string, None, True)
             return string + b"\x00"
         except UnicodeError:
             raise InvalidStringData("strings in documents must be valid UTF-8: %r" % string)
     else:
         if "\x00" in string:
-            raise InvalidDocument("BSON keys / regex patterns must not contain a NUL character")
+            msg = "BSON keys / regex patterns must not contain a NUL character"
+            raise InvalidDocument(msg)
         return _utf_8_encode(string)[0] + b"\x00"
 
 
@@ -665,7 +676,8 @@ def _make_name(string: str) -> bytes:
     """Make a 'C' string suitable for a BSON key."""
     # Keys can only be text in python 3.
     if "\x00" in string:
-        raise InvalidDocument("BSON keys / regex patterns must not contain a NUL character")
+        msg = "BSON keys / regex patterns must not contain a NUL character"
+        raise InvalidDocument(msg)
     return _utf_8_encode(string)[0] + b"\x00"
 
 
@@ -805,7 +817,8 @@ def _encode_int(name: bytes, value: int, dummy0: Any, dummy1: Any) -> bytes:
         try:
             return b"\x12" + name + _PACK_LONG(value)
         except struct.error:
-            raise OverflowError("BSON can only handle up to 8-byte ints")
+            msg = "BSON can only handle up to 8-byte ints"
+            raise OverflowError(msg)
 
 
 def _encode_timestamp(name: bytes, value: Any, dummy0: Any, dummy1: Any) -> bytes:
@@ -818,7 +831,8 @@ def _encode_long(name: bytes, value: Any, dummy0: Any, dummy1: Any) -> bytes:
     try:
         return b"\x12" + name + _PACK_LONG(value)
     except struct.error:
-        raise OverflowError("BSON can only handle up to 8-byte ints")
+        msg = "BSON can only handle up to 8-byte ints"
+        raise OverflowError(msg)
 
 
 def _encode_decimal128(name: bytes, value: Decimal128, dummy0: Any, dummy1: Any) -> bytes:
@@ -941,18 +955,22 @@ def _name_value_to_bson(
             name, fallback_encoder(value), check_keys, opts, in_fallback_call=True
         )
 
-    raise InvalidDocument(f"cannot encode object: {value!r}, of type: {type(value)!r}")
+    msg = f"cannot encode object: {value!r}, of type: {type(value)!r}"
+    raise InvalidDocument(msg)
 
 
 def _element_to_bson(key: Any, value: Any, check_keys: bool, opts: CodecOptions) -> bytes:
     """Encode a single key, value pair."""
     if not isinstance(key, str):
-        raise InvalidDocument(f"documents must have only string keys, key was {key!r}")
+        msg = f"documents must have only string keys, key was {key!r}"
+        raise InvalidDocument(msg)
     if check_keys:
         if key.startswith("$"):
-            raise InvalidDocument(f"key {key!r} must not start with '$'")
+            msg = f"key {key!r} must not start with '$'"
+            raise InvalidDocument(msg)
         if "." in key:
-            raise InvalidDocument(f"key {key!r} must not contain '.'")
+            msg = f"key {key!r} must not contain '.'"
+            raise InvalidDocument(msg)
 
     name = _make_name(key)
     return _name_value_to_bson(name, value, check_keys, opts)
@@ -970,7 +988,8 @@ def _dict_to_bson(doc: Any, check_keys: bool, opts: CodecOptions, top_level: boo
             if not top_level or key != "_id":
                 elements.append(_element_to_bson(key, value, check_keys, opts))
     except AttributeError:
-        raise TypeError(f"encoder expected a mapping type but got: {doc!r}")
+        msg = f"encoder expected a mapping type but got: {doc!r}"
+        raise TypeError(msg)
 
     encoded = b"".join(elements)
     return _PACK_INT(len(encoded) + 5) + encoded + b"\x00"
@@ -1063,10 +1082,12 @@ def _decode_all(
         while position < end:
             obj_size = _UNPACK_INT_FROM(data, position)[0]
             if data_len - position < obj_size:
-                raise InvalidBSON("invalid object size")
+                msg = "invalid object size"
+                raise InvalidBSON(msg)
             obj_end = position + obj_size - 1
             if data[obj_end] != 0:
-                raise InvalidBSON("bad eoo")
+                msg = "bad eoo"
+                raise InvalidBSON(msg)
             if use_raw:
                 docs.append(opts.document_class(data[position : obj_end + 1], opts))  # type: ignore
             else:
@@ -1152,7 +1173,8 @@ def _array_of_documents_to_buffer(view: memoryview) -> bytes:
         append(view[position : position + obj_size])
         position += obj_size
     if position != end:
-        raise InvalidBSON("bad object or element length")
+        msg = "bad object or element length"
+        raise InvalidBSON(msg)
     return b"".join(buffers)
 
 
@@ -1283,7 +1305,8 @@ def decode_file_iter(
         if not size_data:
             break  # Finished with file normally.
         elif len(size_data) != 4:
-            raise InvalidBSON("cut off in middle of objsize")
+            msg = "cut off in middle of objsize"
+            raise InvalidBSON(msg)
         obj_size = _UNPACK_INT_FROM(size_data, 0)[0] - 4
         elements = size_data + file_obj.read(max(0, obj_size))
         yield _bson_to_dict(elements, opts)
@@ -1300,7 +1323,8 @@ def is_valid(bson: bytes) -> bool:
       - `bson`: the data to be validated
     """
     if not isinstance(bson, bytes):
-        raise TypeError("BSON data must be an instance of a subclass of bytes")
+        msg = "BSON data must be an instance of a subclass of bytes"
+        raise TypeError(msg)
 
     try:
         _bson_to_dict(bson, DEFAULT_CODEC_OPTIONS)

bson/_helpers.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 """Setstate and getstate functions for objects with __slots__, allowing
-    compatibility with default pickling protocol
+compatibility with default pickling protocol
 """
 from typing import Any, Mapping
 
@@ -33,7 +33,7 @@ def _mangle_name(name: str, prefix: str) -> str:
 
 def _getstate_slots(self: Any) -> Mapping[Any, Any]:
     prefix = self.__class__.__name__
-    ret = dict()
+    ret = {}
     for name in self.__slots__:
         mangled_name = _mangle_name(name, prefix)
         if hasattr(self, mangled_name):

bson/binary.py

@@ -224,9 +224,11 @@ def __new__(
         subtype: int = BINARY_SUBTYPE,
     ) -> "Binary":
         if not isinstance(subtype, int):
-            raise TypeError("subtype must be an instance of int")
+            msg = "subtype must be an instance of int"
+            raise TypeError(msg)
         if subtype >= 256 or subtype < 0:
-            raise ValueError("subtype must be contained in [0, 256)")
+            msg = "subtype must be contained in [0, 256)"
+            raise ValueError(msg)
         # Support any type that implements the buffer protocol.
         self = bytes.__new__(cls, memoryview(data).tobytes())
         self.__subtype = subtype
@@ -256,22 +258,16 @@ def from_uuid(
         .. versionadded:: 3.11
         """
         if not isinstance(uuid, UUID):
-            raise TypeError("uuid must be an instance of uuid.UUID")
+            msg = "uuid must be an instance of uuid.UUID"
+            raise TypeError(msg)
 
         if uuid_representation not in ALL_UUID_REPRESENTATIONS:
-            raise ValueError(
-                "uuid_representation must be a value from bson.binary.UuidRepresentation"
-            )
+            msg = "uuid_representation must be a value from bson.binary.UuidRepresentation"
+            raise ValueError(msg)
 
         if uuid_representation == UuidRepresentation.UNSPECIFIED:
-            raise ValueError(
-                "cannot encode native uuid.UUID with "
-                "UuidRepresentation.UNSPECIFIED. UUIDs can be manually "
-                "converted to bson.Binary instances using "
-                "bson.Binary.from_uuid() or a different UuidRepresentation "
-                "can be configured. See the documentation for "
-                "UuidRepresentation for more information."
-            )
+            msg = "cannot encode native uuid.UUID with UuidRepresentation.UNSPECIFIED. UUIDs can be manually converted to bson.Binary instances using bson.Binary.from_uuid() or a different UuidRepresentation can be configured. See the documentation for UuidRepresentation for more information."
+            raise ValueError(msg)
 
         subtype = OLD_UUID_SUBTYPE
         if uuid_representation == UuidRepresentation.PYTHON_LEGACY:
@@ -306,15 +302,16 @@ def as_uuid(self, uuid_representation: int = UuidRepresentation.STANDARD) -> UUI
         .. versionadded:: 3.11
         """
         if self.subtype not in ALL_UUID_SUBTYPES:
-            raise ValueError(f"cannot decode subtype {self.subtype} as a uuid")
+            msg = f"cannot decode subtype {self.subtype} as a uuid"
+            raise ValueError(msg)
 
         if uuid_representation not in ALL_UUID_REPRESENTATIONS:
-            raise ValueError(
-                "uuid_representation must be a value from bson.binary.UuidRepresentation"
-            )
+            msg = "uuid_representation must be a value from bson.binary.UuidRepresentation"
+            raise ValueError(msg)
 
         if uuid_representation == UuidRepresentation.UNSPECIFIED:
-            raise ValueError("uuid_representation cannot be UNSPECIFIED")
+            msg = "uuid_representation cannot be UNSPECIFIED"
+            raise ValueError(msg)
         elif uuid_representation == UuidRepresentation.PYTHON_LEGACY:
             if self.subtype == OLD_UUID_SUBTYPE:
                 return UUID(bytes=self)
@@ -330,8 +327,7 @@ def as_uuid(self, uuid_representation: int = UuidRepresentation.STANDARD) -> UUI
                 return UUID(bytes=self)
 
         raise ValueError(
-            "cannot decode subtype %s to %s"
-            % (self.subtype, UUID_REPRESENTATION_NAMES[uuid_representation])
+            f"cannot decode subtype {self.subtype} to {UUID_REPRESENTATION_NAMES[uuid_representation]}"
         )
 
     @property

bson/code.py

@@ -12,8 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Tools for representing JavaScript code in BSON.
-"""
+"""Tools for representing JavaScript code in BSON."""
 
 from collections.abc import Mapping as _Mapping
 from typing import Any, Mapping, Optional, Type, Union
@@ -57,7 +56,8 @@ def __new__(
         **kwargs: Any,
     ) -> "Code":
         if not isinstance(code, str):
-            raise TypeError("code must be an instance of str")
+            msg = "code must be an instance of str"
+            raise TypeError(msg)
 
         self = str.__new__(cls, code)
 
@@ -68,7 +68,8 @@ def __new__(
 
         if scope is not None:
             if not isinstance(scope, _Mapping):
-                raise TypeError("scope must be an instance of dict")
+                msg = "scope must be an instance of dict"
+                raise TypeError(msg)
             if self.__scope is not None:
                 self.__scope.update(scope)  # type: ignore
             else: