Refactor split function with tests #811
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
The split function was (1) selecting files in included directories in the top half of the function, and (2) selecting files with valid extensions and sharding them in the second half. This PR divides the split function in a new `collect_files` function that selects files with valid extensions from non-excluded directories, and then passes the valid filepaths into the `split` function, which calls `collect_files`.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
andrii-i
requested changes
Jun 3, 2024
There was a problem hiding this comment.
Thank you @srdas. Please find comments / suggestions below.
Please make sure you are using pytest. Currently there is nothing in your tests incompatible with pytest so just implement comments suggesting use of different pytest features and make sure to run testing suite with pytest -vv -r ap --cov jupyter_ai or just your test with pytest -vv -k test_collect_files when testing while working on your test. Pytest docs for reference: https://docs.pytest.org/en/8.2.x/getting-started.html#.
packages/jupyter-ai/jupyter_ai/tests/doc_loaders/test_eligible_files.py
Outdated
Show resolved
Hide resolved
packages/jupyter-ai/jupyter_ai/tests/doc_loaders/test_eligible_files.py
Outdated
Show resolved
Hide resolved
packages/jupyter-ai/jupyter_ai/tests/doc_loaders/test_eligible_files.py
Outdated
Show resolved
Hide resolved
packages/jupyter-ai/jupyter_ai/tests/doc_loaders/test_eligible_files.py
Outdated
Show resolved
Hide resolved
The split function was (1) selecting files in included directories in the top half of the function, and (2) selecting files with valid extensions and sharding them in the second half. This PR divides the split function in a new `collect_files` function that selects files with valid extensions from non-excluded directories, and then passes the valid filepaths into the `split` function, which calls `collect_files`.
for more information, see https://pre-commit.ci
Replaced testing using unittests with testing using pytest fixtures.
…pyter-ai into refactor_split_and_test
for more information, see https://pre-commit.ci
replacd unittests with pytests
…pyter-ai into refactor_split_and_test
andrii-i
reviewed
Jun 4, 2024
andrii-i
reviewed
Jun 4, 2024
andrii-i
reviewed
Jun 4, 2024
andrii-i
requested changes
Jun 4, 2024
andrii-i
reviewed
Jun 5, 2024
… split Further improvements to the code suggested from the review of PR
for more information, see https://pre-commit.ci
andrii-i
reviewed
Jun 5, 2024
andrii-i
reviewed
Jun 5, 2024
There was a problem hiding this comment.
Thank you for the changes @srdas. Everything looks good except of one small comment, please give it a look: #811 (comment)
Changed function level constant from all caps to lower case to line up with the convention in https://peps.python.org/pep-0008/#constants.
andrii-i
approved these changes
Jun 5, 2024
Marchlak
pushed a commit
to Marchlak/jupyter-ai
that referenced
this pull request
Oct 28, 2024
* Refactor split function with test The split function was (1) selecting files in included directories in the top half of the function, and (2) selecting files with valid extensions and sharding them in the second half. This PR divides the split function in a new `collect_files` function that selects files with valid extensions from non-excluded directories, and then passes the valid filepaths into the `split` function, which calls `collect_files`. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Test changed to use pytest * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Refactor split function with test The split function was (1) selecting files in included directories in the top half of the function, and (2) selecting files with valid extensions and sharding them in the second half. This PR divides the split function in a new `collect_files` function that selects files with valid extensions from non-excluded directories, and then passes the valid filepaths into the `split` function, which calls `collect_files`. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Test changed to use pytest * refactored tests for directory.py using pytest fixtures Replaced testing using unittests with testing using pytest fixtures. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove old test files replacd unittests with pytests * Update test_directory.py * Update docstrings and further improve code for retrieve filepaths and split Further improvements to the code suggested from the review of PR * update docstring in test file * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update directory.py Changed function level constant from all caps to lower case to line up with the convention in https://peps.python.org/pep-0008/#constants. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.
[1] The split function was (1) selecting files in included directories in the top half of the function, and (2) selecting files with valid extensions and sharding them in the second half. This PR divides the split function in a new
collect_filesfunction that selects files with valid extensions from non-excluded directories, and then passes the valid filepaths into thesplitfunction, which callscollect_files. This separates the file collection from the sharding in the RAG pipeline.[2] Added a unit test for the new
collect_filesfunction indirectory.py. The refactoring in [1] makes unit testing separately for the file selection component simpler. Added a new test foldertests/doc_loaderswith test filetest_eligible_files.py.