Skip to main content

A circular/ring buffer written in C

Project description

A python extension implementing a circular/ring buffer of characters as a C extension. It overwrites silently.

Availability

Currently, pyringbuf is available at https://pypi.python.org/pypi/pyringbuf, or via pip install pyringbuf. As this is a C extension, there is a compilation step, so your system will need to be able to compile extension modules for python.

Usage

>>> from ringbuf import RingBuffer
>>> R = RingBuffer(5)    #choose your buffer size
>>> R.push("a")          #push a single character into the buffer
>>> R.pop()              #pop a single character
'a'
>>> R.write("bcdef")     #fill buffer with many characters at once
>>> R.read(4)            #read many characters at once
'bcde'
>>> R.read(1)
'f'
>>> R.read(1)            #returns an empty string if the buffer is empty
''

Implementation

For the interested, this has been implemented as a pure C extension. The ring buffer itself is implemented as a fixed length array of chars (8-bit signed), dynamically allocated on the Python Heap on instantiation of a buffer. Read and write indexes both increase monotonically, and addresses in the array are determined using index % (modulo) buffer size. Writing more than the buffer size at once throws an exception, otherwise if writing overtakes the read index in the modulo space the buffer contents are silently overwritten.

Project details


Download files

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

Source Distribution

pyringbuf-0.1b2.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file pyringbuf-0.1b2.tar.gz.

File metadata

  • Download URL: pyringbuf-0.1b2.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyringbuf-0.1b2.tar.gz
Algorithm Hash digest
SHA256 a93f14be50f0b5320bc6a2281ee2c4f2193171aef7be14dbe5635bbc84aa98fb
MD5 22487cce4b31ff9cf71d95a5c85b9ead
BLAKE2b-256 1413c1f4a8442b8f01383dd7dabd1f3bc41ab6aa1df4fcacf5f9fee25dad40a5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page