Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Compatibility fixes for docutils, mistune, argparse #67

Merged
merged 2 commits into from
Nov 17, 2022

Conversation

claui
Copy link
Contributor

@claui claui commented Jul 26, 2022

The following compatibility fixes are required to make m2r work with the current Python ecosystem:

  • Add compatibility with docutils 0.19 (see commit message for details)

  • Require Python 3.7+ due to constraints in docutils 0.19

  • Sync up assertion with changes in argparse

  • Limit mistune dependency version range (details)

- Replace the `ErrorString` symbol with `io.error_string`, see also [1].

- Lose the `SafeString` usage, which is no longer necessary in Python 3.
  [1]

- Add compatibility with docutils 0.19, which removed the deprecated
  symbols `ErrorString` and `SafeString`. [1]

- Drop support for Python 2.7, 3.4, 3.5, and 3.6 because docutils 0.19
  requires Python 3.7 or newer. [2]

- Sync up assertion with changes in argparse

[1]: https://sourceforge.net/p/docutils/code/8937/
[2]: https://sourceforge.net/projects/docutils/files/docutils/0.19/
@claui
Copy link
Contributor Author

claui commented Jul 30, 2022

Related: CrossNox#49

@kloczek
Copy link

kloczek commented Aug 27, 2022

Why not just update mistune 2.x? 🤔

@claui
Copy link
Contributor Author

claui commented Aug 27, 2022

@kloczek That would require a bit of work due to the breaking API.
And I’m not sure whether there’s any maintainer or contributor who would be willing to do the work. This repository feels more or less abandoned.

@kloczek
Copy link

kloczek commented Aug 27, 2022

Old mistune 1.x is no longer maintained so it is only matter of time when it will be necessary to do that.

@claui
Copy link
Contributor Author

claui commented Aug 27, 2022

@kloczek You’re not wrong. If someone steps up and makes it all work with mistune v2, I’ll happily withdraw this PR.

But I’m not really invested in doing all the work myself. Actually, I don’t even use m2r. I’m just a humble package maintainer, who meant to contribute a small patch upstream.

@hmaarrfk
Copy link

hmaarrfk commented Oct 6, 2022

As a user hitting these issues with docutils.core I'm wondering why this isn't merge. I understand the desire to get the mistune stuff fixed. but I think as a whole, this PR is going in the positive direction. The mistune upgrade seems like a distinct task

@CodePint
Copy link

Can we please merge this and worry about a way forward once this is no longer and breaking issue?

@miyakogi miyakogi merged commit b64a06c into miyakogi:dev Nov 17, 2022
@claui claui deleted the docutils-deprecation-fix branch November 17, 2022 11:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants