--- a/src/eric7/Utilities/FtpUtilities.py Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Utilities/FtpUtilities.py Thu Dec 21 19:50:01 2023 +0100
@@ -46,7 +46,8 @@
"""
Constructor
- @param parent reference to the parent object (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -57,8 +58,10 @@
"""
Private method to check, if the line should be ignored.
- @param line to check (string)
- @return flag indicating to ignore the line (boolean)
+ @param line to check
+ @type str
+ @return flag indicating to ignore the line
+ @rtype bool
"""
return line.strip() == "" or line.strip().lower().startswith("total ")
@@ -67,8 +70,10 @@
Private method to parse a Unix mode string modifying the
given URL info object.
- @param modeString mode string to be parsed (string)
- @param urlInfo reference to the URL info object (EricUrlInfo)
+ @param modeString mode string to be parsed
+ @type str
+ @param urlInfo reference to the URL info object
+ @type EricUrlInfo
@exception FtpDirLineParserError Raised if the mode cannot be parsed.
"""
if len(modeString) != 10:
@@ -123,10 +128,14 @@
<li>"May 26 2005" (month name, day of month, year)</li>
</ul>
- @param monthAbbreviation abbreviation of the month name (string)
- @param day day of the month (string)
- @param yearOrTime string giving the year or a time (string)
- @param urlInfo reference to the URL info object (EricUrlInfo)
+ @param monthAbbreviation abbreviation of the month name
+ @type str
+ @param day day of the month
+ @type str
+ @param yearOrTime string giving the year or a time
+ @type str
+ @param urlInfo reference to the URL info object
+ @type EricUrlInfo
@exception FtpDirLineParserError Raised if the month abbreviation is
not recognized.
"""
@@ -157,10 +166,12 @@
It splits the line into meta data, number of links, user, group, size,
month, day, year or time and name.
- @param line directory line to split (string)
+ @param line directory line to split
+ @type str
@return tuple of nine strings giving the meta data,
number of links, user, group, size, month, day, year or time
and name
+ @rtype tuple
@exception FtpDirLineParserError Raised if the line is not of a
recognized Unix format.
"""
@@ -191,8 +202,10 @@
"""
Private method to parse a Unix style directory listing line.
- @param line directory line to be parsed (string)
- @return URL info object containing the valid data (EricUrlInfo)
+ @param line directory line to be parsed
+ @type str
+ @return URL info object containing the valid data
+ @rtype EricUrlInfo
"""
(
modeString,
@@ -232,9 +245,12 @@
have the format "10-23-12 03:25PM" (month-day_of_month-two_digit_year,
hour:minute, am/pm).
- @param date date string (string)
- @param time time string (string)
- @param urlInfo reference to the URL info object (EricUrlInfo)
+ @param date date string
+ @type str
+ @param time time string
+ @type str
+ @param urlInfo reference to the URL info object
+ @type EricUrlInfo
@exception FtpDirLineParserError Raised if either of the strings is not
recognized.
"""
@@ -261,8 +277,10 @@
"""
Private method to parse a Windows style directory listing line.
- @param line directory line to be parsed (string)
- @return URL info object containing the valid data (EricUrlInfo)
+ @param line directory line to be parsed
+ @type str
+ @return URL info object containing the valid data
+ @rtype EricUrlInfo
@exception FtpDirLineParserError Raised if the line is not of a
recognized Windows format.
"""
@@ -318,8 +336,10 @@
listings. It tries Unix style first and if that fails switches
to Windows style. If that fails as well, an exception is raised.
- @param line directory line to be parsed (string)
- @return URL info object containing the valid data (EricUrlInfo)
+ @param line directory line to be parsed
+ @type str
+ @return URL info object containing the valid data
+ @rtype EricUrlInfo
"""
if self.__ignoreLine(line):
return None
