Repository navigation
Clarify compileall command-line options #54663
Description
| BPO | 10454 |
|---|---|
| Nosy | @birkenfeld, @merwok, @bitdancer |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2010-12-17.16:31:16.594>
created_at = <Date 2010-11-18.16:11:29.291>
labels = ['easy', 'type-bug', 'docs']
title = 'Clarify compileall command-line options'
updated_at = <Date 2011-09-02.16:03:03.999>
user = 'https://github.com/merwok'bugs.python.org fields:
activity = <Date 2011-09-02.16:03:03.999>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2010-12-17.16:31:16.594>
closer = 'r.david.murray'
components = ['Documentation']
creation = <Date 2010-11-18.16:11:29.291>
creator = 'eric.araujo'
dependencies = []
files = ['20086', '22173', '22174']
hgrepos = []
issue_num = 10454
keywords = ['patch', 'easy']
message_count = 9.0
messages = ['121469', '121471', '124171', '124213', '124227', '137194', '138639', '143405', '143406']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'eric.araujo', 'r.david.murray', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue10454'
versions = ['Python 3.1', 'Python 2.7', 'Python 3.2']
Activity
merwok commentedon Nov 18, 2010
This is the help text of compileall:
usage: python compileall.py [-l] [-f] [-q] [-d destdir] [-x regexp] [-i list] [directory|file ...]
-l: don't recurse down
-f: force rebuild even if timestamps are up-to-date
-q: quiet operation
-d destdir: purported directory name for error messages
if no directory arguments, -l sys.path is assumed
-x regexp: skip files matching the regular expression regexp
the regexp is searched for in the full path of the file
-i list: expand list with its content (file and directory names)
-b: Produce legacy byte-compile file paths
I do not understand the help of -d and -i. Experimenting with the script, reading the code and eventually looking at the file history would certainly clear that.
The short usage line at the top also lacks mention of “-b”.
(minor) I want to rephrase -x, -d and -b.
Bug week-end candidate!
[-]Clarify compileall options[/-][+]Clarify compileall command-line options[/+]merwok commentedon Nov 18, 2010
In addition, the line “if no directory arguments, -l sys.path is assumed” seems misplaced.
bitdancer commentedon Dec 17, 2010
Here is a proposed patch to both docs and help output. The help output now looks like this:
usage: compileall.py [-h] [-l] [-f] [-q] [-b] [-d DESTDIR] [-x REGEXP]
[-i FILE]
[FILE|DIR [FILE|DIR ...]]
Utilities to support installing Python libraries.
positional arguments:
FILE|DIR zero or more file and directory names to compile; if no
arguments given, defaults to the equivalent of -l sys.path
optional arguments:
-h, --help show this help message and exit
-l don't recurse into subdirectories
-f force rebuild even if timestamps are up to date
-q output only error messages
-b use legacy (pre-PEP3147) compiled file locations
-d DESTDIR directory to prepend to file paths for use in compile time
tracebacks and in runtime tracebacks in cases where the source
file is unavailable
-x REGEXP skip files matching the regular expression. The regexp is
searched for in the full path to each file considered for
compilation.
-i FILE add all the files and directories listed in FILE to the list
considered for compilation. If "-", names are read from stdin.
birkenfeld commentedon Dec 17, 2010
+1 -- Didn't read through all of the diff, but in general I trust you enough to believe that the new version is better than the old :)
bitdancer commentedon Dec 17, 2010
Committed in r87338. Backporting the relevant bits will be a bit of a pain, anyone who feels like doing it is welcome to. I may or may not get to it myself.
merwok commentedon May 29, 2011
Hi David, I made this patch to port the improvements you made to 2.7. The new usage message looks like this:
usage: python compileall.py [-l] [-f] [-q] [-d destdir] [-x regexp] [-i list] [directory|file ...]
arguments: zero or more file and directory names to compile; if no arguments given,
defaults to the equivalent of -l sys.path
options:
-l: don't recurse into subdirectories
-f: force rebuild even if timestamps are up-to-date
-q: output only error messages
-d destdir: directory to prepend to file paths for use in compile-time tracebacks and in
runtime tracebacks in cases where the source file is unavailable
-x regexp: skip files matching the regular expression regexp; the regexp is searched for
in the full path of each file considered for compilation
-i file: add all the files and directories listed in file to the list considered for
compilation; if "-", names are read from stdin
I noticed some minor style issues, so I (IMO) improved them in my 2.7 patch and made a 3.x patch with the same minor touch-ups.
bitdancer commentedon Jun 19, 2011
Looks fine except for your changes to the parenthesized defaults. Those should be '0' and 'False' for 2.7 and 3.x, respectively, since that's what they areally are.
python-dev commentedon Sep 2, 2011
New changeset 755a57f987ca by Éric Araujo in branch '3.2':
bpo-10454: a few edits to compileall help messages
http://hg.python.org/cpython/rev/755a57f987ca
New changeset 892e0ee4ca32 by Éric Araujo in branch 'default':
Merge doc changes from 3.2 (bpo-10454, bpo-12298)
http://hg.python.org/cpython/rev/892e0ee4ca32
python-dev commentedon Sep 2, 2011
New changeset 4ae85348e3e8 by Éric Araujo in branch '2.7':
Clarify compileall command-line options (bpo-10454).
http://hg.python.org/cpython/rev/4ae85348e3e8