构建Python代码审查计划程序：审查跟进

最新推荐文章于 2024-04-07 17:13:42 发布

cunjie3951

最新推荐文章于 2024-04-07 17:13:42 发布

阅读量371

点赞数

文章标签： python java go git django

在本系列的第三部分中，您了解了如何保存代码检查请求信息以进行后续操作。您创建了一个名为read_email的方法，用于从收件箱中获取电子邮件，以检查审阅者是否已响应代码审阅请求。您还在代码检查计划程序代码中实现了错误处理。

在本系列的这一部分中，您将使用保存的代码审阅信息和电子邮件中的信息来检查审阅者是否响应了审阅请求。如果请求未得到答复，您将向审核者发送后续电子邮件。

入门

首先从教程系列的第三部分克隆源代码。

git clone https://github.com/royagasthyan/CodeReviewer-Part3 CodeReviewer

修改config.json文件，使其包含一些相关的电子邮件地址，并保留royagasthyan@gmail.com电子邮件地址。这是因为git具有与此特定电子邮件地址相关的提交，这些提交对于代码按预期执行是必需的。修改schedule.py文件中的SMTP凭据：

FROM_EMAIL      = "your_email_address@gmail.com"
FROM_PWD        = "your_password"

导航到项目目录CodeReviewer并尝试在终端中执行以下命令。

python scheduler.py -n 20 -p "project_x"

它应将代码审阅请求发送给随机开发人员进行审阅，并创建包含审阅信息的reviewer.json文件。

实施跟进请求

让我们从创建一个称为followup_request请求方法开始。在followup_request方法内，读取reviewer.json文件并将内容保留在列表中。代码如下：

with open('reviewer.json','r') as jfile:
    review_info = json.load(jfile)

接下来，使用在上一教程中实现的read_email方法提取电子邮件信息。

email_info = read_email(no_days)

如果审阅者已回复审阅请求，则应该有一封主题相同的电子邮件，并在其前面加上一个Re:标签。因此，遍历审阅信息列表，并将审阅主题与电子邮件主题进行比较，以查看审阅者是否已响应请求。

for review in review_info:
    review_replied = false
    expected_subject = 'RE: ' + review['subject']
    for email in email_info:
        if expected_subject == email['subject']:
            review_replied = True
            print 'Reviewer has responded'
            break;

如上面的代码所示，您遍历了review_info列表，并对照电子邮件主题检查了评论信息主题，以查看评论者是否已回复。

现在，一旦审阅者响应了代码审阅请求，您就无需将特定的审阅信息保留在reviewer.json文件中。因此，创建一个名为Delete_Info的Python方法，以从reviewer.json文件中删除特定的评论信息。这是Delete_Info外观：

def Delete_Info(info, id):
    for i in xrange(len(info)):
        if info[i]['id'] == id:
            info.pop(i)
            break
    return info

如上面的代码所示，您已遍历审阅信息列表并删除了与ID匹配的条目。从文件中删除信息后，返回列表。

当回复特定的评论信息时，您需要调用Delete_Info方法。调用Delete_Info方法时，您需要传递review_info的副本，以便不更改原始信息列表。您需要原始的评论信息列表，以便以后进行比较。因此，导入copy Python模块以创建原始评论信息列表的副本。

from copy import copy

创建一个review_info列表的副本。

review_info_copy = copy(review_info)

从原始列表中删除已回复的审阅信息时，请将副本列表传递给Delete_Info方法。

review_info_copy = Delete_Info(review_info_copy,review['id'])

这是followup_request方法：

def followup_request():
    with open('reviewer.json','r') as jfile:
        review_info = json.load(jfile)
    review_info_copy = copy(review_info)

    email_info = read_email(no_days)

    for review in review_info:
        review_replied = False
        expected_subject = 'Re: ' + review['subject']
        for email in email_info:
            if expected_subject == email['Subject']:
                review_replied = True
                review_info_copy = Delete_Info(review_info_copy,review['id'])
                break;

现在，遍历了review_info列表后，您需要检查reviewer.json文件中是否有任何更改。如果已删除任何现有的审阅信息，则需要适当地更新reviewer.json文件。因此，请检查review_info_copy和review_info是否相同，然后更新reviewer.json文件。

if review_info_copy != review_info:
    with open('reviewer.json','w') as outfile:
        json.dump(review_info_copy,outfile)

这是完整的followup_request方法：

def followup_request():
    with open('reviewer.json','r') as jfile:
        review_info = json.load(jfile)
    review_info_copy = copy(review_info)

    email_info = read_email(no_days)

    for review in review_info:
        review_replied = False
        expected_subject = 'Re: ' + review['subject']
        for email in email_info:
            if expected_subject == email['Subject']:
                review_replied = True
                review_info_copy = Delete_Info(review_info_copy,review['id'])
                break;

    if review_info_copy != review_info:
        with open('reviewer.json','w') as outfile:
            json.dump(review_info_copy,outfile)

调用followup_request方法以跟进已发送的审阅请求。

try:
    commits = process_commits()

    # Added the follow Up Method
    followup_request()

    if len(commits) == 0:
        print 'No commits found '
    else:
        schedule_review_request(commits)

except Exception,e:
    print 'Error occurred. Check log for details.'
    logger.error(str(datetime.datetime.now()) + " - Error occurred : " + str(e) + "\n")
    logger.exception(str(e))

保存以上更改。要测试后续功能，请从项目目录中删除reviewer.json文件。现在运行调度程序，以便将代码审阅请求发送给随机开发人员。检查该信息是否已保存在reviewer.json文件中。

要求特定的开发人员通过回复电子邮件来响应代码审查请求。现在再次运行调度程序，这一次调度程序应该能够找到响应并将其从reviewer.json文件中删除。

发送提醒电子邮件

一旦审阅者对代码审阅请求电子邮件做出响应，则该信息需要从reviewer.json文件中删除，因为您无需进一步跟踪。如果审阅者尚未答复代码审阅请求，则需要发送后续邮件以提醒他或她有关审阅请求的信息。

代码审查计划程序将每天运行。当它运行时，您首先需要检查距开发者响应审阅请求是否已经过了一段时间。在项目配置中，您可以设置一个审查期，在此期间，如果审查者未响应，则计划程序将发送提醒电子邮件。

首先，在项目配置中添加配置。在配置文件中添加一个名为followup_frequency的新配置。

{
    "name": "project_x",
    "git_url": "https://github.com/royagasthyan/project_x",
    "followup_frequency":2,
    "members": [
        "royagasthyan@gmail.com",
    	"samon@gmail.com",
    	"sualonni@gmail.com",
    	"restuni@gmail.com"
    ]
}

因此，当审阅者在followup_frequency天数内未响应时，您将发送一封提醒电子邮件。在读取配置时，将配置读取到全局变量中：

for p in main_config:
    if p['name'] == project:
        project_url = p['git_url']
        project_members = p['members']
        followup_frequency = p['followup_frequency']
    break

在followup_request方法内，当审阅者未对followup_frequency天数的followup_frequency请求进行回复时，发送一封提醒电子邮件。计算自发送评论以来的天数。

review_date = datetime.datetime.strptime(review['sendDate'],'%Y-%m-%d')
today = datetime.datetime.today()
days_since_review = (today - review_date).days

如果天数大于配置中的后续频率日期，请发送提醒电子邮件。

if not review_replied:
    if days_since_review > followup_frequency:
        send_email(review['reviewer'],'Reminder: ' + review['subject'],'\nYou have not responded to the review request\n')

这是完整的followup_request方法：

def followup_request():
    with open('reviewer.json','r') as jfile:
        review_info = json.load(jfile)
    review_info_copy = copy(review_info)

    email_info = read_email(no_days)

    for review in review_info:
        review_date = datetime.datetime.strptime(review['sendDate'],'%Y-%m-%d')
        today = datetime.datetime.today()
        days_since_review = (today - review_date).days
        review_replied = False
        expected_subject = 'Re: ' + review['subject']
        for email in email_info:
            if expected_subject == email['Subject']:
                review_replied = True
                review_info_copy = Delete_Info(review_info_copy,review['id'])
                break;

        if not review_replied:
            if days_since_review > followup_frequency:
                send_email(review['reviewer'],'Reminder: ' + review['subject'],'\nYou have not responded to the review request\n')

    if review_info_copy != review_info:
        with open('reviewer.json','w') as outfile:
            json.dump(review_info_copy,outfile)