shim-discipline

To maintain backward compatibility when renaming a Python module, you create a shim at the old import path. This ensures downstream applications continue functioning without breaking unexpectedly during code evolution.

A shim in Python module management is a backward-compatibility stub placed at an old import path. It redirects imports to the new canonical module location, preventing breaking changes when code is relocated or renamed.

You enforce a strict template for backward compatibility stubs by applying consistent shim discipline. This ensures all stubs include required documentation like deprecation notices and expiry dates for auditable code maintenance.

You need to create a shim during Python code refactoring when relocating or renaming canonical modules. This prevents undocumented changes and maintains consumer compatibility by stabilizing the module import path.

This approach to module relocation works for Python projects needing import path stability and auditable code evolution. It manages the creation and documentation of shims to enforce backward compatibility.

The best way to prevent undocumented shims when moving code is to enforce shim discipline. This manages shim creation and updates using a strict template, ensuring all backward-compatibility stubs are properly documented.