💾 Archived View for tris.fyi › pydoc › shlex captured on 2023-04-26 at 13:31:51. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

shlex

A lexical analyzer class for simple shell-like syntaxes.

Classes

StringIO

Text I/O implementation using an in-memory buffer.

The initial_value argument sets the value of object.  The newline
argument is like the one of TextIOWrapper's constructor.

close(self, /)

  Close the IO object.

  Attempting any further operation after the object is closed
  will raise a ValueError.

  This method has no effect if the file is already closed.

detach(...)

  Separate the underlying buffer from the TextIOBase and return it.

  After the underlying buffer has been detached, the TextIO is in an
  unusable state.

fileno(self, /)

  Returns underlying file descriptor if one exists.

  OSError is raised if the IO object does not use a file descriptor.

flush(self, /)

  Flush write buffers, if applicable.

  This is not implemented for read-only and non-blocking streams.

getvalue(self, /)

  Retrieve the entire contents of the object.

isatty(self, /)

  Return whether this is an 'interactive' stream.

  Return False if it can't be determined.

read(self, size=-1, /)

  Read at most size characters, returned as a string.

  If the argument is negative or omitted, read until EOF
  is reached. Return an empty string at EOF.

readable(self, /)

  Returns True if the IO object can be read.

readline(self, size=-1, /)

  Read until newline or EOF.

  Returns an empty string if EOF is hit immediately.

readlines(self, hint=-1, /)

  Return a list of lines from the stream.

  hint can be specified to control the number of lines read: no more
  lines will be read if the total size (in bytes/characters) of all
  lines so far exceeds hint.

seek(self, pos, whence=0, /)

  Change stream position.

  Seek to character offset pos relative to position indicated by whence:
      0  Start of stream (the default).  pos should be >= 0;
      1  Current position - pos must be 0;
      2  End of stream - pos must be 0.
  Returns the new absolute position.

seekable(self, /)

  Returns True if the IO object can be seeked.

tell(self, /)

  Tell the current file position.

truncate(self, pos=None, /)

  Truncate size to pos.

  The pos argument defaults to the current file position, as
  returned by tell().  The current file position is unchanged.
  Returns the new absolute position.

writable(self, /)

  Returns True if the IO object can be written.

write(self, s, /)

  Write string to file.

  Returns the number of characters written, which is always equal to
  the length of the string.

writelines(self, lines, /)

  Write a list of lines to stream.

  Line separators are not added, so it is usual for each of the
  lines provided to have a line separator at the end.

closed = <attribute 'closed' of '_io.StringIO' objects>

encoding = <attribute 'encoding' of '_io._TextIOBase' objects>
  Encoding of the text stream.

  Subclasses should override.

errors = <attribute 'errors' of '_io._TextIOBase' objects>
  The error setting of the decoder or encoder.

  Subclasses should override.

line_buffering = <attribute 'line_buffering' of '_io.StringIO' objects>

newlines = <attribute 'newlines' of '_io.StringIO' objects>

deque

deque([iterable[, maxlen]]) --> deque object

A list-like sequence optimized for data accesses near its endpoints.

append(...)

  Add an element to the right side of the deque.

appendleft(...)

  Add an element to the left side of the deque.

clear(...)

  Remove all elements from the deque.

copy(...)

  Return a shallow copy of a deque.

count(...)

  D.count(value) -> integer -- return number of occurrences of value

extend(...)

  Extend the right side of the deque with elements from the iterable

extendleft(...)

  Extend the left side of the deque with elements from the iterable

index(...)

  D.index(value, [start, [stop]]) -> integer -- return first index of value.
  Raises ValueError if the value is not present.

insert(...)

  D.insert(index, object) -- insert object before index

pop(...)

  Remove and return the rightmost element.

popleft(...)

  Remove and return the leftmost element.

remove(...)

  D.remove(value) -- remove first occurrence of value.

reverse(...)

  D.reverse() -- reverse *IN PLACE*

rotate(...)

  Rotate the deque n steps to the right (default n=1).  If n is negative, rotates left.

maxlen = <attribute 'maxlen' of 'collections.deque' objects>
  maximum size of a deque or None if unbounded

shlex

A lexical analyzer class for simple shell-like syntaxes.

error_leader(self, infile=None, lineno=None)

  Emit a C-compiler-like, Emacs-friendly error-message leader.

get_token(self)

  Get a token from the input stream (or from stack if it's nonempty)

pop_source(self)

  Pop the input source stack.

push_source(self, newstream, newfile=None)

  Push an input source onto the lexer's input source stack.

push_token(self, tok)

  Push a token onto the stack popped by the get_token method

read_token(self)

sourcehook(self, newfile)

  Hook called on a filename to be sourced.

punctuation_chars = <property object at 0x7f75e122c900>

Functions

join

join(split_command)

  Return a shell-escaped string from *split_command*.

quote

quote(s)

  Return a shell-escaped version of the string *s*.

split

split(s, comments=False, posix=True)

  Split the string *s* using shell-like syntax.

Modules

sys