Python

Google Python Style Guide

Official Google Python coding standards extending PEP 8.

Golden Rules

1. Follow PEP 8 as baseline — Google's guide extends it 2. Use type annotations for all public functions and methods 3. 4-space indentation — no tabs 4. Maximum line length: 80 characters 5. Docstrings mandatory for all public modules, functions, classes, methods 6. Prefer comprehensions over map()/filter() 7. Use f-strings for string formatting (Python 3.6+)

Quick Reference

Naming Conventions

Type Annotations

# ✓ CORRECT
def get_user(user_id: int) -> Optional[dict]:
    ...

def process_items(items: List[str], max_count: int = 10) -> List[str]:
    ...

# ✗ INCORRECT
def get_user(user_id):  # missing type annotations
    ...

Docstrings (Google Style)

def fetch_data(url: str, timeout: int = 30) -> dict:
    """Fetches data from the given URL.

    Args:
        url: The URL to fetch data from.
        timeout: Request timeout in seconds. Defaults to 30.

    Returns:
        A dictionary containing the response data.

    Raises:
        ValueError: If the URL is invalid.
    """
    ...

Imports

# ✓ CORRECT - stdlib, then third-party, then local
import os
import sys
from typing import Optional, List

import numpy as np

from myproject import utils

# ✗ INCORRECT
import os, sys        # one import per line
from os.path import * # never wildcard imports

String Formatting

# ✓ CORRECT - f-strings
name = "Alice"
greeting = f"Hello, {name}!"

# ✗ INCORRECT
greeting = "Hello, " + name + "!"    # use f-strings
greeting = "Hello, %s!" % name       # use f-strings

Comprehensions

# ✓ CORRECT
squares = [x ** 2 for x in range(10)]
user_map = {user.id: user for user in users}
evens = [x for x in range(20) if x % 2 == 0]

# ✗ INCORRECT
squares = list(map(lambda x: x ** 2, range(10)))  # use comprehension

Exception Handling

# ✓ CORRECT - catch specific exceptions
try:
    data = json.loads(raw_input)
except json.JSONDecodeError as e:
    raise ValueError(f"Could not parse: {e}") from e

# ✗ INCORRECT
try:
    ...
except:     # never bare except
    pass

Default Arguments

# ✗ INCORRECT - mutable default arguments
def add_item(item: str, items: List[str] = []) -> List[str]:  # BAD!
    items.append(item)
    return items

# ✓ CORRECT - use None for mutable defaults
def add_item(item: str, items: Optional[List[str]] = None) -> List[str]:
    if items is None:
        items = []
    items.append(item)
    return items

Common Mistakes

When to Use This Guide

• Writing new Python code
• Refactoring existing Python
• Code reviews
• Setting up linting rules (pylint, flake8)
• Onboarding new team members

Install

npx skills add testdino-hq/google-styleguides-skills/python

Full Guide

See python.md for complete details, examples, and edge cases.

Google Python Style Guide

Source: https://google.github.io/styleguide/pyguide.html

Golden Rules

1. Follow PEP 8 as baseline — Google's guide extends it 2. Use type annotations for all public functions and methods 3. 4-space indentation — no tabs 4. Maximum line length: 80 characters 5. Docstrings mandatory for all public modules, functions, classes, methods 6. Prefer comprehensions over map()/filter() 7. Use f-strings for string formatting (Python 3.6+)

---

1. Imports

# CORRECT - stdlib, then third-party, then local
import os
import sys
from typing import Optional, List

import numpy as np

from myproject import utils

# INCORRECT
import os, sys        # one import per line
from os.path import * # never wildcard imports

---

2. Type Annotations

# CORRECT
def get_user(user_id: int) -> Optional[dict]:
    ...

def process_items(items: List[str], max_count: int = 10) -> List[str]:
    ...

# INCORRECT
def get_user(user_id):  # add type annotations
    ...

---

3. Docstrings (Google Style)

def fetch_data(url: str, timeout: int = 30) -> dict:
    """Fetches data from the given URL.

    Args:
        url: The URL to fetch data from.
        timeout: Request timeout in seconds. Defaults to 30.

    Returns:
        A dictionary containing the response data.

    Raises:
        ValueError: If the URL is invalid.
    """
    ...

---

4. Naming Conventions

---

5. Strings

# CORRECT - f-strings
name = "Alice"
greeting = f"Hello, {name}!"

# INCORRECT
greeting = "Hello, " + name + "!"    # use f-strings
greeting = "Hello, %s!" % name       # use f-strings

---

6. Comprehensions

# CORRECT
squares = [x ** 2 for x in range(10)]
user_map = {user.id: user for user in users}
unique_names = {user.name for user in users}
evens = [x for x in range(20) if x % 2 == 0]

# INCORRECT
squares = list(map(lambda x: x ** 2, range(10)))  # use comprehension

---

7. Exception Handling

# CORRECT - catch specific exceptions
try:
    data = json.loads(raw_input)
except json.JSONDecodeError as e:
    raise ValueError(f"Could not parse: {e}") from e

# CORRECT - use context managers
with open("data.txt") as file:
    content = file.read()

# INCORRECT
try:
    ...
except:     # never bare except
    pass

---

8. Default Arguments

# INCORRECT - mutable default arguments
def add_item(item: str, items: List[str] = []) -> List[str]:  # BAD!
    items.append(item)
    return items

# CORRECT - use None for mutable defaults
def add_item(item: str, items: Optional[List[str]] = None) -> List[str]:
    if items is None:
        items = []
    items.append(item)
    return items

---

Common Mistakes