Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Make ourselves mypy compatible #1237

Closed
Closed
Make ourselves mypy compatible#1237
Assignees
anna-charlotte

Description

@JoanFM
JoanFM
opened on Mar 14, 2023

For DocArray to be recognized by mypy in other downstream projects we have to fill the py.typed file or register at typeshed. Reference: https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-library-stubs-or-py-typed-marker

Activity

  1. JohannesMessner
    added this to DocArray backlogon Dec 16, 2022
  2. JoanFM
    converted this from a draft issue on Mar 14, 2023
  3. anna-charlotte
    self-assigned this
    on Mar 17, 2023

  4. anna-charlotte commented on Mar 17, 2023

    @anna-charlotte
    anna-charlotte
    on Mar 17, 2023
    Contributor

    I think we are already mypy compatible, as far as I understand, the py.typed file just needs to exist, without content.
    Pydantic and FastApi also just have this empty py.typed file.

    Also, I tested this in a separate project, and mypy worked as expected:

    • for docarray, the import works and incorrect type in line 11 is detected
    • for PIL already the import fails, because it does not have type hints

    image

  5. anna-charlotte
    closed this as completedon Mar 17, 2023
  6. github-project-automation
    moved this from Release Committed to Done in DocArray backlogon Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions