shutil — Высокоуровневые файловые операции

Kod źródłowy: Lib/shutil.py

---

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

Ostrzeżenie

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

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

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

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

Скопируйте содержимое файлоподобного объекта fsrc в файловоподобный объект fdst. Целое число длина, если оно указано, представляет собой размер буфера. В частности, отрицательное значение длины означает копирование данных без циклического перебора исходных данных частями; по умолчанию данные считываются порциями, чтобы избежать неконтролируемого потребления памяти. Обратите внимание: если текущая позиция объекта fsrc в файле не равна 0, будет скопировано только содержимое от текущей позиции до конца файла.

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

Скопируйте содержимое (без метаданных) файла с именем src в файл с именем dst и верните dst наиболее эффективным способом. src и dst — это объекты, подобные пути или имена путей, заданные в виде строк.

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

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

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

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

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

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

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

exception shutil.SpecialFileError

This exception is raised when copyfile() or copytree() attempt to copy a named pipe.

Dodane w wersji 2.7.

exception shutil.SameFileError

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

Dodane w wersji 3.4.

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

Скопируйте биты разрешений из src в dst. Содержимое файла, владелец и группа не затрагиваются. src и dst — это объекты, подобные пути или имена путей, заданные в виде строк. Если follow_symlinks имеет значение false, и оба src и dst являются символическими ссылками, copymode() попытается изменить режим самого dst (а не файла, на который он указывает). Эта функция доступна не на каждой платформе; пожалуйста, смотрите copystat() для получения дополнительной информации. Если copymode() не может изменить символические ссылки на локальной платформе, и его попросят это сделать, он ничего не сделает и вернется.

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

Zmienione w wersji 3.3: Додано аргумент follow_symlinks.

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

Скопируйте биты разрешений, время последнего доступа, время последнего изменения и флаги из src в dst. В Linux copystat() также копирует «расширенные атрибуты», где это возможно. Содержимое файла, владелец и группа не затрагиваются. src и dst — это объекты, подобные пути или имена путей, заданные в виде строк.

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

Informacja

Не всі платформи надають можливість перевіряти та змінювати символічні посилання. 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.

Zmienione w wersji 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.

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

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

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

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

Когда follow_symlinks имеет значение false, а src является символической ссылкой, copy2() пытается скопировать все метаданные из символической ссылки src во вновь созданную символическую ссылку dst. Однако эта функция доступна не на всех платформах. На платформах, где некоторые или все эти функции недоступны, copy2() сохранит все возможные метаданные; copy2() никогда не вызывает исключение, поскольку не может сохранить метаданные файла.

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

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

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

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

Zmienione w wersji 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 або пропущено, вміст і метадані пов’язаних файлів копіюються до нового дерева.

Когда symlinks имеет значение false и файл, на который указывает символическая ссылка, не существует, исключение будет добавлено в список ошибок, возникающих в исключении Error в конце процесса копирования. Вы можете установить необязательный флаг ignore_dangling_symlinks в значение true, если хотите отключить это исключение. Обратите внимание, что эта опция не влияет на платформы, которые не поддерживают 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.

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

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

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

Zmienione w wersji 3.8: Добавлен параметр dirs_exist_ok.

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

Удалить все дерево каталогов; путь должен указывать на каталог (но не на символическую ссылку на каталог). Если ignore_errors имеет значение true, ошибки, возникающие в результате неудачного удаления, будут игнорироваться; если false или опущено, такие ошибки обрабатываются путем вызова обработчика, указанного onexc или onerror, или, если оба опущены, исключения передаются вызывающей стороне.

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

Informacja

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

Если указан onexc, это должен быть вызываемый объект, принимающий три параметра: function, path и excinfo.

Первый параметр, function, — это функция, вызвавшая исключение; это зависит от платформы и реализации. Второй параметр, path, будет именем пути, передаваемым в function. Третий параметр, excinfo, является возникшим исключением. Исключения, вызванные onexc, не будут перехвачены.

Устаревший onerror аналогичен onexc, за исключением того, что третий параметр, который он получает, — это кортеж, возвращаемый из sys.exc_info().

Zobacz także

приклад rmtree para um exemplo de tratamento da remoção de uma árvore de diretórios que contém arquivos somente leitura.

Вызывает событие аудита <auditing>``shutil.rmtree` с аргументами path, dir_fd.

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

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

Zmienione w wersji 3.11: Додано параметр dir_fd.

Zmienione w wersji 3.12: Добавлен параметр onexc, устаревший onerror.

Zmienione w wersji 3.13: rmtree() теперь игнорирует исключения FileNotFoundError для всех путей, кроме пути верхнего уровня. Исключения, кроме OSError и подклассов OSError, теперь всегда передаются вызывающей стороне.

rmtree.avoids_symlink_attacks

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

Dodane w wersji 3.3.

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

Рекурсивно переместите файл или каталог (src) в другое место и верните место назначения.

Если dst — существующий каталог или символическая ссылка на каталог, то src перемещается внутрь этого каталога. Путь назначения в этом каталоге еще не должен существовать.

Если dst уже существует, но не является каталогом, он может быть перезаписан в зависимости от семантики os.rename().

Если место назначения находится в текущей файловой системе, то используется os.rename(). В противном случае src копируется в место назначения с помощью copy_function, а затем удаляется. В случае символических ссылок в качестве места назначения будет создана новая символическая ссылка, указывающая на цель src, а src будет удален.

Если указана copy_function, она должна быть вызываемой функцией, которая принимает два аргумента: src и пункт назначения, и будет использоваться для копирования src в пункт назначения, если os.rename() не может быть использована. Если источником является каталог, вызывается copytree(), передавая ему copy_function. По умолчанию copy_function — copy2(). Использование copy() в качестве copy_function позволяет успешному перемещению, когда невозможно также скопировать метаданные, за счет отсутствия копирования каких-либо метаданных.

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

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

Zmienione w wersji 3.5: Додано аргумент ключового слова copy_function.

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

Zmienione w wersji 3.9: Приймає path-like object для src і dst.

shutil.disk_usage(path)

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

Informacja

В файловых системах Unix path должен указывать на путь внутри смонтированного раздела файловой системы. На этих платформах CPython не пытается получить информацию об использовании диска из несмонтированных файловых систем.

Dodane w wersji 3.3.

Zmienione w wersji 3.8: У Windows шлях тепер може бути файлом або каталогом.

Dostępność: Unix, Windows.

shutil.chown(path, user=None, group=None, *, dir_fd=None, follow_symlinks=True)

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

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

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

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

Dostępność: Unix.

Dodane w wersji 3.3.

Zmienione w wersji 3.13: Добавлены параметры dir_fd и follow_symlinks.

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

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

mode — это маска разрешений, передаваемая в os.access(), по умолчанию определяющая, существует ли файл и является ли он исполняемым.

path — это строка PATH, определяющая каталоги для поиска, разделенная os.pathsep. Если path не указан, переменная среды PATH считывается из os.environ, возвращаясь к os.defpath, если она не установлена.

Se cmd contiver um componente de diretório, which() verificará apenas o caminho especificado diretamente e não pesquisará os diretórios listados em path ou na variável de ambiente PATH do sistema.

В Windows текущий каталог добавляется к path, если mode не включает os.X_OK. Когда mode включает os.X_OK, Windows API NeedCurrentDirectoryForExePathW будет обращаться к нему, чтобы определить, следует ли добавлять текущий каталог к ​​*path*. Чтобы избежать обращения к текущему рабочему каталогу для исполняемых файлов: установите переменную среды NoDefaultCurrentDirectoryInExePath.

Также в Windows переменная среды PATHEXT используется для разрешения команд, которые, возможно, еще не содержат расширения. Например, если вы вызываете shutil.that("python"), который() будет искать PATHEXT, чтобы знать, что он должен искать python.exe в *path * каталоги. Например, в Windows:

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

Это также применяется, когда cmd — это путь, содержащий компонент каталога:

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

Dodane w wersji 3.3.

Zmienione w wersji 3.8: Тип bytes тепер прийнятний. Якщо тип cmd bytes, тип результату також bytes.

Zmienione w wersji 3.12: В Windows текущий каталог больше не добавляется к пути поиска, если mode включает os.X_OK и WinAPI NeedCurrentDirectoryForExePathW(cmd) имеет значение false, в противном случае текущий каталог добавляется в начало, даже если он уже есть. в пути поиска; PATHEXT теперь используется, даже если cmd включает компонент каталога или заканчивается расширением, которое находится в PATHEXT; и теперь можно найти имена файлов без расширения.

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 використовується для копіювання вмісту файлу (а не метаданих).

On Linux os.sendfile() is used.

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

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

Zmienione w wersji 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

В этом примере показано, как удалить дерево каталогов в Windows, где для некоторых файлов установлен бит «только для чтения». Он использует обратный вызов onexc, чтобы очистить бит только для чтения и повторить попытку удаления. Любой последующий сбой будет распространяться.

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)

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

Dodane w wersji 3.2.

Zmienione w wersji 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 — это имя создаваемого файла, включая путь, за вычетом расширения, специфичного для формата.

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.

Informacja

Эта функция не является потокобезопасной, если пользовательские архиваторы, зарегистрированные с помощью register_archive_format(), не поддерживают аргумент root_dir. В этом случае он временно меняет текущий рабочий каталог процесса на root_dir для выполнения архивирования.

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

Zmienione w wersji 3.10.6: Эта функция теперь стала потокобезопасной при создании стандартных архивов .zip и tar.

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()).

Если function имеет пользовательский атрибут function.supports_root_dir, установленный в True, аргумент root_dir передается как аргумент ключевого слова. В противном случае текущий рабочий каталог процесса временно изменяется на root_dir перед вызовом function. В этом случае make_archive() не является потокобезопасным.

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

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

Zmienione w wersji 3.12: Добавлена ​​поддержка функций, поддерживающих аргумент root_dir.

shutil.unregister_archive_format(name)

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

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

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

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

format is the archive format: one of „zip”, „tar”, „gztar”, „bztar”, or „xztar”. Or any other format registered with register_unpack_format(). If not provided, unpack_archive() will use the archive file name extension and see if an unpacker was registered for that extension. In case none is found, a ValueError is raised.

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.

Ostrzeżenie

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

Zmienione w wersji 3.7: Приймає path-like object для filename і extract_dir.

Zmienione w wersji 3.12: Добавлен аргумент filter.

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

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

функция — это вызываемая функция, которая будет использоваться для распаковки архивов. Вызываемый получит:

• путь к архиву, как позиционный аргумент;

• каталог, в который должен быть распакован архив, в качестве позиционного аргумента;

• возможно, аргумент ключевого слова filter, если он был передан unpack_archive();

• дополнительные аргументы ключевого слова, указанные extra_args как последовательность кортежей (имя, значение).

Для опису формату може бути надано 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/myarchive.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).

Dodane w wersji 3.3.

Zmienione w wersji 3.11: Значения fallback также используются, если os.get_terminal_size() возвращает нули.