15.1. os – Различные интерфейсы операционной системы¶os – Miscellaneous operating system interfaces

15.1.1. Параметры процесса¶Process Parameters

Эти функции и элементы данных предоставляют информацию о текущем процессе и пользователе, а также позволяют с ними работать.

os.environ¶

Отображение, представляющее строковое окружение. Например, environ['HOME'] – это путь к домашнему каталогу (на некоторых платформах), и эквивалентно getenv("HOME") в C.

Это отображение захватывается при первом импорте модуля os, обычно во время запуска Python при обработке site.py. Изменения окружения, сделанные после этого момента, не отражаются в os.environ, за исключением изменений, выполненных путём прямого изменения os.environ.

Если платформа поддерживает функцию putenv(), это отображение можно использовать как для изменения окружения, так и для его запроса. putenv() будет вызвана автоматически при изменении отображения.

Примечание

Вызов putenv() напрямую не изменяет os.environ, поэтому лучше изменять os.environ.

Примечание

На некоторых платформах, включая FreeBSD и Mac OS X, установка environ может вызвать утечки памяти. Обратитесь к системной документации putenv().

Если putenv() не указано, изменённая копия этого отображения может быть передана соответствующим функциям создания процессов, чтобы дочерние процессы использовали изменённое окружение.

Если платформа поддерживает функцию unsetenv(), можно удалять элементы из этого отображения, чтобы сбросить переменные окружения. unsetenv() будет вызвана автоматически при удалении элемента из os.environ, а также при вызове одного из методов pop() или clear().

Изменено в версии 2.6: Также удаляет переменные окружения при вызове os.environ.clear() и os.environ.pop().

os.chdir(path)

os.fchdir(fd)

os.getcwd()

Эти функции описаны в Files and Directories.

os.ctermid()¶

Возвращает имя файла, соответствующее управляющему терминалу процесса.

Доступность: Unix.

os.getegid()¶

Возвращает эффективный идентификатор группы текущего процесса. Это соответствует биту «set id» у файла, выполняемого в текущем процессе.

Доступность: Unix.

os.geteuid()¶

Возвращает эффективный идентификатор пользователя текущего процесса.

Доступность: Unix.

os.getgid()¶

Возвращает реальный идентификатор группы текущего процесса.

Доступность: Unix.

os.getgroups()¶

Возвращает список дополнительных идентификаторов групп, связанных с текущим процессом.

Доступность: Unix.

Примечание

На Mac OS X поведение getgroups() несколько отличается от других Unix-платформ. Если интерпретатор Python был собран с целевой версией развёртывания 10.5 или более ранней, getgroups() возвращает список эффективных идентификаторов групп, связанных с текущим процессом пользователя; этот список ограничен системным максимальным количеством записей, обычно 16, и может изменяться вызовами setgroups() при наличии соответствующих привилегий. Если интерпретатор собран с целевой версией развёртывания больше 10.5, getgroups() возвращает текущий список доступа к группам для пользователя, связанного с эффективным идентификатором пользователя процесса; этот список может меняться в течение времени жизни процесса, на него не влияют вызовы setgroups(), и его длина не ограничена 16. Значение целевой версии развёртывания, MACOSX_DEPLOYMENT_TARGET, можно получить с помощью sysconfig.get_config_var().

os.initgroups(username, gid)¶

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

Доступность: Unix.

Новое в версии 2.7.

os.getlogin()¶

Возвращает имя пользователя, вошедшего в систему на управляющем терминале процесса. Для большинства целей удобнее использовать переменную окружения LOGNAME, чтобы узнать, кто пользователь, или pwd.getpwuid(os.getuid())[0], чтобы получить имя входа для реального идентификатора пользователя процесса.

Доступность: Unix.

os.getpgid(pid)¶

Возвращает идентификатор группы процессов для процесса с идентификатором pid. Если pid равен 0, возвращается идентификатор группы текущего процесса.

Доступность: Unix.

Новое в версии 2.3.

os.getpgrp()¶

Возвращает идентификатор текущей группы процессов.

Доступность: Unix.

os.getpid()¶

Возвращает идентификатор текущего процесса.

Доступность: Unix, Windows.

os.getppid()¶

Возвращает идентификатор родительского процесса.

Доступность: Unix.

os.getresuid()¶

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

Доступность: Unix.

Новое в версии 2.7.

os.getresgid()¶

Возвращает кортеж (rgid, egid, sgid), обозначающий реальный, эффективный и сохранённый идентификаторы группы текущего процесса.

Доступность: Unix.

Новое в версии 2.7.

os.getuid()¶

Возвращает реальный идентификатор пользователя текущего процесса.

Доступность: Unix.

os.getenv(varname[, value])¶

Возвращает значение переменной окружения varname, если она существует, или value, если нет. value по умолчанию равно None.

Доступность: большинство разновидностей Unix, Windows.

os.putenv(varname, value)¶

Устанавливает переменную окружения с именем varname равной строке value. Такие изменения в окружении влияют на подпроцессы, запущенные с помощью os.system(), popen() или fork() и execv().

Доступность: большинство разновидностей Unix, Windows.

Примечание

На некоторых платформах, включая FreeBSD и Mac OS X, установка environ может вызвать утечки памяти. Обратитесь к системной документации по putenv.

Когда putenv() поддерживается, присваивания элементам os.environ автоматически преобразуются в соответствующие вызовы putenv(); однако вызовы putenv() не обновляют os.environ, поэтому на самом деле предпочтительнее присваивать значения элементам os.environ.

os.setegid(egid)¶

Устанавливает эффективный идентификатор группы текущего процесса.

Доступность: Unix.

os.seteuid(euid)¶

Устанавливает эффективный идентификатор пользователя текущего процесса.

Доступность: Unix.

os.setgid(gid)¶

Устанавливает идентификатор группы текущего процесса.

Доступность: Unix.

os.setgroups(groups)¶

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

Доступность: Unix.

Новое в версии 2.2.

Примечание

На Mac OS X длина groups не может превышать системного максимального количества эффективных идентификаторов групп, обычно 16. Обратитесь к документации getgroups() для случаев, когда может не возвращаться тот же список групп, который был установлен вызовом setgroups().

os.setpgrp()¶

Вызывает системный вызов setpgrp() или setpgrp(0, 0) в зависимости от того, какая версия реализована (если таковая имеется). За семантикой обращайтесь к руководству Unix.

Доступность: Unix.

os.setpgid(pid, pgrp)¶

Вызывает системный вызов setpgid(), чтобы установить идентификатор группы процессов процесса с идентификатором pid равным группе процессов с идентификатором pgrp. За семантикой обращайтесь к руководству Unix.

Доступность: Unix.

os.setregid(rgid, egid)¶

Устанавливает реальный и эффективный идентификаторы группы текущего процесса.

Доступность: Unix.

os.setresgid(rgid, egid, sgid)¶

Устанавливает реальный, эффективный и сохранённый идентификаторы группы текущего процесса.

Доступность: Unix.

Новое в версии 2.7.

os.setresuid(ruid, euid, suid)¶

Устанавливает реальный, эффективный и сохранённый идентификаторы пользователя текущего процесса.

Доступность: Unix.

Новое в версии 2.7.

os.setreuid(ruid, euid)¶

Устанавливает реальный и эффективный идентификаторы пользователя текущего процесса.

Доступность: Unix.

os.getsid(pid)¶

Вызывает системный вызов getsid(). За семантикой обращайтесь к руководству Unix.

Доступность: Unix.

Новое в версии 2.4.

os.setsid()¶

Вызывает системный вызов setsid(). За семантикой обращайтесь к руководству Unix.

Доступность: Unix.

os.setuid(uid)¶

Устанавливает идентификатор пользователя текущего процесса.

Доступность: Unix.

os.strerror(code)¶

Возвращает сообщение об ошибке, соответствующее коду ошибки в code. На платформах, где strerror() возвращает NULL при неизвестном номере ошибки, возбуждается ValueError.

Доступность: Unix, Windows.

os.umask(mask)¶

Устанавливает текущую числовую umask и возвращает предыдущую umask.

Доступность: Unix, Windows.

os.uname()¶

Возвращает 5-кортеж, содержащий информацию, идентифицирующую текущую операционную систему. Кортеж содержит 5 строк: (sysname, nodename, release, version, machine). Некоторые системы обрезают имя узла до 8 символов или до первого компонента; лучший способ получить имя хоста – socket.gethostname() или даже socket.gethostbyaddr(socket.gethostname()).

Доступность: современные версии Unix.

os.unsetenv(varname)¶

Удаляет (отменяет) переменную окружения с именем varname. Такие изменения в окружении влияют на подпроцессы, запущенные с помощью os.system(), popen() или fork() и execv().

Когда поддерживается unsetenv(), удаление элементов из os.environ автоматически преобразуется в соответствующий вызов unsetenv(); однако вызовы unsetenv() не обновляют os.environ, поэтому на самом деле предпочтительнее удалять элементы из os.environ.

Доступность: большинство разновидностей Unix, Windows.

15.1.2. Создание объекта файла¶File Object Creation

Эти функции создают новые файловые объекты. (См. также open().)

os.fdopen(fd[, mode[, bufsize]])¶

Возвращает открытый файловый объект, подключённый к файловому дескриптору fd. Аргументы mode и bufsize имеют тот же смысл, что и соответствующие аргументы встроенной функции open(). Если fdopen() вызывает исключение, fd остаётся нетронутым (незакрытым).

Доступность: Unix, Windows.

Изменено в версии 2.3: Если указан, аргумент mode теперь должен начинаться с одной из букв 'r', 'w' или 'a', иначе возникает исключение ValueError.

Изменено в версии 2.5: В Unix, когда аргумент mode начинается с 'a', на файловом дескрипторе устанавливается флаг O_APPEND (что реализация fdopen() уже делает на большинстве платформ).

os.popen(command[, mode[, bufsize]])¶

Открывает канал к команде command или от неё. Возвращаемое значение – открытый файловый объект, подключённый к каналу, который можно читать или записывать в зависимости от того, является ли mode значением 'r' (по умолчанию) или 'w'. Аргумент bufsize имеет тот же смысл, что и соответствующий аргумент встроенной функции open(). Код завершения команды (закодированный в формате, указанном для wait()) доступен как возвращаемое значение метода close() файлового объекта, за исключением того, что когда код завершения равен нулю (завершение без ошибок), возвращается None.

Доступность: Unix, Windows.

Устарело с версии 2.6: Эта функция устарела. Используйте модуль subprocess. Обратите особое внимание на раздел Замена старых функций модулем subprocess.

Изменено в версии 2.0: Эта функция работала ненадёжно в Windows в более ранних версиях Python. Это было связано с использованием функции _popen() из библиотек, поставляемых с Windows. В более новых версиях Python не используется неработающая реализация из библиотек Windows.

os.tmpfile()¶

Возвращает новый файловый объект, открытый в режиме обновления (w+b). Файл не имеет связанных с ним записей каталога и будет автоматически удалён, когда для него не останется файловых дескрипторов.

Доступность: Unix, Windows.

Существует несколько различных функций popen*(), которые предоставляют слегка разные способы создания подпроцессов.

Для каждого из вариантов popen*(), если указан bufsize, он задаёт размер буфера для каналов ввода-вывода. mode, если указан, должен быть строкой 'b' или 't'; в Windows это необходимо для определения того, должны ли файловые объекты открываться в двоичном или текстовом режиме. Значение по умолчанию для mode – 't'.

Кроме того, для каждого из этих вариантов в Unix cmd может быть последовательностью, и в этом случае аргументы будут передаваться непосредственно программе без участия оболочки (как в os.spawnv()). Если cmd является строкой, она будет передана оболочке (как в os.system()).

Эти методы не позволяют получить код завершения дочерних процессов. Единственный способ управлять потоками ввода и вывода, а также получать коды возврата – использовать модуль subprocess; эти функции доступны только в Unix.

Обсуждение возможных условий взаимоблокировки, связанных с использованием этих функций, см. в разделе Проблемы управления потоком.

os.popen2(cmd[, mode[, bufsize]])¶

Выполняет cmd как подпроцесс и возвращает файловые объекты (child_stdin, child_stdout).

Устарело с версии 2.6: Эта функция устарела. Используйте модуль subprocess. Особенно обратите внимание на раздел Замена старых функций модулем subprocess.

Доступность: Unix, Windows.

Новое в версии 2.0.

os.popen3(cmd[, mode[, bufsize]])¶

Выполняет cmd как подпроцесс и возвращает файловые объекты (child_stdin, child_stdout, child_stderr).

Устарело с версии 2.6: Эта функция устарела. Используйте модуль subprocess. Особенно обратите внимание на раздел Замена старых функций модулем subprocess.

Доступность: Unix, Windows.

Новое в версии 2.0.

os.popen4(cmd[, mode[, bufsize]])¶

Выполняет cmd как подпроцесс и возвращает файловые объекты (child_stdin, child_stdout_and_stderr).

Устарело с версии 2.6: Эта функция устарела. Используйте модуль subprocess. Особенно обратите внимание на раздел Замена старых функций модулем subprocess.

Доступность: Unix, Windows.

Новое в версии 2.0.

(Обратите внимание, что именование child_stdin, child_stdout, and child_stderr ведётся с точки зрения дочернего процесса, поэтому child_stdin – это стандартный ввод дочернего процесса.)

Эта функциональность также доступна в модуле popen2 через одноимённые функции, но порядок возвращаемых значений у них отличается.

15.1.3. Операции с файловыми дескрипторами¶File Descriptor Operations

Эти функции работают с потоками ввода-вывода, на которые ссылаются файловые дескрипторы.

Файловые дескрипторы – это небольшие целые числа, соответствующие файлу, который был открыт текущим процессом. Например, стандартный ввод обычно имеет файловый дескриптор 0, стандартный вывод – 1, а стандартный вывод ошибок – 2. Последующие файлы, открываемые процессом, получают номера 3, 4, 5 и так далее. Название «файловый дескриптор» слегка обманчиво; на платформах Unix сокеты и каналы также обозначаются файловыми дескрипторами.

Метод fileno() можно использовать для получения файлового дескриптора, связанного с файловым объектом, когда это необходимо. Обратите внимание, что прямое использование файлового дескриптора обходит методы файлового объекта и игнорирует такие аспекты, как внутренняя буферизация данных.

os.close(fd)¶

Закрывает файловый дескриптор fd.

Доступность: Unix, Windows.

Примечание

Эта функция предназначена для низкоуровневого ввода-вывода и должна применяться к файловому дескриптору, возвращённому os.open() или pipe(). Чтобы закрыть «файловый объект», возвращённый встроенной функцией open() или popen() или fdopen(), используйте его метод close().

os.closerange(fd_low, fd_high)¶

Закрывает все файловые дескрипторы от fd_low (включительно) до fd_high (исключительно), игнорируя ошибки. Эквивалентно:

for fd in xrange(fd_low, fd_high):
    try:
        os.close(fd)
    except OSError:
        pass

Доступность: Unix, Windows.

Новое в версии 2.6.

os.dup(fd)¶

Возвращает дубликат файлового дескриптора fd.

Доступность: Unix, Windows.

os.dup2(fd, fd2)¶

Дублирует файловый дескриптор fd в fd2, закрывая последний дескриптор сначала, если необходимо.

Доступность: Unix, Windows.

os.fchmod(fd, mode)¶

Изменяет режим файла, заданного fd, на числовой mode. Список возможных значений mode см. в документации на chmod().

Доступность: Unix.

Новое в версии 2.6.

os.fchown(fd, uid, gid)¶

Изменяет идентификаторы владельца и группы файла, заданного дескриптором fd, на числовые uid и gid. Чтобы оставить один из идентификаторов без изменений, установите его в -1.

Доступность: Unix.

Новое в версии 2.6.

os.fdatasync(fd)¶

Принудительная запись файла с файловым дескриптором fd на диск. Не принуждает к обновлению метаданных.

Доступность: Unix.

Примечание

Эта функция недоступна в MacOS.

os.fpathconf(fd, name)¶

Возвращает информацию о системной конфигурации, относящуюся к открытому файлу. name задаёт значение конфигурации для получения; это может быть строка, являющаяся именем определённого системного значения; эти имена указаны в ряде стандартов (POSIX.1, Unix 95, Unix 98 и другие). Некоторые платформы определяют дополнительные имена. Имена, известные операционной системе хоста, приведены в словаре pathconf_names. Для переменных конфигурации, не включённых в это отображение, также принимается передача целого числа для name.

Если name – строка и не известна, возбуждается исключение ValueError. Если конкретное значение для name не поддерживается хост-системой, даже если оно присутствует в pathconf_names, возбуждается исключение OSError с errno.EINVAL в качестве кода ошибки.

Доступность: Unix.

os.fstat(fd)¶

Возвращает статус для файлового дескриптора fd, аналогично stat().

Доступность: Unix, Windows.

os.fstatvfs(fd)¶

Возвращает информацию о файловой системе, содержащей файл, связанный с файловым дескриптором fd, аналогично statvfs().

Доступность: Unix.

os.fsync(fd)¶

Принудительно записывает файл с файловым дескриптором fd на диск. В Unix вызывает нативную функцию fsync(); в Windows – функцию MS _commit().

Если исходным является объект Python-файла f, сначала выполните f.flush(), а затем os.fsync(f.fileno()), чтобы все внутренние буферы, связанные с f, были записаны на диск.

Доступность: Unix и Windows, начиная с версии 2.2.3.

os.ftruncate(fd, length)¶

Усекает файл, соответствующий файловому дескриптору fd, так, чтобы его размер составлял не более length байт.

Доступность: Unix.

os.isatty(fd)¶

Возвращает True, если файловый дескриптор fd открыт и подключён к устройству типа tty, иначе False.

os.lseek(fd, pos, how)¶

Устанавливает текущую позицию файлового дескриптора fd в позицию pos, с заданным параметром how: SEEK_SET или 0 – установить позицию относительно начала файла; SEEK_CUR или 1 – относительно текущей позиции; SEEK_END или 2 – относительно конца файла. Возвращает новую позицию курсора в байтах от начала.

Доступность: Unix, Windows.

os.SEEK_SET¶

os.SEEK_CUR¶

os.SEEK_END¶

Параметры функции lseek(). Их значения – 0, 1 и 2 соответственно.

Доступность: Windows, Unix.

Новое в версии 2.5.

os.open(file, flags[, mode])¶

Открывает файл file и устанавливает различные флаги в соответствии с flags и, возможно, его режим в соответствии с mode. Режим по умолчанию mode – 0777 (восьмеричное), при этом сначала маскируется текущее значение umask. Возвращает файловый дескриптор для вновь открытого файла.

Описание значений флагов и режимов см. в документации по среде выполнения C; константы флагов (например, O_RDONLY и O_WRONLY) также определены в этом модуле (см. константы флагов open()). В частности, в Windows для открытия файлов в бинарном режиме необходимо добавить O_BINARY.

Доступность: Unix, Windows.

Примечание

Эта функция предназначена для низкоуровневого ввода-вывода. Для обычного использования применяйте встроенную функцию open(), которая возвращает «файловый объект» с методами read() и write() (и многими другими). Чтобы обернуть файловый дескриптор в «файловый объект», используйте fdopen().

os.openpty()¶

Открывает новую пару псевдотерминалов. Возвращает пару файловых дескрипторов (master, slave) для pty и tty соответственно. Для (чуть) более переносимого подхода используйте модуль pty.

Доступность: некоторые разновидности Unix.

os.pipe()¶

Создаёт канал. Возвращает пару файловых дескрипторов (r, w), пригодных для чтения и записи соответственно.

Доступность: Unix, Windows.

os.read(fd, n)¶

Читает не более n байтов из файлового дескриптора fd. Возвращает строку, содержащую прочитанные байты. Если достигнут конец файла, на который ссылается fd, возвращается пустая строка.

Доступность: Unix, Windows.

Примечание

Эта функция предназначена для низкоуровневого ввода-вывода и должна применяться к файловому дескриптору, возвращаемому os.open() или pipe(). Для чтения «файлового объекта», возвращаемого встроенной функцией open() или popen(), fdopen(), sys.stdin, используйте его методы read() или readline().

os.tcgetpgrp(fd)¶

Возвращает группу процессов, связанную с терминалом, заданным fd (открытый файловый дескриптор, возвращаемый os.open()).

Доступность: Unix.

os.tcsetpgrp(fd, pg)¶

Устанавливает группу процессов, связанную с терминалом, заданным fd (открытый файловый дескриптор, возвращаемый os.open()), в pg.

Доступность: Unix.

os.ttyname(fd)¶

Возвращает строку, которая идентифицирует терминальное устройство, связанное с файловым дескриптором fd. Если fd не связан с терминальным устройством, возбуждается исключение.

Доступность: Unix.

os.write(fd, str)¶

Записывает строку str в файловый дескриптор fd. Возвращает количество фактически записанных байтов.

Доступность: Unix, Windows.

Примечание

Эта функция предназначена для низкоуровневого ввода-вывода и должна применяться к файловому дескриптору, возвращённому os.open() или pipe(). Чтобы записать «файловый объект», возвращённый встроенной функцией open() или popen(), или fdopen(), или sys.stdout, или sys.stderr, используйте его метод write().

15.1.4. Файлы и каталоги¶Files and Directories

os.access(path, mode)¶

Использует реальные uid/gid для проверки доступа к path. Обратите внимание, что большинство операций используют эффективные uid/gid, поэтому эта функция может применяться в среде suid/sgid для проверки, имеет ли вызывающий пользователь указанный доступ к path. mode должен быть F_OK для проверки существования path, или может быть логическим ИЛИ одного или нескольких из R_OK, W_OK и X_OK для проверки прав. Возвращает True, если доступ разрешён, False – если нет. См. man-страницу Unix access(2) для получения дополнительной информации.

Доступность: Unix, Windows.

Примечание

Использование access() для проверки, авторизован ли пользователь, например, на открытие файла, перед фактическим открытием с помощью open(), создаёт брешь в безопасности, поскольку пользователь может воспользоваться коротким временным промежутком между проверкой и открытием файла для его изменения. Предпочтительнее использовать подход EAFP. Например:

if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()
return "some default data"

лучше написать так:

try:
    fp = open("myfile")
except IOError as e:
    if e.errno == errno.EACCES:
        return "some default data"
    # Не ошибка прав доступа.
    raise
else:
    with fp:
        return fp.read()

Примечание

Операции ввода-вывода могут завершиться ошибкой, даже если access() указывает, что они должны выполниться успешно, особенно для операций в сетевых файловых системах, которые могут иметь семантику прав доступа, выходящую за рамки обычной POSIX-модели битов разрешений.

os.F_OK¶

Значение, которое нужно передать в качестве параметра mode функции access() для проверки существования path.

os.R_OK¶

Значение, которое нужно включить в параметр mode функции access() для проверки читаемости path.

os.W_OK¶

Значение, которое нужно включить в параметр mode функции access() для проверки возможности записи в path.

os.X_OK¶

Значение, которое нужно включить в параметр mode функции access(), чтобы определить, можно ли выполнить path.

os.chdir(path)¶

Изменяет текущий рабочий каталог на path.

Доступность: Unix, Windows.

os.fchdir(fd)¶

Изменяет текущую рабочую директорию на директорию, представленную файловым дескриптором fd. Дескриптор должен ссылаться на открытую директорию, а не на открытый файл.

Доступность: Unix.

Новое в версии 2.3.

os.getcwd()¶

Возвращает строку, представляющую текущую рабочую директорию.

Доступность: Unix, Windows.

os.getcwdu()¶

Возвращает объект Unicode, представляющий текущий рабочий каталог.

Доступность: Unix, Windows.

Новое в версии 2.3.

os.chflags(path, flags)¶

Устанавливает флаги path в числовое значение flags. flags может принимать комбинацию (побитовое ИЛИ) следующих значений (определённых в модуле stat):

• stat.UF_NODUMP

• stat.UF_IMMUTABLE

• stat.UF_APPEND

• stat.UF_OPAQUE

• stat.UF_NOUNLINK

• stat.UF_COMPRESSED

• stat.UF_HIDDEN

• stat.SF_ARCHIVED

• stat.SF_IMMUTABLE

• stat.SF_APPEND

• stat.SF_NOUNLINK

• stat.SF_SNAPSHOT

Доступность: Unix.

Новое в версии 2.6.

os.chroot(path)¶

Изменяет корневую директорию текущего процесса на path. Доступность: Unix.

Новое в версии 2.2.

os.chmod(path, mode)¶

Изменяет режим path на числовое значение mode. mode может принимать одно из следующих значений (определённых в модуле stat) или их побитовые комбинации:

• stat.S_ISUID

• stat.S_ISGID

• stat.S_ENFMT

• stat.S_ISVTX

• stat.S_IREAD

• stat.S_IWRITE

• stat.S_IEXEC

• stat.S_IRWXU

• stat.S_IRUSR

• stat.S_IWUSR

• stat.S_IXUSR

• stat.S_IRWXG

• stat.S_IRGRP

• stat.S_IWGRP

• stat.S_IXGRP

• stat.S_IRWXO

• stat.S_IROTH

• stat.S_IWOTH

• stat.S_IXOTH

Доступность: Unix, Windows.

Примечание

Хотя Windows поддерживает chmod(), с его помощью можно установить только флаг «только для чтения» файла (через константы stat.S_IWRITE и stat.S_IREAD или соответствующее целочисленное значение). Все остальные биты игнорируются.

os.chown(path, uid, gid)¶

Изменяет владельца и группу path на числовые uid и gid. Чтобы оставить один из идентификаторов без изменений, задайте для него значение -1.

Доступность: Unix.

os.lchflags(path, flags)¶

Устанавливает флаги path в числовое значение flags, как chflags(), но не переходит по символическим ссылкам.

Доступность: Unix.

Новое в версии 2.6.

os.lchmod(path, mode)¶

Изменяет режим path на числовое значение mode. Если путь является символической ссылкой, это изменяет саму ссылку, а не целевой объект. Описание возможных значений mode см. в документации chmod().

Доступность: Unix.

Новое в версии 2.6.

os.lchown(path, uid, gid)¶

Изменяет владельца и группу path на числовые uid и gid. Эта функция не переходит по символическим ссылкам.

Доступность: Unix.

Новое в версии 2.3.

os.link(source, link_name)¶

Создаёт жёсткую ссылку, указывающую на source, с именем link_name.

Доступность: Unix.

os.listdir(path)¶

Возвращает список, содержащий имена элементов в каталоге, заданном path. Список находится в произвольном порядке. Он не включает специальные элементы '.' и '..', даже если они присутствуют в каталоге.

Доступность: Unix, Windows.

Изменено в версии 2.3: В Windows NT/2k/XP и Unix, если path является объектом Unicode, результатом будет список объектов Unicode. Нераскодируемые имена файлов по-прежнему возвращаются как строковые объекты.

os.lstat(path)¶

Выполняет эквивалент системного вызова lstat() для заданного пути. Похожа на stat(), но не переходит по символическим ссылкам. На платформах, не поддерживающих символические ссылки, является псевдонимом для stat().

os.mkfifo(path[, mode])¶

Создаёт FIFO (именованный канал) с именем path с числовым режимом mode. Значение по умолчанию для mode – 0666 (восьмеричное). Текущее значение umask сначала вычитается из режима.

Доступность: Unix.

FIFO – это каналы, к которым можно обращаться как к обычным файлам. FIFO существуют до тех пор, пока их не удалят (например, с помощью os.unlink()). Как правило, FIFO используются как точка встречи между процессами типа «клиент» и «сервер»: сервер открывает FIFO для чтения, а клиент открывает его для записи. Обратите внимание, что mkfifo() не открывает FIFO – он только создаёт точку встречи.

os.mknod(filename[, mode=0600[, device=0]])¶

Создаёт узел файловой системы (файл, специальный файл устройства или именованный канал) с именем filename. mode задаёт как права доступа, так и тип создаваемого узла, комбинируясь (побитовое ИЛИ) с одной из констант stat.S_IFREG, stat.S_IFCHR, stat.S_IFBLK и stat.S_IFIFO (эти константы доступны в stat). Для stat.S_IFCHR и stat.S_IFBLK параметр device определяет вновь создаваемый специальный файл устройства (вероятно, с помощью os.makedev()), в противном случае он игнорируется.

Новое в версии 2.3.

os.major(device)¶

Извлекает старший номер устройства из сырого номера устройства (обычно поля st_dev или st_rdev из stat).

Новое в версии 2.3.

os.minor(device)¶

Извлекает младший номер устройства из сырого номера устройства (обычно поля st_dev или st_rdev из stat).

Новое в версии 2.3.

os.makedev(major, minor)¶

Составляет сырой номер устройства из старшего и младшего номеров устройства.

Новое в версии 2.3.

os.mkdir(path[, mode])¶

Создаёт каталог с именем path с числовым режимом mode. Значение по умолчанию для mode – 0777 (восьмеричное). Если каталог уже существует, вызывается исключение OSError.

На некоторых системах mode игнорируется. Если он используется, сначала применяется маска текущего umask. Если установлены биты, отличные от последних 9 (то есть последних 3 цифр восьмеричного представления mode), их значение зависит от платформы. На некоторых платформах они игнорируются, и для их установки следует явно вызвать chmod().

Также можно создавать временные каталоги; см. функцию tempfile.mkdtemp() модуля tempfile.

Доступность: Unix, Windows.

os.makedirs(path[, mode])¶

Функция рекурсивного создания каталогов. Подобна mkdir(), но создаёт все промежуточные каталоги, необходимые для размещения конечного каталога. Вызывает исключение error, если конечный каталог уже существует или не может быть создан. Значение по умолчанию для mode – 0777 (восьмеричное).

Параметр mode передается в mkdir(); подробнее об интерпретации см. в описании mkdir() .

Примечание

makedirs() запутается, если элементы пути для создания содержат os.pardir.

Новое в версии 1.5.2.

Изменено в версии 2.3: Эта функция теперь корректно обрабатывает пути UNC.

os.pathconf(path, name)¶

Возвращает информацию о системной конфигурации для указанного файла. name задаёт запрашиваемое значение конфигурации; это может быть строка, содержащая имя определённого системного значения. Эти имена заданы в ряде стандартов (POSIX.1, Unix 95, Unix 98 и других). На некоторых платформах могут быть также определены дополнительные имена. Имена, известные операционной системе, приведены в словаре pathconf_names. Для переменных конфигурации, не включённых в это соответствие, допускается также передача целого числа в качестве name.

Если name – строка и не известна, возбуждается исключение ValueError. Если конкретное значение для name не поддерживается хост-системой, даже если оно присутствует в pathconf_names, возбуждается исключение OSError с errno.EINVAL в качестве кода ошибки.

Доступность: Unix.

os.pathconf_names¶

Словарь, сопоставляющий имена, принимаемые pathconf() и fpathconf(), с целочисленными значениями, определёнными для этих имён операционной системой. Его можно использовать для определения набора имён, известных системе. Доступность: Unix.

os.readlink(path)¶

Возвращает строку, представляющую путь, на который указывает символическая ссылка. Результат может быть как абсолютным, так и относительным путём; если он относительный, его можно преобразовать в абсолютный путь с помощью os.path.join(os.path.dirname(path), result).

Изменено в версии 2.6: Если path является объектом Unicode, результат также будет объектом Unicode.

Доступность: Unix.

os.remove(path)¶

Удаляет файл path. Если path является каталогом, вызывается исключение OSError; для удаления каталога см. rmdir() ниже. Эта функция идентична функции unlink(), описанной ниже. В Windows попытка удалить файл, который используется, приводит к исключению; в Unix запись в каталоге удаляется, но выделенное файлу хранилище не освобождается до тех пор, пока исходный файл больше не используется.

Доступность: Unix, Windows.

os.removedirs(path)¶

Рекурсивно удаляет каталоги. Работает как rmdir(), за исключением того, что если конечный каталог успешно удалён, removedirs() пытается последовательно удалить все родительские каталоги, указанные в path, пока не возникнет ошибка (которая игнорируется, поскольку обычно это означает, что родительский каталог не пуст). Например, os.removedirs('foo/bar/baz') сначала удалит каталог 'foo/bar/baz', а затем удалит 'foo/bar' и 'foo', если они пусты. Возбуждает OSError, если конечный каталог не удалось удалить.

Новое в версии 1.5.2.

os.rename(src, dst)¶

Переименовывает файл или каталог src в dst. Если dst является каталогом, будет вызвано исключение OSError. В Unix, если dst существует и является файлом, он будет бесшумно заменён, если у пользователя есть разрешение. Операция может завершиться ошибкой в некоторых разновидностях Unix, если src и dst находятся в разных файловых системах. В случае успеха переименование будет атомарной операцией (это требование POSIX). В Windows, если dst уже существует, будет вызвано исключение OSError, даже если это файл; может не быть способа реализовать атомарное переименование, когда dst указывает на существующий файл.

Доступность: Unix, Windows.

os.renames(old, new)¶

Функция рекурсивного переименования каталогов или файлов. Работает как rename(), за исключением того, что сначала предпринимается попытка создать все промежуточные каталоги, необходимые для формирования нового пути. После переименования каталоги, соответствующие самым правым сегментам пути старого имени, будут удалены с помощью removedirs().

Новое в версии 1.5.2.

Примечание

Эта функция может завершиться неудачей, если новая структура каталогов уже создана, но недостаточно прав для удаления конечного каталога или файла.

os.rmdir(path)¶

Удаляет каталог path. Работает только когда каталог пуст, в противном случае возбуждается OSError. Для удаления целых деревьев каталогов можно использовать shutil.rmtree().

Доступность: Unix, Windows.

os.stat(path)¶

Выполняет эквивалент системного вызова stat() для заданного пути. (Эта функция переходит по символическим ссылкам; для stat символической ссылки используйте lstat().)

Возвращаемое значение – объект, атрибуты которого соответствуют полям структуры stat, а именно:

• st_mode - биты защиты,

• st_ino - номер inode,

• st_dev - устройство,

• st_nlink - количество жёстких ссылок,

• st_uid - идентификатор владельца (uid),

• st_gid - идентификатор группы владельца (gid),

• st_size – размер файла в байтах,

• st_atime – время последнего доступа,

• st_mtime – время последнего изменения содержимого,

• st_ctime – платформозависимо; время последнего изменения метаданных в Unix или время создания в Windows)

Изменено в версии 2.3: Если stat_float_times() возвращает True, значения времени являются числами с плавающей запятой, выражающими секунды. Доли секунды могут сообщаться, если система это поддерживает. См. stat_float_times() для дальнейшего обсуждения.

В некоторых системах Unix (например, Linux) могут быть также доступны следующие атрибуты:

• st_blocks – количество блоков по 512 байт, выделенных файлу

• st_blksize – размер блока файловой системы для эффективного ввода-вывода

• st_rdev – тип устройства, если это inode-устройство

• st_flags – пользовательские флаги для файла

В других системах Unix (например, FreeBSD) могут быть доступны следующие атрибуты (но могут заполняться, только если root попытается их использовать):

• st_gen – номер поколения файла

• st_birthtime – время создания файла

В системах RISCOS также доступны следующие атрибуты:

• st_ftype (тип файла)

• st_attrs (атрибуты)

• st_obtype (тип объекта).

Примечание

Точный смысл и разрешение атрибутов st_atime, st_mtime и st_ctime зависят от операционной системы и файловой системы. Например, в системах Windows, использующих файловые системы FAT или FAT32, атрибут st_mtime имеет разрешение 2 секунды, а st_atime – всего 1 день. Подробности см. в документации операционной системы.

Для обратной совместимости возвращаемое значение stat() также доступно в виде кортежа как минимум из 10 целых чисел, представляющих наиболее важные (и переносимые) члены структуры stat в порядке st_mode, st_ino, st_dev, st_nlink, st_uid, st_gid, st_size, st_atime, st_mtime, st_ctime. Некоторые реализации могут добавлять дополнительные элементы в конец.

Стандартный модуль stat определяет функции и константы, полезные для извлечения информации из структуры stat. (В Windows некоторые элементы заполняются фиктивными значениями.)

Пример:

>>> import os
>>> statinfo = os.stat('somefile.txt')
>>> statinfo
(33188, 422511, 769, 1, 1032, 100, 926, 1105022698,1105022732, 1105022732)
>>> statinfo.st_size
926

Доступность: Unix, Windows.

Изменено в версии 2.2: Добавлен доступ к значениям в качестве атрибутов возвращаемого объекта.

Изменено в версии 2.5: Добавлены st_gen и st_birthtime.

os.stat_float_times([newvalue])¶

Определяет, представляет ли stat_result временные метки как объекты float. Если newvalue равен True, будущие вызовы stat() возвращают float, если равен False, будущие вызовы возвращают int. Если newvalue опущен, возвращает текущую настройку.

Для совместимости со старыми версиями Python, доступ к stat_result как к кортежу всегда возвращает целые числа.

Изменено в версии 2.5: Python теперь по умолчанию возвращает значения типа float. Приложения, которые некорректно работают с временными метками с плавающей запятой, могут использовать эту функцию для восстановления старого поведения.

Разрешение временных меток (то есть наименьшая возможная дробная часть) зависит от системы. Некоторые системы поддерживают только секундное разрешение; на таких системах дробная часть всегда будет равна нулю.

Рекомендуется изменять этот параметр только во время запуска программы в модуле __main__; библиотеки никогда не должны изменять этот параметр. Если приложение использует библиотеку, которая некорректно работает при обработке вещественных временных меток, этому приложению следует отключить эту возможность до тех пор, пока библиотека не будет исправлена.

os.statvfs(path)¶

Выполняет системный вызов statvfs() для указанного пути. Возвращаемое значение – объект, атрибуты которого описывают файловую систему по указанному пути и соответствуют членам структуры statvfs, а именно: f_bsize, f_frsize, f_blocks, f_bfree, f_bavail, f_files, f_ffree, f_favail, f_flag, f_namemax.

Для обратной совместимости возвращаемое значение также доступно в виде кортежа, значения которого соответствуют атрибутам в порядке, указанном выше. Стандартный модуль statvfs определяет константы, полезные для извлечения информации из структуры statvfs при доступе к ней как к последовательности; это остаётся полезным при написании кода, который должен работать с версиями Python, не поддерживающими доступ к полям как к атрибутам.

Доступность: Unix.

Изменено в версии 2.2: Добавлен доступ к значениям в качестве атрибутов возвращаемого объекта.

os.symlink(source, link_name)¶

Создаёт символическую ссылку, указывающую на source, с именем link_name.

Доступность: Unix.

os.tempnam([dir[, prefix]])¶

Возвращает уникальное имя пути, подходящее для создания временного файла. Это будет абсолютный путь, указывающий на потенциальную запись каталога в каталоге dir или в общем месте для временных файлов, если dir опущен или None. Если задан и не None, prefix используется для указания короткого префикса имени файла. Приложения отвечают за правильное создание и управление файлами, созданными с использованием путей, возвращённых tempnam(); автоматическая очистка не предоставляется. В Unix переменная окружения TMPDIR переопределяет dir, а в Windows используется TMP. Конкретное поведение этой функции зависит от реализации библиотеки C; некоторые аспекты недостаточно определены в системной документации.

Предупреждение

Использование tempnam() уязвимо для атак через символические ссылки; рассмотрите возможность использования tmpfile() (раздел Создание файловых объектов) вместо этого.

Доступность: Unix, Windows.

os.tmpnam()¶

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

Предупреждение

Использование tmpnam() уязвимо для атак через символические ссылки; рассмотрите возможность использования tmpfile() (раздел Создание файловых объектов) вместо этого.

Доступность: Unix, Windows. Однако эту функцию, вероятно, не следует использовать в Windows: реализация Microsoft tmpnam() всегда создаёт имя в корневом каталоге текущего диска, а это, как правило, неудачное место для временного файла (в зависимости от прав доступа вы можете даже не иметь возможности открыть файл с таким именем).

os.TMP_MAX¶

Максимальное количество уникальных имён, которые tmpnam() сгенерирует перед повторным использованием имён.

os.unlink(path)¶

Удаляет файл path. Это та же функция, что и remove(); имя unlink() является её традиционным именем в Unix.

Доступность: Unix, Windows.

os.utime(path, times)¶

Устанавливает время доступа и модификации файла, заданного path. Если times равно None, то время доступа и модификации файла устанавливаются в текущее время. (Эффект аналогичен выполнению Unix-программы touch для указанного пути.) В противном случае times должен быть кортежем из двух чисел вида (atime, mtime), который используется для установки времени доступа и модификации соответственно. Возможность указать каталог в качестве path зависит от того, реализует ли операционная система каталоги как файлы (например, Windows этого не делает). Обратите внимание, что точные установленные значения времени могут не возвращаться последующим вызовом stat() из-за разрешения, с которым операционная система записывает время доступа и модификации; см. stat().

Изменено в версии 2.0: Добавлена поддержка None для times.

Доступность: Unix, Windows.

os.walk(top, topdown=True, onerror=None, followlinks=False)¶

Генерирует имена файлов в дереве каталогов, обходя дерево сверху вниз или снизу вверх. Для каждого каталога в дереве с корнем в каталоге top (включая сам top) возвращает кортеж из трех элементов (dirpath, dirnames, filenames).

dirpath – это строка, путь к каталогу. dirnames – список имен подкаталогов в dirpath (за исключением '.' и '..'). filenames – список имен файлов, не являющихся каталогами, в dirpath. Обратите внимание, что имена в списках не содержат компонентов пути. Чтобы получить полный путь (начинающийся с top) к файлу или каталогу в dirpath, выполните os.path.join(dirpath, name).

Если необязательный аргумент topdown равен True или не указан, тройка для каталога генерируется до троек для всех его подкаталогов (каталоги обходятся сверху вниз). Если topdown равен False, тройка для каталога генерируется после троек для всех его подкаталогов (каталоги обходятся снизу вверх). Независимо от значения topdown, список подкаталогов извлекается до того, как генерируются кортежи для каталога и его подкаталогов.

Когда topdown равен True, вызывающий код может изменить список dirnames на месте (возможно, используя del или присваивание срезу), и walk() будет рекурсивно обходить только те подкаталоги, имена которых остались в dirnames; это можно использовать для обрезания дерева поиска, задания определенного порядка обхода или даже для уведомления walk() о каталогах, которые вызывающий код создает или переименовывает до того, как walk() возобновит работу. Изменение dirnames, когда topdown равен False, не влияет на поведение обхода, потому что в режиме снизу вверх каталоги в dirnames генерируются до того, как генерируется сам dirpath.

По умолчанию ошибки из вызова listdir() игнорируются. Если указан необязательный аргумент onerror, это должна быть функция; она будет вызвана с одним аргументом – экземпляром OSError. Она может сообщить об ошибке, чтобы продолжить обход, или возбудить исключение, чтобы прервать обход. Обратите внимание, что имя файла доступно как атрибут filename объекта исключения.

По умолчанию walk() не будет спускаться в символические ссылки, ведущие к каталогам. Установите followlinks в True, чтобы посещать каталоги, на которые указывают симлинки, в системах, поддерживающих их.

Новое в версии 2.6: Параметр followlinks.

Примечание

Следует учитывать, что установка followlinks в True может привести к бесконечной рекурсии, если ссылка указывает на родительский каталог самой себя. walk() не отслеживает уже посещённые каталоги.

Примечание

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

В этом примере показано количество байтов, занимаемых файлами (не каталогами) в каждом каталоге внутри начального каталога, при этом он не заглядывает ни в один подкаталог CVS:

import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/email'):
    print root, "consumes",
    print sum(getsize(join(root, name)) for name in files),
    print "bytes in", len(files), "non-directory files"
    if 'CVS' in dirs:
        dirs.remove('CVS')  # не заходить в CVS-каталоги

В следующем примере обход дерева снизу вверх необходим: rmdir() не позволяет удалить каталог, пока он не пуст.

# Удалить всё, доступное из каталога с именем "top",
# при условии отсутствия символических ссылок.
# ВНИМАНИЕ: это опасно! Например, если top == '/', это
# может удалить все ваши файлы на диске.
import os
for root, dirs, files in os.walk(top, topdown=False):
    for name in files:
        os.remove(os.path.join(root, name))
    for name in dirs:
        os.rmdir(os.path.join(root, name))

Новое в версии 2.3.

15.1.5. Управление процессами¶Process Management

Эти функции можно использовать для создания процессов и управления ими.

Различные функции exec* принимают список аргументов для новой программы, загружаемой в процесс. В каждом случае первый аргумент передаётся новой программе как её собственное имя, а не как аргумент, который пользователь мог бы ввести в командной строке. Для программиста на C это argv[0], передаваемый в main() программы. Например, os.execv('/bin/echo', ['foo', 'bar']) выведет на стандартный вывод только bar; foo будет проигнорирован.

os.abort()¶

Генерирует сигнал SIGABRT для текущего процесса. На Unix поведение по умолчанию – создание дампа памяти; на Windows процесс немедленно возвращает код завершения 3. Имейте в виду, что вызов этой функции не вызовет обработчик сигнала Python, зарегистрированный для SIGABRT с помощью signal.signal().

Доступность: Unix, Windows.

os.execl(path, arg0, arg1, ...)¶

os.execle(path, arg0, arg1, ..., env)¶

os.execlp(file, arg0, arg1, ...)¶

os.execlpe(file, arg0, arg1, ..., env)¶

os.execv(path, args)¶

os.execve(path, args, env)¶

os.execvp(file, args)¶

os.execvpe(file, args, env)¶

Все эти функции выполняют новую программу, заменяя текущий процесс; они не возвращают управление. В Unix новый исполняемый файл загружается в текущий процесс и получает тот же идентификатор процесса, что и вызывающий. Ошибки сообщаются как исключения OSError.

Текущий процесс заменяется немедленно. Открытые файловые объекты и дескрипторы не сбрасываются, поэтому если на этих открытых файлах могут быть буферизованные данные, следует сбросить их с помощью sys.stdout.flush() или os.fsync() перед вызовом функции exec*.

Варианты с буквами «l» и «v» функций exec* различаются способом передачи аргументов командной строки. Варианты «l», пожалуй, проще в использовании, если количество параметров фиксировано на момент написания кода: отдельные параметры просто становятся дополнительными аргументами функций execl*(). Варианты «v» удобны, когда количество параметров переменное: аргументы передаются в виде списка или кортежа как параметр args. В любом случае аргументы дочернего процесса должны начинаться с имени выполняемой команды, хотя это и не принудительно.

Варианты, содержащие "p" ближе к концу (execlp(), execlpe(), execvp() и execvpe()), используют переменную окружения PATH для поиска файла программы. При замене окружения (с помощью одного из вариантов exec*e, обсуждаемых в следующем абзаце) новая среда используется как источник переменной PATH. Остальные варианты, execl(), execle(), execv() и execve(), не используют переменную PATH для поиска исполняемого файла; path должен содержать правильный абсолютный или относительный путь.

Для execle(), execlpe(), execve() и execvpe() (обратите внимание, что все они заканчиваются на «e») параметр env должен быть отображением, используемым для определения переменных окружения нового процесса (они используются вместо окружения текущего процесса); функции execl(), execlp(), execv() и execvp() заставляют новый процесс наследовать окружение текущего процесса.

Доступность: Unix, Windows.

os._exit(n)¶

Завершает процесс с кодом n, без вызова обработчиков очистки, сброса буферов stdio и т.д.

Доступность: Unix, Windows.

Примечание

Стандартный способ завершения – sys.exit(n). _exit() обычно следует использовать только в дочернем процессе после fork().

Определены следующие коды завершения, которые можно использовать с _exit(), хотя они не обязательны. Обычно они используются для системных программ, написанных на Python, например, для внешней программы доставки команд почтового сервера.

os.EX_OK¶

Код завершения, означающий, что ошибок не возникло.

Доступность: Unix.

Новое в версии 2.3.

os.EX_USAGE¶

Код завершения, означающий, что команда была использована неправильно, например, когда передано неверное количество аргументов.

Доступность: Unix.

Новое в версии 2.3.

os.EX_DATAERR¶

Код завершения, означающий, что входные данные были некорректны.

Доступность: Unix.

Новое в версии 2.3.

os.EX_NOINPUT¶

Код завершения, означающий, что входной файл не существовал или не был доступен для чтения.

Доступность: Unix.

Новое в версии 2.3.

os.EX_NOUSER¶

Код завершения, означающий, что указанный пользователь не существовал.

Доступность: Unix.

Новое в версии 2.3.

os.EX_NOHOST¶

Код завершения, означающий, что указанный хост не существовал.

Доступность: Unix.

Новое в версии 2.3.

os.EX_UNAVAILABLE¶

Код завершения, означающий, что требуемая служба недоступна.

Доступность: Unix.

Новое в версии 2.3.

os.EX_SOFTWARE¶

Код завершения, означающий, что обнаружена внутренняя программная ошибка.

Доступность: Unix.

Новое в версии 2.3.

os.EX_OSERR¶

Код завершения, означающий, что обнаружена ошибка операционной системы, например, невозможность выполнить fork или создать канал.

Доступность: Unix.

Новое в версии 2.3.

os.EX_OSFILE¶

Код завершения, означающий, что некоторый системный файл не существовал, не мог быть открыт или содержал ошибку другого рода.

Доступность: Unix.

Новое в версии 2.3.

os.EX_CANTCREAT¶

Код завершения, означающий, что указанный пользователем выходной файл не удалось создать.

Доступность: Unix.

Новое в версии 2.3.

os.EX_IOERR¶

Код выхода, означающий ошибку ввода-вывода при работе с каким-то файлом.

Доступность: Unix.

Новое в версии 2.3.

os.EX_TEMPFAIL¶

Код выхода, означающий временный сбой. Указывает на ситуацию, которая может и не быть ошибкой – например, на невозможность установить сетевое соединение при повторяемой операции.

Доступность: Unix.

Новое в версии 2.3.

os.EX_PROTOCOL¶

Код выхода, означающий, что обмен по протоколу был недопустимым, недействительным или нераспознанным.

Доступность: Unix.

Новое в версии 2.3.

os.EX_NOPERM¶

Код выхода, сообщающий о недостаточных правах для выполнения операции (не относится к проблемам файловой системы).

Доступность: Unix.

Новое в версии 2.3.

os.EX_CONFIG¶

Код выхода, указывающий на ошибку конфигурации.

Доступность: Unix.

Новое в версии 2.3.

os.EX_NOTFOUND¶

Код выхода, означающий нечто вроде «запись не найдена».

Доступность: Unix.

Новое в версии 2.3.

os.fork()¶

Порождает дочерний процесс. Возвращает 0 в дочернем процессе и идентификатор дочернего процесса в родительском. При возникновении ошибки возбуждается OSError.

Обратите внимание, что некоторые платформы, включая FreeBSD <= 6.3, Cygwin и OS/2 EMX, имеют известные проблемы при использовании fork() из потока.

Предупреждение

См. ssl для приложений, использующих модуль SSL с fork().

Доступность: Unix.

os.forkpty()¶

Создаёт дочерний процесс, используя новый псевдотерминал в качестве управляющего терминала дочернего процесса. Возвращает пару (pid, fd), где pid равен 0 в дочернем процессе, а в родительском – идентификатор нового дочернего процесса, и fd – это файловый дескриптор ведущего конца псевдотерминала. Для более переносимого подхода используйте модуль pty. Если возникает ошибка, возбуждается OSError.

Доступность: некоторые разновидности Unix.

os.kill(pid, sig)¶

Отправляет сигнал sig процессу pid. Константы для конкретных сигналов, доступных на хост-платформе, определены в модуле signal.

Windows: Сигналы signal.CTRL_C_EVENT и signal.CTRL_BREAK_EVENT – это специальные сигналы, которые можно отправлять только консольным процессам, имеющим общее окно консоли, например, некоторым подпроцессам. Любое другое значение sig приведет к безусловному завершению процесса через API TerminateProcess, а код возврата будет установлен в sig. Версия kill() для Windows дополнительно принимает дескрипторы процессов для завершения.

Новое в версии 2.7: Поддержка Windows

os.killpg(pgid, sig)¶

Отправить сигнал sig группе процессов pgid.

Доступность: Unix.

Новое в версии 2.3.

os.nice(increment)¶

Добавить increment к «приоритету» процесса. Возвращает новый приоритет.

Доступность: Unix.

os.plock(op)¶

Блокирует сегменты программы в памяти. Значение op (определённое в <sys/lock.h>) определяет, какие сегменты блокируются.

Доступность: Unix.

os.popen(...)

os.popen2(...)

os.popen3(...)

os.popen4(...)

Запускает дочерние процессы и возвращает открытые каналы для взаимодействия. Эти функции описаны в разделе Создание файловых объектов.

os.spawnl(mode, path, ...)¶

os.spawnle(mode, path, ..., env)¶

os.spawnlp(mode, file, ...)¶

os.spawnlpe(mode, file, ..., env)¶

os.spawnv(mode, path, args)¶

os.spawnve(mode, path, args, env)¶

os.spawnvp(mode, file, args)¶

os.spawnvpe(mode, file, args, env)¶

Выполняет программу path в новом процессе.

(Обратите внимание, что модуль subprocess предоставляет более мощные средства для создания новых процессов и получения их результатов; использование этого модуля предпочтительнее, чем использование этих функций. Особенно см. раздел Замена старых функций модулем subprocess.)

Если mode равен P_NOWAIT, эта функция возвращает идентификатор нового процесса; если mode равен P_WAIT, возвращает код выхода процесса, если он завершился нормально, или -signal, где signal – сигнал, который завершил процесс. В Windows идентификатор процесса на самом деле является дескриптором процесса, поэтому его можно использовать с функцией waitpid().

Варианты «l» и «v» функций spawn* различаются способом передачи аргументов командной строки. Варианты «l», возможно, проще в использовании, если количество параметров фиксировано на момент написания кода; отдельные параметры просто становятся дополнительными параметрами функций spawnl*(). Варианты «v» удобны, когда количество параметров переменное, и аргументы передаются в виде списка или кортежа через параметр args. В любом случае, аргументы дочернего процесса должны начинаться с имени выполняемой команды.

Варианты, содержащие вторую «p» в конце (spawnlp(), spawnlpe(), spawnvp() и spawnvpe()), используют переменную окружения PATH для поиска программы file. При замене окружения (с помощью одного из вариантов spawn*e, обсуждаемых в следующем абзаце) новое окружение используется как источник переменной PATH. Другие варианты, spawnl(), spawnle(), spawnv() и spawnve(), не используют переменную PATH для поиска исполняемого файла; path должен содержать подходящий абсолютный или относительный путь.

Для spawnle(), spawnlpe(), spawnve() и spawnvpe() (обратите внимание, все они заканчиваются на «e») параметр env должен быть отображением, которое используется для определения переменных окружения нового процесса (они используются вместо окружения текущего процесса); функции spawnl(), spawnlp(), spawnv() и spawnvp() заставляют новый процесс наследовать окружение текущего процесса. Обратите внимание, что ключи и значения в словаре env должны быть строками; недопустимые ключи или значения приведут к ошибке функции с возвращаемым значением 127.

В качестве примера следующие вызовы spawnlp() и spawnvpe() эквивалентны:

import os
os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')

L = ['cp', 'index.html', '/dev/null']
os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)

Доступность: Unix, Windows. spawnlp(), spawnlpe(), spawnvp()\nи spawnvpe() недоступны в Windows. spawnle() и\nspawnve() не являются потокобезопасными в Windows; рекомендуется использовать\nмодуль subprocess.

Новое в версии 1.6.

os.P_NOWAIT¶

os.P_NOWAITO¶

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

Доступность: Unix, Windows.

Новое в версии 1.6.

os.P_WAIT¶

Возможное значение параметра mode для семейства функций spawn*. Если указано это значение как mode, функции spawn*() не вернутся, пока новый процесс не завершится, и вернут код выхода процесса в случае успешного завершения, или -signal, если сигнал завершит процесс.

Доступность: Unix, Windows.

Новое в версии 1.6.

os.P_DETACH¶

os.P_OVERLAY¶

Возможные значения параметра mode для семейства функций spawn*. Они менее переносимы, чем перечисленные выше. P_DETACH аналогичен P_NOWAIT, но новый процесс отсоединяется от консоли вызывающего процесса. Если используется P_OVERLAY, текущий процесс будет заменён; функция spawn*() не вернётся.

Доступность: Windows.

Новое в версии 1.6.

os.startfile(path[, operation])¶

Запускает файл в связанном с ним приложении.

Если operation не указан или равен 'open', это работает как двойной щелчок по файлу в Проводнике Windows или передача имени файла в качестве аргумента команде start из интерактивной командной строки: файл открывается с помощью приложения, связанного с его расширением (если такое есть).

Если указана другая operation, она должна быть «глаголом команды» (command verb), определяющим, что делать с файлом. Распространённые глаголы, задокументированные Microsoft: 'print' и 'edit' (используются для файлов), а также 'explore' и 'find' (используются для каталогов).

startfile() возвращается сразу после запуска соответствующего приложения. Невозможно дождаться закрытия приложения или получить его код возврата. Параметр path задаётся относительно текущего каталога. Если требуется использовать абсолютный путь, убедитесь, что первый символ не является косой чертой ('/'); в противном случае базовая функция Win32 ShellExecute() не сработает. Используйте функцию os.path.normpath(), чтобы путь был правильно закодирован для Win32.

Доступность: Windows.

Новое в версии 2.0.

Новое в версии 2.5: Параметр operation.

os.system(command)¶

Выполняет команду (строку) в подчиненной оболочке. Это реализуется вызовом стандартной функции C system() и имеет те же ограничения. Изменения sys.stdin и т.д. не отражаются в окружении выполняемой команды.

В Unix возвращаемое значение – это код завершения процесса, закодированный в формате, указанном для wait(). Обратите внимание, что POSIX не определяет значение возвращаемого значения функции C system(), поэтому возвращаемое значение функции Python зависит от системы.

В Windows возвращаемое значение – это значение, возвращаемое системной оболочкой после выполнения command, заданное переменной окружения Windows COMSPEC: в системах с command.com (Windows 95, 98 и ME) это всегда 0; в системах с cmd.exe (Windows NT, 2000 и XP) это код завершения выполненной команды; в системах, использующих нестандартную оболочку, следует обратиться к документации используемой оболочки.

Модуль subprocess предоставляет более мощные средства для запуска новых процессов и получения их результатов; использование этого модуля предпочтительнее, чем этой функции. Смотрите раздел Замена старых функций модулем подпроцесс в документации subprocess для получения полезных примеров.

Доступность: Unix, Windows.

os.times()¶

Возвращает кортеж из 5 чисел с плавающей запятой, указывающих накопленное (процессорное или иное) время в секундах. Элементы: пользовательское время, системное время, пользовательское время дочерних процессов, системное время дочерних процессов и прошедшее реальное время с некоторой фиксированной точки в прошлом – именно в таком порядке. См. страницу руководства Unix times(2) или соответствующую документацию Windows Platform API. В Windows заполнены только первые два элемента, остальные равны нулю.

Доступность: Unix, Windows

os.wait()¶

Ожидает завершения дочернего процесса и возвращает кортеж, содержащий его PID и индикатор статуса выхода: 16-битное число, младший байт которого – номер сигнала, завершившего процесс, а старший байт – статус выхода (если номер сигнала равен нулю); старший бит младшего байта установлен, если был создан файл core.

Доступность: Unix.

os.waitpid(pid, options)¶

Подробности этой функции различаются в Unix и Windows.

В Unix: ожидает завершения дочернего процесса, заданного идентификатором процесса pid, и возвращает кортеж, содержащий его идентификатор процесса и индикатор статуса завершения (закодированный как для wait()). Семантика вызова зависит от значения целочисленного параметра options, который должен быть 0 для нормальной работы.

Если pid больше 0, waitpid() запрашивает информацию о состоянии для этого конкретного процесса. Если pid равен 0, запрос выполняется для состояния любого дочернего процесса в группе процессов текущего процесса. Если pid равен -1, запрос относится к любому дочернему процессу текущего процесса. Если pid меньше -1, запрашивается состояние для любого процесса в группе процессов -pid (абсолютное значение pid).

Возбуждается OSError со значением errno, когда системный вызов возвращает -1.

В Windows: ожидает завершения процесса, заданного дескриптором процесса pid, и возвращает кортеж, содержащий pid и его статус завершения, сдвинутый влево на 8 бит (сдвиг упрощает кроссплатформенное использование функции). pid, меньший или равный 0, не имеет особого смысла в Windows и вызывает исключение. Значение целочисленного параметра options не влияет на результат. pid может относиться к любому процессу, чей идентификатор известен, не обязательно дочернему. Функции spawn*, вызванные с P_NOWAIT, возвращают подходящие дескрипторы процессов.

os.wait3(options)¶

Аналогично waitpid(), но без аргумента с идентификатором процесса; возвращается кортеж из трёх элементов, содержащий идентификатор процесса дочернего процесса, индикацию статуса завершения и информацию об использовании ресурсов. За подробностями об информации об использовании ресурсов обратитесь к resource.getrusage(). Аргумент option совпадает с тем, что передаётся в waitpid() и wait4().

Доступность: Unix.

Новое в версии 2.5.

os.wait4(pid, options)¶

Аналогично waitpid(), но возвращается кортеж из 3 элементов, содержащий идентификатор дочернего процесса, указание статуса завершения и информацию об использовании ресурсов. За подробностями об информации об использовании ресурсов обратитесь к resource.getrusage(). Аргументы для wait4() такие же, как и для waitpid().

Доступность: Unix.

Новое в версии 2.5.

os.WNOHANG¶

Опция для waitpid(), позволяющая вернуть результат немедленно, если статус дочернего процесса недоступен. В этом случае функция возвращает (0, 0).

Доступность: Unix.

os.WCONTINUED¶

Эта опция позволяет сообщать о дочерних процессах, если они были возобновлены после остановки управления заданием с момента последнего сообщения их статуса.

Доступность: некоторые системы Unix.

Новое в версии 2.3.

os.WUNTRACED¶

Этот параметр заставляет сообщать о дочерних процессах, если они были остановлены, но их текущее состояние ещё не было сообщено с момента остановки.

Доступность: Unix.

Новое в версии 2.3.

Следующие функции принимают код состояния процесса, возвращаемый system(), wait() или waitpid(), в качестве параметра. Они могут использоваться для определения статуса процесса.

os.WCOREDUMP(status)¶

Возвращает True, если для процесса был создан дамп ядра, в противном случае возвращает False.

Доступность: Unix.

Новое в версии 2.3.

os.WIFCONTINUED(status)¶

Возвращает True, если процесс был продолжен после остановки управления заданиями, иначе возвращает False.

Доступность: Unix.

Новое в версии 2.3.

os.WIFSTOPPED(status)¶

Возвращает True, если процесс был остановлен, иначе возвращает False.

Доступность: Unix.

os.WIFSIGNALED(status)¶

Возвращает True, если процесс завершился из-за сигнала, иначе возвращает False.

Доступность: Unix.

os.WIFEXITED(status)¶

Возвращает True, если процесс завершился с помощью системного вызова exit(2), иначе возвращает False.

Доступность: Unix.

os.WEXITSTATUS(status)¶

Если WIFEXITED(status) истинно, возвращает целочисленный параметр системного вызова exit(2). В противном случае возвращаемое значение не имеет смысла.

Доступность: Unix.

os.WSTOPSIG(status)¶

Возвращает сигнал, который вызвал остановку процесса.

Доступность: Unix.

os.WTERMSIG(status)¶

Возвращает сигнал, который вызвал завершение процесса.

Доступность: Unix.

15.1.6. Разные сведения о системе¶Miscellaneous System Information

os.confstr(name)¶

Возвращает строковые значения системной конфигурации. name задаёт извлекаемое значение; это может быть строка – имя определённого системного значения; такие имена заданы в ряде стандартов (POSIX, Unix 95, Unix 98 и других). На некоторых платформах определены и дополнительные имена. Имена, известные хост-операционной системе, представлены в виде ключей словаря confstr_names. Для тех переменных конфигурации, которых нет в этом отображении, также допускается передавать целое число в качестве name.

Если значение конфигурации, указанное name, не определено, возвращается None.

Если name – строка и не известна, возбуждается исключение ValueError. Если конкретное значение для name не поддерживается хост-системой, даже если оно присутствует в confstr_names, возбуждается исключение OSError с errno.EINVAL в качестве кода ошибки.

Доступность: Unix

os.confstr_names¶

Словарь, отображающий имена, принимаемые confstr(), в целочисленные значения, определённые для этих имён хост-операционной системой. Может использоваться для определения набора имён, известных системе.

Доступность: Unix.

os.getloadavg()¶

Возвращает количество процессов в очереди выполнения системы, усреднённое за последние 1, 5 и 15 минут, или возбуждает исключение OSError, если среднюю нагрузку получить не удалось.

Доступность: Unix.

Новое в версии 2.3.

os.sysconf(name)¶

Возвращает целочисленные значения системной конфигурации. Если значение конфигурации, указанное name, не определено, возвращается -1. Замечания относительно параметра name для confstr() применимы и здесь; словарь, предоставляющий информацию об известных именах, задаётся sysconf_names.

Доступность: Unix.

os.sysconf_names¶

Словарь, отображающий имена, принимаемые sysconf(), в целочисленные значения, определённые для этих имён хост-операционной системой. Может использоваться для определения набора имён, известных системе.

Доступность: Unix.

Следующие значения данных используются для поддержки операций с путями. Они определены для всех платформ.

Операции более высокого уровня с именами путей определены в модуле os.path.

os.curdir¶

Строковая константа, используемая операционной системой для обращения к текущему каталогу. Для Windows и POSIX это '.'. Также доступна через os.path.

os.pardir¶

Строковая константа, используемая операционной системой для обращения к родительскому каталогу. Для Windows и POSIX это '..'. Также доступна через os.path.

os.sep¶

Символ, используемый операционной системой для разделения компонентов пути. Для POSIX это '/', а для Windows – '\\'. Имейте в виду, что одного знания этого символа недостаточно для разбора или объединения путей – используйте os.path.split() и os.path.join(), – но иногда это бывает полезно. Также доступен через os.path.

os.altsep¶

Альтернативный символ, используемый операционной системой для разделения компонентов пути, или None, если существует только один символ-разделитель. В Windows, где sep – обратная косая черта, этот символ равен '/'. Также доступен через os.path.

os.extsep¶

Символ, отделяющий основное имя файла от расширения; например, '.' в os.py. Также доступен через os.path.

Новое в версии 2.2.

os.pathsep¶

Символ, традиционно используемый операционной системой для разделения компонентов пути поиска (как в PATH), например ':' для POSIX или ';' для Windows. Также доступен через os.path.

os.defpath¶

Путь поиска по умолчанию, используемый exec*p* и spawn*p*, если в окружении нет ключа 'PATH'. Также доступен через os.path.

os.linesep¶

Строка, используемая для разделения (вернее, завершения) строк на текущей платформе. Это может быть один символ, например '\n' для POSIX, или несколько символов, например '\r\n' для Windows. Не используйте os.linesep в качестве символа конца строки при записи файлов, открытых в текстовом режиме (по умолчанию); вместо этого используйте одиночный '\n' на всех платформах.

os.devnull¶

Путь к нулевому устройству. Например: '/dev/null' для POSIX, 'nul' для Windows. Также доступен через os.path.

Новое в версии 2.4.

15.1.7. Разные функции¶Miscellaneous Functions

os.urandom(n)¶

Возвращает строку из n случайных байтов, пригодных для криптографического использования.

Эта функция возвращает случайные байты из источника случайности, специфичного для ОС. Возвращаемые данные должны быть достаточно непредсказуемыми для криптографических приложений, хотя их точное качество зависит от реализации ОС. В UNIX-подобных системах она обращается к /dev/urandom, а в Windows использует CryptGenRandom(). Если источник случайности не найден, возбуждается NotImplementedError.

Для удобного интерфейса к генератору случайных чисел, предоставляемому платформой, обратитесь к random.SystemRandom.

Новое в версии 2.4.