refactor: ♻️ major refactor of path functions to be local-first #1114
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
2 tasks
signekb
reviewed
Mar 10, 2025
| return check_is_file(path) | ||
|
|
||
|
|
||
| def path_resource_raw(resource_id: int, path: Path = Path.cwd()) -> Path: |
There was a problem hiding this comment.
martonvago
requested changes
Mar 11, 2025
| path=temp_path | ||
| ) | ||
|
|
||
| sp.path_properties(path = temp_path) |
There was a problem hiding this comment.
Suggested change
| sp.path_properties(path = temp_path) | |
| sp.path_properties(path=temp_path) |
| path=temp_path | ||
| ) | ||
|
|
||
| sp.path_readme(path = temp_path) |
There was a problem hiding this comment.
Suggested change
| sp.path_readme(path = temp_path) | |
| sp.path_readme(path=temp_path) |
Comment on lines
+113
to
+115
| resource_path = Path(temp_path / "resources") | ||
| resource_path.mkdir() | ||
| sp.create_resource_structure(path=resource_path) |
There was a problem hiding this comment.
Suggested change
| resource_path = Path(temp_path / "resources") | |
| resource_path.mkdir() | |
| sp.create_resource_structure(path=resource_path) | |
| resources_path = Path(temp_path / "resources") | |
| resources_path.mkdir() | |
| sp.create_resource_structure(path=resources_path) |
To avoid confusion with path_resource
Comment on lines
+202
to
+204
| resource_path = Path(temp_path / "resources") | ||
| resource_path.mkdir() | ||
| sp.create_resource_structure(path=resource_path) |
There was a problem hiding this comment.
Suggested change
| resource_path = Path(temp_path / "resources") | |
| resource_path.mkdir() | |
| sp.create_resource_structure(path=resource_path) | |
| resources_path = Path(temp_path / "resources") | |
| resources_path.mkdir() | |
| sp.create_resource_structure(path=resources_path) |
Comment on lines
+242
to
+244
| resource_path = Path(temp_path / "resources") | ||
| resource_path.mkdir() | ||
| sp.create_resource_structure(path=resource_path) |
There was a problem hiding this comment.
Suggested change
| resource_path = Path(temp_path / "resources") | |
| resource_path.mkdir() | |
| sp.create_resource_structure(path=resource_path) | |
| resources_path = Path(temp_path / "resources") | |
| resources_path.mkdir() | |
| sp.create_resource_structure(path=resources_path) |
| tmp_path, tmp_package, function, expected_path | ||
| ): | ||
| path = function(path=tmp_path) | ||
| # When, then |
There was a problem hiding this comment.
I think "when" is for executing the functionality we're testing (here path = function(path=tmp_path)) and "then" is for the assertions.
| (path_readme, "README.md"), | ||
| ], | ||
| ) | ||
| def test_path_local_root_files_return_expected_path( |
There was a problem hiding this comment.
Suggested change
| def test_path_local_root_files_return_expected_path( | |
| def test_path_local_root_functions_return_expected_path( |
Or am I misunderstanding?
| "function", | ||
| [path_properties, path_readme], | ||
| ) | ||
| def test_path_local_root_files_raise_error_if_files_not_exist(tmp_package, function): |
There was a problem hiding this comment.
Suggested change
| def test_path_local_root_files_raise_error_if_files_not_exist(tmp_package, function): | |
| def test_path_local_root_functions_raise_error_if_files_not_exist(tmp_package, function): |
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
Converts all the path functions to be either local-first or multi-user. In the process I consolidated some of the functions into either "local" or "global" files.
I moved some of the smaller helper functions into the larger files, and appended with
_. I'm not a huge fan of how it looks, but given it is a common Python practice and it helps visually separate external from internal functions, I'm ok if we start doing that too.Closes #1004
This PR needs an in-depth review.
Checklist
just run-all