feat(skore/project)!: Enforce mode in a dedicated parameter
#2401
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
thomass-dev
changed the title
mode in a dedicated parameter
thomass-dev
force-pushed
the
skore-hub-project-project-name
branch
from
7f589a2 to
133baf1
Compare
thomass-dev
force-pushed
the
skore-hub-project-project-name
branch
from
133baf1 to
2bf8763
Compare
Contributor
Contributor
| If the ``name`` takes the form of the URI ``hub://<workspace>/<name>``, the project | ||
| is configured to the ``hub`` mode to communicate with the ``skore hub``. | ||
| The project is configured to the ``hub`` mode to communicate with the ``skore hub``. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The project is configured to the ``hub`` mode to communicate with the ``skore hub``. |
| interface. It represents an isolated entity managing users, projects, and | ||
| resources. It can be a company, organization, or team that operates | ||
| independently within the system. | ||
| In this mode, the ``name`` takes the form ``<workspace>/<name>``, where the |
Collaborator
There was a problem hiding this comment.
Suggested change
| In this mode, the ``name`` takes the form ``<workspace>/<name>``, where the | |
| In this mode, the ``name`` is expected to be of the form ``<workspace>/<name>``, where the |
| resources. It can be a company, organization, or team that operates | ||
| independently within the system. | ||
| In this mode, the ``name`` takes the form ``<workspace>/<name>``, where the | ||
| workspace is a ``skore hub`` concept that must be configured on the ``skore hub`` |
Collaborator
There was a problem hiding this comment.
Should we link to skore hub here?
Comment on lines
+41
to
43
| Also in this mode, you must have an account to the ``skore hub`` and must be | ||
| authorized to the specified workspace. You must also be authenticated beforehand, | ||
| by calling the ``skore.login()`` function at the top of your script. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Also in this mode, you must have an account to the ``skore hub`` and must be | |
| authorized to the specified workspace. You must also be authenticated beforehand, | |
| by calling the ``skore.login()`` function at the top of your script. | |
| Note: Using Project in `hub` mode requires an account on `skore hub`, | |
| with access rights to the specified workspace. Authentication to skore-hub | |
| is done by running `skore.login()` before instantiating the Project. |
| - otherwise, the project is configured to communicate with a local storage, | ||
| on the user machine. | ||
| The name of the project. | ||
| mode : {"hub", "local"} |
Collaborator
There was a problem hiding this comment.
Shouldn't we have "local" as the default?
|
|
||
| @staticmethod | ||
| def delete(name: str, **kwargs): | ||
| def delete(name: str, *, mode: Mode, **kwargs): |
Collaborator
There was a problem hiding this comment.
nit: Hm, this is making me not like that delete is a static method
|
|
||
|
|
||
| def login(*, mode: Literal["local", "hub"] = "hub", **kwargs): | ||
| def login(*, mode: Literal["hub", "local"] = "hub", **kwargs): |
Collaborator
There was a problem hiding this comment.
Reuse the Mode type
|
|
||
|
|
||
| def login(*, mode: Literal["local", "hub"] = "hub", **kwargs): | ||
| def login(*, mode: Literal["hub", "local"] = "hub", **kwargs): |
Collaborator
There was a problem hiding this comment.
Why does this function take a mode argument? It doesn't make sense to pass local to it right?
| plugins = entry_points(group="skore.plugins.login") | ||
|
|
||
| if mode not in plugins.names: | ||
| raise ValueError(f"Unknown mode `{mode}`. Please install `skore[{mode}]`.") |
Collaborator
There was a problem hiding this comment.
Maybe this error could be factorized with the one in project.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #2330.