Merge pull request sigmavirus24#678 from sigmavirus24/excise-null-obj

sigmavirus24 · web-flow · commit 3e251f2a066d · 2017-01-29T13:27:49.000-06:00
Excise NullObject from github3.py
diff --git a/github3/api.py b/github3/api.py
@@ -47,8 +47,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.null.NullObject>`
+        them, you will receive ``None``.
 
     :param str username: login name
     :param str password: password for the login
@@ -75,8 +74,7 @@ def enterprise_login(username=None, password=None, token=None, url=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>`
+        them, you will receive ``None``.
 
     :param str username: login name
     :param str password: password for the login
diff --git a/github3/github.py b/github3/github.py
@@ -284,15 +284,7 @@ def create_issue(self, owner, repository, title, body=None, assignee=None,
         if owner and repository and title:
             repo = self.repository(owner, repository)
 
-        # repo can be None or a NullObject.
-        # If repo is None, than one of owner, repository, or title were
-        # False-y. If repo is a NullObject then owner/repository 404's.
-
         if repo is not None:
-            # If repo is a NullObject then that's most likely because the
-            # repository was not found (404). In that case, calling the
-            # create_issue method will still return <NullObject('Repository')>
-            # which will ideally help the user understand what went wrong.
             return repo.create_issue(title, body, assignee, milestone, labels)
 
         return self._instance_or_null(Issue, None)
diff --git a/github3/models.py b/github3/models.py
@@ -17,7 +17,6 @@
 
 from . import exceptions
 from .decorators import requires_auth
-from .null import NullObject
 from .session import GitHubSession
 from .utils import UTC
 
@@ -198,7 +197,7 @@ def _instance_or_null(self, instance_class, json):
                 "GitHub's API returned a body that could not be handled", json
             )
         if not json:
-            return NullObject(instance_class.__name__)
+            return None
         try:
             return instance_class(json, self)
         except TypeError:  # instance_class is not a subclass of GitHubCore
diff --git a/github3/null.py b/github3/null.py
diff --git a/tests/unit/helper.py b/tests/unit/helper.py
@@ -6,6 +6,7 @@
 import github3
 import json
 import os.path
+import sys
 import pytest
 import unittest
 
@@ -173,7 +174,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.null.NullObject()
+        null = NullObject()
         # Set it as the return value for every method
         session.delete.return_value = null
         session.get.return_value = null
@@ -263,3 +264,59 @@ def setUp(self):
         # internet
         self.instance._build_url = self.build_url
         self.after_setup()
+
+
+is_py3 = (3, 0) <= sys.version_info < (4, 0)
+
+
+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/test_null.py b/tests/unit/test_null.py
diff --git a/tests/unit/test_repos_repo.py b/tests/unit/test_repos_repo.py
@@ -5,7 +5,6 @@
 
 from base64 import b64encode
 from github3 import GitHubError
-from github3.null import NullObject
 from github3.repos.repo import (Comparison, Contents, Hook, RepoComment,
                                 RepoCommit, Repository)
 from github3.models import GitHubCore
@@ -80,7 +79,6 @@ def test_add_collaborator(self):
     def test_add_null_collaborator(self):
         """Verify no request is made when adding `None` as a collaborator."""
         self.instance.add_collaborator(None)
-        self.instance.add_collaborator(NullObject())
 
         assert self.session.put.called is False
 
