fixes to pass pylint docstring items

-fix formatting issues
-any missed docstrings

Author: fnmeyer

end-to-end-tests/tests.py

@@ -1,3 +1,4 @@
+"""Test end-to-end functionality for sysrsync."""
 import inspect
 import os
 import sys
@@ -11,7 +12,10 @@
 
 
 class TestE2E(unittest.TestCase):
+    """Test end-to-end functionality."""
+
     def test_send_file(self):
+        """Test sending a file from local to remote."""
         sysrsync.run(source="end-to-end-tests/test-cases/test_file",
                      destination="/tmp/target_test_file",
                      destination_ssh="test@openssh-server",
@@ -20,6 +24,7 @@ def test_send_file(self):
                      strict_host_key_checking=False)
 
     def test_send_file_with_spaces(self):
+        """Test sending a file with spaces from local to remote."""
         sysrsync.run(source="end-to-end-tests/test-cases/file with spaces",
                      destination="/tmp/target_test_file",
                      destination_ssh="test@openssh-server",

setup.py

@@ -1,3 +1,4 @@
+"""Setup script for sysrsync."""
 import setuptools
 import toml
 

sysrsync/__init__.py

@@ -1,2 +1,3 @@
+"""sysrsync: A Python wrapper for rsync."""
 from .command_maker import *
 from .runner import run

sysrsync/command_maker.py

@@ -1,3 +1,4 @@
+"""Generates the rsync command."""
 import os
 import os.path
 from typing import Iterable, List, Optional
@@ -17,9 +18,7 @@ def get_rsync_command(source: str,
                       private_key: Optional[str] = None,
                       rsh_port: Optional[int] = None,
                       strict_host_key_checking: Optional[bool] = None) -> List[str]:
-    """
-    Generates the rsync command with the specified options for synchronizing files and
-        directories.
+    """Generate rsync command with the specified options for synchronizing files and directories.
 
     Args:
         source (str): The source directory or file path.

sysrsync/exceptions.py

@@ -1,3 +1,4 @@
+"""Exceptions for sysrsync."""
 class RemotesError(Exception):
     """
     Exception raised when both the source and destination are remote.
@@ -8,14 +9,14 @@ class RemotesError(Exception):
     """
 
     def __init__(self):
+        """Initialize the RemotesError exception."""
         message = 'source and destination cannot both be remote'
         super().__init__(message)
 
 
 class RsyncError(Exception):
-    """
-    Exception raised for errors related to rsync operations.
-    """
+    """Exception raised for errors related to rsync operations."""
+
     pass
 
 
@@ -31,5 +32,6 @@ class PrivateKeyError(Exception):
     """
 
     def __init__(self, key_file):
+        """Initialize the PrivateKeyError exception."""
         message = f'Private Key File "{key_file}" does not exist'
         super().__init__(message)

sysrsync/helpers/__init__.py

@@ -0,0 +1 @@
+"""Helpers for sysrsync."""

sysrsync/helpers/directories.py

@@ -1,9 +1,10 @@
+"""Directory helper functions for sysrsync."""
 from typing import Tuple, Optional
 
 
 def get_directory_with_ssh(directory: str, ssh: Optional[str]) -> str:
     """
-    Returns the directory path with SSH prefix if SSH is provided.
+    Return the directory path with SSH prefix if SSH is provided.
 
     Args:
         directory (str): The directory path.
@@ -46,7 +47,7 @@ def sanitize_trailing_slash(source_dir, target_dir, sync_sourcedir_contents=True
 
 def strip_trailing_slash(directory: str) -> str:
     """
-    Strips the trailing slash from the directory path if it exists.
+    Strip the trailing slash from the directory path if it exists.
 
     Args:
         directory (str): The directory path.
@@ -55,14 +56,12 @@ def strip_trailing_slash(directory: str) -> str:
         str: The directory path without the trailing slash, if present. Otherwise,
             returns the directory path as is.
     """
-
     return (directory[:-1]
             if directory.endswith('/')
             else directory)
 
 def add_trailing_slash(directory: str) -> str:
-    """
-    Adds a trailing slash to the directory path if it doesn't already have one.
+    """Add a trailing slash to the directory path if it doesn't already have one.
 
     Args:
         directory (str): The directory path.
@@ -71,7 +70,6 @@ def add_trailing_slash(directory: str) -> str:
         str: The directory path with a trailing slash, if it doesn't already have one.
             Otherwise, returns the directory path as is.
     """
-
     return (directory
             if directory.endswith('/')
             else f'{directory}/')

sysrsync/helpers/iterators.py

@@ -1,3 +1,4 @@
+"""Iterator helper functions for sysrsync."""
 import collections
 
 if 'Iterable' in dir(collections):
@@ -11,9 +12,6 @@
 
 
 def flatten(input_iter: Iterable[Any]) -> List[Any]:
-    list_of_lists = (element if isinstance(element, Iterable)
-                     else [element]
-                     for element in input_iter)
     """
     Flattens an iterable by converting nested iterables into a single flat list.
 
@@ -24,5 +22,8 @@ def flatten(input_iter: Iterable[Any]) -> List[Any]:
         List[Any]: A list containing all the elements from the input iterable, with
             nested iterables flattened.
     """
+    list_of_lists = (element if isinstance(element, Iterable)
+                     else [element]
+                     for element in input_iter)
 
     return reduce(iconcat, list_of_lists, [])

sysrsync/helpers/rsync.py

@@ -1,3 +1,4 @@
+"""Generates rsync arguments based on the provided options for sysrsync."""
 import os
 from pathlib import Path
 from typing import Iterable, List, Optional
@@ -7,8 +8,7 @@
 
 
 def get_exclusions(exclusions: Iterable[str]) -> Iterable[str]:
-    """
-    Generates a list of rsync exclusion arguments based on the provided exclusions.
+    """Generate a list of rsync exclusion arguments based on the provided exclusions.
 
     Args:
         exclusions (Iterable[str]): The exclusions to be used for generating the rsync
@@ -24,9 +24,7 @@ def get_exclusions(exclusions: Iterable[str]) -> Iterable[str]:
 
 
 def get_rsh_command(private_key: Optional[str] = None, port: Optional[int] = None, strict_host_key_checking: Optional[bool] = None):
-
-    """
-    Generates the rsync remote shell (rsh) command with the specified options.
+    """Generate rsync remote shell (rsh) command with the specified options.
 
     Args:
         private_key (Optional[str], optional): The path to the private key file.

sysrsync/runner.py

@@ -1,3 +1,4 @@
+"""Runs the rsync command with the specified options."""
 import os
 import subprocess
 
@@ -6,8 +7,7 @@
 
 
 def run(cwd=os.getcwd(), strict=True, verbose=False, **kwargs):
-    """
-    Runs the rsync command with the specified options.
+    """Run the rsync command with the specified options.
 
     Args:
         cwd (str, optional): The current working directory. Defaults to the current
@@ -39,8 +39,7 @@ def run(cwd=os.getcwd(), strict=True, verbose=False, **kwargs):
 
 
 def _check_return_code(return_code: int, action: str):
-    """
-    Checks the return code of an action and raises an exception if it is non-zero.
+    """Check the return code of an action and raises an exception if it is non-zero.
 
     Args:
         return_code (int): The return code of the action.