Merge pull request #79 from azmeuk/pre-commit

pre-commit and linters configuration

Author: simon-weber

.github/workflows/tests.yaml

@@ -41,3 +41,9 @@ jobs:
       - run: make -C libfaketime/vendor/libfaketime
         if: runner.os == 'macOS'
       - run: tox -e ${{ matrix.python }}-${{ matrix.tz }} --recreate
+
+  style:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+---
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.4.3'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-toml
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter

LICENSE

@@ -337,4 +337,3 @@ proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.
-

benchmark.py

@@ -2,9 +2,10 @@
 import sys
 import time
 
+from freezegun import freeze_time as freezegun_fake_time
+
 from libfaketime import fake_time as lft_fake_time
 from libfaketime import reexec_if_needed
-from freezegun import freeze_time as freezegun_fake_time
 
 
 def sample(faker):
@@ -17,20 +18,20 @@ def sample(faker):
 
     return time.perf_counter() - start
 
-if __name__ == '__main__':
 
-    if len(sys.argv) > 1 and sys.argv[1] == 'freezegun':
+if __name__ == "__main__":
+    if len(sys.argv) > 1 and sys.argv[1] == "freezegun":
         faker = freezegun_fake_time
     else:
         faker = lft_fake_time
         reexec_if_needed()
 
     iterations = 1000
 
-    print("timing %s executions of %s" % (iterations, faker))
+    print(f"timing {iterations} executions of {faker}")
 
     sum = 0
     for _ in range(iterations):
         sum += sample(faker)
 
-    print(sum, 'seconds')
+    print(sum, "seconds")

conftest.py

@@ -1,6 +1,8 @@
 import os
+
 import libfaketime
 
+
 def pytest_configure():
     libfaketime.reexec_if_needed()
     _, env_additions = libfaketime.get_reload_information()