certbot.compat.os module

此compat模塊是核心os模塊的包裝，該模塊禁止使用對Certbot的Windows文件安全性模型有害的特定操作（例如chown，chmod，getuid）。該模塊旨在替換整個certbot項目中的標準os模塊（acme除外）。

isort：跳過文件

certbot.compat.os.``chmod（* unused_args，* unused_kwargs）[資源]
禁止使用os.chmod（）方法

certbot.compat.os.``umask（* unused_args，* unused_kwargs）[資源]
禁止使用os.chmod（）方法

certbot.compat.os.``chown（* unused_args，* unused_kwargs）[資源]
禁止使用os.chown（）方法

certbot.compat.os.``open（* unused_args，* unused_kwargs）[資源]
禁止使用os.open（）方法

certbot.compat.os.``mkdir（* unused_args，* unused_kwargs）[資源]
禁止使用os.mkdir（）方法

certbot.compat.os.``makedirs（* unused_args，* unused_kwargs）[資源]
禁止使用方法os.makedirs（）

certbot.compat.os.``rename（* unused_args，* unused_kwargs）[資源]
禁止使用方法os.rename（）

certbot.compat.os.``access（* unused_args，* unused_kwargs）[資源]
禁止使用os.access（）方法

certbot.compat.os.``stat（* unused_args，* unused_kwargs）[資源]
禁止使用os.stat（）方法

certbot.compat.os.``fstat（* unused_args，* unused_kwargs）[資源]
禁止使用os.stat（）方法

certbot.compat.os.``WCOREDUMP（狀態） →布爾
如果將返回“狀態”的進程轉儲到核心文件，則返回True。

certbot.compat.os.``WEXITSTATUS（狀態） →整數
從“狀態”返回流程返回碼。

certbot.compat.os.``WIFCONTINUED（狀態） →布爾
如果從作業控制停止繼續返回“狀態”的過程，則返回True。

certbot.compat.os.``WIFEXITED（狀態） →布爾
如果使用exit（）系統調用退出了返回“狀態”的進程，則返回true。

certbot.compat.os.``WIFSIGNALED（狀態） →布爾
如果返回“狀態”的進程被信號終止，則返回True。

certbot.compat.os.``WIFSTOPPED（狀態） →布爾
如果返回“狀態”的進程已停止，則返回True。

certbot.compat.os.``WSTOPSIG（狀態） →整數
返回停止提供“狀態”值的過程的信號。

certbot.compat.os.``WTERMSIG（狀態） →整數
返回終止提供“狀態”值的過程的信號。

certbot.compat.os.``abort（） →不返回！
立即中止翻譯。此“轉儲核心”或以其他方式在托管操作系統上以最困難的方式失敗。

certbot.compat.os.``chdir（路徑）
將當前工作目錄更改為指定的路徑。

certbot.compat.os.``chroot（路徑）
將根目錄更改為path。

certbot.compat.os.``close（*fd *）
關閉文件描述符（用于低級別的IO）。

certbot.compat.os.``closerange（fd_low，*fd_high *）
關閉[fd_low，fd_high）中的所有文件描述符，忽略錯誤。

certbot.compat.os.``confstr（名稱） →字符串
返回字符串值的系統配置變量。

certbot.compat.os.``ctermid（） →字符串
返回此過程的控制終端的名稱。

certbot.compat.os.``dup（*fd *） →fd2
返回文件描述符的副本。

certbot.compat.os.``dup2（old_fd，*new_fd *）
重復的文件描述符。

certbot.compat.os.``error
的別名 exceptions.OSError

certbot.compat.os.``execv（path，*args *）
執行帶有參數的可執行路徑，替換當前進程。
path：可執行文件的路徑args：元組或字符串列表

certbot.compat.os.``execve（path，args，*env *）
使用參數和環境執行路徑，替換當前進程。
path：可執行文件的路徑args：元組或參數列表env：映射到字符串的字符串字典

certbot.compat.os.``fchdir（*fildes *）
轉到給定文件描述符的目錄。fildes必須在目錄而非文件上打開。

certbot.compat.os.``fchmod（fd，模式）
更改文件描述符fd給定的文件訪問權限。

certbot.compat.os.``fchown（fd，uid，*gid *）
將文件描述符fd給定的文件的所有者和組ID更改為數字uid和gid。

certbot.compat.os.``fdatasync（*fildes *）
強制使用filedescriptor將文件寫入磁盤。
不會強制更新元數據。

certbot.compat.os.``fdopen（fd[，mode =’r’[，bufsize]]） →file_object
返回連接到文件描述符的打開文件對象。

certbot.compat.os.``fork（） →pid
分叉子進程。返回0到子進程，返回子進程的PID到父進程。

certbot.compat.os.``forkpty（）->（pid，*master_fd *）
用新的偽終端作為控制tty的新過程。
像fork（）一樣，將0作為pid返回給子進程，并將子PID返回給父進程。兩者都返回新打開的偽終端的fd。

certbot.compat.os.``fpathconf（fd，*name *） →整數
返回文件描述符fd的配置限制名稱。如果沒有限制，則返回-1。

certbot.compat.os.``fstatvfs（*fd *） →statvfs結果
在給定的fd上執行fstatvfs系統調用。

certbot.compat.os.``fsync（*fildes *）
強制使用filedescriptor將文件寫入磁盤。

certbot.compat.os.``ftruncate（fd，長度）
將文件截斷為指定的長度。

certbot.compat.os.``getcwd（） →路徑
返回代表當前工作目錄的字符串。

certbot.compat.os.``getcwdu（） →路徑
返回表示當前工作目錄的unicode字符串。

certbot.compat.os.``getegid（） → egid
返回當前進程的有效組ID。

certbot.compat.os.``geteuid（） →euid
返回當前進程的有效用戶標識。

certbot.compat.os.``getgid（） →gid
返回當前進程的組ID。

certbot.compat.os.``getgroups（） → list of group IDs
返回該過程的補充組ID列表。

certbot.compat.os.``getloadavg（）->（float，float，*float *）
返回系統運行隊列中最近1、5和15分鐘內平均的進程數，如果無法獲得平均負載，則返回OSError

certbot.compat.os.``getlogin（） →字符串
返回實際的登錄名。

certbot.compat.os.``getpgid（*pid *） →pgid
調用系統調用getpgid（）。

certbot.compat.os.``getpgrp（） →pgrp
返回當前的進程組ID。

certbot.compat.os.``getpid（） →pid
返回當前進程ID

certbot.compat.os.``getppid（） →ppid
返回父進程的ID。

certbot.compat.os.``getresgid（）->（rgid，egid，*sgid *）
獲取當前進程的真實，有效和已保存組ID的元組。

certbot.compat.os.``getresuid（）->（ruid，euid，*suid *）
獲取當前進程的真實，有效和已保存用戶ID的元組。

certbot.compat.os.``getsid（*pid *） →sid
調用系統調用getsid（）。

certbot.compat.os.``getuid（） →uid
返回當前進程的用戶標識。

certbot.compat.os.``initgroups（用戶名，*gid *） →無
調用系統initgroups（）初始化組訪問列表，其中包含指定用戶名所屬的所有組以及指定的組ID。

certbot.compat.os.``isatty（*fd *） →布爾
如果文件描述符“ fd”是連接到終端從屬端的打開文件描述符，則返回True。

certbot.compat.os.``kill（pid，*sig *）
用信號殺死進程。

certbot.compat.os.``killpg（pgid，*sig *）
用信號殺死進程組。

certbot.compat.os.``lchown（path，uid，*gid *）
將路徑的所有者和組標識更改為數字uid和gid。此功能將不遵循符號鏈接。

certbot.compat.os.``link（src，*dst *）
創建到文件的硬鏈接。

certbot.compat.os.``listdir（path） →list_of_strings
返回一個列表，其中包含目錄中條目的名稱。
path：要列出的目錄的路徑
該列表是任意順序的。它不包括特殊條目“。” 和“ ..”，即使它們存在于目錄中。

certbot.compat.os.``lseek（fd，pos，*how *） →newpos
設置文件描述符的當前位置。從頭開始以字節為單位返回新的光標位置。

certbot.compat.os.``lstat(path) → stat result
類似于stat（path），但不要遵循符號鏈接。

certbot.compat.os.``major(device) → major number
從原始設備編號中提取設備主編號。

certbot.compat.os.makedev(major, minor) → device number
由主設備號和次設備號組成一個原始設備號。

certbot.compat.os.``minor(device) → minor number
從原始設備號中提取設備次設備號。

certbot.compat.os.``mkfifo(filename[, mode=0666])
創建一個FIFO（一個POSIX命名管道）。

certbot.compat.os.``mknod(filename[, mode=0600, device])
創建一個名為filename的文件系統節點（文件，設備專用文件或命名管道）。模式指定使用權限和要創建的節點類型，并與S_IFREG，S_IFCHR，S_IFBLK和S_IFIFO中的一個進行組合（按位或）。對于S_IFCHR和S_IFBLK，設備定義了新創建的設備專用文件（可能使用os.makedev（）），否則將被忽略。

certbot.compat.os.``nice（*inc *） →new_priority
通過inc降低進程的優先級，然后返回新的優先級。

certbot.compat.os.``openpty（）->（master_fd，*slave_fd *）
打開一個偽終端，返回主端和從端的開放fd。

certbot.compat.os.``pathconf（路徑，名稱） →整數
返回文件或目錄路徑的配置限制名稱。如果沒有限制，則返回-1。

certbot.compat.os.``pipe（）->（read_end，*write_end *）
創建一個管道。

certbot.compat.os.``popen（命令[，mode =’r’[，bufsize]]） →管道
打開/返回命令返回文件對象的管道。

certbot.compat.os.``putenv（鍵，值）
更改或添加環境變量。

certbot.compat.os.``read（fd，*buffersize *） →字符串
讀取文件描述符。

certbot.compat.os.``readlink（路徑） →路徑
返回表示符號鏈接指向的路徑的字符串。

certbot.compat.os.``remove（路徑）
刪除文件（與unlink（path）相同）。

certbot.compat.os.``rmdir（路徑）
刪除目錄。

certbot.compat.os.``setegid（*gid *）
設置當前進程的有效組ID。

certbot.compat.os.``seteuid（*uid *）
設置當前進程的有效用戶ID。

certbot.compat.os.``setgid（*gid *）
設置當前進程的組ID。

certbot.compat.os.``setgroups（清單）
將當前進程的組設置為列出。

certbot.compat.os.``setpgid（pid，*pgrp *）
調用系統調用setpgid（）。

certbot.compat.os.``setpgrp（）
使該過程成為過程組負責人。

certbot.compat.os.``setregid（rgid，*egid *）
設置當前進程的真實和有效的組ID。

certbot.compat.os.``setresgid（rgid，egid，*sgid *）
設置當前進程的真實，有效和已保存的組ID。

certbot.compat.os.``setresuid（ruid，euid，*suid *）
設置當前進程的真實，有效和已保存的用戶ID。

certbot.compat.os.``setreuid（ruid，*euid *）
設置當前進程的真實有效用戶ID。

certbot.compat.os.``setsid（）
調用系統調用setid（）。

certbot.compat.os.``setuid（*uid *）
設置當前進程的用戶標識。

certbot.compat.os.``stat_float_times（[紐瓦]） →舊的
確定os。[lf] stat是否將時間戳表示為浮點對象。如果newval為True，則將來對stat（）的調用將返回浮點數；如果為False，則未來的調用將返回int。如果省略newval，則返回當前設置。

classcertbot.compat.os.``stat_result
Bases： object
stat_result：stat或lstat的結果。
該對象可以作為一個元組訪問
（mode，ino，dev，nlink，uid，gid，size，atime，mtime，ctime）
或通過屬性st_mode，st_ino，st_dev，st_nlink，st_uid等。
Posix / windows：如果您的平臺支持st_blksize，st_blocks，st_rdev或st_flags，則它們僅可用作屬性。

n_fields= 16

n_sequence_fields= 10

n_unnamed_fields= 3

st_atime

最后訪問時間

st_blksize

文件系統I / O的塊大小

st_blocks

分配的塊數

st_ctime

最后更改時間

st_dev

設備

st_gid

所有者的組ID

st_ino

索引節點

st_mode

保護位

st_mtime

最后修改時間

st_nlink

硬鏈接數

st_rdev

設備類型（如果是inode設備）

st_size

總大小（以字節為單位）

st_uid

所有者的用戶標識

certbot.compat.os.``statvfs（路徑） →statvfs結果
在給定路徑上執行statvfs系統調用。

classcertbot.compat.os.``statvfs_result
Bases： object
statvfs_result：statvfs或fstatvfs的結果。
該對象可以作為一個元組訪問
（bsize，frsize，b;ocks，bfree，bavail，文件，ffree，favail，flag，namemax），
或通過屬性f_bsize，f_frsize，f_blocks，f_bfree等。

f_bavail

f_bfree

f_blocks

f_bsize

f_favail

f_ffree

f_files

f_flag

f_frsize

f_namemax

n_fields= 10

n_sequence_fields= 10

n_unnamed_fields= 0

certbot.compat.os.``strerror（code） →string
將錯誤代碼轉換為消息字符串。

certbot.compat.os.``symlink（src，*dst *）
創建一個指向drc的src的符號鏈接。

certbot.compat.os.``sysconf(name) → integer
返回整數值的系統配置變量。

certbot.compat.os.``system（命令） →exit_status
在子外殼程序中執行命令（字符串）。

certbot.compat.os.``tcgetpgrp（*fd *） →pgid
返回與fd給定的終端關聯的進程組。

certbot.compat.os.``tcsetpgrp（fd，*pgid *）
設置與fd給定的終端關聯的進程組。

certbot.compat.os.``tempnam（[目錄[，前綴]]） →字串
返回一個臨時文件的唯一名稱。目錄和前綴可以指定為字符串。可以將其省略，或者如果不需要則為None。

certbot.compat.os.times（）->（utime，stime，cutime，cstime，*elapsed_time *）
返回表示處理時間的浮點數元組。

certbot.compat.os.tmpfile（） →file object
創建一個沒有目錄條目的臨時文件。

certbot.compat.os.``tmpnam（） →string
返回一個臨時文件的唯一名稱。

certbot.compat.os.ttyname（*fd *） →string
返回連接到“ fd”的終端設備的名稱。

certbot.compat.os.uname（*） →(sysname, nodename, release, version, machine)
返回一個標識當前操作系統的元組。

certbot.compat.os.unlink（pzth）
刪除文件（與remove（path）相同）。

certbot.compat.os.unsetenv（key）
刪除環境變量。

certbot.compat.os.urandom（*n *） →str
返回n個適合加密使用的隨機字節。

certbot.compat.os.``utime（path，（atime，mtime））
utime（path，None）
將文件的訪問時間和修改時間設置為給定值。如果使用第二種形式，請將訪問時間和修改時間設置為當前時間。

certbot.compat.os.wait（）->（pid，status）
等待子進程完成。

certbot.compat.os.wait3（option）->（pid，status，*rusage *）
等待子進程完成。

certbot.compat.os.wait4（pid，option）->（pid，status，*rusage *）
等待給定的子進程完成。

certbot.compat.os.waitpid（pid，option）->（pid，*status *）
等待給定的子進程完成。

certbot.compat.os.write（fd，string） →byteswritten
將字符串寫入文件描述符。

certbot.compat.os.removedirs（path）[資源]
Super-rmdir; 刪除葉子目錄和所有空的中間目錄。像rmdir一樣工作，不同之處在于，如果成功刪除了葉目錄，將刪除最右邊路徑段所對應的目錄，直到使用完整個路徑或發生錯誤為止。在后面的階段中的錯誤將被忽略-它們通常表示目錄不為空。

certbot.compat.os.``renames（old，new）[資源]
Super-rename根據需要創建目錄，并刪除任何留空的目錄。像重命名一樣工作，除了首先嘗試創建使新路徑名良好所需的任何中間目錄。重命名后，將修剪與舊名稱的最右邊路徑段相對應的目錄，直到使用完整個路徑或找到非空目錄為止。
注意：如果您缺少取消葉子目錄或文件的鏈接所需的權限，則使用新的目錄結構時此功能可能會失敗。

certbot.compat.os.walk（top，topdown = True，onerror = None，*followlinks = False *）[資源]
目錄樹生成器。
對于根于頂部的目錄樹中的每個目錄（包括頂部本身，但不包括“。”和“ ..”），將生成一個三元組
目錄路徑，目錄名，文件名
dirpath是一個字符串，是目錄的路徑。dirnames是dirpath中子目錄名稱的列表（不包括“。”和“ ..”）。filenames是dirpath中非目錄文件名稱的列表。請注意，列表中的名稱只是名稱，沒有路徑成分。要獲取目錄路徑中文件或目錄的完整路徑（從頂部開始），請執行os.path.join（dirpath，name）。
如果可選arg’topdown’為true或未指定，則在其任何子目錄的三元組之前生成目錄的三元組（目錄是自上而下生成的）。如果topdown為false，則在其所有子目錄的三元組之后生成目錄的三元組（目錄自下而上生成）。
當topdown為true時，調用者可以就地修改目錄名列表（例如，通過del或slice分配），而walk僅會遞歸到名稱保留在目錄名中的子目錄中；這可以用于修剪搜索或強加特定的訪問順序。當topdown為false時修改目錄名無效，因為目錄名本身生成時已經生成了目錄名中的目錄。無論topdown的值如何，都將在生成目錄及其子目錄的元組之前檢索子目錄的列表。
默認情況下，忽略os.listdir（）調用中的錯誤。如果指定了可選的arg’onerror’，則它應該是一個函數；它將使用一個參數os.error實例進行調用。它可以報告錯誤以繼續進行遍歷，或者引發異常以中止遍歷。請注意，文件名可用作異常對象的文件名屬性。
缺省情況下，os.walk在支持它們的系統上不跟隨指向子目錄的符號鏈接。為了獲得此功能，請將可選參數’followlinks’設置為true。
注意：如果您為top傳遞了相對路徑名，請不要在恢復行走之間更改當前的工作目錄。walk永遠不會更改當前目錄，并假定客戶端也不會更改當前目錄。
例：
從os.path導入os導入連接，獲取root，dirs，os.walk中文件的大小（’python / Lib / email’）：
打印根目錄，“ consums”，打印總和（[getsize（join（root（根目錄，名稱）），表示文件名]]），如果dir中的“ CVS”，則打印“ bytes in”，len（files），“ non-directory files” ：

dirs.remove（’CVS’）＃不要訪問CVS目錄

certbot.compat.os.execl（file，** args *）[資源]
使用參數列表args執行可執行文件，替換當前進程。

certbot.compat.os.execle（file，* args，*env *）[資源]
使用參數列表args和環境env執行可執行文件，替換當前進程。

certbot.compat.os.execlp（file，** args *）[資源]
使用參數列表args執行可執行文件（沿著$ PATH搜索），替換當前進程。

certbot.compat.os.execlpe（file，* args，*env *）[資源]
使用參數列表args和環境env執行可執行文件（沿著$ PATH搜索），替換當前進程。

certbot.compat.os.execvp（file，*args *）[資源]
使用參數列表args執行可執行文件（沿著$ PATH搜索），替換當前進程。args可以是字符串列表或元組。

certbot.compat.os.execvpe（file，args，*env *）[資源]
使用參數列表args和環境env執行可執行文件（沿著$ PATH搜索），替換當前進程。args可以是字符串列表或元組。

certbot.compat.os.getenv（key，*default= None *）[資源]
獲取一個環境變量，如果不存在則返回None。可選的第二個參數可以指定備用默認值。

certbot.compat.os.spawnv(mode, file, args) → integer[資源]
使用子過程中args的參數執行文件。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnve（mode，file，args，*env *） →integer[資源]
在指定環境的子進程中使用args中的參數執行文件。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnl(mode, file, args) → integer[資源]
使用子過程中args的參數執行文件。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnle（mode，文件，* args，*env *） →integer[資源]
在提供的環境中，使用子過程中args的參數執行文件。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnvp(mode, file, *args) → integer[資源]
使用子進程中args的參數執行文件（沿著$ PATH查找）。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnvpe（mode，file，args，*env *） →integer[資源]
在提供的環境的子進程中，使用args的參數執行文件（沿著$ PATH查找）。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnlp(mode, file, *args, env) → integer[資源]
在提供的環境的子進程中，使用args的參數執行文件（沿著$ PATH查找）。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.spawnlpe(mode, file, *args, env) → integer[資源]
在提供的環境的子進程中，使用args的參數執行文件（沿著$ PATH查找）。如果mode == P_NOWAIT，則返回進程的pid。如果mode == P_WAIT如果正常退出，則返回該進程的退出代碼；否則，返回0。否則返回-SIG，其中SIG是殺死它的信號。

certbot.compat.os.``popen2（cmd，mode =’t’，*bufsize = -1 *）[資源]
在子過程中執行shell命令“ cmd”。在UNIX上，“ cmd”可能是一個序列，在這種情況下，參數將直接傳遞給程序，而無需shell干預（例如os.spawnv（））。如果’cmd’是一個字符串，它將被傳遞給shell（與os.system（）一樣）。如果指定了’bufsize’，它將設置I / O管道的緩沖區大小。返回文件對象（child_stdin，child_stdout）。

certbot.compat.os.``popen3（cmd，mode =’t’，*bufsize = -1 *）[資源]
在子過程中執行shell命令“ cmd”。在UNIX上，“ cmd”可能是一個序列，在這種情況下，參數將直接傳遞給程序，而無需shell干預（例如os.spawnv（））。如果’cmd’是一個字符串，它將被傳遞給shell（與os.system（）一樣）。如果指定了’bufsize’，它將設置I / O管道的緩沖區大小。返回文件對象（child_stdin，child_stdout，child_stderr）。

certbot.compat.os.``popen4（cmd，mode =’t’，*bufsize = -1 *）[資源]
在子過程中執行shell命令“ cmd”。在UNIX上，“ cmd”可能是一個序列，在這種情況下，參數將直接傳遞給程序，而無需shell干預（例如os.spawnv（））。如果’cmd’是一個字符串，它將被傳遞給shell（與os.system（）一樣）。如果指定了’bufsize’，它將設置I / O管道的緩沖區大小。返回文件對象（child_stdin，child_stdout_stderr）。