amalota
commented
2 years ago I looked at the MacheteClient fields that keep state of the git machete and i see that the code very heavily depends on the state being mutable and i am not sure if its worth the effort and whether it would significantly improve the code quality. Could you maybe provide with some pros/cons or use cases besides the only one: for managed_branch in self.managed_branches.copy():.
Nevertheless, here are the possible solutions:
1. Tuple - immutable list
Pros:
- simple,
- built-in
Cons:
- can only be a substitute for list
2. immutables - https://github.com/MagicStack/immutables
Pros:
- has context manager (would require less work to use it with current implementation)
- fast
Cons:
- external lib
- Map class can only be a substitute for dict
3. frozenset() - function that converts mutable iterable into immutable set
Pros:
- built-in
Cons:
- not the best substitute for list
- it is a function
5. frozendict - immutable dict class - https://github.com/Marco-Sulla/python-frozendict
Cons:
- external library
6. Create our own immutable iterable classes
Pros:
- can substitute both list and dict
Cons:
- might be difficult and time consuming
@PawelLipski wdyt?
PawelLipski
This has been done in https://github.com/VirtusLab/git-machete-intellij-plugin using vavr.io, with very good results. While CLI is less prone to race conditions on data structure as compared to GUI, it'd be still good to switch to immutable structures (to avoid the need for
.copy()etc.).As a first point, let's research what options for immutable structures are available in the ecosystem... esp. if anything is available in the standard library so that we don't need to add external deps 🙏🏻