You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP →
Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

pyftpdlib-ustcblog

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pyftpdlib-ustcblog

USTC Blog fork of Very fast asynchronous FTP server library

1.4.1
pipPyPI
Maintainers
1

.. image:: https://pypip.in/d/pyftpdlib/badge.png :target: https://crate.io/packages/pyftpdlib/ :alt: Download this month

.. image:: https://pypip.in/v/pyftpdlib/badge.png :target: https://pypi.python.org/pypi/pyftpdlib/ :alt: Latest version

.. image:: https://pypip.in/license/pyftpdlib/badge.png :target: https://pypi.python.org/pypi/pyftpdlib/ :alt: License

.. image:: https://api.travis-ci.org/giampaolo/pyftpdlib.png?branch=master :target: https://travis-ci.org/giampaolo/pyftpdlib :alt: Travis

Quick links

  • Home <https://github.com/giampaolo/pyftpdlib>__
  • Documentation <http://pythonhosted.org/pyftpdlib/>__
  • Download <https://pypi.python.org/pypi/pyftpdlib/>__
  • Blog <http://grodola.blogspot.com/search/label/pyftpdlib>__
  • Mailing list <http://groups.google.com/group/pyftpdlib/topics>__
  • What's new <https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst>__

About

Python FTP server library provides a high-level portable interface to easily write very efficient, scalable and asynchronous FTP servers with Python. It is the most complete RFC-959 <http://www.faqs.org/rfcs/rfc959.html>__ FTP server implementation available for Python <http://www.python.org/>__ programming language and it's used in projects like Google Chromium <http://www.code.google.com/chromium/>__ and Bazaar <http://bazaar-vcs.org/>__ and included in Debian <http://packages.debian.org/sid/python-pyftpdlib>, Fedora <https://admin.fedoraproject.org/pkgdb/packages/name/pyftpdlib> and FreeBSD <http://www.freshports.org/ftp/py-pyftpdlib/>__ package repositories.

Features

  • Extremely lightweight, fast and scalable (see why <https://github.com/giampaolo/pyftpdlib/issues/203>__ and benchmarks <http://pythonhosted.org/pyftpdlib/benchmarks.html>__).
  • Uses sendfile(2) (see pysendfile <https://github.com/giampaolo/pysendfile>__) system call for uploads.
  • Uses epoll() / kqueue() / select() to handle concurrency asynchronously.
  • ...But can optionally skip to a multiple thread / process <http://pythonhosted.org/pyftpdlib/tutorial.html#changing-the-concurrency-model>__ model (as in: you'll be free to block or use slow filesystems).
  • Portable: entirely written in pure Python; works with Python from 2.4 to 3.4 (by using a single code base).
  • Supports FTPS (RFC-4217 <http://tools.ietf.org/html/rfc4217>), IPv6 (RFC-2428 <ftp://ftp.rfc-editor.org/in-notes/rfc2428.txt>), Unicode file names (RFC-2640 <http://tools.ietf.org/html/rfc2640>), MLSD/MLST commands (RFC-3659 <ftp://ftp.rfc-editor.org/in-notes/rfc3659.txt>).
  • Support for virtual users and virtual filesystem.
  • Extremely flexible system of "authorizers" able to manage both "virtual" and "real" users on on both UNIX <http://pythonhosted.org/pyftpdlib/tutorial.html#unix-ftp-server>__ and Windows <http://pythonhosted.org/pyftpdlib/tutorial.html#windows-ftp-server>__.
  • Test coverage <https://github.com/giampaolo/pyftpdlib/blob/master/test/test_ftpd.py>__ close to 100%.

Performances

Depite being written in an intepreted language, pyftpdlib has transfer rates superior to most common UNIX FTP servers. It also scales better since whereas vsftpd and proftpd use multiple processes to achieve concurrency, pyftpdlib will only use one process and handle concurrency asynchronously (see the C10K problem <http://www.kegel.com/c10k.html>). Here are some benchmarks <https://github.com/giampaolo/pyftpdlib/blob/master/test/bench.py> made against my Linux 3.0.0 box, Intel core-duo 3.1 Ghz:

pyftpdlib vs. proftpd 1.3.4

+-----------------------------------------+----------------+----------------+-------------+ | benchmark type | pyftpdlib | proftpd | speedup | +-----------------------------------------+----------------+----------------+-------------+ | STOR (client -> server) | 585.90 MB/sec | 600.49 MB/sec | -0.02x | +-----------------------------------------+----------------+----------------+-------------+ | RETR (server -> client) | 1652.72 MB/sec | 1524.05 MB/sec | +0.08 | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (connect, login) | 0.19 secs | 9.98 secs | +51x | +-----------------------------------------+----------------+----------------+-------------+ | STOR (1 file with 300 idle clients) | 585.59 MB/sec | 518.55 MB/sec | +0.1x | +-----------------------------------------+----------------+----------------+-------------+ | RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1478.19 MB/sec | 0x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.60 secs | +0.05x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (STOR 10M file) | 8.60 secs | 11.56 secs | +0.3x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (QUIT) | 0.03 secs | 0.39 secs | +12x | +-----------------------------------------+----------------+----------------+-------------+

pyftpdlib vs. vsftpd 2.3.5

+-----------------------------------------+----------------+----------------+-------------+ | benchmark type | pyftpdlib | proftpd | speedup | +-----------------------------------------+----------------+----------------+-------------+ | STOR (client -> server) | 585.90 MB/sec | 611.73 MB/sec | -0.04x | +-----------------------------------------+----------------+----------------+-------------+ | RETR (server -> client) | 1652.72 MB/sec | 1512.92 MB/sec | +0.09 | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (connect, login) | 0.19 secs | 20.39 secs | +106x | +-----------------------------------------+----------------+----------------+-------------+ | STOR (1 file with 300 idle clients) | 585.59 MB/sec | 610.23 MB/sec | -0.04x | +-----------------------------------------+----------------+----------------+-------------+ | RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1493.01 MB/sec | 0x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.67 secs | +0.07x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (STOR 10M file) | 8.60 secs | 9.82 secs | +0.07x | +-----------------------------------------+----------------+----------------+-------------+ | 300 concurrent clients (QUIT) | 0.03 secs | 0.01 secs | +0.14x | +-----------------------------------------+----------------+----------------+-------------+

For more benchmarks see here <http://pythonhosted.org/pyftpdlib/benchmarks.html>__.

Quick start

.. code-block:: python

>>> from pyftpdlib.authorizers import DummyAuthorizer
>>> from pyftpdlib.handlers import FTPHandler
>>> from pyftpdlib.servers import FTPServer
>>>
>>> authorizer = DummyAuthorizer()
>>> authorizer.add_user("user", "12345", "/home/giampaolo", perm="elradfmw")
>>> authorizer.add_anonymous("/home/nobody")
>>>
>>> handler = FTPHandler
>>> handler.authorizer = authorizer
>>>
>>> server = FTPServer(("127.0.0.1", 21), handler)
>>> server.serve_forever()
[I 13-02-19 10:55:42] >>> starting FTP server on 127.0.0.1:21 <<<
[I 13-02-19 10:55:42] poller: <class 'pyftpdlib.ioloop.Epoll'>
[I 13-02-19 10:55:42] masquerade (NAT) address: None
[I 13-02-19 10:55:42] passive ports: None
[I 13-02-19 10:55:42] use sendfile(2): True
[I 13-02-19 10:55:45] 127.0.0.1:34178-[] FTP session opened (connect)
[I 13-02-19 10:55:48] 127.0.0.1:34178-[user] USER 'user' logged in.
[I 13-02-19 10:56:27] 127.0.0.1:34179-[user] RETR /home/giampaolo/.vimrc completed=1 bytes=1700 seconds=0.001
[I 13-02-19 10:56:39] 127.0.0.1:34179-[user] FTP session closed (disconnect).

other code samples <http://pythonhosted.org/pyftpdlib/tutorial.html>__

Donate

A lot of time and effort went into making pyftpdlib as it is right now. If you feel pyftpdlib is useful to you or your business and want to support its future development please consider donating me (Giampaolo Rodola' <http://grodola.blogspot.com/p/about.html>_) some money. I only ask for a small donation, but of course I appreciate any amount.

.. image:: https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZSSF7G42VA2XE :alt: Donate via PayPal

Don't want to donate money? Then maybe you could write me a recommendation on Linkedin <http://www.linkedin.com/in/grodola>. In case you're using pyftpdlib into a software of yours mail me <http://grodola.blogspot.com/p/about.html> and I'll add your software to the adoptions list <http://pythonhosted.org/pyftpdlib/adoptions.html>__.

Timeline

  • 2014-06-03: version 1.4.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.4.0.tar.gz>__ released.
  • 2014-04-12: version 1.3.1 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.3.1.tar.gz>__ released.
  • 2013-11-07: version 1.3.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.3.0.tar.gz>__ released.
  • 2013-04-22: version 1.2.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.2.0.tar.gz>__ released.
  • 2013-04-09: version 1.1.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.1.0.tar.gz>__ released.
  • 2013-02-22: version 1.0.1 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.0.1.tar.gz>__ released.
  • 2013-02-19: version 1.0.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-1.0.0.tar.gz>__ released.
  • 2012-05-14: pyftpdlib included in ftp-cloudfs <https://github.com/chmouel/ftp-cloudfs/>__ project.
  • 2012-01-25: version 0.7.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.7.0.tar.gz>__ released.
  • 2011-12-01: pyftpdlib included in feitp-server <http://code.google.com/p/feitp-server/>__ project.
  • 2011-09-26: pyftpdlib included in ftpmaster <https://github.com/MarkLIC/ftpmaster>__ project.
  • 2011-07-09: pyftpdlib included in bftpd <http://bftpd.sourceforge.net/>__ project.
  • 2011-07-09: pyftpdlib included in fastersync <http://code.google.com/p/fastersync/>__ project.
  • 2011-01-31: pyftpdlib included in put.io FTP connector project <http://code.google.com/p/pyftpdlib/wiki/Adoptions?ts=1296442469&updated=Adoptions#put.io*FTP*connector>__.
  • 2011-01-24: version 0.6.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.6.0.tar.gz>__ released.
  • 2010-12-14: added donations <http://code.google.com/p/pyftpdlib/wiki/Donate>__.
  • 2010-08-24: pyftpdlib included in peerscape <http://www.peerscape.org/>__ project.
  • 2010-07-15: pyftpdlib included in Faetus <http://tomatohater.com/faetus/>__ project.
  • 2010-07-11: pyftpdlib included in Pyfilesystem <http://code.google.com/p/pyfilesystem>__ project.
  • 2010-06-28: pyftpdlib has been packaged for Debian <http://packages.debian.org/sid/python-pyftpdlib>__
  • 2010-04-28: pyftpdlib included in sierramodulepos <http://forge.openbravo.com/plugins/mwiki/index.php/MobilePOS>__ project.
  • 2010-03-20: http://www.smartfile.com <http://www.smartfile.com>__ uses pyftpdlib.
  • 2010-01-13: pyftpdlib included in zenftp <http://code.irondojo.com/>__ project.
  • 2009-12-26: pyftpdlib included in Symbian Python FTP server <http://code.google.com/p/sypftp>__ project.
  • 2009-11-04: www.netplay.it <http://www.netplay.it>__ uses pyftpdlib.
  • 2009-11-04: www.adcast.tv <http://www.adcast.tv>__ uses pyftpdlib.
  • 2009-11-04: www.bitsontherun.com <http://www.bitsontherun.com>__ uses pyftpdlib.
  • 2009-11-02: pyftpdlib included in ftp-cloudfs <http://github.com/chmouel/ftp-cloudfs>__ project.
  • 2009-09-14: version 0.5.2 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.5.2.tar.gz>__ released.
  • 2009-08-10: pyftpdlib included in Imgserve <http://github.com/wuzhe/imgserve/tree/master>__ project.
  • 2009-07-22: pyftpdlib included in Plumi <http://plumi.org/wiki>__ project.
  • 2009-04-02: pyftpdlib RPM-packaged and ported on Fedora <https://admin.fedoraproject.org/pkgdb/packages/name/pyftpdlib>__ to make users can easily install on it via yum install pyftpdlib.
  • 2009-03-28: pyftpdlib included in Bazaar <http://bazaar-vcs.org/>__ project.
  • 2009-02-23: pyftpdlib included in ShareFTP <http://git.logfish.net/shareftp.git/>__ project.
  • 2009-01-21: version 0.5.1 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.5.1.tar.gz>__ released.
  • 2008-12-27: pyftpdlib included in Google Chromium <http://code.google.com/intl/it-IT/chromium/>, the open source project behind Google Chrome <http://www.google.com/chrome>.
  • 2008-12-27: pyftpdlib ported on GNU Darwin <http://www.gnu-darwin.org/>__ systems to make users can easily install on it.
  • 2008-11-26: pyftpdlib included in OpenERP <http://openerp.com>__.
  • 2008-10-26: pyftpdlib included in Python for OpenVMS <http://www.vmspython.org/>__ as standard package.
  • 2008-10-09: pyftpdlib included in Shareme <http://bbs.archlinux.org/viewtopic.php?pid=431474>__ project.
  • 2008-09-20: version 0.5.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.5.0.tar.gz>__ released.
  • 2008-08-10: pyftpdlib included in Manent <http://trac.manent-backup.com/>__ project.
  • 2008-05-16: version 0.4.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.4.0.tar.gz>__ released.
  • 2008-04-09: pyftpdlib used as backend for gpftpd <http://arkadiusz-wahlig.blogspot.com/2008/04/hosting-files-on-google.html>, an FTP server for managing files hosted on Google Pages <http://-ages.google.com>.
  • 2008-01-17: version 0.3.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.3.0.tar.gz>__ released.
  • 2007-10-14: pyftpdlib included in Aksy <http://walco.n--tree.net/projects/aksy/wiki>__ project.
  • 2007-09-17: version 0.2.0 <https://pypi.python.org/packages/source/p/pyftpdlib/pyftpdlib-0.2.0.tar.gz>__ released.
  • 2007-09-08: pyftpdlib included as FarManager <http://farmanager.com/>__ plug-in <http://www.farmanager.com/enforum/viewtopic.php?t=640&highlight=&sid=12d4d90f27f421243bcf7a0e3c516efb>__.
  • 2007-03-06: pyftpdlib ported on FreeBSD <http://www.freshports.org/ftp/py-pyftpdlib/>__ systems to make users can easily install on it.
  • 2007-03-07: version 0.1.1 <http://pyftpdlib.googlecode.com/files/pyftpdlib*0.1.1.tar.gz>__ released.
  • 2007-02-26: version 0.1.0 <http://pyftpdlib.googlecode.com/files/pyftpdlib*0.1.tar.gz>__ released.
  • 2006-09-26: initial clunky thread-based progenitor link <http://billiejoex.altervista.org/Prj*pftpd.htm>__.

Trademarks

Some famous trademarks which adopted pyftpdlib (complete list <http://pythonhosted.org/pyftpdlib/adoptions.html>__).

.. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/chrome.jpg :target: http://www.google.com/chrome .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/debian.png :target: http://www.debian.org .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/fedora.png :target: http://fedoraproject.org/ .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/freebsd.gif :target: http://www.freebsd.org .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/openerp.jpg :target: http://openerp.com .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/bazaar.jpg :target: http://bazaar-vcs.org .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/bitsontherun.png :target: http://www.bitsontherun.com .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/openvms.png :target: http://www.openvms.org/ .. image:: http://pyftpdlib.googlecode.com/svn-history/wiki/images/smartfile.jpg :target: http://www.openvms.org/

Keywords

ustc
blog
ftp
ftps
server
ftpd

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Crates.io Implements Trusted Publishing Support

Security News

Crates.io Implements Trusted Publishing Support

Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.

By Sarah Gooding  -  Jul 16, 2025