/usr/lib/python3/dist-packages/pysendfile-2.0.1.egg-info is in python3-sendfile 2.0.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | Metadata-Version: 1.1
Name: pysendfile
Version: 2.0.1
Summary: A Python interface to sendfile(2)
Home-page: https://github.com/giampaolo/pysendfile
Author: Giampaolo Rodola
Author-email: g.rodola@gmail.com
License: MIT
Description: .. image:: https://pypip.in/d/pysendfile/badge.png
:target: https://crate.io/packages/pysendfile/
:alt: Download this month
.. image:: https://pypip.in/v/pysendfile/badge.png
:target: https://pypi.python.org/pypi/pysendfile/
:alt: Latest version
.. image:: https://pypip.in/license/pysendfile/badge.png
:target: https://pypi.python.org/pypi/pysendfile/
:alt: License
.. image:: https://api.travis-ci.org/giampaolo/pysendfile.png?branch=master
:target: https://travis-ci.org/giampaolo/pysendfile
:alt: Travis
===========
Quick links
===========
- `Home page <https://github.com/giampaolo/pysendfile>`_
- `Mailing list <http://groups.google.com/group/py-sendfile>`_
- `Blog <http://grodola.blogspot.com/search/label/pysendfile>`_
- `What's new <https://github.com/giampaolo/pysendfile/blob/master/HISTORY.rst>`_
=====
About
=====
`sendfile(2) <http://linux.die.net/man/2/sendfile>`__ is a system call which
provides a "zero-copy" way of copying data from one file descriptor to another
(a socket). The phrase "zero-copy" refers to the fact that all of the copying
of data between the two descriptors is done entirely by the kernel, with no
copying of data into userspace buffers. This is particularly useful when
sending a file over a socket (e.g. FTP).
The normal way of sending a file over a socket involves reading data from the
file into a userspace buffer, then write that buffer to the socket via
`send() <http://docs.python.org/library/socket.html#socket.socket.send>`__ or
`sendall() <http://docs.python.org/library/socket.html#socket.socket.sendall>`__:
.. code-block:: python
# how a file is tipically sent
import socket
file = open("somefile", "rb")
sock = socket.socket()
sock.connect(("127.0.0.1", 8021))
while True:
chunk = file.read(65536)
if not chunk:
break # EOF
sock.sendall(chunk)
This copying of the data twice (once into the userland buffer, and once out
from that userland buffer) imposes some performance and resource penalties.
`sendfile(2) <http://linux.die.net/man/2/sendfile>`__ syscall avoids these
penalties by avoiding any use of userland buffers; it also results in a single
system call (and thus only one context switch), rather than the series of
`read(2) <http://linux.die.net/man/2/read>`__ /
`write(2) <http://linux.die.net/man/2/write>`__ system calls (each system call
requiring a context switch) used internally for the data copying.
.. code-block:: python
import socket
from sendfile import sendfile
file = open("somefile", "rb")
blocksize = os.path.getsize("somefile")
sock = socket.socket()
sock.connect(("127.0.0.1", 8021))
offset = 0
while True:
sent = sendfile(sock.fileno(), file.fileno(), offset, blocksize)
if sent == 0:
break # EOF
offset += sent
==================
A simple benchmark
==================
This `benchmark script <https://github.com/giampaolo/pysendfile/blob/master/test/benchmark.py>`__
implements the two examples above and compares plain socket.send() and
sendfile() performances in terms of CPU time spent and bytes transmitted per
second resulting in sendfile() being about **2.5x faster**. These are the
results I get on my Linux 2.6.38 box, AMD dual-core 1.6 GHz:
*send()*
+---------------+-----------------+
| CPU time | 28.84 usec/pass |
+---------------+-----------------+
| transfer rate | 359.38 MB/sec |
+---------------+-----------------+
*sendfile()*
+---------------+-----------------+
| CPU time | 11.28 usec/pass |
+---------------+-----------------+
| transfer rate | 860.88 MB/sec |
+---------------+-----------------+
===========================
When do you want to use it?
===========================
Basically any application sending files over the network can take advantage of
sendfile(2). HTTP and FTP servers are a typical example.
`proftpd <http://www.proftpd.org/>`__ and
`vsftpd <https://security.appspot.com/vsftpd.html>`__ are known to use it, so is
`pyftpdlib <http://code.google.com/p/pyftpdlib/>`__.
=================
API documentation
=================
sendfile module provides a single function: sendfile().
- ``sendfile.sendfile(out, in, offset, nbytes, header="", trailer="", flags=0)``
Copy *nbytes* bytes from file descriptor *in* (a regular file) to file
descriptor *out* (a socket) starting at *offset*. Return the number of
bytes just being sent. When the end of file is reached return 0.
On Linux, if *offset* is given as *None*, the bytes are read from the current
position of *in* and the position of *in* is updated.
*headers* and *trailers* are strings that are written before and after the
data from *in* is written. In cross platform applications their usage is
discouraged
(`send() <http://docs.python.org/library/socket.html#socket.socket.send>`__ or
`sendall() <http://docs.python.org/library/socket.html#socket.socket.sendall>`__
can be used instead). On Solaris, _out_ may be the file descriptor of a
regular file or the file descriptor of a socket. On all other platforms,
*out* must be the file descriptor of an open socket.
*flags* argument is only supported on FreeBSD.
- ``sendfile.SF_NODISKIO``
- ``sendfile.SF_MNOWAIT``
- ``sendfile.SF_SYNC``
Parameters for the _flags_ argument, if the implementation supports it. They
are available on FreeBSD platforms. See `FreeBSD's man sendfile(2) <http://www.freebsd.org/cgi/man.cgi?query=sendfile&sektion=2>`__.
=======================
Differences with send()
=======================
- sendfile(2) works with regular (mmap-like) files only (e.g. you can't use it
with a `StringIO <http://docs.python.org/library/stringio.html>`__ object).
- Also, it must be clear that the file can only be sent "as is" (e.g. you
can't modify the content while transmitting).
There might be problems with non regular filesystems such as NFS,
SMBFS/Samba and CIFS. For this please refer to
`proftpd documentation <http://www.proftpd.org/docs/howto/Sendfile.html>`__.
- `OSError <http://docs.python.org/library/exceptions.html#exceptions.OSError>`__
is raised instead of `socket.error <http://docs.python.org/library/socket.html#socket.error>`__.
The accompaining `error codes <http://docs.python.org/library/errno.html>`__
have the same meaning though: EAGAIN, EWOULDBLOCK, EBUSY meaning you are
supposed to retry, ECONNRESET, ENOTCONN, ESHUTDOWN, ECONNABORTED in case of
disconnection. Some examples:
`benchmark script <https://github.com/giampaolo/pysendfile/blob/release-2.0.1/test/benchmark.py#L182>`__,
`test suite <https://github.com/giampaolo/pysendfile/blob/release-2.0.1/test/test_sendfile.py#L202>`__,
`pyftpdlib wrapper <http://code.google.com/p/pyftpdlib/source/browse/tags/release-0.7.0/pyftpdlib/ftpserver.py#1035>`__.
===================
Supported platforms
===================
This module works with Python versions from **2.5** to **3.4**. The supported platforms are:
- **Linux**
- **Mac OSX**
- **FreeBSD**
- **Dragon Fly BSD**
- **Sun OS**
- **AIX** (not properly tested)
=======
Support
=======
Feel free to mail me at *g.rodola [AT] gmail [DOT] com* or post on the the
mailing list: http://groups.google.com/group/py-sendfile.
======
Status
======
As of now the code includes a solid `test suite <https://github.com/giampaolo/pysendfile/blob/master/test/test_sendfile.py>`__ and its ready for production use.
It's been included in `pyftpdlib <http://code.google.com/p/pyftpdlib/>`__
project and used in production environments for almost a year now without any
problem being reported so far.
=======
Authors
=======
pysendfile was originally written by *Ben Woolley* including Linux, FreeBSD and
DragonFly BSD support. Later on *Niklas Edmundsson* took over maintenance and
added AIX support. After a couple of years of project stagnation
`Giampaolo Rodola' <http://grodola.blogspot.com/p/about.html>`__ took over
maintenance and rewrote it from scratch adding support for:
- Python 3
- non-blocking sockets
- `large file <http://docs.python.org/library/posix.html#large-file-support>`__ support
- Mac OSX
- Sun OS
- FreeBSD flag argument
- multiple threads (release GIL)
- a simple benchmark suite
- unit tests
- documentation
Keywords: sendfile,python,performance,ftp
Platform: UNIX
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: SunOS/Solaris
Classifier: Operating System :: POSIX :: AIX
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Operating System
Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: License :: OSI Approved :: MIT License
|