Bitstring Manual

• I User Manual
  • Walkthrough
    • A Brief Introduction
      • Prerequisites
      • Getting started
      • Modifying bitstrings
      • Finding and Replacing
      • Constructing a bitstring
      • Parsing bitstreams
    • Worked examples
      • Hamming distance
      • Sieve of Eratosthenes
  • Introduction
    • Getting Started
  • Creation
    • The bitstring classes
    • Using the constructor
      • From a hexadecimal string
      • From a binary string
      • From an octal string
      • From an integer
      • Big and little-endian integers
      • From a floating point number
      • Exponential-Golomb codes
      • From raw byte data
      • From a file
    • The auto initialiser
  • Packing
    • Compact format strings
  • Interpreting Bitstrings
    • bin
    • hex
    • oct
    • uint / uintbe / uintle / uintne
    • int / intbe / intle / intne
    • float / floatbe / floatle / floatne
    • bytes
    • ue
    • se
    • uie / sie
  • Slicing, Dicing and Splicing
    • Slicing
      • Stepping in slices
    • Joining
    • Truncating, inserting, deleting and overwriting
      • Deleting and truncating
      • insert
      • overwrite
    • The bitstring as a list
    • Splitting
      • split
      • cut
  • Reading, Parsing and Unpacking
    • Reading and parsing
      • read / readlist
      • Reading using format strings
      • Peeking
    • Unpacking
    • Seeking
    • Finding and replacing
      • find / rfind
      • findall
      • replace
    • Working with byte aligned data
  • Miscellany
    • Other Functions
      • bytealign
      • reverse
      • tobytes
      • tofile
      • startswith / endswith
      • ror / rol
    • Special Methods
      • __len__
      • __str__ / __repr__
      • __eq__ / __ne__
      • __invert__
      • __lshift__ / __rshift__ / __ilshift__ / __irshift__
      • __mul__ / __imul__ / __rmul__
      • __copy__
      • __and__ / __or__ / __xor__ / __iand__ / __ior__ / __ixor__
• II Reference
  • Quick Reference
    • Bits
      • Methods
      • Special methods
      • Properties
    • BitArray
      • Additional methods
      • Additional special methods
      • Attributes
    • ConstBitStream
      • Additional methods
      • Additional attributes
    • BitStream
  • The bitstring module
    • The auto initialiser
    • Compact format strings
    • Class properties
  • The Bits class
  • The BitArray class
  • The ConstBitStream class
  • The BitStream class
  • Functions
  • Exceptions
• III Appendices
  • Examples
    • Creation
    • Manipulation
    • Parsing
    • Sieve of Eratosthenes
  • Exponential-Golomb Codes
    • Interleaved exponential-Golomb codes
  • Optimisation Techniques
    • Use combined read and interpretation
    • Choose the simplest class you can
    • Use dedicated functions for bit setting and checking
  • Release Notes
    • Full Version History
      • November 21st 2011: version 3.0.0 released
      • Backwardly incompatible changes
      • New features
      • June 18th 2011: version 2.2.0 released
      • February 23rd 2011: version 2.1.1 released
      • January 23rd 2011: version 2.1.0 released
      • New class hierarchy introduced with simpler classes
      • July 26th 2010: version 2.0.3 released
      • July 25th 2010: version 2.0.2 released
      • The backwardly incompatible changes are:
      • The new features in this release are:
      • March 18th 2010: version 1.3.0 for Python 2.6 and 3.x released
      • New features
      • January 19th 2010: version 1.2.0 for Python 2.6 and 3.x released
      • New `Bits' class
      • December 22nd 2009: version 1.1.3 for Python 2.6 and 3.x released
      • December 18th 2009: version 1.1.2 for Python 2.6 and 3.x released
      • November 24th 2009: version 1.1.0 for Python 2.6 and 3.x released
      • New features
      • October 10th 2009: version 1.0.1 for Python 3.x released
      • October 9th 2009: version 1.0.0 for Python 2.x released
      • API Changes
      • New features
      • September 11th 2009: version 0.5.2 for Python 2.x released
      • August 26th 2009: version 0.5.1 for Python 2.x released
      • July 19th 2009: version 0.5.0 for Python 2.x released
      • June 15th 2009: version 0.4.3 for Python 2.x released
      • May 25th 2009: version 0.4.2 for Python 2.x released
      • April 23rd 2009: Python 3 only version 0.4.1 released
      • April 11th 2009: version 0.4.0 released
      • March 11th 2009: version 0.3.2 released
      • February 26th 2009: version 0.3.1 released
      • February 15th 2009: version 0.3.0 released
      • January 13th 2009: version 0.2.0 released
      • December 29th 2008: version 0.1.0 released