summaryrefslogtreecommitdiff
path: root/pep8.py
diff options
context:
space:
mode:
authorIan Lee <IanLee1521@gmail.com>2016-05-24 11:47:07 -0700
committerIan Lee <IanLee1521@gmail.com>2016-05-24 11:47:07 -0700
commite8ccd6726d440274c8e63001c4b9cd435277ced4 (patch)
treeb15c40cbcdf81052e1661661316cbda5661859f1 /pep8.py
parentb5d335c44558e50cbe063a26e749446a3f449a46 (diff)
parent1dd1127605bc4dfe52e6a9ff23cba7e2b0fe7fea (diff)
downloadpep8-e8ccd6726d440274c8e63001c4b9cd435277ced4.tar.gz
Merge pull request #487 from PyCQA/issue-228
Patched pep8 to comply with pydocstyle; Closes #228.
Diffstat (limited to 'pep8.py')
-rwxr-xr-xpep8.py18
1 files changed, 12 insertions, 6 deletions
diff --git a/pep8.py b/pep8.py
index 247a626..0d329f3 100755
--- a/pep8.py
+++ b/pep8.py
@@ -855,7 +855,7 @@ def whitespace_before_comment(logical_line, tokens):
def imports_on_separate_lines(logical_line):
- r"""Imports should usually be on separate lines.
+ r"""Place imports on separate lines.
Okay: import os\nimport sys
E401: import sys, os
@@ -875,8 +875,10 @@ def imports_on_separate_lines(logical_line):
def module_imports_on_top_of_file(
logical_line, indent_level, checker_state, noqa):
- r"""Imports are always put at the top of the file, just after any module
- comments and docstrings, and before module globals and constants.
+ r"""Place imports at the top of the file.
+
+ Always put imports at the top of the file, just after any module comments
+ and docstrings, and before module globals and constants.
Okay: import os
Okay: # this is a comment\nimport os
@@ -1184,7 +1186,7 @@ def python_3000_not_equal(logical_line):
def python_3000_backticks(logical_line):
- r"""Backticks are removed in Python 3: use repr() instead.
+ r"""Use repr() instead of backticks in Python 3.
Okay: val = repr(1 + 2)
W604: val = `1 + 2`
@@ -1223,7 +1225,9 @@ else:
isidentifier = str.isidentifier
def stdin_get_value():
+ """Read the value from stdin."""
return TextIOWrapper(sys.stdin.buffer, errors='ignore').read()
+
noqa = re.compile(r'# no(?:qa|pep8)\b', re.I).search
@@ -1457,7 +1461,7 @@ class Checker(object):
return check(*arguments)
def init_checker_state(self, name, argument_names):
- """ Prepares a custom state for the specific checker plugin."""
+ """Prepare custom state for the specific checker plugin."""
if 'checker_state' in argument_names:
self.checker_state = self._checker_states.setdefault(name, {})
@@ -1739,6 +1743,7 @@ class BaseReport(object):
class FileReport(BaseReport):
"""Collect the results of the checks and print only the filenames."""
+
print_filename = True
@@ -1946,6 +1951,7 @@ class StyleGuide(object):
def get_parser(prog='pep8', version=__version__):
+ """Create the parser for the program."""
parser = OptionParser(prog=prog, version=version,
usage="%prog [options] input ...")
parser.config_options = [
@@ -2007,7 +2013,7 @@ def get_parser(prog='pep8', version=__version__):
def read_config(options, args, arglist, parser):
- """Read and parse configurations
+ """Read and parse configurations.
If a config file is specified on the command line with the "--config"
option, then only it is used for configuration.