Module utils

Functions

▶ def frame_split_size(frame, n=BIG_BYTES_SHARD_SIZE) -> list
Split a frame into a list of frames of maximum size
source link
```
This helps us to avoid passing around very large bytestrings.
```
Examples
```
>>> frame_split_size([b'12345', b'678'], n=3)  # doctest: +SKIP
[b'123', b'45', b'678']
```
Reexports
- Imported in distributed.protocol.core.
- Imported in distributed.protocol.serialize.
▶ def merge_frames(header, frames)
Merge frames into original lengths
source link
Examples
```
>>> merge_frames({'lengths': [3, 3]}, [b'123456'])
[b'123', b'456']
>>> merge_frames({'lengths': [6]}, [b'123', b'456'])
[b'123456']
```
Reexports
- Imported in distributed.protocol.core.
- Imported in distributed.protocol.serialize.
- Imported in distributed.protocol.tests.test_protocol_utils.
▶ def pack_frames(frames)
Pack frames into a byte-like object
source link
```
This prepends length information to the front of the bytes-like object
```
See also
```
unpack_frames
```
Reexports
- Imported in distributed.protocol.tests.test_protocol_utils.
▶ def pack_frames_prelude(frames)
source link
Reexports
- Imported in distributed.protocol.serialize.
▶ def unpack_frames(b)
Unpack bytes into a sequence of frames
source link
```
This assumes that length information is at the front of the bytestring,
as performed by pack_frames
```
See also
```
pack_frames
```
Reexports
- Imported in distributed.protocol.serialize.
- Imported in distributed.protocol.tests.test_protocol_utils.