Open Source Contribution - Release 0.2.5

Contributing to Pandas (Part 2)



Pandas is a famous open-source library for Python that provides high-performance and easy-to-use data structures and data analysis tools. It is often used in the machine learning field. Pandas project has over 1,300 contributors and 18,000 commits, which makes it one of the biggest open-source projects related to the machine learning field.

Hacktoberfest 2018

This year I am participating in Hacktoberfest. Throughout the month of October, I will need to make 5 pull requests with contributions to one or more projects on Github. This is my fifth contribution to Hacktoberfest and I came across the Pandas project on Github in my previous contribution. 

Throughout this Hacktoberfest I'm trying to find different ways to contribute to the open-source community. I've already explored non-code contributions and how they can be useful. I also explored contributing to a start up project. Now, in order to gain experience with working on a large open-source project, I will keep contributing to Pandas. 

 I got lucky with finding my first issue in Pandas because I caught a brand new issue almost as soon as it was posted and commented that I wanted to contribute right away. However, to find my second issue, I had to do more research and look into older issues that haven't been resolved. And this is when I found an issue that was abandoned by somebody a month ago and expressed my interest in solving it.


My Contribution

One of Pandas' developers brought attention to an issue that caused bad coding practices. Pandas uses flake8, which is a tool for coding style guide enforcement. One of the warnings that flake8 deals with is a bare except warning (E722), which asks to make the except statements specific to certain errors. However, this warning was silenced and ignored, which allowed developers to put bare except statements when handling errors, which is a bad coding practice. In order to solve this issue, I had to add proper errors to except statements and remove E722 from ignore lists, this would prevent future contributors from leaving except statements empty.

 Bad Coding Practice:








Good Coding Practice:










In order for me to make these changes, I had to remind myself and research all the possible errors that can be caught by except statements in Python. The following picture shows a part of a table with short descriptions about different built-in exceptions in Python. I often used this table to remind myself what each exceptions deals with after learning each exception in-depth.


After learning all the built-in exceptions, I had to go through the remaining bare except statements in Pandas, figure out what the code in the try statement does and figure out which errors it can throw in order to catch the proper exceptions. Figuring out the code was easy in certain cases, but most of the time it was difficult to tell at first exactly what the code does. However, after some dedication I was able to figure out the errors and complete my contribution.
Link to the issue:
https://github.com/pandas-dev/pandas/issues/22872


Link to the pull request:


List of things that I contributed to Pandas:
  • Added specific errors to bare except statements in the following files:
    • doc/source/conf.py
    • pandas/tests/indexing/common.py
    • pandas/tests/io/formats/test_format.py
    • pandas/tests/io/test_pytables.py
    • pandas/tests/io/test_sql.py
    • pandas/tests/test_multilevel.py
    • pandas/tests/test_nanops.py
    • pandas/tests/test_panel.py
    • pandas/tests/test_strings.py
  • Removed the E722 from ignore lists, so bare except warnings are no longer muted.
  • Ensured that the except statements worked as expected.
  • Dealt with errors that occurred during CI checks and ensured that my changes are up to project standards in order to merge them with the project.

Conclusion

This contribution gave me further experience with working on a large project and experience with reviewing other people's code in order to identify the exceptions that it can throw. Furthermore, relearning built-in exceptions in Python was refreshing and beneficial to my future projects. 

Don't be afraid to contribute to large open-source project. As you can see from my experiences, nothing bad can come out from attempting to contribute. Worst case scenario is you won't be able to finish your contribution, however you will receive immense experience that will help you in the future.

Comments

Post a Comment

Popular posts from this blog

Another Dropna Bug in Pandas

Image
Another Dropna Bug in Pandas This year I fixed a few bugs that dealt with NaN values and more specifically the Dropna function in Pandas. Every bug like this made me more and more interested in fixing behaviour that is not consistent across the code base, specifically how the functions deal with non existent values. Some functions have a dropna argument. When set to true, the function should drop columns/rows that contain missing values and when set to false, the function should keep columns/rows that contain missing values. Currently, some functions deal well with NaN values, however there are functions that either produce buggy behaviour with NaN or don't deal with it consistently across the code base. This week I found another bug like this and I will be working on it throughout next week. Issue https://github.com/pandas-dev/pandas/issues/10772 The creator of the issue noticed inconsistent behaviour when using the dropna argument inside the crosstab function...
Read more

Unit Tests in Pandas

Image
Contributing Unit Tests to Pandas The issue that I decided to work on this week was one of the easier issues discussed in my last blog, however it gave me valuable experience with unit testing in Python and Pandas specifically. I decided to start my 2019 open-source contributions with unit testing because I haven't had much experience with unit testing previously in Python.  Overview of the Issue https://github.com/pandas-dev/pandas/issues/21205 As I previously stated in my last blog, this issue shed light on an issue with using NaT when converting a Series to a Period using the dt.to_period('D') function. Other datetime64[ns] objects with values have no problem converting into a Period, however when a NaT was passed in, it stayed as datetime64[ns]. NaT represents a missing value for datetime objects. Since the issue was posted, it has been resolved with current updates to the master branch. However, one of the moderators asked for unit tests that would ens...
Read more

Progress in Open Source

Image
Progress in Open Source In this blog I will talk about my journey and progress in open source development so far. I've been really enjoying working on real world projects that are used by many people every day. It is not only challenging as every Pull Request required me to perform research in order to understand the issue and solve it, but it is also rewarding because I acquire hands-on experience that is much needed and also contribute to the open source community that I am very fond of now. Open Source Timeline Summary I started exploring open source development during September of 2018. I had to learn a lot of useful tools that Git and Github offers, which now come in handy almost every day. I now know how to create meaningful issues that follow the specifications of the project, as well as create and structure my Pull Requests to the standards of the project that I'm working on. Furthermore learning how to properly manipulate version history using ...
Read more