Changeset 1745:2402b8a75178

Timestamp:

Dec 29, 2018, 9:49:25 PM (3 years ago)

Author:

Stefan Schwarzer <sschwarzer@…>

Branch:

default

Children:

1746:72d797a82efe, 1762:d5ce348ec42f

Message:

Unify formatting of XXX-style comments

Use consistent format `# XXX: ...` for all FIXME, TODO and XXX
comments.

Files:

• Makefile (modified) (1 diff)
• ftputil/file_transfer.py (modified) (1 diff)
• ftputil/host.py (modified) (4 diffs)
• ftputil/stat.py (modified) (3 diffs)
• ftputil/stat_cache.py (modified) (2 diffs)
• ftputil/sync.py (modified) (3 diffs)

Makefile

@@ -26 +26 @@
 PYTHONPATH=${PROJECT_DIR}:${TEST_DIR}
 
-#TODO Some platforms call that script rst2html.py - allow both.
+# TODO: Some platforms call that script rst2html.py - allow both.
 RST2HTML=rst2html
 

ftputil/file_transfer.py

@@ -12 +12 @@
 
 
-#TODO Think a bit more about the API before making it public.
+# TODO: Think a bit more about the API before making it public.
 # # Only `chunks` should be used by clients of the ftputil library. Any
 # #  other functionality is supposed to be used via `FTPHost` objects.

ftputil/host.py

@@ -62 +62 @@
         self._args = args
         self._kwargs = kwargs
-        #XXX Maybe put the following in a `reset` method.
+        # XXX: Maybe put the following in a `reset` method.
         # The time shift setting shouldn't be reset though.
         # Make a session according to these arguments.
@@ -142 +142 @@
         there aren't any.
         """
-        #TODO: Currently timed-out child sessions aren't removed and
+        # TODO: Currently timed-out child sessions aren't removed and
         # may collect over time. In very busy or long running
         # processes, this might slow down an application because the
@@ -694 +694 @@
             raise ftputil.error.PermanentError("directory '{}' not empty".
                                                format(path))
-        #XXX How does `rmd` work with links?
+        # XXX: How does `rmd` work with links?
         def command(self, path):
             """Callback function."""
@@ -817 +817 @@
                 self._session.rename(source, target)
 
-    #XXX One could argue to put this method into the `_Stat` class, but
-    # I refrained from that because then `_Stat` would have to know
-    # about `FTPHost`'s `_session` attribute and in turn about
+    # XXX: One could argue to put this method into the `_Stat` class,
+    # but I refrained from that because then `_Stat` would have to
+    # know about `FTPHost`'s `_session` attribute and in turn about
     # `_session`'s `dir` method.
     def _dir(self, path):

ftputil/stat.py

@@ -139 +139 @@
                                             format(mode_string))
         st_mode = 0
-        #TODO Add support for "S" and sticky bit ("t", "T").
+        # TODO: Add support for "S" and sticky bit ("t", "T").
         for bit in mode_string[1:10]:
             bit = (bit != "-")
@@ -274 +274 @@
             # supposed (rounded) and the actual time shift.
             #
-            # XXX The downside of this "correction" is that there is
+            # XXX: The downside of this "correction" is that there is
             # a one-minute time interval exactly one year ago that
             # may cause that datetime to be recognized as the current
@@ -633 +633 @@
         # Path was not found during the loop.
         if _exception_for_missing_path:
-            #TODO Use FTP `LIST` command on the file to implicitly use
-            # the usual status code of the server for missing files
-            # (450 vs. 550).
+            # TODO: Use FTP `LIST` command on the file to implicitly
+            # use the usual status code of the server for missing
+            # files (450 vs. 550).
             raise ftputil.error.PermanentError(
                   "550 {}: no such file or directory".format(path))

ftputil/stat_cache.py

@@ -96 +96 @@
         raise an exception.
         """
-        #XXX To be 100 % sure, this should be `host.sep`, but I don't
-        # want to introduce a reference to the `FTPHost` object for
-        # only that purpose.
+        # XXX: To be 100 % sure, this should be `host.sep`, but I
+        # don't want to introduce a reference to the `FTPHost` object
+        # for only that purpose.
         assert path.startswith("/"), ("{} must be an absolute path".
                                       format(path))
@@ -120 +120 @@
                     "entry for path {} has expired".format(path))
         else:
-            #XXX I don't know if this may raise a `CacheMissError` in
-            # case of race conditions. I prefer robust code.
+            # XXX: I don't know if this may raise a `CacheMissError`
+            # in case of race conditions. I prefer robust code.
             try:
                 return self._cache[path]

ftputil/sync.py

@@ -80 +80 @@
         it's actually a file, raise a `SyncError`.
         """
-        #TODO Handle setting of target mtime according to source mtime
+        # TODO: Handle setting of target mtime according to source mtime
         # (beware of rootdir anomalies; try to handle them as well).
         #print("Making", target_dir)
@@ -93 +93 @@
 
     def _sync_file(self, source_file, target_file):
-        #XXX This duplicates code from `FTPHost._copyfileobj`. Maybe
+        # XXX: This duplicates code from `FTPHost._copyfileobj`. Maybe
         # implement the upload and download methods in terms of
         # `_sync_file`, or maybe not?
-        #TODO Handle `IOError`s
-        #TODO Handle conditional copy
-        #TODO Handle setting of target mtime according to source mtime
+        # TODO: Handle `IOError`s
+        # TODO: Handle conditional copy
+        # TODO: Handle setting of target mtime according to source mtime
         # (beware of rootdir anomalies; try to handle them as well).
         #print("Syncing", source_file, "->", target_file)
@@ -153 +153 @@
         This method handles both directory trees and single files.
         """
-        #TODO Handle making of missing intermediate directories
+        # TODO: Handle making of missing intermediate directories.
         source_path = self._source.path.abspath(source_path)
         target_path = self._target.path.abspath(target_path)