RflySimSDK v4.10
RflySimSDK说明文档
载入中...
搜索中...
未找到
Public 成员函数 | Public 属性 | Protected 成员函数 | 所有成员列表
GitOperations类 参考

Public 成员函数

 __init__ (self, repo_path=None)
 初始化Git操作对象
 reset_repos_path (self, repo_path)
 重置仓库目录
 run_other_cmd (self, command)
 提供一个其他未进一步封装执行Git命令的方法
 clone (self, repo_url, target_dir=None, recursive=False)
 从指定仓库地址进行克隆到指定本地目录
 clone_bare (self, repo_url, target_dir=None)
 从指定仓库地址进行克隆到指定本地目录，并发布为bare服务
 init (self)
 初始化本地仓库
 get_remote_origin_url (self)
 获取当前仓库的远程地址
 pull (self)
 拉取远程仓库最新代码
 checkout (self, branch_name)
 切换分支
 checkout_submodules_branch (self, branch_name)
 切换所有子库到指定分支
 create_branch (self, branch_name)
 创建新分支
 add (self, files=".")
 添加文件到暂存区
 commit (self, message)
 提交更改
 push (self, remote="origin", branch_name=None)
 推送更改到远程仓库
 update_to_last_commit (self, branch_name)
 同步到远程仓最新的提交
 status (self, extParam=None)
 查看工作区状态
 log (self, num_commits=10)
 查看提交日志
 branches (self, remote=False)
 查看分支列表
 current_branchName (self)
 当前分支名称
 exists_submodules (self)
 检查是否存在子模块
 update_submodules_to_last_commit (self, branch_name)
 同步所有子库到远程仓最新的提交
 git_daemon_repos (self, basepath, port=None)
 发布git守护进程服务

Public 属性

 repo_path = repo_path or os.getcwd()

Protected 成员函数

 _run_command (self, command)
 执行Git命令的内部方法

构造及析构函数说明

◆ __init__()

__init__ ( self,
repo_path = None )

初始化Git操作对象

  • 参数
    repo_pathGit仓库路径，默认为当前目录
    返回
    无

成员函数说明

◆ _run_command()

_run_command ( self,
command )
protected

执行Git命令的内部方法

  • 参数
    command要执行的Git命令列表
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
这是这个函数的调用关系图:

◆ add()

add ( self,
files = "." )

添加文件到暂存区

  • 参数
    files要添加的文件，默认为所有文件
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ branches()

branches ( self,
remote = False )

查看分支列表

  • 参数
    remote是否显示远程分支，默认为False
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ checkout()

checkout ( self,
branch_name )

切换分支

  • 参数
    branch_name分支名称
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ checkout_submodules_branch()

checkout_submodules_branch ( self,
branch_name )

切换所有子库到指定分支

  • 参数
    branch_name分支名称
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ clone()

clone ( self,
repo_url,
target_dir = None,
recursive = False )

从指定仓库地址进行克隆到指定本地目录

  • 参数
    repo_url仓库URL
    target_dir目标目录，默认为仓库名
    recursive是否递归Clone包括子库
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ clone_bare()

clone_bare ( self,
repo_url,
target_dir = None )

从指定仓库地址进行克隆到指定本地目录，并发布为bare服务

  • 参数
    repo_url仓库URL
    target_dir目标目录，默认为仓库名
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ commit()

commit ( self,
message )

提交更改

  • 参数
    message提交信息
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ create_branch()

create_branch ( self,
branch_name )

创建新分支

  • 参数
    branch_name分支名称
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ current_branchName()

current_branchName ( self)

当前分支名称

  • 返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ exists_submodules()

exists_submodules ( self)

检查是否存在子模块

  • 返回
    命令输出结果

◆ get_remote_origin_url()

get_remote_origin_url ( self)

获取当前仓库的远程地址

  • 返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ git_daemon_repos()

git_daemon_repos ( self,
basepath,
port = None )

发布git守护进程服务

  • 参数
    basepath指定git服务对应资源基础路径
    port指定Git服务发布端口，默认9418
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ init()

init ( self)

初始化本地仓库

  • 返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ log()

log ( self,
num_commits = 10 )

查看提交日志

  • 参数
    num_commits显示的提交数量，默认为10
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ pull()

pull ( self)

拉取远程仓库最新代码

  • 返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ push()

push ( self,
remote = "origin",
branch_name = None )

推送更改到远程仓库

  • 参数
    remote远程仓库名称，默认为origin
    branch_name分支名称，默认为当前分支
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ reset_repos_path()

reset_repos_path ( self,
repo_path )

重置仓库目录

  • 参数
    repo_path: Git仓库路径，默认为当前目录
    返回
    无

◆ run_other_cmd()

run_other_cmd ( self,
command )

提供一个其他未进一步封装执行Git命令的方法

  • 参数
    command要执行的Git命令列表
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ status()

status ( self,
extParam = None )

查看工作区状态

  • 参数
    extParam附加参数
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ update_submodules_to_last_commit()

update_submodules_to_last_commit ( self,
branch_name )

同步所有子库到远程仓最新的提交

  • 参数
    branch_name分支名称，默认为当前分支
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:

◆ update_to_last_commit()

update_to_last_commit ( self,
branch_name )

同步到远程仓最新的提交

  • 参数
    branch_name分支名称，默认为当前分支
    返回
    命令输出结果 @raises subprocess.CalledProcessError: 命令执行失败时抛出
函数调用图:
该类的文档由以下文件生成:
制作者 doxygen 1.15.0