Move NullObject to its own module

sigmavirus24 · sigmavirus24 · commit 015d56f548b8 · 2014-09-06T13:29:33.000-05:00
Due to this, move tests to their own file as well.
diff --git a/github3/api.py b/github3/api.py
@@ -46,7 +46,7 @@ def login(username=None, password=None, token=None, two_factor_callback=None):
         To allow you to specify either a username and password combination or
         a token, none of the parameters are required. If you provide none of
         them, you will receive a
-        :class:`NullObject <github3.structs.NullObject>`
+        :class:`NullObject <github3.null.NullObject>`
 
     :param str username: login name
     :param str password: password for the login
diff --git a/github3/models.py b/github3/models.py
@@ -15,6 +15,7 @@
 
 from github3.decorators import requires_auth
 from github3.exceptions import error_for
+from github3.null import NullObject
 from github3.session import GitHubSession
 from github3.utils import UTC
 
@@ -139,6 +140,14 @@ def _remove_none(data):
             if v is None:
                 del(data[k])
 
+    def _instance_or_null(self, instance_class, json):
+        if json is None:
+            return NullObject(str(instance_class))
+        try:
+            return instance_class(json, self)
+        except TypeError:  # instance_class is not a subclass of GitHubCore
+            return instance_class(json)
+
     def _json(self, response, status_code):
         ret = None
         if self._boolean(response, status_code, 404) and response.content:
diff --git a/github3/null.py b/github3/null.py
@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+from requests.compat import is_py3
+
+
+class NullObject(object):
+    def __init__(self, initializer=None):
+        self.__dict__['initializer'] = initializer
+
+    def __int__(self):
+        return 0
+
+    def __bool__(self):
+        return False
+
+    __nonzero__ = __bool__
+
+    def __str__(self):
+        return ''
+
+    def __unicode__(self):
+        return '' if is_py3 else ''.decode()
+
+    def __repr__(self):
+        return '<NullObject({0})>'.format(
+            repr(self.__getattribute__('initializer'))
+            )
+
+    def __getitem__(self, index):
+        return self
+
+    def __setitem__(self, index, value):
+        pass
+
+    def __getattr__(self, attr):
+        return self
+
+    def __setattr__(self, attr, value):
+        pass
+
+    def __call__(self, *args, **kwargs):
+        return self
+
+    def __contains__(self, other):
+        return False
+
+    def __iter__(self):
+        return iter([])
+
+    def __next__(self):
+        raise StopIteration
+
+    next = __next__
+
+    def is_null(self):
+        return True
diff --git a/github3/structs.py b/github3/structs.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from collections import Iterator
 from github3.models import GitHubCore
-from requests.compat import is_py3, urlparse, urlencode
+from requests.compat import urlparse, urlencode
 
 
 class GitHubIterator(GitHubCore, Iterator):
@@ -139,56 +139,3 @@ def _get_json(self, response):
         self.items = json.get('items', [])
         # If we return None then it will short-circuit the while loop.
         return json.get('items')
-
-
-class NullObject(object):
-    def __init__(self, initializer=None):
-        self.__dict__['initializer'] = initializer
-
-    def __int__(self):
-        return 0
-
-    def __bool__(self):
-        return False
-
-    __nonzero__ = __bool__
-
-    def __str__(self):
-        return ''
-
-    def __unicode__(self):
-        return '' if is_py3 else ''.decode()
-
-    def __repr__(self):
-        return '<NullObject({0})>'.format(
-            repr(self.__getattribute__('initializer'))
-            )
-
-    def __getitem__(self, index):
-        return self
-
-    def __setitem__(self, index, value):
-        pass
-
-    def __getattr__(self, attr):
-        return self
-
-    def __setattr__(self, attr, value):
-        pass
-
-    def __call__(self, *args, **kwargs):
-        return self
-
-    def __contains__(self, other):
-        return False
-
-    def __iter__(self):
-        return iter([])
-
-    def __next__(self):
-        raise StopIteration
-
-    next = __next__
-
-    def is_null(self):
-        return True
diff --git a/tests/unit/helper.py b/tests/unit/helper.py
@@ -155,7 +155,7 @@ class has a dummy ``__iter__`` implementation which we want for
         # Retrieve a mocked session object
         session = super(UnitIteratorHelper, self).create_mocked_session(*args)
         # Initialize a NullObject which has magical properties
-        null = github3.structs.NullObject()
+        null = github3.null.NullObject()
         # Set it as the return value for every method
         session.delete.return_value = null
         session.get.return_value = null
diff --git a/tests/unit/test_null.py b/tests/unit/test_null.py
@@ -0,0 +1,62 @@
+from .helper import UnitHelper
+from github3.null import NullObject
+
+import pytest
+
+
+class TestNullObject(UnitHelper):
+    described_class = NullObject
+
+    def create_instance_of_described_class(self):
+        return self.described_class()
+
+    def test_returns_empty_list(self):
+        assert list(self.instance) == []
+
+    def test_contains_nothing(self):
+        assert 'foo' not in self.instance
+
+    def test_returns_itself_when_called(self):
+        assert self.instance('foo', 'bar', 'bogus') is self.instance
+
+    def test_returns_empty_string(self):
+        assert str(self.instance) == ''
+
+    def test_allows_arbitrary_attributes(self):
+        assert self.instance.attr is self.instance
+
+    def test_allows_arbitrary_attributes_to_be_set(self):
+        self.instance.attr = 'new'
+        assert self.instance.attr is self.instance
+
+    def test_provides_an_api_to_check_if_it_is_null(self):
+        assert self.instance.is_null()
+
+    def test_stops_iteration(self):
+        with pytest.raises(StopIteration):
+            next(self.instance)
+
+    def test_next_raises_stops_iteration(self):
+        with pytest.raises(StopIteration):
+            self.instance.next()
+
+    def test_getitem_returns_itself(self):
+        assert self.instance['attr'] is self.instance
+
+    def test_setitem_sets_nothing(self):
+        self.instance['attr'] = 'attr'
+        assert self.instance['attr'] is self.instance
+
+    def test_turns_into_unicode(self):
+        unicode_str = b''.decode('utf-8')
+        try:
+            assert unicode(self.instance) == unicode_str
+        except NameError:
+            assert str(self.instance) == unicode_str
+
+    def test_instances_are_falsey(self):
+        if self.instance:
+            pytest.fail()
+
+    def test_instances_can_be_coerced_to_zero(self):
+        assert int(self.instance) == 0
diff --git a/tests/unit/test_structs.py b/tests/unit/test_structs.py
@@ -1,7 +1,5 @@
 from .helper import UnitHelper, mock
-from github3.structs import GitHubIterator, NullObject
-
-import pytest
+from github3.structs import GitHubIterator
 
 
 class TestGitHubIterator(UnitHelper):
@@ -38,61 +36,3 @@ def test_stores_headers_properly(self):
         i = GitHubIterator(count, url, cls, session, headers=headers)
         assert i.headers != {}
         assert i.headers.get('Accept') == 'foo'
-
-
-class TestNullObject(UnitHelper):
-    described_class = NullObject
-
-    def create_instance_of_described_class(self):
-        return self.described_class()
-
-    def test_returns_empty_list(self):
-        assert list(self.instance) == []
-
-    def test_contains_nothing(self):
-        assert 'foo' not in self.instance
-
-    def test_returns_itself_when_called(self):
-        assert self.instance('foo', 'bar', 'bogus') is self.instance
-
-    def test_returns_empty_string(self):
-        assert str(self.instance) == ''
-
-    def test_allows_arbitrary_attributes(self):
-        assert self.instance.attr is self.instance
-
-    def test_allows_arbitrary_attributes_to_be_set(self):
-        self.instance.attr = 'new'
-        assert self.instance.attr is self.instance
-
-    def test_provides_an_api_to_check_if_it_is_null(self):
-        assert self.instance.is_null()
-
-    def test_stops_iteration(self):
-        with pytest.raises(StopIteration):
-            next(self.instance)
-
-    def test_next_raises_stops_iteration(self):
-        with pytest.raises(StopIteration):
-            self.instance.next()
-
-    def test_getitem_returns_itself(self):
-        assert self.instance['attr'] is self.instance
-
-    def test_setitem_sets_nothing(self):
-        self.instance['attr'] = 'attr'
-        assert self.instance['attr'] is self.instance
-
-    def test_turns_into_unicode(self):
-        unicode_str = b''.decode('utf-8')
-        try:
-            assert unicode(self.instance) == unicode_str
-        except NameError:
-            assert str(self.instance) == unicode_str
-
-    def test_instances_are_falsey(self):
-        if self.instance:
-            pytest.fail()
-
-    def test_instances_can_be_coerced_to_zero(self):
-        assert int(self.instance) == 0
