Hey everyone! I'm working on a finite element method (FEM) library in Python, but I've realized that I've built it in a rather messy way. Now, I want to tackle a rewrite of its core components. The challenge I'm facing is that the current structure is so interwoven that it's hard to conceptualize how to decouple things. It feels like pulling on one string makes the whole situation worse!
I'm curious about how others approach rethinking their code architecture. Do you create diagrams first, or do you just pick a starting point and work from there? What parts do you focus on initially? I'd love to hear any practices or strategies that helped you successfully refactor your own projects!
3 Answers
For libraries, I think about how users will interact with it first and work backwards. It’s important to keep user experience in mind, especially if it's already released. Comprehensive high-level tests can help a lot too because they can safely guide you in untangling your code. I find it useful to outline the main sections of the codebase using simple boxes to see how they connect—too much detail can bog you down initially!
From what I've seen, attempting a complete rewrite often leads to more complications. A safer approach is to make incremental improvements. Tackle one part of the code at a time and see where that leads. If something doesn’t work as expected, you can always revert and try a different tactic. This method helps you quickly identify what’s really messy and address it effectively.
Interesting, I’ll consider that for sure!
Drawing state and sequence diagrams can really help you visualize the flow of information in your codebase. Understanding who owns what data is key when it comes to organizing your structure. I often use the 'Strangler Fig' method for refactoring and I always write unit tests for the existing code before I make any changes. It lays a safer foundation for your rewrite!
I'll look that up, thanks!
Gotcha! I can make the users suffer. There aren’t that many yet, so I think I can manage the changes. I believe the usage aspect is pretty solid, but it's the background magic that needs better organization.