Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement RFC 30: Component metadata. #978

Merged
merged 1 commit into from
May 10, 2024
Merged

Conversation

jfng
Copy link
Member

@jfng jfng commented Dec 1, 2023

No description provided.

@jfng jfng requested a review from whitequark as a code owner December 1, 2023 16:04
amaranth/lib/meta.py Outdated Show resolved Hide resolved
amaranth/lib/wiring.py Outdated Show resolved Hide resolved
amaranth/lib/wiring.py Outdated Show resolved Hide resolved
amaranth/lib/wiring.py Outdated Show resolved Hide resolved
amaranth/lib/meta.py Outdated Show resolved Hide resolved
@jfng
Copy link
Member Author

jfng commented Jan 15, 2024

Rebased to current main branch.

Copy link

codecov bot commented Jan 15, 2024

Codecov Report

Attention: Patch coverage is 96.15385% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 90.93%. Comparing base (dde8334) to head (861a412).
Report is 14 commits behind head on main.

❗ Current head 861a412 differs from pull request most recent head 519f35a. Consider uploading reports for the commit 519f35a to get more accurate results

Files Patch % Lines
amaranth/lib/meta.py 92.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #978      +/-   ##
==========================================
+ Coverage   90.48%   90.93%   +0.44%     
==========================================
  Files          43       45       +2     
  Lines       10864    10640     -224     
  Branches     2660     2596      -64     
==========================================
- Hits         9830     9675     -155     
+ Misses        855      777      -78     
- Partials      179      188       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jfng
Copy link
Member Author

jfng commented Jan 16, 2024

Update to track changes to the RFC.

Copy link
Member

@whitequark whitequark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. The lib.meta module still needs reference documentation, and lib.wiring module's reference documentation needs to be expanded, before the feature is considered fully done.

@jfng
Copy link
Member Author

jfng commented Jan 19, 2024

Rebased on current main.

Updated Signature.annotations(self, obj) to Signature.annotations(self, obj, /); This prevents obj from being set as a kwarg, which allows subclasses to rename it (e.g. to interface).

@jfng
Copy link
Member Author

jfng commented Jan 19, 2024

Looks good to me. The lib.meta module still needs reference documentation, and lib.wiring module's reference documentation needs to be expanded, before the feature is considered fully done.

Agreed.

amaranth/lib/wiring.py Outdated Show resolved Hide resolved
@whitequark whitequark added this to the 0.5 milestone Jan 22, 2024
@whitequark
Copy link
Member

I've added a task list to the tracking issue: #1047 (comment)

@jfng
Copy link
Member Author

jfng commented Apr 30, 2024

Updated with documentation and changelog entry.

The CI link check will fail until the ComponentMetadata schema is published to https://amaranth-lang.org/schema/amaranth/0.5/component.json.

Copy link
Member

@whitequark whitequark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@whitequark whitequark force-pushed the metadata branch 2 times, most recently from c254cb4 to 8057b60 Compare May 10, 2024 13:04
Co-authored-by: Catherine <whitequark@whitequark.org>
@whitequark whitequark enabled auto-merge May 10, 2024 13:11
@whitequark whitequark added this pull request to the merge queue May 10, 2024
Merged via the queue into amaranth-lang:main with commit 496432e May 10, 2024
19 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants