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

[Adam T. <aa-...@us...>]

Replying to comments from the review file here:

> * Use single quotes for strings (""" for docstrings) (↗policies.txt).
> * Avoid line length > 79 chars.

Yep, will fix

> Missing the "usage" [argument].

Added back, I removed it as it overrides the more helpful message that argparse provides by default but yes there is a remote possibility someone might be using it

> Not needed.  Note the "Filenames will be tilde-expanded later." in the docstring.

I moved the tilde expansion to the class constructor for a minor performance boost.  What I forgot to do was remove the docstring comment.

> Changed behaviour: Users may set ``$DOCUTILSCONFIG=~/.config/docutils.conf``.

I don't think it is, as the "DOCUTILSCONFIG" in environment path includes tilde expansion. The fast path is only when "DOCUTILSCONFIG" does not exist (likely the majority of cases).

> Place at end of file. 

Sure

> We have 3 settings sources: components, config files, command line: * Are settings after updating from config files still "default" settings?

You could argue yes, the settings are the default for the particular environment. Happy to take better suggestions, though.

> I propose a more versatile variant that allows for "settings_overrides" and customization of the config file names.

I see the idea, but I would very strongly advise against -- this is meant to be a simple convinience function. If the more complex functionality is needed later, we can always either add it to the same function, or add a new one. 

> I propose a more general helper function ... Publisher.get_components()

This looks good. I would document it as a private / provisional, method, but I think this could be used now.

A


---

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

**Status:** open
**Created:** Thu Jan 06, 2022 03:02 PM UTC by Günter Milde
**Last Updated:** Tue Feb 08, 2022 05:15 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.