Excise NullObject from github3.py

sigmavirus24 · sigmavirus24 · commit 9cab37004c4c · 2017-01-29T09:34:39.000-06:00
As part of on going work to improve the overall design and simplicity, we're removing the NullObject and it's usage. At the present time, it causes a lot of confusion for users (not as much as Empty, but still up there) and there are simpler ways of designing the library than this. Related-to sigmavirus24#670
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
