PYTHON-1834 (cont) Add pre-commit config (mongodb#853)

Author: blink1073

.git-blame-ignore-revs

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

.github/workflows/test-python.yml

@@ -5,6 +5,18 @@ on:
   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/[email protected]
+        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 }}

.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
 -------------
 
@@ -67,4 +84,4 @@ The ``-b`` flag adds as a regex pattern to block files you do not wish to
 update in PyMongo.
 This is primarily helpful if you are implementing a new feature in PyMongo
 that has spec tests already implemented, or if you are attempting to
-validate new spec tests in PyMongo.
+validate new spec tests in PyMongo.

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.
-

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/

doc/migrate-to-pymongo4.rst

@@ -950,4 +950,4 @@ Additional BSON classes implement ``__slots__``
 :class:`~bson.max_key.MaxKey`, :class:`~bson.timestamp.Timestamp`,
 :class:`~bson.regex.Regex`, and :class:`~bson.dbref.DBRef` now implement
 ``__slots__`` to reduce memory usage. This means that their attributes are fixed, and new
-attributes cannot be added to the object at runtime.
+attributes cannot be added to the object at runtime.