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

Fix __init__.py being private #1556

Merged

Conversation

not-my-profile
Copy link
Contributor

@not-my-profile not-my-profile commented Jan 2, 2023

Previously visibility::module_visibility() returned Private
for any module name starting with an underscore, resulting in
__init__.py being categorized as private, which in turn resulted
in D104 (Missing docstring in public package) never being reported
for __init__.py files.

The commits implement separate changes, so I'd rather have you not squash them.

@charliermarsh
Copy link
Member

Do you mind expanding the PR summary a bit to flesh out what changed here and why?

Previously visibility::module_visibility() returned Private
for any module name starting with an underscore, resulting in
__init__.py being categorized as private, which in turn resulted
in D104 (Missing docstring in public package) never being reported
for __init__.py files.

This commit fixes this by accounting for __init__.py.
Any string that starts with __ also starts with _
so the latter part of the expression was redundant.
@not-my-profile
Copy link
Contributor Author

But of course :) I amended the commit messages and the PR description.

@charliermarsh
Copy link
Member

Thank you :)

@charliermarsh charliermarsh merged commit 90b2d85 into astral-sh:main Jan 2, 2023
renovate bot referenced this pull request in ixm-one/pytest-cmake-presets Jan 3, 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.206` ->
`^0.0.207` |
[![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.207/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.207/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.207/compatibility-slim/0.0.206)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.207/confidence-slim/0.0.206)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

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

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

#### What's Changed

- Implement list-to-tuple comprehension unpacking by
[@&#8203;colin99d](https://togithub.com/colin99d) in
[https://github.com/charliermarsh/ruff/pull/1534](https://togithub.com/charliermarsh/ruff/pull/1534)
- Avoid triggering PD errors on method calls by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[https://github.com/charliermarsh/ruff/pull/1537](https://togithub.com/charliermarsh/ruff/pull/1537)
- Avoid PD false positives on some non-DataFrame expressions by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[https://github.com/charliermarsh/ruff/pull/1538](https://togithub.com/charliermarsh/ruff/pull/1538)
- Correct UP027 message to “generator expression” by
[@&#8203;andersk](https://togithub.com/andersk) in
[https://github.com/charliermarsh/ruff/pull/1540](https://togithub.com/charliermarsh/ruff/pull/1540)
- Add flake8-simplify SIM300 check for Yoda Conditions by
[@&#8203;PedramNavid](https://togithub.com/PedramNavid) in
[https://github.com/charliermarsh/ruff/pull/1539](https://togithub.com/charliermarsh/ruff/pull/1539)
- Print warning when running debug builds without --no-cache by
[@&#8203;not-my-profile](https://togithub.com/not-my-profile) in
[https://github.com/charliermarsh/ruff/pull/1549](https://togithub.com/charliermarsh/ruff/pull/1549)
- Fix typing::match_annotated_subscript matching ExprKind::Call by
[@&#8203;not-my-profile](https://togithub.com/not-my-profile) in
[https://github.com/charliermarsh/ruff/pull/1554](https://togithub.com/charliermarsh/ruff/pull/1554)
- Add clarification by
[@&#8203;VictorGob](https://togithub.com/VictorGob) in
[https://github.com/charliermarsh/ruff/pull/1557](https://togithub.com/charliermarsh/ruff/pull/1557)
- Add explicit new-rule recommendation in CONTRIBUTING.md by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[https://github.com/charliermarsh/ruff/pull/1558](https://togithub.com/charliermarsh/ruff/pull/1558)
- Detect unpacking assignments in eradicate by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[https://github.com/charliermarsh/ruff/pull/1559](https://togithub.com/charliermarsh/ruff/pull/1559)
- Fix `__init__.py` being private by
[@&#8203;not-my-profile](https://togithub.com/not-my-profile) in
[https://github.com/charliermarsh/ruff/pull/1556](https://togithub.com/charliermarsh/ruff/pull/1556)

#### New Contributors

- [@&#8203;PedramNavid](https://togithub.com/PedramNavid) made their
first contribution in
[https://github.com/charliermarsh/ruff/pull/1539](https://togithub.com/charliermarsh/ruff/pull/1539)
- [@&#8203;VictorGob](https://togithub.com/VictorGob) made their first
contribution in
[https://github.com/charliermarsh/ruff/pull/1557](https://togithub.com/charliermarsh/ruff/pull/1557)

**Full Changelog**:
astral-sh/ruff@v0.0.206...v0.0.207

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43NC4yIiwidXBkYXRlZEluVmVyIjoiMzQuNzQuMiJ9-->

Signed-off-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

2 participants