[TIPS] Refactoring - Clean Code - Tip 5 - Consistent Coding Style
By JoeVu, at: July 19, 2024, 5:44 p.m.
![[TIPS] Refactoring - Clean Code - Tip 5 - Consistent Coding Style](/media/filer_public_thumbnails/filer_public/c0/a6/c0a6b790-b0d3-49aa-844b-cf11d180d297/refactoring_tips_consistent_coding_style.png__800x600_crop_subsampling-2_upscale.png)
![[TIPS] Refactoring - Clean Code - Tip 5 - Consistent Coding Style](/media/filer_public_thumbnails/filer_public/c0/a6/c0a6b790-b0d3-49aa-844b-cf11d180d297/refactoring_tips_consistent_coding_style.png__400x240_crop_subsampling-2_upscale.png)
Refactoring Tip 5: Consistent Coding Style
-
Junior: Coding style might be inconsistent.
-
Senior: Adheres to PEP 8 and uses tools like
blackandflake8to ensure consistent style.
Consistent coding style is essential for readability and maintainability of the code. Here's an example to illustrate the difference between how a junior and a senior developer might approach this principle.
Example 1: Inconsistent Naming Conventions and Formatting
Junior Developer's Approach
A junior developer might have inconsistent naming conventions and formatting in their code:
import requests
def fetchData(URL):
response = requests.get(URL)
if response.status_code == 200:
return response.json()
else:
return None
def processData(data):
processed_data = []
for item in data:
if item['value'] > 10:
processed_data.append(item)
return processed_data
data = fetchData('https://api.example.com/data')
if data:
processedData = processData(data)
print(processedData)
Senior Developer's Approach
A senior developer would follow PEP 8 guidelines and use tools like black and flake8 to ensure consistent style:
import requests
def fetch_data(url):
response = requests.get(url)
if response.status_code == 200:
return response.json()
return None
def process_data(data):
processed_data = [
item for item in data if item['value'] > 10
]
return processed_data
data = fetch_data('https://api.example.com/data')
if data:
processed_data = process_data(data)
print(processed_data)
Example 2: Inconsistent Indentation and Spacing
Junior Developer's Approach
A junior developer might have inconsistent indentation and spacing in their code:
def calculate_total(items):
total=0
for item in items:
total+=item['price']
return total
items = [{'price': 10}, {'price': 20}, {'price': 30}]
total = calculate_total(items)
print ( total )
Senior Developer's Approach
A senior developer would ensure consistent indentation and spacing, following PEP 8:
def calculate_total(items):
total = 0
for item in items:
total += item['price']
return total
items = [{'price': 10}, {'price': 20}, {'price': 30}]
total = calculate_total(items)
print(total)
Example 3: Using Tools for Consistency
Junior Developer's Approach
A junior developer might not use tools to enforce coding style, leading to inconsistencies:
import requests
def get_data(url): response = requests.get(url); if response.status_code == 200: return response.json(); else: return NonSenior Developer's Approach
A senior developer would use tools like black and flake8 to format the code consistently:
# Run black to format the code
black script.py
# Run flake8 to check for style violations
flake8 script.py
Before running black and flake8:
import requests
def get_data(url):
response = requests.get(url)
if response.status_code == 200:
return response.json()
else:
return None
After running black:
import requests
def get_data(url):
response = requests.get(url)
if response.status_code == 200:
return response.json()
return None
other great tools are https://pre-commit.com/ and https://github.com/4Catalyzer/fourmat.
Key Improvements:
- Consistent Naming Conventions: Follow PEP 8 guidelines for naming variables and functions.
- Consistent Indentation and Spacing: Ensure code is uniformly indented and spaced.
- Use of Formatting Tools: Utilize tools like
blackfor automatic formatting andflake8for style checks.
Consistent coding style improves code readability and maintainability. Using tools like black and flake8 helps enforce these standards, ensuring that the codebase remains clean and consistent.
![[TIPS] Refactoring - Clean Code - Tip 4 - Utilize Python's Built-in Functions and Libraries](/media/filer_public_thumbnails/filer_public/00/72/0072a7b0-eecc-41b6-ada6-c00cc81450ef/refactoring_tips_utilize_pythons_built-in_functions_and_libraries.png__400x240_crop_subsampling-2_upscale.png)
![[TIPS] Refactoring - Clean Code - Tip 3: Break Down Large Functions](/media/filer_public_thumbnails/filer_public/e6/90/e690210a-1482-4d12-8f74-da66f4a3edb5/refactoring_tips_break_down_large_functions.png__400x240_crop_subsampling-2_upscale.png)
![[TIPS] Refactoring - Clean Code - Tip 2 - Use Meaningful Names](/media/filer_public_thumbnails/filer_public/cf/00/cf006c32-762a-43a1-ae41-610a3f7fc9cd/refactoring_tips_meaningful_names.png__400x240_crop_subsampling-2_upscale.png)
