Document sys.path on Windows

[mhammond]

BPO	459007
Nosy	@tim-one, @mhammond, @freddrake, @akuchling, @birkenfeld, @taleinat, @devdanzin, @tjguk, @merwok, @briancurtin
Files	comment_move_to_windows_rst.patch

^{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: ```python assignee = None closed_at = created_at = labels = ['easy', 'type-bug', 'docs'] title = 'Document sys.path on Windows' updated_at = user = 'https://github.com/mhammond' ``` bugs.python.org fields: ```python activity = actor = 'georg.brandl' assignee = 'docs@python' closed = True closed_date = closer = 'georg.brandl' components = ['Documentation'] creation = creator = 'mhammond' dependencies = [] files = ['18997'] hgrepos = [] issue_num = 459007 keywords = ['patch', 'easy'] message_count = 14.0 messages = ['6408', '6409', '6410', '6411', '55348', '73954', '107993', '110481', '110484', '110486', '110495', '110797', '117290', '118922'] nosy_count = 16.0 nosy_names = ['tim.peters', 'mhammond', 'fdrake', 'akuchling', 'georg.brandl', 'jafo', 'taleinat', 'ajaksu2', 'ruseel', 'tim.golden', 'eric.araujo', 'brian.curtin', 'matthieu.labbe', 'docs@python', 'BreamoreBoy', 'catalin.iacob'] pr_nums = [] priority = 'normal' resolution = 'fixed' stage = 'needs patch' status = 'closed' superseder = None type = 'behavior' url = 'https://bugs.python.org/issue459007' versions = ['Python 2.6', 'Python 3.1', 'Python 2.7', 'Python 3.2'] ```

[mhammond]

I keep promising to document how Python builds the sys.path. Please-holder so Tim has a consistent place to hassle me :)

[freddrake]

Logged In: YES user_id=3066

Raised priority since we keep answering questions about this, and there's now a chance that it'll get done. ;-)

[tim-one]

Logged In: YES user_id=31435

Nice try, Fred -- but I figure Mark knows that if he does this, we'll just ask him to document the registry on Windows too \<wink>.

[freddrake]

Logged In: YES user_id=3066

Only so far as we use it! The _winreg module already has documentation, and no one has filed a bug report on it.

[eacf80b2-9081-4882-a7f5-27e9644c3853]

This is a high priority item that hasn't been touched in half a decade. Mark: Consider this a reminder if this is still on your agenda to do. If not, shall we just close it? Is there anyone else that could do this?

[akuchling]

I think this item doesn't need to be handled by Mark. There's a comment at the top of PC/getpathp.c giving the rules, so it's just a matter of editing the text and adding reST markup. But where in the docs should this material go? using/windows.rst?

[taleinat]

Wow, this has been on hold for ages! I know I could have used this information in the past, and several people have asked me about this.

Perhaps there should be a place in the documentations which explains how sys.path is populated, with detailed explanations for different platforms?

With some guidance as per the right place in the docs for this, I'll gladly work on this. Note that I'm not an expert on this issue, I just plan to gather information form several places and write up a single nice documentation page.

[83d2e70e-e599-4a04-b820-3814bbdb9bef]

Tim, Brian I've added you to the nosy list as I think you could assist. Unless I get a response within the next 10 years I will close this as "out of date"

[merwok]

Out of date seems an inaccurate status to me. Bugs may take weeks to years to be fixed. This one is tagged easy (according to amk in msg73954), so perhaps someone will have a go at it during a Bug Day or a spring, or one of the docs people will just do it (e.g. me after my summer job).

[merwok]

s/spring/sprint/ :)

[mhammond]

FWIW, I think the rules are fairly well explained in the comments in PC/getpathp.c; last time I looked at this, the only thing I couldn't really decide was where in the official docs these comments should be put (after reformatting and minor rewording etc)

[merwok]

using/windows.rst seems the best place to add comments from PC/getpathp.c, under the “Finding modules” section.

[bce94e20-b875-4117-80ad-2a6ef7f1922e]

I made patch which move comment from PC/getpathp.c to Doc/using/windows.rst. And did a little editing, reST markup.

http://codereview.appspot.com/2211046

[birkenfeld]

Thanks for the patch, merged with existing info in using/windows.rst in r85615.