Project access refactoring #481
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
igor-davidyuk
force-pushed
the
idavidyu/get-project-refactoring
branch
from
fda516c
to
cf1b025
Compare
igor-davidyuk
force-pushed
the
idavidyu/get-project-refactoring
branch
2 times, most recently
from
2f8d677
to
a901752
Compare
ljcornel
reviewed
Aug 27, 2024
geti_sdk/geti.py
Outdated
|
|
||
| :param project_name: Name of the project to retrieve | ||
| :param project_id: ID of the project to retrieve. If not specified, the | ||
| project with name `project_name` will be retrieved. | ||
| :param project: Project object to update. If not specified, the project with |
There was a problem hiding this comment.
This sentence is not finished. I'm not sure about the behaviour, does the project override the project_id?
There was a problem hiding this comment.
Just looked at the ProjectClient.get_project method, the behaviour is clear now. Could you add a brief description of the parameter order here? Mainly because users may use the Geti object as the entrypoint to the API
There was a problem hiding this comment.
I updated the docstring, please see if the explanations are clearer now
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
Co-authored-by: Ludo Cornelissen <[email protected]>
Co-authored-by: Ludo Cornelissen <[email protected]>
Signed-off-by: Igor-Davidyuk <[email protected]>
igor-davidyuk
force-pushed
the
idavidyu/get-project-refactoring
branch
from
35b1a40
to
2faeac2
Compare
ljcornel
approved these changes
Sep 12, 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.
This PR adds guardrails to the user workflow that should streamline the experience of working with identically named projects.
The
get_projectnow may be called with one of [project_name, project_id, project_object].Fetching a project by name now has an unraveled logic scheme and is THE place where the user can determine the correct
project_id.All the other methods now accept a project object as an argument instead of a project_name which may be potentially problematic.