Skip to content

Use ruamel.yaml.clib as default #4712

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

Open
LecrisUT wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −1
Open

Use ruamel.yaml.clib as default #4712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pylock.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1924,6 +1924,7 @@ name = "pylero"
version = "0.1.1"
index = "https://pypi.org/simple"
sdist = { url = "https://files.pythonhosted.org/packages/88/38/0c0ccaafbb8594cf50af8d2376a5afee9e7279b7715a928558e7b52eb6f6/pylero-0.1.1.tar.gz", upload-time = 2025-05-30T13:38:52Z, size = 309121, hashes = { sha256 = "de0ccd37da69e50993fe403eca5d093d70c57319640d6af6403ab9a3496ae16c" } }
wheels = [{ url = "https://files.pythonhosted.org/packages/0b/79/4a7ff895325f7226f846cf4e274be9bbeedcd2d9804027c5025e72134ff4/pylero-0.1.1-py3-none-any.whl", upload-time = 2025-12-19T15:11:28Z, size = 101338, hashes = { sha256 = "ada04668e36adaaed950e213699f8442466994142c127a3f07b5e4d19fc9709f" } }]

[[packages]]
name = "python-bugzilla"
Expand Down Expand Up @@ -2402,7 +2403,6 @@ wheels = [{ name = "ruamel_yaml-0.18.16-py3-none-any.whl", url = "https://files.
[[packages]]
name = "ruamel-yaml-clib"
version = "0.2.15"
marker = "python_full_version < '3.14' and platform_python_implementation == 'CPython'"
index = "https://pypi.org/simple"
sdist = { url = "https://files.pythonhosted.org/packages/ea/97/60fda20e2fb54b83a61ae14648b0817c8f5d84a3821e40bfbdae1437026a/ruamel_yaml_clib-0.2.15.tar.gz", upload-time = 2025-11-16T16:12:59Z, size = 225794, hashes = { sha256 = "46e4cc8c43ef6a94885f72512094e482114a8a706d3c555a34ed4b0d20200600" } }
wheels = [
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ dependencies = [
"pygments>=2.7.4",
"requests>=2.25.1",
"ruamel.yaml>=0.16.6",
"ruamel-yaml-clib",
Copy link
Contributor

@graphite-app graphite-app bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making ruamel-yaml-clib an unconditional dependency will break installations on non-CPython implementations (PyPy, Jython, etc.) since it's a C extension only available for CPython. The removed marker in pylock.toml (line 2405) previously restricted it to platform_python_implementation == 'CPython'.

This should be:

"ruamel-yaml-clib; platform_python_implementation == 'CPython'",

Without this marker, pip install will fail on PyPy and other implementations where the C extension cannot be compiled/installed.

Suggested change
"ruamel-yaml-clib",
"ruamel-yaml-clib; platform_python_implementation == 'CPython'",

Spotted by Graphite

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

Copy link
Member Author

@LecrisUT LecrisUT Mar 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting observation. We are implying CPython in many other places though due to other dependencies. Will keep it open for discussions

"urllib3>=1.26.5, <3.0",
"typing-extensions>=4; python_version < '3.13'",
]
Expand Down
2 changes: 2 additions & 0 deletions tmt/utils/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3506,6 +3506,8 @@ def _yaml(
:returns: a loader/dumper instance.
"""

# We use the safe mode as default in order to use CParser from ruamel.yaml.clib
yaml_type = yaml_type or "safe"
yaml = YAML(typ=yaml_type)
Comment on lines +3510 to 3511
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Combine these lines for conciseness.

Suggested change
yaml_type = yaml_type or "safe"
yaml = YAML(typ=yaml_type)
yaml = YAML(typ=yaml_type or "safe")


yaml.indent(mapping=4, sequence=4, offset=2)
Expand Down
5 changes: 5 additions & 0 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading