docstrings, re-order methods.

python · barneygale · Jul 6, 2024 · Jun 20, 2024 · Jun 20, 2024 · Jun 21, 2024
commit 15cc3db3e8ef1742b5c627578e4683ee0e994312
@@ -790,6 +790,18 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=False):
         """
         raise UnsupportedOperation(self._unsupported_msg('mkdir()'))
 
+    def _get_metadata(self, follow_symlinks):
+        """
+        Returns path metadata as a dict with string keys.
+        """
+        return {}
+
+    def _set_metadata(self, metadata, follow_symlinks):
+        """
+        Sets path metadata from the given dict with string keys.
+        """
+        pass
+
     def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
         """
         Copy the contents of this file to the given target. If this file is a
@@ -819,12 +831,6 @@ def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
         if preserve_metadata:
             target._set_metadata(self._get_metadata(True), True)
 
-    def _get_metadata(self, follow_symlinks):
-        return {}
-
-    def _set_metadata(self, metadata, follow_symlinks):
-        pass
-
     def copytree(self, target, *, follow_symlinks=True, dirs_exist_ok=False,
                  ignore=None, on_error=None):
         """

@@ -781,6 +781,9 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=False):
             if not exist_ok or not self.is_dir():
                 raise
 
+    _get_metadata = get_file_metadata
+    _set_metadata = set_file_metadata
+
     if copyfile:
         def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
             """
@@ -800,9 +803,6 @@ def copy(self, target, *, follow_symlinks=True, preserve_metadata=False):
                 raise
             copyfile(os.fspath(self), target, follow_symlinks)
 
-    _get_metadata = get_file_metadata
-    _set_metadata = set_file_metadata
-
     def chmod(self, mode, *, follow_symlinks=True):
         """
         Change the permissions of the path, like os.chmod().

@@ -160,6 +160,9 @@ def copyfileobj(source_f, target_f):
 
 
 def get_file_metadata(path, follow_symlinks):
+    """
+    Returns local path metadata as a dict with string keys.
+    """
     st = os.stat(path, follow_symlinks=follow_symlinks)
     result = {
         'mode': stat.S_IMODE(st.st_mode),
@@ -180,6 +183,9 @@ def get_file_metadata(path, follow_symlinks):
 
 
 def set_file_metadata(path, metadata, follow_symlinks):
+    """
+    Sets local path metadata from the given dict with string keys.
+    """
     def _nop(*args, ns=None, follow_symlinks=None):
         pass