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

Implement yield-to-yield from conversion #1544

Merged
merged 19 commits into from Jan 4, 2023
Merged

Implement yield-to-yield from conversion #1544

merged 19 commits into from Jan 4, 2023

Conversation

colin99d
Copy link
Contributor

@colin99d colin99d commented Jan 2, 2023

A part of #827.

I am creating this draft pr for visibility. This is easily the most challenging fixer I have done, due to the infinite amount of nesting of functions inside functions allowed in python. Because of this I have created a recursive function to get all potential yield from statements. There is still a lot of work to be done, but I just wanted to push this in case anyone sees a much simpler way to do it.

@colin99d colin99d marked this pull request as ready for review January 2, 2023 17:47
@colin99d
Copy link
Contributor Author

colin99d commented Jan 2, 2023

This is done and ready for review. It passes all the tests provided by pyupgrade except for one case I document in the code. Current issues are as follows:

  1. Our implementation keeps more comments than pyupgrade does (this is the issue mentioned above). However, I think this is more of a plus than a minus. I REALLY doubt people want their comments removed by our linter.
  2. The implementation would fail if before or after the loop x is defined as a separate thing and used. Our implementation would err in the side of NOT making changes.

@charliermarsh
Copy link
Member

Will try to get to this tomorrow, thanks!

@charliermarsh charliermarsh changed the title Pyupgrade: Yieldfrom Implement yield-to-yield from conversion Jan 4, 2023
@charliermarsh charliermarsh merged commit fb1a638 into astral-sh:main Jan 4, 2023
}

/// UP028
pub fn rewrite_yield_from(checker: &mut Checker, stmt: &Stmt) {
Copy link
Member

Choose a reason for hiding this comment

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

@colin99d - I ended up refactoring this quite a bit. You might be interested in checking out the current implementation. The logic is roughly: do one pass over the function to find any candidate yield statements to convert, do a second pass to find any references to variables, then cross-reference to ensure we don't rewrite any yields whose variables are referenced elsewhere.

renovate bot added a commit to ixm-one/pytest-cmake-presets that referenced this pull request Jan 4, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.209` ->
`^0.0.210` |
[![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.210/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.210/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.210/compatibility-slim/0.0.209)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.210/confidence-slim/0.0.209)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>charliermarsh/ruff</summary>

###
[`v0.0.210`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.210)

[Compare
Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.209...v0.0.210)

#### What's Changed

- Do not Change Quotation Style for `PT006` Autofix by
[@&#8203;saadmk11](https://togithub.com/saadmk11) in
[astral-sh/ruff#1600
- Implement autofix for `PT022` by
[@&#8203;harupy](https://togithub.com/harupy) in
[astral-sh/ruff#1604
- Add isort.order-by-type boolean setting by
[@&#8203;mattoberle](https://togithub.com/mattoberle) in
[astral-sh/ruff#1607
- Fix \*arg and \*\*kwarg handling for Google docstrings by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1608
- Associate inline comments with parenthesized `ImportFrom` statements
by [@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1609
- Fix leftover whitespace when removing `pass` for `PIE790` by
[@&#8203;edgarrmondragon](https://togithub.com/edgarrmondragon) in
[astral-sh/ruff#1612
- Treat .pyi files as **future** annotations-enabled by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1616
- Treat convention as setting ignore, rather than select by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1611
- Avoid byte-string conversions by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1618
- Implement missing fixes for `PT006` by
[@&#8203;edgarrmondragon](https://togithub.com/edgarrmondragon) in
[astral-sh/ruff#1622
- Implement `yield`-to-`yield from` conversion by
[@&#8203;colin99d](https://togithub.com/colin99d) in
[astral-sh/ruff#1544
- Add some more users to the README by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#1623
- Check `SIM118` in comprehension by
[@&#8203;harupy](https://togithub.com/harupy) in
[astral-sh/ruff#1627

#### New Contributors

- [@&#8203;mattoberle](https://togithub.com/mattoberle) made their first
contribution in
[astral-sh/ruff#1607

**Full Changelog**:
astral-sh/ruff@v0.0.209...v0.0.210

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC44MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuODEuMCJ9-->

Signed-off-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@colin99d colin99d deleted the yieldfrom branch January 5, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants