Style Guidelines

PEP8 is the industrial fundamental. You can also check Style Guides for Google, which gives more specifications than PEP8.

VSCode Setup

Additionally, here is my settings in VSCode. If you have installed these plugins on VS Code, you can directly copy-paste my settings to yours if you like.

• Python

  Note

  Pylance (Python language support) is installed automatically)

• iSort

• Black Formatter

• autoDocstring

Copy-paste the following block to your VSCode settings.json.

"[python]": {
    "editor.codeActionsOnSave": {
        "source.organizeImports": "explicit"
    },
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnType": true,
},
"python.analysis.typeCheckingMode": "basic",
"python.analysis.completeFunctionParens": true,
"python.analysis.addImport.exactMatchOnly": true,
"python.analysis.diagnosticSeverityOverrides": {
    "reportOptionalMemberAccess": "none",
    "reportOptionalSubscript": "none",
    "reportOptionalOperand": "none",
    "reportOptionalCall": "none",
    "reportUnusedVariable": "warning",
    "reportUnusedClass": "warning",
    "reportUnusedExpression": "warning",
    "reportUnusedFunction": "warning",
    "reportUnusedImport": "warning",
},
"python.testing.pytestEnabled": true,
"python.testing.pytestArgs": [
    "tests"
],
"python.analysis.autoFormatStrings": true,