Python

Resources on this site

• Syntax

• Variables, Data Types, Expressions, Operators

• Output Formatting

• Conditions

• Loops

• Functions

• Files

• Strings

• Collections

• Classes and Objects

• Quality & Deployment

• Math

Structure / Style / Security

• PEP 8 -- Style Guide for Python Code

  • Highlights

    • Maximum line length 79 characters

    • Blank lines

    • Comments

    • Naming conventions

• Bandit

• See Recommended Settings on the PyCharm page

Documentation

Docstrings

• Complete sentences inside triple double quotes

• One at the top of each file

  • a description of the file

  • __author__ = "Your Name" (not technically a docstring)

Example

"""My Sweet Integration Program"""

__author__ = "Jeff Lamont"

• One under each function header

  • describe what the function does, not how

  • should include information about parameters and return values

Example

def get_bmr(height, weight):

"""The purpose of this function is to determine the user's basal metabolic rate (bmr) by asking a few questions and plugging them into a formula.

height - an integer in centimeters

weight - an integer in kilograms"""

• Python Docstrings geeksforgeeks

• PEP 257 -- Docstring Conventions

• If written properly, you can see the docstring from the interpreter or Python Console in PyCharm by importing the file name (without the file extension) and then typing help and the file name inside parentheses

import filename

help(filename)

help(filename.function_name)

Example

import Main

help(Main)

help(Main.calc_area)

The program should not run when you do import, if it does, you need to put all code in a function, use a main function, and replace the call to main with:

if __name__ == "__main__":
main()

More info