Convert constructors to kwargs.

stix2/__init__.py

@@ -47,8 +47,17 @@ class _STIXBase(collections.Mapping):
 
 class Indicator(_STIXBase):
 
-    def __init__(self, type='indicator', id=None, created=None, modified=None,
+    _properties = [
-                 labels=None, pattern=None, valid_from=None):
+        'type',
+        'id',
+        'created',
+        'modified',
+        'labels',
+        'pattern',
+        'valid_from',
+    ]
+
+    def __init__(self, **kwargs):
         # TODO:
         # - created_by_ref
         # - revoked
@@ -61,31 +70,38 @@ class Indicator(_STIXBase):
         # - valid_until
         # - kill_chain_phases
 
-        if not created or not modified or not valid_from:
+        # TODO: do we care about the performance penalty of creating this
-            now = datetime.now(tz=pytz.UTC)
+        # if we won't need it?
+        now = datetime.now(tz=pytz.UTC)
 
-        if type != 'indicator':
+        if not kwargs.get('type'):
-            raise ValueError("Indicators must have type='indicator'.")
+            kwargs['type'] = 'indicator'
+        if kwargs['type'] != 'indicator':
+            raise ValueError("Indicator must have type='indicator'.")
 
-        if not id:
+        if not kwargs.get('id'):
-            id = 'indicator--' + str(uuid.uuid4())
+            kwargs['id'] = 'indicator--' + str(uuid.uuid4())
-        if not id.startswith('indicator--'):
+        if not kwargs['id'].startswith('indicator--'):
             raise ValueError("Indicator id values must begin with 'indicator--'.")
 
-        if not labels:
+        if not kwargs.get('labels'):
             raise ValueError("Missing required field for Indicator: 'labels'.")
 
-        if not pattern:
+        if not kwargs.get('pattern'):
             raise ValueError("Missing required field for Indicator: 'pattern'.")
 
+        extra_kwargs = list(set(kwargs.keys()) - set(self._properties))
+        if extra_kwargs:
+            raise TypeError("unexpected keyword arguments: " + str(extra_kwargs))
+
         self._inner = {
-            'type': type,
+            'type': kwargs['type'],
-            'id': id,
+            'id': kwargs['id'],
-            'created': created or now,
+            'created': kwargs.get('created', now),
-            'modified': modified or now,
+            'modified': kwargs.get('modified', now),
-            'labels': labels,
+            'labels': kwargs['labels'],
-            'pattern': pattern,
+            'pattern': kwargs['pattern'],
-            'valid_from': valid_from or now,
+            'valid_from': kwargs.get('valid_from', now),
         }
 
     def _dict(self):
@@ -102,8 +118,16 @@ class Indicator(_STIXBase):
 
 class Malware(_STIXBase):
 
-    def __init__(self, type='malware', id=None, created=None, modified=None,
+    _properties = [
-                 labels=None, name=None):
+        'type',
+        'id',
+        'created',
+        'modified',
+        'labels',
+        'name',
+    ]
+
+    def __init__(self, **kwargs):
         # TODO:
         # - created_by_ref
         # - revoked
@@ -114,30 +138,37 @@ class Malware(_STIXBase):
         # - description
         # - kill_chain_phases
 
-        if not created or not modified:
+        # TODO: do we care about the performance penalty of creating this
-            now = datetime.now(tz=pytz.UTC)
+        # if we won't need it?
+        now = datetime.now(tz=pytz.UTC)
 
-        if type != 'malware':
+        if not kwargs.get('type'):
+            kwargs['type'] = 'malware'
+        if kwargs['type'] != 'malware':
             raise ValueError("Malware must have type='malware'.")
 
-        if not id:
+        if not kwargs.get('id'):
-            id = 'malware--' + str(uuid.uuid4())
+            kwargs['id'] = 'malware--' + str(uuid.uuid4())
-        if not id.startswith('malware--'):
+        if not kwargs['id'].startswith('malware--'):
             raise ValueError("Malware id values must begin with 'malware--'.")
 
-        if not labels:
+        if not kwargs.get('labels'):
             raise ValueError("Missing required field for Malware: 'labels'.")
 
-        if not name:
+        if not kwargs.get('name'):
             raise ValueError("Missing required field for Malware: 'name'.")
 
+        extra_kwargs = list(set(kwargs.keys()) - set(self._properties))
+        if extra_kwargs:
+            raise TypeError("unexpected keyword arguments: " + str(extra_kwargs))
+
         self._inner = {
-            'type': type,
+            'type': kwargs['type'],
-            'id': id,
+            'id': kwargs['id'],
-            'created': created or now,
+            'created': kwargs.get('created', now),
-            'modified': modified or now,
+            'modified': kwargs.get('modified', now),
-            'labels': labels,
+            'labels': kwargs['labels'],
-            'name': name,
+            'name': kwargs['name'],
         }
 
     def _dict(self):

stix2/test/test_stix2.py

@@ -81,7 +81,7 @@ def test_indicator_type_must_be_indicator():
     with pytest.raises(ValueError) as excinfo:
         indicator = stix2.Indicator(type='xxx')
 
-    assert "Indicators must have type='indicator'." in str(excinfo)
+    assert "Indicator must have type='indicator'." in str(excinfo)
 
 
 def test_indicator_id_must_start_with_indicator():
@@ -113,6 +113,12 @@ def test_cannot_assign_to_attributes():
     assert "Cannot modify properties after creation." in str(excinfo)
 
 
+def test_invalid_kwarg_to_indicator():
+    with pytest.raises(TypeError) as excinfo:
+        indicator = stix2.Indicator(my_custom_property="foo", **INDICATOR_KWARGS)
+    assert "unexpected keyword arguments: ['my_custom_property']" in str(excinfo)
+
+
 EXPECTED_MALWARE = """{
     "created": "2016-05-12T08:17:27Z",
     "id": "malware--0c7b5b88-8ff7-4a4d-aa9d-feb398cd0061",