In this challenge, you will focus on improving code readability by renaming variables and functions that currently have unclear or misleading names. **Clear and descriptive naming** is a key aspect of code quality, making your code easier to understand and maintain. Your task is to identify **poorly named elements** in the provided code and rename them to better reflect their purpose and behavior.


import unittest
import user_code
import ast
import re   
import unittest
import importlib
import io
from contextlib import redirect_stdout

class TestTask(unittest.TestCase):
    def test_function_name(self):
        import user_code
        importlib.reload(user_code)
        func = getattr(user_code, 'sum_positive_numbers', None)
        _dynamic_test(
            self,
            callable(func),
            "Function is renamed to 'sum_positive_numbers' and is callable",
            "Function 'sum_positive_numbers' not found or not callable",
        )

    def test_variable_name(self):
        import user_code
        importlib.reload(user_code)
        var = getattr(user_code, 'numbers_list', None)
        _dynamic_test(
            self,
            isinstance(var, list) and var == [3, -1, 4, -2, 5],
            "Variable is renamed to 'numbers_list' and has correct value",
            f"Variable 'numbers_list' not found or has wrong value: {var}",
        )

    def test_function_behavior(self):
        import user_code
        importlib.reload(user_code)
        func = getattr(user_code, 'sum_positive_numbers', None)
        result = func([3, -1, 4, -2, 5])
        _dynamic_test(
            self,
            result == 12,
            "Function returns correct sum of positive numbers",
            f"Function returned {result} instead of 12",
        )

    def test_print_output(self):
        import user_code
        importlib.reload(user_code)
        f = io.StringIO()
        with redirect_stdout(f):
            importlib.reload(user_code)
        output = normalize_text(f.getvalue())
        expected = normalize_text("12")
        _dynamic_test(
            self,
            expected in output,
            f"Output includes '12'",
            f"Expected output: '12' not found in: {output}",
        )

    def test_no_old_names(self):
        import user_code
        importlib.reload(user_code)
        has_f1 = hasattr(user_code, 'f1')
        has_nums = hasattr(user_code, 'nums')
        _dynamic_test(
            self,
            not has_f1 and not has_nums,
            "Old names 'f1' and 'nums' are removed",
            "Old names 'f1' or 'nums' are still present in the code",
        )

def _dynamic_test(test_case, condition, success_message, failure_message):
    if condition:
        test_case._testMethodName = success_message
        test_case.assertTrue(True, success_message)
    else:
        test_case._testMethodName = failure_message
        test_case.fail(failure_message)

def normalize_text(text):
    text = text.lower()
    text = re.sub(r"\s{2,}", " ", text)
    text = re.sub(r"\s*([,:?])\s*", r"\1 ", text)
    return text.strip()

def change_var(code: str, var_name: str, value: str) -> str:
    tree = ast.parse(code)
    lines = code.splitlines()
    for i, node in enumerate(tree.body):
        if isinstance(node, ast.Assign):
            for target in node.targets:
                if isinstance(target, ast.Name) and target.id == var_name:
                    start_line = node.lineno - 1
                    line = lines[start_line]
                    indent = ' ' * (len(line) - len(line.lstrip()))
                    lines[start_line] = f"{indent}{var_name} = {value}"
                    next_line = len(lines)
                    for next_node in tree.body[i+1:]:
                        if hasattr(next_node, 'lineno'):
                            next_line = next_node.lineno - 1
                            break
                    if next_line > start_line + 1:
                        lines[start_line+1:next_line] = []
                    
                    return '\\n'.join(lines)
    return code

if __name__ == "__main__":
    unittest.main()


test_main.py

Master the principles of writing clean, maintainable, and efficient Python code. Learn to identify code smells, apply refactoring techniques, and adopt best practices for code quality. Practice your skills with hands-on tasks designed for those familiar with basic Python syntax.

Explore the fundamental concepts of code quality, why it matters, and how to recognize poor code in Python.

Delve into practical refactoring methods to enhance Python code structure and eliminate code smells.

Adopt Pythonic conventions and idioms to write elegant, efficient, and maintainable code.

Learn strategies for maintaining code quality over time, including documentation, testing, and code reviews.

Challenge: Rename for Clarity

Lösung

Awesome!

Challenge: Rename for Clarity

Lösung