typing: add type hints to cloudinit.distros.parsers.hostname - #6996
Open
GoUrAv-MaLiK wants to merge 1 commit into
Open
typing: add type hints to cloudinit.distros.parsers.hostname#6996GoUrAv-MaLiK wants to merge 1 commit into
GoUrAv-MaLiK wants to merge 1 commit into
Conversation
Annotate HostnameConf and enable check_untyped_defs for the module by removing it from the mypy override list in pyproject.toml. Two issues surfaced by check_untyped_defs are fixed: - self._contents is Optional and is now narrowed with an assert after parse() before it is iterated. - __str__ no longer reuses the 'contents' name for both the StringIO buffer and its rendered string value. Towards canonicalGH-5445.
holmanb
requested changes
Aug 12, 2026
| def __str__(self) -> str: | ||
| self.parse() | ||
| contents = StringIO() | ||
| assert self._contents is not None |
Member
There was a problem hiding this comment.
While this technically is a form of type narrowing, it results in an exception when the assertion is fails.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Enables
check_untyped_defsforcloudinit.distros.parsers.resolv_confby annotatingResolvConfand removing it from the mypy override list inpyproject.toml.self._contentsisOptional; it is now narrowed with anassertafterparse()before it is iterated or appended to. Behaviour is unchanged.Refs GH-5445
tests/unittests/distros/test_resolv.pyProposed Commit Message
Additional Context
Part of the incremental effort in GH-5445 to enable
check_untyped_defsmodule-by-module.Test Steps
Merge type