Set GitHub API version via __init__

This replaces the setter method with a named
parameter of __init__.

Author: anz-ableton

src/github3/github.py

@@ -59,9 +59,21 @@ class GitHub(models.GitHubCore):
     call the GitHub object with authentication parameters.
     """
 
-    def __init__(self, username="", password="", token="", session=None):
-        """Create a new GitHub instance to talk to the API."""
+    def __init__(
+        self, username="", password="", token="", session=None, api_version=""
+    ):
+        """Create a new GitHub instance to talk to the API.
+
+        :param str api_version:
+            API version to send with X-GitHub-Api-Version header.
+            See https://docs.github.com/en/rest/overview/api-versions
+            for details about API versions.
+        """
         super().__init__({}, session or self.new_session())
+
+        if api_version:
+            self.session.headers.update({"X-GitHub-Api-Version": api_version})
+
         if token:
             self.login(username, token=token)
         elif username and password:
@@ -2596,17 +2608,6 @@ def set_client_id(self, id, secret):
         """
         self.session.params = {"client_id": id, "client_secret": secret}
 
-    def set_api_version(self, api_version):
-        """Allow to set a specific API version.
-
-        :param str api_version:
-            API version to send with X-GitHub-Api-Version header.
-            See https://docs.github.com/en/rest/overview/api-versions?apiVersion=2022-11-28 for details on API versions.
-        """  # noqa: E501
-        if not api_version:
-            return
-        self.session.headers.update({"X-GitHub-Api-Version": api_version})
-
     def set_user_agent(self, user_agent):
         """Allow the user to set their own user agent string.
 

tests/unit/test_github.py

@@ -727,12 +727,6 @@ def test_set_user_agent_required_user_agent(self):
 
         self.session.headers.update.called is False
 
-    def test_set_api_version(self):
-        self.instance.set_api_version("2022-11-28")
-        self.session.headers.update.assert_called_once_with(
-            {"X-GitHub-Api-Version": "2022-11-28"}
-        )
-
     def test_set_user_agent(self):
         self.instance.set_user_agent("github3py")
         self.session.headers.update.assert_called_once_with(
@@ -1396,6 +1390,14 @@ def test_search_users(self):
             headers={},
         )
 
+    def test_api_version_header(_):
+        gh = GitHub(api_version="2022-11-28")
+        assert gh.session.headers.get("X-GitHub-Api-Version") == "2022-11-28"
+
+    def test_api_version_header_not_defined(_):
+        gh = GitHub()
+        assert gh.session.headers.get("X-GitHub-Api-Version") is None
+
 
 class TestGitHubRequiresAuthentication(
     helper.UnitRequiresAuthenticationHelper