edtlib: Add static type hint stub files for mypy

[rruuaanng]

Add stub files (.pyi) for "edtlib.py" and "dtlib.py" to improve mypy static analysis and code completion.

[rruuaanng]

Let me restart the ci process.

Edit:

It seems to work.

[rruuaanng]

@mbolivar @pdgendt Please review it again!

[pdgendt]

Please review it again!

Hmn, with the ruff checks now added, I think it would be best to fix the following issues too:

# in .ruff-excludes.toml
"./scripts/dts/python-devicetree/src/devicetree/dtlib.py" = [
    "UP007",    # https://docs.astral.sh/ruff/rules/non-pep604-annotation
]
"./scripts/dts/python-devicetree/src/devicetree/edtlib.py" = [
    "UP007",    # https://docs.astral.sh/ruff/rules/non-pep604-annotation
]

So that the interface and actual implementation have the same declarations.

[github-actions]

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

[github-actions]

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

[henrikbrixandersen]

@rruuaanng Please rebase on main and resolve any merge conflicts.

[rruuaanng]

@henrikbrixandersen
I'll deal with it after the vacation :)

[mbolivar]

@rruuaanng can you please check CI and update again so we can get this in?

[kartben]

It feels like some documentation needs to be added as to how/when these files need to be regenerated?

@rruuaanng I think this never got addressed? How/when do you expect people to update these files? There's already good do's/don'ts at the top of dtlib/edtlib files so it would probably be good to add a not there w.r.t what people must do what they add new APIs etc

[sonarqubecloud]

Please retry analysis of this Pull-Request directly on SonarQube Cloud

[rruuaanng]

It feels like some documentation needs to be added as to how/when these files need to be regenerated?

@rruuaanng I think this never got addressed? How/when do you expect people to update these files? There's already good do's/don'ts at the top of dtlib/edtlib files so it would probably be good to add a not there w.r.t what people must do what they add new APIs etc

Maybe I should mention that in the README. I'll add it.