Summary

Update force_bytes and force_unicode to support casting objects to strings.

Review Request #13033 — Created May 10, 2023 and submitted May 30, 2023, 3:25 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

force_bytes() and force_unicode() now take a strings_only boolean
argument, which defaults to True for backwards-compatibility. When set
to False, these functions can take any arbitrary object and try to
turn it into a string.

force_bytes() will look for a __bytes__() dunder method, using that to
get the result, and then falling back on __str__().

force_unicode() will just look for __str__(). Since every object has
this, it will technically work with any object.

Typing has been updated to provide overloads based on the strings_only
parameter, helping to ensure callers receive type warnings if they
provide something other than a string without opting into
strings_only=False.

Unit tests have been added to cover this module.

Testing Done

Unit tests pass.

Tested this with some upcoming fixes for command output rendering.

Commits

Summary	ID
Update force_bytes and force_unicode to support casting objects to strings. `force_bytes()` and `force_unicode()` now take a `strings_only` boolean argument, which defaults to `True` for backwards-compatibility. When set to `False`, these functions can take any arbitrary object and try to turn it into a string. `force_bytes()` will look for a `__bytes__()` dunder method, using that to get the result, and then falling back on `__str__()`. `force_unicode()` will just look for `__str__()`. Since every object has this, it will technically work with any object. Typing has been updated to provide overloads based on the `strings_only` parameter, helping to ensure callers receive type warnings if they provide something other than a string without opting into `strings_only=False`. Unit tests have been added to cover this module.	f0ec00cf06f36a3498cec8727d2243e72b235373

Summary

Update force_bytes and force_unicode to support casting objects to strings.

`force_bytes()` and `force_unicode()` now take a `strings_only` boolean argument, which defaults to `True` for backwards-compatibility. When set to `False`, these functions can take any arbitrary object and try to turn it into a string. `force_bytes()` will look for a `__bytes__()` dunder method, using that to get the result, and then falling back on `__str__()`. `force_unicode()` will just look for `__str__()`. Since every object has this, it will technically work with any object. Typing has been updated to provide overloads based on the `strings_only` parameter, helping to ensure callers receive type warnings if they provide something other than a string without opting into `strings_only=False`. Unit tests have been added to cover this module.

f0ec00cf06f36a3498cec8727d2243e72b235373

Issues

Description	From	Last Updated
Can we be specific here that this means "str or bytes"? For a minute I was thinking this was str …	david	May 19, 2023, 4:14 p.m.
Can we be specific here that this means "str or bytes"? For a minute I was thinking this was str …	david	May 19, 2023, 4:15 p.m.

flake8 passed.

JSHint passed.

rbtools/utils/encoding.py (Diff revision 1)

Neat!

rbtools/utils/encoding.py (Diff revision 1)

The issue has been resolved. Show all issues

Can we be specific here that this means "str or bytes"? For a minute I was thinking this was str only, which was quite confusing.

rbtools/utils/encoding.py (Diff revision 1)

The issue has been resolved. Show all issues

Can we be specific here that this means "str or bytes"? For a minute I was thinking this was str only, which was quite confusing.

Change Summary:

Updated docs to be more explicit about byte/Unicode strings, instead of referring to both generically as "strings".

Commits:

	Summary	ID
	Update force_bytes and force_unicode to support casting objects to strings. `force_bytes()` and `force_unicode()` now take a `strings_only` boolean argument, which defaults to `True` for backwards-compatibility. When set to `False`, these functions can take any arbitrary object and try to turn it into a string. `force_bytes()` will look for a `__bytes__()` dunder method, using that to get the result, and then falling back on `__str__()`. `force_unicode()` will just look for `__str__()`. Since every object has this, it will technically work with any object. Typing has been updated to provide overloads based on the `strings_only` parameter, helping to ensure callers receive type warnings if they provide something other than a string without opting into `strings_only=False`. Unit tests have been added to cover this module.	69129cd131e7176fcb0e6fe1f5aab6443c3b6cc7
	Update force_bytes and force_unicode to support casting objects to strings. `force_bytes()` and `force_unicode()` now take a `strings_only` boolean argument, which defaults to `True` for backwards-compatibility. When set to `False`, these functions can take any arbitrary object and try to turn it into a string. `force_bytes()` will look for a `__bytes__()` dunder method, using that to get the result, and then falling back on `__str__()`. `force_unicode()` will just look for `__str__()`. Since every object has this, it will technically work with any object. Typing has been updated to provide overloads based on the `strings_only` parameter, helping to ensure callers receive type warnings if they provide something other than a string without opting into `strings_only=False`. Unit tests have been added to cover this module.	f0ec00cf06f36a3498cec8727d2243e72b235373

Diff:

Revision 2 (+448 -18)

Show changes

	rbtools/utils/encoding.py
	rbtools/utils/tests/test_encoding.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (e0fe507)

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