Skip to content
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.

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

update salt.utils.stringutils.human_to_bytes for broader use #61833

Merged
merged 2 commits into from
Apr 11, 2022

Conversation

nicholasmhughes
Copy link
Collaborator

What does this PR do?

This PR moves the _handle_unit function from the virt module to the stringutils.human_to_bytes utility in order to replace the narrow functionality there. It also tags the function as a Jinja filter.

What issues does this PR fix or reference?

Fixes: #61831

Previous Behavior

human_to_bytes didn't handle sizes above a petabyte, and also didn't handle units specified in more than a character (KB or KiB vs K).

New Behavior

The function is now much more flexible and is exposed as a Jinja filter.

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@nicholasmhughes nicholasmhughes requested a review from a team as a code owner March 22, 2022 21:05
@nicholasmhughes nicholasmhughes requested review from krionbsd and removed request for a team March 22, 2022 21:05
@github-actions
Copy link

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to
questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings!
When I was created we had a lot of these. The documentation for these
modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these
issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that
you would be the most familiar with this module and be able to add some other
examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you
can't add those other examples, either because you're too busy, or unfamiliar,
or you just aren't interested, we still appreciate the contributions that
you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- duration: 1.14s
- exit code: 1

The function 'nesthash' on 'salt/modules/virt.py' does not have a 'CLI Example:' in it's docstring
The function 'init' on 'salt/modules/virt.py' does not have a 'CLI Example:' in it's docstring
The function 'node_devices' on 'salt/modules/virt.py' does not have a 'CLI Example:' in it's docstring
The function 'network_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in it's docstring
The function 'pool_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in it's docstring
The function 'random' on 'salt/utils/stringutils.py' does not have a docstring
Found 6 errors


Thanks again!

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-ubuntu-2004-amd64-py3-tcp-pytest

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-arch-lts-x86_64-py3-pytest

1 similar comment
@nicholasmhughes
Copy link
Collaborator Author

re-run pr-arch-lts-x86_64-py3-pytest

@garethgreenaway garethgreenaway added the Phosphorus v3005.0 Release code name and version label Apr 7, 2022
Copy link
Contributor

@waynew waynew left a comment

Choose a reason for hiding this comment

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

I suppose Yottabytes is probably a reasonable place to stop for now :trollface:

@Ch3LL Ch3LL merged commit bb21bb3 into saltstack:master Apr 11, 2022
@nicholasmhughes nicholasmhughes deleted the refactor-human_to_bytes branch April 11, 2022 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Phosphorus v3005.0 Release code name and version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE REQUEST] update salt.utils.stringutils.human_to_bytes for broader use
5 participants