Summary

Remove deprecation for passing non-string values to API add_field.

Review Request #14489 — Created June 28, 2025 and submitted July 11, 2025, 9:29 a.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

The API request add_field method has had a deprecation warning for a
while about passing in values that are not either str or bytes. This
change replaces the warning+cast with an exception.

There were a few places inside RBTools itself that were still hitting
this, all in the post implementation. These have been fixed up to format
the values as strings.

Testing Done


Ran unit tests.
Audited call sites to verify that we were passing string types

  everywhere.
Posted changes, including ones that needed to upload binary files.

Commits

Summary	ID
Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	7f16aed79145ff42fa8127f18108abd007bfd679

Summary

Remove deprecation for passing non-string values to API add_field.

The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.

7f16aed79145ff42fa8127f18108abd007bfd679

Issues

Description	From	Last Updated
We should prefix all strings with f when any in a multi-line string needs it. This avoids some warnings. What's …	chipx86	July 3, 2025, 9:51 a.m.
I feel like in the cases where we want to convert to a string, we should just cut out the …	chipx86	July 3, 2025, 9:51 a.m.
We should add a new version changed entry to say that only bytes and strings are accepted.	maubin	July 7, 2025, 2:35 p.m.
We can get rid of this.	maubin	July 7, 2025, 2:35 p.m.

flake8 passed.

JSHint passed.

rbtools/api/request.py (Diff revision 1)

The issue has been resolved. Show all issues

We should prefix all strings with f when any in a multi-line string needs it. This avoids some warnings.

What's the type: ignore for?

david July 3, 2025, 9:57 a.m.

value is typed as bytes | str, so any code inside this if statement will be flagged as unreachable if we don't have this.

chipx86 July 7, 2025, 2:31 p.m.

Oh, that's surprisingly annoying.

What happens if you instead add in there: assert not TYPE_CHECKING?

david July 7, 2025, 2:34 p.m.

The assert line gets flagged as unreachable (lol)

chipx86 July 7, 2025, 2:36 p.m.

Type checkers, why are you the way that you are.

Okay, typing_extensions.assert_never() seems to be for this purpose.

chipx86 July 7, 2025, 2:37 p.m.

But notably would raise an exception. So we'd have to wrap in TYPE_CHECKING, I guess.

rbtools/commands/post.py (Diff revision 1)

The issue has been resolved. Show all issues

I feel like in the cases where we want to convert to a string, we should just cut out the middle-man and use str(...) directly. This avoids the extra processing and results in the same thing.

Commits:

	Summary	ID
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Did some smoke testing of posting changes.	9c67b0acd147822e9d888e45e2fc5f7be93187a7
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	dd4e668a91ea3a9f59ce3132c9b0c6b03984be46

Diff:

Revision 2 (+56 -28)

Show changes

	rbtools/api/request.py
	rbtools/commands/post.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

rbtools/api/request.py (Diff revision 2)

The issue has been resolved. Show all issues

We should add a new version changed entry to say that only bytes and strings are accepted.

rbtools/api/request.py (Diff revision 2)
The issue has been resolved. Show all issues
```
We can get rid of this.
```

Commits:

	Summary	ID
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	dd4e668a91ea3a9f59ce3132c9b0c6b03984be46
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	e0522dd3779d3af6579b2490d7b3000f817b57a3

Diff:

Revision 3 (+116 -46)

Show changes

	rbtools/api/request.py
	rbtools/commands/post.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	ID
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	e0522dd3779d3af6579b2490d7b3000f817b57a3
	Remove deprecation for passing non-string values to API add_field. The API request `add_field` method has had a deprecation warning for a while about passing in values that are not either `str` or `bytes`. This change replaces the warning+cast with an exception. There were a few places inside RBTools itself that were still hitting this, all in the post implementation. These have been fixed up to format the values as strings. Testing Done: - Ran unit tests. - Audited call sites to verify that we were passing string types everywhere. - Posted changes, including ones that needed to upload binary files.	7f16aed79145ff42fa8127f18108abd007bfd679

Diff:

Revision 4 (+122 -46)

Show changes

	rbtools/api/request.py
	rbtools/commands/post.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (c03889f)