Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Python: Add type hints python package #10394

Closed
magnesj opened this issue Jun 16, 2023 · 2 comments
Closed

Python: Add type hints python package #10394

magnesj opened this issue Jun 16, 2023 · 2 comments
Assignees
@kriben
Labels
Python Issue related to Python interface
Milestone
Reveal Backlog

Comments

@magnesj
Copy link
Member

magnesj commented Jun 16, 2023 •
edited
Loading

  • investigate how type hinting is used in WebViz
  • investigate how type hints can be used to improve the user experience of the Python API
  • add type hints to generated Python code
  • use type hints in other python code of the library
  • improve class and function documentation

https://mypy.readthedocs.io/en/stable/index.html
https://lynn-kwong.medium.com/use-black-mypy-and-pylint-to-make-your-python-code-more-professional-b594512f4362
https://composed.blog/python/github-actions
https://towardsdatascience.com/introduction-to-mypy-3d32fc96db75

https://github.com/equinor/webviz-subsurface
@magnesj magnesj added the Python Issue related to Python interface label Jun 16, 2023
@magnesj magnesj added this to the Reveal 2023 Sprint 06 milestone Jun 16, 2023
@magnesj
Copy link
Member Author

magnesj commented Jul 6, 2023 •
edited
Loading

See also #10185 #7795

@magnesj
Copy link
Member Author

magnesj commented Aug 7, 2023

Types in grpc
grpc/grpc#32564

kriben added a commit that referenced this issue Aug 9, 2023
@kriben
Python: add type hinting to python code.
954b60c 
Types are checked using mypy.

Fixes #10394.
kriben added a commit that referenced this issue Aug 23, 2023
@kriben
Python: add type hinting to python code.
edf7cce 
Types are checked using mypy.

Fixes #10394.
@kriben kriben closed this as completed in 7aabe8c Aug 23, 2023
@github-actions github-actions bot added the PendingRelease Issues is fixed and will be available in next release label Aug 23, 2023
@magnesj magnesj removed the PendingRelease Issues is fixed and will be available in next release label Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kriben kriben

Labels
Python Issue related to Python interface
Projects
None yet
Milestone
Reveal Backlog
Development

No branches or pull requests
2 participants
@kriben @magnesj