arabelatso/skills-4-se/code-smell-detector

# Check project structure
ls -la
 
# Count Python files
find . -name "*.py" | wc -l
 
# Identify large files (potential smells)
find . -name "*.py" -exec wc -l {} + | sort -rn | head -10

# Scan entire project
python scripts/detect_smells.py /path/to/project
 
# Exclude specific directories
python scripts/detect_smells.py /path/to/project venv,tests,docs

# Find long files (potential large classes)
find . -name "*.py" -exec wc -l {} + | awk '$1 > 300'
 
# Find magic numbers (basic pattern)
grep -r "[^0-9]\d\{3,\}" --include="*.py" .
 
# Find hardcoded paths
grep -r '"/.*/"' --include="*.py" .
 
# Find commented code
grep -r "^[ ]*#.*def \|^[ ]*#.*class " --include="*.py" .

# Install
pip install radon
 
# Check cyclomatic complexity
radon cc /path/to/project -a
 
# Maintainability index
radon mi /path/to/project
 
# Show only complex functions
radon cc /path/to/project -nc

pip install pylint
 
# Check for code smells
pylint /path/to/project --disable=C0111  # Disable docstring warnings

# Before: God class with 28 methods
class UserManager:
    def create_user(self, data): pass
    def update_user(self, user_id, data): pass
    def delete_user(self, user_id): pass
    def authenticate(self, username, password): pass
    def hash_password(self, password): pass
    def send_welcome_email(self, user): pass
    def send_password_reset(self, user): pass
    def log_activity(self, user, action): pass
    def get_statistics(self, user): pass
    # ... 19 more methods
# After: Split by responsibility
class UserRepository:
    """Handles user persistence."""
    def create(self, data): pass
    def update(self, user_id, data): pass
    def delete(self, user_id): pass
    def find_by_id(self, user_id): pass
class UserAuthService:
    """Handles authentication."""
    def authenticate(self, username, password): pass
    def hash_password(self, password): pass
    def validate_password_strength(self, password): pass
class UserNotificationService:
    """Handles user notifications."""
    def send_welcome_email(self, user): pass
    def send_password_reset(self, user): pass
class UserAnalyticsService:
    """Handles user analytics."""
    def log_activity(self, user, action): pass
    def get_statistics(self, user): pass

# Before: Feature envy
class Order:
    def calculate_total(self):
        discount = self.customer.get_discount_rate()
        is_premium = self.customer.is_premium_member()
        address = self.customer.get_shipping_address()
        total = sum(item.price for item in self.items)
        if is_premium:
            total *= (1 - discount)
        if address.country != 'US':
            total += 50
        return total
# After: Move to appropriate class
class Customer:
    def calculate_order_total(self, items):
        total = sum(item.price for item in items)
        if self.is_premium_member():
            total *= (1 - self.get_discount_rate())
        if self.shipping_address.country != 'US':
            total += 50
        return total
class Order:
    def calculate_total(self):
        return self.customer.calculate_order_total(self.items)

# Before: Duplicate code
class UserValidator:
    def validate(self, data):
        if not data.get('email') or '@' not in data['email']:
            raise ValueError("Invalid email")
        if not data.get('name') or len(data['name']) < 2:
            raise ValueError("Invalid name")
        # ... more validation
class ProfileValidator:
    def validate(self, data):
        if not data.get('email') or '@' not in data['email']:
            raise ValueError("Invalid email")
        if not data.get('name') or len(data['name']) < 2:
            raise ValueError("Invalid name")
        # ... more validation
# After: Extract common validation
class ValidationHelpers:
    @staticmethod
    def validate_email(email):
        if not email or '@' not in email:
            raise ValueError("Invalid email")
    @staticmethod
    def validate_name(name):
        if not name or len(name) < 2:
            raise ValueError("Invalid name")
class UserValidator:
    def validate(self, data):
        ValidationHelpers.validate_email(data.get('email'))
        ValidationHelpers.validate_name(data.get('name'))
        # ... more validation
class ProfileValidator:
    def validate(self, data):
        ValidationHelpers.validate_email(data.get('email'))
        ValidationHelpers.validate_name(data.get('name'))
        # ... more validation

# Before: Data clumps
def send_email(name, email, phone, street, city, zip_code):
    pass
def send_sms(name, email, phone, street, city, zip_code):
    pass
def send_notification(name, email, phone, street, city, zip_code):
    pass
# After: Parameter object
from dataclasses import dataclass
@dataclass
class Address:
    street: str
    city: str
    zip_code: str
@dataclass
class ContactInfo:
    name: str
    email: str
    phone: str
    address: Address
def send_email(contact: ContactInfo):
    pass
def send_sms(contact: ContactInfo):
    pass
def send_notification(contact: ContactInfo):
    pass

# Before: Magic numbers
def calculate_discount(price):
    if price > 1000:
        return price * 0.15
    elif price > 500:
        return price * 0.10
    else:
        return price * 0.05
# After: Named constants
BULK_ORDER_THRESHOLD = 1000
LARGE_ORDER_THRESHOLD = 500
BULK_DISCOUNT_RATE = 0.15
LARGE_DISCOUNT_RATE = 0.10
STANDARD_DISCOUNT_RATE = 0.05
def calculate_discount(price):
    if price > BULK_ORDER_THRESHOLD:
        return price * BULK_DISCOUNT_RATE
    elif price > LARGE_ORDER_THRESHOLD:
        return price * LARGE_DISCOUNT_RATE
    else:
        return price * STANDARD_DISCOUNT_RATE