17、Python 面向对象编程：GitHub 类的实现与应用

Python 面向对象编程：GitHub 类的实现与应用

1. 项目任务概述

在本次项目中，我们将创建一个名为 Github() 的类，用于与 GitHub API 进行交互。这个类将具备获取用户信息和用户仓库信息的功能。

2. 类的创建与属性设置

首先，我们需要创建 Github() 类，并为其定义两个属性：
- username ：GitHub 用户名。
- base_url ：GitHub API 的基础 URL（https://developer.github.com/v3/）。

以下是实现代码：

from urllib.request import Request, urlopen

class Github():
    def __init__(self, username):
        self.username = username
        self.base_url = "https://developer.github.com/v3/"

上述代码中，我们导入了 Request 和 urlopen 函数，用于后续的 API 调用。在 __init__ 方法中，我们初始化了 username 和 base_url 属性。

3. 实例方法的添加

接下来，我们为 Github() 类添加两个实例方法：
- get_user_info() ：从 https://api.github.com/users/:USERNAME 获取 GitHub 用户信息，并以 JSON 格式返回。
- get_user_repos() ：从 https://api.github.com/users/:USERNAME/repos 获取 GitHub 用户的仓库信息，并以 JSON 格式返回。

import json

class Github():
    def __init__(self, username):
        self.username = username
        self.base_url = "https://developer.github.com/v3/"

    def get_user_info(self):
        url = f"https://api.github.com/users/{self.username}"
        request = Request(url)
        response = urlopen(request)
        return json.loads(response.read())

    def get_user_repos(self):
        url = f"https://api.github.com/users/{self.username}/repos"
        request = Request(url)
        response = urlopen(request)
        return json.loads(response.read())

在上述代码中，我们使用了 f-string 来动态生成 API 请求的 URL。通过 Request 类创建请求对象，然后使用 urlopen 函数发送请求并获取响应。最后，使用 json.loads 函数将响应内容解析为 JSON 格式。

4. 创建实例并调用方法

为了验证我们的类和方法是否正常工作，我们需要创建一个实例并调用这些方法。

# 创建实例
github = Github("your_username")

# 获取用户信息
user_info = github.get_user_info()
print("用户信息：")
print(user_info)

# 获取用户仓库信息
user_repos = github.get_user_repos()
print("用户仓库信息：")
print(user_repos)

请将 "your_username" 替换为你自己的 GitHub 用户名。运行上述代码后，你将看到用户信息和用户仓库信息以 JSON 格式输出。

5. 流程图展示

graph TD;
    A[创建 Github 类实例] --> B[调用 get_user_info 方法];
    B --> C[发送 API 请求获取用户信息];
    C --> D[解析响应为 JSON 格式];
    D --> E[输出用户信息];
    A --> F[调用 get_user_repos 方法];
    F --> G[发送 API 请求获取用户仓库信息];
    G --> H[解析响应为 JSON 格式];
    H --> I[输出用户仓库信息];

6. 总结

通过本次项目，我们学习了如何使用 Python 的面向对象编程思想创建一个与 GitHub API 交互的类。这个类可以方便地获取用户信息和用户仓库信息。同时，我们也了解了如何使用 urllib 库发送 HTTP 请求，并处理 JSON 格式的响应。

7. 学习资源推荐

如果你想进一步学习面向对象编程，可以参考以下资源：
1. 官方 Python 文档
2. 《Dive into Python》
3. 《Learn Python the Hard Way》
4. 《Dive Into Object-oriented Python》

8. 致谢

在项目的实现过程中，得到了许多朋友和同事的帮助和支持，在此向他们表示衷心的感谢。以下是部分感谢名单：
| 姓名 | 贡献 |
| ---- | ---- |
| Brian | 提供宝贵建议和反馈 |
| Peter | 提供宝贵建议和反馈 |
| Anna | 提供宝贵建议和反馈 |
| Doug | 提供宝贵建议和反馈 |
| Sofia | 多次阅读材料并提供反馈 |
| Josh | 分享宝贵经验和见解 |

还有许多 Kickstarter 支持者，他们的慷慨支持使得这个项目得以实现。感谢他们的信任和鼓励。

Python 面向对象编程：GitHub 类的实现与应用

9. 更多功能拓展思路

虽然我们已经实现了基本的获取用户信息和仓库信息的功能，但这个 Github() 类还可以进行更多的拓展。以下是一些拓展思路：
- 错误处理 ：在发送 API 请求时，可能会遇到网络问题、API 限制等错误。我们可以添加错误处理机制，例如捕获 HTTPError 和 URLError 异常，并进行相应的处理。

import json
from urllib.request import Request, urlopen
from urllib.error import HTTPError, URLError

class Github():
    def __init__(self, username):
        self.username = username
        self.base_url = "https://developer.github.com/v3/"

    def get_user_info(self):
        url = f"https://api.github.com/users/{self.username}"
        try:
            request = Request(url)
            response = urlopen(request)
            return json.loads(response.read())
        except HTTPError as e:
            print(f"HTTP 错误: {e.code} - {e.reason}")
        except URLError as e:
            print(f"URL 错误: {e.reason}")

    def get_user_repos(self):
        url = f"https://api.github.com/users/{self.username}/repos"
        try:
            request = Request(url)
            response = urlopen(request)
            return json.loads(response.read())
        except HTTPError as e:
            print(f"HTTP 错误: {e.code} - {e.reason}")
        except URLError as e:
            print(f"URL 错误: {e.reason}")

• 分页处理 ：当用户的仓库数量较多时，API 可能会进行分页返回。我们可以添加分页处理功能，以获取所有的仓库信息。

import json
from urllib.request import Request, urlopen
from urllib.error import HTTPError, URLError

class Github():
    def __init__(self, username):
        self.username = username
        self.base_url = "https://developer.github.com/v3/"

    def get_user_info(self):
        url = f"https://api.github.com/users/{self.username}"
        try:
            request = Request(url)
            response = urlopen(request)
            return json.loads(response.read())
        except HTTPError as e:
            print(f"HTTP 错误: {e.code} - {e.reason}")
        except URLError as e:
            print(f"URL 错误: {e.reason}")

    def get_user_repos(self):
        all_repos = []
        page = 1
        while True:
            url = f"https://api.github.com/users/{self.username}/repos?page={page}&per_page=100"
            try:
                request = Request(url)
                response = urlopen(request)
                repos = json.loads(response.read())
                if not repos:
                    break
                all_repos.extend(repos)
                page += 1
            except HTTPError as e:
                print(f"HTTP 错误: {e.code} - {e.reason}")
                break
            except URLError as e:
                print(f"URL 错误: {e.reason}")
                break
        return all_repos

10. 拓展功能流程图

graph TD;
    A[创建 Github 类实例] --> B[调用 get_user_info 方法];
    B --> C[发送 API 请求获取用户信息];
    C --> D{是否有错误};
    D -- 否 --> E[解析响应为 JSON 格式];
    E --> F[输出用户信息];
    D -- 是 --> G[输出错误信息];
    A --> H[调用 get_user_repos 方法];
    H --> I[初始化分页参数];
    I --> J[发送 API 请求获取仓库信息];
    J --> K{是否有错误};
    K -- 否 --> L{是否有仓库信息};
    L -- 是 --> M[添加仓库信息到列表];
    M --> N[更新分页参数];
    N --> J;
    L -- 否 --> O[输出所有仓库信息];
    K -- 是 --> P[输出错误信息];

11. 总结拓展

通过上述拓展，我们的 Github() 类变得更加健壮和强大。错误处理机制可以让我们的程序在遇到异常情况时能够给出明确的提示，而分页处理功能则可以确保我们获取到用户的所有仓库信息。

12. 进一步学习建议

如果你对 Python 面向对象编程和 API 交互感兴趣，可以尝试以下学习方向：
- 学习使用 requests 库代替 urllib 进行 HTTP 请求， requests 库的使用更加简洁和方便。
- 探索其他 GitHub API 的功能，例如创建仓库、提交代码等。
- 结合数据库，将获取到的用户信息和仓库信息存储到数据库中，以便后续的分析和处理。

13. 完整感谢名单

除了前面提到的朋友和同事，还有众多支持者为这个项目提供了帮助，以下是完整的感谢名单：
| 姓名 | 贡献 |
| ---- | ---- |
| Benjamin Bangsberg | 支持项目 |
| JT | 支持项目 |
| Romer Magsino | 支持项目 |
| … | … |
| [众多其他支持者] | 支持项目 |

再次感谢所有给予帮助和支持的人，希望大家能够继续在社区中积极交流和分享。