EDGAR workflow-specific operational change #704
Draft
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
Security InsightsNo security relevant content was detected by automated scans. Action Items
Questions or Comments? Reach out on Slack: #support-infosec. |
| @@ -546,7 +546,7 @@ def addFile(self, ivf): | |||
| def addFilingDoc(self, filingDocuments): | |||
| self.filingDocuments = filingDocuments | |||
|
|
|||
| def save(self, destination: io.BytesIO | str, zipOutput: bool = False, copyScriptPath: Path | None = None): | |||
| def save(self, destination: io.BytesIO | str, zipOutput: bool = False, copyScriptPath: Path | None = None, stubFileOnly: bool = False): | |||
There was a problem hiding this comment.
I think we should probably catch stubFileOnly used without useStubViewer and throw an error, as currently you won't get an error, you'll just silently get the first file from the document set.
Perhaps we could move the option on to createViewer and use it to control the calls to addFile? This might be clearer than just only outputting the first file.
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.
Reason for change
This change is a companion to EdgarRenderer Pull Request #114
With the Edgar workflow the iXBRLViewer stub is generated twice (for the situation of private and redacted public viewers), not by the usual plugin invocation but instead invoked from an EdgarRenderer iXBRLViewerPluginInterface module.
EdgarRenderer provides unique fact IDs because they're also needed by EDGAR's ixviewer-plus.
It adds a stubOnly flag to generateViewer, so that when saving (into an io.bytes zip) only the stub is saved. The source files are not readable because they may either be encrypted or in a POSTED zip source, but not plain filesystem files. The source files also may not represent the redacted publicly disseminatable files.
Description of change
Add stub-only parameter.
Steps to Test
review:
@Arelle/arelle
@paulwarren-wk