docs: expand anti-patterns with private state access guidance #8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Expands the anti-patterns section in DESIGN_PHILOSOPHY.md with explicit guidance about accessing private state via
getattr(obj, '_private', ...).Motivation
This PR was motivated by microsoft/amplifier-app-cli#70 which demonstrates a "fix" that reaches into private internal state instead of using public APIs:
The comment "Pattern from session_spawner.py" shows this anti-pattern is spreading across the codebase, making it important to document why this is wrong.
What's Added
New subsection "Accessing Private State (Critical Anti-Pattern)" under Module Development anti-patterns:
Design Philosophy Alignment
This aligns with existing principles:
Related
🤖 Generated with Amplifier
Co-Authored-By: Amplifier 240397093+microsoft-amplifier@users.noreply.github.com