Style Guide For Python Code

Start from the beginning
                                        

                                   var_three, var_four)

          # More indentation included to distinguish this from the rest.

          def long_function_name(

                  var_one, var_two, var_three,

                  var_four):

              print(var_one)

    No:   # Arguments on first line forbidden when not using vertical alignment

          foo = long_function_name(var_one, var_two,

              var_three, var_four)

          # Further indentation required as indentation is not distinguishable

          def long_function_name(

              var_one, var_two, var_three,

              var_four):

              print(var_one)

    Optional:

          # Extra indentation is not necessary.

          foo = long_function_name(

            var_one, var_two,

            var_three, var_four)

  Tabs or Spaces?

    Never mix tabs and spaces.

    The most popular way of indenting Python is with spaces only.  The

    second-most popular way is with tabs only.  Code indented with a mixture

    of tabs and spaces should be converted to using spaces exclusively.  When

    invoking the Python command line interpreter with the -t option, it issues

    warnings about code that illegally mixes tabs and spaces.  When using -tt

    these warnings become errors.  These options are highly recommended!

    For new projects, spaces-only are strongly recommended over tabs.  Most

    editors have features that make this easy to do.

  Maximum Line Length

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character

    lines; plus, limiting windows to 80 characters makes it possible to have

    several windows side-by-side.  The default wrapping on such devices

    disrupts the visual structure of the code, making it more difficult to

    understand.  Therefore, please limit all lines to a maximum of 79

    characters.  For flowing long blocks of text (docstrings or comments),

    limiting the length to 72 characters is recommended.

    The preferred way of wrapping long lines is by using Python's implied line

    continuation inside parentheses, brackets and braces.  Long lines can be

    broken over multiple lines by wrapping expressions in parentheses. These

Docstring ConventionsWhere stories live. Discover now