Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

METADATA 27KB

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