Add pre-commit setup

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-json
+        exclude: "^asv.conf.json$"
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        types: [file, python]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier
+        exclude: "^asv.conf.json$"

CONTRIBUTING.md

@@ -39,6 +39,17 @@ easier to validate it.
 
 ## Pull requests
 
+### Linting your code
+
+Before commiting anything, install the pre-commit hooks:
+
+```shell
+python3 -m pip install -r requirements-extra.txt
+pre-commit install
+```
+
+This will ensure that your contribution passes our linting checks.
+
 ### PRs should be linked to a GitHub issue
 
 Before opening a pull request to this repository, first please make sure there is a GitHub issue

MANIFEST.in

@@ -30,6 +30,7 @@ include webpack.config.js
 include NEWS.rst
 include .flake8
 include src/memray/py.typed
+include .pre-commit-config.yaml
 
 recursive-include src/vendor *
 recursive-include src/memray *.py

README.md

@@ -102,6 +102,14 @@ python3 -m pip install -e . -r requirements-test.txt -r requirements-extra.txt
 
 This will install Memray in the virtual environment in development mode (the `-e` of the last `pip install` command).
 
+If you plan to contribute back, you should install the pre-commit hooks:
+
+```shell
+pre-commit install
+```
+
+This will ensure that your contribution passes our linting checks.
+
 # Documentation
 
 You can find the latest documentation available [here](https://bloomberg.github.io/memray/).

requirements-extra.txt

@@ -5,4 +5,5 @@ mypy
 bump2version
 towncrier
 check-manifest
+pre-commit
 -r requirements-docs.txt

src/memray/_memray_test_utils.pyx

@@ -162,7 +162,7 @@ cdef class PymallocMemoryAllocator:
             self.ptr = PyObject_Malloc(size)
         else:
             raise RuntimeError("Invlid pymalloc domain")
- 
+
         return self.ptr != NULL
 
     @cython.profile(True)
@@ -175,7 +175,7 @@ cdef class PymallocMemoryAllocator:
             self.ptr = PyObject_Calloc(1, size)
         else:
             raise RuntimeError("Invlid pymalloc domain")
- 
+
         return self.ptr != NULL
 
     @cython.profile(True)
@@ -188,7 +188,7 @@ cdef class PymallocMemoryAllocator:
             self.ptr = PyObject_Realloc(self.ptr, size)
         else:
             raise RuntimeError("Invlid pymalloc domain")
- 
+
         return self.ptr != NULL
 
 cdef do_not_optimize_ptr(void* ptr):