Simplify HDFDocumentComposer #858
Open
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
|
Given I did not change any of the tests, we still pass in |
coretl
requested changes
Apr 29, 2025
Comment on lines
+81
to
+83
| async def collect_stream_docs( | ||
| self, indices_written: int | ||
| ) -> AsyncIterator[StreamAsset]: |
There was a problem hiding this comment.
Ok, having seen the code it does no I/O, so we can put it back to a plain iterator
Suggested change
| async def collect_stream_docs( | |
| self, indices_written: int | |
| ) -> AsyncIterator[StreamAsset]: | |
| def collect_stream_docs( | |
| self, indices_written: int | |
| ) -> Iterator[StreamAsset]: |
Comment on lines
+143
to
+144
| async for doc in self._composer.collect_stream_docs(indices_written): | ||
| yield doc |
There was a problem hiding this comment.
Which simplifies to
Suggested change
| async for doc in self._composer.collect_stream_docs(indices_written): | |
| yield doc | |
| yield from self._composer.collect_stream_docs(indices_written) |
Comment on lines
+148
to
+153
| if not self._composer: | ||
| self._composer = HDFDocumentComposer( | ||
| Path(await self.panda_data_block.hdf_directory.get_value()) | ||
| / Path(await self.panda_data_block.hdf_file_name.get_value()), | ||
| self._datasets, | ||
| ) |
There was a problem hiding this comment.
What was the reasoning to put it here rather than in open()?
| yield "stream_resource", doc | ||
| for doc in self.composer.stream_data(indices_written): | ||
| yield "stream_datum", doc | ||
| if self.composer: |
There was a problem hiding this comment.
I think we should raise if self.composer is None
Suggested change
| if self.composer: | |
| if self.composer is None: | |
| msg = "open() not called on {self}" | |
| raise RuntimeError(msg) |
|
@shihab-dls please could we rebase this so we can merge it? |
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.
Fixes #795
This PR should mostly remove duplicate code in writers that perform the same
collect_stream_docsoperation. As #795 requested tests to remain unchanged, writers still have theircollect_stream_docsmethods, but this simply calls the composers method.With this, composers can now be created in
open(); however, as panda's writer creates its dataset in_update_datasets(), I create the composer here instead.EDIT: I've moved this back to
collect_stream_docs(for panda writer), as I think it's clearer here.