io‸cursor

一个零拷贝的文件包装器，用于Python的字节缓冲区，受Rust的std::io::Cursor启发。

🗺️ 概览

iocursor.Cursor 允许您包装一个分配的缓冲区（即实现缓冲区协议的Python对象），并通过文件对象API与之交互。它与io.BytesIO有一些共同点，但有以下主要区别

• 零拷贝 VS 拷贝：在初始化时，Cursor不会复制你给它提供的数据，而BytesIO会。这使得当你在进行只读操作时，Cursor更加高效。
• 静态 VS 可增长：Cursor只会使用你在静态内存中提供的缓冲区，而BytesIO会使用其专用的、可增长的缓冲区。

🔧 安装

直接从PyPI安装，使用pip

$ pip install iocursor

预构建的轮子适用于所有支持的Python3版本在Linux和OSX上。否则，仅需要可工作的C编译器即可从源码构建。

🧶 线程安全

iocursor.Cursor实例不是线程安全的。当只使用相同后端内存的几个Cursor实例进行读取时应该没问题。否则，请使用锁。

💡 例子

• 当你需要将bytes传递给只接受文件对象的接口时，请使用iocursor.Cursor。例如，将从base64解码的PNG图像传递给PIL，而不进行拷贝。

  import base64
  from iocursor import Cursor
  from PIL import Image
  
  imgdata = base64.b64decode("iVBORw0KGgoAAAANSUhEU...")
  img = Image.open(Cursor(imgdata))
  

• 当你想使用文件API将数据写入已知大小的缓冲区时，请使用iocursor.Cursor。例如，使用pysmb API检索文件，该API只接受文件对象。

  from SMB.SMBConnection import SMBConnectSMBConnection
  
  smb = SMBConnection('guest', '', 'client', 'server')
  smb.connect("192.168.0.1")
  
  info = smb.getAttributes("Music", "The Clash/Rock the Casbah.mp3")
  cursor = Cursor(bytearray(shared_file.file_size))
  smb.retrieveFile("Music", "The Clash/Rock the Casbah.mp3", cursor)
  
  buffer = cursor.getvalue()
  

• 当你想在实现了缓冲区协议的类型上执行直接I/O时，请使用iocursor.Cursor。例如，通过向其中写入字节来初始化numpy 数组。

  import numpy
  
  array = numpy.empty(4, dtype="int16")
  cursor = Cursor(array)
  cursor.write(b"\x01\x00\x02\x00\x03\x00\x04\x00")
  print(array)  # array([1, 2, 3, 4], dtype=int16)
  

💭 反馈

⚠️ 问题追踪器

发现了一个错误？有一个增强请求？如果你需要报告或询问问题，请访问GitHub问题追踪器。如果你正在提交错误报告，请尽可能提供有关问题的详细信息，并尝试在简单、易于复现的情况下重现相同的错误。

🏗️ 贡献

欢迎贡献力量！有关更多详细信息，请参阅CONTRIBUTING.md。

⚖️ 许可证

此库根据MIT许可证提供。