docs: expand anti-patterns with private state access guidance#8
Closed
colombod wants to merge 1 commit intomicrosoft:mainfrom
Closed
docs: expand anti-patterns with private state access guidance#8colombod wants to merge 1 commit intomicrosoft:mainfrom
colombod wants to merge 1 commit intomicrosoft:mainfrom
Conversation
607fe3b to
0f23601
Compare
Add bullet to 'In Module Development' anti-patterns about bypassing public interfaces to access internal state. Motivated by microsoft/amplifier-app-cli#70. 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
0f23601 to
0faf27e
Compare
Contributor
Author
|
Closing in favor of adding this to IMPLEMENTATION_PHILOSOPHY.md in amplifier-foundation instead - that's the right place for development-time guidance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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