Changeset 852:f883b3708318

Timestamp:

2010-02-11 21:43:49 (6 months ago)

Author:

Stefan Schwarzer <sschwarzer@…>

Branch:

default

Message:

Add a `_st_mtime_precision` value to stat result objects.

This contains the precision of the modification timestamp in
seconds. I plan to use this for a more robust decision in the
`upload_if_newer` and `download_if_newer` methods.

Files:

• _test_ftp_stat.py (modified) (3 diffs)
• ftp_stat.py (modified) (10 diffs)

_test_ftp_stat.py

@@ -1 @@
-# Copyright (C) 2003-2009, Stefan Schwarzer
+# Copyright (C) 2003-2010, Stefan Schwarzer
 # All rights reserved.
 #
@@ -280 +280 @@
             self.failIf(isinstance(exc_obj, ftp_error.FTPOSError))
 
-    def test_lstat_one_file(self):
-        """Test `lstat` for a file."""
+    def test_lstat_one_unix_file(self):
+        """Test `lstat` for a file described in Unix-style format."""
         stat_result = self.stat.lstat('/home/sschwarzer/index.html')
         self.assertEqual(oct(stat_result.st_mode), '0100644')
         self.assertEqual(stat_result.st_size, 4604)
-
-    def test_lstat_one_dir(self):
-        """Test `lstat` for a directory."""
+        self.assertEqual(stat_result._st_mtime_precision, 60)
+
+    def test_lstat_one_ms_file(self):
+        """Test `lstat` for a file described in DOS-style format."""
+        stat_result = self.stat.lstat('/home/msformat/abcd.exe')
+        self.assertEqual(stat_result._st_mtime_precision, 60)
+
+    def test_lstat_one_unix_dir(self):
+        """Test `lstat` for a directory described in Unix-style format."""
         stat_result = self.stat.lstat('/home/sschwarzer/scios2')
         self.assertEqual(oct(stat_result.st_mode), '042755')
@@ -300 +306 @@
                         stat_tuple_to_seconds((1999, 9, 20, 0, 0, 0)))
         self.assertEqual(stat_result.st_ctime, None)
+        self.assertEqual(stat_result._st_mtime_precision, 24*60*60)
         self.failUnless(stat_result ==
           (17901, None, None, 6, '45854', '200', 512, None,
            stat_tuple_to_seconds((1999, 9, 20, 0, 0, 0)), None))
+
+    def test_lstat_one_ms_dir(self):
+        """Test `lstat` for a directory described in DOS-style format."""
+        stat_result = self.stat.lstat('/home/msformat/WindowsXP')
+        self.assertEqual(stat_result._st_mtime_precision, 60)
 
     def test_lstat_via_stat_module(self):

ftp_stat.py

@@ -1 @@
-# Copyright (C) 2002-2008, Stefan Schwarzer
+# Copyright (C) 2002-2010, Stefan Schwarzer
 # All rights reserved.
 #
@@ -148 +148 @@
 
     def parse_unix_time(self, month_abbreviation, day, year_or_time,
-                        time_shift):
+                        time_shift, with_precision=False):
         """
         Return a floating point number, like from `time.mktime`, by
@@ -155 +155 @@
         "time on server" - "time on client" and is available as the
         `time_shift` parameter in the `parse_line` interface.
+
+        If `with_precision` is true (default: false), return a
+        two-element tuple consisting of the floating point number as
+        described in the previous paragraph and the precision of the
+        time in seconds. This takes into account that, for example, a
+        time string like "May 26  2005" has only a precision of one
+        day. This information is important for the `upload_if_newer`
+        and `download_if_newer` methods in the `FTPHost` class.
 
         Times in Unix-style directory listings typically have one of
@@ -176 +184 @@
             st_mtime = time.mktime( (year, month, day,
                                      hour, minute, 0, 0, 0, -1) )
+            # precise up to a day
+            st_mtime_precision = 24 * 60 * 60
         else:
             # `year_or_time` is a time hh:mm
@@ -184 +194 @@
             st_mtime = time.mktime( (year, month, day,
                                      hour, minute, 0, 0, 0, -1) )
+            # precise up to a minute
+            st_mtime_precision = 60
             # rhs of comparison: transform client time to server time
             #  (as on the lhs), so both can be compared with respect
@@ -199 +211 @@
                 st_mtime = time.mktime( (year-1, month, day,
                                          hour, minute, 0, 0, 0, -1) )
-        return st_mtime
+        if with_precision:
+            return (st_mtime, st_mtime_precision)
+        else:
+            return st_mtime
 
     def parse_ms_time(self, date, time_, time_shift):
@@ -221 +236 @@
         # don't complain about unused `time_shift` argument
         # pylint: disable-msg=W0613
+        # For the time being, I don't add a `with_precision`
+        #  parameter as in the Unix parser because the precision for
+        #  the DOS format is always a minute and can be set in
+        #  `MSParser.parse_line`. Should you find yourself needing
+        #  support for `with_precision` for a derived class, please
+        #  write a mail (see ftputil.txt/html).
         try:
             month, day, year = [int(part) for part in date.split('-')]
@@ -294 +315 @@
         st_atime = None
         # st_mtime
-        st_mtime = self.parse_unix_time(month, day, year_or_time, time_shift)
+        st_mtime, st_mtime_precision = \
+          self.parse_unix_time(month, day, year_or_time, time_shift,
+                               with_precision=True)
         # st_ctime
         st_ctime = None
@@ -305 +328 @@
                       (st_mode, st_ino, st_dev, st_nlink, st_uid,
                        st_gid, st_size, st_atime, st_mtime, st_ctime) )
+        stat_result._st_mtime_precision = st_mtime_precision
         stat_result._st_name = st_name
         stat_result._st_target = st_target
@@ -362 +386 @@
         stat_result._st_name = name
         stat_result._st_target = None
+        # mtime precision in seconds
+        stat_result._st_mtime_precision = 60
         return stat_result