Updates for metadata information #7343
Merged
Conversation
This file contains 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
- Override 'label' values with 'verbose_name' values - Only if 'label' is *not* translated, but 'verbose_name' is - Allows the translated model fields name to be pushed through to the metadata framework
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
…venTree into metadata-improvements
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7343 +/- ##
=======================================
Coverage 83.78% 83.78%
=======================================
Files 1049 1049
Lines 46005 46031 +26
Branches 1386 1386
=======================================
+ Hits 38545 38569 +24
- Misses 7099 7101 +2
Partials 361 361
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
matmair
approved these changes
May 26, 2024
Yeah, I'll add some unit tests so that we don't get any regressions |
martonmiklos
pushed a commit
to martonmiklos/InvenTree
that referenced
this pull request
Jun 24, 2024
* Updates for metadata information - Override 'label' values with 'verbose_name' values - Only if 'label' is *not* translated, but 'verbose_name' is - Allows the translated model fields name to be pushed through to the metadata framework * Remove unused import * Add unit testing for metadata lookup * Update serializer: allow 'category' to be blank * Bump API version * Fix for unit test
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.
This PR fixes a subtle bug which existed in our "metadata" implementation, which extracted database field information and provided it to the DRF API.
Any custom serializer fields which do not have an explicitly defined label would default to their attribute name, which was an untranslated string.
So, something like this:
Would result in a
labelvalue of "Category" (which is simply extracted from the name of the serializer field) even if it pointed to an underlying database model field. The "verbose_name" of the field (in this casePart Category) was not obtained.Worse, the auto-generated labels were not exposed to the translation framework at any point. So, any custom DRF fields were never getting translated.
This patch adds some extra introspection steps, and will override a raw stirng value with a translated string value (if it exists). It also adds explicit mapping from
verbose_name(on the model field) tolabel(on the serializer field).Note: If a translated string exists on the serializer field it will not be overridden by the model field