Use ruff to also sort imports

[Matiiss]

Just a capability that was not being utilized (it was done before when we were using black + isort)

From ruff docs:

Sorting imports

Currently, the Ruff formatter does not sort imports. In order to both sort imports and format, call the Ruff linter and then the formatter:

ruff check --select I --fix
ruff format

A unified command for both linting and formatting is planned.

[MyreMylar]

Seems reasonable to me.

I'd rather have these automagically sorted in a consistent manner aligned with python coding standards than having to figure it out myself.

[Matiiss]

I added back the missing import and also rewrote the method to how I've seen it typically typed out elsewhere, such as the CPython repository: https://github.com/search?q=repo%3Apython%2Fcpython%20%22classmethod(types.GenericAlias)%22&type=code

[aatle]

Does the import sorting not also apply to stub files?

[Matiiss]

Does the import sorting not also apply to stub files?

Nope, pyproject.toml contains this

[tool.ruff]
exclude = [
  "buildconfig/",
  "docs/reST/",
  "setup.py",
]

[aatle]

LGTM;

[Matiiss]

There's a little TODO still left:

• configure pyproject.toml to include buildconfig/stubs/pygame and run formatting again

[aatle]

I assumed that would be a separate PR, but I guess it could be put with this one for convenience, placing the large changes together.

[aatle]

This configuration should properly configure the ruff configuration:

[tool.ruff]
extend-exclude = [
    "buildconfig/*.py",  # *.pyi stub files still included
    "docs/reST",
    "setup.py",
]

Alternatively, include can be set to specific directories.

[Matiiss]

This configuration should properly configure the ruff configuration:

[tool.ruff]
extend-exclude = [
    "buildconfig/*.py",  # *.pyi stub files still included
    "docs/reST",
    "setup.py",
]

Alternatively, include can be set to specific directories.

Both options have a flaw I dislike, with the exclude it's not being quite as specific, for example, if there were other .py files in some other directories, they'd still get formatted.
Whereas the include requires being overly specific.

That said, considering that the reason we don't want buildconfig/*.py files formatted is because they're legacy files, if there were new files to be added in some other subdirectory, they'd likely not be a legacy thing and could be easily formatted, so I think I'll go with that approach for now.

I did consult ruff developers, however, it seems there isn't (currently) really a way to include a directory but exclude a specific subdirectory inside of it. (When I say include I mean including in the exclude and similar with excluding from exclude). There was some other quirky behavior I found, but that's besides the point 😁

[MightyJosip]

Can you also add .ruff_cache dir into the gitignore

[Matiiss]

Can you also add .ruff_cache dir into the gitignore

To be fair, it would be ignored by git anyway because it contains an auto-generated .gitignore inside of it, but I added it to the top level .gitignore anyway. (At least it's now visually consistent with other ignored directories 😁)

[aatle]

LGTM; thanks!

(Before merging, pull in from main and run pre-commit so that tests pass.)

[ankith26]

LGTM, thanks for the PR 👍