shutil — High-level file operations

Вихідний код: Lib/shutil.py

---

Модуль shutil пропонує низку високорівневих операцій над файлами та колекціями файлів. Зокрема, передбачені функції, які підтримують копіювання та видалення файлів. Для операцій з окремими файлами дивіться також модуль os.

Попередження

Навіть функції копіювання файлів вищого рівня (shutil.copy(), shutil.copy2()) не можуть скопіювати всі метадані файлу.

На платформах POSIX це означає, що власник файлу та група втрачаються, а також ACL. У Mac OS форк ресурсів та інші метадані не використовуються. Це означає, що ресурси буде втрачено, а тип файлу та коди творця будуть неправильними. У Windows власники файлів, ACL та альтернативні потоки даних не копіюються.

Операції з каталогами та файлами

shutil.copyfileobj(fsrc, fdst[, length])

Copy the contents of the file-like object fsrc to the file-like object fdst. The integer length, if given, is the buffer size. In particular, a negative length value means to copy the data without looping over the source data in chunks; by default the data is read in chunks to avoid uncontrolled memory consumption. Note that if the current file position of the fsrc object is not 0, only the contents from the current file position to the end of the file will be copied.

shutil.copyfile(src, dst, *, follow_symlinks=True)

Copy the contents (no metadata) of the file named src to a file named dst and return dst in the most efficient way possible. src and dst are path-like objects or path names given as strings.

dst має бути повним ім’ям цільового файлу; подивіться на copy() копію, яка приймає шлях цільового каталогу. Якщо src і dst вказують той самий файл, виникає SameFileError.

Місце призначення має бути доступним для запису; інакше буде викликано виняток OSError. Якщо dst вже існує, його буде замінено. За допомогою цієї функції неможливо скопіювати спеціальні файли, такі як символьні або блокові пристрої та канали.

Якщо follow_symlinks має значення false, а src є символічним посиланням, замість копіювання файлу, на який вказує src, буде створено нове символічне посилання.

Викликає подію аудиту shutil.copyfile з аргументами src, dst.

Змінено в версії 3.3: Раніше викликалося IOError замість OSError. Додано аргумент follow_symlinks. Тепер повертає dst.

Змінено в версії 3.4: Викликати SameFileError замість Error. Оскільки перший є підкласом останнього, ця зміна є зворотно сумісною.

Змінено в версії 3.8: Спеціальні для платформи системні виклики швидкого копіювання можуть використовуватися внутрішньо для більш ефективного копіювання файлу. Перегляньте розділ Залежні від платформи ефективні операції копіювання.

exception shutil.SameFileError

Цей виняток виникає, якщо джерело та призначення у copyfile() є одним і тим самим файлом.

Added in version 3.4.

shutil.copymode(src, dst, *, follow_symlinks=True)

Copy the permission bits from src to dst. The file contents, owner, and group are unaffected. src and dst are path-like objects or path names given as strings. If follow_symlinks is false, and both src and dst are symbolic links, copymode() will attempt to modify the mode of dst itself (rather than the file it points to). This functionality is not available on every platform; please see copystat() for more information. If copymode() cannot modify symbolic links on the local platform, and it is asked to do so, it will do nothing and return.

Викликає подію аудиту shutil.copymode з аргументами src, dst.

Змінено в версії 3.3: Додано аргумент follow_symlinks.

shutil.copystat(src, dst, *, follow_symlinks=True)

Copy the permission bits, last access time, last modification time, and flags from src to dst. On Linux, copystat() also copies the «extended attributes» where possible. The file contents, owner, and group are unaffected. src and dst are path-like objects or path names given as strings.

Якщо follow_symlinks має значення false, а src і dst посилаються на символічні посилання, copystat() працюватиме з самими символьними посиланнями, а не з файлами, на які посилаються символічні посилання, зчитуючи інформацію з символьне посилання src і запис інформації до символічного посилання dst.

Примітка

Не всі платформи надають можливість перевіряти та змінювати символічні посилання. Python сам може сказати вам, які функції доступні локально.

• Якщо os.chmod в os.supports_follow_symlinks має значення True, copystat() може змінити біти дозволу символічного посилання.

• Якщо os.utime в os.supports_follow_symlinks має значення True, copystat() може змінити час останнього доступу та модифікації символічного посилання.

• Якщо os.chflags в os.supports_follow_symlinks має значення True, copystat() може змінювати прапорці символічного посилання. (os.chflags доступний не на всіх платформах.)

На платформах, де деякі або всі ці функції недоступні, коли буде запропоновано змінити символічне посилання, copystat() скопіює все, що зможе. copystat() ніколи не повертає помилку.

Для отримання додаткової інформації перегляньте os.supports_follow_symlinks.

Викликає подію аудиту shutil.copystat з аргументами src, dst.

Змінено в версії 3.3: Додано аргумент follow_symlinks і підтримку розширених атрибутів Linux.

shutil.copy(src, dst, *, follow_symlinks=True)

Копіює файл src у файл або каталог dst. src і dst повинні бути шляховими об’єктами або рядками. Якщо dst визначає каталог, файл буде скопійовано в dst з використанням базового імені файлу з src. Якщо dst вказує на файл, який уже існує, його буде замінено. Повертає шлях до щойно створеного файлу.

Якщо follow_symlinks має значення false, а src є символічним посиланням, dst буде створено як символічне посилання. Якщо follow_symlinks має значення true і src є символічним посиланням, dst буде копією файлу, на який посилається src.

copy() копіює дані файлу та режим дозволу файлу (див. os.chmod()). Інші метадані, наприклад час створення та модифікації файлу, не зберігаються. Щоб зберегти всі метадані файлу з оригіналу, замість цього використовуйте copy2().

Викликає подію аудиту shutil.copyfile з аргументами src, dst.

Викликає подію аудиту shutil.copymode з аргументами src, dst.

Змінено в версії 3.3: Додано аргумент follow_symlinks. Тепер повертає шлях до щойно створеного файлу.

Змінено в версії 3.8: Спеціальні для платформи системні виклики швидкого копіювання можуть використовуватися внутрішньо для більш ефективного копіювання файлу. Перегляньте розділ Залежні від платформи ефективні операції копіювання.

shutil.copy2(src, dst, *, follow_symlinks=True)

Ідентичний copy() за винятком того, що copy2() також намагається зберегти метадані файлу.

When follow_symlinks is false, and src is a symbolic link, copy2() attempts to copy all metadata from the src symbolic link to the newly created dst symbolic link. However, this functionality is not available on all platforms. On platforms where some or all of this functionality is unavailable, copy2() will preserve all the metadata it can; copy2() never raises an exception because it cannot preserve file metadata.

copy2() використовує copystat() для копіювання метаданих файлу. Перегляньте copystat() для отримання додаткової інформації про підтримку платформи для зміни метаданих символічних посилань.

Викликає подію аудиту shutil.copyfile з аргументами src, dst.

Викликає подію аудиту shutil.copystat з аргументами src, dst.

Змінено в версії 3.3: Додано аргумент follow_symlinks, також спробуйте скопіювати розширені атрибути файлової системи (наразі лише для Linux). Тепер повертає шлях до щойно створеного файлу.

Змінено в версії 3.8: Спеціальні для платформи системні виклики швидкого копіювання можуть використовуватися внутрішньо для більш ефективного копіювання файлу. Перегляньте розділ Залежні від платформи ефективні операції копіювання.

shutil.ignore_patterns(*patterns)

Ця фабрична функція створює функцію, яку можна використовувати як виклик для аргументу ignore copytree(), ігноруючи файли та каталоги, які відповідають одному з наданих шаблонів стилю glob. Дивіться приклад нижче.

shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)

Рекурсивно скопіюйте все дерево каталогів із коренем src до каталогу з назвою dst і поверніть каталог призначення. Усі проміжні каталоги, які повинні містити dst, також будуть створені за замовчуванням.

Дозволи та час каталогів копіюються за допомогою copystat(), окремі файли копіюються за допомогою copy2().

Якщо symlinks має значення true, символічні посилання у вихідному дереві представлені як символічні посилання в новому дереві, а метадані оригінальних посилань буде скопійовано, наскільки це дозволяє платформа; якщо false або пропущено, вміст і метадані пов’язаних файлів копіюються до нового дерева.

When symlinks is false, if the file pointed to by the symlink doesn’t exist, an exception will be added in the list of errors raised in an Error exception at the end of the copy process. You can set the optional ignore_dangling_symlinks flag to true if you want to silence this exception. Notice that this option has no effect on platforms that don’t support os.symlink().

Якщо задано ignore, це має бути виклик, який отримає як аргументи каталог, який відвідує copytree(), і список його вмісту, який повертає os.listdir(). Оскільки copytree() викликається рекурсивно, ignore викликається один раз для кожного каталогу, який копіюється. Викликаний має повертати послідовність імен каталогу та файлу відносно поточного каталогу (тобто підмножину елементів у другому аргументі); ці імена будуть проігноровані в процесі копіювання. ignore_patterns() можна використати для створення такого виклику, який ігнорує імена на основі шаблонів у стилі glob.

Якщо трапляються винятки, виникає повідомлення Error зі списком причин.

Якщо задано copy_function, це має бути виклик, який використовуватиметься для копіювання кожного файлу. Він буде викликаний із вихідним шляхом і цільовим шляхом як аргументами. За замовчуванням використовується copy2(), але можна використовувати будь-яку функцію, яка підтримує такий самий підпис (наприклад, copy()).

Якщо dirs_exist_ok має значення false (за замовчуванням), а dst уже існує, виникає FileExistsError. Якщо dirs_exist_ok має значення true, операція копіювання продовжуватиметься, якщо буде виявлено існуючі каталоги, а файли в дереві dst будуть перезаписані відповідними файлами з дерева src.

Викликає подію аудиту shutil.copytree з аргументами src, dst.

Змінено в версії 3.2: Додано аргумент copy_function, щоб мати можливість надати спеціальну функцію копіювання. Додано аргумент ignore_dangling_symlinks, щоб вимкнути помилки висячих символьних посилань, коли symlinks має значення false.

Змінено в версії 3.3: Копіювати метадані, якщо symlinks має значення false. Тепер повертає dst.

Змінено в версії 3.8: Спеціальні для платформи системні виклики швидкого копіювання можуть використовуватися внутрішньо для більш ефективного копіювання файлу. Перегляньте розділ Залежні від платформи ефективні операції копіювання.

Змінено в версії 3.8: Added the dirs_exist_ok parameter.

shutil.rmtree(path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None)

Delete an entire directory tree; path must point to a directory (but not a symbolic link to a directory). If ignore_errors is true, errors resulting from failed removals will be ignored; if false or omitted, such errors are handled by calling a handler specified by onexc or onerror or, if both are omitted, exceptions are propagated to the caller.

Ця функція може підтримувати шляхи відносно дескрипторів каталогу.

Примітка

На платформах, які підтримують необхідні функції на основі fd, за замовчуванням використовується стійка до атак символічних посилань версія rmtree(). На інших платформах реалізація rmtree() чутлива до атаки через символічні посилання: за належного часу та обставин зловмисники можуть маніпулювати символічними посиланнями у файловій системі, щоб видалити файли, до яких вони не мали б доступу інакше. Програми можуть використовувати атрибут функції rmtree.avoids_symlink_attacks, щоб визначити, який регістр застосовний.

If onexc is provided, it must be a callable that accepts three parameters: function, path, and excinfo.

The first parameter, function, is the function which raised the exception; it depends on the platform and implementation. The second parameter, path, will be the path name passed to function. The third parameter, excinfo, is the exception that was raised. Exceptions raised by onexc will not be caught.

The deprecated onerror is similar to onexc, except that the third parameter it receives is the tuple returned from sys.exc_info().

Raises an auditing event shutil.rmtree with arguments path, dir_fd.

Змінено в версії 3.3: Додано версію, стійку до атак символічних посилань, яка використовується автоматично, якщо платформа підтримує функції на основі fd.

Змінено в версії 3.8: У Windows більше не буде видаляти вміст з’єднання каталогу перед видаленням з’єднання.

Змінено в версії 3.11: Додано параметр dir_fd.

Змінено в версії 3.12: Added the onexc parameter, deprecated onerror.

rmtree.avoids_symlink_attacks

Вказує, чи поточна платформа та реалізація забезпечують стійку до атак символічних посилань версію rmtree(). Наразі це стосується лише платформ, які підтримують функції доступу до каталогу на основі fd.

Added in version 3.3.

shutil.move(src, dst, copy_function=copy2)

Recursively move a file or directory (src) to another location and return the destination.

If dst is an existing directory or a symlink to a directory, then src is moved inside that directory. The destination path in that directory must not already exist.

If dst already exists but is not a directory, it may be overwritten depending on os.rename() semantics.

If the destination is on the current filesystem, then os.rename() is used. Otherwise, src is copied to the destination using copy_function and then removed. In case of symlinks, a new symlink pointing to the target of src will be created as the destination and src will be removed.

If copy_function is given, it must be a callable that takes two arguments, src and the destination, and will be used to copy src to the destination if os.rename() cannot be used. If the source is a directory, copytree() is called, passing it the copy_function. The default copy_function is copy2(). Using copy() as the copy_function allows the move to succeed when it is not possible to also copy the metadata, at the expense of not copying any of the metadata.

Викликає подію аудиту shutil.move з аргументами src, dst.

Змінено в версії 3.3: Додано явну обробку символічних посилань для іноземних файлових систем, таким чином адаптуючи її до поведінки GNU mv. Тепер повертає dst.

Змінено в версії 3.5: Додано аргумент ключового слова copy_function.

Змінено в версії 3.8: Спеціальні для платформи системні виклики швидкого копіювання можуть використовуватися внутрішньо для більш ефективного копіювання файлу. Перегляньте розділ Залежні від платформи ефективні операції копіювання.

Змінено в версії 3.9: Приймає path-like object для src і dst.

shutil.disk_usage(path)

Повертає статистику використання диска щодо заданого шляху як named tuple з атрибутами total, used і free, які є обсягом загального, використаного та вільного простору в байтах. шлях може бути файлом або каталогом.

Примітка

On Unix filesystems, path must point to a path within a mounted filesystem partition. On those platforms, CPython doesn’t attempt to retrieve disk usage information from non-mounted filesystems.

Added in version 3.3.

Змінено в версії 3.8: У Windows шлях тепер може бути файлом або каталогом.

Availability: Unix, Windows.

shutil.chown(path, user=None, group=None)

Змінити власника користувача та/або групу вказаного шляху.

user може бути системним іменем користувача або uid; те саме стосується групи. Потрібен принаймні один аргумент.

Дивіться також os.chown(), базову функцію.

Викликає подію аудиту shutil.chown з аргументами path, user, group.

Availability: Unix.

Added in version 3.3.

shutil.which(cmd, mode=os.F_OK | os.X_OK, path=None)

Повертає шлях до виконуваного файлу, який буде запущено, якщо буде викликано заданий cmd. Якщо cmd не буде викликано, поверніть None.

mode is a permission mask passed to os.access(), by default determining if the file exists and is executable.

path is a «PATH string» specifying the directories to look in, delimited by os.pathsep. When no path is specified, the PATH environment variable is read from os.environ, falling back to os.defpath if it is not set.

On Windows, the current directory is prepended to the path if mode does not include os.X_OK. When the mode does include os.X_OK, the Windows API NeedCurrentDirectoryForExePathW will be consulted to determine if the current directory should be prepended to path. To avoid consulting the current working directory for executables: set the environment variable NoDefaultCurrentDirectoryInExePath.

Also on Windows, the PATHEXT environment variable is used to resolve commands that may not already include an extension. For example, if you call shutil.which("python"), which() will search PATHEXT to know that it should look for python.exe within the path directories. For example, on Windows:

>>> shutil.which("python")
'C:\\Python33\\python.EXE'

This is also applied when cmd is a path that contains a directory component:

>> shutil.which("C:\\Python33\\python")
'C:\\Python33\\python.EXE'

Added in version 3.3.

Змінено в версії 3.8: Тип bytes тепер прийнятний. Якщо тип cmd bytes, тип результату також bytes.

Змінено в версії 3.12: On Windows, the current directory is no longer prepended to the search path if mode includes os.X_OK and WinAPI NeedCurrentDirectoryForExePathW(cmd) is false, else the current directory is prepended even if it is already in the search path; PATHEXT is used now even when cmd includes a directory component or ends with an extension that is in PATHEXT; and filenames that have no extension can now be found.

exception shutil.Error

Цей виняток збирає винятки, які виникають під час операції з кількома файлами. Для copytree() аргумент винятку — це список із 3-х кортежів (srcname, dstname, exception).

Залежні від платформи ефективні операції копіювання

Починаючи з Python 3.8, усі функції, пов’язані з копіюванням файлу (copyfile(), copy(), copy2(), copytree() та move() ) може використовувати специфічні для платформи системні виклики «швидкого копіювання» для більш ефективного копіювання файлу (див. bpo-33671). «швидке копіювання» означає, що операція копіювання відбувається всередині ядра, уникаючи використання буферів простору користувача в Python, як у «outfd.write(infd.read())».

У macOS fcopyfile використовується для копіювання вмісту файлу (а не метаданих).

У Linux використовується os.sendfile().

У Windows shutil.copyfile() використовує більший розмір буфера за замовчуванням (1 МіБ замість 64 КіБ) і використовується варіант memoryview() на основі shutil.copyfileobj().

Якщо операція швидкого копіювання зазнала невдачі і дані не були записані в цільовий файл, програма shutil мовчки повернеться до використання менш ефективної внутрішньої функції copyfileobj().

Змінено в версії 3.8.

приклад копіювання

Приклад, який використовує помічник ignore_patterns():

from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))

Буде скопійовано все, крім файлів .pyc і файлів або каталогів, назва яких починається з tmp.

Інший приклад, який використовує аргумент ignore для додавання виклику журналювання:

from shutil import copytree
import logging

def _logpath(path, names):
    logging.info('Working in %s', path)
    return []   # nothing will be ignored

copytree(source, destination, ignore=_logpath)

приклад rmtree

This example shows how to remove a directory tree on Windows where some of the files have their read-only bit set. It uses the onexc callback to clear the readonly bit and reattempt the remove. Any subsequent failure will propagate.

import os, stat
import shutil

def remove_readonly(func, path, _):
    "Clear the readonly bit and reattempt the removal"
    os.chmod(path, stat.S_IWRITE)
    func(path)

shutil.rmtree(directory, onexc=remove_readonly)

Архівні операції

Added in version 3.2.

Змінено в версії 3.5: Додано підтримку формату xztar.

Також надаються утиліти високого рівня для створення та читання стиснених і архівованих файлів. Вони покладаються на модулі zipfile і tarfile.

shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

Створіть архівний файл (наприклад, zip або tar) і поверніть його назву.

base_name is the name of the file to create, including the path, minus any format-specific extension.

format is the archive format: one of «zip» (if the zlib module is available), «tar», «gztar» (if the zlib module is available), «bztar» (if the bz2 module is available), or «xztar» (if the lzma module is available).

root_dir – це каталог, який буде кореневим каталогом архіву, усі шляхи в архіві будуть відносними до нього; наприклад, ми зазвичай chdir в root_dir перед створенням архіву.

base_dir - це каталог, з якого ми починаємо архівування; тобто base_dir буде загальним префіксом для всіх файлів і каталогів в архіві. base_dir має бути задано відносно root_dir. Перегляньте Приклад архівування з base_dir, щоб дізнатися, як використовувати base_dir і root_dir разом.

root_dir і base_dir за замовчуванням є поточним каталогом.

Якщо dry_run має значення true, архів не створюється, але операції, які будуть виконані, реєструються в logger.

власник і група використовуються під час створення архіву tar. За замовчуванням використовуються поточний власник і група.

logger має бути об’єктом, сумісним з PEP 282, зазвичай екземпляром logging.Logger.

Аргумент verbose не використовується та не підтримується.

Викликає подію аудиту shutil.make_archive з аргументами base_name, format, root_dir, base_dir.

Примітка

This function is not thread-safe when custom archivers registered with register_archive_format() do not support the root_dir argument. In this case it temporarily changes the current working directory of the process to root_dir to perform archiving.

Змінено в версії 3.8: Сучасний формат pax (POSIX.1-2001) тепер використовується замість застарілого формату GNU для архівів, створених за допомогою format="tar".

Змінено в версії 3.10.6: This function is now made thread-safe during creation of standard .zip and tar archives.

shutil.get_archive_formats()

Повернути список підтримуваних форматів для архівування. Кожен елемент повернутої послідовності є кортежем (назва, опис).

Типово shutil надає такі формати:

• zip: ZIP-файл (якщо доступний модуль zlib).

• tar: Нестиснутий файл tar. Використовує формат POSIX.1-2001 pax для нових архівів.

• gztar: заархівований tar-файл (якщо доступний модуль zlib).

• bztar: bzip2-файл tar (якщо доступний модуль bz2).

• xztar: xz’ed tar-файл (якщо доступний модуль lzma).

Ви можете зареєструвати нові формати або надати власний архіватор для будь-яких існуючих форматів, використовуючи register_archive_format().

shutil.register_archive_format(name, function[, extra_args[, description]])

Зареєструйте архіватор для формату назва.

функція — це виклик, який використовуватиметься для розпакування архівів. Викликаний отримає base_name файлу для створення, а потім base_dir (який за замовчуванням os.curdir), щоб розпочати архівування. Подальші аргументи передаються як ключові аргументи: owner, group, dry_run і logger (як передано в make_archive()).

If function has the custom attribute function.supports_root_dir set to True, the root_dir argument is passed as a keyword argument. Otherwise the current working directory of the process is temporarily changed to root_dir before calling function. In this case make_archive() is not thread-safe.

Якщо задано, extra_args — це послідовність пар (ім’я, значення), які використовуватимуться як додаткові аргументи ключових слів, коли використовується виклик архіватора.

опис використовується get_archive_formats(), який повертає список архіваторів. За замовчуванням порожній рядок.

Змінено в версії 3.12: Added support for functions supporting the root_dir argument.

shutil.unregister_archive_format(name)

Видаліть формат архіву назва зі списку підтримуваних форматів.

shutil.unpack_archive(filename[, extract_dir[, format[, filter]]])

Розпакуйте архів. ім’я файлу — це повний шлях до архіву.

extract_dir — назва цільового каталогу, куди розпаковується архів. Якщо не вказано, використовується поточний робочий каталог.

format — це формат архіву: «zip», «tar», «gztar», «bztar» або «xztar». Або будь-який інший формат, зареєстрований у register_unpack_format(). Якщо не вказано, unpack_archive() використовуватиме розширення назви архівного файлу та перевірятиме, чи було зареєстровано розпаковувач для цього розширення. Якщо нічого не знайдено, виникає ValueError.

The keyword-only filter argument is passed to the underlying unpacking function. For zip files, filter is not accepted. For tar files, it is recommended to set it to 'data', unless using features specific to tar and UNIX-like filesystems. (See Extraction filters for details.) The 'data' filter will become the default for tar files in Python 3.14.

Викликає подію аудиту shutil.unpack_archive з аргументами filename, extract_dir, format.

Попередження

Ніколи не витягуйте архіви з ненадійних джерел без попередньої перевірки. Можливо, що файли створюються поза шляхом, указаним у аргументі extract_dir, наприклад. члени, які мають абсолютні імена файлів, що починаються з «/» або імена файлів із двома крапками «..».

Змінено в версії 3.7: Приймає path-like object для filename і extract_dir.

Змінено в версії 3.12: Added the filter argument.

shutil.register_unpack_format(name, extensions, function[, extra_args[, description]])

Реєструє формат розпакування. ім’я — це назва формату, а розширення — це список розширень, що відповідають формату, наприклад .zip для файлів Zip.

function is the callable that will be used to unpack archives. The callable will receive:

• the path of the archive, as a positional argument;

• the directory the archive must be extracted to, as a positional argument;

• possibly a filter keyword argument, if it was given to unpack_archive();

• additional keyword arguments, specified by extra_args as a sequence of (name, value) tuples.

Для опису формату може бути надано description, яке буде повернено функцією get_unpack_formats().

shutil.unregister_unpack_format(name)

Скасувати реєстрацію формату розпакування. ім’я - це назва формату.

shutil.get_unpack_formats()

Повернути список усіх зареєстрованих форматів для розпакування. Кожен елемент повернутої послідовності є кортежем (назва, розширення, опис).

Типово shutil надає такі формати:

• zip: ZIP-файл (розпакування стиснених файлів працює лише за наявності відповідного модуля).

• tar: нестиснутий файл tar.

• gztar: заархівований tar-файл (якщо доступний модуль zlib).

• bztar: bzip2-файл tar (якщо доступний модуль bz2).

• xztar: xz’ed tar-файл (якщо доступний модуль lzma).

Ви можете зареєструвати нові формати або надати власний розпаковувач для будь-яких існуючих форматів за допомогою register_unpack_format().

Приклад архівування

У цьому прикладі ми створюємо архів tar-файлів у форматі gzip, який містить усі файли, знайдені в каталозі .ssh користувача:

>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
>>> make_archive(archive_name, 'gztar', root_dir)
'/Users/tarek/myarchive.tar.gz'

Отриманий архів містить:

$ tar -tzvf /Users/tarek/myarchive.tar.gz
drwx------ tarek/staff       0 2010-02-01 16:23:40 ./
-rw-r--r-- tarek/staff     609 2008-06-09 13:26:54 ./authorized_keys
-rwxr-xr-x tarek/staff      65 2008-06-09 13:26:54 ./config
-rwx------ tarek/staff     668 2008-06-09 13:26:54 ./id_dsa
-rwxr-xr-x tarek/staff     609 2008-06-09 13:26:54 ./id_dsa.pub
-rw------- tarek/staff    1675 2008-06-09 13:26:54 ./id_rsa
-rw-r--r-- tarek/staff     397 2008-06-09 13:26:54 ./id_rsa.pub
-rw-r--r-- tarek/staff   37192 2010-02-06 18:23:10 ./known_hosts

Приклад архівування з base_dir

У цьому прикладі, подібному до один вище, ми показуємо, як використовувати make_archive(), але цього разу з використанням base_dir. Тепер у нас є така структура каталогу:

$ tree tmp
tmp
└── root
    └── structure
        ├── content
            └── please_add.txt
        └── do_not_add.txt

У остаточному архіві слід включити please_add.txt, а do_not_add.txt — ні. Тому ми використовуємо наступне:

>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> make_archive(
...     archive_name,
...     'tar',
...     root_dir='tmp/root',
...     base_dir='structure/content',
... )
'/Users/tarek/my_archive.tar'

Перелік файлів у отриманому архіві дає нам:

$ python -m tarfile -l /Users/tarek/myarchive.tar
structure/content/
structure/content/please_add.txt

Запит розміру вихідного терміналу

shutil.get_terminal_size(fallback=(columns, lines))

Отримайте розмір вікна терміналу.

Для кожного з двох вимірів перевіряється змінна середовища, COLUMNS і LINES відповідно. Якщо змінна визначена і значення є додатним цілим числом, вона використовується.

Якщо COLUMNS або LINES не визначені, що є звичайним випадком, термінал, підключений до sys.__stdout__, запитується через виклик os.get_terminal_size().

Якщо розмір терміналу не може бути успішно запитаний через те, що система не підтримує запити, або тому, що ми не підключені до терміналу, використовується значення, указане в параметрі резервного. fallback за замовчуванням (80, 24), який є розміром за замовчуванням, який використовується багатьма емуляторами терміналів.

Повернене значення є іменованим кортежем типу os.terminal_size.

Дивіться також: Єдина специфікація UNIX, версія 2, Інші змінні середовища (Other Environment Variables).

Added in version 3.3.

Змінено в версії 3.11: The fallback values are also used if os.get_terminal_size() returns zeroes.