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
|
| |downloads| |stars| |forks| |contributors|
| |version| |packages| |license|
| |github-actions| |doc| |twitter|
.. |downloads| image:: https://img.shields.io/pypi/dm/pyftpdlib.svg
:target: https://pepy.tech/project/pyftpdlib
:alt: Downloads
.. |stars| image:: https://img.shields.io/github/stars/giampaolo/pyftpdlib.svg
:target: https://github.com/giampaolo/pyftpdlib/stargazers
:alt: Github stars
.. |forks| image:: https://img.shields.io/github/forks/giampaolo/pyftpdlib.svg
:target: https://github.com/giampaolo/pyftpdlib/network/members
:alt: Github forks
.. |contributors| image:: https://img.shields.io/github/contributors/giampaolo/pyftpdlib.svg
:target: https://github.com/giampaolo/pyftpdlib/graphs/contributors
:alt: Contributors
.. |github-actions| image:: https://img.shields.io/github/actions/workflow/status/giampaolo/pyftpdlib/.github/workflows/tests.yml
:target: https://github.com/giampaolo/pyftpdlib/actions
:alt: GH actions
.. |doc| image:: https://readthedocs.org/projects/pyftpdlib/badge/?version=latest
:target: https://pyftpdlib.readthedocs.io/en/latest/
:alt: Documentation Status
.. |version| image:: https://img.shields.io/pypi/v/pyftpdlib.svg?label=pypi
:target: https://pypi.org/project/pyftpdlib
:alt: Latest version
.. |py-versions| image:: https://img.shields.io/pypi/pyversions/psutil.svg
:alt: Supported Python versions
.. |packages| image:: https://repology.org/badge/tiny-repos/python:pyftpdlib.svg
:target: https://repology.org/metapackage/python:pyftpdlib/versions
:alt: Binary packages
.. |license| image:: https://img.shields.io/pypi/l/pyftpdlib.svg
:target: https://github.com/giampaolo/pyftpdlib/blob/master/LICENSE
:alt: License
.. |twitter| image:: https://img.shields.io/twitter/follow/grodola.svg?label=follow&style=flat&logo=twitter&logoColor=4FADFF
:target: https://twitter.com/grodola
:alt: Twitter Follow
Quick links
===========
- `Home`_
- `Documentation`_
- `Download`_
- `Mailing list`_
- `What's new`_
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`_ FTP server implementation available for `Python`_
programming language.
Features
========
- Extremely **lightweight**, **fast** and **scalable** (see
`why <https://github.com/giampaolo/pyftpdlib/issues/203>`__ and
`benchmarks`_).
- Uses **sendfile(2)** (see `pysendfile <https://github.com/giampaolo/pysendfile>`__)
system call for uploads (Linux only).
- Uses ``epoll()`` / ``kqueue()`` / ``select()`` to handle concurrency
asynchronously.
- ...But can optionally skip to a `multiple thread / process`_ model (as in:
you'll be free to block or use slow filesystems).
- Portable: entirely written in pure Python.
- Supports **FTPS** (`RFC-4217`_), **IPv6** (`RFC-2428`_), **Unicode** file
names (`RFC-2640`_), **MLSD/MLST** commands (`RFC-3659`_).
- Support for virtual users and virtual filesystem.
- Flexible system of "authorizers" able to manage both "virtual" and
"real" users on on both
`UNIX <https://pyftpdlib.readthedocs.io/en/latest/tutorial.html#unix-ftp-server>`__
and
`Windows <https://pyftpdlib.readthedocs.io/en/latest/tutorial.html#windows-ftp-server>`__.
Performances
============
Despite being written in an interpreted language, pyftpdlib has transfer rates
comparable or superior to common UNIX FTP servers written in C. It usually
tends to scale better (see `benchmarks`_) because whereas vsftpd and proftpd
use multiple processes to achieve concurrency, pyftpdlib only uses one (see
`the C10K problem`_).
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** | **vsftpd** | **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 <https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__.
Command line usage
==================
Start a FTP server, with an anonymous user with write permissions, on port 2121:
.. code-block:: sh
$ python3 -m pyftpdlib --write
RuntimeWarning: write permissions assigned to anonymous user.
self._check_permissions(username, perm)
[I 2024-06-23 13:49:35] concurrency model: async
[I 2024-06-23 13:49:35] masquerade (NAT) address: None
[I 2024-06-23 13:49:35] passive ports: None
[I 2024-06-23 13:49:35] >>> starting FTP server on 0.0.0.0:2121, pid=763634 <<<
API usage
=========
.. 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="elradfmwMT")
>>> 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).
For other code samples read the `tutorial <https://pyftpdlib.readthedocs.io/en/latest/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 some money.
.. _`benchmarks`: https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html
.. _`Documentation`: https://pyftpdlib.readthedocs.io
.. _`donating`: https://gmpy.dev/donate
.. _`Download`: https://pypi.org/project/pyftpdlib/
.. _`Home`: https://github.com/giampaolo/pyftpdlib
.. _`Mailing list`: https://groups.google.com/group/pyftpdlib/topics
.. _`multiple thread / process`: https://pyftpdlib.readthedocs.io/en/latest/tutorial.html#changing-the-concurrency-model
.. _`Python`: https://www.python.org/
.. _`RFC-2428`: https://datatracker.ietf.org/doc/html/rfc2428
.. _`RFC-2640`: https://datatracker.ietf.org/doc/html/rfc2640
.. _`RFC-3659`: https://datatracker.ietf.org/doc/html/rfc3659
.. _`RFC-4217`: https://datatracker.ietf.org/doc/html/rfc4217
.. _`RFC-959`: https://datatracker.ietf.org/doc/html/rfc959.html
.. _`the C10K problem`: http://www.kegel.com/c10k.html
.. _`What's new`: https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst
|
