summaryrefslogtreecommitdiffstats
path: root/Doc/library/shutil.rst
Commit message (Collapse)AuthorAgeFilesLines
* bpo-34260, shutil: fix copy2 and copystat documentation (GH-8523)Zsolt Cserna2018-10-231-1/+1
| | | | | | | | | | Fix the documentation of copy2, as it does not copy file ownership (user and group), only mode, mtime, atime and flags. The original text was confusing to developers as it suggested that this command is the same as 'cp -p', but according to cp(1), '-p' copies file ownership as well. Clarify which metadata is copied by shutil.copystat in its docstring.
* bpo-11233: Create availability directive for documentation (GH-9692)Cheryl Sabella2018-10-121-2/+2
| | | | | | Replace "Availability: xxx" with ".. availability:: xxx" in the doc. Original patch by Georg Brandl. Co-Authored-By: Georg Brandl <georg@python.org>
* bpo-32557: allow shutil.disk_usage to take a file path on Windows also (GH-9372)Joe Pamer2018-09-251-2/+5
| | | https://bugs.python.org/issue32557
* bpo-33671 / shutil.copyfile: use memoryview() with dynamic size on Windows ↵Giampaolo Rodola2018-06-191-1/+5
| | | | | | | | | | (#7681) bpo-33671 * use memoryview() with size == file size on Windows, see https://github.com/python/cpython/pull/7160#discussion_r195405230 * release intermediate (sliced) memoryview immediately * replace "OSX" occurrences with "macOS" * add some unittests for copyfileobj()
* bpo-33671: efficient zero-copy for shutil.copy* functions (Linux, OSX and ↵Giampaolo Rodola2018-06-121-2/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Win) (#7160) * have shutil.copyfileobj use sendfile() if possible * refactoring: use ctx manager * add test with non-regular file obj * emulate case where file size can't be determined * reference _copyfileobj_sendfile directly * add test for offset() at certain position * add test for empty file * add test for non regular file dst * small refactoring * leave copyfileobj() alone in order to not introduce any incompatibility * minor refactoring * remove old test * update docstring * update docstring; rename exception class * detect platforms which only support file to socket zero copy * don't run test on platforms where file-to-file zero copy is not supported * use tempfiles * reset verbosity * add test for smaller chunks * add big file size test * add comment * update doc * update whatsnew doc * update doc * catch Exception * remove unused import * add test case for error on second sendfile() call * turn docstring into comment * add one more test * update comment * add Misc/NEWS entry * get rid of COPY_BUFSIZE; it belongs to another PR * update doc * expose posix._fcopyfile() for OSX * merge from linux branch * merge from linux branch * expose fcopyfile * arg clinic for the win implementation * convert path type to path_t * expose CopyFileW * fix windows tests * release GIL * minor refactoring * update doc * update comment * update docstrings * rename functions * rename test classes * update doc * update doc * update docstrings and comments * avoid do import nt|posix modules if unnecessary * set nt|posix modules to None if not available * micro speedup * update description * add doc note * use better wording in doc * rename function using 'fastcopy' prefix instead of 'zerocopy' * use :ref: in rst doc * change wording in doc * add test to make sure sendfile() doesn't get called aymore in case it doesn't support file to file copies * move CopyFileW in _winapi and actually expose CopyFileExW instead * fix line endings * add tests for mode bits * add docstring * remove test file mode class; let's keep it for later when Istart addressing OSX fcopyfile() specific copies * update doc to reflect new changes * update doc * adjust tests on win * fix argument clinic error * update doc * OSX: expose copyfile(3) instead of fcopyfile(3); also expose flags arg to python * osx / copyfile: use path_t instead of char * do not set dst name in the OSError exception in order to remain consistent with platforms which cannot do that (e.g. linux) * add same file test * add test for same file * have osx copyfile() pre-emptively check if src and dst are the same, otherwise it will return immedialtey and src file content gets deleted * turn PermissionError into appropriate SameFileError * expose ERROR_SHARING_VIOLATION in order to raise more appropriate SameFileError * honour follow_symlinks arg when using CopyFileEx * update Misc/NEWS * expose CreateDirectoryEx mock * change C type * CreateDirectoryExW actual implementation * provide specific makedirs() implementation for win * fix typo * skeleton for SetNamedSecurityInfo * get security info for src path * finally set security attrs * add unit tests * mimick os.makedirs() behavior and raise if dst dir exists * set 2 paths for OSError object * set 2 paths for OSError object * expand windows test * in case of exception on os.sendfile() set filename and filename2 exception attributes * set 2 filenames (src, dst) for OSError in case copyfile() fails on OSX * update doc * do not use CreateDirectoryEx() in copytree() if source dir is a symlink (breaks test_copytree_symlink_dir); instead just create a plain dir and remain consistent with POSIX implementation * use bytearray() and readinto() * use memoryview() with bytearray() * refactoring + introduce a new _fastcopy_binfileobj() fun * remove CopyFileEx and other C wrappers * remove code related to CopyFileEx * Recognize binary files in copyfileobj() ...and use fastest _fastcopy_binfileobj() when possible * set 1MB copy bufsize on win; also add a global _COPY_BUFSIZE variable * use ctx manager for memoryview() * update doc * remove outdated doc * remove last CopyFileEx remnants * OSX - use fcopyfile(3) instead of copyfile(3) ...as an extra safety measure: in case src/dst are "exotic" files (non regular or living on a network fs etc.) we better fail on open() instead of copyfile(3) as we're not quite sure what's gonna happen in that case. * update doc
* bpo-26330: Update shutil.disk_usage() documentation (GH-5184)Cheryl Sabella2018-01-151-1/+2
| | | | Clarify that on Windows, path must be a directory. On Unix, path can be a file or a directory.
* bpo-30218: support path-like objects in shutil.unpack_archive() (GH-1367)Jelle Zijlstra2017-05-051-0/+3
| | | Thanks to Jelle Zijlstra for the patch.
* bpo-29784: Fix the reference to shutil.copy in the docs (GH-602)Mariatta2017-03-111-2/+2
|
* Merge from 3.5Berker Peksag2016-12-271-2/+2
|\
| * Move versionadded inside of the get_terminal_size() blockBerker Peksag2016-12-271-2/+2
| |
* | Merge spelling and grammar from 3.5Martin Panter2016-12-181-1/+1
|\ \ | |/
| * Fix spelling and grammar in code comments and documentationMartin Panter2016-12-181-1/+1
| |
* | Issue #14061: Misc fixes and cleanups in archiving code in shutil.Serhiy Storchaka2016-12-161-20/+24
|\ \ | |/ | | | | | | | | Imporoved the documentation and tests for make_archive() and unpack_archive(). Improved error handling when corresponding compress module is not available. Brake circular dependency between shutil and tarfile modules.
| * Issue #14061: Misc fixes and cleanups in archiving code in shutil.Serhiy Storchaka2016-12-161-20/+24
| | | | | | | | | | | | Imporoved the documentation and tests for make_archive() and unpack_archive(). Improved error handling when corresponding compress module is not available. Brake circular dependency between shutil and tarfile modules.
* | Merge doc fixups from 3.5Martin Panter2016-11-211-1/+1
|\ \ | |/
| * Change double hyphens (en dashes) to em (longer) dashesMartin Panter2016-11-211-1/+1
| |
* | Closes #27904: Improved logging statements to defer formatting until needed.Vinay Sajip2016-08-311-1/+1
|/
* Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.Martin Panter2016-07-261-1/+3
| | | | Patch by Julien Palard.
* Issue #22558: Add remaining doc links to source code for Python-coded modules.Terry Jan Reedy2016-06-111-2/+3
| | | | | Reformat header above separator line (added if missing) to a common format. Patch by Yoni Lavi.
* Issue #26778: Fixed "a/an/and" typos in code comment and documentation.Serhiy Storchaka2016-04-171-1/+1
|
* Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5Martin Panter2015-11-021-2/+2
|\
| * Issue #25523: Correct "a" article to "an" articleMartin Panter2015-11-021-2/+2
| | | | | | | | | | | | This changes the main documentation, doc strings, source code comments, and a couple error messages in the test suite. In some cases the word was removed or edited some other way to fix the grammar.
* | Issue #25161: Merge full stops from 3.4 into 3.5Martin Panter2015-10-101-1/+1
|\ \ | |/
| * Issue #25161: Add full stops in documentation; patch by Takase ArihiroMartin Panter2015-10-101-1/+1
| |
| * Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple ↵Senthil Kumaran2015-06-151-1/+1
| | | | | | | | | | | | | | | | | | documentation typos. Related Issues: #issue21528 #issue24453
* | merge 3.4 (#22933)Benjamin Peterson2015-03-221-6/+3
|\ \ | |/
| * clarify behavior of shutil.move when destination exists (closes #22933)Benjamin Peterson2015-03-221-6/+3
| | | | | | | | Patch by Mike Short.
* | merge with 3.4Georg Brandl2014-10-311-1/+1
|\ \ | |/
| * Closes #22771: "verbose" is unused; deprecate it.Georg Brandl2014-10-311-1/+1
| |
* | merge with 3.4Georg Brandl2014-10-311-3/+13
|\ \ | |/
| * #22613: elaborate on arguments of shutil archival functions (thanks Jacques ↵Georg Brandl2014-10-311-3/+13
| | | | | | | | Ducasse)
* | Fix usage of the versionchanged directive.Berker Peksag2014-08-111-1/+1
| | | | | | | | Patch by Akira Li.
* | Issue #5411: Fixed version number.Serhiy Storchaka2014-08-061-1/+1
| |
* | Issue #5411: Added support for the "xztar" format in the shutil module.Serhiy Storchaka2014-08-061-1/+7
| |
* | #19840: Add copy_function to shutil.move.R David Murray2014-06-111-5/+17
| | | | | | | | Patch by Claudiu Popa.
* | Fix Issue #21528 - Fix documentation typosDonald Stufft2014-05-201-1/+1
| |
* | Issue19643 Fix whitespaceTim Golden2014-05-071-3/+3
| |
* | Issue19643 Add an example of shutil.rmtree which shows how to cope with ↵Tim Golden2014-05-071-0/+20
|/ | | | readonly files on Windows
* Backout a1a05e2724dd: shutil.which(bytes) is a new feature and my patch does ↵Victor Stinner2013-12-161-4/+0
| | | | not work on Windows
* Issue #18283: shutil.which() now supports bytes argument, not only text ↵Victor Stinner2013-12-161-0/+4
| | | | argument.
* Fix shutil.which() test for issue #16993.Serhiy Storchaka2013-01-221-1/+1
|\
| * Fix shutil.which() test for issue #16993.Serhiy Storchaka2013-01-221-1/+1
| |
* | Issue #16993: shutil.which() now preserves the case of the path and extensionSerhiy Storchaka2013-01-211-1/+1
|\ \ | |/ | | | | on Windows.
| * Issue #16993: shutil.which() now preserves the case of the path and extensionSerhiy Storchaka2013-01-211-1/+1
| | | | | | | | on Windows.
* | Issue #16719: Get rid of WindowsError. Use OSError insteadAndrew Svetlov2012-12-191-4/+3
| | | | | | | | Patch by Serhiy Storchaka.
* | Merge: use OSError instead of os.error in the docs.Andrew Svetlov2012-12-151-1/+1
|\ \ | |/
| * Use OSError instead of os.error in the docs.Andrew Svetlov2012-12-151-1/+1
| |
* | #1492704: Ensure and document backward compatibility of the changeHynek Schlawack2012-10-281-1/+2
| |
* | Closes #1492704: Make shutil.copyfile() raise a distinct SameFileErrorHynek Schlawack2012-10-071-1/+13
|/ | | | Patch by Atsuo Ishimoto.
* Cleanup/rewrite shutil docs regarding follow_symlinks and copying attributes.Larry Hastings2012-09-211-31/+84
|
generated by cgit v0.12 at 2025-01-27 13:19:38 (GMT)