METADATA 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063
  1. Metadata-Version: 2.1
  2. Name: pycodestyle
  3. Version: 2.8.0
  4. Summary: Python style guide checker
  5. Home-page: https://pycodestyle.pycqa.org/
  6. Author: Johann C. Rocholl
  7. Author-email: johann@rocholl.net
  8. Maintainer: Ian Lee
  9. Maintainer-email: IanLee1521@gmail.com
  10. License: Expat license
  11. Project-URL: Changes, https://pycodestyle.pycqa.org/en/latest/developer.html#changes
  12. Keywords: pycodestyle,pep8,PEP 8,PEP-8,PEP8
  13. Platform: UNKNOWN
  14. Classifier: Development Status :: 5 - Production/Stable
  15. Classifier: Environment :: Console
  16. Classifier: Intended Audience :: Developers
  17. Classifier: License :: OSI Approved :: MIT License
  18. Classifier: Operating System :: OS Independent
  19. Classifier: Programming Language :: Python
  20. Classifier: Programming Language :: Python :: 2
  21. Classifier: Programming Language :: Python :: 2.7
  22. Classifier: Programming Language :: Python :: 3
  23. Classifier: Programming Language :: Python :: 3.5
  24. Classifier: Programming Language :: Python :: 3.6
  25. Classifier: Programming Language :: Python :: 3.7
  26. Classifier: Programming Language :: Python :: 3.8
  27. Classifier: Programming Language :: Python :: Implementation :: CPython
  28. Classifier: Programming Language :: Python :: Implementation :: PyPy
  29. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  30. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
  31. License-File: LICENSE
  32. pycodestyle (formerly called pep8) - Python style guide checker
  33. ===============================================================
  34. .. image:: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml/badge.svg
  35. :target: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml
  36. :alt: Build status
  37. .. image:: https://readthedocs.org/projects/pycodestyle/badge/?version=latest
  38. :target: https://pycodestyle.pycqa.org
  39. :alt: Documentation Status
  40. .. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg
  41. :target: https://pypi.org/project/pycodestyle/
  42. :alt: Wheel Status
  43. .. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg
  44. :alt: Join the chat at https://gitter.im/PyCQA/pycodestyle
  45. :target: https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
  46. pycodestyle is a tool to check your Python code against some of the style
  47. conventions in `PEP 8`_.
  48. .. _PEP 8: http://www.python.org/dev/peps/pep-0008/
  49. .. note::
  50. This package used to be called ``pep8`` but was renamed to ``pycodestyle``
  51. to reduce confusion. Further discussion can be found `in the issue where
  52. Guido requested this
  53. change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the
  54. lightning talk at PyCon 2016 by @IanLee1521:
  55. `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_
  56. `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.
  57. Features
  58. --------
  59. * Plugin architecture: Adding new checks is easy.
  60. * Parseable output: Jump to error location in your editor.
  61. * Small: Just one Python file, requires only stdlib. You can use just
  62. the ``pycodestyle.py`` file for this purpose.
  63. * Comes with a comprehensive test suite.
  64. Installation
  65. ------------
  66. You can install, upgrade, and uninstall ``pycodestyle.py`` with these commands::
  67. $ pip install pycodestyle
  68. $ pip install --upgrade pycodestyle
  69. $ pip uninstall pycodestyle
  70. There's also a package for Debian/Ubuntu, but it's not always the
  71. latest version.
  72. Example usage and output
  73. ------------------------
  74. ::
  75. $ pycodestyle --first optparse.py
  76. optparse.py:69:11: E401 multiple imports on one line
  77. optparse.py:77:1: E302 expected 2 blank lines, found 1
  78. optparse.py:88:5: E301 expected 1 blank line, found 0
  79. optparse.py:222:34: W602 deprecated form of raising exception
  80. optparse.py:347:31: E211 whitespace before '('
  81. optparse.py:357:17: E201 whitespace after '{'
  82. optparse.py:472:29: E221 multiple spaces before operator
  83. optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
  84. You can also make ``pycodestyle.py`` show the source code for each error, and
  85. even the relevant text from PEP 8::
  86. $ pycodestyle --show-source --show-pep8 testsuite/E40.py
  87. testsuite/E40.py:2:10: E401 multiple imports on one line
  88. import os, sys
  89. ^
  90. Imports should usually be on separate lines.
  91. Okay: import os\nimport sys
  92. E401: import sys, os
  93. Or you can display how often each error was found::
  94. $ pycodestyle --statistics -qq Python-2.5/Lib
  95. 232 E201 whitespace after '['
  96. 599 E202 whitespace before ')'
  97. 631 E203 whitespace before ','
  98. 842 E211 whitespace before '('
  99. 2531 E221 multiple spaces before operator
  100. 4473 E301 expected 1 blank line, found 0
  101. 4006 E302 expected 2 blank lines, found 1
  102. 165 E303 too many blank lines (4)
  103. 325 E401 multiple imports on one line
  104. 3615 E501 line too long (82 characters)
  105. 612 W601 .has_key() is deprecated, use 'in'
  106. 1188 W602 deprecated form of raising exception
  107. Links
  108. -----
  109. * `Read the documentation <https://pycodestyle.pycqa.org/>`_
  110. * `Fork me on GitHub <http://github.com/PyCQA/pycodestyle>`_
  111. Changelog
  112. =========
  113. 2.8.0 (2021-10-10)
  114. ------------------
  115. Changes:
  116. * Drop python 3.4. PR #982.
  117. * E712: fix false negative with multiple comparisons. PR #987.
  118. * E211: fix false positives with ``match``. PR #989.
  119. * E772: improve performance of bare except check. PR #992.
  120. * Backport tokenize performance improvement from python 3.10. PR #993.
  121. * E225: fix for lambdas containing positional-only args. PR #1012.
  122. * Remove ``indent_size_str`` "setting". PR #995.
  123. * E402: allow ``__all__`` to be typed. PR #1019.
  124. * E225: fix false positives for ``*`` in ``case``. PR #1003.
  125. * E201: detect tabs as whitespace. PR #1015.
  126. 2.7.0 (2021-03-14)
  127. ------------------
  128. Changes:
  129. * Fix physical checks (such as W191) at end of file. PR #961.
  130. * Add ``--indent-size`` option (defaulting to ``4``). PR #970.
  131. * W605: fix escaped crlf false positive on windows. PR #976.
  132. 2.6.0 (2020-05-11)
  133. ------------------
  134. Announcements:
  135. * Anthony Sottile (@asottile) joined the team as a core developer. :tada:
  136. Changes:
  137. * E306: fix detection inside ``async def``. PR #929.
  138. * E301: fix regression disallowing decorated one-liners. PR #927.
  139. * E714: fix false positive with chained ``is not``. PR #931.
  140. 2.6.0a1 (2020-04-23)
  141. --------------------
  142. New checks:
  143. * E225: require whitespace around ``and`` ``in`` ``is`` and ``or``. PR #847.
  144. Changes:
  145. * E117: fix indentation using tabs by treating as 8-space indents. PR #837.
  146. * E721: fix false positive with names containg ``istype``. PR #850.
  147. * E741: allow ``l`` as a named argument in a function call. PR #853.
  148. * E302: fix false-negative with decorated functions. PR #859.
  149. * W504: ellipsis (``...``) is no longer treated as a binary operator. PR #875.
  150. * E402: allow ``with``, ``if``, ``elif``, ``else`` to guard imports. PR #834.
  151. * Add support for assignment expressions ``:=`` (PEP 572). PR #879.
  152. * Add support for positional-only arguments ``/`` (PEP 570). PR #872, #918.
  153. * Add support for python 3.8.
  154. * Add support for matrix multiplication operator ``@`` (PEP 465). PR #897.
  155. * Support visual indent for continuation lines for ``with`` / ``assert`` /
  156. ``raise``. PR #912.
  157. * E302: allow two blank lines after a block of one-liners. PR #913.
  158. * E302: allow two-and-fewer newlines at the top of the file. PR #919.
  159. 2.5.0 (2019-01-29)
  160. ------------------
  161. New checks:
  162. * E117: Over-indented code blocks
  163. * W505: Maximum doc-string length only when configured with --max-doc-length
  164. Changes:
  165. * Remove support for EOL Python 2.6 and 3.3. PR #720.
  166. * Add E117 error for over-indented code blocks.
  167. * Allow W605 to be silenced by `# noqa` and fix the position reported by W605
  168. * Allow users to omit blank lines around one-liner definitions of classes and
  169. functions
  170. * Include the function return annotation (``->``) as requiring surrounding
  171. whitespace only on Python 3
  172. * Verify that only names can follow ``await``. Previously we allowed numbers
  173. and strings.
  174. * Add support for Python 3.7
  175. * Fix detection of annotated argument defaults for E252
  176. * Correct the position reported by W504
  177. 2.4.0 (2018-04-10)
  178. ------------------
  179. New checks:
  180. * Add W504 warning for checking that a break doesn't happen after a binary
  181. operator. This check is ignored by default. PR #502.
  182. * Add W605 warning for invalid escape sequences in string literals. PR #676.
  183. * Add W606 warning for 'async' and 'await' reserved keywords being introduced
  184. in Python 3.7. PR #684.
  185. * Add E252 error for missing whitespace around equal sign in type annotated
  186. function arguments with defaults values. PR #717.
  187. Changes:
  188. * An internal bisect search has replaced a linear search in order to improve
  189. efficiency. PR #648.
  190. * pycodestyle now uses PyPI trove classifiers in order to document supported
  191. python versions on PyPI. PR #654.
  192. * 'setup.cfg' '[wheel]' section has been renamed to '[bdist_wheel]', as
  193. the former is legacy. PR #653.
  194. * pycodestyle now handles very long lines much more efficiently for python
  195. 3.2+. Fixes #643. PR #644.
  196. * You can now write 'pycodestyle.StyleGuide(verbose=True)' instead of
  197. 'pycodestyle.StyleGuide(verbose=True, paths=['-v'])' in order to achieve
  198. verbosity. PR #663.
  199. * The distribution of pycodestyle now includes the license text in order to
  200. comply with open source licenses which require this. PR #694.
  201. * 'maximum_line_length' now ignores shebang ('#!') lines. PR #736.
  202. * Add configuration option for the allowed number of blank lines. It is
  203. implemented as a top level dictionary which can be easily overwritten. Fixes
  204. #732. PR #733.
  205. Bugs:
  206. * Prevent a 'DeprecationWarning', and a 'SyntaxError' in future python, caused
  207. by an invalid escape sequence. PR #625.
  208. * Correctly report E501 when the first line of a docstring is too long.
  209. Resolves #622. PR #630.
  210. * Support variable annotation when variable start by a keyword, such as class
  211. variable type annotations in python 3.6. PR #640.
  212. * pycodestyle internals have been changed in order to allow 'python3 -m
  213. cProfile' to report correct metrics. PR #647.
  214. * Fix a spelling mistake in the description of E722. PR #697.
  215. * 'pycodestyle --diff' now does not break if your 'gitconfig' enables
  216. 'mnemonicprefix'. PR #706.
  217. 2.3.1 (2017-01-31)
  218. ------------------
  219. Bugs:
  220. * Fix regression in detection of E302 and E306; #618, #620
  221. 2.3.0 (2017-01-30)
  222. ------------------
  223. New Checks:
  224. * Add E722 warning for bare ``except`` clauses
  225. * Report E704 for async function definitions (``async def``)
  226. Bugs:
  227. * Fix another E305 false positive for variables beginning with "class" or
  228. "def"
  229. * Fix detection of multiple spaces between ``async`` and ``def``
  230. * Fix handling of variable annotations. Stop reporting E701 on Python 3.6 for
  231. variable annotations.
  232. 2.2.0 (2016-11-14)
  233. ------------------
  234. Announcements:
  235. * Added Make target to obtain proper tarball file permissions; #599
  236. Bugs:
  237. * Fixed E305 regression caused by #400; #593
  238. 2.1.0 (2016-11-04)
  239. ------------------
  240. Announcements:
  241. * Change all references to the pep8 project to say pycodestyle; #530
  242. Changes:
  243. * Report E302 for blank lines before an "async def"; #556
  244. * Update our list of tested and supported Python versions which are 2.6, 2.7,
  245. 3.2, 3.3, 3.4 and 3.5 as well as the nightly Python build and PyPy.
  246. * Report E742 and E743 for functions and classes badly named 'l', 'O', or 'I'.
  247. * Report E741 on 'global' and 'nonlocal' statements, as well as prohibited
  248. single-letter variables.
  249. * Deprecated use of `[pep8]` section name in favor of `[pycodestyle]`; #591
  250. * Report E722 when bare except clause is used; #579
  251. Bugs:
  252. * Fix opt_type AssertionError when using Flake8 2.6.2 and pycodestyle; #561
  253. * Require two blank lines after toplevel def, class; #536
  254. * Remove accidentally quadratic computation based on the number of colons. This
  255. will make pycodestyle faster in some cases; #314
  256. 2.0.0 (2016-05-31)
  257. ------------------
  258. Announcements:
  259. * Repository renamed to `pycodestyle`; Issue #466 / #481.
  260. * Added joint Code of Conduct as member of PyCQA; #483
  261. Changes:
  262. * Added tox test support for Python 3.5 and pypy3
  263. * Added check E275 for whitespace on `from ... import ...` lines; #489 / #491
  264. * Added W503 to the list of codes ignored by default ignore list; #498
  265. * Removed use of project level `.pep8` configuration file; #364
  266. Bugs:
  267. * Fixed bug with treating `~` operator as binary; #383 / #384
  268. * Identify binary operators as unary; #484 / #485
  269. 1.7.0 (2016-01-12)
  270. ------------------
  271. Announcements:
  272. * Repository moved to PyCQA Organization on GitHub:
  273. https://github.com/pycqa/pep8
  274. Changes:
  275. * Reverted the fix in #368, "options passed on command line are only ones
  276. accepted" feature. This has many unintended consequences in pep8 and flake8
  277. and needs to be reworked when I have more time.
  278. * Added support for Python 3.5. (Issue #420 & #459)
  279. * Added support for multi-line config_file option parsing. (Issue #429)
  280. * Improved parameter parsing. (Issues #420 & #456)
  281. Bugs:
  282. * Fixed BytesWarning on Python 3. (Issue #459)
  283. 1.6.2 (2015-02-15)
  284. ------------------
  285. Changes:
  286. * Added check for breaking around a binary operator. (Issue #197, Pull #305)
  287. Bugs:
  288. * Restored config_file parameter in process_options(). (Issue #380)
  289. 1.6.1 (2015-02-08)
  290. ------------------
  291. Changes:
  292. * Assign variables before referenced. (Issue #287)
  293. Bugs:
  294. * Exception thrown due to unassigned ``local_dir`` variable. (Issue #377)
  295. 1.6.0 (2015-02-06)
  296. ------------------
  297. News:
  298. * Ian Lee <ianlee1521@gmail.com> joined the project as a maintainer.
  299. Changes:
  300. * Report E731 for lambda assignment. (Issue #277)
  301. * Report E704 for one-liner def instead of E701.
  302. Do not report this error in the default configuration. (Issue #277)
  303. * Replace codes E111, E112 and E113 with codes E114, E115 and E116
  304. for bad indentation of comments. (Issue #274)
  305. * Report E266 instead of E265 when the block comment starts with
  306. multiple ``#``. (Issue #270)
  307. * Report E402 for import statements not at the top of the file. (Issue #264)
  308. * Do not enforce whitespaces around ``**`` operator. (Issue #292)
  309. * Strip whitespace from around paths during normalization. (Issue #339 / #343)
  310. * Update ``--format`` documentation. (Issue #198 / Pull Request #310)
  311. * Add ``.tox/`` to default excludes. (Issue #335)
  312. * Do not report E121 or E126 in the default configuration. (Issues #256 / #316)
  313. * Allow spaces around the equals sign in an annotated function. (Issue #357)
  314. * Allow trailing backslash if in an inline comment. (Issue #374)
  315. * If ``--config`` is used, only that configuration is processed. Otherwise,
  316. merge the user and local configurations are merged. (Issue #368 / #369)
  317. Bug fixes:
  318. * Don't crash if Checker.build_tokens_line() returns None. (Issue #306)
  319. * Don't crash if os.path.expanduser() throws an ImportError. (Issue #297)
  320. * Missing space around keyword parameter equal not always reported, E251.
  321. (Issue #323)
  322. * Fix false positive E711/E712/E713. (Issues #330 and #336)
  323. * Do not skip physical checks if the newline is escaped. (Issue #319)
  324. * Flush sys.stdout to avoid race conditions with printing. See flake8 bug:
  325. https://gitlab.com/pycqa/flake8/issues/17 for more details. (Issue #363)
  326. 1.5.7 (2014-05-29)
  327. ------------------
  328. Bug fixes:
  329. * Skip the traceback on "Broken pipe" signal. (Issue #275)
  330. * Do not exit when an option in ``setup.cfg`` or ``tox.ini``
  331. is not recognized.
  332. * Check the last line even if it does not end with a newline. (Issue #286)
  333. * Always open files in universal newlines mode in Python 2. (Issue #288)
  334. 1.5.6 (2014-04-14)
  335. ------------------
  336. Bug fixes:
  337. * Check the last line even if it has no end-of-line. (Issue #273)
  338. 1.5.5 (2014-04-10)
  339. ------------------
  340. Bug fixes:
  341. * Fix regression with E22 checks and inline comments. (Issue #271)
  342. 1.5.4 (2014-04-07)
  343. ------------------
  344. Bug fixes:
  345. * Fix negative offset with E303 before a multi-line docstring.
  346. (Issue #269)
  347. 1.5.3 (2014-04-04)
  348. ------------------
  349. Bug fixes:
  350. * Fix wrong offset computation when error is on the last char
  351. of a physical line. (Issue #268)
  352. 1.5.2 (2014-04-04)
  353. ------------------
  354. Changes:
  355. * Distribute a universal wheel file.
  356. Bug fixes:
  357. * Report correct line number for E303 with comments. (Issue #60)
  358. * Do not allow newline after parameter equal. (Issue #252)
  359. * Fix line number reported for multi-line strings. (Issue #220)
  360. * Fix false positive E121/E126 with multi-line strings. (Issue #265)
  361. * Fix E501 not detected in comments with Python 2.5.
  362. * Fix caret position with ``--show-source`` when line contains tabs.
  363. 1.5.1 (2014-03-27)
  364. ------------------
  365. Bug fixes:
  366. * Fix a crash with E125 on multi-line strings. (Issue #263)
  367. 1.5 (2014-03-26)
  368. ----------------
  369. Changes:
  370. * Report E129 instead of E125 for visually indented line with same
  371. indent as next logical line. (Issue #126)
  372. * Report E265 for space before block comment. (Issue #190)
  373. * Report E713 and E714 when operators ``not in`` and ``is not`` are
  374. recommended. (Issue #236)
  375. * Allow long lines in multiline strings and comments if they cannot
  376. be wrapped. (Issue #224).
  377. * Optionally disable physical line checks inside multiline strings,
  378. using ``# noqa``. (Issue #242)
  379. * Change text for E121 to report "continuation line under-indented
  380. for hanging indent" instead of indentation not being a
  381. multiple of 4.
  382. * Report E131 instead of E121 / E126 if the hanging indent is not
  383. consistent within the same continuation block. It helps when
  384. error E121 or E126 is in the ``ignore`` list.
  385. * Report E126 instead of E121 when the continuation line is hanging
  386. with extra indentation, even if indentation is not a multiple of 4.
  387. Bug fixes:
  388. * Allow the checkers to report errors on empty files. (Issue #240)
  389. * Fix ignoring too many checks when ``--select`` is used with codes
  390. declared in a flake8 extension. (Issue #216)
  391. * Fix regression with multiple brackets. (Issue #214)
  392. * Fix ``StyleGuide`` to parse the local configuration if the
  393. keyword argument ``paths`` is specified. (Issue #246)
  394. * Fix a false positive E124 for hanging indent. (Issue #254)
  395. * Fix a false positive E126 with embedded colon. (Issue #144)
  396. * Fix a false positive E126 when indenting with tabs. (Issue #204)
  397. * Fix behaviour when ``exclude`` is in the configuration file and
  398. the current directory is not the project directory. (Issue #247)
  399. * The logical checks can return ``None`` instead of an empty iterator.
  400. (Issue #250)
  401. * Do not report multiple E101 if only the first indentation starts
  402. with a tab. (Issue #237)
  403. * Fix a rare false positive W602. (Issue #34)
  404. 1.4.6 (2013-07-02)
  405. ------------------
  406. Changes:
  407. * Honor ``# noqa`` for errors E711 and E712. (Issue #180)
  408. * When both a ``tox.ini`` and a ``setup.cfg`` are present in the project
  409. directory, merge their contents. The ``tox.ini`` file takes
  410. precedence (same as before). (Issue #182)
  411. * Give priority to ``--select`` over ``--ignore``. (Issue #188)
  412. * Compare full path when excluding a file. (Issue #186)
  413. * New option ``--hang-closing`` to switch to the alternative style of
  414. closing bracket indentation for hanging indent. Add error E133 for
  415. closing bracket which is missing indentation. (Issue #103)
  416. * Accept both styles of closing bracket indentation for hanging indent.
  417. Do not report error E123 in the default configuration. (Issue #103)
  418. Bug fixes:
  419. * Do not crash when running AST checks and the document contains null bytes.
  420. (Issue #184)
  421. * Correctly report other E12 errors when E123 is ignored. (Issue #103)
  422. * Fix false positive E261/E262 when the file contains a BOM. (Issue #193)
  423. * Fix E701, E702 and E703 not detected sometimes. (Issue #196)
  424. * Fix E122 not detected in some cases. (Issue #201 and #208)
  425. * Fix false positive E121 with multiple brackets. (Issue #203)
  426. 1.4.5 (2013-03-06)
  427. ------------------
  428. * When no path is specified, do not try to read from stdin. The feature
  429. was added in 1.4.3, but it is not supported on Windows. Use ``-``
  430. filename argument to read from stdin. This usage is supported
  431. since 1.3.4. (Issue #170)
  432. * Do not require ``setuptools`` in setup.py. It works around an issue
  433. with ``pip`` and Python 3. (Issue #172)
  434. * Add ``__pycache__`` to the ignore list.
  435. * Change misleading message for E251. (Issue #171)
  436. * Do not report false E302 when the source file has a coding cookie or a
  437. comment on the first line. (Issue #174)
  438. * Reorganize the tests and add tests for the API and for the command line
  439. usage and options. (Issues #161 and #162)
  440. * Ignore all checks which are not explicitly selected when ``select`` is
  441. passed to the ``StyleGuide`` constructor.
  442. 1.4.4 (2013-02-24)
  443. ------------------
  444. * Report E227 or E228 instead of E225 for whitespace around bitwise, shift
  445. or modulo operators. (Issue #166)
  446. * Change the message for E226 to make clear that it is about arithmetic
  447. operators.
  448. * Fix a false positive E128 for continuation line indentation with tabs.
  449. * Fix regression with the ``--diff`` option. (Issue #169)
  450. * Fix the ``TestReport`` class to print the unexpected warnings and
  451. errors.
  452. 1.4.3 (2013-02-22)
  453. ------------------
  454. * Hide the ``--doctest`` and ``--testsuite`` options when installed.
  455. * Fix crash with AST checkers when the syntax is invalid. (Issue #160)
  456. * Read from standard input if no path is specified.
  457. * Initiate a graceful shutdown on ``Control+C``.
  458. * Allow changing the ``checker_class`` for the ``StyleGuide``.
  459. 1.4.2 (2013-02-10)
  460. ------------------
  461. * Support AST checkers provided by third-party applications.
  462. * Register new checkers with ``register_check(func_or_cls, codes)``.
  463. * Allow constructing a ``StyleGuide`` with a custom parser.
  464. * Accept visual indentation without parenthesis after the ``if``
  465. statement. (Issue #151)
  466. * Fix UnboundLocalError when using ``# noqa`` with continued lines.
  467. (Issue #158)
  468. * Re-order the lines for the ``StandardReport``.
  469. * Expand tabs when checking E12 continuation lines. (Issue #155)
  470. * Refactor the testing class ``TestReport`` and the specific test
  471. functions into a separate test module.
  472. 1.4.1 (2013-01-18)
  473. ------------------
  474. * Allow sphinx.ext.autodoc syntax for comments. (Issue #110)
  475. * Report E703 instead of E702 for the trailing semicolon. (Issue #117)
  476. * Honor ``# noqa`` in addition to ``# nopep8``. (Issue #149)
  477. * Expose the ``OptionParser`` factory for better extensibility.
  478. 1.4 (2012-12-22)
  479. ----------------
  480. * Report E226 instead of E225 for optional whitespace around common
  481. operators (``*``, ``**``, ``/``, ``+`` and ``-``). This new error
  482. code is ignored in the default configuration because PEP 8 recommends
  483. to "use your own judgement". (Issue #96)
  484. * Lines with a ``# nopep8`` at the end will not issue errors on line
  485. length E501 or continuation line indentation E12*. (Issue #27)
  486. * Fix AssertionError when the source file contains an invalid line
  487. ending ``"\r\r\n"``. (Issue #119)
  488. * Read the ``[pep8]`` section of ``tox.ini`` or ``setup.cfg`` if present.
  489. (Issue #93 and #141)
  490. * Add the Sphinx-based documentation, and publish it
  491. on https://pycodestyle.readthedocs.io/. (Issue #105)
  492. 1.3.4 (2012-12-18)
  493. ------------------
  494. * Fix false positive E124 and E128 with comments. (Issue #100)
  495. * Fix error on stdin when running with bpython. (Issue #101)
  496. * Fix false positive E401. (Issue #104)
  497. * Report E231 for nested dictionary in list. (Issue #142)
  498. * Catch E271 at the beginning of the line. (Issue #133)
  499. * Fix false positive E126 for multi-line comments. (Issue #138)
  500. * Fix false positive E221 when operator is preceded by a comma. (Issue #135)
  501. * Fix ``--diff`` failing on one-line hunk. (Issue #137)
  502. * Fix the ``--exclude`` switch for directory paths. (Issue #111)
  503. * Use ``-`` filename to read from standard input. (Issue #128)
  504. 1.3.3 (2012-06-27)
  505. ------------------
  506. * Fix regression with continuation line checker. (Issue #98)
  507. 1.3.2 (2012-06-26)
  508. ------------------
  509. * Revert to the previous behaviour for ``--show-pep8``:
  510. do not imply ``--first``. (Issue #89)
  511. * Add E902 for IO errors. (Issue #87)
  512. * Fix false positive for E121, and missed E124. (Issue #92)
  513. * Set a sensible default path for config file on Windows. (Issue #95)
  514. * Allow ``verbose`` in the configuration file. (Issue #91)
  515. * Show the enforced ``max-line-length`` in the error message. (Issue #86)
  516. 1.3.1 (2012-06-18)
  517. ------------------
  518. * Explain which configuration options are expected. Accept and recommend
  519. the options names with hyphen instead of underscore. (Issue #82)
  520. * Do not read the user configuration when used as a module
  521. (except if ``config_file=True`` is passed to the ``StyleGuide`` constructor).
  522. * Fix wrong or missing cases for the E12 series.
  523. * Fix cases where E122 was missed. (Issue #81)
  524. 1.3 (2012-06-15)
  525. ----------------
  526. .. warning::
  527. The internal API is backwards incompatible.
  528. * Remove global configuration and refactor the library around
  529. a ``StyleGuide`` class; add the ability to configure various
  530. reporters. (Issue #35 and #66)
  531. * Read user configuration from ``~/.config/pep8``
  532. and local configuration from ``./.pep8``. (Issue #22)
  533. * Fix E502 for backslash embedded in multi-line string. (Issue #68)
  534. * Fix E225 for Python 3 iterable unpacking (PEP 3132). (Issue #72)
  535. * Enable the new checkers from the E12 series in the default
  536. configuration.
  537. * Suggest less error-prone alternatives for E712 errors.
  538. * Rewrite checkers to run faster (E22, E251, E27).
  539. * Fixed a crash when parsed code is invalid (too many
  540. closing brackets).
  541. * Fix E127 and E128 for continuation line indentation. (Issue #74)
  542. * New option ``--format`` to customize the error format. (Issue #23)
  543. * New option ``--diff`` to check only modified code. The unified
  544. diff is read from STDIN. Example: ``hg diff | pep8 --diff``
  545. (Issue #39)
  546. * Correctly report the count of failures and set the exit code to 1
  547. when the ``--doctest`` or the ``--testsuite`` fails.
  548. * Correctly detect the encoding in Python 3. (Issue #69)
  549. * Drop support for Python 2.3, 2.4 and 3.0. (Issue #78)
  550. 1.2 (2012-06-01)
  551. ----------------
  552. * Add E121 through E128 for continuation line indentation. These
  553. checks are disabled by default. If you want to force all checks,
  554. use switch ``--select=E,W``. Patch by Sam Vilain. (Issue #64)
  555. * Add E721 for direct type comparisons. (Issue #47)
  556. * Add E711 and E712 for comparisons to singletons. (Issue #46)
  557. * Fix spurious E225 and E701 for function annotations. (Issue #29)
  558. * Add E502 for explicit line join between brackets.
  559. * Fix E901 when printing source with ``--show-source``.
  560. * Report all errors for each checker, instead of reporting only the
  561. first occurrence for each line.
  562. * Option ``--show-pep8`` implies ``--first``.
  563. 1.1 (2012-05-24)
  564. ----------------
  565. * Add E901 for syntax errors. (Issues #63 and #30)
  566. * Add E271, E272, E273 and E274 for extraneous whitespace around
  567. keywords. (Issue #57)
  568. * Add ``tox.ini`` configuration file for tests. (Issue #61)
  569. * Add ``.travis.yml`` configuration file for continuous integration.
  570. (Issue #62)
  571. 1.0.1 (2012-04-06)
  572. ------------------
  573. * Fix inconsistent version numbers.
  574. 1.0 (2012-04-04)
  575. ----------------
  576. * Fix W602 ``raise`` to handle multi-char names. (Issue #53)
  577. 0.7.0 (2012-03-26)
  578. ------------------
  579. * Now ``--first`` prints only the first occurrence of each error.
  580. The ``--repeat`` flag becomes obsolete because it is the default
  581. behaviour. (Issue #6)
  582. * Allow specifying ``--max-line-length``. (Issue #36)
  583. * Make the shebang more flexible. (Issue #26)
  584. * Add testsuite to the bundle. (Issue #25)
  585. * Fixes for Jython. (Issue #49)
  586. * Add PyPI classifiers. (Issue #43)
  587. * Fix the ``--exclude`` option. (Issue #48)
  588. * Fix W602, accept ``raise`` with 3 arguments. (Issue #34)
  589. * Correctly select all tests if ``DEFAULT_IGNORE == ''``.
  590. 0.6.1 (2010-10-03)
  591. ------------------
  592. * Fix inconsistent version numbers. (Issue #21)
  593. 0.6.0 (2010-09-19)
  594. ------------------
  595. * Test suite reorganized and enhanced in order to check more failures
  596. with fewer test files. Read the ``run_tests`` docstring for details
  597. about the syntax.
  598. * Fix E225: accept ``print >>sys.stderr, "..."`` syntax.
  599. * Fix E501 for lines containing multibyte encoded characters. (Issue #7)
  600. * Fix E221, E222, E223, E224 not detected in some cases. (Issue #16)
  601. * Fix E211 to reject ``v = dic['a'] ['b']``. (Issue #17)
  602. * Exit code is always 1 if any error or warning is found. (Issue #10)
  603. * ``--ignore`` checks are now really ignored, especially in
  604. conjunction with ``--count``. (Issue #8)
  605. * Blank lines with spaces yield W293 instead of W291: some developers
  606. want to ignore this warning and indent the blank lines to paste their
  607. code easily in the Python interpreter.
  608. * Fix E301: do not require a blank line before an indented block. (Issue #14)
  609. * Fix E203 to accept NumPy slice notation ``a[0, :]``. (Issue #13)
  610. * Performance improvements.
  611. * Fix decoding and checking non-UTF8 files in Python 3.
  612. * Fix E225: reject ``True+False`` when running on Python 3.
  613. * Fix an exception when the line starts with an operator.
  614. * Allow a new line before closing ``)``, ``}`` or ``]``. (Issue #5)
  615. 0.5.0 (2010-02-17)
  616. ------------------
  617. * Changed the ``--count`` switch to print to sys.stderr and set
  618. exit code to 1 if any error or warning is found.
  619. * E241 and E242 are removed from the standard checks. If you want to
  620. include these checks, use switch ``--select=E,W``. (Issue #4)
  621. * Blank line is not mandatory before the first class method or nested
  622. function definition, even if there's a docstring. (Issue #1)
  623. * Add the switch ``--version``.
  624. * Fix decoding errors with Python 3. (Issue #13 [1]_)
  625. * Add ``--select`` option which is mirror of ``--ignore``.
  626. * Add checks E261 and E262 for spaces before inline comments.
  627. * New check W604 warns about deprecated usage of backticks.
  628. * New check W603 warns about the deprecated operator ``<>``.
  629. * Performance improvement, due to rewriting of E225.
  630. * E225 now accepts:
  631. - no whitespace after unary operator or similar. (Issue #9 [1]_)
  632. - lambda function with argument unpacking or keyword defaults.
  633. * Reserve "2 blank lines" for module-level logical blocks. (E303)
  634. * Allow multi-line comments. (E302, issue #10 [1]_)
  635. 0.4.2 (2009-10-22)
  636. ------------------
  637. * Decorators on classes and class methods are OK now.
  638. 0.4 (2009-10-20)
  639. ----------------
  640. * Support for all versions of Python from 2.3 to 3.1.
  641. * New and greatly expanded self tests.
  642. * Added ``--count`` option to print the total number of errors and warnings.
  643. * Further improvements to the handling of comments and blank lines.
  644. (Issue #1 [1]_ and others changes.)
  645. * Check all py files in directory when passed a directory (Issue
  646. #2 [1]_). This also prevents an exception when traversing directories
  647. with non ``*.py`` files.
  648. * E231 should allow commas to be followed by ``)``. (Issue #3 [1]_)
  649. * Spaces are no longer required around the equals sign for keyword
  650. arguments or default parameter values.
  651. .. [1] These issues refer to the `previous issue tracker`__.
  652. .. __: http://github.com/cburroughs/pep8.py/issues
  653. 0.3.1 (2009-09-14)
  654. ------------------
  655. * Fixes for comments: do not count them when checking for blank lines between
  656. items.
  657. * Added setup.py for pypi upload and easy_installability.
  658. 0.2 (2007-10-16)
  659. ----------------
  660. * Loads of fixes and improvements.
  661. 0.1 (2006-10-01)
  662. ----------------
  663. * First release.