importer: Remove requirement for filename and lineno metadata #101
+33
−27
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
Importers have to add "filename" and "lineno" metadata entries to the generated entries. However, these are used only by the the bencount.core.data.entry_sortkey() sorting key function when entries are written in the ledger. As the Python sort implementation is guaranteed stable, this is at best not useful and actually problematic when the source document is sorted in reverse date order and the importer does not explicitly takes this in account. Implementing a sortkey() function that does not use these metadata entries removes the need for the importers to generate them and avoids the issue with reverse sorting of entries for the same day. Propagate the change to the base classes and example importers.
This was referenced Feb 6, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Importers have to add "filename" and "lineno" metadata entries to the
generated entries. However, these are used only by the the
bencount.core.data.entry_sortkey() sorting key function when entries
are written in the ledger.
As the Python sort implementation is guaranteed stable, this is at
best not useful and actually problematic when the source document is
sorted in reverse date order and the importer does not explicitly
takes this in account.
Implementing a sortkey() function that does not use these metadata
entries removes the need for the importers to generate them and avoids
the issue with reverse sorting of entries for the same day.
Propagate the change to the base classes and example importers.