gordonbondon / kubernetes-typed

mypy plugin to type check Kubernetes resources

Hey, I'm Artem! 👋

Between dealing with complex codes at my $DAYJOB and enjoying life outside engineering I occasionally try to share things I've done.

Here are some of them, categorized:

Terraform

• terraform-provider-webhookrelay
• terraform-provider-maxminddb
• terraform-aws-wafv2-maxminddb
• terraform-common-verify

Kubernetes

• kubernetes-typed

Chef

• choregraphie-dynamodb-lock

Go

And other random tools, mostly written in go:

• maxminddb-cidrs
• go-webhookrelay
• gitlab-project-settings

kubernetes-typed's Issues

Remove (or update) version constraints on mypy

Currently, this package depends on mypy>=0.800, <=0.910 which makes it impossible to use it with python 3.10+ if you use the match Expression, as this has been added in mypy >= 0.940.

Why is the version of mypy constrained in the setup.py anyway? Would it be possible to remove this constaint? Or at least release an updated version?

Thanks in advance!

upper bound on mypy dependency

The setup.py file declares an upper bound on the mypy dependency

kubernetes-typed/setup.py

Line 77 in 82995b0

"mypy>=0.800, <=0.910",

Is there a particular reason for that? Newer versions of mypy often come with good bugfixes, I'd like to use this package with a newer mypy version, if possible.

Add new dynamic class CustomResourceDict with version support

Current approach with CustomResource["relative/path/to/crd.yaml", "spec", "some_property"] is limited to having only one definition/version in crd file and its impossible to extend with new options. Returned errors always mention TypedDict('Jsonschema') which is not userfriendly.

Instead, we should use get_dynamic_class_hook https://github.com/python/mypy/blob/3acbf3fe78a61c19ff96754233ada453472004c4/mypy/plugin.py#L692-L705 to provide more options while creating custom resource type definition. Possible syntax:

MyResource = CustomResourceDict(
    definition_path="/path/to/crd.yaml",
    property_path: ["spec", "some_property"]
    group: "myapi.io",
    version: "v1",
    kind: "MyResource"
)

First iteration should include these features:

• CustomResourceDict dynamic hook
• Handle multiple versions per CustomResourceDefinition
• Handle multiple definitions per file
• Set TypeDict name from kind

Similar to https://github.com/lovasoa/marshmallow_dataclass/blob/513e8bfc0dcef02314180790486cea3c04f65178/marshmallow_dataclass/mypy.py

Circular references

Hi there,

I'm getting the below error when using this:

from kubernetes_typed.client import V1PodDict

ImportError: cannot import name 'AdmissionregistrationV1ServiceReferenceDict' from partially initialized module 'kubernetes_typed.client' (most likely due to a circular import) (/home/user/repos/xxx/k8s-monitor/.venv/lib/python3.8/site-packages/kubernetes_typed/client/__init__.py)

Leveraging Kubernetes-typed to augment IntelliSense functionality

Is it possible to utilize Kubernetes-typed to enhance IntelliSense capabilities within VSCode/Pyright?