Update version to 0.19.* and update stubs

Author: stevenlele

stubs/ruamel.yaml/METADATA.toml

@@ -1,6 +1,6 @@
-version = "0.18.*"
-upstream_repository = "https://sourceforge.net/p/ruamel-yaml/code/"
+version = "0.19.*"
+upstream-repository = "https://sourceforge.net/p/ruamel-yaml/code/"
 
 [tool.stubtest]
 skip = true  # mypy parse errors in upstream package
-stubtest_requirements = ["configobj"]
+stubtest-dependencies = ["configobj"]

stubs/ruamel.yaml/_ruamel_yaml.pyi

@@ -26,7 +26,7 @@ class CParser:
     def check_token(self, *choices: type[Token]) -> bool: ...
     def get_event(self) -> Event | None: ...
     def peek_event(self) -> Event | None: ...
-    def check_event(self, *choices: type[Token]) -> bool: ...
+    def check_event(self, *choices: type[Event]) -> bool: ...
     def check_node(self) -> bool: ...
     def get_node(self) -> Node | None: ...
     def get_single_node(self) -> Node | None: ...

stubs/ruamel.yaml/ruamel/yaml/__init__.pyi

@@ -1,3 +1,5 @@
+from typing import Final
+
 from .comments import CommentedMap as CommentedMap, CommentedSeq as CommentedSeq
 from .constructor import *
 from .cyaml import *
@@ -11,6 +13,6 @@ from .representer import *
 from .resolver import *
 from .tokens import *
 
-version_info: tuple[int, int, int]
-__version__: str
-__with_libyaml__: bool
+version_info: Final[tuple[int, int, int]]
+__version__: Final[str]
+__with_libyaml__: Final[bool]

stubs/ruamel.yaml/ruamel/yaml/comments.pyi

@@ -1,11 +1,12 @@
 import sys
 from _typeshed import SupportsWrite, sentinel
 from collections.abc import Hashable, Iterable, Iterator, Mapping, MutableSet, Set as AbstractSet, Sized
-from typing import Any, Final, Generic, NoReturn, TypeVar
-from typing_extensions import Self, TypeAlias
+from typing import Any, Final, Generic, NoReturn, TypeAlias, TypeVar
+from typing_extensions import Self, deprecated
 
 from .anchor import Anchor
 from .compat import MutableSliceableSequence, ordereddict
+from .mergevalue import MergeValue
 from .nodes import _ScalarNodeStyle
 from .tag import Tag
 from .tokens import CommentToken, _CommentGroup
@@ -51,20 +52,30 @@ class Comment:
     def __init__(self, *, old: bool = True) -> None: ...
     @property
     def items(self) -> dict[_Index | _Key, _CommentGroup]: ...
+
     @property
-    def end(self): ...  # RTSC
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def end(self): ...
     @end.setter
-    def end(self, value) -> None: ...  # RTSC
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def end(self, value) -> None: ...
+
     @property
-    def pre(self): ...  # RTSC
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def pre(self): ...
     @pre.setter
-    def pre(self, value) -> None: ...  # RTSC
-    def get(self, item: _Index | _Key, pos: int): ...  # RTSC
-    def set(self, item: _Index | _Key, pos: int, value: list[int]): ...  # RTSC
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def pre(self, value) -> None: ...
+
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def get(self, item: _Index | _Key, pos: int): ...
+    @deprecated("RTSC functionality is experimental, unsupported, and known to fail")
+    def set(self, item: _Index | _Key, pos: int, value: list[int]): ...
     def __contains__(self, x: str, /) -> bool: ...
 
 class Format:
     attrib: Final = format_attrib
+    _flow_style: bool | None
     def __init__(self) -> None: ...
     def set_flow_style(self) -> None: ...
     def set_block_style(self) -> None: ...
@@ -77,8 +88,8 @@ class LineCol:
     data: dict[_Key, list[int]] | None
     def __init__(self) -> None: ...
     def add_kv_line_col(self, key: _Key, data: list[int]) -> None: ...
-    def key(self, k: str, /) -> tuple[int, int] | None: ...
-    def value(self, k: str, /) -> tuple[int, int] | None: ...
+    def key(self, k: _Key, /) -> tuple[int, int] | None: ...
+    def value(self, k: _Key, /) -> tuple[int, int] | None: ...
     def item(self, idx: int, /) -> tuple[int, int] | None: ...
     def add_idx_line_col(self, key: _Index, data: list[int]) -> None: ...
 
@@ -106,7 +117,7 @@ class CommentedBase:
     def yaml_set_ctag(self, value: Tag, /) -> None: ...
     def copy_attributes(self, t: _Commented, memo: dict[int, Any] | None = None) -> _Commented: ...
 
-class CommentedSeq(MutableSliceableSequence[_T], list[_T], CommentedBase):  # type: ignore[misc]
+class CommentedSeq(MutableSliceableSequence[_T], list[_T], CommentedBase):  # type: ignore[misc]  # pyrefly: ignore [inconsistent-inheritance]
     def __getsingleitem__(self, idx: int) -> _T: ...
     def __setsingleitem__(self, idx: int, value: _T) -> None: ...
     def __delsingleitem__(self, idx: int) -> None: ...
@@ -135,15 +146,15 @@ class CommentedMapValuesView(CommentedMapView, Generic[_VT_co]):
 
 class CommentedMap(ordereddict[_KT, _VT], CommentedBase):
     def insert(self, pos: int, key: _KT, value: _VT, comment: str | None = None) -> None: ...
-    def mlget(self, key: list[_Index | _Key], default: Any = None, list_ok: bool = False) -> Any: ...
+    def mlget(self, key: list[_Index | _Key], default: object = None, list_ok: bool = False) -> object: ...
     def non_merged_items(self) -> Iterator[tuple[_KT, _VT]]: ...
     def keys(self) -> CommentedMapKeysView[_KT]: ...  # type: ignore[override]
     def values(self) -> CommentedMapValuesView[_VT]: ...  # type: ignore[override]
     def items(self) -> CommentedMapItemsView[_KT, _VT]: ...  # type: ignore[override]
     @property
-    def merge(self) -> list[tuple[int, Self]]: ...
+    def merge(self) -> MergeValue | list[Self]: ...
     def add_referent(self, cm: Self) -> None: ...
-    def add_yaml_merge(self, value: list[tuple[int, Self]]) -> None: ...
+    def add_yaml_merge(self, value: MergeValue) -> None: ...
     def update_key_value(self, key: _KT) -> None: ...
     def __deepcopy__(self, memo: dict[int, Any]) -> Self: ...
 
@@ -179,6 +190,6 @@ class TaggedScalar(CommentedBase):
     style: _ScalarNodeStyle | None
     def __init__(self, value: str | None = None, style: _ScalarNodeStyle | None = None, tag: Tag | str | None = None) -> None: ...
     def count(self, s: str, start: int | None = None, end: int | None = None) -> int: ...
-    def __getitem__(self, pos: int) -> str: ...
+    def __getitem__(self, pos: int | slice) -> str: ...
 
 def dump_comments(d: object, name: str = "", sep: str = ".", out: SupportsWrite[str] = sys.stdout) -> None: ...

stubs/ruamel.yaml/ruamel/yaml/compat.pyi

@@ -2,8 +2,8 @@ from _typeshed import SupportsRead, SupportsWrite
 from abc import ABCMeta, abstractmethod
 from collections import OrderedDict
 from collections.abc import Iterable, MutableSequence
-from typing import IO, Any, Final, TypeVar, overload
-from typing_extensions import Self, TypeAlias
+from typing import IO, Any, Final, TypeAlias, TypeVar, overload
+from typing_extensions import Self
 
 from .docinfo import Version
 
@@ -49,14 +49,17 @@ class MutableSliceableSequence(MutableSequence[_T], metaclass=ABCMeta):
     def __getitem__(self, index: int) -> _T: ...
     @overload
     def __getitem__(self, index: slice) -> Self: ...
+
     @overload
     def __setitem__(self, index: int, value: _T) -> None: ...
     @overload
     def __setitem__(self, index: slice, value: Iterable[_T]) -> None: ...
+
     @overload
     def __delitem__(self, index: int) -> None: ...
     @overload
     def __delitem__(self, index: slice) -> None: ...
+
     @abstractmethod
     def __getsingleitem__(self, index: int) -> _T: ...
     @abstractmethod

stubs/ruamel.yaml/ruamel/yaml/composer.pyi

@@ -6,14 +6,16 @@ from .nodes import CollectionNode, MappingNode, Node, ScalarNode, SequenceNode
 from .parser import Parser
 from .resolver import BaseResolver
 
-__all__ = ["Composer", "ComposerError"]
+__all__ = ["Composer", "ComposerError", "MaxDepthExceededError"]
 
 class ComposerError(MarkedYAMLError): ...
+class MaxDepthExceededError(MarkedYAMLError): ...
 
 class Composer:
     loader: YAML | _Loader | None
     anchors: dict[str, Node]
     warn_double_anchors: bool
+    depth: int
     def __init__(self, loader: YAML | _Loader | None = None) -> None: ...
     @property
     def parser(self) -> Parser: ...

stubs/ruamel.yaml/ruamel/yaml/configobjwalker.pyi

@@ -1,7 +1,7 @@
 from collections.abc import Iterator
 from typing_extensions import deprecated
 
-from configobj import ConfigObj  # type: ignore[import-not-found]  # pyright: ignore[reportMissingImports]
+from configobj import ConfigObj as _ConfigObj  # type: ignore[import-not-found]  # pyright: ignore[reportMissingImports]
 
 @deprecated("configobj_walker has moved to ruamel.yaml.util")
-def configobj_walker(cfg: ConfigObj, /) -> Iterator[str]: ...
+def configobj_walker(cfg: _ConfigObj, /) -> Iterator[str]: ...