Typing Errors when importing the dagger SDK due to beartype 0.18 | Dagger | Page 1

sour iris Apr 2, 2024, 9:47 AM

#

Hello all, I'm running into issues with my pipelines caused by BearType, that seem to happen just when I'm trying to import the Dagger Python SDK. The exceptions all trace back to just the lines saying from dagger import ...
This is 'pre-zenith' style dagger code, just pipelines I'm executing directly rather than modules. What's weird is that even with previously working versions of the SDK (0.9.8), I'm still seeing the exceptions, so I'm not sure what's going on here...

📎 message.txt

sour iris Apr 2, 2024, 10:13 AM

#

As a note, it's not related to the latest beartype release, because I still see this error even if I downgrade...

sour iris Apr 2, 2024, 10:46 AM

#

I'm digging into this further, and getting some very frustrating errors. I can resolve the warnings about forward references by making all forward references in generic types explicit (e.g. Sequence["Container"] -> Sequence["dagger.client.gen.Container"]), but now I'm also headbutting against string enum defaults where Beartype is complaing that e.g. "media_types" default value 'OCIMediaTypes' violates type hint dagger.client.gen.ImageMediaTypes | None, as str 'OCIMediaTypes' not <class "builtins.NoneType"> or <protocol "dagger.client.gen.ImageMediaTypes">; I'm wondering, is there some kind of configuration setting for beartype I'm missing that will squash this kind of behaviour?

For reference, I'm running Python 3.11 and testing this with dagger 0.10.3

#

Ugh virtualenvs. Okay, so this is related to Beartype v0.18, very sorry for the spam

#

Typing Errors when importing the dagger SDK due to beartype 0.18

plush junco Apr 2, 2024, 11:14 AM

#

cc @torn thistle

sour iris Apr 2, 2024, 11:25 AM

#

From checking the release notes, looks like the default checks are definitely expected in 0.18 and are probably a constraint of using a str/enum mixin for backwards compatibility instead of the new StrEnum type 😌 The forward-references are somewhat less expected.

I don't want to just open a PR on gen.py as of course this is generated code, and how it ends up in the sdk from the GraphQL spec is something I'm not totally clear on 🙂

torn thistle Apr 2, 2024, 11:30 AM

#

Yeah, just caught this in CI (#maintainers message).

naive phoenix Apr 2, 2024, 4:30 PM

#

Also running into this, any success with downgrading beartype?

torn thistle Apr 2, 2024, 4:32 PM

#

naive phoenix Also running into this, any success with downgrading beartype?

Downgrading was done in https://github.com/dagger/dagger/pull/6993, now I'm trying to fix. I don't like how beartype wants me to use full paths in forward references when it's types from the current file!

#

This latest beartype version includes a change I contributed that fixes autocomplete for PyCharm users, so I really want to be able to fix this before next release.

naive phoenix Apr 2, 2024, 4:36 PM

#

torn thistle This latest beartype version includes a change I contributed that fixes autocomp...

yea I really like beartypes philosophy/approach but there seem to be some sharp edges to it

#

is there an ETA on releasing this fix?

torn thistle Apr 2, 2024, 4:39 PM

#

Nope. Looking at it. I know what the issue is, I'm seeing if there's a way to ignore this particular exception.

#

https://github.com/dagger/dagger/pull/6297 introduced a few issues with default values. I was aware of [] being in defaults but wasn't too worried because the client doesn't mutate these values. Apparently beartype wasn't checking default values but now it does and surfaced another case that I wasn't aware of (in enums). So I'm using the warnings from beartype to find these. Already fixed locally so now I'm looking into the final thing which is just making beartype ignore forward references.