Move sass types into sass module.

Author: asottile

pysass.cpp

@@ -37,7 +37,7 @@ static struct PySass_Pair PySass_output_style_enum[] = {
 
 static PyObject* _to_py_value(const union Sass_Value* value) {
     PyObject* retv = NULL;
-    PyObject* types_mod = PyImport_ImportModule("sassutils.sass_types");
+    PyObject* types_mod = PyImport_ImportModule("sass");
     PyObject* sass_comma = PyObject_GetAttrString(types_mod, "SASS_SEPARATOR_COMMA");
     PyObject* sass_space = PyObject_GetAttrString(types_mod, "SASS_SEPARATOR_SPACE");
 
@@ -131,7 +131,7 @@ static PyObject* _to_py_value(const union Sass_Value* value) {
 
 static union Sass_Value* _to_sass_value(PyObject* value) {
     union Sass_Value* retv = NULL;
-    PyObject* types_mod = PyImport_ImportModule("sassutils.sass_types");
+    PyObject* types_mod = PyImport_ImportModule("sass");
     PyObject* sass_number_t = PyObject_GetAttrString(types_mod, "SassNumber");
     PyObject* sass_color_t = PyObject_GetAttrString(types_mod, "SassColor");
     PyObject* sass_list_t = PyObject_GetAttrString(types_mod, "SassList");

sass.py

@@ -10,6 +10,7 @@
 'a b {\n  color: blue; }\n'
 
 """
+from __future__ import absolute_import
 import collections
 import inspect
 import os
@@ -103,6 +104,7 @@ def compile_dirname(
                 return False, v
     return True, None
 
+
 def compile(**kwargs):
     """There are three modes of parameters :func:`compile()` can take:
     ``string``, ``filename``, and ``dirname``.
@@ -394,3 +396,86 @@ def and_join(strings):
         return ''
     iterator = enumerate(strings)
     return ', '.join('and ' + s if i == last else s for i, s in iterator)
+
+"""
+This module provides datatypes to be used in custom sass functions.
+
+The following mappings from sass types to python types are used:
+
+SASS_NULL: ``None``
+SASS_BOOLEAN: ``True`` or ``False``
+SASS_STRING: class:`str`
+SASS_NUMBER: class:`SassNumber`
+SASS_COLOR: class:`SassColor`
+SASS_LIST: class:`SassList`
+SASS_MAP: class:`dict` or class:`SassMap`
+SASS_ERROR: class:`SassError`
+SASS_WARNING: class:`SassWarning`
+"""
+
+
+class SassNumber(collections.namedtuple('SassNumber', ('value', 'unit'))):
+    def __new__(cls, value, unit):
+        value = float(value)
+        if not isinstance(unit, text_type):
+            unit = unit.decode('UTF-8')
+        return super(SassNumber, cls).__new__(cls, value, unit)
+
+
+class SassColor(collections.namedtuple('SassColor', ('r', 'g', 'b', 'a'))):
+    def __new__(cls, r, g, b, a):
+        r = float(r)
+        g = float(g)
+        b = float(b)
+        a = float(a)
+        return super(SassColor, cls).__new__(cls, r, g, b, a)
+
+
+SASS_SEPARATOR_COMMA = collections.namedtuple('SASS_SEPARATOR_COMMA', ())()
+SASS_SEPARATOR_SPACE = collections.namedtuple('SASS_SEPARATOR_SPACE', ())()
+SEPARATORS = frozenset((SASS_SEPARATOR_COMMA, SASS_SEPARATOR_SPACE))
+
+
+class SassList(collections.namedtuple('SassList', ('items', 'separator'))):
+    def __new__(cls, items, separator):
+        items = tuple(items)
+        assert separator in SEPARATORS
+        return super(SassList, cls).__new__(cls, items, separator)
+
+
+class SassError(collections.namedtuple('SassError', ('msg',))):
+    def __new__(cls, msg):
+        if not isinstance(msg, text_type):
+            msg = msg.decode('UTF-8')
+        return super(SassError, cls).__new__(cls, msg)
+
+
+class SassWarning(collections.namedtuple('SassError', ('msg',))):
+    def __new__(cls, msg):
+        if not isinstance(msg, text_type):
+            msg = msg.decode('UTF-8')
+        return super(SassWarning, cls).__new__(cls, msg)
+
+
+class SassMap(dict):
+    """Because sass maps can have mapping types as keys, we need an immutable
+    hashable mapping type.
+    """
+    __slots__ = ('_hash',)
+
+    def __new__(cls, *args, **kwargs):
+        value = super(SassMap, cls).__new__(cls, *args, **kwargs)
+        # An assertion that all things are hashable
+        value._hash = hash(frozenset(value.items()))
+        return value
+
+    def __repr__(self):
+        return '{0}({1})'.format(type(self).__name__, frozenset(self.items()))
+
+    def __hash__(self):
+        return self._hash
+
+    def _immutable(self, *_):
+        raise AssertionError('SassMaps are immutable')
+
+    __setitem__ = __delitem__ = _immutable

sasstests.py

@@ -21,7 +21,6 @@
 
 import sass
 import sassc
-from sassutils import sass_types
 from sassutils.builder import Manifest, build_directory
 from sassutils.wsgi import SassMiddleware
 
@@ -788,57 +787,57 @@ def test_raises_typeerror_star_kwargs(self):
 
 class SassTypesTest(unittest.TestCase):
     def test_number_no_conversion(self):
-        num = sass_types.SassNumber(123., u'px')
+        num = sass.SassNumber(123., u'px')
         assert type(num.value) is float, type(num.value)
         assert type(num.unit) is text_type, type(num.unit)
 
     def test_number_conversion(self):
-        num = sass_types.SassNumber(123, b'px')
+        num = sass.SassNumber(123, b'px')
         assert type(num.value) is float, type(num.value)
         assert type(num.unit) is text_type, type(num.unit)
 
     def test_color_no_conversion(self):
-        color = sass_types.SassColor(1., 2., 3., .5)
+        color = sass.SassColor(1., 2., 3., .5)
         assert type(color.r) is float, type(color.r)
         assert type(color.g) is float, type(color.g)
         assert type(color.b) is float, type(color.b)
         assert type(color.a) is float, type(color.a)
 
     def test_color_conversion(self):
-        color = sass_types.SassColor(1, 2, 3, 1)
+        color = sass.SassColor(1, 2, 3, 1)
         assert type(color.r) is float, type(color.r)
         assert type(color.g) is float, type(color.g)
         assert type(color.b) is float, type(color.b)
         assert type(color.a) is float, type(color.a)
 
     def test_sass_list_no_conversion(self):
-        lst = sass_types.SassList(
-            ('foo', 'bar'), sass_types.SASS_SEPARATOR_COMMA,
+        lst = sass.SassList(
+            ('foo', 'bar'), sass.SASS_SEPARATOR_COMMA,
         )
         assert type(lst.items) is tuple, type(lst.items)
-        assert lst.separator is sass_types.SASS_SEPARATOR_COMMA, lst.separator
+        assert lst.separator is sass.SASS_SEPARATOR_COMMA, lst.separator
 
     def test_sass_list_conversion(self):
-        lst = sass_types.SassList(
-            ['foo', 'bar'], sass_types.SASS_SEPARATOR_SPACE,
+        lst = sass.SassList(
+            ['foo', 'bar'], sass.SASS_SEPARATOR_SPACE,
         )
         assert type(lst.items) is tuple, type(lst.items)
-        assert lst.separator is sass_types.SASS_SEPARATOR_SPACE, lst.separator
+        assert lst.separator is sass.SASS_SEPARATOR_SPACE, lst.separator
 
     def test_sass_warning_no_conversion(self):
-        warn = sass_types.SassWarning(u'error msg')
+        warn = sass.SassWarning(u'error msg')
         assert type(warn.msg) is text_type, type(warn.msg)
 
     def test_sass_warning_no_conversion(self):
-        warn = sass_types.SassWarning(b'error msg')
+        warn = sass.SassWarning(b'error msg')
         assert type(warn.msg) is text_type, type(warn.msg)
 
     def test_sass_error_no_conversion(self):
-        err = sass_types.SassError(u'error msg')
+        err = sass.SassError(u'error msg')
         assert type(err.msg) is text_type, type(err.msg)
 
     def test_sass_error_conversion(self):
-        err = sass_types.SassError(b'error msg')
+        err = sass.SassError(b'error msg')
         assert type(err.msg) is text_type, type(err.msg)
 
 
@@ -855,25 +854,25 @@ def identity(x):
 
 custom_functions = {
     'raises': lambda: raise_exc(AssertionError('foo')),
-    'returns_warning': lambda: sass_types.SassWarning('This is a warning'),
-    'returns_error': lambda: sass_types.SassError('This is an error'),
+    'returns_warning': lambda: sass.SassWarning('This is a warning'),
+    'returns_error': lambda: sass.SassError('This is an error'),
     # Tuples are a not-supported type.
     'returns_unknown': lambda: (1, 2, 3),
     'returns_true': lambda: True,
     'returns_false': lambda: False,
     'returns_none': lambda: None,
     'returns_unicode': lambda: u'☃',
     'returns_bytes': lambda: u'☃'.encode('UTF-8'),
-    'returns_number': lambda: sass_types.SassNumber(5, 'px'),
-    'returns_color': lambda: sass_types.SassColor(1, 2, 3, .5),
-    'returns_comma_list': lambda: sass_types.SassList(
-        ('Arial', 'sans-serif'), sass_types.SASS_SEPARATOR_COMMA,
+    'returns_number': lambda: sass.SassNumber(5, 'px'),
+    'returns_color': lambda: sass.SassColor(1, 2, 3, .5),
+    'returns_comma_list': lambda: sass.SassList(
+        ('Arial', 'sans-serif'), sass.SASS_SEPARATOR_COMMA,
     ),
-    'returns_space_list': lambda: sass_types.SassList(
-        ('medium', 'none'), sass_types.SASS_SEPARATOR_SPACE,
+    'returns_space_list': lambda: sass.SassList(
+        ('medium', 'none'), sass.SASS_SEPARATOR_SPACE,
     ),
     'returns_py_dict': lambda: {'foo': 'bar'},
-    'returns_map': lambda: sass_types.SassMap((('foo', 'bar'),)),
+    'returns_map': lambda: sass.SassMap((('foo', 'bar'),)),
     # TODO: returns SassMap
     'identity': identity,
 }