Skip to content

Fix pep8 violations #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
praveenkumar wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix pep8 violations #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions scripts/git2changelog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,42 @@

# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.

# File Name : git2changelog
# Creation Date : 06-07-2014
# Created By : Jamie Duncan
# Last Modified : Sun 08 Jun 2014 05:58:37 AM EDT
# Purpose : executable for converting a git log stanza into a usable spec file changelog
# Purpose : executable for converting a git log stanza into a usable spec
# file changelog

from optparse import OptionParser
from git2changelog import CLData
import os


def main():

parser = OptionParser(usage="%prog -b [-e -r -s]" )
parser.add_option("-b", "--begin_tag", dest="t_start", help="Tag to start data collecton from. required.", metavar="BEGIN_TAG")
parser.add_option("-e", "--end_tag", default='HEAD', dest="t_end", help="Tag to end the data collection. defaults to HEAD.", metavar="END_TAG")
parser.add_option("-f", "--log_format", default="rpm", dest="log_format", help="Format to Generate Changelog. defaults to rpm")
parser.add_option("-s", "--search", default=None, dest="search_term", help="Commit Search Criteria. optional.", metavar="SEARCH_TERM")
parser.add_option("-n", "--name", default=None, dest="tag_name", help="New Tag Name for untagged commits. optional.", metavar="TAG_NAME")
parser.add_option("-r", "--repo", default=None, dest="repo", help="Repository to Scan. defaults to current directory.", metavar="REPO")
parser = OptionParser(usage="%prog -b [-e -r -s]")
parser.add_option("-b", "--begin_tag", dest="t_start",
help="Tag to start data collecton from. required.",
metavar="BEGIN_TAG")
parser.add_option("-e", "--end_tag", default='HEAD', dest="t_end",
help="Tag to end the data collection. defaults to HEAD.",
metavar="END_TAG")
parser.add_option("-f", "--log_format", default="rpm",
dest="log_format",
help="Format to Generate Changelog. defaults to rpm")
parser.add_option("-s", "--search", default=None, dest="search_term",
help="Commit Search Criteria. optional.",
metavar="SEARCH_TERM")
parser.add_option("-n", "--name", default=None, dest="tag_name",
help="New Tag Name for untagged commits. optional.",
metavar="TAG_NAME")
parser.add_option("-r", "--repo", default=None, dest="repo",
help="Repository to Scan. defaults to current directory.",
metavar="REPO")

(options, args) = parser.parse_args()
if options.repo is None:
Expand Down
89 changes: 60 additions & 29 deletions src/git2changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,49 +12,62 @@

# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.

# File Name : changelogup.py
# Creation Date : 06-07-2014
# Created By : Jamie Duncan
# Last Modified : Mon 09 Jun 2014 01:28:56 PM EDT
# Purpose : for converting a git log stanza into a usable spec file changelog

# Modified By : Praveen Kumar
# Last Modified : Mon 13 Apr 2015 02:11:56 AM EDT
# Purpose : fix pep8 issue

import subprocess
import csv
from dateutil.parser import parse
from optparse import OptionParser
import os

#################################
#
#
# Python Module Requirement
# python-dateutil
#
##################################
#


class InvalidRepositoryError(Exception):
pass


class NoGitTagsError(Exception):
pass


class CLData:

def __init__(self, options):

self.t_start = options.t_start #start tag
self.t_end = options.t_end #end tag, defaults to 'HEAD'
self.t_start = options.t_start # start tag
self.t_end = options.t_end # end tag, defaults to 'HEAD'
self.search_terms = False

# option search term to limit commit output,
# is passed as a comma-delimited list
if options.search_term:
self.search_terms = options.search_term.split(',') #option search term to limit commit output, is passed as a comma-delimited list
self.repo = options.repo #git repo directory to run against - defaults to curr working directory
self.search_terms = options.search_term.split(
','
)
# git repo directory to run against, defaults to curr working directory
self.repo = options.repo
self.tag_name = False
if options.tag_name:
self.tag_name = options.tag_name

#log_format - opens up the ability to have other log formats generated
#current supported formats
# log_format - opens up the ability to have other log formats generated
# current supported formats
# rpm - the default. and RPM spec file changelog

self.log_format = options.log_format.lower()
Expand All @@ -64,20 +77,28 @@ def __init__(self, options):

def _checkRepository(self):
if not os.path.isdir(os.path.join(self.repo, '.git')):
raise InvalidRepositoryError("%s Does Not Appear to be a Valid git Repository" % self.repo)
raise InvalidRepositoryError(
"%s Does Not Appear to be a Valid git Repository" % self.repo)

def _checkTags(self):
#the logic here: if you don't have any tagged releases you should not be creating a spec file.
# the logic here: if you don't have any tagged releases you should not
# be creating a spec file.

git_command = 'git tag'
cl_raw = subprocess.Popen(git_command,shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, cwd=self.repo)
cl_raw = subprocess.Popen(git_command,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
cwd=self.repo)

tags = cl_raw.stdout.readlines()
if len(tags) == 0:
raise NoGitTagsError("The Repository Does Not Seem To Have any Tags Created. Please Verify.")
raise NoGitTagsError(
"The Repository Does Not Seem To Have any Tags"
" Created. Please Verify.")

def _formatDate(self, date):
#returns the date in the proper format for a changelog in a spec file
# returns the date in the proper format for a changelog in a spec file

return parse(date).strftime('%a %b %d %Y')

Expand All @@ -88,7 +109,7 @@ def _formatRelease(self, tag):
new_release = False
if 'HEAD' in tag:
if 'tag' in tag:
tag = "- %s" % tag.split(':')[1].strip(' ()').split(',')[0]
tag = "- %s" % tag.split(':')[1].strip(' ()').split(',')[0]
else:
if self.tag_name:
tag = "- %s" % self.tag_name
Expand All @@ -99,13 +120,20 @@ def _formatRelease(self, tag):
tag = "- %s" % tag.split(':')[1].strip(' ()')
new_release = True

return new_release,tag
return new_release, tag

def _getGitLog(self):
#grabs the raw git log data from the given repo

git_command = 'git --no-pager log %s..%s --pretty --format=\'%%cD,%%cn,%%ce,%%h,"%%s","%%d"\'' % (self.t_start, self.t_end)
cl_raw = subprocess.Popen(git_command,shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, cwd=self.repo)
# grabs the raw git log data from the given repo

git_command = ('git --no-pager log %s..%s --pretty '
'--format=\'%%cD,%%cn,%%ce,%%h,"%%s","%%d"\'') % (
self.t_start, self.t_end
)
cl_raw = subprocess.Popen(git_command,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
cwd=self.repo)

return cl_raw.stdout.readlines()

Expand All @@ -114,23 +142,26 @@ def _generateRPMChangeLog(self, data):
# called if log_format = 'rpm'

for row in data:
r_check,release = self._formatRelease(row[6])
r_check, release = self._formatRelease(row[6])
if r_check:
print "\n* %s %s <%s> %s" % (self._formatDate(row[1]),row[2],row[3],release)
print "\n* %s %s <%s> %s" % (self._formatDate(row[1]), row[2],
row[3], release)
if self.search_terms:
for item in self.search_terms:
if item in row[5]:
print "- %s : Commit %s" % (row[5],row[4])
print "- %s : Commit %s" % (row[5], row[4])
break
else:
print "- %s : Commit %s" % (row[5],row[4])
print "- %s : Commit %s" % (row[5], row[4])
else:
if self.search_terms: #if we want to limit the output to lines with certain strings in the comment
# if we want to limit the output to lines with certain strings
# in the comment
if self.search_terms:
for item in self.search_terms:
if item in row[5]:
print "- %s : Commit %s" % (row[5],row[4])
else: #if we want all of the commits - no search term given
print "- %s : Commit %s" % (row[5],row[4])
print "- %s : Commit %s" % (row[5], row[4])
else: # if we want all of the commits - no search term given
print "- %s : Commit %s" % (row[5], row[4])

def formatChangeLog(self):

Expand Down