[refactor] Create a primer package in 'pylint.testutils'

[Pierre-Sassoulas]

Type of Changes

	Type
✓	🐛 Bug fix
✓	✨ New feature
✓	🔨 Refactoring
✓	📜 Docs

Description

First step to be able to add more testable things related to primer here. I'm wondering if an external package called pylint-testutils wouldn't be better at this point. We don't need to ship test helper in pylint, but pytest do not like import from test file contained in tests. We might remove pylint/testutils in 3.0 and always use bleeding edge of the new package in pylint itself.

[Pierre-Sassoulas]

The path to the primer directory to not need to be modified because it's relative (PRIMER_DIRECTORY_PATH = Path("tests") / ".pylint_primer_tests")

[DanielNoord]

I have been thinking about this as well, but let's not do this as long as the primer isn't where we want this to be (parallelisation etc.).

Just giving the list of packages we prime also doesn't make a lot of sense: if anybody would ever want to re-use our primer the first thing they'll likely change is the packages to prime.

[coveralls]

Pull Request Test Coverage Report for Build 2473831366

• 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.0005%) to 95.526%

---

Totals
Change from base Build 2471585025:	0.0005%
Covered Lines:	16354
Relevant Lines:	17120

---

💛 - Coveralls

[Pierre-Sassoulas]

I think temporarily adding primer's helper in pylint.testutils to be able to test them properly is a decent compromise until they mature and we cleanup, what do you think ? I want to test and modify the primer comment next.

[DanielNoord]

Hm, then let's do pylint/testutils/_primer/__init__.py etc.

[DanielNoord]

To preserve backwards compatibility we might want to keep the old file and re-import there with a warning. However, I don't think there will be many packages that use this so let's not do that 😄

[Pierre-Sassoulas]

let's not do that

Yeah agree completely 👍 Package maintainers that discovered our primer's helper are big boys and girls, they can change their export. The cleanup we'll have to do for pylint 3.0 is already beyond epic as is 😄

[github-actions]

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit 9c14297