Improve type annotations for io.lobster.{lobsterenv/outputs}

[DanielYang59]

Summary

• Improve type annotations and docstring tweaks for io.lobster.{lobsterenv/outputs}.
• Separate unit tests for lobster inputs and outputs in acc9a1f.

TODOs:

• Test downstream LobsterPy with the script from Improve types for electronic_structure.{bandstructure/cohp} #3873

[JaGeo]

@DanielYang59 I think I am fine with this. Thank you! :)

One point, however: It is really hard to see the diff on the tests. Can you just make sure everything has been moved and that all tests are still in place?

[DanielYang59]

@DanielYang59 I think I am fine with this. Thank you! :)

Thanks a lot for reviewing! No problem.

One point, however: It is really hard to see the diff on the tests. Can you just make sure everything has been moved and that all tests are still in place?

I'm pretty sure I didn't touch the actual content of those tests, just splitting acc9a1f. The slight difference in number of lines should be related to imports.

[JaGeo]

@DanielYang59 Great! Thank you :).

[DanielYang59]

No problem, also pinging @janosh for review. Thanks!

[janosh]

can we change the Literal doc string format to just use pipes? unless someone disagrees with that style?

- (Literal["icoop", "icobi"])
+ ("icoop" | "icobi")

[DanielYang59]

can we change the Literal doc string format to just use pipes?

Yep that's a good point (dropping the Literal is more concise, also just use human-readable things), Google docstring standard doesn't seem to have such detailed rules on typing yet.

I believe there will be other violations, in this case are you aware of any IDE functionality to search for something only in code/comment, which would be very useful if we want to search for Literal in comment only for example (or replace numpy with NumPy but just in comments). I didn't really find one for VScode, excepting for using regular expression but is not very straightforward.

A similar feature request microsoft/vscode#55832 but didn't seem to get implemented.

[janosh]

thanks a lot @DanielYang59! 👍 super fast to address comments as always 😄

[DanielYang59]

No problem. Thanks for reviewing @JaGeo (hope you had a wonderful vacation)

[DanielYang59]

are you aware of any IDE functionality to search for something only in code/comment

I did some search on this, seemingly VS Code doesn't seem to have the feature or from extensions (yet), though there is a related feature request on 2016.

The good news being PyCharm does have this functionality (even for the free community version):