Issue 290 in pyftpdlib: [doc] add documentation of FTPServer constructor to help(pyftpdlib)

[pyft...@googlecode.com]

Status: New
Owner: ----
Labels: Type-Defect Priority-Medium Component-Library

New issue 290 by karl.ric...@gmail.com: [doc] add documentation of
FTPServer constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

help(pyftpdlib) doesn't contain any information about the handling of
address parameter passed to the constructor, futhermore I experienced the
following inconsistence between my version 1.2.0 (running on Ubuntu 14.04
with both python 2.7.6 and 3.4.0) and the wiki:
<code>
python -m pyftpdlib -i 127.0.0.1 -p 8021
</code>
returns
<output>
[I 14-05-11 01:31:48] >>> starting FTP server on 127.0.0.1:8021, pid=21752
<<<
[I 14-05-11 01:31:48] poller: <class 'pyftpdlib.ioloop.Epoll'>
[I 14-05-11 01:31:48] masquerade (NAT) address: None
[I 14-05-11 01:31:48] passive ports: None
[I 14-05-11 01:31:48] use sendfile(2): True
</output>
instead of
<output>
[I 13-02-20 14:16:36] >>> starting FTP server on 0.0.0.0:21 <<<
[I 13-02-20 14:16:36] poller: <class 'pyftpdlib.ioloop.Epoll'>
[I 13-02-20 14:16:36] masquerade (NAT) address: None
[I 13-02-20 14:16:36] passive ports: None
[I 13-02-20 14:16:36] use sendfile(2): True
</output>
as shown in the wiki https://code.google.com/p/pyftpdlib/wiki/FAQ.

Besides a general need for this improvement of the docs, I need
clearification in order to investigate further and file a bug report if
necessary.

--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[pyft...@googlecode.com]

Comment #1 on issue 290 by karl.ric...@gmail.com: [doc] add documentation

of FTPServer constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

port in the second output should be 8021 instead of 21 (can't edit :( )

[pyft...@googlecode.com]

Comment #2 on issue 290 by g.rodola: [doc] add documentation of FTPServer

constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

> help(pyftpdlib) doesn't contain any information about the handling of
> address parameter passed to the constructor,

What do you mean? The "address" parameter is already explained in the doc.
help(pyftpdlib) is not meant to provide an extended set of information,
just a brief description of the lib and a quick & dirty example usage.

As for the "port 8021" issue: I just edited the doc (thanks for signaling).

[pyft...@googlecode.com]

Comment #3 on issue 290 by karl.ric...@gmail.com: [doc] add documentation

of FTPServer constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

It is not clear whether the address is the address where pyftpdlib listens
(I assumed this from 0.0.0.0) or the address where the socket is created.

[pyft...@googlecode.com]

Comment #4 on issue 290 by g.rodola: [doc] add documentation of FTPServer

constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

> [...] or the address where the socket is created.

This doesn't make sense.
The ip:port pair is the address where the socket *listens*, and it should
be clear if you're used to network/socket programming.

[pyft...@googlecode.com]

Comment #5 on issue 290 by karl.ric...@gmail.com: [doc] add documentation

of FTPServer constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

OK, I thought it might be some sort of access restriction for client (as I
partly pointed out initially, I needed clearification to check whether
access works). It should be clearer with the correction of the example :)

[pyft...@googlecode.com]

Updates:
Status: Invalid

Comment #6 on issue 290 by g.rodola: [doc] add documentation of FTPServer

constructor to help(pyftpdlib)
http://code.google.com/p/pyftpdlib/issues/detail?id=290

(No comment was entered for this change.)