bitstruct-3.1.0/0000775000175000017500000000000012676404012013450 5ustar erikerik00000000000000bitstruct-3.1.0/bitstruct.egg-info/0000775000175000017500000000000012676404012017165 5ustar erikerik00000000000000bitstruct-3.1.0/bitstruct.egg-info/top_level.txt0000664000175000017500000000001212676404012021710 0ustar erikerik00000000000000bitstruct bitstruct-3.1.0/bitstruct.egg-info/SOURCES.txt0000664000175000017500000000044312676404012021052 0ustar erikerik00000000000000LICENSE MANIFEST.in Makefile README.rst bitstruct.py setup.py bitstruct.egg-info/PKG-INFO bitstruct.egg-info/SOURCES.txt bitstruct.egg-info/dependency_links.txt bitstruct.egg-info/top_level.txt docs/Makefile docs/conf.py docs/index.rst docs/make.bat tests/__init__.py tests/test_bitstruct.pybitstruct-3.1.0/bitstruct.egg-info/dependency_links.txt0000664000175000017500000000000112676404012023233 0ustar erikerik00000000000000 bitstruct-3.1.0/bitstruct.egg-info/PKG-INFO0000664000175000017500000001001412676404012020256 0ustar erikerik00000000000000Metadata-Version: 1.1 Name: bitstruct Version: 3.1.0 Summary: This module performs conversions between Python values and C bit field structs represented as Python byte strings. Home-page: https://github.com/eerimoq/bitstruct Author: Erik Moqvist, Ilya Petukhov Author-email: erik.moqvist@gmail.com License: MIT Description: |buildstatus|_ About ===== This module is intended to have a similar interface as the python struct module, but working on bits instead of primitive data types (char, int, ...). Documentation: http://bitstruct.readthedocs.org/en/latest Installation ============ .. code-block:: python pip install bitstruct Example usage ============= See the test suite: https://github.com/eerimoq/bitstruct/blob/master/tests/test_bitstruct.py A basic example of packing/unpacking four integers: .. code-block:: python >>> from bitstruct import * >>> pack('u1u3u4s16', 1, 2, 3, -4) b'\xa3\xff\xfc' >>> unpack('u1u3u4s16', b'\xa3\xff\xfc') (1, 2, 3, -4) >>> calcsize('u1u3u4s16') 24 The unpacked fields can be named by assigning them to variables or by wrapping the result in a named tuple: .. code-block:: python >>> from bitstruct import * >>> from collections import namedtuple >>> MyName = namedtuple('myname', [ 'a', 'b', 'c', 'd' ]) >>> unpacked = unpack('u1u3u4s16', b'\xa3\xff\xfc') >>> myname = MyName(*unpacked) >>> myname myname(a=1, b=2, c=3, d=-4) >>> myname.c 3 An example of packing/unpacking a unsinged integer, a signed integer, a float, a boolean and a byte string: .. code-block:: python >>> from bitstruct import * >>> pack('u5s5f32b1r13', 1, -1, 3.75, True, b'\xff\xff') b'\x0f\xd0\x1c\x00\x00?\xff' >>> unpack('u5s5f32b1r13', b'\x0f\xd0\x1c\x00\x00?\xff') (1, -1, 3.75, True, b'\xff\xf8') >>> calcsize('u5s5f32b1r13') 56 The same format and values as in the previous example, but using LSB (Least Significant Bit) first instead of the default MSB (Most Significant Bit) first: .. code-block:: python >>> from bitstruct import * >>> pack('>> unpack('>> calcsize('>> from bitstruct import * >>> unpack('s17s13r24', '0123456789abcdef'.decode('hex')) (582, -3751, b'\xe2j\xf3') >>> with open("test.bin", "rb") as fin: ... unpack('s17s13r24', fin.read(8)) ... ... (582, -3751, b'\xe2j\xf3') Change endianness of the data with byteswap(), and then unpack the values: .. code-block:: python >>> from bitstruct import * >>> packed = pack('u1u3u4s16', 1, 2, 3, 1) >>> unpack('u1u3u4s16', byteswap('12', packed)) (1, 2, 3, 256) .. |buildstatus| image:: https://travis-ci.org/eerimoq/bitstruct.svg .. _buildstatus: https://travis-ci.org/eerimoq/bitstruct Keywords: bit field,bit parsing,bit unpack,bit pack Platform: UNKNOWN Classifier: License :: OSI Approved :: MIT License Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 3 bitstruct-3.1.0/setup.cfg0000664000175000017500000000007312676404012015271 0ustar erikerik00000000000000[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 bitstruct-3.1.0/tests/0000775000175000017500000000000012676404012014612 5ustar erikerik00000000000000bitstruct-3.1.0/tests/__init__.py0000664000175000017500000000000012640301107016701 0ustar erikerik00000000000000bitstruct-3.1.0/tests/test_bitstruct.py0000664000175000017500000001337312676315510020261 0ustar erikerik00000000000000import unittest from bitstruct import * class BitStructTest(unittest.TestCase): def test_pack(self): """Pack values. """ packed = pack('u1u1s6u7u9', 0, 0, -2, 65, 22) self.assertEqual(packed, b'\x3e\x82\x16') packed = pack('u1', 1) self.assertEqual(packed, b'\x80') packed = pack('u77', 0x100000000001000000) ref = b'\x00\x80\x00\x00\x00\x00\x08\x00\x00\x00' self.assertEqual(packed, ref) packed = pack('p1u1s6u7u9', 0, -2, 65, 22) self.assertEqual(packed, b'\x3e\x82\x16') packed = pack('p1u1s6p7u9', 0, -2, 22) self.assertEqual(packed, b'\x3e\x00\x16') packed = pack('u1s6f32r43', 0, -2, 3.75, b'\x00\xff\x00\xff\x00\xff') self.assertEqual(packed, b'\x7c\x80\xe0\x00\x00\x01\xfe\x01\xfe\x01\xc0') packed = pack('b1', True) self.assertEqual(packed, b'\x80') packed = pack('b1p6b1', True, True) self.assertEqual(packed, b'\x81') packed = pack('u5b2u1', -1, False, 1) self.assertEqual(packed, b'\xf9') def test_unpack(self): """Unpack values. """ unpacked = unpack('u1u1s6u7u9', b'\x3e\x82\x16') self.assertEqual(unpacked, (0, 0, -2, 65, 22)) unpacked = unpack('u1', bytearray(b'\x80')) self.assertEqual(unpacked, (1,)) packed = b'\x00\x80\x00\x00\x00\x00\x08\x00\x00\x00' unpacked = unpack('u77', packed) self.assertEqual(unpacked, (0x100000000001000000,)) packed = b'\x3e\x82\x16' unpacked = unpack('p1u1s6u7u9', packed) self.assertEqual(unpacked, (0, -2, 65, 22)) packed = b'\x3e\x82\x16' unpacked = unpack('p1u1s6p7u9', packed) self.assertEqual(unpacked, (0, -2, 22)) packed = b'\x7c\x80\xe0\x00\x00\x01\xfe\x01\xfe\x01\xc0' unpacked = unpack('u1s6f32r43', packed) self.assertEqual(unpacked, (0, -2, 3.75, b'\x00\xff\x00\xff\x00\xe0')) packed = [0x80] unpacked = unpack('b1', packed) self.assertEqual(unpacked, (True,)) packed = b'\x80' unpacked = unpack('b1p6b1', packed) self.assertEqual(unpacked, (True, False)) packed = b'\x06' unpacked = unpack('u5b2u1', packed) self.assertEqual(unpacked, (0, True, 0)) packed = b'\x04' unpacked = unpack('u5b2u1', packed) self.assertEqual(unpacked, (0, True, 0)) # bad float size try: unpack('f33', b'\x00\x00\x00\x00\x00') self.fail() except ValueError: pass # gcc packed struct with bitfields # # struct foo_t { # int a; # char b; # uint32_t c : 7; # uint32_t d : 25; # } foo; # # foo.a = 1; # foo.b = 1; # foo.c = 0x67; # foo.d = 0x12345; unpacked = unpack('s32s8u25u7', byteswap('414', b'\x01\x00\x00\x00\x01\xe7\xa2\x91\x00')) self.assertEqual(unpacked, (1, 1, 0x12345, 0x67)) def test_pack_unpack(self): """Pack and unpack values. """ packed = pack('u1u1s6u7u9', 0, 0, -2, 65, 22) unpacked = unpack('u1u1s6u7u9', packed) self.assertEqual(unpacked, (0, 0, -2, 65, 22)) packed = pack('f64', 1.0) unpacked = unpack('f64', packed) self.assertEqual(unpacked, (1.0, )) def test_calcsize(self): """Calculate size. """ size = calcsize('u1u1s6u7u9') self.assertEqual(size, 24) size = calcsize('u1') self.assertEqual(size, 1) size = calcsize('u77') self.assertEqual(size, 77) size = calcsize('u1s6u7u9') self.assertEqual(size, 23) size = calcsize('b1s6u7u9') self.assertEqual(size, 23) def test_byteswap(self): """Byte swap. """ res = b'\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a' ref = b'\x01\x03\x02\x04\x08\x07\x06\x05\x0a\x09' self.assertEqual(byteswap('12142', ref), res) packed = pack('u1u5u2u16', 1, 2, 3, 4) unpacked = unpack('u1u5u2u16', byteswap('12', packed)) self.assertEqual(unpacked, (1, 2, 3, 1024)) def test_endianness(self): """Test pack/unpack with endianness information in the format string. """ # big endian ref = b'\x02\x46\x9a\xfe\x00\x00\x00' packed = pack('>u19s3f32', 0x1234, -2, -1.0) self.assertEqual(packed, ref) unpacked = unpack('>u19s3f32', packed) self.assertEqual(unpacked, (0x1234, -2, -1.0)) # little endian ref = b'\x2c\x48\x0c\x00\x00\x07\xf4' packed = pack('u19f64r3p4', 1, -2, 1.0, b'\x80') self.assertEqual(packed, ref) unpacked = unpack('>u19f64r3p4', packed) self.assertEqual(unpacked, (1, -2, 1.0, b'\x80')) # opposite endianness of the 'mixed endianness' test ref = b'\x80\x00\x1e\x00\x00\x00\x00\x00\x00\x0f\xfc\x20' packed = pack('s5s5>> from bitstruct import * >>> pack('u1u3u4s16', 1, 2, 3, -4) b'\xa3\xff\xfc' >>> unpack('u1u3u4s16', b'\xa3\xff\xfc') (1, 2, 3, -4) >>> calcsize('u1u3u4s16') 24 The unpacked fields can be named by assigning them to variables or by wrapping the result in a named tuple: .. code-block:: python >>> from bitstruct import * >>> from collections import namedtuple >>> MyName = namedtuple('myname', [ 'a', 'b', 'c', 'd' ]) >>> unpacked = unpack('u1u3u4s16', b'\xa3\xff\xfc') >>> myname = MyName(*unpacked) >>> myname myname(a=1, b=2, c=3, d=-4) >>> myname.c 3 An example of packing/unpacking a unsinged integer, a signed integer, a float, a boolean and a byte string: .. code-block:: python >>> from bitstruct import * >>> pack('u5s5f32b1r13', 1, -1, 3.75, True, b'\xff\xff') b'\x0f\xd0\x1c\x00\x00?\xff' >>> unpack('u5s5f32b1r13', b'\x0f\xd0\x1c\x00\x00?\xff') (1, -1, 3.75, True, b'\xff\xf8') >>> calcsize('u5s5f32b1r13') 56 The same format and values as in the previous example, but using LSB (Least Significant Bit) first instead of the default MSB (Most Significant Bit) first: .. code-block:: python >>> from bitstruct import * >>> pack('>> unpack('>> calcsize('>> from bitstruct import * >>> unpack('s17s13r24', '0123456789abcdef'.decode('hex')) (582, -3751, b'\xe2j\xf3') >>> with open("test.bin", "rb") as fin: ... unpack('s17s13r24', fin.read(8)) ... ... (582, -3751, b'\xe2j\xf3') Change endianness of the data with byteswap(), and then unpack the values: .. code-block:: python >>> from bitstruct import * >>> packed = pack('u1u3u4s16', 1, 2, 3, 1) >>> unpack('u1u3u4s16', byteswap('12', packed)) (1, 2, 3, 256) .. |buildstatus| image:: https://travis-ci.org/eerimoq/bitstruct.svg .. _buildstatus: https://travis-ci.org/eerimoq/bitstruct bitstruct-3.1.0/Makefile0000664000175000017500000000017712640301107015105 0ustar erikerik00000000000000# create release and upload to pypi all: python setup.py sdist python setup.py bdist_wheel --universal twine upload dist/* bitstruct-3.1.0/docs/0000775000175000017500000000000012676404012014400 5ustar erikerik00000000000000bitstruct-3.1.0/docs/index.rst0000664000175000017500000000104212640301107016226 0ustar erikerik00000000000000.. bitstruct documentation master file, created by sphinx-quickstart on Sat Apr 25 11:54:09 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. toctree:: :maxdepth: 2 bitstruct - Interpret strings as packed binary data =================================================== .. include:: ../README.rst Functions ========= .. autofunction:: bitstruct.pack .. autofunction:: bitstruct.unpack .. autofunction:: bitstruct.calcsize .. autofunction:: bitstruct.byteswap bitstruct-3.1.0/docs/make.bat0000664000175000017500000001612212640301107015777 0ustar erikerik00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled echo. coverage to run coverage check of the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) REM Check if sphinx-build is available and fallback to Python version if any %SPHINXBUILD% 2> nul if errorlevel 9009 goto sphinx_python goto sphinx_ok :sphinx_python set SPHINXBUILD=python -m sphinx.__init__ %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) :sphinx_ok if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\bitstruct.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\bitstruct.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %~dp0 echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %~dp0 echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "coverage" ( %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage if errorlevel 1 exit /b 1 echo. echo.Testing of coverage in the sources finished, look at the ^ results in %BUILDDIR%/coverage/python.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end bitstruct-3.1.0/docs/Makefile0000664000175000017500000001637512640301107016044 0ustar erikerik00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " applehelp to make an Apple Help Book" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " coverage to run coverage check of the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/bitstruct.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/bitstruct.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @echo @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." @echo "N.B. You won't be able to view it unless you put it in" \ "~/Library/Documentation/Help or install it in your application" \ "bundle." devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/bitstruct" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/bitstruct" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." coverage: $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage @echo "Testing of coverage in the sources finished, look at the " \ "results in $(BUILDDIR)/coverage/python.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." bitstruct-3.1.0/docs/conf.py0000664000175000017500000002211412676171465015714 0ustar erikerik00000000000000# -*- coding: utf-8 -*- # # bitstruct documentation build configuration file, created by # sphinx-quickstart on Sat Apr 25 11:54:09 2015. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os import shlex # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('..')) import bitstruct # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'bitstruct' copyright = u'2015, Erik Moqvist' author = u'Erik Moqvist' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = bitstruct.__version__ # The full version, including alpha/beta/rc tags. release = bitstruct.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' #html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value #html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'bitstructdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', # Latex figure (float) alignment #'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'bitstruct.tex', u'bitstruct Documentation', u'Erik Moqvist', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'bitstruct', u'bitstruct Documentation', [author], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'bitstruct', u'bitstruct Documentation', author, 'bitstruct', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False bitstruct-3.1.0/LICENSE0000664000175000017500000000207012640301107014444 0ustar erikerik00000000000000The MIT License (MIT) Copyright (c) 2015 Erik Moqvist Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. bitstruct-3.1.0/PKG-INFO0000664000175000017500000001001412676404012014541 0ustar erikerik00000000000000Metadata-Version: 1.1 Name: bitstruct Version: 3.1.0 Summary: This module performs conversions between Python values and C bit field structs represented as Python byte strings. Home-page: https://github.com/eerimoq/bitstruct Author: Erik Moqvist, Ilya Petukhov Author-email: erik.moqvist@gmail.com License: MIT Description: |buildstatus|_ About ===== This module is intended to have a similar interface as the python struct module, but working on bits instead of primitive data types (char, int, ...). Documentation: http://bitstruct.readthedocs.org/en/latest Installation ============ .. code-block:: python pip install bitstruct Example usage ============= See the test suite: https://github.com/eerimoq/bitstruct/blob/master/tests/test_bitstruct.py A basic example of packing/unpacking four integers: .. code-block:: python >>> from bitstruct import * >>> pack('u1u3u4s16', 1, 2, 3, -4) b'\xa3\xff\xfc' >>> unpack('u1u3u4s16', b'\xa3\xff\xfc') (1, 2, 3, -4) >>> calcsize('u1u3u4s16') 24 The unpacked fields can be named by assigning them to variables or by wrapping the result in a named tuple: .. code-block:: python >>> from bitstruct import * >>> from collections import namedtuple >>> MyName = namedtuple('myname', [ 'a', 'b', 'c', 'd' ]) >>> unpacked = unpack('u1u3u4s16', b'\xa3\xff\xfc') >>> myname = MyName(*unpacked) >>> myname myname(a=1, b=2, c=3, d=-4) >>> myname.c 3 An example of packing/unpacking a unsinged integer, a signed integer, a float, a boolean and a byte string: .. code-block:: python >>> from bitstruct import * >>> pack('u5s5f32b1r13', 1, -1, 3.75, True, b'\xff\xff') b'\x0f\xd0\x1c\x00\x00?\xff' >>> unpack('u5s5f32b1r13', b'\x0f\xd0\x1c\x00\x00?\xff') (1, -1, 3.75, True, b'\xff\xf8') >>> calcsize('u5s5f32b1r13') 56 The same format and values as in the previous example, but using LSB (Least Significant Bit) first instead of the default MSB (Most Significant Bit) first: .. code-block:: python >>> from bitstruct import * >>> pack('>> unpack('>> calcsize('>> from bitstruct import * >>> unpack('s17s13r24', '0123456789abcdef'.decode('hex')) (582, -3751, b'\xe2j\xf3') >>> with open("test.bin", "rb") as fin: ... unpack('s17s13r24', fin.read(8)) ... ... (582, -3751, b'\xe2j\xf3') Change endianness of the data with byteswap(), and then unpack the values: .. code-block:: python >>> from bitstruct import * >>> packed = pack('u1u3u4s16', 1, 2, 3, 1) >>> unpack('u1u3u4s16', byteswap('12', packed)) (1, 2, 3, 256) .. |buildstatus| image:: https://travis-ci.org/eerimoq/bitstruct.svg .. _buildstatus: https://travis-ci.org/eerimoq/bitstruct Keywords: bit field,bit parsing,bit unpack,bit pack Platform: UNKNOWN Classifier: License :: OSI Approved :: MIT License Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 3 bitstruct-3.1.0/setup.py0000775000175000017500000000150412676403656015202 0ustar erikerik00000000000000#!/usr/bin/env python from setuptools import setup import bitstruct setup(name='bitstruct', version=bitstruct.__version__, description=('This module performs conversions between Python values ' 'and C bit field structs represented as Python ' 'byte strings.'), long_description=open('README.rst', 'r').read(), author='Erik Moqvist, Ilya Petukhov', author_email='erik.moqvist@gmail.com', license='MIT', classifiers=[ 'License :: OSI Approved :: MIT License', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3', ], keywords=['bit field', 'bit parsing', 'bit unpack', 'bit pack'], url='https://github.com/eerimoq/bitstruct', py_modules=['bitstruct'], test_suite="tests") bitstruct-3.1.0/MANIFEST.in0000664000175000017500000000026412674710475015223 0ustar erikerik00000000000000include LICENSE include Makefile recursive-include docs *.bat recursive-include docs *.py recursive-include docs *.rst recursive-include docs Makefile recursive-include tests *.py bitstruct-3.1.0/bitstruct.py0000664000175000017500000001434212676403674016066 0ustar erikerik00000000000000import re import struct __version__ = "3.1.0" def _parse_format(fmt): parsed_infos = re.findall(r'([<>]?)([a-zA-Z])(\d+)', fmt) # Use big endian as default and use the endianness of the previous # value if none is given for the current value. infos = [] endianness = ">" for info in parsed_infos: if info[0] != "": endianness = info[0] infos.append((info[1], int(info[2]), endianness)) return infos def _pack_integer(size, arg): if arg < 0: arg = ((1 << size) + arg) return '{{:0{}b}}'.format(size).format(arg) def _pack_boolean(size, arg): return _pack_integer(size, int(arg)) def _pack_float(size, arg): if size == 32: value = struct.pack('>f', arg) elif size == 64: value = struct.pack('>d', arg) else: raise ValueError('Bad float size {}. Must be 32 or 64 bits.'.format(size)) return ''.join('{:08b}'.format(b) for b in bytearray(value)) def _pack_bytearray(size, arg): bits = ''.join('{:08b}'.format(b) for b in arg) return bits[0:size] def _unpack_integer(_type, bits): value = int(bits, 2) if _type == 's': if bits[0] == '1': value -= (1 << len(bits)) return value def _unpack_boolean(bits): value = _unpack_integer('u', bits) return bool(value) def _unpack_float(size, bits): packed = _unpack_bytearray(size, bits) if size == 32: value = struct.unpack('>f', packed)[0] elif size == 64: value = struct.unpack('>d', packed)[0] else: raise ValueError('Bad float size {}. Must be 32 or 64 bits.'.format(size)) return value def _unpack_bytearray(size, bits): value = bytearray() for i in range(size // 8): value.append(int(bits[8*i:8*i+8], 2)) rest = size % 8 if rest > 0: value.append(int(bits[size-rest:], 2) << (8-rest)) return value def pack(fmt, *args): """Return a byte string containing the values v1, v2, ... packed according to the given format. If the total number of bits are not a multiple of 8, padding will be added at the end of the last byte. :param fmt: Bitstruct format string. See format description below. :param args: Variable argument list of values to pack. :returns: A byte string of the packed values. `fmt` is a string of bitorder-type-length groups. Bitorder may be omitted. Bitorder is either ">" or "<", where ">" means MSB first and "<" means LSB first. If bitorder is omitted, the previous values' bitorder is used for the current value. For example, in the format string "u1