os

package
v0.9.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const LLGoPackage = "py.os"

Variables

This section is empty.

Functions

func Abort added in v0.8.2 

func Abort() *py.Object

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.

func Access added in v0.8.2 

func Access(path *py.Object, mode *py.Object) *py.Object

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.

func Chdir added in v0.8.2 

func Chdir(path *py.Object) *py.Object

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.

func Chflags added in v0.8.2 

func Chflags(path *py.Object, flags *py.Object, followSymlinks *py.Object) *py.Object

Set file flags.

If follow_symlinks is False, and the last element of the path is a symbolic 

link, chflags will change flags on the symbolic link itself instead of the
file the link points to.

follow_symlinks may not be implemented on your platform. If it is unavailable, using it will raise a NotImplementedError.

func Chmod added in v0.8.2 

func Chmod(path *py.Object, mode *py.Object) *py.Object

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.
  Be careful when using number literals for *mode*. The conventional UNIX notation for
  numeric modes uses an octal base, which needs to be indicated with a ``0o`` prefix in
  Python.
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.

func Chown added in v0.8.2 

func Chown(path *py.Object, uid *py.Object, gid *py.Object) *py.Object

Change the owner and group id of path to the numeric uid and gid.\ 

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 relative; 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.

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 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, chown 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.

func Chroot added in v0.8.2 

func Chroot(path *py.Object) *py.Object

Change root directory to path.

func Close added in v0.8.2 

func Close(fd *py.Object) *py.Object

Close a file descriptor.

func Closerange added in v0.8.2 

func Closerange(fdLow *py.Object, fdHigh *py.Object) *py.Object

Closes all file descriptors in [fd_low, fd_high), ignoring errors.

func Confstr added in v0.8.2 

func Confstr(name *py.Object) *py.Object

Return a string-valued system configuration variable.

func CpuCount added in v0.8.2 

func CpuCount() *py.Object

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))“

func Ctermid added in v0.8.2 

func Ctermid() *py.Object

Return the name of the controlling terminal for this process.

func DeviceEncoding added in v0.8.2 

func DeviceEncoding(fd *py.Object) *py.Object

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.

func Dup added in v0.8.2 

func Dup(fd *py.Object) *py.Object

Return a duplicate of a file descriptor.

func Dup2 added in v0.8.2 

func Dup2(fd *py.Object, fd2 *py.Object, inheritable *py.Object) *py.Object

Duplicate file descriptor.

func Execl added in v0.8.2 

func Execl(file *py.Object, __llgo_va_list ...interface{}) *py.Object

execl(file, *args) 

Execute the executable file with argument list args, replacing the
current process.

func Execle added in v0.8.2 

func Execle(file *py.Object, __llgo_va_list ...interface{}) *py.Object

execle(file, *args, env) 

Execute the executable file with argument list args and
environment env, replacing the current process.

func Execlp added in v0.8.2 

func Execlp(file *py.Object, __llgo_va_list ...interface{}) *py.Object

execlp(file, *args) 

Execute the executable file (which is searched for along $PATH)
with argument list args, replacing the current process.

func Execlpe added in v0.8.2 

func Execlpe(file *py.Object, __llgo_va_list ...interface{}) *py.Object

execlpe(file, *args, env) 

Execute the executable file (which is searched for along $PATH)
with argument list args and environment env, replacing the current
process.

func Execv added in v0.8.2 

func Execv(path *py.Object, argv *py.Object) *py.Object

Execute an executable path with arguments, replacing current process. 

path
  Path of executable file.
argv
  Tuple or list of strings.

func Execve added in v0.8.2 

func Execve(path *py.Object, argv *py.Object, env *py.Object) *py.Object

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.

func Execvp added in v0.8.2 

func Execvp(file *py.Object, args *py.Object) *py.Object

execvp(file, args) 

Execute the executable file (which is searched for along $PATH)
with argument list args, replacing the current process.
args may be a list or tuple of strings.

func Execvpe added in v0.8.2 

func Execvpe(file *py.Object, args *py.Object, env *py.Object) *py.Object

execvpe(file, args, env) 

Execute the executable file (which is searched for along $PATH)
with argument list args and environment env, replacing the
current process.
args may be a list or tuple of strings.

func Fchdir added in v0.8.2 

func Fchdir(fd *py.Object) *py.Object

Change to the directory of the given file descriptor.

fd must be opened on a directory, not a file. Equivalent to os.chdir(fd).

func Fchmod added in v0.8.2 

func Fchmod(fd *py.Object, mode *py.Object) *py.Object

Change the access permissions of the file given by file descriptor fd. 

fd
  The file descriptor of the file to be modified.
mode
  Operating-system mode bitfield.
  Be careful when using number literals for *mode*. The conventional UNIX notation for
  numeric modes uses an octal base, which needs to be indicated with a ``0o`` prefix in
  Python.

Equivalent to os.chmod(fd, mode).

func Fchown added in v0.8.2 

func Fchown(fd *py.Object, uid *py.Object, gid *py.Object) *py.Object

Change the owner and group id of the file specified by file descriptor.

Equivalent to os.chown(fd, uid, gid).

func Fork added in v0.8.2 

func Fork() *py.Object

Fork a child process.

Return 0 to child process and PID of child to parent process.

func Forkpty added in v0.8.2 

func Forkpty() *py.Object

Fork a new process with a new pseudo-terminal as controlling tty.

Returns a tuple of (pid, master_fd). Like fork(), return pid of 0 to the child process, and pid of child to the parent process. To both, return fd of newly opened pseudo-terminal.

func Fpathconf added in v0.8.2 

func Fpathconf(fd *py.Object, name *py.Object) *py.Object

Return the configuration limit name for the file descriptor fd.

If there is no limit, return -1.

func Fsdecode added in v0.8.2 

func Fsdecode(filename *py.Object) *py.Object

Decode filename (an os.PathLike, bytes, or str) from the filesystem 

encoding with 'surrogateescape' error handler, return str unchanged. On
Windows, use 'strict' error handler if the file system encoding is
'mbcs' (which is the default encoding).

func Fsencode added in v0.8.2 

func Fsencode(filename *py.Object) *py.Object

Encode filename (an os.PathLike, bytes, or str) to the filesystem 

encoding with 'surrogateescape' error handler, return bytes unchanged.
On Windows, use 'strict' error handler if the file system encoding is
'mbcs' (which is the default encoding).

func Fspath added in v0.8.2 

func Fspath(path *py.Object) *py.Object

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.

func Fstat added in v0.8.2 

func Fstat(fd *py.Object) *py.Object

Perform a stat system call on the given file descriptor.

Like stat(), but for an open file descriptor. Equivalent to os.stat(fd).

func Fstatvfs added in v0.8.2 

func Fstatvfs(fd *py.Object) *py.Object

Perform an fstatvfs system call on the given fd.

Equivalent to statvfs(fd).

func Fsync added in v0.8.2 

func Fsync(fd *py.Object) *py.Object

Force write of fd to disk.

func Ftruncate added in v0.8.2 

func Ftruncate(fd *py.Object, length *py.Object) *py.Object

Truncate a file, specified by file descriptor, to a specific length.

func Fwalk added in v0.8.2 

func Fwalk(top *py.Object, topdown *py.Object, onerror *py.Object) *py.Object

Directory tree generator. 

This behaves exactly like walk(), except that it yields a 4-tuple

    dirpath, dirnames, filenames, dirfd

`dirpath`, `dirnames` and `filenames` are identical to walk() output,
and `dirfd` is a file descriptor referring to the directory `dirpath`.

The advantage of fwalk() over walk() is that it's safe against symlink
races (when follow_symlinks is False).

If dir_fd is not None, it should be a file descriptor open to a directory,
  and top should be relative; top will then be relative to that directory.
  (dir_fd is always supported for fwalk.)

Caution:
Since fwalk() yields file descriptors, those are only valid until the
next iteration step, so you should dup() them if you want to keep them
for a longer period.

Example:

import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
    print(root, "consumes", end="")
    print(sum(os.stat(name, dir_fd=rootfd).st_size for name in files),
          end="")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

func GetBlocking added in v0.8.2 

func GetBlocking(fd *py.Object) *py.Object

Get the blocking mode of the file descriptor.

Return False if the O_NONBLOCK flag is set, True if the flag is cleared.

func GetExecPath added in v0.8.2 

func GetExecPath(env *py.Object) *py.Object

Returns the sequence of directories that will be searched for the 

named executable (similar to a shell) when launching a process.

*env* must be an environment variable dict or None.  If *env* is None,
os.environ will be used.

func GetInheritable added in v0.8.2 

func GetInheritable(fd *py.Object) *py.Object

Get the close-on-exe flag of the specified file descriptor.

func Getcwd 

func Getcwd() *py.Object

Return a unicode string representing the current working directory.

func Getcwdb added in v0.8.2 

func Getcwdb() *py.Object

Return a bytes string representing the current working directory.

func Getegid added in v0.8.2 

func Getegid() *py.Object

Return the current process's effective group id.

func Getenv added in v0.8.2 

func Getenv(key *py.Object, default_ *py.Object) *py.Object

Get an environment variable, return None if it doesn't exist. 

The optional second argument can specify an alternate default.
key, default and the result are str.

func Getenvb added in v0.8.2 

func Getenvb(key *py.Object, default_ *py.Object) *py.Object

Get an environment variable, return None if it doesn't exist. 

The optional second argument can specify an alternate default.
key, default and the result are bytes.

func Geteuid added in v0.8.2 

func Geteuid() *py.Object

Return the current process's effective user id.

func Getgid added in v0.8.2 

func Getgid() *py.Object

Return the current process's group id.

func Getgrouplist added in v0.8.2 

func Getgrouplist(user *py.Object, group *py.Object) *py.Object

Returns a list of groups to which a user belongs. 

user
  username to lookup
group
  base group id of the user

func Getgroups added in v0.8.2 

func Getgroups() *py.Object

Return list of supplemental group IDs for the process.

func Getloadavg added in v0.8.2 

func Getloadavg() *py.Object

Return average recent system load information.

Return the number of processes in the system run queue averaged over the last 1, 5, and 15 minutes as a tuple of three floats. Raises OSError if the load average was unobtainable.

func Getlogin added in v0.8.2 

func Getlogin() *py.Object

Return the actual login name.

func Getpgid added in v0.8.2 

func Getpgid(pid *py.Object) *py.Object

Call the system call getpgid(), and return the result.

func Getpgrp added in v0.8.2 

func Getpgrp() *py.Object

Return the current process group id.

func Getpid added in v0.8.2 

func Getpid() *py.Object

Return the current process id.

func Getppid added in v0.8.2 

func Getppid() *py.Object

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

func Getpriority added in v0.8.2 

func Getpriority(which *py.Object, who *py.Object) *py.Object

Return program scheduling priority.

func Getsid added in v0.8.2 

func Getsid(pid *py.Object) *py.Object

Call the system call getsid(pid) and return the result.

func Getuid added in v0.8.2 

func Getuid() *py.Object

Return the current process's user id.

func Initgroups added in v0.8.2 

func Initgroups(username *py.Object, gid *py.Object) *py.Object

Initialize the group access list.

Call the system initgroups() to initialize the group access list with all of the groups of which the specified username is a member, plus the specified group id.

func Isatty added in v0.8.2 

func Isatty(fd *py.Object) *py.Object

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.

func Kill added in v0.8.2 

func Kill(pid *py.Object, signal *py.Object) *py.Object

Kill a process with a signal.

func Killpg added in v0.8.2 

func Killpg(pgid *py.Object, signal *py.Object) *py.Object

Kill a process group with a signal.

func Lchflags added in v0.8.2 

func Lchflags(path *py.Object, flags *py.Object) *py.Object

Set file flags.

This function will not follow symbolic links. Equivalent to chflags(path, flags, follow_symlinks=False).

func Lchmod added in v0.8.2 

func Lchmod(path *py.Object, mode *py.Object) *py.Object

Change the access permissions of a file, without following symbolic links.

If path is a symlink, this affects the link itself rather than the target. Equivalent to chmod(path, mode, follow_symlinks=False)."

func Lchown added in v0.8.2 

func Lchown(path *py.Object, uid *py.Object, gid *py.Object) *py.Object

Change the owner and group id of path to the numeric uid and gid.

This function will not follow symbolic links. Equivalent to os.chown(path, uid, gid, follow_symlinks=False). 

func Link(src *py.Object, dst *py.Object) *py.Object

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.

func Listdir added in v0.8.2 

func Listdir(path *py.Object) *py.Object

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.

func Lockf added in v0.8.2 

func Lockf(fd *py.Object, command *py.Object, length *py.Object) *py.Object

Apply, test or remove a POSIX lock on an open file descriptor. 

fd
  An open file descriptor.
command
  One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
length
  The number of bytes to lock, starting at the current position.

func LoginTty added in v0.8.2 

func LoginTty(fd *py.Object) *py.Object

Prepare the tty of which fd is a file descriptor for a new login session.

Make the calling process a session leader; make the tty the controlling tty, the stdin, the stdout, and the stderr of the calling process; close fd.

func Lseek added in v0.8.2 

func Lseek(fd *py.Object, position *py.Object, whence *py.Object) *py.Object

Set the position of a file descriptor. Return the new position. 

fd
  An open file descriptor, as returned by os.open().
position
  Position, interpreted relative to 'whence'.
whence
  The relative position to seek from. Valid values are:
  - SEEK_SET: seek from the start of the file.
  - SEEK_CUR: seek from the current file position.
  - SEEK_END: seek from the end of the file.

The return value is the number of bytes relative to the beginning of the file.

func Lstat added in v0.8.2 

func Lstat(path *py.Object) *py.Object

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

func Major added in v0.8.2 

func Major(device *py.Object) *py.Object

Extracts a device major number from a raw device number.

func Makedev added in v0.8.2 

func Makedev(major *py.Object, minor *py.Object) *py.Object

Composes a raw device number from the major and minor device numbers.

func Makedirs added in v0.8.2 

func Makedirs(name *py.Object, mode *py.Object, existOk *py.Object) *py.Object

makedirs(name [, mode=0o777][, exist_ok=False]) 

Super-mkdir; create a leaf directory and all intermediate ones.  Works like
mkdir, except that any intermediate path segment (not just the rightmost)
will be created if it does not exist. If the target directory already
exists, raise an OSError if exist_ok is False. Otherwise no exception is
raised.  This is recursive.

func Minor added in v0.8.2 

func Minor(device *py.Object) *py.Object

Extracts a device minor number from a raw device number.

func Mkdir added in v0.8.2 

func Mkdir(path *py.Object, mode *py.Object) *py.Object

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. Where it is used, the current umask value is first masked out.

func Mkfifo added in v0.8.2 

func Mkfifo(path *py.Object, mode *py.Object) *py.Object

Create a "fifo" (a POSIX named pipe).

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.

func Mknod added in v0.8.2 

func Mknod(path *py.Object, mode *py.Object, device *py.Object) *py.Object

Create a node in the file system.

Create a node in the file system (file, device special file or named pipe) at path. mode specifies both the permissions to use and the type of node to be created, being combined (bitwise OR) with one of S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode, device defines the newly created device special file (probably using os.makedev()). Otherwise device is ignored.

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.

func Nice added in v0.8.2 

func Nice(increment *py.Object) *py.Object

Add increment to the priority of process and return the new priority.

func Open added in v0.8.2 

func Open(path *py.Object, flags *py.Object, mode *py.Object) *py.Object

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.

func Openpty added in v0.8.2 

func Openpty() *py.Object

Open a pseudo-terminal.

Return a tuple of (master_fd, slave_fd) containing open file descriptors for both the master and slave ends.

func Pathconf added in v0.8.2 

func Pathconf(path *py.Object, name *py.Object) *py.Object

Return the configuration limit name for the file or directory path.

If there is no limit, return -1. On some platforms, path may also be specified as an open file descriptor. 

If this functionality is unavailable, using it raises an exception.

func Pipe added in v0.8.2 

func Pipe() *py.Object

Create a pipe.

Returns a tuple of two file descriptors: 

(read_fd, write_fd)

func Pread added in v0.8.2 

func Pread(fd *py.Object, length *py.Object, offset *py.Object) *py.Object

Read a number of bytes from a file descriptor starting at a particular offset.

Read length bytes from file descriptor fd, starting at offset bytes from the beginning of the file. The file offset remains unchanged.

func Preadv added in v0.8.2 

func Preadv(fd *py.Object, buffers *py.Object, offset *py.Object, flags *py.Object) *py.Object

Reads from a file descriptor into a number of mutable bytes-like objects.

Combines the functionality of readv() and pread(). As readv(), it will transfer data into each buffer until it is full and then move on to the next buffer in the sequence to hold the rest of the data. Its fourth argument, specifies the file offset at which the input operation is to be performed. It will return the total number of bytes read (which can be less than the total capacity of all the objects).

The flags argument contains a bitwise OR of zero or more of the following flags:

- RWF_HIPRI - RWF_NOWAIT

Using non-zero flags requires Linux 4.6 or newer.

func Putenv added in v0.8.2 

func Putenv(name *py.Object, value *py.Object) *py.Object

Change or add an environment variable.

func Pwrite added in v0.8.2 

func Pwrite(fd *py.Object, buffer *py.Object, offset *py.Object) *py.Object

Write bytes to a file descriptor starting at a particular offset.

Write buffer to fd, starting at offset bytes from the beginning of the file. Returns the number of bytes writte. Does not change the current file offset.

func Pwritev added in v0.8.2 

func Pwritev(fd *py.Object, buffers *py.Object, offset *py.Object, flags *py.Object) *py.Object

Writes the contents of bytes-like objects to a file descriptor at a given offset.

Combines the functionality of writev() and pwrite(). All buffers must be a sequence of bytes-like objects. Buffers are processed in array order. Entire contents of first buffer is written before proceeding to second, and so on. The operating system may set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used. This function writes the contents of each object to the file descriptor and returns the total number of bytes written.

The flags argument contains a bitwise OR of zero or more of the following flags:

- RWF_DSYNC - RWF_SYNC - RWF_APPEND

Using non-zero flags requires Linux 4.7 or newer.

func Read added in v0.8.2 

func Read(fd *py.Object, length *py.Object) *py.Object

Read from a file descriptor. Returns a bytes object.

func Readv added in v0.8.2 

func Readv(fd *py.Object, buffers *py.Object) *py.Object

Read from a file descriptor fd into an iterable of buffers.

The buffers should be mutable buffers accepting bytes. readv will transfer data into each buffer until it is full and then move on to the next buffer in the sequence to hold the rest of the data.

readv returns the total number of bytes read, which may be less than the total capacity of all the buffers.

func Remove added in v0.8.2 

func Remove(path *py.Object) *py.Object

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.

func Removedirs added in v0.8.2 

func Removedirs(name *py.Object) *py.Object

removedirs(name) 

Super-rmdir; remove a leaf directory and all empty intermediate
ones.  Works like rmdir except that, if the leaf directory is
successfully removed, directories corresponding to rightmost path
segments will be pruned away until either the whole path is
consumed or an error occurs.  Errors during this latter phase are
ignored -- they generally mean that a directory was not empty.

func Rename added in v0.8.2 

func Rename(src, dst *py.Object) *py.Object

Rename the file or directory src to dst. If dst exists, the operation will fail with an OSError subclass in a number of cases:

On Windows, if dst exists a FileExistsError is always raised. The operation may fail if src and dst are on different filesystems. Use shutil.move() to support moves to a different filesystem.

On Unix, if src is a file and dst is a directory or vice-versa, an IsADirectoryError or a NotADirectoryError will be raised respectively. If both are directories and dst is empty, dst will be silently replaced. If dst is a non-empty directory, an OSError is raised. If both are files, dst will be replaced silently if the user has permission. The operation may fail on some Unix flavors if src and dst are on different filesystems. If successful, the renaming will be an atomic operation (this is a POSIX requirement).

func Renames added in v0.8.2 

func Renames(old *py.Object, new *py.Object) *py.Object

renames(old, new) 

Super-rename; create directories as necessary and delete any left
empty.  Works like rename, except creation of any intermediate
directories needed to make the new pathname good is attempted
first.  After the rename, directories corresponding to rightmost
path segments of the old name will be pruned until either the
whole path is consumed or a nonempty directory is found.

Note: this function can fail with the new directory structure made
if you lack permissions needed to unlink the leaf directory or
file.

func Rmdir added in v0.8.2 

func Rmdir(path *py.Object) *py.Object

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.

func Scandir added in v0.8.2 

func Scandir(path *py.Object) *py.Object

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='.'.

func SchedGetPriorityMin added in v0.8.2 

func SchedGetPriorityMin(policy *py.Object) *py.Object

Get the minimum scheduling priority for policy.

func SchedYield added in v0.8.2 

func SchedYield() *py.Object

Voluntarily relinquish the CPU.

func Sendfile added in v0.8.2 

func Sendfile(outFd *py.Object, inFd *py.Object, offset *py.Object, count *py.Object, headers *py.Object, trailers *py.Object, flags *py.Object) *py.Object

Copy count bytes from file descriptor in_fd to file descriptor out_fd.

func SetBlocking added in v0.8.2 

func SetBlocking(fd *py.Object, blocking *py.Object) *py.Object

Set the blocking mode of the specified file descriptor.

Set the O_NONBLOCK flag if blocking is False, clear the O_NONBLOCK flag otherwise.

func SetInheritable added in v0.8.2 

func SetInheritable(fd *py.Object, inheritable *py.Object) *py.Object

Set the inheritable flag of the specified file descriptor.

func Setegid added in v0.8.2 

func Setegid(egid *py.Object) *py.Object

Set the current process's effective group id.

func Seteuid added in v0.8.2 

func Seteuid(euid *py.Object) *py.Object

Set the current process's effective user id.

func Setgid added in v0.8.2 

func Setgid(gid *py.Object) *py.Object

Set the current process's group id.

func Setgroups added in v0.8.2 

func Setgroups(groups *py.Object) *py.Object

Set the groups of the current process to list.

func Setpgid added in v0.8.2 

func Setpgid(pid *py.Object, pgrp *py.Object) *py.Object

Call the system call setpgid(pid, pgrp).

func Setpgrp added in v0.8.2 

func Setpgrp() *py.Object

Make the current process the leader of its process group.

func Setpriority added in v0.8.2 

func Setpriority(which *py.Object, who *py.Object, priority *py.Object) *py.Object

Set program scheduling priority.

func Setregid added in v0.8.2 

func Setregid(rgid *py.Object, egid *py.Object) *py.Object

Set the current process's real and effective group ids.

func Setreuid added in v0.8.2 

func Setreuid(ruid *py.Object, euid *py.Object) *py.Object

Set the current process's real and effective user ids.

func Setsid added in v0.8.2 

func Setsid() *py.Object

Call the system call setsid().

func Setuid added in v0.8.2 

func Setuid(uid *py.Object) *py.Object

Set the current process's user id.

func Spawnl added in v0.8.2 

func Spawnl(mode *py.Object, file *py.Object, __llgo_va_list ...interface{}) *py.Object

spawnl(mode, file, *args) -> integer

Execute file with arguments from args in a subprocess. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnle added in v0.8.2 

func Spawnle(mode *py.Object, file *py.Object, __llgo_va_list ...interface{}) *py.Object

spawnle(mode, file, *args, env) -> integer

Execute file with arguments from args in a subprocess with the supplied environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnlp added in v0.8.2 

func Spawnlp(mode *py.Object, file *py.Object, __llgo_va_list ...interface{}) *py.Object

spawnlp(mode, file, *args) -> integer

Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnlpe added in v0.8.2 

func Spawnlpe(mode *py.Object, file *py.Object, __llgo_va_list ...interface{}) *py.Object

spawnlpe(mode, file, *args, env) -> integer

Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnv added in v0.8.2 

func Spawnv(mode *py.Object, file *py.Object, args *py.Object) *py.Object

spawnv(mode, file, args) -> integer

Execute file with arguments from args in a subprocess. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnve added in v0.8.2 

func Spawnve(mode *py.Object, file *py.Object, args *py.Object, env *py.Object) *py.Object

spawnve(mode, file, args, env) -> integer

Execute file with arguments from args in a subprocess with the specified environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnvp added in v0.8.2 

func Spawnvp(mode *py.Object, file *py.Object, args *py.Object) *py.Object

spawnvp(mode, file, args) -> integer

Execute file (which is looked for along $PATH) with arguments from args in a subprocess. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Spawnvpe added in v0.8.2 

func Spawnvpe(mode *py.Object, file *py.Object, args *py.Object, env *py.Object) *py.Object

spawnvpe(mode, file, args, env) -> integer

Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

func Stat added in v0.8.2 

func Stat(path *py.Object) *py.Object

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.

func Statvfs added in v0.8.2 

func Statvfs(path *py.Object) *py.Object

Perform a statvfs system call on the given 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.

func Strerror added in v0.8.2 

func Strerror(code *py.Object) *py.Object

Translate an error code to a message string. 

func Symlink(src *py.Object, dst *py.Object, targetIsDirectory *py.Object) *py.Object

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.

func Sync added in v0.8.2 

func Sync() *py.Object

Force write of everything to disk.

func Sysconf added in v0.8.2 

func Sysconf(name *py.Object) *py.Object

Return an integer-valued system configuration variable.

func System added in v0.8.2 

func System(command *py.Object) *py.Object

Execute the command in a subshell.

func Tcgetpgrp added in v0.8.2 

func Tcgetpgrp(fd *py.Object) *py.Object

Return the process group associated with the terminal specified by fd.

func Tcsetpgrp added in v0.8.2 

func Tcsetpgrp(fd *py.Object, pgid *py.Object) *py.Object

Set the process group associated with the terminal specified by fd.

func Times added in v0.8.2 

func Times() *py.Object

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.

func Truncate added in v0.8.2 

func Truncate(path *py.Object, length *py.Object) *py.Object

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.

func Ttyname added in v0.8.2 

func Ttyname(fd *py.Object) *py.Object

Return the name of the terminal device connected to 'fd'. 

fd
  Integer file descriptor handle.

func Umask added in v0.8.2 

func Umask(mask *py.Object) *py.Object

Set the current numeric umask and return the previous umask.

func Uname added in v0.8.2 

func Uname() *py.Object

Return an object identifying the current operating system.

The object behaves like a named tuple with the following fields: 

(sysname, nodename, release, version, machine)

func Unlink(path *py.Object) *py.Object

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.

func Unsetenv added in v0.8.2 

func Unsetenv(name *py.Object) *py.Object

Delete an environment variable.

func Urandom added in v0.8.2 

func Urandom(size *py.Object) *py.Object

Return a bytes object containing random bytes suitable for cryptographic use.

func WCOREDUMP added in v0.8.2 

func WCOREDUMP(status *py.Object) *py.Object

Return True if the process returning status was dumped to a core file.

func WEXITSTATUS added in v0.8.2 

func WEXITSTATUS(status *py.Object) *py.Object

Return the process return code from status.

func WIFCONTINUED added in v0.8.2 

func WIFCONTINUED(status *py.Object) *py.Object

Return True if a particular process was continued from a job control stop.

Return True if the process returning status was continued from a job control stop.

func WIFEXITED added in v0.8.2 

func WIFEXITED(status *py.Object) *py.Object

Return True if the process returning status exited via the exit() system call.

func WIFSIGNALED added in v0.8.2 

func WIFSIGNALED(status *py.Object) *py.Object

Return True if the process returning status was terminated by a signal.

func WIFSTOPPED added in v0.8.2 

func WIFSTOPPED(status *py.Object) *py.Object

Return True if the process returning status was stopped.

func WSTOPSIG added in v0.8.2 

func WSTOPSIG(status *py.Object) *py.Object

Return the signal that stopped the process that provided the status value.

func WTERMSIG added in v0.8.2 

func WTERMSIG(status *py.Object) *py.Object

Return the signal that terminated the process that provided the status value.

func Wait added in v0.8.2 

func Wait() *py.Object

Wait for completion of a child process.

Returns a tuple of information about the child process: 

(pid, status)

func Wait3 added in v0.8.2 

func Wait3(options *py.Object) *py.Object

Wait for completion of a child process.

Returns a tuple of information about the child process: 

(pid, status, rusage)

func Wait4 added in v0.8.2 

func Wait4(pid *py.Object, options *py.Object) *py.Object

Wait for completion of a specific child process.

Returns a tuple of information about the child process: 

(pid, status, rusage)

func Waitpid added in v0.8.2 

func Waitpid(pid *py.Object, options *py.Object) *py.Object

Wait for completion of a given child process.

Returns a tuple of information regarding the child process: 

(pid, status)

The options argument is ignored on Windows.

func WaitstatusToExitcode added in v0.8.2 

func WaitstatusToExitcode(status *py.Object) *py.Object

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.

func Walk added in v0.8.2 

func Walk(top *py.Object, topdown *py.Object, onerror *py.Object, followlinks *py.Object) *py.Object

Directory tree generator. 

For each directory in the directory tree rooted at top (including top
itself, but excluding '.' and '..'), yields a 3-tuple

    dirpath, dirnames, filenames

dirpath is a string, the path to the directory.  dirnames is a list of
the names of the subdirectories in dirpath (including symlinks to directories,
and excluding '.' and '..').
filenames is a list of the names of the non-directory files in dirpath.
Note that the names in the lists are just names, with no path components.
To get a full path (which begins with top) to a file or directory in
dirpath, do os.path.join(dirpath, name).

If optional arg 'topdown' is true or not specified, the triple for a
directory is generated before the triples for any of its subdirectories
(directories are generated top down).  If topdown is false, the triple
for a directory is generated after the triples for all of its
subdirectories (directories are generated bottom up).

When topdown is true, the caller can modify the dirnames list in-place
(e.g., via del or slice assignment), and walk will only recurse into the
subdirectories whose names remain in dirnames; this can be used to prune the
search, or to impose a specific order of visiting.  Modifying dirnames when
topdown is false has no effect on the behavior of os.walk(), since the
directories in dirnames have already been generated by the time dirnames
itself is generated. No matter the value of topdown, the list of
subdirectories is retrieved before the tuples for the directory and its
subdirectories are generated.

By default errors from the os.scandir() call are ignored.  If
optional arg 'onerror' is specified, it should be a function; it
will be called with one argument, an OSError instance.  It can
report the error to continue with the walk, or raise the exception
to abort the walk.  Note that the filename is available as the
filename attribute of the exception object.

By default, os.walk does not follow symbolic links to subdirectories on
systems that support them.  In order to get this functionality, set the
optional argument 'followlinks' to true.

Caution:  if you pass a relative pathname for top, don't change the
current working directory between resumptions of walk.  walk never
changes the current directory, and assumes that the client doesn't
either.

Example:

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), end=" ")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

func Write added in v0.8.2 

func Write(fd *py.Object, data *py.Object) *py.Object

Write a bytes object to a file descriptor.

func Writev added in v0.8.2 

func Writev(fd *py.Object, buffers *py.Object) *py.Object

Iterate over buffers, and write the contents of each to a file descriptor.

Returns the total number of bytes written. buffers must be a sequence of bytes-like objects.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.