enable diagram detect based on file instance id #1887
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1887 +/- ##
==========================================
+ Coverage 90.62% 90.69% +0.06%
==========================================
Files 126 126
Lines 19609 19617 +8
==========================================
+ Hits 17771 17791 +20
+ Misses 1838 1826 -12
|
added 6 commits
August 27, 2024 08:16
…to DOG-3974_dm_reference_in_diagram_detect
doctrino
reviewed
Sep 2, 2024
Comment on lines
376
to
381
| if self.file_id is None and self.file_external_id is not None: | ||
| item: dict[str, str | int | dict[str, int]] = {"fileExternalId": self.file_external_id} | ||
| item: dict[str, str | int | dict[str, int] | dict[str, str]] = {"fileExternalId": self.file_external_id} | ||
| if self.file_id is not None and self.file_external_id is None: | ||
| item = {"fileId": self.file_id} | ||
| if self.file_instance_id is not None: | ||
| item = {"fileInstanceId": self.file_instance_id.dump(include_instance_type=False)} |
There was a problem hiding this comment.
A situation that should never happen, but this is more robust:
item: dict[str, str | int | dict[str, int] | dict[str, str]] = {}
if self.file_id is None and self.file_external_id is not None and self.file_instance_id is None:
item["fileExternalId"] = self.file_external_id
elif self.file_id is not None and self.file_external_id is None and self.file_instance_id is None:
item["fileId"] = self.file_id
elif self.file_instance_id is not None and self.file_id is None and self.file_external_id is None:
item["fileInstanceId"] = self.file_instance_id.dump(include_instance_type=False)
else:
raise ValueError("Exactly one of file_id, file_external_id and file_instance_id must be set")|
|
||
| PNID_FILE_ID = 3261066797848581 | ||
| DIAGRAM_SPACE = "diagram_space" |
There was a problem hiding this comment.
Can you make a fixture to guarantee that this space will exist?
Something like
@pytest.fixture(scope="session")
def diagram_space(cognite_client: CogniteClient) -> Space:
return cognite_client.data_modeling.spaces.apply(SpaceApply(space=DIAGRAM_SPACE))There was a problem hiding this comment.
Hm, could do that, but should also make sure that the file exists in that case. If the space does not exist, then the file cant exist either, so maybe add a file to the repo and upload it if it is not there or what do you think?
There was a problem hiding this comment.
Yes, I missed that. I would also make another fixture for the file then. If the file is not too big or sensitive then commit it to the repo.
| @@ -103,3 +106,20 @@ def test_run_diagram_detect_in_pattern_mode(self, cognite_client): | |||
|
|
|||
| assert len(detected_by_resource_type["file_reference"]) >= 10 # 14 seen when making the test | |||
| assert len(detected_by_resource_type["instrument"]) >= 60 # 72 seen when making the test | |||
|
|
|||
| def test_run_diagram_detect_with_file_instance_id(self, cognite_client): | |||
There was a problem hiding this comment.
Suggested change
| def test_run_diagram_detect_with_file_instance_id(self, cognite_client): | |
| @pytest.mark.usefixtures("diagram_space") | |
| def test_run_diagram_detect_with_file_instance_id(self, cognite_client): |
doctrino
approved these changes
Sep 2, 2024
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.
Description
Make diagram detect available by file_instance_id.
I have done it similarly to id and external id, but could consider to only make it available with file references, since file references with page ranges is the recommended way to run (at least when documents have variable numbers of pages).
PR in context-api is here
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.