Debugging and Refactoring the Current Python Code

[Lancasterwu]

With PR #180, we can finally run the restructured gatorgrouper.

However, there are still some bugs and bad designed python code.

The program was only refactored in this structure, some specific functions still looks terrible.

I want to assign @GatorEducator/team-lancaster and @GatorEducator/team-spencer (except @huangs1 and @ilikerustoo) to go over all code in details to improve them.

"The refactored code should be clean, efficient, and maintainable code that is well documented"

Please create a branch following the style enhance/debug-improve-YOURFILENAME
Note that you should not put .py after YOURFILENAME.

To be organized, please comment under this Issue to claim the file you are going to work.

You should be responsible for having a good understanding of the file that you are assigned and be able to explain to other people.

😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏

---

We now have:

• @thomad74 for read_student_file.py
• @ALEXANDERB82 for group_scoring.py
• @wattob for group_random.py
• @everitt-andrew for wgroup_rrobin.py
• @reibelj for parse_arguments.py
• @Lancasterwu for display.py
• @yeej2 for remove_absent_students.py and rebalance.py
• @baldeosinghm for gatorgrouper.py

There are only two configuration files left

• defaults.py - short
• constants.py - short

---

😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏 😄 😆 😊 😃 😏

When ever you find a bug or bad designed code or some thing that does not make sense to you, please make a note under this issue and raise a new issue to clearly explain it.

For example:

Comment under this issue:

reibelj commented a day ago

I will look into `parse_arguments.py`

Issue #194 to fix a bug related to invalid group number

Sample Issue that you should raise: #194

[ilikerustoo]

Could to be more specific in examples of what would need improving? This is probably low priority for now since we have the application finally up and running when PR #180 merges.

[baldeosinghm]

I agree with @ilikerustoo. What files do you think are in need of urgent refactoring?

[everitt-andrew]

I will look at potential refactoring that can be done with group_rrobin.py
The only refactoring that this program needed was the alteration of the docstrings. As such, I did not raise an issue and my changes can be found in the enhance/debug-improve-group_rrobin branch.
I also raised issue 205 in response to the bug that Lancaster and I found earlier while writing the test_rrobin_responses method inside of test_group_method.py.

[wattob]

I will take a look at the functions within group_random.py

[reibelj]

I will look into parse_arguments.py

Issue #194 to fix a bug related to invalid group number

[ALEXANDERB82]

I will look at group_scoring.py

[thomad74]

I will look at read_student_file.py

Issue #188 to provide failure handling (@ilikerustoo is currently working on that)

[baldeosinghm]

I will handle gatorgrouper.py

[baldeosinghm]

I recently spoke to Saejin, and gatorgrouper.py has no real need for refactoring. The code works and there is nothing to really attend to.

[thomad74]

@ilikerustoo have you done work on the read_student_file.py and if so, have you committed this work so I can continue to add to it?

[ilikerustoo]

@thomad74 I have not. I apologize. I have been busy but I will look into this again soon.

[thomad74]

@ilikerustoo No problem, I was just wondering!

[baldeosinghm]

This issue was handled by PR #226