Skip to content

chore(ingest): use builtin tuple, drop typing.Tuple, add docstring#7094

Open
oab24413gmai wants to merge 1 commit into
chroma-core:mainfrom
oab24413gmai:chore/ingest-modernize-tuple-import
Open

chore(ingest): use builtin tuple, drop typing.Tuple, add docstring#7094
oab24413gmai wants to merge 1 commit into
chroma-core:mainfrom
oab24413gmai:chore/ingest-modernize-tuple-import

Conversation

@oab24413gmai
Copy link
Copy Markdown

Small modernization in chromadb/ingest/impl/utils.py:

  • Drop the unused from typing import Tuple and use the builtin tuple[...] in the parse_topic_name return annotation (project already targets a Python version where this is supported).
  • Add a one-line docstring to create_topic_name for parity with its sibling.

No behavior change.

Replace typing.Tuple with builtin tuple (PEP 585) in parse_topic_name
return annotation, and add a docstring to create_topic_name for
consistency with parse_topic_name.
@github-actions
Copy link
Copy Markdown

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant