Adding Pycln QA tool to the pre-commit config by hadialqattan · Pull Request #5234 · python-poetry/poetry

hadialqattan · 2022-02-25T13:28:24Z

Pull Request Check List

Resolves: #5233

Added tests for changed code. (no need)
Updated documentation for changed code. (no need)

Why?

I found a comment from one of your maintainers/active contributors that say a PR adding Pycln to the pre-commit hooks is welcome.

This is the comment:

A second PR adding pycln to the pre-commit config would be welcome, I think.

Consensus seems to be that the new Union syntax is harmless and nicer to write. Let's go ahead with this.

Originally posted by @neersighted in #5088 (comment)

Also, I found Pycln a good addition to improve the code quality of Poetry, therefore I've created this PR.

BTW, I'm the author of Pycln.

hadialqattan · 2022-02-25T13:46:51Z

 #!/usr/bin/env python
 # Learn more: https://github.com/kennethreitz/setup.py
 import os
-import re


Detected and removed by pycln.

hadialqattan · 2022-02-25T13:47:49Z

 from distutils.core import setup

-from build import *
+from build import *  # nopycln: import


# nopycln: import can be replaced with # noqa if you prefer that.

hadialqattan · 2022-02-25T13:48:18Z

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-import io


Detected and removed by pycln.

hadialqattan · 2022-02-25T13:52:37Z

 from poetry.repositories.repository import Repository
+
+
+__all__ = ["Pool", "Repository"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:52:45Z

 from poetry.puzzle.solver import Solver
+
+
+__all__ = ["Solver"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:52:50Z

 from poetry.publishing.publisher import Publisher
+
+
+__all__ = ["Publisher"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:52:57Z

-from poetry.packages.package_collection import PackageCollection
+
+
+__all__ = ["DependencyPackage", "Locker"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:53:02Z

 )
+
+
+__all__ = ["PythonRequirementSolution"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:53:08Z

 )
+
+
+__all__ = ["PythonRequirementSolutionProvider"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:53:13Z

 from poetry.masonry.builders.editable import EditableBuilder
+
+
+__all__ = ["EditableBuilder"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-25T13:53:19Z

 from poetry.installation.installer import Installer
+
+
+__all__ = ["Installer"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

branchv

thanks @hadialqattan! I'm a huge fan of this addition, and pycln. thanks for creating it 👏

I just have one question about the import you manually removed

hadialqattan · 2022-02-26T08:32:35Z

thanks @hadialqattan! I'm a huge fan of this addition, and pycln. thanks for creating it 👏

I just have one question about the import you manually removed

Thank you for showing your interest in my tool, I appreciate that.

The import statement that I've removed manually seems like it's not used anywhere in the project.

hadialqattan · 2022-02-28T11:18:17Z

 from poetry.packages.package_collection import PackageCollection
+
+
+__all__ = ["DependencyPackage", "Locker", "PackageCollection"]


Why have I added __all__ dunder? __init__.py without __all__ (Pycln Docs)

hadialqattan · 2022-02-28T11:23:38Z

I don't know why pre-commit is complaining about something has nothing todo with this PR:

pyupgrade................................................................Failed
- hook id: pyupgrade
- exit code: 1
- files were modified by this hook

Rewriting tests/console/commands/test_run.py
Rewriting tests/console/commands/test_show.py

finswimmer · 2022-02-28T16:30:37Z

I don't know why pre-commit is complaining about something has nothing todo with this PR

Rebasing onto master should fix it now (see #5247)

branchv

thanks @hadialqattan, this looks good to me. let's wait for more opinions

hadialqattan · 2022-03-04T20:15:03Z

BTW, I have included a used by section in the README file containing a list of notable projects/organizations that use Pycln.

hadialqattan · 2022-03-10T19:10:34Z

@branchvincent

A gentle ping...

Secrus · 2022-05-17T13:15:57Z

@hadialqattan Could you please merge changes from master? I will make sure the team takes a look at this ;)

hadialqattan · 2022-05-17T16:14:36Z

Hi @Secrus, sure, I'm gonna work on that as soon as possible. I'll let know you when the PR is ready to go.

hadialqattan · 2022-05-17T16:49:52Z

@Secrus I believe that the PR is ready now.

branchv · 2022-05-19T22:41:40Z

@hadialqattan sorry for forgetting about this! If you're up for it, https://github.com/python-poetry/poetry-core would definitely benefit from this as well

hadialqattan · 2022-05-20T05:26:33Z

@hadialqattan sorry for forgetting about this! If you're up for it, https://github.com/python-poetry/poetry-core would definitely benefit from this as well

That sounds good..

I'm gonna open a PR there as soon as possible!

hadialqattan · 2022-05-21T15:30:33Z

@branchvincent it's ready PR360.

github-actions · 2024-02-29T14:08:13Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

hadialqattan commented Feb 25, 2022

View reviewed changes

Comment thread src/poetry/utils/_compat.py Resolved

hadialqattan commented Feb 25, 2022

View reviewed changes

Comment thread src/poetry/packages/__init__.py Resolved

branchv requested changes Feb 25, 2022

View reviewed changes

Comment thread .pre-commit-config.yaml Resolved

Comment thread src/poetry/packages/__init__.py Resolved

Comment thread src/poetry/utils/_compat.py Resolved

hadialqattan requested a review from branchv February 26, 2022 08:27

hadialqattan mentioned this pull request Feb 26, 2022

Pycln QA tool as a pre-commit hook Textualize/rich#2001

Merged

3 of 9 tasks

hadialqattan closed this Feb 28, 2022

hadialqattan force-pushed the master branch from 8507fcb to e403ff4 Compare February 28, 2022 11:07

hadialqattan reopened this Feb 28, 2022

hadialqattan commented Feb 28, 2022

View reviewed changes

hadialqattan force-pushed the master branch from 8a0688b to ffce803 Compare February 28, 2022 18:36

branchv previously approved these changes Feb 28, 2022

View reviewed changes

hadialqattan dismissed branchv’s stale review via 0244430 March 12, 2022 13:28

hadialqattan requested a review from branchv March 12, 2022 13:30

neersighted closed this May 4, 2022

neersighted reopened this May 4, 2022

Secrus added status/waiting-on-response Waiting on response from author Cleanup labels May 17, 2022

hadialqattan added 2 commits May 17, 2022 19:12

Add pycln QA tool as a pre-commit hook.

34b9ff2

Update pycln to v1.2.5

1e38365

hadialqattan force-pushed the master branch from 0244430 to 1e38365 Compare May 17, 2022 16:14

hadialqattan added 2 commits May 17, 2022 19:16

Upgrade pycln pre-commit hook to 1.3.2

fb5422f

A new unused import detected by Pycln.

1817966

Secrus removed the status/waiting-on-response Waiting on response from author label May 17, 2022

In v1.3.2 this is unnecessary pycln-skip.

4c10427

Secrus approved these changes May 17, 2022

View reviewed changes

Secrus requested a review from a team May 17, 2022 16:34

neersighted approved these changes May 17, 2022

View reviewed changes

neersighted merged commit d0aa6e8 into python-poetry:master May 17, 2022

hadialqattan mentioned this pull request May 20, 2022

Add: pycln as a pre-commit hook python-poetry/poetry-core#360

Merged

kasteph mentioned this pull request May 30, 2022

Release 1.2.0b2 #5725

Merged

github-actions Bot locked as resolved and limited conversation to collaborators Feb 29, 2024

		from poetry.repositories.repository import Repository


		__all__ = ["Pool", "Repository"]

		from poetry.publishing.publisher import Publisher


		__all__ = ["Publisher"]

		from poetry.packages.package_collection import PackageCollection


		__all__ = ["DependencyPackage", "Locker"]

		from poetry.masonry.builders.editable import EditableBuilder


		__all__ = ["EditableBuilder"]

		from poetry.installation.installer import Installer


		__all__ = ["Installer"]

Conversation

hadialqattan commented Feb 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Check List

Why?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

branchv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hadialqattan commented Feb 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hadialqattan commented Feb 28, 2022

Uh oh!

finswimmer commented Feb 28, 2022

Uh oh!

branchv left a comment

Choose a reason for hiding this comment

Uh oh!

hadialqattan commented Mar 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hadialqattan commented Mar 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Secrus commented May 17, 2022

Uh oh!

hadialqattan commented May 17, 2022

Uh oh!

hadialqattan commented May 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

branchv commented May 19, 2022

Uh oh!

hadialqattan commented May 20, 2022

Uh oh!

hadialqattan commented May 21, 2022

Uh oh!

github-actions Bot commented Feb 29, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hadialqattan commented Feb 25, 2022 •

edited

Loading

hadialqattan commented Mar 4, 2022 •

edited

Loading

hadialqattan commented Mar 10, 2022 •

edited

Loading

hadialqattan commented May 17, 2022 •

edited

Loading