[CLIENT-2092] Add pre-commit hooks (#354)

* Formats the documentation
* Fixes end of line issues for all files
* Github Actions: now uses precommit hooks for lint job
* BUILD.md: explains how to run pre-commit hooks

Author: juliannguyen4

.clang-format

@@ -164,4 +164,3 @@ WhitespaceSensitiveMacros:
   - NS_SWIFT_NAME
   - CF_SWIFT_NAME
 ...
-

.git-blame-ignore-revs

@@ -6,4 +6,3 @@ c8e007035f6f99859313c790de69edcdae2c696c
 # Python source code
 8a36b7b0977ce4771077113923a9ae1888d22fbb
 edc3d1af41e8851e927eb82ca6e915c4841732d3
-

.github/workflows/tests.yml

@@ -21,15 +21,7 @@ jobs:
       with:
         python-version: '3.9'
         architecture: 'x64'
-    - name: Install linting dependencies
-      run: python -m pip install flake8
-    - name: Lint Python code
-      run: python -m flake8
-    - name: Lint C wrapper code
-      uses: jidicula/[email protected]
-      with:
-        check-path: 'src'
-        clang-format-version: 14
+    - uses: pre-commit/[email protected]
 
   alpine:
     runs-on: ubuntu-latest

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+-   repo: https://github.com/pycqa/flake8
+    rev: '6.0.0'  # pick a git hash / tag to point to
+    hooks:
+    -   id: flake8
+        # Only run on files specified in .flake8
+        pass_filenames: false
+
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v14.0.6
+    hooks:
+    -   id: clang-format
+        files: "^src/"
+        types: ["file", "c"]
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-case-conflict
+    -   id: check-toml
+    -   id: debug-statements
+        # Only run on files specified in .flake8
+        pass_filenames: false
+        files: "^(aerospike_helpers|test)/"
+        types: ["file", "python"]
+    -   id: end-of-file-fixer
+
+-   repo: https://github.com/PyCQA/doc8
+    rev: v1.1.1
+    hooks:
+    -   id: doc8
+        args: ["doc/"]
+        pass_filenames: false

BUILD.md

@@ -182,6 +182,16 @@ All C source code must be formatted with `clang-format`:
 clang-format -i <filename>
 ```
 
+### Precommit Hooks
+
+All commits must pass precommit hook tests. To install precommit hooks:
+```
+pip install pre-commit
+pre-commit install
+```
+
+See pre-commit's documentation for more usage explanations.
+
 ## License
 
 The Aerospike Python Client is made availabled under the terms of the Apache License, Version 2, as stated in the file `LICENSE`.

LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

Releases.md

@@ -147,4 +147,4 @@ CLIENT-1555	Remove dependency on c-client binary from python client source insta
 CLIENT-1566 Python-Client hangs intermittently in automation cluster
 
 ## Updates
- * Upgraded to [Aerospike C Client 5.2.6](https://download.aerospike.com/download/client/c/notes.html#5.2.6)
+ * Upgraded to [Aerospike C Client 5.2.6](https://download.aerospike.com/download/client/c/notes.html#5.2.6)

api-changes.md

@@ -1,4 +1,4 @@
 # Backward Incompatible API Changes
 
 The documentation of backward incompatible API changes has been moved to
-<https://www.aerospike.com/docs/client/python/usage/incompatible.html>.
+<https://www.aerospike.com/docs/client/python/usage/incompatible.html>.

doc/README.md

@@ -34,4 +34,3 @@ Spelling check:
 ```bash
 sphinx-build -b spelling . spelling
 ```
-

doc/_static/theme_overrides.css

@@ -10,4 +10,4 @@
     .wy-table-responsive {
        overflow: visible !important;
     }
- }
+ }

doc/aerospike.rst

@@ -663,7 +663,8 @@ Policy Options
 Commit Level Policy Options
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Specifies the number of replicas required to be successfully committed before returning success in a write operation to provide the desired consistency guarantee.
+Specifies the number of replicas required to be successfully committed before returning success in a write operation to
+provide the desired consistency guarantee.
 
 .. data:: POLICY_COMMIT_LEVEL_ALL
 
@@ -1302,15 +1303,15 @@ Flags used by :class:`~aerospike_helpers.operations.expression_operations.expres
 
 .. data:: EXP_WRITE_UPDATE_ONLY
 
-	If bin exists, the bin will be overwritten.
-	If bin does not exist, the operation will be denied.
-	If bin does not exist, fail with BinNotFound
-	when EXP_WRITE_POLICY_NO_FAIL is not set.
+    If bin exists, the bin will be overwritten.
+    If bin does not exist, the operation will be denied.
+    If bin does not exist, fail with BinNotFound
+    when EXP_WRITE_POLICY_NO_FAIL is not set.
 
 .. data:: EXP_WRITE_ALLOW_DELETE
 
-	If expression results in nil value, then delete the bin. Otherwise, return
-	OpNotApplicable when EXP_WRITE_POLICY_NO_FAIL is not set.
+    If expression results in nil value, then delete the bin. Otherwise, return
+    OpNotApplicable when EXP_WRITE_POLICY_NO_FAIL is not set.
 
 .. data:: EXP_WRITE_POLICY_NO_FAIL
 
@@ -1541,4 +1542,3 @@ See :ref:`aerospike_operation_helpers.expressions` for more information.
 .. data:: REGEX_NEWLINE
 
     Match-any-character operators don't match a newline.
-

doc/aerospike_helpers.batch.rst

@@ -6,7 +6,8 @@ aerospike\_helpers\.batch package
 aerospike\_helpers\.batch\.records module
 -----------------------------------------
 
-Classes for the use with client batch APIs :meth:`~Client.batch_write`, :meth:`~Client.batch_operate`, :meth:`~Client.batch_apply`, :meth:`~Client.batch_remove`.
+Classes for the use with client batch APIs :meth:`~Client.batch_write`, :meth:`~Client.batch_operate`,
+:meth:`~Client.batch_apply`, :meth:`~Client.batch_remove`.
 
 .. automodule:: aerospike_helpers.batch.records
     :members:

doc/aerospike_helpers.cdt_ctx.rst

@@ -8,4 +8,4 @@ aerospike\_helpers\.cdt_ctx module
 .. automodule:: aerospike_helpers.cdt_ctx
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

doc/aerospike_helpers.expressions.rst

@@ -19,7 +19,7 @@ allow for expanded functionality and customizability.
 In the Python client, Aerospike expressions are built using a series of classes that represent
 comparison and logical operators, bins, metadata operations, and bin operations.
 Expressions are constructed using a Lisp like syntax by instantiating an expression that yields a boolean,
-such as :meth:`~aerospike_helpers.expressions.base.Eq` or :meth:`~aerospike_helpers.expressions.base.And`, 
+such as :meth:`~aerospike_helpers.expressions.base.Eq` or :meth:`~aerospike_helpers.expressions.base.And`,
 while passing them other expressions and constants as arguments, and finally calling the :meth:`compile` method.
 
 Example::
@@ -65,7 +65,7 @@ For:
 The filtered out record's ``meta`` and ``bins`` are both set to :py:obj:`None` .
 
 For:
-  
+
   * :meth:`~aerospike.Client.batch_write` (records filtered out by a batch or batch record policy)
   * :meth:`~aerospike.Client.batch_operate` (records filtered out by a batch or batch write policy)
   * :meth:`~aerospike.Client.batch_apply` (records filtered out by a batch or batch apply policy)
@@ -90,7 +90,8 @@ When the following documentation says an expression returns a **list expression*
 it means that the expression returns a list during evaluation on the server side.
 
 Expressions used with :meth:`~aerospike_helpers.operations.expression_operations.expression_read`
-or :meth:`~aerospike_helpers.operations.expression_operations.expression_write` do send their return values to the client or write them to the server.
+or :meth:`~aerospike_helpers.operations.expression_operations.expression_write` do send their return values to the
+client or write them to the server.
 These expressions are called **operation expressions**.
 
 When these docs say that an expression parameter requires an integer or **integer expression**,

doc/aerospike_helpers.rst

@@ -4,7 +4,8 @@
 :mod:`aerospike\_helpers` --- Aerospike Helper Package for bin operations (list, map, bit, etc.)
 ************************************************************************************************
 
-This package contains helpers to be used by the operate and operate_ordered methods for bin operations. (list, map, bitwise, etc.)
+This package contains helpers to be used by the operate and operate_ordered methods for bin operations.
+(list, map, bitwise, etc.)
 
 .. automodule:: aerospike_helpers
     :members:
@@ -20,7 +21,3 @@ Subpackages
     aerospike_helpers.expressions
     aerospike_helpers.cdt_ctx
     aerospike_helpers.batch
-
-
-
-