lib.enum: privatize internal attributes in EnumView/FlagView
#1424
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1424 +/- ##
==========================================
+ Coverage 90.83% 91.13% +0.29%
==========================================
Files 43 43
Lines 10946 10963 +17
Branches 2305 2656 +351
==========================================
+ Hits 9943 9991 +48
+ Misses 830 801 -29
+ Partials 173 171 -2 ☔ View full report in Codecov by Sentry. |
Before this commit, public names `enum` and `target` were not usable as enumeration member or method names. This was unintentional and our policy is to not reserve public names where they may clash with names defined in downstream code. This commit makes them a private name (`__enum`, etc). This was chosen instead of a sunder name (`_amaranth_enum_`, etc) because there is a 1:1 correspondence between the attribute and a `ValueCastable` method: * `shape()` -> `__enum` * `as_value()` -> `__target`
whitequark
force-pushed
the
enum-view-stray-names
branch
from
fe1f5fd to
915eaa5
Compare
Merged
via the queue into
amaranth-lang:main
with commit Jun 27, 2024
8542252
19 of 20 checks passed
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.
Before this commit, public names
enumandtargetwere not usable as enumeration member or method names. This was unintentional and our policy is to not reserve public names where they may clash with names defined in downstream code.This commit makes them a private name (
__enum, etc). This was chosen instead of a sunder name (_amaranth_enum_, etc) because there is a 1:1 correspondence between the attribute and aValueCastablemethod:shape()->__enumas_value()->__target