# coding: utf-8 # AUTO-GENERATED FILE -- DO NOT EDIT """ This module provides access to operating system functionality that is standardized by the C Standard and the POSIX standard (a thinly disguised Unix interface). Refer to the library manual and corresponding Unix manual entries for more information on calls. """ class DirEntry(object): def inode(self): """ Return inode of the entry; cached per entry. """ pass def is_dir(self, follow_symlinks=True): """ Return True if the entry is a directory; cached per entry. """ pass def is_file(self, follow_symlinks=True): """ Return True if the entry is a file; cached per entry. """ pass def is_symlink(self): """ Return True if the entry is a symbolic link; cached per entry. """ pass name = None path = None def stat(self, follow_symlinks=True): """ Return stat_result object for the entry; cached per entry. """ pass F_OK = 0 O_APPEND = 8 O_BINARY = 32768 O_CREAT = 256 O_EXCL = 1024 O_NOINHERIT = 128 O_RANDOM = 16 O_RDONLY = 0 O_RDWR = 2 O_SEQUENTIAL = 32 O_SHORT_LIVED = 4096 O_TEMPORARY = 64 O_TEXT = 16384 O_TRUNC = 512 O_WRONLY = 1 P_DETACH = 4 P_NOWAIT = 1 P_NOWAITO = 3 P_OVERLAY = 2 P_WAIT = 0 R_OK = 4 TMP_MAX = 2147483647 W_OK = 2 X_OK = 1 _LOAD_LIBRARY_SEARCH_APPLICATION_DIR = 512 _LOAD_LIBRARY_SEARCH_DEFAULT_DIRS = 4096 _LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR = 256 _LOAD_LIBRARY_SEARCH_SYSTEM32 = 2048 _LOAD_LIBRARY_SEARCH_USER_DIRS = 1024 __doc__ = """This module provides access to operating system functionality that is standardized by the C Standard and the POSIX standard (a thinly disguised Unix interface). Refer to the library manual and corresponding Unix manual entries for more information on calls.""" class __loader__(object): """ Meta path import for built-in modules. All methods are either class or static methods to avoid the need to instantiate the class. """ _ORIGIN = 'built-in' def create_module(self, spec): """ Create a built-in module """ pass def exec_module(self, module): """ Exec a built-in module """ pass def find_module(self, fullname, path=None): """ Find the built-in module. If 'path' is ever specified then the search is considered a failure. This method is deprecated. Use find_spec() instead. """ pass def find_spec(self, fullname, path=None, target=None): pass def get_code(self, fullname): """ Return None as built-in modules do not have code objects. """ pass def get_source(self, fullname): """ Return None as built-in modules do not have source code. """ pass def is_package(self, fullname): """ Return False as built-in modules are never packages. """ pass def load_module(self, fullname): """ Load the specified module into sys.modules and return it. This method is deprecated. Use loader.exec_module instead. """ pass def module_repr(self, module): """ Return repr for the module. The method is deprecated. The import machinery does the job itself. """ pass __name__ = 'nt' __package__ = '' __spec__ = None def _add_dll_directory(path): """ Add a path to the DLL search path. This search path is used when resolving dependencies for imported extension modules (the module itself is resolved through sys.path), and also by ctypes. Returns an opaque value that may be passed to os.remove_dll_directory to remove this directory from the search path. """ pass def _exit(status): """ Exit to the system with specified status, without normal exit processing. """ pass def _getdiskusage(path): """ Return disk usage statistics about the given path as a (total, free) tuple. """ pass def _getfinalpathname(path): """ A helper function for samepath on windows. """ pass def _getfullpathname(path): pass def _getvolumepathname(path): """ A helper function for ismount on Win32. """ pass _have_functions = [] def _remove_dll_directory(cookie): """ Removes a path from the DLL search path. The parameter is an opaque value that was returned from os.add_dll_directory. You can only remove directories that you added yourself. """ pass def abort(): """ Abort the interpreter immediately. This function 'dumps core' or otherwise fails in the hardest way possible on the hosting operating system. This function never returns. """ pass def access(path, mode, dir_fd=None, effective_ids=False, follow_symlinks=True): """ Use the real uid/gid to test for access to a path. path Path to be tested; can be string, bytes, or a path-like object. mode Operating-system mode bitfield. Can be F_OK to test existence, or the inclusive-OR of R_OK, W_OK, and X_OK. dir_fd If not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. effective_ids If True, access will use the effective uid/gid instead of the real uid/gid. follow_symlinks If False, and the last element of the path is a symbolic link, access will examine the symbolic link itself instead of the file the link points to. dir_fd, effective_ids, and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. Note that most operations will use the effective uid/gid, therefore this routine can be used in a suid/sgid environment to test if the invoking user has the specified access to the path. """ pass def chdir(path): """ Change the current working directory to the specified path. path may always be specified as a string. On some platforms, path may also be specified as an open file descriptor. If this functionality is unavailable, using it raises an exception. """ pass def chmod(path, mode, dir_fd=None, follow_symlinks=True): """ Change the access permissions of a file. path Path to be modified. May always be specified as a str, bytes, or a path-like object. On some platforms, path may also be specified as an open file descriptor. If this functionality is unavailable, using it raises an exception. mode Operating-system mode bitfield. dir_fd If not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. follow_symlinks If False, and the last element of the path is a symbolic link, chmod will modify the symbolic link itself instead of the file the link points to. It is an error to use dir_fd or follow_symlinks when specifying path as an open file descriptor. dir_fd and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. """ pass def close(fd): """ Close a file descriptor. """ pass def closerange(fd_low, fd_high): """ Closes all file descriptors in [fd_low, fd_high), ignoring errors. """ pass def cpu_count(arg0): """ Return the number of CPUs in the system; return None if indeterminable. This number is not equivalent to the number of CPUs the current process can use. The number of usable CPUs can be obtained with ``len(os.sched_getaffinity(0))`` """ pass def device_encoding(fd): """ Return a string describing the encoding of a terminal's file descriptor. The file descriptor must be attached to a terminal. If the device is not a terminal, return None. """ pass def dup(fd): """ Return a duplicate of a file descriptor. """ pass def dup2(fd, fd2, inheritable=True): """ Duplicate file descriptor. """ pass environ = {} class error(Exception): """ Base class for I/O related errors. """ def __init__(self, *args, **kwargs): pass characters_written = property(None, None, None, ) errno = None filename = None filename2 = None strerror = None winerror = None def execv(path, argv): """ Execute an executable path with arguments, replacing current process. path Path of executable file. argv Tuple or list of strings. """ pass def execve(path, argv, env): """ Execute an executable path with arguments, replacing current process. path Path of executable file. argv Tuple or list of strings. env Dictionary of strings mapping to strings. """ pass def fspath(path): """ Return the file system path representation of the object. If the object is str or bytes, then allow it to pass through as-is. If the object defines __fspath__(), then return the result of that method. All other types raise a TypeError. """ pass def fstat(fd): """ Perform a stat system call on the given file descriptor. Like stat(), but for an open file descriptor. Equivalent to os.stat(fd). """ pass def fsync(fd): """ Force write of fd to disk. """ pass def ftruncate(fd, length): """ Truncate a file, specified by file descriptor, to a specific length. """ pass def get_handle_inheritable(handle): """ Get the close-on-exe flag of the specified file descriptor. """ pass def get_inheritable(fd): """ Get the close-on-exe flag of the specified file descriptor. """ pass def get_terminal_size(columns, lines): """ Return the size of the terminal window as (columns, lines). The optional argument fd (default standard output) specifies which file descriptor should be queried. If the file descriptor is not connected to a terminal, an OSError is thrown. This function will only be defined if an implementation is available for this system. shutil.get_terminal_size is the high-level function which should normally be used, os.get_terminal_size is the low-level implementation. """ pass def getcwd(): """ Return a unicode string representing the current working directory. """ pass def getcwdb(): """ Return a bytes string representing the current working directory. """ pass def getlogin(): """ Return the actual login name. """ pass def getpid(): """ Return the current process id. """ pass def getppid(arg0): """ Return the parent's process id. If the parent process has already exited, Windows machines will still return its id; others systems will return the id of the 'init' process (1). """ pass def isatty(fd): """ Return True if the fd is connected to a terminal. Return True if the file descriptor is an open file descriptor connected to the slave end of a terminal. """ pass def kill(pid, signal): """ Kill a process with a signal. """ pass def link(src, dst, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True): """ Create a hard link to a file. If either src_dir_fd or dst_dir_fd is not None, it should be a file descriptor open to a directory, and the respective path string (src or dst) should be relative; the path will then be relative to that directory. If follow_symlinks is False, and the last element of src is a symbolic link, link will create a link to the symbolic link itself instead of the file the link points to. src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. """ pass def listdir(path=None): """ Return a list containing the names of the files in the directory. path can be specified as either str, bytes, or a path-like object. If path is bytes, the filenames returned will also be bytes; in all other circumstances the filenames returned will be str. If path is None, uses the path='.'. On some platforms, path may also be specified as an open file descriptor;\\ the file descriptor must refer to a directory. If this functionality is unavailable, using it raises NotImplementedError. The list is in arbitrary order. It does not include the special entries '.' and '..' even if they are present in the directory. """ pass def lseek(fd, position, how): """ Set the position of a file descriptor. Return the new position. Return the new cursor position in number of bytes relative to the beginning of the file. """ pass def lstat(path, dir_fd=None): """ Perform a stat system call on the given path, without following symbolic links. Like stat(), but do not follow symbolic links. Equivalent to stat(path, follow_symlinks=False). """ pass def mkdir(path, mode=511, dir_fd=None): """ Create a directory. If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. The mode argument is ignored on Windows. """ pass def open(path, flags, mode=511, dir_fd=None): """ Open a file for low level IO. Returns a file descriptor (integer). If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def pipe(read_fd, write_fd): """ Create a pipe. Returns a tuple of two file descriptors: (read_fd, write_fd) """ pass def putenv(name, value): """ Change or add an environment variable. """ pass def read(fd, length): """ Read from a file descriptor. Returns a bytes object. """ pass def readlink(path, dir_fd=None): """ Return a string representing the path to which the symbolic link points. If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def remove(path, dir_fd=None): """ Remove a file (same as unlink()). If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def rename(src, dst, src_dir_fd=None, dst_dir_fd=None): """ Rename a file or directory. If either src_dir_fd or dst_dir_fd is not None, it should be a file descriptor open to a directory, and the respective path string (src or dst) should be relative; the path will then be relative to that directory. src_dir_fd and dst_dir_fd, may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. """ pass def replace(src, dst, src_dir_fd=None, dst_dir_fd=None): """ Rename a file or directory, overwriting the destination. If either src_dir_fd or dst_dir_fd is not None, it should be a file descriptor open to a directory, and the respective path string (src or dst) should be relative; the path will then be relative to that directory. src_dir_fd and dst_dir_fd, may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. """ pass def rmdir(path, dir_fd=None): """ Remove a directory. If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def scandir(path=None): """ Return an iterator of DirEntry objects for given path. path can be specified as either str, bytes, or a path-like object. If path is bytes, the names of yielded DirEntry objects will also be bytes; in all other circumstances they will be str. If path is None, uses the path='.'. """ pass def set_handle_inheritable(handle, inheritable): """ Set the inheritable flag of the specified handle. """ pass def set_inheritable(fd, inheritable): """ Set the inheritable flag of the specified file descriptor. """ pass def spawnv(mode, path, argv): """ Execute the program specified by path in a new process. mode Mode of process creation. path Path of executable file. argv Tuple or list of strings. """ pass def spawnve(mode, path, argv, env): """ Execute the program specified by path in a new process. mode Mode of process creation. path Path of executable file. argv Tuple or list of strings. env Dictionary of strings mapping to strings. """ pass def startfile(arg0): """ Start a file with its associated application. When "operation" is not specified or "open", this acts like double-clicking the file in Explorer, or giving the file name as an argument to the DOS "start" command: the file is opened with whatever application (if any) its extension is associated. When another "operation" is given, it specifies what should be done with the file. A typical operation is "print". startfile returns as soon as the associated application is launched. There is no option to wait for the application to close, and no way to retrieve the application's exit status. The filepath is relative to the current directory. If you want to use an absolute path, make sure the first character is not a slash ("/"); the underlying Win32 ShellExecute function doesn't work if it is. """ pass def stat(path, dir_fd=None, follow_symlinks=True): """ Perform a stat system call on the given path. path Path to be examined; can be string, bytes, a path-like object or open-file-descriptor int. dir_fd If not None, it should be a file descriptor open to a directory, and path should be a relative string; path will then be relative to that directory. follow_symlinks If False, and the last element of the path is a symbolic link, stat will examine the symbolic link itself instead of the file the link points to. dir_fd and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. It's an error to use dir_fd or follow_symlinks when specifying path as an open file descriptor. """ pass class stat_result(tuple): """ stat_result: Result from stat, fstat, or lstat. This object may be accessed either as a tuple of (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime) or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on. Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev, or st_flags, they are available as attributes only. See os.stat for more information. """ n_fields = 18 n_sequence_fields = 10 n_unnamed_fields = 3 st_atime = None st_atime_ns = None st_ctime = None st_ctime_ns = None st_dev = None st_file_attributes = None st_gid = None st_ino = None st_mode = None st_mtime = None st_mtime_ns = None st_nlink = None st_reparse_tag = None st_size = None st_uid = None class statvfs_result(tuple): """ statvfs_result: Result from statvfs or fstatvfs. This object may be accessed either as a tuple of (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax), or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on. See os.statvfs for more information. """ f_bavail = None f_bfree = None f_blocks = None f_bsize = None f_favail = None f_ffree = None f_files = None f_flag = None f_frsize = None f_fsid = None f_namemax = None n_fields = 11 n_sequence_fields = 10 n_unnamed_fields = 0 def strerror(code): """ Translate an error code to a message string. """ pass def symlink(src, dst, target_is_directory=False, dir_fd=None): """ Create a symbolic link pointing to src named dst. target_is_directory is required on Windows if the target is to be interpreted as a directory. (On Windows, symlink requires Windows 6.0 or greater, and raises a NotImplementedError otherwise.) target_is_directory is ignored on non-Windows platforms. If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def system(command): """ Execute the command in a subshell. """ pass class terminal_size(tuple): """ A tuple of (columns, lines) for holding terminal window size """ columns = None lines = None n_fields = 2 n_sequence_fields = 2 n_unnamed_fields = 0 def times(utime, stime, cutime, cstime, elapsed_time): """ Return a collection containing process timing information. The object returned behaves like a named tuple with these fields: (utime, stime, cutime, cstime, elapsed_time) All fields are floating point numbers. """ pass class times_result(tuple): """ times_result: Result from os.times(). This object may be accessed either as a tuple of (user, system, children_user, children_system, elapsed), or via the attributes user, system, children_user, children_system, and elapsed. See os.times for more information. """ children_system = None children_user = None elapsed = None n_fields = 5 n_sequence_fields = 5 n_unnamed_fields = 0 system = None user = None def truncate(path, length): """ Truncate a file, specified by path, to a specific length. On some platforms, path may also be specified as an open file descriptor. If this functionality is unavailable, using it raises an exception. """ pass def umask(mask): """ Set the current numeric umask and return the previous umask. """ pass class uname_result(tuple): """ uname_result: Result from os.uname(). This object may be accessed either as a tuple of (sysname, nodename, release, version, machine), or via the attributes sysname, nodename, release, version, and machine. See os.uname for more information. """ machine = None n_fields = 5 n_sequence_fields = 5 n_unnamed_fields = 0 nodename = None release = None sysname = None version = None def unlink(path, dir_fd=None): """ Remove a file (same as remove()). If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. dir_fd may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError. """ pass def unsetenv(name): """ Delete an environment variable. """ pass def urandom(size): """ Return a bytes object containing random bytes suitable for cryptographic use. """ pass def utime(atime, mtime): """ Set the access and modified time of path. path may always be specified as a string. On some platforms, path may also be specified as an open file descriptor. If this functionality is unavailable, using it raises an exception. If times is not None, it must be a tuple (atime, mtime); atime and mtime should be expressed as float seconds since the epoch. If ns is specified, it must be a tuple (atime_ns, mtime_ns); atime_ns and mtime_ns should be expressed as integer nanoseconds since the epoch. If times is None and ns is unspecified, utime uses the current time. Specifying tuples for both times and ns is an error. If dir_fd is not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory. If follow_symlinks is False, and the last element of the path is a symbolic link, utime will modify the symbolic link itself instead of the file the link points to. It is an error to use dir_fd or follow_symlinks when specifying path as an open file descriptor. dir_fd and follow_symlinks may not be available on your platform. If they are unavailable, using them will raise a NotImplementedError. """ pass def waitpid(pid, options): """ Wait for completion of a given process. Returns a tuple of information regarding the process: (pid, status << 8) The options argument is ignored on Windows. """ pass def waitstatus_to_exitcode(status): """ Convert a wait status to an exit code. On Unix: * If WIFEXITED(status) is true, return WEXITSTATUS(status). * If WIFSIGNALED(status) is true, return -WTERMSIG(status). * Otherwise, raise a ValueError. On Windows, return status shifted right by 8 bits. On Unix, if the process is being traced or if waitpid() was called with WUNTRACED option, the caller must first check if WIFSTOPPED(status) is true. This function must not be called if WIFSTOPPED(status) is true. """ pass def write(fd, data): """ Write a bytes object to a file descriptor. """ pass