PYTHON-1834 [v4.0] Use a code formatter 2 (#856)

Author: blink1073

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial pre-commit reformat
+b1d76c8ef4dd8fd364168c53b5c081b6d053d7b6

.github/workflows/test-python.yml

@@ -0,0 +1,40 @@
+name: Python Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+
+  pre-commit:
+    name: pre-commit
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/action@v2.0.0
+        with:
+          extra_args: --all-files --hook-stage=manual
+
+  build:
+    # supercharge/mongodb-github-action requires containers so we don't test other platforms
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: ["3.6", "3.10", "pypy-3.8"]
+    name: CPython ${{ matrix.python-version }}-${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.7.0
+        with:
+          mongodb-version: 4.4
+      - name: Run tests
+        run: |
+          python setup.py test

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-toml
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+    exclude: WHEEL
+    exclude_types: [json]
+  - id: forbid-new-submodules
+  - id: trailing-whitespace
+    exclude: .patch
+    exclude_types: [json]
+
+- repo: https://github.com/psf/black
+  rev: 22.1.0
+  hooks:
+  - id: black
+    files: \.py$
+    args: [--line-length=100]
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.7.0
+  hooks:
+  - id: isort
+    files: \.py$
+    args: [--profile=black]

CONTRIBUTING.rst

@@ -38,6 +38,23 @@ General Guidelines
   from the cmd line to run the test suite).
 - Add yourself to doc/contributors.rst :)
 
+Running Linters
+---------------
+
+PyMongo uses `pre-commit <https://pypi.org/project/pre-commit/>`_
+for managing linting of the codebase.
+``pre-commit`` performs various checks on all files in PyMongo and uses tools
+that help follow a consistent code style within the codebase.
+
+To set up ``pre-commit`` locally, run::
+
+    pip install pre-commit
+    pre-commit install
+
+To run ``pre-commit`` manually, run::
+
+    pre-commit run --all-files
+
 Documentation
 -------------
 

THIRD-PARTY-NOTICES

@@ -94,4 +94,3 @@ supplied in this file in the creation of products supporting the
 Unicode Standard, and to make copies of this file in any form
 for internal or external distribution as long as this notice
 remains attached.
-

bson/binary.py

@@ -69,7 +69,7 @@ class UuidRepresentation:
     code. When decoding a BSON binary field with a UUID subtype, a
     :class:`~bson.binary.Binary` instance will be returned instead of a
     :class:`uuid.UUID` instance.
-    
+
     See :ref:`unspecified-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -81,7 +81,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary, using RFC-4122 byte order with
     binary subtype :data:`UUID_SUBTYPE`.
-    
+
     See :ref:`standard-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -93,7 +93,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary, using RFC-4122 byte order with
     binary subtype :data:`OLD_UUID_SUBTYPE`.
-    
+
     See :ref:`python-legacy-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -105,7 +105,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary subtype :data:`OLD_UUID_SUBTYPE`,
     using the Java driver's legacy byte order.
-    
+
     See :ref:`java-legacy-representation-details` for details.
 
     .. versionadded:: 3.11
@@ -117,7 +117,7 @@ class UuidRepresentation:
     :class:`uuid.UUID` instances will automatically be encoded to
     and decoded from BSON binary subtype :data:`OLD_UUID_SUBTYPE`,
     using the C# driver's legacy byte order.
-    
+
     See :ref:`csharp-legacy-representation-details` for details.
 
     .. versionadded:: 3.11

doc/api/pymongo/event_loggers.rst

@@ -4,4 +4,4 @@
 
 .. automodule:: pymongo.event_loggers
    :synopsis: A collection of simple listeners for monitoring driver events.
-   :members:
+   :members:

doc/api/pymongo/topology_description.rst

@@ -7,4 +7,3 @@
 
    .. autoclass:: pymongo.topology_description.TopologyDescription()
       :members:
-

doc/atlas.rst

@@ -41,4 +41,3 @@ Connections to Atlas require TLS/SSL.
 .. _homebrew: https://brew.sh/
 .. _macports: https://www.macports.org/
 .. _requests: https://pypi.python.org/pypi/requests
-

doc/examples/server_selection.rst

@@ -105,4 +105,4 @@ list of known hosts. As an example, for a 3-member replica set with a
 all available secondaries.
 
 
-.. _server selection algorithm: https://docs.mongodb.com/manual/core/read-preference-mechanics/
+.. _server selection algorithm: https://docs.mongodb.com/manual/core/read-preference-mechanics/