-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
PEP8 testing #1945
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.
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
Merged
Merged
PEP8 testing #1945
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
fd57377
Added a coding_standards test module. Currently checks PEP8 complianc…
pelson bc3e3ed
Added some of the PEP8 guidelines to ignore in the coding standards t…
pelson bb1a328
Fixed failing PEP8 test.
pelson 747b849
PEP8 test only on python2. 2to3 produces non pep8 compliant code.
pelson bd4f6fd
Fixed tests after rebase.
pelson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| from fnmatch import fnmatch | ||
| import os | ||
| import sys | ||
|
|
||
| from nose.tools import assert_equal | ||
| import pep8 | ||
|
|
||
| import matplotlib | ||
|
|
||
|
|
||
| class StandardReportWithExclusions(pep8.StandardReport): | ||
| #; A class attribute to store the exception exclusion file patterns. | ||
| expected_bad_files = [ | ||
| '*/matplotlib/__init__.py', | ||
| '*/matplotlib/_cm.py', | ||
| '*/matplotlib/_mathtext_data.py', | ||
| '*/matplotlib/_pylab_helpers.py', | ||
| '*/matplotlib/afm.py', | ||
| '*/matplotlib/animation.py', | ||
| '*/matplotlib/artist.py', | ||
| '*/matplotlib/axes.py', | ||
| '*/matplotlib/axis.py', | ||
| '*/matplotlib/backend_bases.py', | ||
| '*/matplotlib/bezier.py', | ||
| '*/matplotlib/cbook.py', | ||
| '*/matplotlib/collections.py', | ||
| '*/matplotlib/docstring.py', | ||
| '*/matplotlib/dviread.py', | ||
| '*/matplotlib/finance.py', | ||
| '*/matplotlib/font_manager.py', | ||
| '*/matplotlib/fontconfig_pattern.py', | ||
| '*/matplotlib/gridspec.py', | ||
| '*/matplotlib/legend.py', | ||
| '*/matplotlib/legend_handler.py', | ||
| '*/matplotlib/mathtext.py', | ||
| '*/matplotlib/mlab.py', | ||
| '*/matplotlib/path.py', | ||
| '*/matplotlib/patheffects.py', | ||
| '*/matplotlib/pylab.py', | ||
| '*/matplotlib/pyplot.py', | ||
| '*/matplotlib/rcsetup.py', | ||
| '*/matplotlib/stackplot.py', | ||
| '*/matplotlib/texmanager.py', | ||
| '*/matplotlib/text.py', | ||
| '*/matplotlib/transforms.py', | ||
| '*/matplotlib/type1font.py', | ||
| '*/matplotlib/widgets.py', | ||
| '*/matplotlib/testing/compare.py', | ||
| '*/matplotlib/testing/decorators.py', | ||
| '*/matplotlib/testing/image_util.py', | ||
| '*/matplotlib/testing/noseclasses.py', | ||
| '*/matplotlib/testing/jpl_units/Duration.py', | ||
| '*/matplotlib/testing/jpl_units/Epoch.py', | ||
| '*/matplotlib/testing/jpl_units/EpochConverter.py', | ||
| '*/matplotlib/testing/jpl_units/StrConverter.py', | ||
| '*/matplotlib/testing/jpl_units/UnitDbl.py', | ||
| '*/matplotlib/testing/jpl_units/UnitDblConverter.py', | ||
| '*/matplotlib/testing/jpl_units/UnitDblFormatter.py', | ||
| '*/matplotlib/testing/jpl_units/__init__.py', | ||
| '*/matplotlib/tri/tricontour.py', | ||
| '*/matplotlib/tri/triinterpolate.py', | ||
| '*/matplotlib/tri/tripcolor.py', | ||
| '*/matplotlib/tri/triplot.py', | ||
| '*/matplotlib/tests/__init__.py', | ||
| '*/matplotlib/tests/test_agg.py', | ||
| '*/matplotlib/tests/test_animation.py', | ||
| '*/matplotlib/tests/test_arrow_patches.py', | ||
| '*/matplotlib/tests/test_artist.py', | ||
| '*/matplotlib/tests/test_axes.py', | ||
| '*/matplotlib/tests/test_backend_pdf.py', | ||
| '*/matplotlib/tests/test_backend_pgf.py', | ||
| '*/matplotlib/tests/test_backend_svg.py', | ||
| '*/matplotlib/tests/test_basic.py', | ||
| '*/matplotlib/tests/test_bbox_tight.py', | ||
| '*/matplotlib/tests/test_cbook.py', | ||
| '*/matplotlib/tests/test_colorbar.py', | ||
| '*/matplotlib/tests/test_colors.py', | ||
| '*/matplotlib/tests/test_compare_images.py', | ||
| '*/matplotlib/tests/test_contour.py', | ||
| '*/matplotlib/tests/test_dates.py', | ||
| '*/matplotlib/tests/test_delaunay.py', | ||
| '*/matplotlib/tests/test_dviread.py', | ||
| '*/matplotlib/tests/test_image.py', | ||
| '*/matplotlib/tests/test_legend.py', | ||
| '*/matplotlib/tests/test_lines.py', | ||
| '*/matplotlib/tests/test_mathtext.py', | ||
| '*/matplotlib/tests/test_patches.py', | ||
| '*/matplotlib/tests/test_pickle.py', | ||
| '*/matplotlib/tests/test_png.py', | ||
| '*/matplotlib/tests/test_rcparams.py', | ||
| '*/matplotlib/tests/test_simplification.py', | ||
| '*/matplotlib/tests/test_spines.py', | ||
| '*/matplotlib/tests/test_streamplot.py', | ||
| '*/matplotlib/tests/test_subplots.py', | ||
| '*/matplotlib/tests/test_text.py', | ||
| '*/matplotlib/tests/test_tightlayout.py', | ||
| '*/matplotlib/tests/test_transforms.py', | ||
| '*/matplotlib/tests/test_triangulation.py', | ||
| '*/matplotlib/compat/subprocess.py', | ||
| '*/matplotlib/backends/__init__.py', | ||
| '*/matplotlib/backends/backend_agg.py', | ||
| '*/matplotlib/backends/backend_cairo.py', | ||
| '*/matplotlib/backends/backend_cocoaagg.py', | ||
| '*/matplotlib/backends/backend_gdk.py', | ||
| '*/matplotlib/backends/backend_gtk.py', | ||
| '*/matplotlib/backends/backend_gtk3.py', | ||
| '*/matplotlib/backends/backend_gtk3cairo.py', | ||
| '*/matplotlib/backends/backend_gtkagg.py', | ||
| '*/matplotlib/backends/backend_gtkcairo.py', | ||
| '*/matplotlib/backends/backend_macosx.py', | ||
| '*/matplotlib/backends/backend_mixed.py', | ||
| '*/matplotlib/backends/backend_pdf.py', | ||
| '*/matplotlib/backends/backend_pgf.py', | ||
| '*/matplotlib/backends/backend_ps.py', | ||
| '*/matplotlib/backends/backend_qt4.py', | ||
| '*/matplotlib/backends/backend_qt4agg.py', | ||
| '*/matplotlib/backends/backend_svg.py', | ||
| '*/matplotlib/backends/backend_template.py', | ||
| '*/matplotlib/backends/backend_tkagg.py', | ||
| '*/matplotlib/backends/backend_webagg.py', | ||
| '*/matplotlib/backends/backend_wx.py', | ||
| '*/matplotlib/backends/backend_wxagg.py', | ||
| '*/matplotlib/backends/qt4_compat.py', | ||
| '*/matplotlib/backends/tkagg.py', | ||
| '*/matplotlib/backends/windowing.py', | ||
| '*/matplotlib/backends/qt4_editor/figureoptions.py', | ||
| '*/matplotlib/backends/qt4_editor/formlayout.py', | ||
| '*/matplotlib/sphinxext/__init__.py', | ||
| '*/matplotlib/sphinxext/ipython_console_highlighting.py', | ||
| '*/matplotlib/sphinxext/ipython_directive.py', | ||
| '*/matplotlib/sphinxext/mathmpl.py', | ||
| '*/matplotlib/sphinxext/only_directives.py', | ||
| '*/matplotlib/sphinxext/plot_directive.py', | ||
| '*/matplotlib/projections/__init__.py', | ||
| '*/matplotlib/projections/geo.py', | ||
| '*/matplotlib/projections/polar.py'] | ||
|
|
||
| #: A class attribute to store patterns which have seen exceptions. | ||
| matched_exclusions = set() | ||
|
|
||
| def get_file_results(self): | ||
| # If the file had no errors, return self.file_errors (which will be 0) | ||
| if not self._deferred_print: | ||
| return self.file_errors | ||
|
|
||
| # Iterate over all of the patterns, to find a possible exclusion. If we | ||
| # the filename is to be excluded, go ahead and remove the counts that | ||
| # self.error added. | ||
| for pattern in self.expected_bad_files: | ||
| if fnmatch(self.filename, pattern): | ||
| self.matched_exclusions.add(pattern) | ||
| # invert the error method's counters. | ||
| for _, _, code, _, _ in self._deferred_print: | ||
| self.counters[code] -= 1 | ||
| if self.counters[code] == 0: | ||
| self.counters.pop(code) | ||
| self.messages.pop(code) | ||
| self.file_errors -= 1 | ||
| self.total_errors -= 1 | ||
| return self.file_errors | ||
|
|
||
| # Otherwise call the superclass' method to print the bad results. | ||
| return super(StandardReportWithExclusions, | ||
| self).get_file_results() | ||
|
|
||
|
|
||
| def test_pep8_conformance(): | ||
| # Tests the matplotlib codebase against the "pep8" tool. | ||
| # | ||
| # Users can add their own excluded files (should files exist in the | ||
| # local directory which is not in the repository) by adding a | ||
| # ".pep8_test_exclude.txt" file in the same directory as this test. | ||
| # The file should be a line separated list of filenames/directories | ||
| # as can be passed to the "pep8" tool's exclude list. | ||
|
|
||
| # Only run this test with Python 2 - the 2to3 tool generates non pep8 | ||
| # compliant code. | ||
| if sys.version_info[0] != 2: | ||
| return | ||
|
|
||
| # to get a list of bad files, rather than the specific errors, add | ||
| # "reporter=pep8.FileReport" to the StyleGuide constructor. | ||
| pep8style = pep8.StyleGuide(quiet=False, | ||
| reporter=StandardReportWithExclusions) | ||
|
|
||
| # Extend the number of PEP8 guidelines which are not checked. | ||
| pep8style.options.ignore = pep8style.options.ignore + ('E121', 'E122', | ||
| 'E123', 'E124', 'E125', 'E126', 'E127', | ||
| 'E128') | ||
|
|
||
| # Support for egg shared object wrappers, which are not PEP8 compliant, | ||
| # nor part of the matplotlib repository. | ||
| # DO NOT ADD FILES *IN* THE REPOSITORY TO THIS LIST. | ||
| pep8style.options.exclude.extend( | ||
| ['_delaunay.py', | ||
| '_image.py', | ||
| '_tri.py', | ||
| '_backend_agg.py', | ||
| '_tkagg.py', | ||
| 'ft2font.py', | ||
| '_cntr.py', | ||
| '_png.py', | ||
| '_path.py', | ||
| 'ttconv.py', | ||
| 'pyparsing*']) | ||
|
|
||
| # Allow users to add their own exclude list. | ||
| extra_exclude_file = os.path.join(os.path.dirname(__file__), | ||
| '.pep8_test_exclude.txt') | ||
| if os.path.exists(extra_exclude_file): | ||
| with open(extra_exclude_file, 'r') as fh: | ||
| extra_exclude = [line.strip() for line in fh if line.strip()] | ||
| pep8style.options.exclude.extend(extra_exclude) | ||
|
|
||
| result = pep8style.check_files([os.path.dirname(matplotlib.__file__)]) | ||
| assert_equal(result.total_errors, 0, "Found code syntax " | ||
| "errors (and warnings).") | ||
|
|
||
| reporter = pep8style.options.reporter | ||
| # If we've been using the exclusions reporter, check that we didn't | ||
| # exclude files unnecessarily. | ||
| if reporter is StandardReportWithExclusions: | ||
| unexpectedly_good = sorted(set(reporter.expected_bad_files) - | ||
| reporter.matched_exclusions) | ||
|
|
||
| if unexpectedly_good: | ||
| raise ValueError('Some exclude patterns were unnecessary as the ' | ||
| 'files they pointed to either passed the PEP8 ' | ||
| 'tests or do not point to a file:\n ' | ||
| '{}'.format('\n '.join(unexpectedly_good))) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| import nose | ||
| nose.runmodule(argv=['-s', '--with-doctest'], exit=False) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this comment above just be a docstring? Also, it seems out of date with what's actually here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think its out of date (I suppose there is more going on in the method than the comment suggests?). Is there a specific part which is out of date?
If I convert it to a docstring, you end up with annoying output when running the tests. This can be avoided though (see http://stackoverflow.com/questions/12962772/how-to-stop-python-unittest-from-printing-test-docstring)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see. Let's leave it as a comment then.
I was confused by the list of exclusions in this file and the mention of
.pep8_test_exclude. Why are there two different methods for defining exclusions?