Funktionierender Prototyp des Serious Games zur Vermittlung von Wissen zu Software-Engineering-Arbeitsmodellen.
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 31KB

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