Merge pull request #218 from Nurdok/drop_pep257_back_comp

Remove `pep257` entry point (drop backward compatibility)

Author: Nurdok

docs/release_notes.rst

@@ -10,6 +10,11 @@ Current Development Version
 Major Updates
 
 * Support for Python 2.6 has been dropped (#206, #217).
+* Support for the ``pep257`` console script has been dropped. Only the
+  ``pydocstyle`` console script should be used (#216, #218).
+
+New Features
+
 * Decorator-based skipping via ``--ignore-decorators`` has been added (#204).
 
 Bug Fixes
@@ -21,8 +26,8 @@ Bug Fixes
 
 Bug Fixes
 
-* Fixed an issue where the `flake8-docstrings` failed when accessing some
-  public API from `pydocstyle`.
+* Fixed an issue where the ``flake8-docstrings`` failed when accessing some
+  public API from ``pydocstyle``.
 
 
 1.1.0 - September 29th, 2016

setup.py

@@ -34,7 +34,6 @@
     entry_points={
         'console_scripts': [
             'pydocstyle = pydocstyle.cli:main',
-            'pep257 = pydocstyle.cli:main_pep257',
         ],
     },
 )

src/pydocstyle/cli.py

@@ -17,7 +17,7 @@ class ReturnCode(object):
     invalid_options = 2
 
 
-def run_pydocstyle(use_pep257=False):
+def run_pydocstyle():
     log.setLevel(logging.DEBUG)
     conf = ConfigurationParser()
     setup_stream_handlers(conf.get_default_run_configuration())
@@ -32,12 +32,6 @@ def run_pydocstyle(use_pep257=False):
     # Reset the logger according to the command line arguments
     setup_stream_handlers(run_conf)
 
-    if use_pep257:
-        log.warning("Deprecation Warning:\n"
-                    "pep257 has been renamed to pydocstyle and the use of the "
-                    "pep257 executable is deprecated and will be removed in "
-                    "the next major version. Please use `pydocstyle` instead.")
-
     log.debug("starting in debug mode.")
 
     Error.explain = run_conf.explain
@@ -66,23 +60,14 @@ def run_pydocstyle(use_pep257=False):
     return exit_code
 
 
-def main(use_pep257=False):
-    """Run pydocstyle as a script.
-
-    `use_pep257` is True if the script was invoked with the deprecated script
-    name `pep257`, in which case a deprecation warning will be printed.
-
-    """
+def main():
+    """Run pydocstyle as a script."""
     try:
-        sys.exit(run_pydocstyle(use_pep257))
+        sys.exit(run_pydocstyle())
     except KeyboardInterrupt:
         pass
 
 
-def main_pep257():
-    main(use_pep257=True)
-
-
 def setup_stream_handlers(conf):
     """Setup logging stream handlers according to the options."""
     class StdoutFilter(logging.Filter):

src/tests/test_integration.py

@@ -108,9 +108,9 @@ def install_package(request):
     subprocess.check_call(shlex.split(uninstall_cmd), cwd=cwd)
 
 
-@pytest.yield_fixture(scope="function", params=('pydocstyle', 'pep257'))
+@pytest.yield_fixture(scope="function")
 def env(request):
-    with SandboxEnv(request.param) as test_env:
+    with SandboxEnv() as test_env:
         yield test_env
 
 
@@ -882,10 +882,3 @@ def foo():
     _, _, code = env.invoke()
 
     assert code == 0
-
-
-def test_pep257_entry_point():
-    with SandboxEnv('pep257') as env:
-        _, err, code = env.invoke()
-        assert code == 0
-        assert 'Deprecation Warning' in err, err