Mailman 3 June 2015 - docs

[issue17546] Document the circumstances where the locals() dict get updated
by Nick Coghlan June 29, 2015

June 29, 2015

Nick Coghlan added the comment: I mostly like Martin's suggested wording, but would also note that I filed issue 17960 to tighten up the requirements for when we expect assigning to locals() to work. To save folks reading the whole referenced email, I think it would be worth defining that modifying the namespace returned by locals() will affect the runtime namespace at module and class scope and when using exec, but will have no effect at function scope (as locals() returns a copy of the … [View More]

1 0

[issue17546] Document the circumstances where the locals() dict get updated
by Martin Panter June 29, 2015

June 29, 2015

Martin Panter added the comment: Here is another attempt with different words: ''' .. note:: The dictionary returned by :func:`locals` is an accurate snapshot of the local namespace at the time it is called. If the namespace changes after the call, the dictionary may become out of date, but it may also automatically update at any time. The contents of the dictionary should not be modified by the user; it is undefined whether such changes affect the namespace or not. ''' ---------- … [View More]

1 0

[issue20281] time.strftime %z format specifier is the same as %Z
by R. David Murray June 26, 2015

June 26, 2015

R. David Murray added the comment: Because there's a different issue for making strftime system independent, issue 3173. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20281> _______________________________________

1 0

[issue20281] time.strftime %z format specifier is the same as %Z
by dendory June 26, 2015

June 26, 2015

dendory added the comment: Why is the focus on documentation entries when the real work should be on trying to make this function to work on all platforms? I understand that Windows's implementation of strftime() defines %z and %Z to return the same thing, but timezone information is still available in other ways. For example, _get_timezone() returns the offset in seconds between localtime and UTC. I don't have VC++ 2010 installed so I can't test it but this seems like a fairly simple thing … [View More]

1 0

Re: [docs] Documentation regressions from adding subprocess.run() (issue 24420)
by berker.peksag＠gmail.com June 26, 2015

June 26, 2015

http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst File Doc/library/subprocess.rst (right): http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst#n… Doc/library/subprocess.rst:880: .. function:: check_output(args, *[, input], stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) On 2015/06/26 02:32:56, vadmium wrote: > On 2015/06/25 23:31:14, berkerpeksag wrote: > > I think we can now remove *input* from the signature. … [View More]

1 0

Re: [docs] Documentation regressions from adding subprocess.run() (issue 24420)
by vadmium+py＠gmail.com June 26, 2015

June 26, 2015

Reviewers: berkerpeksag, http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst File Doc/library/subprocess.rst (right): http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst#n… Doc/library/subprocess.rst:880: .. function:: check_output(args, *[, input], stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) On 2015/06/25 23:31:14, berkerpeksag wrote: > I think we can now remove *input* from the signature. Yes I agree. I might … [View More]tweak the new paragraph and the “versionchanged” note to add more context, though. Please review this at http://bugs.python.org/review/24420/ Affected files: Doc/library/subprocess.rst # HG changeset patch # Parent 1cdedc9a9e9ff2f71f3e192fb8feaa8ba9f55c02 diff -r 1cdedc9a9e9f Doc/library/subprocess.rst --- a/Doc/library/subprocess.rst Tue Jun 09 14:24:30 2015 -0400 +++ b/Doc/library/subprocess.rst Wed Jun 10 04:01:37 2015 +0000 @@ -825,7 +825,7 @@ .. function:: call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None) Run the command described by *args*. Wait for command to complete, then - return the :attr:`returncode` attribute. + return the :attr:`~Popen.returncode` attribute. This is equivalent to:: @@ -833,6 +833,11 @@ (except that the *input* and *check* parameters are not supported) + The arguments shown above are merely the most + common ones. The full function signature is largely the + same as that of the :class:`Popen` constructor - this function passes all + supplied arguments other than *timeout* directly through to that interface. + .. note:: Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this @@ -856,6 +861,11 @@ (except that the *input* parameter is not supported) + The arguments shown above are merely the most + common ones. The full function signature is largely the + same as that of the :class:`Popen` constructor - this function passes all + supplied arguments other than *timeout* directly through to that interface. + .. note:: Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this @@ -867,7 +877,7 @@ *timeout* was added. -.. function:: check_output(args, *, input=None, stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) +.. function:: check_output(args, *[, input], stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) Run command with arguments and return its output. @@ -880,6 +890,13 @@ run(..., check=True, stdout=PIPE).stdout + The arguments shown above are merely the most common ones. + The full function signature is largely the same as that of :func:`run` - + most arguments are passed directly through to that interface. + The differences are that explicitly passing ``input=None`` is not + supported, and that *stdout* is not permitted as an argument, as + it is used internally to collect the output from the subprocess. + By default, this function will return the data as encoded bytes. The actual encoding of the output data may depend on the command being invoked, so the decoding to text will often need to be handled at the application level. [View Less]

1 0

Documentation regressions from adding subprocess.run() (issue 24420)
by berker.peksag＠gmail.com June 25, 2015

June 25, 2015

http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst File Doc/library/subprocess.rst (right): http://bugs.python.org/review/24420/diff/15059/Doc/library/subprocess.rst#n… Doc/library/subprocess.rst:880: .. function:: check_output(args, *[, input], stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) I think we can now remove *input* from the signature. The following paragraph makes the *input* parameter's presence redundant: + The arguments … [View More]

1 0

[issue24496] Non-idiomatic examples in gzip docs
by Jakub Kadlčík June 25, 2015

June 25, 2015

New submission from Jakub Kadlčík: Hello, I think there are awesome example code snippets in gzip documentation. No doubt, they helped me a lot. The only problem is that they are not idiomatic. They look like C more than Python. I suggest following patch ---------- assignee: docs@python components: Documentation files: idiomatic-gzip.diff keywords: patch messages: 245729 nosy: FrostyX, docs@python priority: normal severity: normal status: open title: Non-idiomatic examples in gzip docs type:… [View More]

4 3

[issue23684] urlparse() documentation does not account for default scheme
by Martin Panter June 25, 2015

June 25, 2015

New submission from Martin Panter: The documentation for urlsplit() says: ''' urlparse(urlstring, scheme='', allow_fragments=True) . . . If the scheme argument is specified, it gives the default addressing scheme, to be used only if the URL does not specify one. The default value for this argument is the empty string. ''' However this contradicts the table of attributes, which gives: Attribute: scheme, . . . Value if not present: empty string Similarly for urlsplit(). Of course, the … [View More]

4 6