Add new option xlsx_specify_headers #114
Open
+41
−6
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
The xlsx_ignore_headers option allows specific fields to be excluded when enumerating the serializer. This adds the ability to explicitly specify the fields that should be included. The absence of the option will result in the default behavior.
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
|
@nathan-osman Thanks so much for the contributions! We'll get the workflows run today and review this week. |
|
|
||
| This also works with nested fields, separated with a dot (i.e. `icon.url`). | ||
| To include only a specified list of fields, provide them with: `xlsx_specify_headers = [<fields to include>]`. Conversely, to exclude certain fields from your export, provide them with: `xlsx_ignore_headers = [<excluded fields>]`. |
There was a problem hiding this comment.
I'm wondering whether these 2 options should be mutually exclusive: you could use one option or the other, but not both...
I looked at the Django model forms API with fields and exclude which have a similar concern and they're not mutually exclusive:
excludeis an optional list of field names. If provided, the named fields will be excluded from the returned fields, even if they are listed in thefieldsargument.
Which -I think- matches the current implementation here. Maybe add a sentence to explain that ignore takes precendence over specify?
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.
The existing
xlsx_ignore_headersoption allows specific fields to be excluded when enumerating fields in the serializer. This pull request adds the ability to explicitly specify the fields that should be included:The absence of the option will result in the default behavior. A test was added to ensure correct behavior.