format_changelog() - Code Metrics - Inspection of "PR: Feature/templates" - spyder-ide/loghub - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

by Gonzalo

created 2016-12-05 20:41 UTC

format_changelog() D

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	12
Bugs	2	Features	0

Metric	Value
cc	8
c	12
b	2
f	0
dl	0
loc	49
rs	4.7619

# -*- coding: utf-8 -*-
# -----------------------------------------------------------------------------
# Copyright (c) The Spyder Development Team
#
# Licensed under the terms of the MIT License
# (See LICENSE.txt for details)
# -----------------------------------------------------------------------------
"""Build a list of issues and pull requests per Github milestone."""

from __future__ import print_function

# Standard library imports
import argparse
import datetime
import getpass
import re
import sys
import time

# Third party imports
from jinja2 import Template

# Local imports
from loghub.external.github import GitHub
from loghub.templates import CHANGELOG_TEMPLATE_PATH, RELEASE_TEMPLATE_PATH

PY2 = sys.version[0] == '2'


def main():
    """Main script."""
    # Cli options
    parser = argparse.ArgumentParser(
        description='Script to print the list of issues and pull requests '
        'closed in a given milestone')
    parser.add_argument(
        'repository',
        help="Repository name to generate the Changelog for, in the form "
        "user/repo or org/repo (e.g. spyder-ide/spyder)")
    parser.add_argument(
        '-m',
        '--milestone',
        action="store",
        dest="milestone",
        default='',
        help="Github milestone to get issues and pull requests for")
    parser.add_argument(
        '-il',
        '--issue-label-regex',
        action="store",
        dest="issue_label_regex",
        default='',
        help="Label issue filter using a regular expression filter")
    parser.add_argument(
        '-pl',
        '--pr-label-regex',
        action="store",
        dest="pr_label_regex",
        default='',
        help="Label pull requets filter using a regular expression filter")
    parser.add_argument(
        '-st',
        '--since-tag',
        action="store",
        dest="since_tag",
        default='',
        help="Github issues and pull requests since tag")
    parser.add_argument(
        '-ut',
        '--until-tag',
        action="store",
        dest="until_tag",
        default='',
        help="Github issues and pull requests until tag")
    parser.add_argument(
        '-f',
        '--format',
        action="store",
        dest="output_format",
        default='changelog',
        help="Format for print, either 'changelog' (for "
        "Changelog.md file) or 'release' (for the Github "
        "Releases page). Default is 'changelog'. The "
        "'release' option doesn't generate Markdown "
        "hyperlinks.")
    parser.add_argument(
        '--template',
        action="store",
        dest="template",
        default='',
        help="Use a custom Jinja2 template file ")
    parser.add_argument(
        '-u',
        '--user',
        action="store",
        dest="user",
        default='',
        help="Github user name")
    parser.add_argument(
        '-p',
        '--password',
        action="store",
        dest="password",
        default='',
        help="Github user password")
    parser.add_argument(
        '-t',
        '--token',
        action="store",
        dest="token",
        default='',
        help="Github access token")
    options = parser.parse_args()

    username = options.user
    password = options.password
    milestone = options.milestone

    if username and not password:
        password = getpass.getpass()

    # Check if repo given
    if not options.repository:
        print('Please define a repository name to this script. See its help')
        sys.exit(1)

    # Check if milestone or tag given
    if not milestone and not options.since_tag:
        print('\nQuerying all issues\n')
    elif milestone:
        print('\nQuerying issues for milestone {0}\n'.format(milestone))

    create_changelog(
        repo=options.repository,
        username=username,
        password=password,
        token=options.token,
        milestone=milestone,
        since_tag=options.since_tag,
        until_tag=options.until_tag,
        output_format=options.output_format,
        issue_label_regex=options.issue_label_regex,
        pr_label_regex=options.pr_label_regex,
        template_file=options.template)


def create_changelog(repo, username, password, token, milestone, since_tag,
                     until_tag, output_format, issue_label_regex,
                     pr_label_regex, template_file):
    """Create changelog data."""
    # Instantiate Github API
    gh = GitHubRepo(
        username=username,
        password=password,
        token=token,
        repo=repo, )

    version = until_tag or None
    milestone_number = None
    closed_at = None
    since = None
    until = None

    # Set milestone or from tag
    if milestone and not since_tag:
        milestone_data = gh.milestone(milestone)
        milestone_number = milestone_data['number']
        closed_at = milestone_data['closed_at']
        version = milestone.replace('v', '')
    elif not milestone and since_tag:
        since = gh.tag(since_tag)['tagger']['date']
        if until_tag:
            until = gh.tag(until_tag)['tagger']['date']
            closed_at = until

    # This returns issues and pull requests
    issues = gh.issues(
        milestone=milestone_number, state='closed', since=since, until=until)

    # Filter by regex if available
    filtered_issues, filtered_prs = [], []
    issue_pattern = re.compile(issue_label_regex)
    pr_pattern = re.compile(pr_label_regex)
    for issue in issues:
        is_pr = bool(issue.get('pull_request'))
        is_issue = not is_pr
        labels = ' '.join(issue.get('_label_names'))

        if is_issue and issue_label_regex:
            issue_valid = bool(issue_pattern.search(labels))
            if issue_valid:
                filtered_issues.append(issue)
        elif is_pr and pr_label_regex:
            pr_valid = bool(pr_pattern.search(labels))
            if pr_valid:
                filtered_prs.append(issue)
        elif is_issue and not issue_label_regex:
            filtered_issues.append(issue)
        elif is_pr and not pr_label_regex:
            filtered_prs.append(issue)

    format_changelog(
        repo,
        filtered_issues,
        filtered_prs,
        version,
        closed_at=closed_at,
        output_format=output_format,
        template_file=template_file)


def format_changelog(repo,
                     issues,
                     prs,
                     version,
                     closed_at=None,
                     output_format='changelog',
                     output_file='CHANGELOG.temp',
                     template_file=None):
    """Create changelog data."""
    # Header
    if version and version[0] == 'v':
        version = version.replace('v', '')
    else:
        version = '<RELEASE_VERSION>'

    if closed_at:
        close_date = closed_at.split('T')[0]
    else:
        close_date = time.strftime("%Y/%m/%d")

    # Load template
    if template_file:
        filepath = template_file
    else:
        if output_format == 'changelog':
            filepath = CHANGELOG_TEMPLATE_PATH
        else:
            filepath = RELEASE_TEMPLATE_PATH

    with open(filepath) as f:
        data = f.read()

    repo_owner, repo_name = repo.split('/')
    template = Template(data)
    rendered = template.render(
        issues=issues,
        pull_requests=prs,
        version=version,
        close_date=close_date,
        repo_full_name=repo,
        repo_owner=repo_owner,
        repo_name=repo_name,)

    print('\n')
    print(rendered)
    print('\n')

    with open(output_file, 'w') as f:
        f.write(rendered)


class GitHubRepo(object):
    """Github repository wrapper."""

    def __init__(self, username=None, password=None, token=None, repo=None):
        """Github repository wrapper."""
        self.gh = GitHub(
            username=username,
            password=password,
            access_token=token, )
        repo_organization, repo_name = repo.split('/')
        self.repo = self.gh.repos(repo_organization)(repo_name)

    def tags(self):
        """Return all tags."""
        return self.repo('git')('refs')('tags').get()

    def tag(self, tag_name):
        """Get tag information."""
        refs = self.repo('git')('refs')('tags').get()
        sha = -1
        for ref in refs:
            ref_name = 'refs/tags/{tag}'.format(tag=tag_name)
            if 'object' in ref and ref['ref'] == ref_name:
                sha = ref['object']['sha']
                break

        if sha == -1:
            print("You didn't pass a valid tag name!")
            sys.exit(1)

        return self.repo('git')('tags')(sha).get()

    def milestones(self):
        """Return all milestones."""
        return self.repo.milestones.get(state='all')

    def milestone(self, milestone_title):
        """Return milestone with given title."""
        milestones = self.milestones()
        milestone_number = -1
        for milestone in milestones:
            if milestone['title'] == milestone_title:
                milestone_number = milestone['number']
                break

        if milestone_number == -1:
            print("You didn't pass a valid milestone name!")
            sys.exit(1)

        return milestone

    def issues(self,
               milestone=None,
               state=None,
               assignee=None,
               creator=None,
               mentioned=None,
               labels=None,
               sort=None,
               direction=None,
               since=None,
               until=None):
        """Return Issues and Pull Requests."""
        page = 1
        issues = []
        while True:
            result = self.repo.issues.get(page=page,
                                          per_page=100,
                                          milestone=milestone,
                                          state=state,
                                          assignee=assignee,
                                          creator=creator,
                                          mentioned=mentioned,
                                          labels=labels,
                                          sort=sort,
                                          firection=direction,
                                          since=since)
            if len(result) > 0:
                issues += result
                page = page + 1
            else:
                break

        # If since was provided, filter the issue
        if since:
            since_date = self.str_to_date(since)
            for issue in issues[:]:
                close_date = self.str_to_date(issue['closed_at'])
                if close_date < since_date:
                    issues.remove(issue)

        # If until was provided, filter the issue
        if until:
            until_date = self.str_to_date(until)
            for issue in issues[:]:
                close_date = self.str_to_date(issue['closed_at'])
                if close_date > until_date:
                    issues.remove(issue)

        # If it is a pr check if it is merged or closed, removed closed ones
        for issue in issues[:]:
            pr = issue.get('pull_request', '')

            # Add label names inside additional key
            issue['_label_names'] = [l['name'] for l in issue.get('labels')]

            if pr:
                number = issue['number']
                if not self.is_merged(number):
                    issues.remove(issue)

        return issues

    def is_merged(self, pr):
        """
        Return wether a PR was merged, or if it was closed and discarded.

        https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
        """
        merged = True
        try:
            self.repo('pulls')(str(pr))('merge').get()
        except Exception:
            merged = False
        return merged

    @staticmethod
    def str_to_date(string):
        """Convert ISO date string to datetime object."""
        parts = string.split('T')
        date_parts = parts[0]
        time_parts = parts[1][:-1]
        year, month, day = [int(i) for i in date_parts.split('-')]
        hour, minutes, seconds = [int(i) for i in time_parts.split(':')]
        return datetime.datetime(year, month, day, hour, minutes, seconds)


if __name__ == '__main__':  # yapf: disable
    main()


1			# -- coding: utf-8 --
2			# -----------------------------------------------------------------------------
3			# Copyright (c) The Spyder Development Team
4			#
5			# Licensed under the terms of the MIT License
6			# (See LICENSE.txt for details)
7			# -----------------------------------------------------------------------------
8			"""Build a list of issues and pull requests per Github milestone."""
9
10			from __future__ import print_function
11
12			# Standard library imports
13			import argparse
14			import datetime
15			import getpass
16			import re
17			import sys
18			import time
19
20			# Third party imports
21			from jinja2 import Template
22
23			# Local imports
24			from loghub.external.github import GitHub
25			from loghub.templates import CHANGELOG_TEMPLATE_PATH, RELEASE_TEMPLATE_PATH
26
27			PY2 = sys.version[0] == '2'
28
29
30			def main():
31			"""Main script."""
32			# Cli options
33			parser = argparse.ArgumentParser(
34			description='Script to print the list of issues and pull requests '
35			'closed in a given milestone')
36			parser.add_argument(
37			'repository',
38			help="Repository name to generate the Changelog for, in the form "
39			"user/repo or org/repo (e.g. spyder-ide/spyder)")
40			parser.add_argument(
41			'-m',
42			'--milestone',
43			action="store",
44			dest="milestone",
45			default='',
46			help="Github milestone to get issues and pull requests for")
47			parser.add_argument(
48			'-il',
49			'--issue-label-regex',
50			action="store",
51			dest="issue_label_regex",
52			default='',
53			help="Label issue filter using a regular expression filter")
54			parser.add_argument(
55			'-pl',
56			'--pr-label-regex',
57			action="store",
58			dest="pr_label_regex",
59			default='',
60			help="Label pull requets filter using a regular expression filter")
61			parser.add_argument(
62			'-st',
63			'--since-tag',
64			action="store",
65			dest="since_tag",
66			default='',
67			help="Github issues and pull requests since tag")
68			parser.add_argument(
69			'-ut',
70			'--until-tag',
71			action="store",
72			dest="until_tag",
73			default='',
74			help="Github issues and pull requests until tag")
75			parser.add_argument(
76			'-f',
77			'--format',
78			action="store",
79			dest="output_format",
80			default='changelog',
81			help="Format for print, either 'changelog' (for "
82			"Changelog.md file) or 'release' (for the Github "
83			"Releases page). Default is 'changelog'. The "
84			"'release' option doesn't generate Markdown "
85			"hyperlinks.")
86			parser.add_argument(
87			'--template',
88			action="store",
89			dest="template",
90			default='',
91			help="Use a custom Jinja2 template file ")
92			parser.add_argument(
93			'-u',
94			'--user',
95			action="store",
96			dest="user",
97			default='',
98			help="Github user name")
99			parser.add_argument(
100			'-p',
101			'--password',
102			action="store",
103			dest="password",
104			default='',
105			help="Github user password")
106			parser.add_argument(
107			'-t',
108			'--token',
109			action="store",
110			dest="token",
111			default='',
112			help="Github access token")
113			options = parser.parse_args()
114
115			username = options.user
116			password = options.password
117			milestone = options.milestone
118
119			if username and not password:
120			password = getpass.getpass()
121
122			# Check if repo given
123			if not options.repository:
124			print('Please define a repository name to this script. See its help')
125			sys.exit(1)
126
127			# Check if milestone or tag given
128			if not milestone and not options.since_tag:
129			print('\nQuerying all issues\n')
130			elif milestone:
131			print('\nQuerying issues for milestone {0}\n'.format(milestone))
132
133			create_changelog(
134			repo=options.repository,
135			username=username,
136			password=password,
137			token=options.token,
138			milestone=milestone,
139			since_tag=options.since_tag,
140			until_tag=options.until_tag,
141			output_format=options.output_format,
142			issue_label_regex=options.issue_label_regex,
143			pr_label_regex=options.pr_label_regex,
144			template_file=options.template)
145
146
147			def create_changelog(repo, username, password, token, milestone, since_tag,
148			until_tag, output_format, issue_label_regex,
149			pr_label_regex, template_file):
150			"""Create changelog data."""
151			# Instantiate Github API
152			gh = GitHubRepo(
153			username=username,
154			password=password,
155			token=token,
156			repo=repo, )
157
158			version = until_tag or None
159			milestone_number = None
160			closed_at = None
161			since = None
162			until = None
163
164			# Set milestone or from tag
165			if milestone and not since_tag:
166			milestone_data = gh.milestone(milestone)
167			milestone_number = milestone_data['number']
168			closed_at = milestone_data['closed_at']
169			version = milestone.replace('v', '')
170			elif not milestone and since_tag:
171			since = gh.tag(since_tag)['tagger']['date']
172			if until_tag:
173			until = gh.tag(until_tag)['tagger']['date']
174			closed_at = until
175
176			# This returns issues and pull requests
177			issues = gh.issues(
178			milestone=milestone_number, state='closed', since=since, until=until)
179
180			# Filter by regex if available
181			filtered_issues, filtered_prs = [], []
182			issue_pattern = re.compile(issue_label_regex)
183			pr_pattern = re.compile(pr_label_regex)
184			for issue in issues:
185			is_pr = bool(issue.get('pull_request'))
186			is_issue = not is_pr
187			labels = ' '.join(issue.get('_label_names'))
188
189			if is_issue and issue_label_regex:
190			issue_valid = bool(issue_pattern.search(labels))
191			if issue_valid:
192			filtered_issues.append(issue)
193			elif is_pr and pr_label_regex:
194			pr_valid = bool(pr_pattern.search(labels))
195			if pr_valid:
196			filtered_prs.append(issue)
197			elif is_issue and not issue_label_regex:
198			filtered_issues.append(issue)
199			elif is_pr and not pr_label_regex:
200			filtered_prs.append(issue)
201
202			format_changelog(
203			repo,
204			filtered_issues,
205			filtered_prs,
206			version,
207			closed_at=closed_at,
208			output_format=output_format,
209			template_file=template_file)
210
211
212			def format_changelog(repo,
213			issues,
214			prs,
215			version,
216			closed_at=None,
217			output_format='changelog',
218			output_file='CHANGELOG.temp',
219			template_file=None):
220			"""Create changelog data."""
221			# Header
222			if version and version[0] == 'v':
223			version = version.replace('v', '')
224			else:
225			version = '<RELEASE_VERSION>'
226
227			if closed_at:
228			close_date = closed_at.split('T')[0]
229			else:
230			close_date = time.strftime("%Y/%m/%d")
231
232			# Load template
233			if template_file:
234			filepath = template_file
235			else:
236			if output_format == 'changelog':
237			filepath = CHANGELOG_TEMPLATE_PATH
238			else:
239			filepath = RELEASE_TEMPLATE_PATH
240
241			with open(filepath) as f:
242			data = f.read()
243
244			repo_owner, repo_name = repo.split('/')
245			template = Template(data)
246			rendered = template.render(
247			issues=issues,
248			pull_requests=prs,
249			version=version,
250			close_date=close_date,
251			repo_full_name=repo,
252			repo_owner=repo_owner,
253			repo_name=repo_name,)
254
255			print('\n')
256			print(rendered)
257			print('\n')
258
259			with open(output_file, 'w') as f:
260			f.write(rendered)
261
262
263			class GitHubRepo(object):
264			"""Github repository wrapper."""
265
266			def __init__(self, username=None, password=None, token=None, repo=None):
267			"""Github repository wrapper."""
268			self.gh = GitHub(
269			username=username,
270			password=password,
271			access_token=token, )
272			repo_organization, repo_name = repo.split('/')
273			self.repo = self.gh.repos(repo_organization)(repo_name)
274
275			def tags(self):
276			"""Return all tags."""
277			return self.repo('git')('refs')('tags').get()
278
279			def tag(self, tag_name):
280			"""Get tag information."""
281			refs = self.repo('git')('refs')('tags').get()
282			sha = -1
283			for ref in refs:
284			ref_name = 'refs/tags/{tag}'.format(tag=tag_name)
285			if 'object' in ref and ref['ref'] == ref_name:
286			sha = ref['object']['sha']
287			break
288
289			if sha == -1:
290			print("You didn't pass a valid tag name!")
291			sys.exit(1)
292
293			return self.repo('git')('tags')(sha).get()
294
295			def milestones(self):
296			"""Return all milestones."""
297			return self.repo.milestones.get(state='all')
298
299			def milestone(self, milestone_title):
300			"""Return milestone with given title."""
301			milestones = self.milestones()
302			milestone_number = -1
303			for milestone in milestones:
304			if milestone['title'] == milestone_title:
305			milestone_number = milestone['number']
306			break
307
308			if milestone_number == -1:
309			print("You didn't pass a valid milestone name!")
310			sys.exit(1)
311
312			return milestone
313
314			def issues(self,
315			milestone=None,
316			state=None,
317			assignee=None,
318			creator=None,
319			mentioned=None,
320			labels=None,
321			sort=None,
322			direction=None,
323			since=None,
324			until=None):
325			"""Return Issues and Pull Requests."""
326			page = 1
327			issues = []
328			while True:
329			result = self.repo.issues.get(page=page,
330			per_page=100,
331			milestone=milestone,
332			state=state,
333			assignee=assignee,
334			creator=creator,
335			mentioned=mentioned,
336			labels=labels,
337			sort=sort,
338			firection=direction,
339			since=since)
340			if len(result) > 0:
341			issues += result
342			page = page + 1
343			else:
344			break
345
346			# If since was provided, filter the issue
347			if since:
348			since_date = self.str_to_date(since)
349			for issue in issues[:]:
350			close_date = self.str_to_date(issue['closed_at'])
351			if close_date < since_date:
352			issues.remove(issue)
353
354			# If until was provided, filter the issue
355			if until:
356			until_date = self.str_to_date(until)
357			for issue in issues[:]:
358			close_date = self.str_to_date(issue['closed_at'])
359			if close_date > until_date:
360			issues.remove(issue)
361
362			# If it is a pr check if it is merged or closed, removed closed ones
363			for issue in issues[:]:
364			pr = issue.get('pull_request', '')
365
366			# Add label names inside additional key
367			issue['_label_names'] = [l['name'] for l in issue.get('labels')]
368
369			if pr:
370			number = issue['number']
371			if not self.is_merged(number):
372			issues.remove(issue)
373
374			return issues
375
376			def is_merged(self, pr):
377			"""
378			Return wether a PR was merged, or if it was closed and discarded.
379
380			https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
381			"""
382			merged = True
383			try:
384			self.repo('pulls')(str(pr))('merge').get()
385			except Exception:
386			merged = False
387			return merged
388
389			@staticmethod
390			def str_to_date(string):
391			"""Convert ISO date string to datetime object."""
392			parts = string.split('T')
393			date_parts = parts[0]
394			time_parts = parts[1][:-1]
395			year, month, day = [int(i) for i in date_parts.split('-')]
396			hour, minutes, seconds = [int(i) for i in time_parts.split(':')]
397			return datetime.datetime(year, month, day, hour, minutes, seconds)
398
399
400			if __name__ == '__main__': # yapf: disable
401			main()
402

spyder-ide / loghub

Pull Request — master (#20)

format_changelog() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like