Merge pull request #1969 from minrk/ruff

switch to ruff for lint/format

.flake8

@@ -1,3 +1,5 @@
+# flake8 no longer used,
+# ruff config in pyproject.toml
 [flake8]
 exclude = .git,dist,docs,zmq/eventloop/minitornado,buildutils/templates
 ignore = E,W

.gitignore

@@ -48,3 +48,4 @@ _deps
 /Makefile
 _src
 licenses
+.virtual_documents

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
         language: python
         pass_filenames: false
         additional_dependencies:
-          - black
+          - ruff
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.17  # Use the ref you want to point at
     hooks:
@@ -24,19 +24,24 @@ repos:
           - mdformat-myst
         exclude: LICENSE.md
 
-  - repo: https://github.com/PyCQA/autoflake
-    rev: v2.3.1
-    hooks:
-      - id: autoflake
-        args:
-          - --in-place
-        exclude: zmq/tests/test_imports.py
+  # autoformat and lint Python code
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.2
+    hooks:
+      - id: ruff
+        types_or:
+          - python
+          - jupyter
+          - pyi
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+        types_or:
+          - python
+          - jupyter
+          - pyi
+        # don't format zmq/constants.py twice
+        exclude: zmq/constants.py
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
-        exclude: ^buildutils/templates/
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.9.0
     hooks:
@@ -49,29 +54,6 @@ repos:
         args: [zmq]
         additional_dependencies:
           - types-paramiko
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
-    hooks:
-      - id: pyupgrade
-        args:
-          - --py36-plus
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        name: isort (python)
-      - id: isort
-        name: isort (cython)
-        types: [cython]
-      - id: isort
-        name: isort (pyi)
-        types: [pyi]
-  - repo: https://github.com/psf/black
-    rev: 24.3.0
-    hooks:
-      - id: black
-        # don't run black twice on constants.py
-        exclude: zmq/constants.py
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:

RELICENSE/authors.py

@@ -82,15 +82,5 @@ def sort_key(email_commits):
             commits[0].authored_datetime.year,
         )
     else:
-        msg = "{commits} commits ({start}-{end})".format(
-            commits=len(commits),
-            start=commits[-1].authored_datetime.year,
-            end=commits[0].authored_datetime.year,
-        )
-    print(
-        "- [ ] {name} {email}: {msg}".format(
-            name=email_names[email],
-            email=email,
-            msg=msg,
-        )
-    )
+        msg = f"{len(commits)} commits ({commits[-1].authored_datetime.year}-{commits[0].authored_datetime.year})"
+    print(f"- [ ] {email_names[email]} {email}: {msg}")

buildutils/constants.py

@@ -25,7 +25,7 @@
 root = pjoin(buildutils, os.path.pardir)
 
 sys.path.insert(0, pjoin(root, 'zmq'))
-import constants
+import constants  # noqa: E402
 
 all_names = []
 for name in constants.__all__:
@@ -49,7 +49,7 @@ def cython_enums():
     lines = []
     for name in all_names:
         if no_prefix(name):
-            lines.append('enum: ZMQ_{0} "{0}"'.format(name))
+            lines.append(f'enum: ZMQ_{name} "{name}"')
         else:
             lines.append(f'enum: ZMQ_{name}')
 
@@ -112,7 +112,7 @@ def generate_file(fname, ns_func, dest_dir="."):
     with open(dest, 'w') as f:
         f.write(out)
     if fname.endswith(".py"):
-        run([sys.executable, "-m", "black", dest])
+        run(["ruff", "format", dest])
 
 
 def render_constants():

docs/source/conf.py

@@ -19,7 +19,7 @@
 sys.path.append(str(repo_root))
 
 # set target libzmq version
-from buildutils.bundle import bundled_version
+from buildutils.bundle import bundled_version  # noqa
 
 # remove repo root from sys.path
 sys.path = sys.path[:-1]

examples/asyncio/helloworld_pubsub_dealerrouter.py

@@ -195,11 +195,7 @@ async def lang_changer_router(self) -> None:
                 )
 
                 self.hello_world.change_language()
-                print(
-                    "Changed language! New language is: {}\n".format(
-                        self.hello_world.lang
-                    )
-                )
+                print(f"Changed language! New language is: {self.hello_world.lang}\n")
 
         except Exception as e:
             print("Error with sub world")

examples/device/device.py

@@ -3,7 +3,6 @@
 # This example is placed in the Public Domain
 # It may also be used under the Creative Commons CC-0 License, (C) PyZMQ Developers
 
-
 import time
 from threading import Thread
 

examples/eventloop/echostream.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
-"""Adapted echo.py to put the send in the event loop using a ZMQStream.
-"""
+"""Adapted echo.py to put the send in the event loop using a ZMQStream."""
+
 from typing import List
 
 from tornado import ioloop

examples/pubsub/subscriber.py

@@ -10,7 +10,6 @@
 #  the file LICENSE.BSD, distributed as part of this software.
 # -----------------------------------------------------------------------------
 
-
 import sys
 import time
 

examples/security/asyncio-ironhouse.py

@@ -98,9 +98,7 @@ async def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

examples/security/generate_certificates.py

@@ -55,9 +55,7 @@ def generate_certificates(base_dir: Union[str, os.PathLike]) -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     generate_certificates(os.path.dirname(__file__))

examples/security/grasslands.py

@@ -3,10 +3,10 @@
 '''
 No protection at all.
 
-All connections are accepted, there is no authentication, and no privacy. 
+All connections are accepted, there is no authentication, and no privacy.
 
-This is how ZeroMQ always worked until we built security into the wire 
-protocol in early 2013. Internally, it uses a security mechanism called 
+This is how ZeroMQ always worked until we built security into the wire
+protocol in early 2013. Internally, it uses a security mechanism called
 "NULL".
 
 Author: Chris Laws

examples/security/ioloop-ironhouse.py

@@ -121,9 +121,7 @@ async def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

examples/security/ironhouse.py

@@ -89,9 +89,7 @@ def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

examples/security/stonehouse.py

@@ -88,9 +88,7 @@ def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

examples/security/strawhouse.py

@@ -83,9 +83,7 @@ def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

examples/security/woodhouse.py

@@ -79,9 +79,7 @@ def run() -> None:
 if __name__ == '__main__':
     if zmq.zmq_version_info() < (4, 0):
         raise RuntimeError(
-            "Security is not supported in libzmq version < 4.0. libzmq version {}".format(
-                zmq.zmq_version()
-            )
+            f"Security is not supported in libzmq version < 4.0. libzmq version {zmq.zmq_version()}"
         )
 
     if '-v' in sys.argv:

perf/Dockerfile

@@ -1,9 +1,9 @@
-FROM python:3.6
-RUN pip install pandas cython
-RUN pip install -vv https://github.com/zeromq/pyzmq/archive/master.tar.gz --install-option=--zmq=bundled
+FROM python:3.11
+RUN pip install pandas
+RUN pip install --pre pyzmq
 RUN mkdir /data && mkdir /perf
 ADD *.py /perf/
 
 WORKDIR /data
-ENTRYPOINT ["python", "/perf/collect.py"]
+ENTRYPOINT ["python3", "/perf/collect.py"]
 CMD ["thr"]

perf/Makefile

@@ -1,8 +1,8 @@
-BASE_IMAGE=python:3.6
+BASE_IMAGE=python:3.11
 IMAGE=pyzmq-perf
 VOLUME=pyzmq-perf
 
-ifeq ($(DOCKER_MACHINE_NAME), "")
+ifeq ("$(DOCKER_MACHINE_NAME)", "")
 	OUT_PATH=$(PWD)
 	FETCH=true
 else