olehermanse opened a new issue, #2075:
URL: https://github.com/apache/libcloud/issues/2075

   ## Summary
   
   If someone copy-pastes code from [this 
example](https://github.com/apache/libcloud/blob/v3.8.0/docs/examples/compute/create_ec2_node_custom_ami.py#L22),
 they will get type errors in a type checker like 
[pyright](https://github.com/microsoft/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.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@libcloud.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to