Writing bits to a binary file

Question

I have 23 bits represented as a string, and I need to write this string to a binary file as 4 bytes. The last byte is always 0. The following code works (Python 3.3), but it doesn't feel very elegant (I'm rather new to Python and programming). Do you have any tips of making it better? It seems a for-loop might be useful, but how do I do the slicing within the loop without getting a IndexError? Note that that when I extract the bits into a byte, I reverse the bit-order.

from array import array

bin_array = array("B")
bits = "10111111111111111011110"    #Example string. It's always 23 bits
byte1 = bits[:8][::-1]
byte2 = bits[8:16][::-1]
byte3 = bits[16:][::-1]
bin_array.append(int(byte1, 2))
bin_array.append(int(byte2, 2))
bin_array.append(int(byte3, 2))
bin_array.append(0)

with open("test.bnr", "wb") as f:
    f.write(bytes(bin_array))

# Writes [253, 255, 61, 0] to the file

Jon Clements · Accepted Answer · 2014-01-19 18:46:42Z

19

You can treat it as an int, then create the 4 bytes as follows:

>>> bits = "10111111111111111011110"
>>> int(bits[::-1], 2).to_bytes(4, 'little')
b'\xfd\xff=\x00'

edited Jan 19, 2014 at 18:46

answered Jan 19, 2014 at 18:40

Jon Clements

143k34 gold badges254 silver badges288 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Olav Over a year ago

@Jon That is... amazing. Is it possbile to go the other way? Something like: int.from_bytes(b'\xfd\xff=\x00', 'little') and get "10111111111111111011110"

Jon Clements Over a year ago

@Olav, yup - format it appropriately: format(int.from_bytes(b'\xfd\xff=\x00', 'little'), '023b')[::-1]

ICW Over a year ago

This question gets asked a lot of times on this site, but this is the only reasonable solution out of any of the answers thank you

martineau Over a year ago

@YungGun: int.to_bytes() wasn't added to Python until version 3.2, so for compatibility with current and older versions of the language using the struct module, as shown in my answer, might be preferable since it will work in both Python 2.x and 3.x.

Jon Clements Over a year ago

@Kebman not really... see en.wikipedia.org/wiki/…

|

martineau · Accepted Answer · 2018-10-06 19:05:00Z

9

The struct module was designed for exactly this sort of thing — consider the following in which the conversion to bytes has been broken down into some unnecessary intermediate steps to make understanding it clearer:

import struct

bits = "10111111111111111011110"  # example string. It's always 23 bits
int_value = int(bits[::-1], base=2)
bin_array = struct.pack('i', int_value)
with open("test.bnr", "wb") as f:
    f.write(bin_array)

A harder-to-read, but shorter, way would be:

bits = "10111111111111111011110"  # example string. It's always 23 bits
with open("test.bnr", "wb") as f:
    f.write(struct.pack('i', int(bits[::-1], 2)))

edited Oct 6, 2018 at 19:05

answered Jan 19, 2014 at 19:10

martineau

124k29 gold badges181 silver badges319 bronze badges

Comments

Dmitry Vakhrushev · Accepted Answer · 2014-01-19 18:52:27Z

1

from array import array

bin_array = array("B")
bits = "10111111111111111011110"

bits = bits + "0" * (32 - len(bits))  # Align bits to 32, i.e. add "0" to tail
for index in range(0, 32, 8):
    byte = bits[index:index + 8][::-1]
    bin_array.append(int(byte, 2))

with open("test.bnr", "wb") as f:
    f.write(bytes(bin_array))

answered Jan 19, 2014 at 18:52

Dmitry Vakhrushev

1,3828 silver badges12 bronze badges

Comments

Paulo Bu · Accepted Answer · 2014-01-19 19:39:46Z

1

You can perform the split in one line using re.findall method:

>>>bits = "10111111111111111011110"
>>>import re
>>>re.findall(r'\d{1,8}', bits)
['10111111', '11111111', '1011110']

As an algorithm, you can pad bits to length 32 and then use re.findall method to group it in octects:

>>> bits
'10111111111111111011110000000000'
>>> re.findall(r'\d{8}', bits)
['10111111', '11111111', '10111100', '00000000']

Your code would be like this:

import re
from array import array

bin_array = array("B")
bits = "10111111111111111011110".ljust(32, '0')  # pad it to length 32

for octect in re.findall(r'\d{8}', bits): # split it in 4 octects
    bin_array.append(int(octect[::-1], 2)) # reverse them and append it

with open("test.bnr", "wb") as f:
    f.write(bytes(bin_array))

edited Jan 19, 2014 at 19:39

answered Jan 19, 2014 at 19:18

Paulo Bu

29.9k6 gold badges77 silver badges74 bronze badges

1 Comment

Jon Clements Over a year ago

The padding would be more explicit as bits = "10111111111111111011110".ljust(32, '0')

Collectives™ on Stack Overflow

Writing bits to a binary file

4 Answers 4

6 Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

6 Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related