[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Barry A. Warsaw added the comment: I'm closing this as won't fix since smtpd.py is deprecated and will likely not get any future development. Please see aiosmtpd as a much better third party replacement. -- resolution: -> wont fix stage: patch review -> resolved status: open -> clos

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Changes by Berker Peksag : -- nosy: +berker.peksag stage: -> patch review ___ Python tracker ___ ___ Python-bugs-list mailing list Un

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Mark Lawrence added the comment: Where do we stand with this and #14945 ? -- nosy: +BreamoreBoy versions: +Python 3.5 -Python 3.3 ___ Python tracker ___ _

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Nick Coghlan added the comment: I created #14945 as a suggestion to add a simple page to http://docs.python.org/dev/using/index.html that will provide a central reference to the module documentation for modules with officially supported behaviour when used with the "-m" switch. -- no

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Éric Araujo added the comment: Here are comments on the doc patch. +Run as a script +--- I’d say “Command-Line Interface”. +``smtpd`` is a pluggable RFC 2821-compliant SMTP proxy. :mod:`smtpd` is also a pluggable etc. +.. program:: smtpd.py Strip the .py + the ``setuid`` Please

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Changes by Raymond Hettinger : -- assignee: rhettinger -> ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Éric Araujo added the comment: Meta-bugs are useful for bookkeeping purposes like the implementation of a PEP or a broad feature like “bytes/text model in email” . Just open one report for each module you want to add doc for. -- nosy: +eric.araujo ___

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: > Only "document and formalize" the parts that are well thought out. I don't believe I have the knowledge, right or ability to make that call for any module or package but a pair of extremely obvious ones (http.server seems a pretty good candidate as it's docum

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Raymond Hettinger added the comment: > As I said, my only intention here is be to document > (and argparsify/formalize) what is already there. In a handful of cases, that would be useful; however, for the most part, these APIs were undocumented for a reason. Some of the command-line interface

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Barry A. Warsaw added the comment: On Feb 22, 2011, at 08:15 PM, Xavier Morel wrote: >Barry, do I correctly understand your comment to mean I should write >end-to-end tests of the CLI (until reaching the already tested "meat" of >smtpd), not just the CLI options parsing? Given the way the __ma

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: Barry, do I correctly understand your comment to mean I should write end-to-end tests of the CLI (until reaching the already tested "meat" of smtpd), not just the CLI options parsing? -- ___ Python tracker

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Barry A. Warsaw added the comment: I'd support updating to argparse *if* you write a test suite for full coverage of the existing cli first. Once that passes, you'll have more confidence in your port. Modernizing the argument parsing in that case would be a useful addition. Not critical, b

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: One more note I forgot previously: the conversion of as much scripts as possible to argparse would be for three reasons: * Make behavior consistent across the board (e.g. -h/--help) * Make CLI documentation format consistent across the board either so users kno

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: > any of the undocumented command-line interfaces are intentionally > undocumented -- they were there for the convenience of the developer for > exercising the module as it was being developed and are not part of the > official API. I can understand that, but

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Raymond Hettinger added the comment: Xavier, I think these efforts are misguided in several ways: * Many of the undocumented command-line interfaces are intentionally undocumented -- they were there for the convenience of the developer for exercising the module as it was being developed and are

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: > Do tests currently exist for smtpd run as a script? I have to confess I didn't think to check. > If not, our experience with converting compileall to argparse indicates a > thorough test suite is needed (and even so we missed some things we hadn't > thought

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

R. David Murray added the comment: Thanks for taking an interest in this and working up a patch. Unfortunately I do have some concerns. As far as I know the only module that currently uses argparse is compileall, which was only changed recently. Do tests currently exist for smtpd run as a s

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

Xavier Morel added the comment: Second patch: documenting smtpd-as-a-script in the module's rst -- Added file: http://bugs.python.org/file20813/smtpd-as-script-doc.diff ___ Python tracker _

[issue11260] smtpd-as-a-script feature should be documented and should use argparse

New submission from Xavier Morel : argparse has been merged to the standard library in 3.2, and (tell me if I'm wrong) would therefore be the "best-practices" way to parse command-line arguments. Numerous stdlib modules can be used as scripts, but they tend to have ad-hoc documentation (if th