#Python indent block of text code#

When the code needs to remain compatible with older versions of Python that don’t support the feature recommended by the style guide.Ĭontinuation lines should align wrapped elements either vertically using Python’s implicit line joining inside parentheses, brackets and braces, or using a hanging indent 3.

Because the code in question predates the introduction of the guideline and there is no other reason to be modifying that code.

To be consistent with surrounding code that also breaks it (maybe for historic reasons) – although this is also an opportunity to clean up someone else’s mess (in true XP style).

When applying the guideline would make the code less readable, even for someone who is used to reading code that follows this PEP.Some other good reasons to ignore a particular guideline: In particular: do not break backwards compatibility just to comply with this PEP! Look at other examples and decide what looks best. However, know when to be inconsistent-sometimes style guide recommendations just aren't applicable. Consistency within one module or function is the most important. Consistency within a project is more important. Consistency with this style guide is important. As PEP 20 says, “Readability counts”.Ī style guide is about consistency. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. One of Guido’s key insights is that code is read much more often than it is written. A Foolish Consistency is the Hobgoblin of Little Minds In the event of any conflicts, such project-specific guides take precedence for that project. Many projects have their own coding style guidelines. This style guide evolves over time as additional conventions are identified and past conventions are rendered obsolete by changes in the language itself. This document and PEP 257 (Docstring Conventions) were adapted from Guido’s original Python Style Guide essay, with some additions from Barry’s style guide 2. Please see the companion informational PEP describing style guidelines for the C code in the C implementation of Python 1. Use the following example code to test the behavior described above by evaluating the two commented blocks using Run Selection/Line in Python Terminal functionality.This document gives coding conventions for the Python code comprising the standard library in the main Python distribution. This behavior makes this sort of workflow a little difficult.

I tend to work 'bottom-up', evaluating/debugging smaller pieces of code that form more complex functions, and those individual pieces are obviously indented. should be first deindented to a 'base level' before sending to the terminal?).Īs an example, the indented code above should be sent to the terminal as if it was the following (i.e. It would be useful if the evaluation of indented code worked regardless of it's position or level of indentation in the overall code (i.e. Sending a selected Python code for evaluation in the Python terminal via Run Selection/Line in Python Terminal results in 'IndentationError: unexpected indent' errors if the block of code is indented.Įxample: evaluating the following selection results in an error because of the indentation of the whole block at 4 spaces:

Relevant/affected Python packages and their versions: none.

Python version: 3.7.0, installed via pyenv.

Python indent block of text