Software Engineering Practices, Part 2
A Summary of lecture "AWS ML Foundations Course", via Udacity
- Code Reviews
Testing and Data Science
Problems that could occur in data science aren't always easily detectable; you might have values being encoded incorrectly, features being used inappropriately, unexpected data breaking assumptions.
To catch these errors, you have to check for the quality and accuracy of your analysis in addition to the quality of your code. Proper testing is necessary to avoid unexpected surprises and have confidence in your results.
TEST DRIVEN DEVELOPMENT: a development process where you write tests for tasks before you even write the code to implement those tasks.
UNIT TEST: a test that covers a "unit" of code, usually a single function, independently from the rest of the program.
- Four ways Data Science Goes Wrong and How Test Driven Data Analysis Can Help: Link
- Ned Batchelder: Getting Started Testing: Slide Deck and Presentation Video
We want to test our functions in a way that is repeatable and automated. Ideally, we'd run a test program that runs all our unit tests and cleanly lets us know which ones failed and which ones succeeded. Fortunately, there are great tools available in Python that we can use to create effective unit tests!
Unit Test Advantages and Disadvantages
The advantage of unit tests is that they are isolated from the rest of your program, and thus, no dependencies are involved. They don't require access to databases, APIs, or other external sources of information. However, passing unit tests isn’t always enough to prove that our program is working successfully. To show that all the parts of our program work with each other properly, communicating and transferring data between them correctly, we use integration tests. In this lesson, we'll focus on unit tests; however, when you start building larger programs, you will want to use integration tests as well.
You can read about integration testing and how integration tests relate to unit tests here. That article contains other very useful links as well.
Unit Testing Tools
pip install -U pytest in your terminal. You can see more information on getting started here.
- Create a test file starting with
- Define unit test functions that start with
test_inside the test file
pytestinto your terminal in the directory of your test file and it will detect these tests for you!
test_ is the default - if you wish to change this, you can learn how to in this
In the test output, periods represent successful unit tests and F's represent failed unit tests. Since all you see is what test functions failed, it's wise to have only one
assert statement per test. Otherwise, you wouldn't know exactly how many tests failed, and which tests failed.
Your tests won't be stopped by failed
assert statements, but it will stop if you have syntax errors.
root@1c2d457fb26f:/home/workspace# pytest ========================================================================== test session starts =========================================================================== platform linux -- Python 3.6.3, pytest-5.4.2, py-1.8.1, pluggy-0.13.1 rootdir: /home/workspace plugins: requests-mock-1.5.2 collected 4 items test_compute_launch.py ..F. [100%] ================================================================================ FAILURES ================================================================================ ___________________________________________________________________ test_days_until_launch_0_negative ____________________________________________________________________ def test_days_until_launch_0_negative(): > assert(days_until_launch(83, 64) == 0) E assert -19 == 0 E + where -19 = days_until_launch(83, 64) test_compute_launch.py:10: AssertionError======================================================================== short test summary info ========================================================================= FAILED test_compute_launch.py::test_days_until_launch_0_negative - assert -19 == 0 ====================================================================== 1 failed, 3 passed in 0.32s =======================================================================
After fixing code,
root@1c2d457fb26f:/home/workspace# pytest ========================================================================== test session starts =========================================================================== platform linux -- Python 3.6.3, pytest-5.4.2, py-1.8.1, pluggy-0.13.1 rootdir: /home/workspace plugins: requests-mock-1.5.2 collected 4 items test_compute_launch.py .... [100%] =========================================================================== 4 passed in 0.05s ============================================================================
Test Driven Development and Data Science
- TEST DRIVEN DEVELOPMENT: writing tests before you write the code that’s being tested. Your test would fail at first, and you’ll know you’ve finished implementing a task when this test passes.
- Tests can check for all the different scenarios and edge cases you can think of, before even starting to write your function. This way, when you do start implementing your function, you can run this test to get immediate feedback on whether it works or not in all the ways you can think of, as you tweak your function.
- When refactoring or adding to your code, tests help you rest assured that the rest of your code didn't break while you were making those changes. Tests also helps ensure that your function behavior is repeatable, regardless of external parameters, such as hardware and time.
Test driven development for data science is relatively new and has a lot of experimentation and breakthroughs appearing, which you can learn more about in the resources below.
Logging is valuable for understanding the events that occur while running your program. For example, if you run your model over night and see that it's producing ridiculous results the next day, log messages can really help you understand more about the context in which this occurred. Lets learn about the qualities that make a log message effective.
Logging is the process of recording messages to describe events that have occurred while running your software. Let's take a look at a few examples, and learn tips for writing good log messages.
Tip: Be professional and clear
Bad: Hmmm... this isn't working??? Bad: idk.... :( Good: Couldn't parse file.
Tip: Be concise and use normal capitalization
Bad: Start Product Recommendation Process Bad: We have completed the steps necessary and will now proceed with the recommendation process for the records in our product database. Good: Generating product recommendations.
Tip: Choose the appropriate level for logging
- DEBUG - level you would use for anything that happens in the program.
- ERROR - level to record any error that occurs
- INFO - level to record all actions that are user-driven or system specific, such as regularly scheduled operations
Tip: Provide any useful information
Bad: Failed to read location data Good: Failed to read location data: store_id 8324971
Code reviews benefit everyone in a team to promote best programming practices and prepare code for production. Let's go over what to look for in a code review and some tips on how to conduct one.
Questions to Ask Yourself When Conducting a Code Review
First, let's look over some of the questions we may ask ourselves while reviewing code. These are simply from the concepts we've covered in these last two lessons!
Is the code clean and modular?
- Can I understand the code easily?
- Does it use meaningful names and whitespace?
- Is there duplicated code?
- Can you provide another layer of abstraction?
- Is each function and module necessary?
- Is each function or module too long?
Is the code efficient?
- Are there loops or other steps we can vectorize?
- Can we use better data structures to optimize any steps?
- Can we shorten the number of calculations needed for any steps?
- Can we use generators or multiprocessing to optimize any steps?
Is documentation effective?
- Are in-line comments concise and meaningful?
- Is there complex code that's missing documentation?
- Do function use effective docstrings?
- Is the necessary project documentation provided?
Is the code well tested?
- Does the code high test coverage?
- Do tests check for interesting cases?
- Are the tests readable?
- Can the tests be made more efficient?
Is the logging effective?
- Are log messages clear, concise, and professional?
- Do they include all relevant and useful information?
- Do they use the appropriate logging level?
Tips for Conducting a Code Review
Now that we know what we are looking for, let's go over some tips on how to actually write your code review. When your coworker finishes up some code that they want to merge to the team's code base, they might send it to you for review. You provide feedback and suggestions, and then they may make changes and send it back to you. When you are happy with the code, you approve and it gets merged to the team's code base.
As you may have noticed, with code reviews you are now dealing with people, not just computers. So it's important to be thoughtful of their ideas and efforts. You are in a team and there will be differences in preferences. The goal of code review isn't to make all code follow your personal preferences, but a standard of quality for the whole team.
Tip: Use a code linter
This isn't really a tip for code review, but can save you lots of time from code review! Using a Python code linter like pylint can automatically check for coding standards and PEP 8 guidelines for you! It's also a good idea to agree on a style guide as a team to handle disagreements on code style, whether that's an existing style guide or one you create together incrementally as a team.
Tip: Explain issues and make suggestions
Rather than commanding people to change their code a specific way because it's better, it will go a long way to explain to them the consequences of the current code and suggest changes to improve it. They will be much more receptive to your feedback if they understand your thought process and are accepting recommendations, rather than following commands. They also may have done it a certain way intentionally, and framing it as a suggestion promotes a constructive discussion, rather than opposition.
BAD: Make model evaluation code its own module - too repetitive. BETTER: Make the model evaluation code its own module. This will simplify models.py to be less repetitive and focus primarily on building models. GOOD: How about we consider making the model evaluation code its own module? This would simplify models.py to only include code for building models. Organizing these evaluations methods into separate functions would also allow us to reuse them with different models without repeating code.
Tip: Keep your comments objective
Try to avoid using the words "I" and "you" in your comments. You want to avoid comments that sound personal to bring the attention of the review to the code and not to themselves.
BAD: I wouldn't groupby genre twice like you did here... Just compute it once and use that for your aggregations. BAD: You create this groupby dataframe twice here. Just compute it once, save it as groupby_genre and then use that to get your average prices and views. GOOD: Can we group by genre at the beginning of the function and then save that as a groupby object? We could then reference that object to get the average prices and views without computing groupby twice.
Tip: Provide code examples
When providing a code review, you can save the author time and make it easy for them to act on your feedback by writing out your code suggestions. This shows you are willing to spend some extra time to review their code and help them out. It can also just be much quicker for you to demonstrate concepts through code rather than explanations.
Let's say you were reviewing code that included the following lines:
first_names =  last_names =  for name in enumerate(df.name): first, last = name.split(' ') first_names.append(first) last_names.append(last) df['first_name'] = first_names df['last_names'] = last_names
BAD: You can do this all in one step by using the pandas str.split method. GOOD: We can actually simplify this step to the line below using the pandas str.split method. Found this on this stack overflow post: https://stackoverflow.com/questions/14745022/how-to-split-a-column-into-two-columns
df['first_name'], df['last_name'] = df['name'].str.split(' ', 1).str