Skip to content

Is name=None correct for NodeImage constructor? #2075

@olehermanse

Description

@olehermanse

Summary

If someone copy-pastes code from this example, they will get type errors in a type checker like pyright.

Detailed Information

The type hints for NodeImage say that name is a str:

https://github.com/apache/libcloud/blob/v3.8.0/libcloud/compute/base.py#L451

However, in one of the examples in docs, name is set to None:

https://github.com/apache/libcloud/blob/v3.8.0/docs/examples/compute/create_ec2_node_custom_ami.py#L22

https://libcloud.readthedocs.io/en/stable/compute/examples.html#create-ec2-node-using-a-custom-ami

This means that a type-checker like pyright will complain if you follow this example.

Should the type hint and/or the example be changed?

My workaround was to add # type: ignore to silence the warning, but I figured I can open an issue in case someone else might run into the same thing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions