Files list end point refactor #1529
Open
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
korgan00
requested changes
Nov 7, 2024
Comment on lines
+159
to
+178
| if provider_name: | ||
| function = self.get_provider_function( | ||
| provider_name=provider_name, function_title=function_title | ||
| ) | ||
| if not function: | ||
| return Response( | ||
| { | ||
| "message": f"Qiskit Function {provider_name}/{function_title} doesn't exist." # pylint: disable=line-too-long | ||
| }, | ||
| status=status.HTTP_404_NOT_FOUND, | ||
| ) | ||
|
|
||
| if function: | ||
| if not self.user_has_access_to_provider_function( | ||
| request.user, function | ||
| ): | ||
| return Response( | ||
| {"message": "You don't have access to this Qiskit Function."}, | ||
| status=status.HTTP_403_FORBIDDEN, | ||
| ) |
There was a problem hiding this comment.
Suggested change
| if provider_name: | |
| function = self.get_provider_function( | |
| provider_name=provider_name, function_title=function_title | |
| ) | |
| if not function: | |
| return Response( | |
| { | |
| "message": f"Qiskit Function {provider_name}/{function_title} doesn't exist." # pylint: disable=line-too-long | |
| }, | |
| status=status.HTTP_404_NOT_FOUND, | |
| ) | |
| if function: | |
| if not self.user_has_access_to_provider_function( | |
| request.user, function | |
| ): | |
| return Response( | |
| {"message": "You don't have access to this Qiskit Function."}, | |
| status=status.HTTP_403_FORBIDDEN, | |
| ) | |
| if provider_name: | |
| function = self.get_provider_function( | |
| provider_name=provider_name, function_title=function_title | |
| ) | |
| if not function: | |
| return Response( | |
| { | |
| "message": f"Qiskit Function {provider_name}/{function_title} doesn't exist." # pylint: disable=line-too-long | |
| }, | |
| status=status.HTTP_404_NOT_FOUND, | |
| ) | |
| if not self.user_has_access_to_provider_function( | |
| request.user, function | |
| ): | |
| return Response( | |
| {"message": "You don't have access to this Qiskit Function."}, | |
| status=status.HTTP_403_FORBIDDEN, | |
| ) |
Since the function is only set inside if provider_name: I think it doesn't make sense to check the function out of the if.
| def __init__( | ||
| self, | ||
| username: str, | ||
| working_dir: str, |
There was a problem hiding this comment.
How about Literal type or Enum?
https://stackoverflow.com/questions/58114837/python-3-type-hint-for-string-options
Comment on lines
+46
to
+48
| def __get_user_path( | ||
| self, username: str, function_title: str | None, provider_name: str | None | ||
| ) -> str: |
There was a problem hiding this comment.
Suggested change
| def __get_user_path( | |
| self, username: str, function_title: str | None, provider_name: str | None | |
| ) -> str: | |
| def __get_user_path( | |
| self, function_title: str | None, provider_name: str | None | |
| ) -> str: |
self contains username, it can be omitted.
Comment on lines
+66
to
+73
| if provider_name is None: | ||
| path = username | ||
| else: | ||
| path = f"{username}/{provider_name}/{function_title}" | ||
| return os.path.join( | ||
| sanitize_file_path(settings.MEDIA_ROOT), | ||
| sanitize_file_path(path), | ||
| ) |
There was a problem hiding this comment.
Suggested change
| if provider_name is None: | |
| path = username | |
| else: | |
| path = f"{username}/{provider_name}/{function_title}" | |
| return os.path.join( | |
| sanitize_file_path(settings.MEDIA_ROOT), | |
| sanitize_file_path(path), | |
| ) | |
| path = os.path.join(settings.MEDIA_ROOT, username) | |
| if provider_name: | |
| path = os.path.join(path, provider_name, function_title) | |
| return sanitize_file_path(path) |
How about join everyone with the path.join and sanitize at the end.
| if provider_name is None: | ||
| path = username | ||
| else: | ||
| path = f"{username}/{provider_name}/{function_title}" |
There was a problem hiding this comment.
We are not checking if function_title is none
Comment on lines
+88
to
+92
| path = f"{provider_name}/{function_title}" | ||
| return os.path.join( | ||
| sanitize_file_path(settings.MEDIA_ROOT), | ||
| sanitize_file_path(path), | ||
| ) |
There was a problem hiding this comment.
Suggested change
| path = f"{provider_name}/{function_title}" | |
| return os.path.join( | |
| sanitize_file_path(settings.MEDIA_ROOT), | |
| sanitize_file_path(path), | |
| ) | |
| path = os.path.join( | |
| settings.MEDIA_ROOT, provider_name, function_title | |
| ) | |
| return sanitize_file_path(path) |
korgan00
reviewed
Nov 7, 2024
Comment on lines
+39
to
+44
| if working_dir == USER_STORAGE: | ||
| self.file_path = self.__get_user_path( | ||
| username, function_title, provider_name | ||
| ) | ||
| elif working_dir == PROVIDER_STORAGE: | ||
| self.file_path = self.__get_provider_path(function_title, provider_name) |
There was a problem hiding this comment.
what happens if working dir is not user or provider?
|
Thank you so much @korgan00 , as soon as I return from vacations I will take a look 🙏 |
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.
Summary
This PR is part of an effort to stabilize
filesAPI end-points in #1509This PR focuses on
files/andfiles/provider/end-points to be able to list the files in the working directories for the user and for the provider.Details and comments
files/end-point was separated in two:files/now contains the paths:username/andusername/provider/functionwith the purpose to separated files from functions from the user's root folderfiles/provider/to manage the pathprovider/functionso now each function will have its own folder in the provider directory.FileStoragewas created to manage the logic of access to this storage for providers and users with the purpose to simplify the view.