如何将新文件推送到 GitHub？答案

【问题标题】：How do I push new files to GitHub?如何将新文件推送到 GitHub？
【发布时间】：2016-11-30 09:17:45
【问题描述】：

我在 github.com 上创建了一个新的存储库，然后将其克隆到我的本地机器上

git clone https://github.com/usrname/mathematics.git

我在mathematics文件夹下添加了3个新文件

$ tree 
.
├── LICENSE
├── numerical_analysis
│   └── regression_analysis
│       ├── simple_regression_analysis.md
│       ├── simple_regression_analysis.png
│       └── simple_regression_analysis.py

现在，我想使用 Python 将 3 个新文件上传到我的 GitHub，更具体地说，PyGithub。这是我尝试过的：

#!/usr/bin/env python
# *-* coding: utf-8 *-*
from github import Github

def main():
    # Step 1: Create a Github instance:
    g = Github("usrname", "passwd")
    repo = g.get_user().get_repo('mathematics')

    # Step 2: Prepare files to upload to GitHub
    files = ['mathematics/numerical_analysis/regression_analysis/simple_regression_analysis.py', 'mathematics/numerical_analysis/regression_analysis/simple_regression_analysis.png']

    # Step 3: Make a commit and push
    commit_message = 'Add simple regression analysis'

    tree = repo.get_git_tree(sha)
    repo.create_git_commit(commit_message, tree, [])
    repo.push()

if __name__ == '__main__':
    main()

我不知道

如何为repo.get_git_tree 获取字符串sha
如何在第 2 步和第 3 步之间建立连接，即推送特定文件

就个人而言，PyGithub documentation 不可读。找了很久也没找到合适的api。

【问题讨论】：

要获得sha，您需要使用hashlib
@WayneWerner 这绝对不是他应该做的。 sha 是由 git 计算得出的，如果您尝试自己计算，几乎肯定会出错。
我可以知道投反对票的原因吗？
那么，直接调用git与它交互如何？或者使用GitPython之类的python接口，不一定是面向GitHub的？它的文档确实……非常稀少，我认为它不可用。
我对文档的理解是，您想要获取分支，从中获取 HEAD 提交（从中获取提交的 sha 值和基础树）。有了它，调用create_git_tree 传递HEAD 的树作为基础，并给它一个InputGitTreeElement 列表（设置content，但单独留下sha）和你的修改。然后用你的新树调用create_git_commit。最后，您需要获取分支 ref 并将其更新为您的新提交 sha。找到一些包含这个库的库可能比自己做要容易。

标签： python git github pygithub

【解决方案1】：

我尝试使用GitHub API 提交多个文件。 Git Data API 的这个页面说它应该“非常简单”。有关该调查的结果，请参阅this answer。

我建议使用类似GitPython:

from git import Repo

repo_dir = 'mathematics'
repo = Repo(repo_dir)
file_list = [
    'numerical_analysis/regression_analysis/simple_regression_analysis.py',
    'numerical_analysis/regression_analysis/simple_regression_analysis.png'
]
commit_message = 'Add simple regression analysis'
repo.index.add(file_list)
repo.index.commit(commit_message)
origin = repo.remote('origin')
origin.push()

注意：此版本的脚本在存储库的父目录中运行。

【讨论】：

您只能在当前工作目录的根目录或子目录中添加文件，不能从父目录添加文件。
好吧，您可以简单地使用os.chdir() 来处理另一个目录或 Git 存储库，例如在使用单独的存储库进行备份时。以上也将继续在“新”git项目中工作。
文件列表中需要添加哪个路径？当我提供本地可用的图像路径时，它会显示错误 filenotfounderror winerror 2 python

【解决方案2】：

注意：此版本的脚本是从 GIT 存储库中调用的，因为我从文件路径中删除了存储库名称。

我终于想通了如何使用PyGithub来提交多个文件：

import base64
from github import Github
from github import InputGitTreeElement

token = '5bf1fd927dfb8679496a2e6cf00cbe50c1c87145'
g = Github(token)
repo = g.get_user().get_repo('mathematics')
file_list = [
    'numerical_analysis/regression_analysis/simple_regression_analysis.png',
    'numerical_analysis/regression_analysis/simple_regression_analysis.py'
]
commit_message = 'Add simple regression analysis'
master_ref = repo.get_git_ref('heads/master')
master_sha = master_ref.object.sha
base_tree = repo.get_git_tree(master_sha)
element_list = list()
for entry in file_list:
    with open(entry, 'rb') as input_file:
        data = input_file.read()
    if entry.endswith('.png'):
        data = base64.b64encode(data)
    element = InputGitTreeElement(entry, '100644', 'blob', data)
    element_list.append(element)
tree = repo.create_git_tree(element_list, base_tree)
parent = repo.get_git_commit(master_sha)
commit = repo.create_git_commit(commit_message, tree, [parent])
master_ref.edit(commit.sha)
""" An egregious hack to change the PNG contents after the commit """
for entry in file_list:
    with open(entry, 'rb') as input_file:
        data = input_file.read()
    if entry.endswith('.png'):
        old_file = repo.get_contents(entry)
        commit = repo.update_file('/' + entry, 'Update PNG content', data, old_file.sha)

如果我尝试从 PNG 文件中添加原始数据，对 create_git_tree 的调用最终会在 Requester.py 中调用 json.dumps，这会导致引发以下异常：

UnicodeDecodeError: 'utf8' codec can't decode byte 0x89 in position 0: invalid start byte

我通过base64 编码PNG 数据并提交它来解决这个问题。后来，我使用update_file的方法来更改PNG数据。这会导致对存储库的两次单独提交，这可能不是您想要的。

【讨论】：

【解决方案3】：

我可以给你一些信息支持，但也是一个具体的解决方案。

Here 您可以找到将新文件添加到存储库的示例，here 是一个视频教程。

您可以在 GitHub 的开发者页面上看到与 GitHub 一起使用的 python 包列表：

但如果需要，您也可以使用 IPython 中的命令推送文件：

In [1]: import subprocess
In [2]: print subprocess.check_output('git init', shell=True)
Initialized empty Git repository in /home/code/.git/
In [3]: print subprocess.check_output('git add .', shell=True)
In [4]: print subprocess.check_output('git commit -m "a commit"', shell=True)

【讨论】：

【解决方案4】：

使用子流程，这将做同样的工作-

import subprocess
subprocess.call(['git', 'add', '-A'])
subprocess.call(['git', 'commit', '-m', '{}'.format(commit_message)])
subprocess.call(['git', 'push', 'https://{}@github.com/user-name/repo.git'.format(token)])

确保使用 -A 或 -all 来跟踪项目/甚至父目录中的所有文件。使用“混帐添加。”将仅跟踪编写此代码的 cwd 内的文件。

【讨论】：

【解决方案5】：

import subprocess
p = subprocess.Popen("git rev-parse HEAD".split(), stdout=subprocess.PIPE)
out, err = p.communicate()
sha = out.strip()

可能有一种方法可以用 PyGithub 做到这一点，但这应该可以快速破解。

【讨论】：

【解决方案6】：

如果您不需要 pygithub，dulwich git-library 提供high level git commands。有关命令，请查看https://www.dulwich.io/apidocs/dulwich.porcelain.html

【讨论】：

感谢您的快速响应。如果您能提供 MWE，那就太好了。
@sparkandshine 抱歉 - 什么是 MWE？最小的工作示例？
没错，Minimal working example
以为我在一个较旧的项目中使用了 dulwich，但实际上我只是通过子进程使用普通的 git 命令 - 抱歉，没有工作示例

【解决方案7】：

如果 PyGithub 的文档不可用（而且看起来不可用），而您只想推送一个提交（不做任何花哨的问题、repo 配置等），您可能最好直接连接使用 git，调用 git 可执行文件或使用包装库，例如 GitPython。

直接使用git 与您提到的subprocess.Popen 之类的东西在倾斜曲线上可能更容易，但从长远来看，对于错误处理等也更困难，因为您实际上并没有很好的抽象传递，并且必须自己进行解析。

摆脱 PyGithub 还可以让您摆脱对 GitHub 及其 API 的束缚，让您可以推送到任何存储库，甚至是计算机上的另一个文件夹。

【讨论】：