Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
112 changes: 56 additions & 56 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -46,14 +46,14 @@
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
# |version| and |release|, also used in various other places throughout the
Expand All @@ -67,41 +67,41 @@

# 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.
exclude_patterns = ['_build']

# 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 ----------------------------------------------
Expand All @@ -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
# "<project> v<release> 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,
Expand All @@ -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 <link> 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'
Expand All @@ -192,56 +192,56 @@
# -- 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 ---------------------------------------

# 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 -------------------------------------------
Expand All @@ -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
8 changes: 6 additions & 2 deletions flake8diff/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
__version__ = '0.2.1'
__version__ = '0.2.2'
__description__ = (
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved short description here so that it can be reused both by setup.py and in main.py

'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__']
2 changes: 1 addition & 1 deletion flake8diff/flake8.py
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this now will only print in console when verbose flag is used. otherwise it silently fails and proceeds to check other VCS. if none are found, then it flake8-diff will exit with error

else:
if vcs.is_used() and vcs.check():
return vcs
Expand Down
27 changes: 24 additions & 3 deletions flake8diff/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
import logging
import operator
import os
import platform
import six
import sys

from . import __description__, __version__
from .flake8 import COLORS, STRICT_MODES, Flake8Diff
from .vcs import SUPPORTED_VCS

Expand All @@ -38,9 +40,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(
Expand Down Expand Up @@ -114,10 +114,31 @@
'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 = (
'version: {}\n'
'python: {}\n'
'system: {}\n'
'source: https://github.com/dealertrack/flake8-diff'
)
print(msg.format(__version__, sys.executable, platform.system()))
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.')

Expand Down
2 changes: 1 addition & 1 deletion flake8diff/test_flake8.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

class Flake8DiffTestCase(TestCase):
def test_flake8diff(self):
f8d = flake8.Flake8Diff("", {})
flake8.Flake8Diff("", {})
3 changes: 2 additions & 1 deletion flake8diff/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 2 additions & 1 deletion flake8diff/vcs/git.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
"""
Expand Down Expand Up @@ -64,6 +64,7 @@ def changed_files(self):
self.vcs,
"diff",
"--name-only",
"--diff-filter=ACMRTUXB",
] + self.commits)

return filter(self.filter_file,
Expand Down
2 changes: 1 addition & 1 deletion flake8diff/vcs/hg.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
Loading