Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pre-commit.ci] pre-commit autoupdate #2050

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ repos:
additional_dependencies:
- ruff
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.18 # Use the ref you want to point at
rev: 0.7.19 # Use the ref you want to point at
hooks:
- id: mdformat
# Optionally add plugins
Expand All @@ -26,7 +26,7 @@ repos:

# autoformat and lint Python code
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.7.2
rev: v0.8.1
hooks:
- id: ruff
types_or:
Expand Down
42 changes: 21 additions & 21 deletions docs/source/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ but since libzmq sockets themselves aren't threadsafe, pyzmq sockets should stil

### 26.0.1

- Fix install from source with cmake \< 3.21
- Fix install from source with cmake < 3.21

### 26.0.0

Expand Down Expand Up @@ -119,7 +119,7 @@ Changes:
Bugs fixed:

- Fix builds on Solaris by including generated platform.hpp
- Cleanup futures in `Socket.poll()` that are cancelled and never return
- Cleanup futures in `Socket.poll()` that are cancelled and never return
- Fix builds with `-j` when numpy is present in the build env

### 25.1.0
Expand Down Expand Up @@ -390,7 +390,7 @@ Code changes from 21.0 are minimal.

pyzmq-21.0.1 only changes CI configuration for Windows wheels (built with VS2017 instead of VS2019),
fixing compatibility with some older Windows on all Pythons
and removing requirement of VC++ redistributable package on latest Windows and Python \< 3.8.
and removing requirement of VC++ redistributable package on latest Windows and Python < 3.8.

There still appears to be a compatibility issue with Windows 7 that will be fixed ASAP.
Until then, you can pin `pip install pyzmq<21`.
Expand Down Expand Up @@ -451,7 +451,7 @@ but there are only small changes for users with relatively recent versions of Py
Packaging updates:

- Update bundled libzmq to 4.3.3
- Drop support for Python \< 3.5 (all versions of Python \< 3.6 are EOL at time of release)
- Drop support for Python < 3.5 (all versions of Python < 3.6 are EOL at time of release)
- Require setuptools to build from source
- Require Cython 0.29 to build from version control (sdists still ship .c files, so will never need Cython)
- Respect \$PKG_CONFIG env for finding libzmq when building from source
Expand Down Expand Up @@ -664,7 +664,7 @@ PyZMQ 15 adds Future-returning sockets and pollers for both {mod}`asyncio` and {

- add {mod}`asyncio` support via {mod}`zmq.asyncio`
- add {mod}`tornado.concurrent` future support via {mod}`zmq.eventloop.future`
- trigger bundled libzmq if system libzmq is found to be \< 3.
- trigger bundled libzmq if system libzmq is found to be < 3.
System libzmq 2 can be forced by explicitly requesting `--zmq=/prefix/`.

## 14.7.0
Expand Down Expand Up @@ -746,7 +746,7 @@ pyzmq-14.3.1 is the last version to include bdists for Python 3.3

Minor bugfixes to pyzmq 14.3:

- Fixes to building bundled libzmq on OS X \< 10.9
- Fixes to building bundled libzmq on OS X < 10.9
- Fixes to import-failure warnings on Python 3.4
- Fixes to tests
- Pull upstream fixes to zmq.ssh for ssh multiplexing
Expand Down Expand Up @@ -838,7 +838,7 @@ Bugfix release

The main new feature is improved tornado 3 compatibility.
PyZMQ ships a 'minitornado' submodule, which contains a small subset of tornado 3.0.1,
in order to get the IOLoop base class. zmq.eventloop.ioloop.IOLoop is now a simple subclass,
in order to get the IOLoop base class. zmq.eventloop.ioloop.IOLoop is now a simple subclass,
and if the system tornado is ≥ 3.0, then the zmq IOLoop is a proper registered subclass
of the tornado one itself, and minitornado is entirely unused.

Expand Down Expand Up @@ -900,7 +900,7 @@ This means that subclasses of these classes that require extra attributes

- Implementation splits core Cython bindings from pure-Python subclasses
with sugar methods (send/recv_multipart). This should facilitate
non-Cython backends and PyPy support \[spoiler: it did!\].
non-Cython backends and PyPy support [spoiler: it did!].

### Bugs Fixed

Expand All @@ -923,9 +923,9 @@ and may be removed or changed in incompatible ways in later releases.
#### Threadsafe ZMQStream

With the IOLoop inherited from tornado, there is exactly one method that is threadsafe:
{meth}`~.tornado.ioloop.IOLoop.add_callback`. With this release, we are trying an experimental option
{meth}`~.tornado.ioloop.IOLoop.add_callback`. With this release, we are trying an experimental option
to pass all IOLoop calls via this method, so that ZMQStreams can be used from one thread
while the IOLoop runs in another. To try out a threadsafe stream:
while the IOLoop runs in another. To try out a threadsafe stream:

```python
stream = ZMQStream(socket, threadsafe=True)
Expand Down Expand Up @@ -959,7 +959,7 @@ subclass which provides [gevent](https://www.gevent.org/) compatibility has been
## 2.2.0

Some effort has gone into refining the pyzmq API in this release to make it a model for
other language bindings. This is principally made in a few renames of objects and methods,
other language bindings. This is principally made in a few renames of objects and methods,
all of which leave the old name for backwards compatibility.

```{note}
Expand All @@ -970,12 +970,12 @@ possible), to allow more permissive use of less-critical code and utilities.
### Name Changes

- The `Message` class has been renamed to {class}`~.Frame`, to better match other
zmq bindings. The old Message name remains for backwards-compatibility. Wherever pyzmq
zmq bindings. The old Message name remains for backwards-compatibility. Wherever pyzmq
docs say "Message", they should refer to a complete zmq atom of communication (one or
more Frames, connected by ZMQ_SNDMORE). Please report any remaining instances of
Message==MessagePart with an Issue (or better yet a Pull Request).
- All `foo_unicode` methods are now called `foo_string` (`_unicode` remains for
backwards compatibility). This is not only for cross-language consistency, but it makes
backwards compatibility). This is not only for cross-language consistency, but it makes
more sense in Python 3, where native strings are unicode, and the `_unicode` suffix
was wedded too much to Python 2.

Expand All @@ -988,15 +988,15 @@ possible), to allow more permissive use of less-critical code and utilities.
- Python 2.5 compatibility has been dropped, and some code has been cleaned up to reflect
no-longer-needed hacks.
- Some Cython files in `zmq.core` have been split, to reduce the amount of
Cython-compiled code. Much of the body of these files were pure Python, and thus did
not benefit from the increased compile time. This change also aims to ease maintaining
Cython-compiled code. Much of the body of these files were pure Python, and thus did
not benefit from the increased compile time. This change also aims to ease maintaining
feature parity in other projects, such as
[pyzmq-ctypes](https://github.com/svpcom/pyzmq-ctypes).

### New Stuff

- {class}`~.zmq.Context` objects can now set default options when they create a socket. These
are set and accessed as attributes to the context. Socket options that do not apply to a
are set and accessed as attributes to the context. Socket options that do not apply to a
socket (e.g. SUBSCRIBE on non-SUB sockets) will simply be ignored.
- {meth}`~.ZMQStream.on_recv_stream` has been added, which adds the stream itself as a
second argument to the callback, making it easier to use a single callback on multiple
Expand All @@ -1014,7 +1014,7 @@ set in stone, and may be removed or changed in incompatible ways in later releas

## 2.1.11

- remove support for LABEL prefixes. A major feature of libzmq-3.0, the LABEL
- remove support for LABEL prefixes. A major feature of libzmq-3.0, the LABEL
prefix, has been removed from libzmq, prior to the first stable libzmq 3.x release.

- The prefix argument to {meth}`~.zmq.Socket.send_multipart` remains, but it continue to behave in
Expand All @@ -1024,9 +1024,9 @@ set in stone, and may be removed or changed in incompatible ways in later releas

- add {meth}`.zmq.Socket.poll` method, for simple polling of events on a single socket.

- no longer require monkeypatching tornado IOLoop. The `ioloop.ZMQPoller` class
- no longer require monkeypatching tornado IOLoop. The `ioloop.ZMQPoller` class
is a poller implementation that matches tornado's expectations, and pyzmq sockets can
be used with any tornado application just by specifying the use of this poller. The
be used with any tornado application just by specifying the use of this poller. The
pyzmq IOLoop implementation now only trivially differs from tornado's.

It is still recommended to use `ioloop.install()`, which sets *both* the zmq and
Expand Down Expand Up @@ -1078,7 +1078,7 @@ set in stone, and may be removed or changed in incompatible ways in later releas
- added zmq.ssh tools for tunneling socket connections, copied from IPython
- Expanded sockopt support to cover changes in libzmq-4.0 dev.
- Fixed an issue that prevented {exc}`KeyboardInterrupt` from being catchable.
- Added attribute-access for set/getsockopt. Setting/Getting attributes of {class}`~.zmq.Socket`s
- Added attribute-access for set/getsockopt. Setting/Getting attributes of {class}`~.zmq.Socket`s
with the names of socket options is mapped to calls of set/getsockopt.

```python
Expand All @@ -1099,7 +1099,7 @@ s.linger

## 2.1.7.1

- bdist for 64b Windows only. This fixed a type mismatch on the `ZMQ_FD` sockopt
- bdist for 64b Windows only. This fixed a type mismatch on the `ZMQ_FD` sockopt
that only affected that platform.

## 2.1.7
Expand Down
2 changes: 1 addition & 1 deletion docs/source/howto/eventloop.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ by restoring either callback.
#### {meth}`~.ZMQStream.on_recv_stream`

{meth}`.ZMQStream.on_recv_stream` is just like on_recv above, but the callback will be
passed both the message and the stream, rather than just the message. This is meant to make
passed both the message and the stream, rather than just the message. This is meant to make
it easier to use a single callback with multiple streams.

```python
Expand Down
2 changes: 1 addition & 1 deletion docs/source/howto/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ logger.info('hello world!')
```

You can use this module's built-in command line interface to "tune in" to
messages broadcast by the log handler. To start the log watcher,
messages broadcast by the log handler. To start the log watcher,
run this command from a shell that has access to the pyzmq package
(usually a virtual environment):

Expand Down
4 changes: 2 additions & 2 deletions docs/source/howto/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can protect your sockets by e.g.:
## Using your own serialization

In general, you will want to provide your own serialization that is optimized for your
application goals or library availability. This may include using your own preferred
application goals or library availability. This may include using your own preferred
serialization such as [msgpack] or [msgspec],
or adding compression via {py:mod}`zlib` in the standard library,
or the super fast [blosc] library.
Expand Down Expand Up @@ -133,7 +133,7 @@ def recv_signed_zipped_pickle(socket, flags=0, *, key):

### Example: numpy arrays

A common data structure in Python is the numpy array. PyZMQ supports sending
A common data structure in Python is the numpy array. PyZMQ supports sending
numpy arrays without copying any data, since they provide the Python buffer interface.
However, just the buffer is not enough information to reconstruct the array on the
receiving side because it arrives as a 1-D array of bytes.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/howto/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ So once you have established the tunnel, connections to `localip:localport` will
be connections to `remoteip:remoteport`.

In most cases, you have a zeromq url for a remote machine, but you need to tunnel the
connection through an ssh server. This is
connection through an ssh server. This is

So if you would use this command from the same LAN as the remote machine:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ General questions about ØMQ are better sent to the [ØMQ tracker] or [mailing l
# Supported LibZMQ

PyZMQ aims to support all stable (≥ 3.2.2, ≥ 4.0.1 )
versions of libzmq. Building the same pyzmq against various versions of libzmq is supported,
versions of libzmq. Building the same pyzmq against various versions of libzmq is supported,
but only the functionality of the linked libzmq will be available.

```{note}
Expand Down
Loading