Get even numbers

[Vahablotfi]

---

name: Get even numbers
about: Python function that takes a list of integers as input and returns a list of all even numbers from the input list.

---

The challenge is to create a Python function that takes a list of integers as input and returns a list of all even numbers from the input list.

Behavior

The function accepts a list of integers as input.
It filters the list to include only even numbers.
It returns a new list containing all even numbers from the input.

Files

• The file name describes the function's behavior
• There is a module docstring in the function file
• The test file's name matches the function file name -
  /tests/test_file_name.py
• There is a module docstring in the tests file

Unit Tests

• The test class has a helpful name in PascalCase
• The test class has a docstring
• Every unit test has
  • A helpful name
  • A clear docstring
  • Only one assertion
  • There is no logic in the unit test
• All tests pass
• There are tests for defensive assertions
• There are tests for boundary cases

Function Docstring

• The function's behavior is described
• The function's arguments are described:
  • Type
  • Purpose
  • Other assumptions (eg. if it's a number, what's the expected range?)
• The return value is described
  • Type
  • Other assumptions are documented
• The defensive assertions are documented using Raises:
  • Each assumption about an argument is checked with an assertion
  • Each assertion checks for only one assumption about the argument
• Include 3 or more (passing!) doctests

The Function

• The function's name describes it's behavior
• The function's name matches the file name
• The function has correct type annotations
• The function is not called in the function file

Strategy

Do's

• Variable names help to understand the strategy
• Any comments are clear and describe the strategy
• Lines of code are spaced to help show different stages of the strategy

Don'ts

• The function's strategy is not described in the documentation
• Comments explain the strategy, not the implementation
• The function does not have more comments than code
  • If it does, consider finding a new strategy or a simpler implementation

Implementation

• The code passes the formatting checks
• The code passes all Ruff linting checks
• The code has no (reasonable) Pylint errors
  • In code review, you can decide when fixing a Pylint error is helpful and
    when it's too restricting.
• Variables are named with snake_case
• Variable names are clear and helpful
• The code follows the strategy as simply as possible
• The implementation is as simple as possible given the strategy
• There are no commented lines of code
• There are no print statements anywhere
• The code includes defensive assertions
• Defensive assertions include as little logic as possible

[Vahablotfi]

To test this PR update the main branch in your local machine, then checkout to get_even_numbers by running git checkout get_even_numbers. Once you have the files on your local machine you can run python3 -m unittest solutions.tests.test_get_even_numbers (you must be in the root directory of the project) to check the unit test, and to check the doctest, you can navigate to solutions directory and run python3 -m doctest -v get_even_numbers.py.

[Melat-arch]

Great job on implementing the get_even_numbers function! Your code is well-structured, and the docstring is comprehensive, clearly explaining the function's behavior, parameters, and return value, along with useful doctests. The checks to ensure the input is a list of integers show solid defensive programming. Consider highlighting your assumptions in the code with inline comments, especially where you enforce type checks with TypeError. Overall, your implementation is clear and effective, with only minor areas for improvement to enhance robustness and maintainability. Keep up the excellent work!