PYTHON-4005 Replace flake8 and isort with ruff (#1399)

Author: blink1073

.flake8

@@ -24,12 +24,12 @@ repos:
     files: \.py$
     args: [--line-length=100]
 
-- repo: https://github.com/PyCQA/isort
-  rev: 5.12.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.1.0
   hooks:
-  - id: isort
-    files: \.py$
-    args: [--profile=black]
+    - id: ruff
+      args: ["--fix", "--show-fixes"]
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: "1.13.0"
@@ -38,18 +38,6 @@ repos:
     additional_dependencies:
     - black==22.3.0
 
-- repo: https://github.com/PyCQA/flake8
-  rev: 3.9.2
-  hooks:
-  - id: flake8
-    files: \.py$
-    additional_dependencies: [
-        'flake8-bugbear==20.1.4',
-        'flake8-logging-format==0.6.0',
-        'flake8-implicit-str-concat==0.2.0',
-    ]
-    stages: [manual]
-
 # We use the Python version instead of the original version which seems to require Docker
 # https://github.com/koalaman/shellcheck-precommit
 - repo: https://github.com/shellcheck-py/shellcheck-py

.pre-commit-config.yaml

@@ -244,7 +244,7 @@ def _raise_unknown_type(element_type: int, element_name: str) -> NoReturn:
 
 
 def _get_int(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[int, int]:
     """Decode a BSON int32 to python int."""
     return _UNPACK_INT_FROM(data, position)[0], position + 4
@@ -257,7 +257,7 @@ def _get_c_string(data: Any, view: Any, position: int, opts: CodecOptions[Any])
 
 
 def _get_float(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[float, int]:
     """Decode a BSON double to python float."""
     return _UNPACK_FLOAT_FROM(data, position)[0], position + 8
@@ -282,7 +282,7 @@ def _get_object_size(data: Any, position: int, obj_end: int) -> Tuple[int, int]:
     try:
         obj_size = _UNPACK_INT_FROM(data, position)[0]
     except struct.error as exc:
-        raise InvalidBSON(str(exc))
+        raise InvalidBSON(str(exc)) from None
     end = position + obj_size - 1
     if data[end] != 0:
         raise InvalidBSON("bad eoo")
@@ -358,7 +358,7 @@ def _get_array(
 
 
 def _get_binary(
-    data: Any, view: Any, position: int, obj_end: int, opts: CodecOptions[Any], dummy1: Any
+    data: Any, _view: Any, position: int, obj_end: int, opts: CodecOptions[Any], dummy1: Any
 ) -> Tuple[Union[Binary, uuid.UUID], int]:
     """Decode a BSON binary to bson.binary.Binary or python UUID."""
     length, subtype = _UNPACK_LENGTH_SUBTYPE_FROM(data, position)
@@ -395,15 +395,15 @@ def _get_binary(
 
 
 def _get_oid(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[ObjectId, int]:
     """Decode a BSON ObjectId to bson.objectid.ObjectId."""
     end = position + 12
     return ObjectId(data[position:end]), end
 
 
 def _get_boolean(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[bool, int]:
     """Decode a BSON true/false to python True/False."""
     end = position + 1
@@ -416,7 +416,7 @@ def _get_boolean(
 
 
 def _get_date(
-    data: Any, view: Any, position: int, dummy0: int, opts: CodecOptions[Any], dummy1: Any
+    data: Any, _view: Any, position: int, dummy0: int, opts: CodecOptions[Any], dummy1: Any
 ) -> Tuple[Union[datetime.datetime, DatetimeMS], int]:
     """Decode a BSON datetime to python datetime.datetime."""
     return _millis_to_datetime(_UNPACK_LONG_FROM(data, position)[0], opts), position + 8
@@ -431,7 +431,7 @@ def _get_code(
 
 
 def _get_code_w_scope(
-    data: Any, view: Any, position: int, obj_end: int, opts: CodecOptions[Any], element_name: str
+    data: Any, view: Any, position: int, _obj_end: int, opts: CodecOptions[Any], element_name: str
 ) -> Tuple[Code, int]:
     """Decode a BSON code_w_scope to bson.code.Code."""
     code_end = position + _UNPACK_INT_FROM(data, position)[0]
@@ -462,22 +462,22 @@ def _get_ref(
 
 
 def _get_timestamp(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[Timestamp, int]:
     """Decode a BSON timestamp to bson.timestamp.Timestamp."""
     inc, timestamp = _UNPACK_TIMESTAMP_FROM(data, position)
     return Timestamp(timestamp, inc), position + 8
 
 
 def _get_int64(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[Int64, int]:
     """Decode a BSON int64 to bson.int64.Int64."""
     return Int64(_UNPACK_LONG_FROM(data, position)[0]), position + 8
 
 
 def _get_decimal128(
-    data: Any, view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
+    data: Any, _view: Any, position: int, dummy0: Any, dummy1: Any, dummy2: Any
 ) -> Tuple[Decimal128, int]:
     """Decode a BSON decimal128 to bson.decimal128.Decimal128."""
     end = position + 16
@@ -496,11 +496,11 @@ def _get_decimal128(
     ord(BSONOBJ): _get_object,
     ord(BSONARR): _get_array,
     ord(BSONBIN): _get_binary,
-    ord(BSONUND): lambda u, v, w, x, y, z: (None, w),  # Deprecated undefined
+    ord(BSONUND): lambda u, v, w, x, y, z: (None, w),  # noqa: ARG005 # Deprecated undefined
     ord(BSONOID): _get_oid,
     ord(BSONBOO): _get_boolean,
     ord(BSONDAT): _get_date,
-    ord(BSONNUL): lambda u, v, w, x, y, z: (None, w),
+    ord(BSONNUL): lambda u, v, w, x, y, z: (None, w),  # noqa: ARG005
     ord(BSONRGX): _get_regex,
     ord(BSONREF): _get_ref,  # Deprecated DBPointer
     ord(BSONCOD): _get_code,
@@ -510,16 +510,16 @@ def _get_decimal128(
     ord(BSONTIM): _get_timestamp,
     ord(BSONLON): _get_int64,
     ord(BSONDEC): _get_decimal128,
-    ord(BSONMIN): lambda u, v, w, x, y, z: (MinKey(), w),
-    ord(BSONMAX): lambda u, v, w, x, y, z: (MaxKey(), w),
+    ord(BSONMIN): lambda u, v, w, x, y, z: (MinKey(), w),  # noqa: ARG005
+    ord(BSONMAX): lambda u, v, w, x, y, z: (MaxKey(), w),  # noqa: ARG005
 }
 
 
 if _USE_C:
 
     def _element_to_dict(
         data: Any,
-        view: Any,
+        view: Any,  # noqa: ARG001
         position: int,
         obj_end: int,
         opts: CodecOptions[Any],
@@ -615,11 +615,11 @@ def _bson_to_dict(data: Any, opts: CodecOptions[_DocumentType]) -> _DocumentType
     except Exception:
         # Change exception type to InvalidBSON but preserve traceback.
         _, exc_value, exc_tb = sys.exc_info()
-        raise InvalidBSON(str(exc_value)).with_traceback(exc_tb)
+        raise InvalidBSON(str(exc_value)).with_traceback(exc_tb) from None
 
 
 if _USE_C:
-    _bson_to_dict = _cbson._bson_to_dict  # noqa: F811
+    _bson_to_dict = _cbson._bson_to_dict
 
 
 _PACK_FLOAT = struct.Struct("<d").pack
@@ -653,7 +653,9 @@ def _make_c_string_check(string: Union[str, bytes]) -> bytes:
             _utf_8_decode(string, None, True)
             return string + b"\x00"
         except UnicodeError:
-            raise InvalidStringData("strings in documents must be valid UTF-8: %r" % string)
+            raise InvalidStringData(
+                "strings in documents must be valid UTF-8: %r" % string
+            ) from None
     else:
         if "\x00" in string:
             raise InvalidDocument("BSON keys / regex patterns must not contain a NUL character")
@@ -667,7 +669,9 @@ def _make_c_string(string: Union[str, bytes]) -> bytes:
             _utf_8_decode(string, None, True)
             return string + b"\x00"
         except UnicodeError:
-            raise InvalidStringData("strings in documents must be valid UTF-8: %r" % string)
+            raise InvalidStringData(
+                "strings in documents must be valid UTF-8: %r" % string
+            ) from None
     else:
         return _utf_8_encode(string)[0] + b"\x00"
 
@@ -817,7 +821,7 @@ 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")
+            raise OverflowError("BSON can only handle up to 8-byte ints") from None
 
 
 def _encode_timestamp(name: bytes, value: Any, dummy0: Any, dummy1: Any) -> bytes:
@@ -830,7 +834,7 @@ 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")
+        raise OverflowError("BSON can only handle up to 8-byte ints") from None
 
 
 def _encode_decimal128(name: bytes, value: Decimal128, dummy0: Any, dummy1: Any) -> bytes:
@@ -995,14 +999,14 @@ def _dict_to_bson(
             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}")
+        raise TypeError(f"encoder expected a mapping type but got: {doc!r}") from None
 
     encoded = b"".join(elements)
     return _PACK_INT(len(encoded) + 5) + encoded + b"\x00"
 
 
 if _USE_C:
-    _dict_to_bson = _cbson._dict_to_bson  # noqa: F811
+    _dict_to_bson = _cbson._dict_to_bson
 
 
 _CODEC_OPTIONS_TYPE_ERROR = TypeError("codec_options must be an instance of CodecOptions")
@@ -1110,11 +1114,11 @@ def _decode_all(data: _ReadableBuffer, opts: CodecOptions[_DocumentType]) -> lis
     except Exception:
         # Change exception type to InvalidBSON but preserve traceback.
         _, exc_value, exc_tb = sys.exc_info()
-        raise InvalidBSON(str(exc_value)).with_traceback(exc_tb)
+        raise InvalidBSON(str(exc_value)).with_traceback(exc_tb) from None
 
 
 if _USE_C:
-    _decode_all = _cbson._decode_all  # noqa: F811
+    _decode_all = _cbson._decode_all
 
 
 @overload
@@ -1207,7 +1211,7 @@ def _array_of_documents_to_buffer(view: memoryview) -> bytes:
 
 
 if _USE_C:
-    _array_of_documents_to_buffer = _cbson._array_of_documents_to_buffer  # noqa: F811
+    _array_of_documents_to_buffer = _cbson._array_of_documents_to_buffer
 
 
 def _convert_raw_document_lists_to_streams(document: Any) -> None:

bson/__init__.py

@@ -242,7 +242,7 @@ def __new__(
     @classmethod
     def from_uuid(
         cls: Type[Binary], uuid: UUID, uuid_representation: int = UuidRepresentation.STANDARD
-    ) -> "Binary":
+    ) -> Binary:
         """Create a BSON Binary object from a Python UUID.
 
         Creates a :class:`~bson.binary.Binary` object from a

bson/binary.py

@@ -168,7 +168,7 @@ def _validate_type_encoder(self, codec: _Codec) -> None:
             if issubclass(cast(TypeCodec, codec).python_type, pytype):
                 err_msg = (
                     "TypeEncoders cannot change how built-in types are "
-                    "encoded (encoder {} transforms type {})".format(codec, pytype)
+                    f"encoded (encoder {codec} transforms type {pytype})"
                 )
                 raise TypeError(err_msg)
 

bson/codec_options.py

@@ -75,10 +75,10 @@ def __hash__(self) -> int:
     def __repr__(self) -> str:
         return type(self).__name__ + "(" + str(self._value) + ")"
 
-    def __lt__(self, other: Union["DatetimeMS", int]) -> bool:
+    def __lt__(self, other: Union[DatetimeMS, int]) -> bool:
         return self._value < other
 
-    def __le__(self, other: Union["DatetimeMS", int]) -> bool:
+    def __le__(self, other: Union[DatetimeMS, int]) -> bool:
         return self._value <= other
 
     def __eq__(self, other: Any) -> bool:
@@ -91,10 +91,10 @@ def __ne__(self, other: Any) -> bool:
             return self._value != other._value
         return True
 
-    def __gt__(self, other: Union["DatetimeMS", int]) -> bool:
+    def __gt__(self, other: Union[DatetimeMS, int]) -> bool:
         return self._value > other
 
-    def __ge__(self, other: Union["DatetimeMS", int]) -> bool:
+    def __ge__(self, other: Union[DatetimeMS, int]) -> bool:
         return self._value >= other
 
     _type_marker = 9

bson/datetime_ms.py

@@ -89,7 +89,7 @@ def __getattr__(self, key: Any) -> Any:
         try:
             return self.__kwargs[key]
         except KeyError:
-            raise AttributeError(key)
+            raise AttributeError(key) from None
 
     def as_doc(self) -> SON[str, Any]:
         """Get the SON document representation of this DBRef.

bson/dbref.py

@@ -298,7 +298,7 @@ def __str__(self) -> str:
         return str(dec)
 
     def __repr__(self) -> str:
-        return f"Decimal128('{str(self)}')"
+        return f"Decimal128('{self!s}')"
 
     def __setstate__(self, value: Tuple[int, int]) -> None:
         self.__high, self.__low = value

bson/decimal128.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Exceptions raised by the BSON package."""
+from __future__ import annotations
 
 
 class BSONError(Exception):

bson/errors.py

@@ -737,8 +737,7 @@ def _parse_canonical_regex(doc: Any) -> Regex[str]:
         raise TypeError(f"Bad $regularExpression, extra field(s): {doc}")
     if len(regex) != 2:
         raise TypeError(
-            'Bad $regularExpression must include only "pattern"'
-            'and "options" components: {}'.format(doc)
+            f'Bad $regularExpression must include only "pattern and "options" components: {doc}'
         )
     opts = regex["options"]
     if not isinstance(opts, str):
@@ -812,7 +811,7 @@ def _parse_canonical_decimal128(doc: Any) -> Decimal128:
 
 def _parse_canonical_minkey(doc: Any) -> MinKey:
     """Decode a JSON MinKey to bson.min_key.MinKey."""
-    if type(doc["$minKey"]) is not int or doc["$minKey"] != 1:
+    if type(doc["$minKey"]) is not int or doc["$minKey"] != 1:  # noqa: E721
         raise TypeError(f"$minKey value must be 1: {doc}")
     if len(doc) != 1:
         raise TypeError(f"Bad $minKey, extra field(s): {doc}")
@@ -821,7 +820,7 @@ def _parse_canonical_minkey(doc: Any) -> MinKey:
 
 def _parse_canonical_maxkey(doc: Any) -> MaxKey:
     """Decode a JSON MaxKey to bson.max_key.MaxKey."""
-    if type(doc["$maxKey"]) is not int or doc["$maxKey"] != 1:
+    if type(doc["$maxKey"]) is not int or doc["$maxKey"] != 1:  # noqa: E721
         raise TypeError("$maxKey value must be 1: %s", (doc,))
     if len(doc) != 1:
         raise TypeError(f"Bad $minKey, extra field(s): {doc}")