Commit Graph

271 Commits

Author SHA1 Message Date
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
Georg Brandl 306336bcda Closes #15161: add support for giving path as a fd for truncate() and pathconf(). 2012-06-24 12:55:33 +02:00
Georg Brandl 8ccadaafe6 Restore mostly-alphabetic sorting of os functions. 2012-06-24 12:50:06 +02:00
Georg Brandl b9df00cc00 Note that equivalents are valid for 3.3+ only. 2012-06-24 12:38:14 +02:00
Georg Brandl b9831ab63c Move Linux-only *xattr() functions to their own subheading. 2012-06-24 11:57:07 +02:00
Georg Brandl b1a1ac0b67 Small nits in os doc. 2012-06-24 11:54:07 +02:00
Georg Brandl 50c4000685 "Refactor" docs for the new dir_fd, follow_symlinks, path-as-fd APIs: document the options at a central place and link to it. 2012-06-24 11:45:20 +02:00
Larry Hastings b698d8e7e9 Issue #15154: Add "dir_fd" parameter to os.rmdir, remove "rmdir"
parameter from os.remove / os.unlink.
Patch written by Georg Brandl.  (I'm really looking forward to George
getting commit privileges so I don't have to keep doing checkins on his
behalf.)
2012-06-23 16:55:07 -07:00
Larry Hastings 9cf065cfdc Issue #14626: Large refactoring of functions / parameters in the os module.
Many functions now support "dir_fd" and "follow_symlinks" parameters;
some also support accepting an open file descriptor in place of of a path
string.  Added os.support_* collections as LBYL helpers.  Removed many
functions only previously seen in 3.3 alpha releases (often starting with
"f" or "l", or ending with "at").  Originally suggested by Serhiy Storchaka;
implemented by Larry Hastings.
2012-06-22 16:30:09 -07:00
Jesus Cea 9436361e4c Closes #10142: Support for SEEK_HOLE/SEEK_DATA 2012-06-22 18:32:07 +02:00
Victor Stinner 034d0aa217 Issue #14711: os.stat_float_times() has been deprecated. 2012-06-05 01:22:15 +02:00
Petri Lehtinen fa52cbd5e6 #14863: Update the documentation of os.fdopen() 2012-05-24 21:49:59 +03:00
Petri Lehtinen 1a01ebc41c #14863: Update the documentation of os.fdopen()
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
2012-05-24 21:46:36 +03:00
Hynek Schlawack f0bf135cd1 Restore [] where default arguments are not keywords 2012-05-22 16:14:56 +02:00
Hynek Schlawack 979f37afd2 Restore [] where default arguments are not keywords
Reverts some changes of d13fdd97cc8e.
2012-05-22 16:12:18 +02:00
Hynek Schlawack 87d8200978 #14804: Remove [] around optional arguments with default values 2012-05-21 13:35:03 +02:00
Hynek Schlawack dfa465243c #14804: Remove [] around optional arguments with default values 2012-05-21 11:01:54 +02:00
Larry Hastings 76ad59b7e8 Issue #14127: Add ns= parameter to utime, futimes, and lutimes.
Removed futimens as it is now redundant.
Changed shutil.copystat to use st_atime_ns and st_mtime_ns from os.stat
and ns= parameter to utime--it once again preserves exact metadata on Linux!
2012-05-03 00:30:07 -07:00
Ned Deily ca9bfe17be Issue #10433: merge 2012-04-30 11:15:38 -07:00
Ned Deily 2e20968feb Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:14:02 -07:00
Jesus Cea 990eff0776 Backing out 86dc014cdd74. Not ready yet 2012-04-26 17:05:31 +02:00
Jesus Cea 2b47f0a23f Close #10142: Support for SEEK_HOLE/SEEK_DATA 2012-04-26 16:39:35 +02:00
Larry Hastings 6fe20b3aee Issue #14127: Add st_{cma}time_ns fields to os.stat() result object. 2012-04-19 15:07:49 -07:00
Eli Bendersky d049d5c7fb fix Sphinx error in os.rst 2012-02-11 09:52:29 +02:00
Antoine Pitrou bcf2b59fb5 Issue #13609: Add two functions to query the terminal size:
os.get_terminal_size (low level) and shutil.get_terminal_size (high level).
Patch by Zbigniew Jędrzejewski-Szmek.
2012-02-08 23:28:36 +01:00
Victor Stinner 4195b5caea Backout f8409b3d6449: the PEP 410 is not accepted yet 2012-02-08 23:03:19 +01:00
Victor Stinner ccd5715a14 PEP 410 2012-02-08 14:31:50 +01:00
Charles-François Natali 7794090251 Following Nick's suggestion, rename posix.fdlistdir() to posix.flistdir(), to
be consistent with other functions accepting file descriptors (fdlistdir() was
added in 3.3, so hasn't been released yet).
2012-02-06 19:54:48 +01:00
Charles-François Natali 7372b06cd7 Issue #13734: Add os.fwalk(), a directory walking function yielding file
descriptors.
2012-02-05 15:15:38 +01:00
Antoine Pitrou f3b2d88b67 Issue #8828: Add new function os.replace(), for cross-platform renaming with overwriting. 2012-01-30 22:08:52 +01:00
Antoine Pitrou 91ecea24f5 Issue #13772: In os.symlink() under Windows, do not try to guess the link
target's type (file or directory).  The detection was buggy and made the
call non-atomic (therefore prone to race conditions).
2012-01-24 09:05:18 +01:00
Antoine Pitrou 5311c1d7ab Issue #13772: In os.symlink() under Windows, do not try to guess the link
target's type (file or directory).  The detection was buggy and made the
call non-atomic (therefore prone to race conditions).
2012-01-24 08:59:28 +01:00
Victor Stinner e83f899364 Issue #13530: Document os.lseek() result
Patch written by Jérémy Anger.
2011-12-17 23:15:09 +01:00
Charles-François Natali 76961faaa0 Issue #13757: Change os.fdlistdir() so that it duplicates the passed file
descriptor (instead of closing it).
2012-01-10 20:25:09 +01:00
Charles-François Natali dc3044c704 Issue #12760: Add a create mode to open(). Patch by David Townshend. 2012-01-09 22:40:02 +01:00
Victor Stinner 25ec056cc2 Issue #13530: Document os.lseek() result
Patch written by Jérémy Anger.
2011-12-17 23:15:22 +01:00
Ezio Melotti 257a14c2a5 Refactor functions signatures in the doc. 2011-11-09 00:25:47 +02:00
Brian Curtin 4b6fabdff1 Backed out changeset 60ae7979fec8 2011-11-08 14:54:02 -06:00
Brian Curtin e751d6f2f1 Remove the old style [...] to denote optional args and show the defaults. 2011-11-08 14:30:02 -06:00
Brian Curtin 569b494320 Fix #13327. utimensat now has the atime and mtime arguments set as optional,
defaulting to None like the other utimes family members. It now accepts
keyword arguments because, unlike other other functions in the family,
it has a `flags` value at the end of the argument list (which
retains its 0 default).
2011-11-07 16:09:20 -06:00
Brian Curtin c1b65d1831 Fix 13327. Remove explicit None arguments from futimes, futimens, futimesat,
and lutimes.
2011-11-07 14:18:54 -06:00
Brian Curtin 52fbea1d87 Fix #13327. Remove the need for an explicit None as the second argument to
os.utime in order to update to the current time. The second argument is now
optional.
2011-11-06 13:41:17 -06:00
Victor Stinner 8b905bd9d4 Issue #13226: Add RTLD_xxx constants to the os module. These constants can by
used with sys.setdlopenflags().
2011-10-25 13:34:04 +02:00
Victor Stinner e3455c026a Mention that os.O_CLOEXEC was added to Python 3.3 2011-10-20 00:46:21 +02:00
Ezio Melotti f10644983e Merge with 3.2. 2011-10-19 11:06:26 +03:00
Ezio Melotti bb8606dae3 #12277: merge with 3.2. 2011-10-18 13:00:36 +03:00
Ezio Melotti 67494f2224 #12277: add missing comma. 2011-10-18 12:59:39 +03:00
Victor Stinner 69db2dbcbe Fix typo in the os doc: lremoveattr => lremovexattr 2011-10-14 00:07:53 +02:00
Antoine Pitrou 62ab10a05a Replace mentions of IOError 2011-10-12 20:10:51 +02:00
Ross Lagerwall 7194efe8b4 Merge with 3.2. 2011-09-01 07:02:31 +02:00
Ross Lagerwall a9353db2cd Remove duplicate text in os documentation. 2011-09-01 06:58:52 +02:00
Benjamin Peterson 799bd80d8a expose linux extended file system attributes (closes #12720) 2011-08-31 22:15:17 -04:00
Sandro Tosi d902a14dd0 #12191: add shutil.chown() to change user and/or group owner of a given path also specifying their names. 2011-08-22 23:28:27 +02:00
Benjamin Peterson 94b580d423 expose sched.h functions (closes #12655) 2011-08-02 17:30:04 -05:00
Ezio Melotti cd1d3ef77b #13233: fix typo. 2011-10-20 19:51:18 +03:00
Antoine Pitrou 6d175b72b5 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:29:18 +02:00
Antoine Pitrou 0e752dd3f8 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:26:58 +02:00
Antoine Pitrou 87fd76edb6 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:55:38 +02:00
Antoine Pitrou a83cdaae89 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:54:23 +02:00
Victor Stinner 6e2e3b9e81 Issue #12423: Fix os.abort() documentation
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:26:39 +02:00
Senthil Kumaran 3aac179498 Fix whitespace nit in datetime and os rst files. 2011-07-04 11:43:51 -07:00
Senthil Kumaran a6bac95a3c issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage. 2011-07-04 11:28:30 -07:00
Victor Stinner 2b49f12a63 (merge 3.2) Issue #12423: Fix os.abort() documentation
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:27:06 +02:00
Senthil Kumaran 8fbfc12f5e merge from 3.2 2011-07-04 11:44:17 -07:00
Senthil Kumaran 276a58b821 Merge from 3.2 . Replace the term members with correct and appropriate terminology. Initial patch by Adam Woodbeck. 2011-07-04 11:31:53 -07:00
Ned Deily 8b56c4b1b8 Issue #8746: Correct faulty configure checks so that os.chflags() and
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X).  Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED).  Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-28 00:13:01 -07:00
Ned Deily 3eb67d58d6 Issue #8746: Correct faulty configure checks so that os.chflags() and
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X).  Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED).  Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-28 00:00:28 -07:00
Ross Lagerwall b0ae53d8a0 Issue #9344: Add os.getgrouplist(). 2011-06-10 07:30:30 +02:00
Charles-François Natali 368f34bb4b Issue #12196: Make os.pipe2() flags argument mandatory. 2011-06-06 19:49:47 +02:00
Charles-François Natali daafdd5bea Issue #12196: Add pipe2() to the os module. 2011-05-29 20:07:40 +02:00
Charles-François Natali 1e045b1831 Issue #12105: Add O_CLOEXEC to the os module. 2011-05-22 20:42:32 +02:00
Benjamin Peterson 2ed7521e96 merge 3.2 2011-05-20 11:49:58 -05:00
Benjamin Peterson 619323c68f merge 3.1 2011-05-20 11:49:19 -05:00
Benjamin Peterson 2340986fe0 this should actually be an IOError 2011-05-20 11:49:06 -05:00
Benjamin Peterson 7f071e6e9f merge 3.2 2011-05-20 11:42:47 -05:00
Benjamin Peterson c7dd737ef7 merge 3.1 2011-05-20 11:41:59 -05:00
Benjamin Peterson 249b508c98 add example for not using access 2011-05-20 11:41:13 -05:00
Victor Stinner b3e7219abf Issue #8407: Add pthread_kill(), sigpending() and sigwait() functions to the
signal module.
2011-05-08 01:46:11 +02:00
R David Murray 5647c473bc Merge #10999 fix. 2011-03-10 17:22:33 -05:00
R David Murray 30178068d9 #10999: Add missing documentation for chflags constants to stat module docs
Patch by Michal Nowikowski.
2011-03-10 17:18:33 -05:00
Ross Lagerwall 7807c3545d Issue #10812: Add some extra posix functions to the os module. 2011-03-17 20:20:30 +02:00
R David Murray ee30a0be35 Merge #10999 fix. 2011-03-10 17:38:50 -05:00
Antoine Pitrou 8250e23abd Issue #10755: Add the posix.fdlistdir() function. Patch by Ross Lagerwall. 2011-02-25 23:41:16 +00:00
Antoine Pitrou f65132de3d Issue #4761: Add the *at() family of functions (openat(), etc.) to the posix
module.  Patch by Ross Lagerwall.
2011-02-25 23:25:17 +00:00
Giampaolo Rodolà 18e8bcb289 Issue 10784: adds os.getpriority() and os.setpriority() functions. 2011-02-25 20:57:54 +00:00
Giampaolo Rodolà c9c2c8b034 Issue 10882: add os.sendfile(). (patch provided by Ross Lagerwall) 2011-02-25 14:39:16 +00:00
Georg Brandl f6c8fd62b9 Merged revisions 86537,86867-86868,86881,86887,86913-86915,86931-86933,86960,86964,86974,86980,86996,87008,87050 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r86537 | georg.brandl | 2010-11-19 23:09:04 +0100 (Fr, 19 Nov 2010) | 1 line

  Do not put a raw REPLACEMENT CHARACTER in the document.
........
  r86867 | georg.brandl | 2010-11-29 15:50:54 +0100 (Mo, 29 Nov 2010) | 1 line

  Fix indentation bug.
........
  r86868 | georg.brandl | 2010-11-29 15:53:15 +0100 (Mo, 29 Nov 2010) | 1 line

  Fix heading style inconsistencies.
........
  r86881 | georg.brandl | 2010-11-30 08:43:28 +0100 (Di, 30 Nov 2010) | 1 line

  #10584: fix bad links.
........
  r86887 | georg.brandl | 2010-11-30 15:57:54 +0100 (Di, 30 Nov 2010) | 1 line

  Fix typo.
........
  r86913 | georg.brandl | 2010-12-01 16:32:43 +0100 (Mi, 01 Dez 2010) | 1 line

  Add missing word, and add a better reference to the actual function.
........
  r86914 | georg.brandl | 2010-12-01 16:36:33 +0100 (Mi, 01 Dez 2010) | 1 line

  #10594: fix parameter names in PyList API docs.
........
  r86915 | georg.brandl | 2010-12-01 16:44:25 +0100 (Mi, 01 Dez 2010) | 1 line

  Fix some markup and style in the unittest docs.
........
  r86931 | georg.brandl | 2010-12-02 10:06:12 +0100 (Do, 02 Dez 2010) | 1 line

  Fix-up documentation of makedirs().
........
  r86932 | david.malcolm | 2010-12-02 17:41:00 +0100 (Do, 02 Dez 2010) | 2 lines

  Fix spelling of Jamie Zawinski's surname in urllib.parse docstring (issue 10606)
........
  r86933 | georg.brandl | 2010-12-02 19:02:01 +0100 (Do, 02 Dez 2010) | 1 line

  #10597: fix Py_SetPythonHome docs by pointing to where the meaning of PYTHONHOME is already documented.
........
  r86960 | georg.brandl | 2010-12-03 08:55:44 +0100 (Fr, 03 Dez 2010) | 1 line

  #10360: catch TypeError in WeakSet.__contains__, just like WeakKeyDictionary does.
........
  r86964 | georg.brandl | 2010-12-03 10:58:38 +0100 (Fr, 03 Dez 2010) | 1 line

  #10549: fix interface of docclass() for text documenter.
........
  r86974 | georg.brandl | 2010-12-03 16:30:09 +0100 (Fr, 03 Dez 2010) | 1 line

  Markup consistency fixes.
........
  r86980 | georg.brandl | 2010-12-03 18:19:27 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix punctuation.
........
  r86996 | georg.brandl | 2010-12-03 20:56:42 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix indentation.
........
  r87008 | georg.brandl | 2010-12-04 10:04:04 +0100 (Sa, 04 Dez 2010) | 1 line

  Fix typo.
........
  r87050 | georg.brandl | 2010-12-04 18:09:30 +0100 (Sa, 04 Dez 2010) | 1 line

  Fix typo.
........
2011-02-25 09:48:21 +00:00
Raymond Hettinger 8f0ae9a17f Doc fixups. 2011-02-18 00:53:55 +00:00
Georg Brandl c60e306a80 Fix markup problems. 2011-02-12 07:32:02 +00:00
R. David Murray 43b2f457a0 Merged revisions 87136,87221,87256,87337-87338,87571,87839,88164 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k


........
  r87136 | r.david.murray | 2010-12-08 17:53:00 -0500 (Wed, 08 Dec 2010) | 6 lines

  Have script_helper._assert_python strip refcount strings from stderr.

  This makes the output of the function and those that depend on it
  independent of whether or not they are being run under a debug
  build.
........
  r87221 | r.david.murray | 2010-12-13 19:55:46 -0500 (Mon, 13 Dec 2010) | 4 lines

  #10699: fix docstring for tzset: it does not take a parameter

  Thanks to Garrett Cooper for the fix.
........
  r87256 | r.david.murray | 2010-12-14 21:19:14 -0500 (Tue, 14 Dec 2010) | 2 lines

  #10705: document what the values of debuglevel are and mean.
........
  r87337 | r.david.murray | 2010-12-17 11:11:40 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10559: provide instructions for accessing sys.argv when first mentioned.
........
  r87338 | r.david.murray | 2010-12-17 11:29:07 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10454: clarify the compileall docs and help messages.
    [compileall.py changes not backported.]
........
  r87571 | r.david.murray | 2010-12-29 14:06:48 -0500 (Wed, 29 Dec 2010) | 2 lines

  Fix same typo in docs.
........
  r87839 | r.david.murray | 2011-01-07 16:57:25 -0500 (Fri, 07 Jan 2011) | 9 lines

  Fix formatting of values with embedded newlines when rfc2047 encoding

  Before this patch if a value being encoded had an embedded newline,
  the line following the newline would have no leading whitespace,
  and the whitespace it did have was encoded into the word.  Now
  the existing whitespace gets turned into a blank, the way it does
  in other header reformatting, and the _continuation_ws gets added
  at the beginning of the encoded line.
........
  r88164 | r.david.murray | 2011-01-24 14:34:58 -0500 (Mon, 24 Jan 2011) | 12 lines

  #10960: fix 'stat' links, link to lstat from stat, general tidy of stat doc.

  Original patch by Michal Nowikowski, with some additions and wording
  fixes by me.

  I changed the wording from 'Performs a stat system call' to 'Performs
  the equivalent of a stat system call', since on Windows there are no
  stat/lstat system calls involved.  I also extended Michal's breakout
  of the attributes into a list to the other paragraphs, and rearranged
  the order of the paragraphs in the 'stat' docs to make it flow
  better and put it in what I think is a more logical/useful order.
........
2011-02-11 03:13:19 +00:00