Bump pydocstyle from 3.0.0 to 4.0.1

requirements/check.txt

@@ -9,7 +9,7 @@ flake8-print==3.1.0
 isort==4.3.21
 m2r==0.2.1
 pep8-naming==0.8.2
-pydocstyle==3.0.0
+pydocstyle==4.0.1
 pygments==2.4.2
 pylint==2.3.1
 readme-renderer==24.0

src/watchmaker/__init__.py

@@ -163,6 +163,7 @@ class Arguments(dict):
                 # This list would be converted to the following dict and merged
                 # into the parameters passed to the worker configurations:
                 {'arg1': 'value1', 'arg2': 'value2'}
+
     """
 
     def __init__(
@@ -203,6 +204,7 @@ class Client(object):
     Keyword Arguments:
         arguments: (:obj:`Arguments`)
             A dictionary of arguments. See :class:`watchmaker.Arguments`.
+
     """
 
     def __init__(self, arguments):

src/watchmaker/logger/__init__.py

@@ -84,6 +84,7 @@ def make_log_dir(log_dir):
     Args:
         log_dir: (:obj:`str`)
         Path to a directory.
+
     """
     if not os.path.exists(log_dir):
         os.makedirs(log_dir)
@@ -123,6 +124,7 @@ def prepare_logging(log_dir, log_level):
             - ``warning``
             - ``info``
             - ``debug``
+
     """
     logformat = (
         '%(asctime)s [%(name)s][%(levelname)-5s][%(process)s]: %(message)s'

src/watchmaker/managers/platform.py

@@ -71,6 +71,7 @@ def retrieve_file(self, url, filename):
 
             filename: (:obj:`str`)
                 Path where the file will be saved.
+
         """
         # Convert a local path to a URI
         url = watchmaker.utils.uri_from_filepath(url)
@@ -268,6 +269,7 @@ def extract_contents(self, filepath, to_directory, create_dir=False):
                 Switch to control the creation of a subdirectory within
                 ``to_directory`` named for the filename of the compressed file.
                 (*Default*: ``False``)
+
         """
         if filepath.endswith('.zip'):
             self.log.debug('File Type: zip')

src/watchmaker/utils/__init__.py

@@ -77,6 +77,7 @@ def copytree(src, dst, force=False, **kwargs):
         force: (:obj:`bool`)
             Whether to delete destination prior to copy.
             (*Default*: ``False``)
+
     """
     if force and os.path.exists(dst):
         shutil.rmtree(dst)

src/watchmaker/workers/salt.py

@@ -83,6 +83,7 @@ class SaltBase(WorkerBase, PlatformManagerBase):
             computer account will be created when joining a domain.
             E.g. ``"OU=SuperCoolApp,DC=example,DC=com"``
             (*Default*: ``''``)
+
     """
 
     def __init__(self, *args, **kwargs):
@@ -319,6 +320,7 @@ def run_salt(self, command, **kwargs):
                 Watchmaker will always begin the command with the options
                 ``--local``, ``--retcode-passthrough``, and ``--no-color``, so
                 do not specify those options in the command.
+
         """
         cmd = [
             self.salt_call,
@@ -551,6 +553,7 @@ class SaltLinux(SaltBase, LinuxPlatformManager):
             A git reference present in ``git_repo``, such as a commit or a tag.
             If not specified, the HEAD of the default branch is used.
             (*Default*: ``''``)
+
     """
 
     def __init__(self, *args, **kwargs):
@@ -706,6 +709,7 @@ class SaltWindows(SaltBase, WindowsPlatformManager):
             salt formula. E.g. ``"MemberServer"``, ``"DomainController"``, or
             ``"Workstation"``
             (*Default*: ``''``)
+
     """
 
     def __init__(self, *args, **kwargs):

src/watchmaker/workers/yum.py

@@ -21,6 +21,7 @@ class Yum(WorkerBase, LinuxPlatformManager):
         repo_map: (:obj:`list`)
             List of dictionaries containing a map of yum repo files to systems.
             (*Default*: ``[]``)
+
     """
 
     SUPPORTED_DISTS = ('amazon', 'centos', 'red hat')

tests/test_saltworker.py

@@ -32,6 +32,7 @@ def test_default_valid_environments(saltworker_client):
 
     Args:
         saltworker_client: (:obj:`src.workers.SaltBase`)
+
     """
     # test that the defaults work
     assert saltworker_client.before_install() is None
@@ -43,6 +44,7 @@ def test_bogus_environment(saltworker_client):
 
     Args:
         saltworker_client: (:obj:`src.workers.SaltBase`)
+
     """
     # ensure InvalidValue is raised when a bogus environment type is selected
     with pytest.raises(InvalidValue):
@@ -57,6 +59,7 @@ def test_valid_environment(saltworker_client):
 
     Args:
         saltworker_client: (:obj:`src.workers.SaltBase`)
+
     """
     saltworker_client.ent_env = 'dev'
     saltworker_client.valid_envs = [None, 'dev', 'test', 'prod']