Code Cleaning with Python: Shedding the Scales!
Mohit Bansal (Philomath) (~miphilomath) |
1
Description:
Building and maintaining a robust, high-quality codebase is an ongoing challenge, especially in a shared coding environment with vague or non-optimal standards. Poorly structured codebase can often result in frustration, considerably hindering productivity and affecting team morale. In this presentation, I will shed light on the effective techniques and methodologies that can be employed to refactor a poorly developed Python codebase. Specifically, the talk will focus on crucial refactoring techniques like Don’t Repeat Yourself (DRY) and Single Responsibility Principle (SRP) among others. Along with these, I will also introduce and discuss other Pythonic norms and standards which can be instrumental in cultivating healthier, more sustainable and efficient codebases.
Talk Outline (Tentative):
- Introduction: Set the stage by introducing the topic and its relevance.
- The Challenge: Discuss issues arising from sub-optimal coding practices in shared Python codebases.
- Understanding Refactoring: Delve into the concept of refactoring, its necessity, and its impact on productivity.
- Techniques & Principles of Refactoring: Introduce critical techniques, including DRY and SRP, and elaborate their importance through real-world examples.
- Pythonic Norms & Standards: Briefly discuss other crucial norms and standards enhancing the Python code's readability, maintainability, and efficiency.
- Best Practices for Refactoring: Share practical tips and strategies for effective refactoring, complete with testing strategies and the usage of refactoring tools.
- Case Study/Live Demo: Demonstrate the refactoring of a small piece of poorly constructed code into a well-structured segment.
- Conclusion: Reinforce the importance of these practices and their effects on productivity and team collaboration.
- Q&A: Answer potential audience queries.
This talk aims to serve as a practical resource for developers at all levels who are looking to improve their proficiency in Python, and contribute to a more streamlined, maintainable and efficient codebase. It will offer valuable insights, practical tips and actionable strategies that can be implemented in real-time to manage, restructure and revamp Python codebases.
The key objective will be to equip the participants with strategic insights on how to identify and remedy unhealthy coding practices, thereby enhancing their ability to contribute successfully to the quality management and growth of a shared codebase.
Prerequisites:
Experience working with python codebase will be helpful for the audience to relate to the suggestions.
Content URLs:
https://docs.google.com/presentation/d/1elUX6bHmIQBCzK7LFe1FePDHUTF0fxvOzNC8sOr-WKI/edit?usp=sharing
Speaker Info:
A philomath who has a curiosity for everything. Backend developer by profession.
Speaker Links:
https://www.youtube.com/live/UgWK_AS6X60?si=KYjsU_4EzB-u-1E0&t=19450 https://theknowledgeseeker.in