Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: bypass kwargs to SimpeDirectoryReader with better type hinting #16858

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

himself65
Copy link
Member

@himself65 himself65 commented Nov 6, 2024

Description

Expose args type from SimpleDirectoryReader for downstream file-system like data source

Follow PEP 692, improve type hinting for SimpleDirectoryReader

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

  • Yes
  • No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.

  • I added new unit tests to cover this change
  • I believe this change is already covered by existing unit tests

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

@himself65 himself65 force-pushed the himself65/20241106/directory-reader branch from 068c260 to 3160214 Compare November 6, 2024 21:35
@himself65 himself65 marked this pull request as ready for review November 6, 2024 22:29
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Nov 6, 2024
@himself65 himself65 changed the title feat: expose directory args feat: expose DirectoryReaderArgs and LoadFileArgs Nov 6, 2024
@himself65 himself65 changed the title feat: expose DirectoryReaderArgs and LoadFileArgs feat: bypass kwargs to SimpeDirectoryReader with better type hinting Nov 6, 2024
@himself65 himself65 force-pushed the himself65/20241106/directory-reader branch from bace166 to 0de0b68 Compare November 7, 2024 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant