From 3aa5d2d3c83a9f7d81f02ce169ea8c59472ab2e3 Mon Sep 17 00:00:00 2001
From: Anthony Sottile <asottile@umich.edu>
Date: Mon, 27 Aug 2018 08:44:21 -0700
Subject: [PATCH] Deprecate sassc for pysassc

---
 docs/index.rst       |   2 +-
 docs/sassc.rst       |   4 +-
 pysassc.py           | 182 ++++++++++++++++++++++++++++++++++++++++++
 sass.py              |   2 +-
 sassc.py             | 185 +++----------------------------------------
 sasstests.py         | 100 +++++++++++++++--------
 sassutils/builder.py |   2 +-
 setup.py             |   7 +-
 8 files changed, 266 insertions(+), 218 deletions(-)
 create mode 100644 pysassc.py
 mode change 100755 => 100644 sassc.py

diff --git a/docs/index.rst b/docs/index.rst
index c6dd75cc..b10fe50f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -105,7 +105,7 @@ References
 .. toctree::
    :maxdepth: 2
 
-   sassc
+   pysassc
    sass
    sassutils
 
diff --git a/docs/sassc.rst b/docs/sassc.rst
index 27f2aa4c..9fee79fc 100644
--- a/docs/sassc.rst
+++ b/docs/sassc.rst
@@ -1,5 +1,5 @@
 
-.. program:: sassc
+.. program:: pysassc
 
-.. automodule:: sassc
+.. automodule:: pysassc
    :members:
diff --git a/pysassc.py b/pysassc.py
new file mode 100644
index 00000000..455af197
--- /dev/null
+++ b/pysassc.py
@@ -0,0 +1,182 @@
+#!/usr/bin/env python
+r""":mod:`pysassc` --- SassC compliant command line interface
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This provides SassC_ compliant CLI executable named :program:`pysassc`:
+
+.. sourcecode:: console
+
+   $ pysassc
+   Usage: pysassc [options] SCSS_FILE [CSS_FILE]
+
+There are options as well:
+
+.. option:: -t <style>, --style <style>
+
+   Coding style of the compiled result.  The same as :func:`sass.compile()`
+   function's ``output_style`` keyword argument.  Default is ``nested``.
+
+.. option:: -s <style>, --output-style <style>
+
+    Alias for -t / --style.
+
+    .. deprecated:: 0.11.0
+
+.. option:: -I <dir>, --include-path <dir>
+
+   Optional directory path to find ``@import``\ ed (S)CSS files.
+   Can be multiply used.
+
+.. option:: -m, -g, --sourcemap
+
+   Emit source map.  Requires the second argument (output CSS filename).
+   The filename of source map will be the output CSS filename followed by
+   :file:`.map`.
+
+   .. versionadded:: 0.4.0
+
+.. option:: -p, --precision
+
+   Set the precision for numbers. Default is 5.
+
+   .. versionadded:: 0.7.0
+
+.. option:: --source-comments
+
+   Include debug info in output.
+
+   .. versionadded:: 0.11.0
+
+.. option:: -v, --version
+
+   Prints the program version.
+
+.. option:: -h, --help
+
+   Prints the help message.
+
+.. _SassC: https://github.com/sass/sassc
+
+"""
+from __future__ import print_function
+
+import functools
+import io
+import optparse
+import sys
+
+import sass
+
+
+def main(argv=sys.argv, stdout=sys.stdout, stderr=sys.stderr):
+    parser = optparse.OptionParser(
+        usage='%prog [options] SCSS_FILE [OUT_CSS_FILE]',
+        version='%prog {} (sass/libsass {})'.format(
+            sass.__version__, sass.libsass_version,
+        ),
+    )
+    output_styles = list(sass.OUTPUT_STYLES)
+    output_styles = ', '.join(output_styles[:-1]) + ', or ' + output_styles[-1]
+    parser.add_option(
+        '-t', '--style', '-s', '--output-style', metavar='STYLE',
+        type='choice', choices=list(sass.OUTPUT_STYLES), default='nested',
+        help=(
+            'Coding style of the compiled result.  Choose one of ' +
+            output_styles + '. [default: %default]'
+        ),
+    )
+    parser.add_option(
+        '-m', '-g', '--sourcemap', dest='source_map',
+        action='store_true', default=False,
+        help='Emit source map.  Requires the second argument '
+             '(output css filename).',
+    )
+    parser.add_option(
+        '-I', '--include-path', metavar='DIR',
+        dest='include_paths', action='append',
+        help='Path to find "@import"ed (S)CSS source files. '
+             'Can be multiply used.',
+    )
+    parser.add_option(
+        '-p', '--precision', action='store', type='int', default=5,
+        help='Set the precision for numbers. [default: %default]',
+    )
+    parser.add_option(
+        '--source-comments', action='store_true', default=False,
+        help='Include debug info in output',
+    )
+    parser.add_option(
+        '--import-extensions',
+        dest='custom_import_extensions', action='append',
+        help='Extra extensions allowed for sass imports. '
+             'Can be multiply used.',
+    )
+    options, args = parser.parse_args(argv[1:])
+    error = functools.partial(
+        print,
+        parser.get_prog_name() + ': error:',
+        file=stderr,
+    )
+    if not args:
+        parser.print_usage(stderr)
+        error('too few arguments')
+        return 2
+    elif len(args) > 2:
+        parser.print_usage(stderr)
+        error('too many arguments')
+        return 2
+    filename = args[0]
+    if options.source_map and len(args) < 2:
+        parser.print_usage(stderr)
+        error(
+            '-m/-g/--sourcemap requires the second argument, the output '
+            'css filename.',
+        )
+        return 2
+
+    try:
+        if options.source_map:
+            source_map_filename = args[1] + '.map'  # FIXME
+            css, source_map = sass.compile(
+                filename=filename,
+                output_style=options.style,
+                source_comments=options.source_comments,
+                source_map_filename=source_map_filename,
+                output_filename_hint=args[1],
+                include_paths=options.include_paths,
+                precision=options.precision,
+                custom_import_extensions=options.custom_import_extensions,
+            )
+        else:
+            source_map_filename = None
+            source_map = None
+            css = sass.compile(
+                filename=filename,
+                output_style=options.style,
+                source_comments=options.source_comments,
+                include_paths=options.include_paths,
+                precision=options.precision,
+                custom_import_extensions=options.custom_import_extensions,
+            )
+    except (IOError, OSError) as e:
+        error(e)
+        return 3
+    except sass.CompileError as e:
+        error(e)
+        return 1
+    else:
+        if len(args) < 2:
+            print(css, file=stdout)
+        else:
+            with io.open(args[1], 'w', encoding='utf-8', newline='') as f:
+                f.write(css)
+        if source_map_filename:
+            with io.open(
+                source_map_filename, 'w', encoding='utf-8', newline='',
+            ) as f:
+                f.write(source_map)
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())
diff --git a/sass.py b/sass.py
index 3dd040f6..2590197b 100644
--- a/sass.py
+++ b/sass.py
@@ -551,7 +551,7 @@ def my_importer(path):
             "values like 'none', 'line_numbers', and 'map' for "
             'the source_comments parameter are deprecated; ' +
             deprecation_message,
-            DeprecationWarning,
+            FutureWarning,
         )
     if not isinstance(source_comments, bool):
         raise TypeError('source_comments must be bool, not ' +
diff --git a/sassc.py b/sassc.py
old mode 100755
new mode 100644
index 469c83dc..24153428
--- a/sassc.py
+++ b/sassc.py
@@ -1,182 +1,15 @@
-#!/usr/bin/env python
-r""":mod:`sassc` --- SassC compliant command line interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+import warnings
 
-This provides SassC_ compliant CLI executable named :program:`sassc`:
+import pysassc
 
-.. sourcecode:: console
 
-   $ sassc
-   Usage: sassc [options] SCSS_FILE [CSS_FILE]
-
-There are options as well:
-
-.. option:: -t <style>, --style <style>
-
-   Coding style of the compiled result.  The same as :func:`sass.compile()`
-   function's ``output_style`` keyword argument.  Default is ``nested``.
-
-.. option:: -s <style>, --output-style <style>
-
-    Alias for -t / --style.
-
-    .. deprecated:: 0.11.0
-
-.. option:: -I <dir>, --include-path <dir>
-
-   Optional directory path to find ``@import``\ ed (S)CSS files.
-   Can be multiply used.
-
-.. option:: -m, -g, --sourcemap
-
-   Emit source map.  Requires the second argument (output CSS filename).
-   The filename of source map will be the output CSS filename followed by
-   :file:`.map`.
-
-   .. versionadded:: 0.4.0
-
-.. option:: -p, --precision
-
-   Set the precision for numbers. Default is 5.
-
-   .. versionadded:: 0.7.0
-
-.. option:: --source-comments
-
-   Include debug info in output.
-
-   .. versionadded:: 0.11.0
-
-.. option:: -v, --version
-
-   Prints the program version.
-
-.. option:: -h, --help
-
-   Prints the help message.
-
-.. _SassC: https://github.com/sass/sassc
-
-"""
-from __future__ import print_function
-
-import functools
-import io
-import optparse
-import sys
-
-import sass
-
-
-def main(argv=sys.argv, stdout=sys.stdout, stderr=sys.stderr):
-    parser = optparse.OptionParser(
-        usage='%prog [options] SCSS_FILE [OUT_CSS_FILE]',
-        version='%prog {} (sass/libsass {})'.format(
-            sass.__version__, sass.libsass_version,
-        ),
-    )
-    output_styles = list(sass.OUTPUT_STYLES)
-    output_styles = ', '.join(output_styles[:-1]) + ', or ' + output_styles[-1]
-    parser.add_option(
-        '-t', '--style', '-s', '--output-style', metavar='STYLE',
-        type='choice', choices=list(sass.OUTPUT_STYLES), default='nested',
-        help=(
-            'Coding style of the compiled result.  Choose one of ' +
-            output_styles + '. [default: %default]'
-        ),
-    )
-    parser.add_option(
-        '-m', '-g', '--sourcemap', dest='source_map',
-        action='store_true', default=False,
-        help='Emit source map.  Requires the second argument '
-             '(output css filename).',
-    )
-    parser.add_option(
-        '-I', '--include-path', metavar='DIR',
-        dest='include_paths', action='append',
-        help='Path to find "@import"ed (S)CSS source files. '
-             'Can be multiply used.',
-    )
-    parser.add_option(
-        '-p', '--precision', action='store', type='int', default=5,
-        help='Set the precision for numbers. [default: %default]',
-    )
-    parser.add_option(
-        '--source-comments', action='store_true', default=False,
-        help='Include debug info in output',
-    )
-    parser.add_option(
-        '--import-extensions',
-        dest='custom_import_extensions', action='append',
-        help='Extra extensions allowed for sass imports. '
-             'Can be multiply used.',
-    )
-    options, args = parser.parse_args(argv[1:])
-    error = functools.partial(
-        print,
-        parser.get_prog_name() + ': error:',
-        file=stderr,
-    )
-    if not args:
-        parser.print_usage(stderr)
-        error('too few arguments')
-        return 2
-    elif len(args) > 2:
-        parser.print_usage(stderr)
-        error('too many arguments')
-        return 2
-    filename = args[0]
-    if options.source_map and len(args) < 2:
-        parser.print_usage(stderr)
-        error(
-            '-m/-g/--sourcemap requires the second argument, the output '
-            'css filename.',
-        )
-        return 2
-
-    try:
-        if options.source_map:
-            source_map_filename = args[1] + '.map'  # FIXME
-            css, source_map = sass.compile(
-                filename=filename,
-                output_style=options.style,
-                source_comments=options.source_comments,
-                source_map_filename=source_map_filename,
-                output_filename_hint=args[1],
-                include_paths=options.include_paths,
-                precision=options.precision,
-                custom_import_extensions=options.custom_import_extensions,
-            )
-        else:
-            source_map_filename = None
-            source_map = None
-            css = sass.compile(
-                filename=filename,
-                output_style=options.style,
-                source_comments=options.source_comments,
-                include_paths=options.include_paths,
-                precision=options.precision,
-                custom_import_extensions=options.custom_import_extensions,
-            )
-    except (IOError, OSError) as e:
-        error(e)
-        return 3
-    except sass.CompileError as e:
-        error(e)
-        return 1
-    else:
-        if len(args) < 2:
-            print(css, file=stdout)
-        else:
-            with io.open(args[1], 'w', encoding='utf-8', newline='') as f:
-                f.write(css)
-        if source_map_filename:
-            with io.open(
-                source_map_filename, 'w', encoding='utf-8', newline='',
-            ) as f:
-                f.write(source_map)
-    return 0
+def main(*args, **kwargs):
+    warnings.warn(
+        'The `sassc` entrypoint is deprecated, please use `pysassc`',
+        FutureWarning,
+    ),
+    return pysassc.main(*args, **kwargs)
 
 
 if __name__ == '__main__':
-    sys.exit(main())
+    exit(main())
diff --git a/sasstests.py b/sasstests.py
index ff55396e..84480637 100644
--- a/sasstests.py
+++ b/sasstests.py
@@ -22,6 +22,7 @@
 from werkzeug.test import Client
 from werkzeug.wrappers import Response
 
+import pysassc
 import sass
 import sassc
 from sassutils.builder import Manifest, build_directory
@@ -424,7 +425,7 @@ def test_compile_string_deprecated_source_comments_line_numbers(self):
                 source_comments='line_numbers',
             )
             assert len(w) == 1
-            assert issubclass(w[-1].category, DeprecationWarning)
+            assert issubclass(w[-1].category, FutureWarning)
         assert expected == actual
 
     def test_compile_filename(self):
@@ -466,7 +467,7 @@ def test_compile_source_map_deprecated_source_comments_map(self):
                 source_map_filename='a.scss.css.map',
             )
             assert len(w) == 1
-            assert issubclass(w[-1].category, DeprecationWarning)
+            assert issubclass(w[-1].category, FutureWarning)
         assert expected == actual
         self.assert_source_map_equal(expected_map, actual_map)
 
@@ -588,16 +589,20 @@ def test_output_style(self):
 class ManifestTestCase(BaseTestCase):
 
     def test_normalize_manifests(self):
-        manifests = Manifest.normalize_manifests({
-            'package': 'sass/path',
-            'package.name': ('sass/path', 'css/path'),
-            'package.name2': Manifest('sass/path', 'css/path'),
-            'package.name3': {
-                'sass_path': 'sass/path',
-                'css_path': 'css/path',
-                'strip_extension': True,
-            },
-        })
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter('always')
+            manifests = Manifest.normalize_manifests({
+                'package': 'sass/path',
+                'package.name': ('sass/path', 'css/path'),
+                'package.name2': Manifest('sass/path', 'css/path'),
+                'package.name3': {
+                    'sass_path': 'sass/path',
+                    'css_path': 'css/path',
+                    'strip_extension': True,
+                },
+            })
+            assert len(w) == 3
+            assert all(issubclass(x.category, FutureWarning) for x in w)
         assert len(manifests) == 4
         assert isinstance(manifests['package'], Manifest)
         assert manifests['package'].sass_path == 'sass/path'
@@ -624,7 +629,12 @@ def replace_source_path(s, name):
                 return s.replace('SOURCE', test_source_path(name))
 
             shutil.copytree('test', src_path)
-            m = Manifest(sass_path='test', css_path='css')
+            with warnings.catch_warnings(record=True) as w:
+                warnings.simplefilter('always')
+                m = Manifest(sass_path='test', css_path='css')
+                assert len(w) == 1
+                assert issubclass(w[-1].category, FutureWarning)
+
             m.build_one(d, 'a.scss')
             with open(os.path.join(d, 'css', 'a.scss.css')) as f:
                 assert A_EXPECTED_CSS == f.read()
@@ -704,11 +714,15 @@ def test_wsgi_sass_middleware(self):
         with tempdir() as css_dir:
             src_dir = os.path.join(css_dir, 'src')
             shutil.copytree('test', src_dir)
-            app = SassMiddleware(
-                self.sample_wsgi_app, {
-                    __name__: (src_dir, css_dir, '/static'),
-                },
-            )
+            with warnings.catch_warnings(record=True) as w:
+                warnings.simplefilter('always')
+                app = SassMiddleware(
+                    self.sample_wsgi_app, {
+                        __name__: (src_dir, css_dir, '/static'),
+                    },
+                )
+                assert len(w) == 1
+                assert issubclass(w[-1].category, FutureWarning)
             client = Client(app, Response)
             r = client.get('/asdf')
             assert r.status_code == 200
@@ -780,7 +794,7 @@ def setUp(self):
         self.err = StringIO()
 
     def test_no_args(self):
-        exit_code = sassc.main(['sassc'], self.out, self.err)
+        exit_code = pysassc.main(['pysassc'], self.out, self.err)
         assert exit_code == 2
         err = self.err.getvalue()
         assert err.strip().endswith('error: too few arguments'), \
@@ -788,8 +802,8 @@ def test_no_args(self):
         assert '' == self.out.getvalue()
 
     def test_three_args(self):
-        exit_code = sassc.main(
-            ['sassc', 'a.scss', 'b.scss', 'c.scss'],
+        exit_code = pysassc.main(
+            ['pysassc', 'a.scss', 'b.scss', 'c.scss'],
             self.out, self.err,
         )
         assert exit_code == 2
@@ -798,18 +812,35 @@ def test_three_args(self):
             'actual error message is: ' + repr(err)
         assert self.out.getvalue() == ''
 
+    def test_pysassc_stdout(self):
+        exit_code = pysassc.main(
+            ['pysassc', 'test/a.scss'],
+            self.out, self.err,
+        )
+        assert exit_code == 0
+        assert self.err.getvalue() == ''
+        assert A_EXPECTED_CSS.strip() == self.out.getvalue().strip()
+
     def test_sassc_stdout(self):
-        exit_code = sassc.main(['sassc', 'test/a.scss'], self.out, self.err)
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter('always')
+            exit_code = sassc.main(
+                ['sassc', 'test/a.scss'],
+                self.out, self.err,
+            )
+            assert len(w) == 1
+            assert issubclass(w[-1].category, FutureWarning)
+            assert 'use `pysassc`' in str(w[-1].message)
         assert exit_code == 0
         assert self.err.getvalue() == ''
         assert A_EXPECTED_CSS.strip() == self.out.getvalue().strip()
 
-    def test_sassc_output(self):
+    def test_pysassc_output(self):
         fd, tmp = tempfile.mkstemp('.css')
         try:
             os.close(fd)
-            exit_code = sassc.main(
-                ['sassc', 'test/a.scss', tmp],
+            exit_code = pysassc.main(
+                ['pysassc', 'test/a.scss', tmp],
                 self.out, self.err,
             )
             assert exit_code == 0
@@ -820,12 +851,12 @@ def test_sassc_output(self):
         finally:
             os.remove(tmp)
 
-    def test_sassc_output_unicode(self):
+    def test_pysassc_output_unicode(self):
         fd, tmp = tempfile.mkstemp('.css')
         try:
             os.close(fd)
-            exit_code = sassc.main(
-                ['sassc', 'test/d.scss', tmp],
+            exit_code = pysassc.main(
+                ['pysassc', 'test/d.scss', tmp],
                 self.out, self.err,
             )
             assert exit_code == 0
@@ -836,8 +867,11 @@ def test_sassc_output_unicode(self):
         finally:
             os.remove(tmp)
 
-    def test_sassc_source_map_without_css_filename(self):
-        exit_code = sassc.main(['sassc', '-m', 'a.scss'], self.out, self.err)
+    def test_pysassc_source_map_without_css_filename(self):
+        exit_code = pysassc.main(
+            ['pysassc', '-m', 'a.scss'],
+            self.out, self.err,
+        )
         assert exit_code == 2
         err = self.err.getvalue()
         assert err.strip().endswith(
@@ -1448,15 +1482,15 @@ def test_source_comments():
     assert out == '/* line 1, stdin */\na {\n  color: red; }\n'
 
 
-def test_sassc_sourcemap(tmpdir):
+def test_pysassc_sourcemap(tmpdir):
     src_file = tmpdir.join('src').ensure_dir().join('a.scss')
     out_file = tmpdir.join('a.scss.css')
     out_map_file = tmpdir.join('a.scss.css.map')
 
     src_file.write('.c { font-size: 5px + 5px; }')
 
-    exit_code = sassc.main([
-        'sassc', '-m', src_file.strpath, out_file.strpath,
+    exit_code = pysassc.main([
+        'pysassc', '-m', src_file.strpath, out_file.strpath,
     ])
     assert exit_code == 0
 
diff --git a/sassutils/builder.py b/sassutils/builder.py
index 919b2120..e775e718 100644
--- a/sassutils/builder.py
+++ b/sassutils/builder.py
@@ -154,7 +154,7 @@ def __init__(
             warnings.warn(
                 '`strip_extension` was not specified, defaulting to `False`.\n'
                 'In the future, `strip_extension` will default to `True`.',
-                DeprecationWarning,
+                FutureWarning,
             )
             strip_extension = False
         elif not isinstance(strip_extension, bool):
diff --git a/setup.py b/setup.py
index 79de909b..a5734f07 100644
--- a/setup.py
+++ b/setup.py
@@ -253,14 +253,13 @@ def run(self):
     version=version(),
     ext_modules=[sass_extension],
     packages=['sassutils'],
-    py_modules=['sass', 'sassc', 'sasstests'],
+    py_modules=['pysassc', 'sass', 'sassc', 'sasstests'],
     package_data={
         '': [
             'README.rst',
             'test/*.sass',
         ],
     },
-    scripts=['sassc.py'],
     license='MIT License',
     author='Hong Minhee',
     author_email='minhee' '@' 'dahlia.kr',
@@ -274,8 +273,8 @@ def run(self):
             'sass_manifests = sassutils.distutils:validate_manifests',
         ],
         'console_scripts': [
-            ['pysassc = sassc:main'],
-            # TODO: deprecate `sassc` and remove (#134)
+            ['pysassc = pysassc:main'],
+            # TODO: remove `sassc` entry (#134)
             ['sassc = sassc:main'],
         ],
     },