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
Python linting script #1032
Closed
Closed
Python linting script #1032
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
963ecd3
Use Python script to lint drafts
MikeBishop f5a845b
Fix mode on .lint.py for non-Windows systems
MikeBishop 3d296ef
Most of Martin's feedback
MikeBishop 53d9932
Use argparse instead of getopt; multiple files at once
MikeBishop 1b08f18
Stderr here too
MikeBishop 9f84c88
Python version flexibility
MikeBishop a629788
autopep8
martinthomson 7abbc4a
More compact version probing
MikeBishop e323a81
Martin's hated comma came back
MikeBishop File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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,59 @@ | ||
#!/usr/bin/env python3 | ||
|
||
import sys | ||
import argparse | ||
import re | ||
|
||
parser = argparse.ArgumentParser(description='Lint markdown drafts.') | ||
parser.add_argument('files', metavar='file', nargs='+', help='Files to lint') | ||
parser.add_argument('-l', dest='maxLineLength', default=80) | ||
parser.add_argument('-f', dest='maxFigureLineLength', default=65) | ||
|
||
args = parser.parse_args() | ||
|
||
foundError = False | ||
|
||
for inputfile in args.files: | ||
insideFigure = False | ||
beforeAbstract = True | ||
with open(inputfile, 'U') as draft: | ||
linecounter = 1 | ||
lines = draft.readlines() | ||
|
||
abstract = re.compile('^--- abstract') | ||
table = re.compile('^\s*(?:\||{:)') | ||
figure = re.compile('^[~`]{3}') | ||
|
||
for line in lines: | ||
line = line.rstrip('\r\n') | ||
linenumber = linecounter | ||
linecounter += 1 | ||
|
||
# Skip everything before abstract | ||
if beforeAbstract: | ||
matchObj = abstract.match(line) | ||
if matchObj: | ||
beforeAbstract = False | ||
continue | ||
|
||
# Skip tables | ||
matchObj = table.match(line) | ||
if matchObj: | ||
continue | ||
|
||
# Toggle figure state | ||
matchObj = figure.match(line) | ||
if matchObj: | ||
insideFigure = not insideFigure | ||
continue | ||
|
||
# Check length | ||
length = len(line) | ||
limit = args.maxFigureLineLength if insideFigure else args.maxLineLength | ||
if length > limit: | ||
foundError = True | ||
sys.stderr.write("{0}: Line is {1} characters; limit is {2}\n".format( | ||
linenumber, length, limit)) | ||
sys.stderr.write("{0}\n".format(line)) | ||
|
||
sys.exit(1 if foundError else 0) |
This file contains 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
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.
can you run autopep8 over this?