Depcreated licenses are loaded by default.

* scancodedb deprecated licenses are loaded by default
* spdx deprecated licenses are loaded by default
* Added property LicenseSymbol.is_deprecated to check for deprecations.

Signed-off-by: Pablo Castellazzi <[email protected]>

Author: pcastellazzi

src/license_expression/__init__.py

@@ -864,8 +864,9 @@ def build_licensing(license_index):
     lics = [
         {
             'key': l.get('license_key', ''),
-            'is_exception': l.get('is_exception', ''),
-        } for l in license_index if not l.get('is_deprecated', False)
+            'is_deprecated': l.get('is_deprecated', False),
+            'is_exception': l.get('is_exception', False),
+        } for l in license_index
     ]
     return load_licensing_from_license_index(lics)
 
@@ -880,10 +881,9 @@ def build_spdx_licensing(license_index):
         {
             'key': l.get('spdx_license_key', ''),
             'aliases': l.get('other_spdx_license_keys', []),
-            'is_exception': l.get('is_exception', ''),
-        } for l in license_index
-        if l.get('spdx_license_key')
-        and not l.get('is_deprecated', False)
+            'is_deprecated': l.get('is_deprecated', False),
+            'is_exception': l.get('is_exception', False),
+        } for l in license_index if l.get('spdx_license_key')
     ]
     return load_licensing_from_license_index(lics)
 
@@ -1202,7 +1202,7 @@ class LicenseSymbol(BaseSymbol):
     expression.
     """
 
-    def __init__(self, key, aliases=tuple(), is_exception=False, *args, **kwargs):
+    def __init__(self, key, aliases=tuple(), is_deprecated=False, is_exception=False, *args, **kwargs):
         if not key:
             raise ExpressionError(f'A license key cannot be empty: {key!r}')
 
@@ -1246,6 +1246,7 @@ def __init__(self, key, aliases=tuple(), is_exception=False, *args, **kwargs):
                 f'and not: {type(aliases)}.'
             )
         self.aliases = aliases and tuple(aliases) or tuple()
+        self.is_deprecated = is_deprecated
         self.is_exception = is_exception
 
         # super only know about a single "obj" object.

tests/test_license_expression.py

@@ -98,39 +98,39 @@ def test_LicenseSymbol(self):
 
     def test_python_operators_simple(self):
         licensing = Licensing()
-        
+
         sym1 = LicenseSymbol('MIT')
         sym2 = LicenseSymbol('BSD-2')
-        
+
         assert sym1 & sym2 == licensing.AND(sym1, sym2)
         assert sym1 | sym2 == licensing.OR(sym1, sym2)
-        
+
         sym3 = LicenseWithExceptionSymbol(LicenseSymbol("GPL-3.0-or-later"), LicenseSymbol("GCC-exception-3.1"))
-        
+
         # Make sure LicenseWithExceptionSymbol operation work on left and right side
         assert sym3 & sym1 == licensing.AND(sym3, sym1)
         assert sym1 & sym3 == licensing.AND(sym1, sym3)
         assert sym3 | sym1 == licensing.OR(sym3, sym1)
         assert sym1 | sym3 == licensing.OR(sym3, sym1)
-    
+
     def test_boolean_expression_operators(self):
-        
+
         # Make sure LicenseWithExceptionSymbol boolean expression are set
         assert LicenseWithExceptionSymbol.Symbol is not None
         assert LicenseWithExceptionSymbol.TRUE is not None
         assert LicenseWithExceptionSymbol.FALSE is not None
         assert LicenseWithExceptionSymbol.AND is not None
         assert LicenseWithExceptionSymbol.OR is not None
         assert LicenseWithExceptionSymbol.NOT is not None
-        
+
         # Make sure LicenseWithExceptionSymbol matches LicenseSymbol
         assert LicenseWithExceptionSymbol.Symbol == LicenseSymbol
         assert LicenseWithExceptionSymbol.TRUE == LicenseSymbol.TRUE
         assert LicenseWithExceptionSymbol.FALSE == LicenseSymbol.FALSE
         assert LicenseWithExceptionSymbol.AND == LicenseSymbol.AND
         assert LicenseWithExceptionSymbol.OR == LicenseSymbol.OR
         assert LicenseWithExceptionSymbol.NOT == LicenseSymbol.NOT
-        
+
 
 
 class LicensingTest(TestCase):
@@ -2433,53 +2433,32 @@ class UtilTest(TestCase):
     test_data_dir = join(dirname(__file__), 'data')
 
     def test_build_licensing(self):
-        test_license_index_location = join(
-            self.test_data_dir, 'test_license_key_index.json')
-        with open(test_license_index_location) as f:
-            license_info = json.load(f)
-        lics = [
-            {
-                'key': l.get('license_key', ''),
-                'is_exception': l.get('is_exception', ''),
-            } for l in license_info if l.get('spdx_license_key')
-        ]
-        syms = [LicenseSymbol(**l) for l in lics]
-        expected = Licensing(syms)
-
-        test_license_index = get_license_index(
-            license_index_location=test_license_index_location)
+        test_license_index_location = join(self.test_data_dir, "test_license_key_index.json")
+        test_license_index = get_license_index(license_index_location=test_license_index_location)
         result = build_licensing(test_license_index)
 
-        assert result.known_symbols == expected.known_symbols
-        assert result.known_symbols_lowercase == expected.known_symbols_lowercase
-        # Ensure deprecated licenses are not loaded
-        assert 'aladdin-md5' not in result.known_symbols
-        assert 'aladdin-md5' not in result.known_symbols_lowercase
+        known_symbols = set(result.known_symbols.keys())
+        known_symbols_lowercase = set(result.known_symbols_lowercase.keys())
+        expected_symbols = {"389-exception", "3com-microcode", "3dslicer-1.0", "aladdin-md5"}
 
-    def test_build_spdx_licensing(self):
-        test_license_index_location = join(
-            self.test_data_dir, 'test_license_key_index.json')
-        with open(test_license_index_location) as f:
-            license_info = json.load(f)
-        lics = [
-            {
-                'key': l.get('spdx_license_key', ''),
-                'aliases': l.get('other_spdx_license_keys', ''),
-                'is_exception': l.get('is_exception', ''),
-            } for l in license_info if l.get('spdx_license_key')
-        ]
-        syms = [LicenseSymbol(**l) for l in lics]
-        expected = Licensing(syms)
+        assert known_symbols == expected_symbols
+        assert known_symbols_lowercase == {sym.lower() for sym in expected_symbols}
 
-        test_license_index = get_license_index(
-            license_index_location=test_license_index_location)
+    def test_build_spdx_licensing(self):
+        test_license_index_location = join(self.test_data_dir, "test_license_key_index.json")
+        test_license_index = get_license_index(license_index_location=test_license_index_location)
         result = build_spdx_licensing(test_license_index)
 
-        assert result.known_symbols == expected.known_symbols
-        assert result.known_symbols_lowercase == expected.known_symbols_lowercase
-        # Ensure deprecated licenses are not loaded
-        assert 'aladdin-md5' not in result.known_symbols
-        assert 'aladdin-md5' not in result.known_symbols_lowercase
+        known_symbols = set(result.known_symbols.keys())
+        known_symbols_lowercase = set(result.known_symbols_lowercase.keys())
+        expected_symbols = {
+            "389-exception",
+            "LicenseRef-scancode-3com-microcode",
+            "LicenseRef-scancode-3dslicer-1.0",
+        }
+
+        assert known_symbols == expected_symbols
+        assert known_symbols_lowercase == {sym.lower() for sym in expected_symbols}
 
     def test_get_license_key_info(self):
         test_license_index_location = join(