search

python-lsp / python-lsp-server

Fork of the python-language-server project, maintained by the Spyder IDE team and the community
MIT License
1.75k stars 187 forks source link

pydocstyle is deprecated; GitHub repo has been archived #561

Open penguinpee opened 1 month ago

penguinpee commented 1 month ago

I just noticed that the maintainer of pydocstyle in Fedora has retired the package with a note that upstream abandoned the project. The GitHub repo has been archived as of Nov 3, 2023:

The Pydocstyle project is officially deprecated, and it is no longer actively maintained.

Are there any plans of replacing it? It's listed as a dependency of the all extra, which in turn spyder depends on.

michalspano commented 1 month ago

Good catch, I noticed the same.

penguinpee commented 1 month ago

Upstream recommends using ruff. It feels a bit overkill using that only for checking docstrings. It could easily replace other linters like flake8, black etc. as well.

Some guidance as to possible replacement candidates would be helpful.

ccordoba12 commented 1 month ago

Hey @penguinpee, thanks for reporting. You said:

Are there any plans of replacing it? It's listed as a dependency of the all extra, which in turn spyder depends on.

Not for now, and sorry to say it, but I think the decision you mentioned breaks Spyder's code completion and linting in Fedora.

Upstream recommends using ruff. It feels a bit overkill using that only for checking docstrings.

Agreed. Furthermore, I don't think ruff options map exactly to Pydocstyle ones.

Some guidance as to possible replacement candidates would be helpful.

I don't think there's a direct replacement and we're not going to address this here nor in Spyder for at least six months (perhaps more) because the package is still working (even if not actively developed).

So, I guess your only choice is to patch pylsp and Spyder in Fedora to make things work without Pydocstyle.

penguinpee commented 1 month ago

Thanks for the reply @ccordoba12. If push comes to shove I will have to bite the bullet. But first I will try to get maintenance of pydocstyle transferred to me and resurrect the package.

I'll leave it to you to keep this ticket open as a reminder or close it as deferred.

ccordoba12 commented 1 month ago

But first I will try to get maintenance of pydocstyle transferred to me and resurrect the package.

That's a good idea and will save you from a lot of trouble.

I'll leave it to you to keep this ticket open as a reminder or close it as deferred.

I'll leave it open to not forget to address it in a later release.

penguinpee commented 3 weeks ago

I was looking at the python-lsp-ruff plugin and what it would take to make that available in Spyder akin to python-lsp-black, when I came across this snippet:

'ruff': {
    # Disable it until we have a graphical option for users to
    # enable it.
    'enabled': False,
},

Is this part of spyder-ide/spyder#21357 or spyder-ide/spyder#21040?

I'll be reading through the plugin development documentation next. But before embarking on this adventure, if I feel up to it, I just wanted to make sure, I'm not starting on a project that someone else is already working on.