diff options
author | willmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-01-02 21:47:12 +0000 |
---|---|---|
committer | willmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-01-02 21:47:12 +0000 |
commit | 407775dd6ad8f46cdb4343a0905ca476411223b7 (patch) | |
tree | 6419f1f0ac64d382f893f1fdbfe1771f26327d27 | |
parent | f77f8fe564cc029423bbe20498df4f4a9ac29bf6 (diff) | |
download | pyfilesystem-git-407775dd6ad8f46cdb4343a0905ca476411223b7.tar.gz |
More doc tweaks
-rw-r--r-- | docs/conf.py | 2 | ||||
-rw-r--r-- | docs/filesystems.rst | 2 | ||||
-rw-r--r-- | fs/ftpfs.py | 29 | ||||
-rw-r--r-- | fs/memoryfs.py | 2 |
4 files changed, 21 insertions, 14 deletions
diff --git a/docs/conf.py b/docs/conf.py index a6347d1..61069f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -192,3 +192,5 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True + +autoclass_content = 'both' diff --git a/docs/filesystems.rst b/docs/filesystems.rst index 5e94ef2..da01faa 100644 --- a/docs/filesystems.rst +++ b/docs/filesystems.rst @@ -29,7 +29,7 @@ OS An interface to the OS Filesystem. See :mod:`fs.osfs` Secure FTP (Secure FTP) ----------------------- +----------------------- A secure FTP filesystem. See :mod:`fs.sftpfs` diff --git a/fs/ftpfs.py b/fs/ftpfs.py index 4f3371d..2b342e4 100644 --- a/fs/ftpfs.py +++ b/fs/ftpfs.py @@ -2,10 +2,12 @@ fs.ftpfs ======== -FTPS is a filesystem for accessing an FTP server (uses ftplib in standard library) +FTPFS is a filesystem for accessing an FTP server (uses ftplib in standard library) """ +__all__ = ['FTPFS'] + import fs from fs.base import * from fs.path import pathsplit @@ -26,7 +28,6 @@ except ImportError: import time import sys -__all__ = ['FTPFS'] # ----------------------------------------------- # Taken from http://www.clapper.org/software/python/grizzled/ @@ -745,16 +746,20 @@ class FTPFS(FS): port=21, dircache=True, max_buffer_size=128*1024*1024): - """ - :param host: - :param user: - :param passwd: - :param timeout: + """ Connect to a FTP server. + + :param host: Host to connect to + :param user: Username, or a blank string for anonymous + :param passwd: Password, if required + :param acct: Accounting information (few servers require this) + :param timeout: Timeout in seconds + :param port: Port to connection (default is 21) :param dircache: If True then directory information will be cached, - which will speed up operations such as getinfo, isdi, isfile, but changes - to the ftp file structure will not be visible untill clear_dircache is - called - :param max_buffer_size: Number of bytes to hold before blocking write operations. + which will speed up operations such as getinfo, isdi, isfile, but + changes to the ftp file structure will not be visible until + `~fs.ftpfs.FTPFS.clear_dircache` is called + :param dircache: If True directory information will be cached for fast access + :param max_buffer_size: Number of bytes to hold before blocking write operations """ @@ -845,7 +850,7 @@ class FTPFS(FS): """ Clear cached directory information. - :path: Path of directory to clear cache for, or all directories if + :param path: Path of directory to clear cache for, or all directories if None (the default) """ diff --git a/fs/memoryfs.py b/fs/memoryfs.py index 36d997e..a88d8f7 100644 --- a/fs/memoryfs.py +++ b/fs/memoryfs.py @@ -180,7 +180,7 @@ class MemoryFS(FS): return self.dir_entry_factory(*args, **kwargs)
def __init__(self, file_factory=None):
- FS.__init__(self, thread_synchronize=_thread_syncronize_default)
+ super(FS, self).__init__(thread_synchronize=_thread_syncronize_default)
self.dir_entry_factory = DirEntry
self.file_factory = file_factory or MemoryFile
|