Skip to content

Commit 814a9de

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent d38c98c commit 814a9de

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

docs/source/changelog.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ but since libzmq sockets themselves aren't threadsafe, pyzmq sockets should stil
4949

5050
### 26.0.1
5151

52-
- Fix install from source with cmake \< 3.21
52+
- Fix install from source with cmake < 3.21
5353

5454
### 26.0.0
5555

@@ -119,7 +119,7 @@ Changes:
119119
Bugs fixed:
120120

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

125125
### 25.1.0
@@ -390,7 +390,7 @@ Code changes from 21.0 are minimal.
390390

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

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

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

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

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

747747
Minor bugfixes to pyzmq 14.3:
748748

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

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

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

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

905905
### Bugs Fixed
906906

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

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

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

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

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

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

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

996996
### New Stuff
997997

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

10151015
## 2.1.11
10161016

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

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

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

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

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

10841084
```python
@@ -1099,7 +1099,7 @@ s.linger
10991099

11001100
## 2.1.7.1
11011101

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

11051105
## 2.1.7

docs/source/howto/eventloop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ by restoring either callback.
9393
#### {meth}`~.ZMQStream.on_recv_stream`
9494

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

9999
```python

docs/source/howto/logging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ logger.info('hello world!')
5757
```
5858

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

docs/source/howto/serialization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can protect your sockets by e.g.:
3636
## Using your own serialization
3737

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

134134
### Example: numpy arrays
135135

136-
A common data structure in Python is the numpy array. PyZMQ supports sending
136+
A common data structure in Python is the numpy array. PyZMQ supports sending
137137
numpy arrays without copying any data, since they provide the Python buffer interface.
138138
However, just the buffer is not enough information to reconstruct the array on the
139139
receiving side because it arrives as a 1-D array of bytes.

docs/source/howto/ssh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ So once you have established the tunnel, connections to `localip:localport` will
2828
be connections to `remoteip:remoteport`.
2929

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

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

docs/source/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ General questions about ØMQ are better sent to the [ØMQ tracker] or [mailing l
2121
# Supported LibZMQ
2222

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

2727
```{note}

0 commit comments

Comments
 (0)