ci: added typechecking

[ErikBjare]

While integrating LiteLLM into gptme (ErikBjare/gptme#14), I found that it doesn't properly support typechecking (no py.typed marker file present).

This fixes that, and adds a typechecking workflow to CI.

It also adds a bunch of types-* packages as dev deps. If this is really not wanted (although I don't see why not), it can be replaced by a call to mypy --install-types in CI (but this would require contributors to run the same locally if they want to typecheck).

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
litellm	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 20, 2024 4:07pm

[ErikBjare]

This is now passing and ready to merge!

[krrishdholakia]

Hey @ErikBjare this shows an empty file. Is that expected?

Sorry it took me so long to get to this PR

[ErikBjare]

@krrishdholakia Yes, see https://peps.python.org/pep-0561/ for the spec defining its purpose/meaning.

[jamesbraza]

Just reading this PR, @krrishdholakia just to share for your knowledge, the py.typed file is correct here, it's a marker file (presence/absense) so it's contents doesn't matter (normally it's empty)

• PEP: https://peps.python.org/pep-0561/#packaging-type-information
• For example, PyTorch: https://github.com/pytorch/pytorch/blob/v2.3.0/torch/py.typed

[krrishdholakia]

hey @ErikBjare @jamesbraza is it necessary to add mypy and types in our core dependencies?

for context i'm looking at openai's dependencies and i don't see this there - https://github.com/openai/openai-python/blob/54a5911f5215148a0bdeb10e2bcfb84f635a75b9/pyproject.toml#L10

[jamesbraza]

So these are not the core deps, they're dev (developer) deps. Also, #4136 added mypy to the dev group already, so if this PR were rebased atop main this particular line would go away.

However, the below type stubs added need to stay in dev group dependencies.

Tho I don't think the type stubs should be so specifically pinned, it's okay with something like >= instead of ^

[ErikBjare]

Any plans to get something like this merged? I am still not using LiteLLM in my projects due to the poor typing.

[krrishdholakia]

Closing this pr, as litellm already has a py.typed file -

litellm/litellm/py.typed

Line 2 in 16c0307

# See PEP 561 for more information.

[ErikBjare]

@krrishdholakia This PR did much more than simply add the py.typed file.

For the file to make any sense you have to also typecheck your code, which you still do not seem to do?

[krrishdholakia]

Hi @ErikBjare yep we do -

litellm/.circleci/config.yml

Line 92 in 16c0307

name: Linting Testing

Let me know if i'm missing anything

[ErikBjare]

I see! But omg, that CI config is horrendous. Why aren't you using dependency groups and lock files?

…

On Thu, Sep 26, 2024, 19:23 Krish Dholakia ***@***.***> wrote: Hi @ErikBjare <https://github.com/ErikBjare> yep we do - https://github.com/BerriAI/litellm/blob/16c0307eab601b238f21021b9cba04b6957ad34c/.circleci/config.yml#L92 Let me know if i'm missing anything — Reply to this email directly, view it on GitHub <#1537 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKXDOTNGQGUJML53XK3VTTZYQ7KHAVCNFSM6AAAAABCDIMV22VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZXGUZDIOJTHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>