Skip to main content

Simple implementation of circular buffer.

Project description

  • License : MIT


Simple circular buffer written in python extension.

CircularBuffer will allocate requested size + 2 bytes for two sections of null terminated strings.

May temporary allocate another half of the allocated bytes if you used buffer protocol, I mostly used them for regex.


Simply pip install pycircularbuffer, compilation from downloaded source is probably needed.


from circularbuffer import CircularBuffer

buf = CircularBuffer(1024)

buf.write(b'some text')
while len(buf) > 0:

from re import match


# python2
with buf:
    match_found = match(br'^ha', buf)

# python3
match_found = match(br'^ha', buf)

# use `result` immediately because regex didn't make memory copy of the
# internal buffer, or run another `match()` on a memory copy, for example:

match_found_str =
independent_match_found = match(br'^ha', match_found_str)


Don’t to this in python 3: ‘a’ in buf, instead: b’a’ in buf.


Regular methods:

  • clear()
  • read()
  • resize()
  • write()
  • write_available()
  • make_contiguous()

String methods:

  • count()
  • startswith()
  • find()
  • index()

Sequence methods:

  • __contains__()
  • __getitem__()
  • __len__()
  • __setitem__()

Magic methods:

  • __repr__()

  • __str__()

    Note: while string representation makes thing easier it always creates memory copy.

  • __enter__()

  • __exit__()

Buffer protocol:

Note: for python version < 3, you need to use context manager, the with statement, to let CircularBuffer know when you are releasing the buffer.

Using buffer protocol will throw ReservedError exception for

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pycircularbuffer, version 0.0.8
Filename, size File type Python version Upload date Hashes
Filename, size pycircularbuffer-0.0.8.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page