Commit Graph

460 Commits

Author SHA1 Message Date
Ethan Furman cdc0879d3a issue27186 -- initial docs, tests, and python version of os.fspath 2016-06-02 15:06:09 -07:00
Tommy Beadle 63b91e5403 Issue #24617: Add comment for os.mkdir about mode quirks 2016-06-02 15:41:20 -04:00
Martin Panter e501a93c18 Issue #27125: Merge typo fixes from 3.5
Also merge changes from Issue #27117; no actual code changes to 3.6.
2016-05-29 09:05:06 +00:00
Martin Panter 8d56c026a5 Issue #27125: Fix various errors like “will [be] inherited” 2016-05-29 04:13:35 +00:00
Zachary Ware 3211595bef Merge with 3.5 2016-04-25 09:27:49 -05:00
Zachary Ware d3304e3e20 FileExistsError is raised by mkdir when dir exists
Reported by Saul Spatz on docs@
2016-04-25 09:27:27 -05:00
Martin Panter cda80940ed Issue #15984: Merge PyUnicode doc from 3.5 2016-04-15 02:27:11 +00:00
Martin Panter 6245cb3c01 Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
This affects documentation, code comments, and a debugging messages.
2016-04-15 02:14:19 +00:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Serhiy Storchaka ffe96ae10b Issue #25994: Added the close() method and the support of the context manager
protocol for the os.scandir() iterator.
2016-02-11 13:21:30 +02:00
Victor Stinner 59fe937c50 Merge 3.5 (doc) 2016-01-31 18:36:52 +01:00
Victor Stinner 5f0c5d92ef Enhance os.scandir() doc
Issue #26248, patch written by Ben Hoyt:

1) Clarify that the return values of is_dir()/is_file()/etc are cached
   separately for follow_symlinks True and False.
2) Be more specific about when the functions require a system call, and how it
   relates to caching and follow_symlinks.
3) DRY up common stuff between is_dir and is_file by saying "Caching, system
   calls made, and exceptions raised are as per is_dir" in is_file.
4) Tweak to the first paragraph of docs for is_dir/is_file to simplify: assume
   the follow_symlinks=True default, then note the follow_symlinks=False
   non-default case after.
2016-01-31 18:36:41 +01:00
Guido van Rossum f08a308ebb Docs for issue #22570. (Merge 3.5->3.6) 2016-01-06 11:37:52 -08:00
Guido van Rossum 1469d744bc Cross-reference os.DirEntry and pathlib.Path for issue #22570. 2016-01-06 11:36:03 -08:00
Brett Cannon 01f7ac3bb0 Backport of fix for issue #25930 2015-12-28 17:30:32 -08:00
Brett Cannon 050391774a Issue #25930: Document that os.unlink and os.remove are *semantically* identical.
Saying that the functions were identical confused some users who were
upset when the functions were no longer simply the same function under
different names.

Thanks to Anthony Sottile for the bug report and Swati Jaiswal for the
initial patch.
2015-12-28 17:28:19 -08:00
Victor Stinner 4487a46727 Merge 3.4 (Issue #25461) 2015-10-23 12:39:20 +02:00
Victor Stinner de6e800f45 Merge 3.4 (Issue #25461) 2015-10-23 12:39:01 +02:00
Victor Stinner 0e316f688e Issue #25461: Rephrase os.walk() doc
Patch written by Bernt Røskar Brenna.
2015-10-23 12:38:11 +02:00
Martin Panter 3286031481 Merge sendfile() doc fixes from 3.5 2015-09-11 23:54:58 +00:00
Martin Panter 3133a9f5ab socket.sendfile() is a method not a module 2015-09-11 23:44:18 +00:00
Martin Panter f9b6875259 Issue #25063: socket.sendfile() does not exist in 3.4
Remove notice that was backported in revision 50527a1b769c.
2015-09-11 23:39:34 +00:00
Martin Panter 3f560c16e5 Merge 3.5 into 3.6 2015-09-09 06:28:08 +00:00
Martin Panter 6088b7bd49 Merge 3.4 into 3.5 2015-09-09 06:27:43 +00:00
Martin Panter 9499413508 os.sendfile(headers=None, trailers=None) arguments are not actually accepted
Needs to be tested on a BSD.
2015-09-09 05:29:24 +00:00
Martin Panter a122b5a1fd Issue #23738: Merge 3.5 into 3.6 2015-09-09 03:01:17 +00:00
Martin Panter 0ff89099c7 Issue #23738: Merge 3.4 into 3.5 2015-09-09 01:56:53 +00:00
Martin Panter bf19d16950 Issue #23738: Document and test actual keyword parameter names
Also fix signature because os.utime(..., ns=None) is not allowed.
2015-09-09 01:01:13 +00:00
Victor Stinner 9f0b5e7097 Merge 3.5 (doc) 2015-07-29 02:29:54 +02:00
Victor Stinner ace8848df6 What's New in Python 3.5: document os.urandom() changes 2015-07-29 02:28:32 +02:00
Charles-François Natali dc87e4b885 Issue #23530: Improve os.cpu_count() description.
Patch by Julian Taylor.
2015-07-13 21:01:39 +01:00
Victor Stinner 51b58325f9 Closes #24013: Improve os.scandir() and DirEntry documentation
Patch written by Ben Hoyt.
2015-05-15 09:12:58 +02:00
Victor Stinner 56f6526085 os module doc: remove availability when useless
Remove "Availability: Unix, Windows." from os module documentation for
functions available on all platforms.
2015-05-15 09:11:59 +02:00
Berker Peksag 0f51d04b47 Issue #24062: Fix os.stat links. Patch by July Tikhonov. 2015-04-27 13:53:54 +03:00
Berker Peksag 2034caa0c4 Issue #24062: Fix os.stat links. Patch by July Tikhonov. 2015-04-27 13:53:28 +03:00
Steve Dower fe0a41aae4 Issue #23668: Adds support for os.truncate and os.ftruncate on Windows 2015-03-20 19:50:46 -07:00
Victor Stinner 708d9ba5a2 Issue #23618: Document EINTR changes in socket documentation 2015-04-02 11:49:42 +02:00
Victor Stinner a766ddfa2f Issue #23648: Document the PEP 475 in the "Porting to Python 3.5" section and
add a version changed note in modified functions.
2015-03-26 23:50:57 +01:00
Victor Stinner 80f6bb4cd8 Merge 3.4 (os doc) 2015-03-10 13:31:58 +01:00
Victor Stinner 47c41b4e4d Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example 2015-03-10 13:31:47 +01:00
Victor Stinner 524a5ba111 Issue #23605: os.walk() now calls os.scandir() instead of os.listdir().
The usage of os.scandir() reduces the number of calls to os.stat().
Initial patch written by Ben Hoyt.
2015-03-10 13:20:34 +01:00
Victor Stinner 6036e4431d Issue #22524: New os.scandir() function, part of the PEP 471: "os.scandir()
function -- a better and faster directory iterator". Patch written by Ben
Hoyt.
2015-03-08 01:58:04 +01:00
Berker Peksag 5a4addabbf Fix typo in os.supports_effective_ids documentation. 2015-02-16 03:36:45 +02:00
Berker Peksag 4d6c6063bf Fix typo in os.supports_effective_ids documentation. 2015-02-16 03:36:10 +02:00
Steve Dower 7d0e0c9f7b Closes #23253: Delay-load ShellExecute 2015-01-24 08:18:24 -08:00
Jesus Cea b6cdc1c01b MERGE: Docs: 'os.pwrite()' needs bytes, not strings 2014-10-20 16:19:33 +02:00
Jesus Cea 67503c5f1c Docs: 'os.pwrite()' needs bytes, not strings 2014-10-20 16:18:24 +02:00
Berker Peksag 131caba074 Revert #22251 2014-09-28 00:01:55 +03:00
Berker Peksag 9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag f7fee33104 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:22:35 +03:00
Berker Peksag 3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
Benjamin Peterson c187f15bb7 merge 3.4 (closes #22307) 2014-08-30 21:06:00 -04:00
Benjamin Peterson e218bcbf39 getuid() returns real process id not effective (closes #22307) 2014-08-30 21:04:15 -04:00
Victor Stinner f6a271ae98 Issue #18395: Rename ``_Py_char2wchar()`` to :c:func:`Py_DecodeLocale`, rename
``_Py_wchar2char()`` to :c:func:`Py_EncodeLocale`, and document these
functions.
2014-08-01 12:28:48 +02:00
Victor Stinner 1db9e7bb19 Issue #22054: Add os.get_blocking() and os.set_blocking() functions to get and
set the blocking mode of a file descriptor (False if the O_NONBLOCK flag is
set, True otherwise). These functions are not available on Windows.
2014-07-29 22:32:47 +02:00
Victor Stinner e1d24f7ec3 Issue #21813: Enhance documentation of the os.stat_result class. 2014-07-24 12:44:07 +02:00
Victor Stinner 992019c006 Backport os.rst documentation from Python 3.5. 2014-07-24 12:42:45 +02:00
Victor Stinner 6d4f4feca2 Issue #21813: Enhance documentation of the os.stat_result class. 2014-07-24 12:42:16 +02:00
Ned Deily ddb1d82fe6 Issue #21875: Remove vestigial references to Classic Mac OS in os module docs. 2014-06-26 23:42:38 -07:00
Ned Deily 5c867018f0 Issue #21875: Remove vestigial references to Classic Mac OS in os module docs. 2014-06-26 23:40:06 -07:00
Zachary Ware 63f277b694 Issue #21741: Add st_file_attributes to os.stat_result on Windows.
Patch by Ben Hoyt.
2014-06-19 09:46:37 -05:00
Victor Stinner 9ec15176bc (Merge 3.4) Closes #21758: asyncio doc: mention explicitly that subprocess
parameters are bytes or character strings
2014-06-19 12:51:17 +02:00
Victor Stinner 6bfd854ea8 Closes #21758: asyncio doc: mention explicitly that subprocess parameters are
bytes or character strings
2014-06-19 12:50:27 +02:00
Benjamin Peterson 5b521fc9de merge 3.4 (#13779) 2014-06-15 20:52:02 -07:00
Benjamin Peterson e58e0c7f33 clarify when the list of subdirectories is read (closes #13779) 2014-06-15 20:51:12 -07:00
Benjamin Peterson 0ce9537fc5 improve note 2014-06-15 18:30:27 -07:00
Giampaolo Rodola' 915d14190e fix issue #17552: add socket.sendfile() method allowing to send a file over a socket by using high-performance os.sendfile() on UNIX. Patch by Giampaolo Rodola'· 2014-06-11 03:54:30 +02:00
Benjamin Peterson 8dfd73a2b4 merge 3.4 (#10503) 2014-06-07 13:51:51 -07:00
Benjamin Peterson 4bb09c8432 specify that getuid() returns the real uid (closes #10503)
Patch by εσχατοκυριος.
2014-06-07 13:50:34 -07:00
Giampaolo Rodola' 409569b1cf update os.sendfile() doc signaling that cross-platform apps should not use headers, trailers and flags arguments 2014-04-24 18:09:21 +02:00
Andrew Kuchling f5a429295d #6490: Expand documentation for os.popen().
Patch by Sam Kimbrel.
2014-04-16 09:10:53 -04:00
Benjamin Peterson 1acc69c650 update version changed 2014-04-01 19:22:06 -04:00
Benjamin Peterson 9dc203fff9 merge 3.3 (#21082) 2014-04-01 19:18:48 -04:00
Benjamin Peterson 4717e2112b merge 3.2 (#21082) 2014-04-01 19:17:57 -04:00
Benjamin Peterson ee5f1c13d1 remove directory mode check from makedirs (closes #21082) 2014-04-01 19:13:18 -04:00
Zachary Ware a22ae21db6 Fix parameter name in docs for os.makedirs and os.removedirs.
Pointed out by Colin Davis on docs@.
2014-03-20 09:42:01 -05:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Éric Araujo fa5e6e4773 Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:51:00 -04:00
Benjamin Peterson dc3cce077d merge 3.3 (#17811) 2014-01-18 22:57:05 -05:00
Benjamin Peterson e83ed43281 improve description of buffers argument for readv/writev (closes #17811)
Patch by Nikolaus Rath.
2014-01-18 22:54:59 -05:00
doko@ubuntu.com ca616a2709 - Issue #19736: Add module-level statvfs constants defined for GNU/glibc
based systems.
2013-12-08 15:23:07 +01:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Victor Stinner 05f31bfef3 doc: fix typo 2013-11-06 01:48:45 +01:00
Christian Heimes ee0bac66b2 Issue #19227 / Issue #18747: Remove pthread_atfork() handler to remove OpenSSL re-seeding
It is causing trouble like e.g. hanging processes.
2013-10-29 21:11:55 +01:00
Christian Heimes 3046fe4c03 Issue #18747: document issue with OpenSSL's CPRNG state and fork 2013-10-29 21:08:56 +01:00
Serhiy Storchaka 690a6a95bd Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:13:37 +03:00
Serhiy Storchaka dab8354920 Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:12:43 +03:00
Georg Brandl aca718e9f1 merge with 3.3 2013-10-06 19:27:17 +02:00
Georg Brandl 136a050bf3 Fix name of the "exist_ok" argument. Found by Neil Bushong on docs@. 2013-10-06 19:27:13 +02:00
Georg Brandl 434bdf413f merge with 3.3 2013-10-06 18:58:03 +02:00
Georg Brandl 9ad5bf662d Closes #15228: remove reference to Unix "touch"; it is confusing since the path needs to exist for os.utime() to succeed 2013-10-06 18:57:49 +02:00
Georg Brandl af1edb7f45 merge with 3.3 2013-10-06 18:48:30 +02:00
Georg Brandl c6a2c9b466 Closes #15213: update comment for _PyOS_URandom 2013-10-06 18:43:19 +02:00
Georg Brandl 15f57f61cb merge with 3.3 2013-10-06 18:12:13 +02:00
Georg Brandl 0bbbeb59f4 Closes #12350: clarify blocks/block size members of stat result. 2013-10-06 18:11:32 +02:00
Senthil Kumaran 3af4fad555 Correcting the mistake in 678e3c0d2d99
Merge from 3.3
Addresses Issue #18553: isatty is not Unix only.
2013-09-19 00:10:17 -07:00
Senthil Kumaran 2a97cee5ed Correcting the mistake in 14ba90816930
Addresses Issue #18553: isatty is not Unix only.
2013-09-19 00:08:56 -07:00
Georg Brandl 5642ff9d8e Fixup reST syntax errors and streamline docs of PEP 446. 2013-09-15 10:37:57 +02:00
Senthil Kumaran 59b74ec5e3 merge from 3.3
Removing the mention of os.isatty mention as Unix only
Correct the wrong documentation.
2013-09-07 11:30:04 -07:00
Senthil Kumaran 1b90227c0d Removing the mention of os.isatty mention as Unix only
Correct the wrong documentation.
2013-09-07 11:28:58 -07:00
Victor Stinner daf455554b Issue #18571: Implementation of the PEP 446: file descriptors and file handles
are now created non-inheritable; add functions os.get/set_inheritable(),
os.get/set_handle_inheritable() and socket.socket.get/set_inheritable().
2013-08-28 00:53:59 +02:00
Christian Heimes d88f735f17 Issue #18673: Add versionchanged to docs 2013-08-16 14:37:50 +02:00
Christian Heimes 177b3f9982 Issue #18673: Add O_TMPFILE to os module. O_TMPFILE requires Linux kernel
3.11 or newer. It's only defined on system with 3.11 uapi headers, too.
2013-08-16 14:35:09 +02:00
Andrew Kuchling 4921a089e2 #12716: reorganize docs for os module a bit
* Move the constants used by os.open() to after the description of os.open(),
  instead of putting them in their own section.

* Move RTLD_* constants to "Miscellaneous System Information" section, and
  mention the sys functions they're used with.

* Mention dir_fd parameter in os.open() text.

* Typo fix ("are a supported by").
2013-06-21 11:49:57 -04:00
Jason R. Coombs 3a09286790 Issue #13772: Restored directory detection of targets in `os.symlink` on Windows, which was temporarily removed in Python 3.2.3 due to an incomplete implementation. The implementation now works even if the symlink is created in a location other than the current directory. 2013-05-27 23:21:28 -04:00
Jason R. Coombs 8f1a8e32b1 Merge with 3.3 2013-05-27 23:26:36 -04:00
Charles-Francois Natali 44feda3cd0 Issue #17914: Add os.cpu_count(). Patch by Yogesh Chaudhari, based on an
initial patch by Trent Nelson.
2013-05-20 14:40:46 +02:00
Charles-Francois Natali f18a82d956 Issue #17529: Fix os.sendfile() documentation regarding the type of file
descriptor supported.
2013-05-01 15:13:12 +02:00
Charles-Francois Natali a771a1b48e Issue #17529: Fix os.sendfile() documentation regarding the type of file
descriptor supported.
2013-05-01 15:12:20 +02:00
Benjamin Peterson 3b965a237c expose O_PATH if possible 2013-03-13 10:27:41 -05:00
Serhiy Storchaka 0cad7eca45 Issue #17193: Use binary prefixes (KiB, MiB, GiB) for memory units. 2013-02-16 17:30:31 +02:00
Serhiy Storchaka f8def28ff0 Issue #17193: Use binary prefixes (KiB, MiB, GiB) for memory units. 2013-02-16 17:29:56 +02:00
Andrew Svetlov a191959849 Issue #16714: use 'raise' exceptions, don't 'throw'.
Patch by Serhiy Storchaka.
2012-12-18 21:27:16 +02:00
Andrew Svetlov 5b89840d9c Issue #16714: use 'raise' exceptions, don't 'throw'.
Patch by Serhiy Storchaka.
2012-12-18 21:26:36 +02:00
Ezio Melotti ff790aac66 #16530: merge with 3.3. 2012-11-23 19:46:52 +02:00
Ezio Melotti 44dcd6bcb2 #16530: merge with 3.2. 2012-11-23 19:46:29 +02:00
Ezio Melotti ba4d8ed8f8 #16530: the "options" arg of os.wait3 is required. 2012-11-23 19:45:52 +02:00
Chris Jerdonek 1a5f3ec9a9 Merge from 3.3: link to mapping glossary entry in docs. 2012-11-03 12:07:20 -07:00
Chris Jerdonek 1c8bb9f4d5 Merge from 3.2: link to mapping glossary entry in docs. 2012-11-03 12:06:42 -07:00
Chris Jerdonek 11f3f172e7 Link to mapping glossary entry in "Mapping Types - dict" and os.environ docs. 2012-11-03 12:05:55 -07:00
Andrew Svetlov b3fe704a4a Merge issue #15936: Reformat text for os.random to follow Larry Hastings suggestion 2012-10-16 13:52:53 +03:00
Andrew Svetlov 2bfe386091 Issue #15936: Reformat text for os.random to follow Larry Hastings suggestion 2012-10-16 13:52:25 +03:00
Andrew Svetlov f4e5044638 Merge issue #15936: Add link from os.urandom to random.SystemRandom 2012-10-16 13:15:35 +03:00
Andrew Svetlov 03cb99c2d1 Issue #15936: Add link from os.urandom to random.SystemRandom 2012-10-16 13:15:06 +03:00
Hynek Schlawack c3c6fe5b1a Merge 3.3 2012-10-08 07:46:11 +02:00
Hynek Schlawack 101591e9d5 Merge 3.2 2012-10-08 07:44:54 +02:00
Hynek Schlawack 0230b6af78 #13498: Clarify docs of os.makedirs()'s exist_ok argument.
Done with great native-speaker help from R. David Murray.
2012-10-07 18:04:38 +02:00
Jesus Cea f6c2e894ae #16135: Removal of OS/2 support (Docs) 2012-10-05 01:11:10 +02:00
R David Murray ce478b9891 #15886: remove redundant phrase 2012-09-10 21:08:50 -04:00
Andrew Svetlov a2fe334081 Issue #15527: fix docs, remove double parens by changing markup.
Patch by Serhiy Storchaka.
2012-08-11 21:14:08 +03:00
Victor Stinner 69a6ca5260 os.unlinkat() has been removed, update os.fwalk() doc 2012-08-05 15:18:02 +02:00
Victor Stinner 15f3d1e266 Issue #12655: Mention multiprocessing.cpu_count() in os.sched_getaffinity() doc 2012-08-04 20:57:48 +02:00
Antoine Pitrou 848698727f Issue #12655: Instead of requiring a custom type, os.sched_getaffinity and
os.sched_setaffinity now use regular sets of integers to represent the
CPUs a process is restricted to.
2012-08-04 16:16:35 +02:00
Larry Hastings 950b76ab1a Doc fix: the text role is called "func", not "funk". 2012-07-15 17:32:36 -07:00
Larry Hastings b40380667c Issue #15202: Consistently use the name "follow_symlinks" for
new parameters in os and shutil functions.  Patch by Serhiy Storchaka.
2012-07-15 10:57:38 -07:00
Larry Hastings c48fe98a7c Issue #15177: Added dir_fd parameter to os.fwalk(). 2012-06-25 04:49:05 -07:00
Larry Hastings fdaea06d3c Issue #15176: Clarified behavior, documentation, and implementation
of os.listdir().
2012-06-25 04:42:23 -07:00
Larry Hastings 77892dc1e3 More doc fixes: made it clear where to start reading when you click on <dir_fd>. 2012-06-25 03:27:33 -07:00
Georg Brandl aceaf90804 Some tightening of the documentation for the new kwarg-style os module functionality. 2012-06-25 08:33:56 +02:00
Georg Brandl 4d399a4092 Grammar fix. 2012-06-25 07:40:32 +02:00
Éric Araujo 0a8f5f709a Fix typos 2012-06-24 13:53:41 -04:00
Hynek Schlawack 1729b8f45b Fix doc of os.fwalk: example used now non-existing os.fstatat() 2012-06-24 16:11:08 +02:00
Georg Brandl 6cff9ffab0 Fix use of class markup. 2012-06-24 14:05:40 +02:00
Larry Hastings 605a62ddb1 Issue #15118: Change return value of os.uname() and os.times() from
plain tuples to immutable iterable objects with named attributes
(structseq objects).
2012-06-24 04:33:36 -07:00
Georg Brandl f62445ad30 Fix casing of Unix. 2012-06-24 13:31:20 +02:00
Georg Brandl 8a5555f792 Make the style of the "Availability" sections consistent. 2012-06-24 13:29:09 +02:00
Georg Brandl a570e98e7b Actually it is just one function. 2012-06-24 13:26:22 +02:00
Georg Brandl b2462e2b8c Minor clarification about fdopen(). 2012-06-24 13:24:56 +02:00