From 990236d18891a7976a2be9db8611a5e58dd956e5 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Sun, 26 Jul 2015 11:08:12 -0400 Subject: [PATCH 1/7] fix for #29 which does not trigger flake8 for removed files that is accomplished by using --diff-filter parameter in git diff (taken from http://stackoverflow.com/questions/6879501/filter-git-diff-by-type-of-change) also this commit changes the log level from error to info when particular VCS is not found --- flake8diff/flake8.py | 2 +- flake8diff/vcs/git.py | 3 ++- flake8diff/vcs/hg.py | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/flake8diff/flake8.py b/flake8diff/flake8.py index be436b2..7d5a4f8 100644 --- a/flake8diff/flake8.py +++ b/flake8diff/flake8.py @@ -129,7 +129,7 @@ def get_vcs(self): try: vcs = vcs(self.commits, self.options) except VCSNotInstalledError: - logger.error('Seems like {0} is not installed'.format(vcs.name)) + logger.info('Seems like {0} is not installed'.format(vcs.name)) else: if vcs.is_used() and vcs.check(): return vcs diff --git a/flake8diff/vcs/git.py b/flake8diff/vcs/git.py index a3ec5aa..db3ff4a 100644 --- a/flake8diff/vcs/git.py +++ b/flake8diff/vcs/git.py @@ -20,7 +20,7 @@ def get_vcs(self): """ Get git binary executable path """ - return _execute('which git', strict=True).strip() + return _execute('which git', strict=True, log_errors=False).strip() def is_used(self): """ @@ -64,6 +64,7 @@ def changed_files(self): self.vcs, "diff", "--name-only", + "--diff-filter=ACMRTUXB", ] + self.commits) return filter(self.filter_file, diff --git a/flake8diff/vcs/hg.py b/flake8diff/vcs/hg.py index b7b04d8..180071f 100644 --- a/flake8diff/vcs/hg.py +++ b/flake8diff/vcs/hg.py @@ -20,7 +20,7 @@ def get_vcs(self): """ Get git binary executable path """ - vcs = _execute('which hg', strict=True).strip() + vcs = _execute('which hg', strict=True, log_errors=False).strip() return vcs def is_used(self): From fd6a236bc65da3226ecee6e5858d7eca9fd0fca3 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Sun, 26 Jul 2015 11:34:07 -0400 Subject: [PATCH 2/7] fixed flake8 violations that seemed appropriate considering package name --- docs/conf.py | 114 +++++++++++++++++++------------------- flake8diff/__init__.py | 6 +- flake8diff/test_flake8.py | 2 +- flake8diff/test_utils.py | 3 +- setup.py | 34 ++++++------ 5 files changed, 83 insertions(+), 76 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 06100d8..c096a61 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -46,16 +46,16 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'flake8-diff' -copyright = u'2014, Dealertrack Technologies' +project = 'flake8-diff' +copyright = '2014, Dealertrack Technologies' -# The version info for the project you're documenting, acts as replacement for +# The version info for the project yo're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. import flake8diff @@ -67,13 +67,13 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -81,27 +81,27 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- @@ -113,26 +113,26 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -142,48 +142,48 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'flake8-diffdoc' @@ -192,43 +192,43 @@ # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'flake8-diff.tex', u'flake8-diff Documentation', - u'Dealertrack Technologies', 'manual'), + ('index', 'flake8-diff.tex', 'flake8-diff Documentation', + 'Dealertrack Technologies', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -236,12 +236,12 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'flake8-diff', u'flake8-diff Documentation', - [u'Dealertrack Technologies'], 1) + ('index', 'flake8-diff', 'flake8-diff Documentation', + ['Dealertrack Technologies'], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -250,19 +250,19 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'flake8-diff', u'flake8-diff Documentation', - u'Dealertrack Technologies', 'flake8-diff', 'One line description of project.', - 'Miscellaneous'), + ('index', 'flake8-diff', 'flake8-diff Documentation', + 'Dealertrack Technologies', 'flake8-diff', + 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/flake8diff/__init__.py b/flake8diff/__init__.py index e36c8d7..449b62a 100644 --- a/flake8diff/__init__.py +++ b/flake8diff/__init__.py @@ -1,3 +1,7 @@ __version__ = '0.2.0' +__description__ = ( + 'Run flake8 across a set of changed files and filter out ' + 'violations occurring only on the lines that were changed.' +) -__all__ = ['__version__'] +__all__ = ['__version__', '__description__'] diff --git a/flake8diff/test_flake8.py b/flake8diff/test_flake8.py index f7f2bf3..bbabb95 100644 --- a/flake8diff/test_flake8.py +++ b/flake8diff/test_flake8.py @@ -5,4 +5,4 @@ class Flake8DiffTestCase(TestCase): def test_flake8diff(self): - f8d = flake8.Flake8Diff("", {}) + flake8.Flake8Diff("", {}) diff --git a/flake8diff/test_utils.py b/flake8diff/test_utils.py index 17e27d0..274f4ce 100644 --- a/flake8diff/test_utils.py +++ b/flake8diff/test_utils.py @@ -13,7 +13,8 @@ def test_execute_success(self): self.assertTrue(pwd is not "") self.assertTrue(isinstance(pwd, six.string_types)) - @pytest.mark.skipif(sys.version_info < (2, 7), reason="Python >=2.7 needed") + @pytest.mark.skipif(sys.version_info < (2, 7), + reason="Python >=2.7 needed") def test_execute_failure(self): with self.assertRaises(CalledProcessError): utils._execute("doesnotexist", strict=True) diff --git a/setup.py b/setup.py index 76bb6c5..dfd1eea 100644 --- a/setup.py +++ b/setup.py @@ -3,29 +3,31 @@ setup( - name = "flake8-diff", - version = flake8diff.__version__, - url = "http://dealertrack.github.io", - author = "Dealertrack Technologies", - author_email = "gregory.armer@dealertrack.com", - description = ("Run flake8 across a set of changed files and filter out " - "violations occurring only on the lines that were changed."), - long_description = '\n' + open('README.rst').read(), - download_url = 'https://github.com/dealertrack/flake8-diff/releases/tag/v' + flake8diff.__version__, - include_package_data = True, - packages = find_packages(), - package_data = {'flake8-diff': [ 'README.rst' ] }, + name="flake8-diff", + version=flake8diff.__version__, + url="http://dealertrack.github.io", + author="Dealertrack Technologies", + author_email="gregory.armer@dealertrack.com", + description=flake8diff.__description__, + long_description='\n' + open('README.rst').decode('utf-8').read(), + download_url=( + 'https://github.com/dealertrack/flake8-diff/releases/tag/v' + + flake8diff.__version__ + ), + include_package_data=True, + packages=find_packages(), + package_data={'flake8-diff': ['README.rst']}, zip_safe=False, - install_requires = [ + install_requires=[ 'flake8', 'argparse', 'blessings', 'six', ], - entry_points = { + entry_points={ 'console_scripts': [ - 'flake8-diff = flake8diff.main:main' + 'flake8-diff=flake8diff.main:main' ] }, - dependency_links = [] + dependency_links=[] ) From c4bb91fc98faa4894b20334b8b895da678abd554 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Sun, 26 Jul 2015 11:44:24 -0400 Subject: [PATCH 3/7] added --version parameter to flake8-diff script --- flake8diff/main.py | 24 ++++++++++++++++++++++++ setup.py | 7 ++++++- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/flake8diff/main.py b/flake8diff/main.py index e6e37c8..9826f84 100644 --- a/flake8diff/main.py +++ b/flake8diff/main.py @@ -22,6 +22,7 @@ import six import sys +from . import __description__, __version__ from .flake8 import COLORS, STRICT_MODES, Flake8Diff from .vcs import SUPPORTED_VCS @@ -114,10 +115,33 @@ 'Can be any of "{0}"' ''.format(', '.join(STRICT_MODES.keys())), ) +parser.add_argument( + '--version', + action='store_true', + default=False, + help='Show the version number of flake8-diff' +) + + +def version(): + msg = ( + 'flake8-diff\n' + '===========\n' + '{}\n\n' + 'version: {}\n' + 'python: {}\n' + 'source: https://github.com/dealertrack/flake8-diff' + ) + print(msg.format(__description__, __version__, sys.executable)) + sys.exit(0) def main(): args = parser.parse_args() + + if args.version: + return version() + if len(args.commit) > 2: parser.error('At most 2 commits can be provided.') diff --git a/setup.py b/setup.py index dfd1eea..6a56ce3 100644 --- a/setup.py +++ b/setup.py @@ -2,6 +2,11 @@ import flake8diff +def read(path): + with open(path, 'rb') as fid: + return fid.read().decode('utf-8') + + setup( name="flake8-diff", version=flake8diff.__version__, @@ -9,7 +14,7 @@ author="Dealertrack Technologies", author_email="gregory.armer@dealertrack.com", description=flake8diff.__description__, - long_description='\n' + open('README.rst').decode('utf-8').read(), + long_description='\n' + read('README.rst'), download_url=( 'https://github.com/dealertrack/flake8-diff/releases/tag/v' + flake8diff.__version__ From e5aa3714371c75e84324f049c281a9bf041e0e37 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Sun, 26 Jul 2015 11:47:04 -0400 Subject: [PATCH 4/7] fixed typo --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c096a61..572e94c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,7 +55,7 @@ project = 'flake8-diff' copyright = '2014, Dealertrack Technologies' -# The version info for the project yo're documenting, acts as replacement for +# The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. import flake8diff From 8f79de2c51b5189f1086ee835513c7e1c2dd5aee Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Sun, 26 Jul 2015 11:48:42 -0400 Subject: [PATCH 5/7] reusing short description in flake8-script script parser --- flake8diff/main.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/flake8diff/main.py b/flake8diff/main.py index 9826f84..15ad2b8 100644 --- a/flake8diff/main.py +++ b/flake8diff/main.py @@ -39,9 +39,7 @@ parser = argparse.ArgumentParser( - description='This script runs flake8 across a set of changed files ' - 'and filters out violations occurring only on the lines ' - 'that were changed.', + description=__description__, ) parser.add_argument( From 0c8af87c30e9df2591e92db75250f0bcd337a4a4 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Wed, 29 Jul 2015 09:05:53 -0400 Subject: [PATCH 6/7] removed flake8 description from --version --- flake8diff/main.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/flake8diff/main.py b/flake8diff/main.py index 15ad2b8..eb804b0 100644 --- a/flake8diff/main.py +++ b/flake8diff/main.py @@ -19,6 +19,7 @@ import logging import operator import os +import platform import six import sys @@ -123,14 +124,12 @@ def version(): msg = ( - 'flake8-diff\n' - '===========\n' - '{}\n\n' 'version: {}\n' 'python: {}\n' + 'system: {}\n' 'source: https://github.com/dealertrack/flake8-diff' ) - print(msg.format(__description__, __version__, sys.executable)) + print(msg.format(__version__, sys.executable, platform.system())) sys.exit(0) From bec04390ce9263fc7957ccb7fcf39d582fa8d4ad Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Mon, 3 Aug 2015 12:21:21 -0400 Subject: [PATCH 7/7] bumped version to 0.1.2 which addresses #29 --- flake8diff/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flake8diff/__init__.py b/flake8diff/__init__.py index 49d9ace..0495f87 100644 --- a/flake8diff/__init__.py +++ b/flake8diff/__init__.py @@ -1,4 +1,4 @@ -__version__ = '0.2.1' +__version__ = '0.2.2' __description__ = ( 'Run flake8 across a set of changed files and filter out ' 'violations occurring only on the lines that were changed.'