[Docutils-develop] [docutils:bugs] Re: #441 Move from "optparse" to "argparse".

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

On 2022-01-12, Adam Turner wrote:

>> ... move to dict based arguments_spec

> Fair enough -- I have proposed the simplest possible change, which is
> just replicating `kwargs` of `ArgumentParser.add_argument`. 

We need to keep compatibility the current "settings spec" specification
as this is part of the "drop-in" extension API (used by, e.g.,
"myst-docutils"). After deciding on a new interface (maybe just an
add_argument `kwargs` dict), we can use this in Docutils and deprecate the
old interface.

...

>> once the API sufficiently defined a deprecation policy is agreed

> OK, seems this is a blocker to a few of my proposed changes. I can open
> a ticket to start a discussion if there's not one already?

Yes, this may help.

For the time beeing, we may follow the [Python rules](https://www.python.org/dev/peps/pep-0387/#backwards-compatibility-rules):
incompatible changes require an advance warning at least 2 minor version before
implentation.

The change from 0.x to 1.x, although increasing the major number should
signify a major changes in commitment rather than API.
(cf. https://docutils.sourceforge.io/docs/dev/policies.html#version-identification)

Thanks, Günter

---

** [bugs:#441] Move from "optparse" to "argparse".**

**Status:** open
**Created:** Thu Jan 06, 2022 03:02 PM UTC by Günter Milde
**Last Updated:** Wed Jan 12, 2022 11:43 PM UTC
**Owner:** Günter Milde

The optparse documentation says:
> Deprecated since version 3.2: The optparse module is deprecated and will not be developed further; development will continue with the argparse module.

We are currently suppressing related deprecation warnings in the test suite.
After raising the Python dependency to >=3.7, now may be the right time to make the move.

---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.