refactor: refactor module names to avoid function/module name clashes #114
+36
−36
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.
Overview
This PR refactors several module filenames in the
gitingest
package to address naming clashes between modules and the functions they export. Additionally, the names of the corresponding test files have been updated to match the new module names.Changes Made
Module Renaming:
clone.py
is nowrepository_clone.py
ingest.py
is nowrepository_ingest.py
ingest_from_query.py
is nowquery_ingestion.py
parse_query.py
is nowquery_parser.py
process_query.py
is noquery_processor.py
Test File Renaming:
test_clone.py
is nowtest_repository_clone.py
, and similarly for other modules.Import Updates:
gitingest/__init__.py
to reflect the new module names.Rationale
The original module names conflicted with their function names, which could lead to confusion and potential import issues. By renaming modules (and their associated test files) to more descriptive names, we improve the clarity of the codebase and prevent future naming conflicts.
Testing
Impact
These changes should be fully backward compatible as public API functions (
clone_repo
,ingest
,ingest_from_query
, andparse_query
) remain the same. The only differences are internal file/module names, which do not affect end-user code relying on the public API.