summaryrefslogtreecommitdiff
path: root/paramiko/sftp_attr.py
diff options
context:
space:
mode:
authorOlle Lundberg <olle.lundberg@klarna.com>2014-01-23 11:32:59 +0100
committerOlle Lundberg <olle.lundberg@klarna.com>2014-01-23 11:32:59 +0100
commit24635609dc5ab8aff2e7fa3f34c4993cbc424579 (patch)
tree7be1e6ee8e6df7e90c188cd8949cbb8fba9e372e /paramiko/sftp_attr.py
parentdde21a7de09bd92a6a362a26009a56a942b3d246 (diff)
downloadparamiko-24635609dc5ab8aff2e7fa3f34c4993cbc424579.tar.gz
Epydoc -> Sphinx.
Diffstat (limited to 'paramiko/sftp_attr.py')
-rw-r--r--paramiko/sftp_attr.py26
1 files changed, 13 insertions, 13 deletions
diff --git a/paramiko/sftp_attr.py b/paramiko/sftp_attr.py
index b459b04b..267bc3ab 100644
--- a/paramiko/sftp_attr.py
+++ b/paramiko/sftp_attr.py
@@ -26,8 +26,8 @@ class SFTPAttributes (object):
"""
Representation of the attributes of a file (or proxied file) for SFTP in
client or server mode. It attemps to mirror the object returned by
- C{os.stat} as closely as possible, so it may have the following fields,
- with the same meanings as those returned by an C{os.stat} object:
+ ``os.stat`` as closely as possible, so it may have the following fields,
+ with the same meanings as those returned by an ``os.stat`` object:
- st_size
- st_uid
- st_gid
@@ -36,8 +36,8 @@ class SFTPAttributes (object):
- st_mtime
Because SFTP allows flags to have other arbitrary named attributes, these
- are stored in a dict named C{attr}. Occasionally, the filename is also
- stored, in C{filename}.
+ are stored in a dict named ``attr``. Occasionally, the filename is also
+ stored, in ``filename``.
"""
FLAG_SIZE = 1
@@ -61,15 +61,15 @@ class SFTPAttributes (object):
def from_stat(cls, obj, filename=None):
"""
- Create an SFTPAttributes object from an existing C{stat} object (an
- object returned by C{os.stat}).
-
- @param obj: an object returned by C{os.stat} (or equivalent).
- @type obj: object
- @param filename: the filename associated with this file.
- @type filename: str
- @return: new L{SFTPAttributes} object with the same attribute fields.
- @rtype: L{SFTPAttributes}
+ Create an SFTPAttributes object from an existing ``stat`` object (an
+ object returned by ``os.stat``).
+
+ :param obj: an object returned by ``os.stat`` (or equivalent).
+ :type obj: object
+ :param filename: the filename associated with this file.
+ :type filename: str
+ :return: new :class:`SFTPAttributes` object with the same attribute fields.
+ :rtype: :class:`SFTPAttributes`
"""
attr = cls()
attr.st_size = obj.st_size