Skip to content

Fix access to opts and sls vars in pyobjects renderer #62337

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

Merged
merged 1 commit into from
Jul 20, 2022

Conversation

nicholasmhughes
Copy link
Collaborator

What does this PR do?

This PR adds access to the minion options dictionary and SLS name of the state file being run in the pyobjects renderer.

What issues does this PR fix or reference?

Fixes: 62336

Previous Behavior

No access to __opts__ or __sls__

New Behavior

Access to __opts__ and __sls__

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 July 17, 2022 17:11
@nicholasmhughes nicholasmhughes requested review from ScriptAutomate and removed request for a team July 17, 2022 17:11
@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
- exit code: 1

/home/runner/.cache/pre-commit/repoze03h4o4/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'render' on 'salt/renderers/pyobjects.py' does not have a docstring
Found 1 errors


Thanks again!

1 similar comment
@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
- exit code: 1

/home/runner/.cache/pre-commit/repoze03h4o4/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'render' on 'salt/renderers/pyobjects.py' does not have a docstring
Found 1 errors


Thanks again!

@nicholasmhughes nicholasmhughes added the Sulfur v3006.0 release code name and version label Jul 17, 2022
@nicholasmhughes
Copy link
Collaborator Author

re-run full all

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-debian-11-arm64-py3-pytest

@nicholasmhughes
Copy link
Collaborator Author

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

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-ubuntu-2204-amd64-py3-pytest

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-windows-2019-x64-py3-pytest

@nicholasmhughes
Copy link
Collaborator Author

re-run pr-debian-9-amd64-py3-pytest

@Ch3LL Ch3LL merged commit 58e3546 into saltstack:master Jul 20, 2022
@nicholasmhughes nicholasmhughes deleted the fix-pyobjects-opts branch August 22, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sulfur v3006.0 release code name and version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants