python-future API reference

164 public APIs from python-future (PythonCharmers/python-future) — 90 classes, 23 functions, 51 methods. Signatures extracted by static analysis of the actual source.

Repository: PythonCharmers/python-future

Kind	Count
Classes	90
Functions	23
Methods	51

API list

classsrc.future.backports.datetime.date

Concrete date type.

methodsrc.future.backports.datetime.date.ctime()

Return ctime() style string.

methodsrc.future.backports.datetime.date.day()

day (1-31)

methodsrc.future.backports.datetime.date.month()

month (1-12)

methodsrc.future.backports.datetime.date.strftime(fmt)

Format using strftime().

methodsrc.future.backports.datetime.date.today()

Construct a date from time.time().

methodsrc.future.backports.datetime.date.year()

year (1-9999)

classsrc.future.backports.datetime.time

Time with time zone.

methodsrc.future.backports.datetime.time.hour()

hour (0-23)

methodsrc.future.backports.datetime.time.microsecond()

microsecond (0-999999)

methodsrc.future.backports.datetime.time.minute()

minute (0-59)

methodsrc.future.backports.datetime.time.second()

second (0-59)

methodsrc.future.backports.datetime.time.strftime(fmt)

Format using strftime().

methodsrc.future.backports.datetime.time.tzinfo()

timezone info object

methodsrc.future.backports.datetime.time.tzname()

Return the timezone name.

classsrc.future.backports.datetime.timedelta

Represent the difference between two datetime objects.

methodsrc.future.backports.datetime.timedelta.days()

days

methodsrc.future.backports.datetime.timedelta.microseconds()

microseconds

methodsrc.future.backports.datetime.timedelta.seconds()

seconds

classsrc.future.backports.datetime.tzinfo

Abstract base class for time zone info classes.

methodsrc.future.backports.datetime.tzinfo.tzname(dt)

datetime -> string name of time zone.

funcsrc.future.backports.email._header_value_parser.get_value(value)

quoted-string / attribute

funcsrc.future.backports.email._header_value_parser.parse_content_transfer_encoding_header(value)

mechanism

classsrc.future.backports.email._parseaddr.AddrlistClass

Address parser class by Ben Escoto.

methodsrc.future.backports.email._parseaddr.AddrlistClass.getaddress()

Parse the next address.

methodsrc.future.backports.email._parseaddr.AddrlistClass.getaddrlist()

Parse all addresses.

methodsrc.future.backports.email._parseaddr.AddrlistClass.getaddrspec()

Parse an RFC 2822 addr-spec.

methodsrc.future.backports.email._parseaddr.AddrlistClass.getatom(atomends=None)

Parse an RFC 2822 atom.

classsrc.future.backports.email.charset.Charset

Map character sets to their email properties.

funcsrc.future.backports.email.charset.add_alias(alias, canonical)

Add a character set alias.

funcsrc.future.backports.email.encoders.encode_noop(msg)

Do nothing.

classsrc.future.backports.email.errors.BoundaryError

Couldn't find terminating boundary.

classsrc.future.backports.email.errors.CharsetError

An illegal charset was given.

classsrc.future.backports.email.errors.HeaderDefect

Base class for a header defect.

classsrc.future.backports.email.errors.HeaderMissingRequiredValue

A header that must have a value had none

classsrc.future.backports.email.errors.HeaderParseError

Error while parsing headers.

classsrc.future.backports.email.errors.InvalidBase64PaddingDefect

base64 encoded sequence had an incorrect length

classsrc.future.backports.email.errors.InvalidHeaderDefect

Header is not valid, message gives details.

classsrc.future.backports.email.errors.MessageDefect

Base class for a message defect.

classsrc.future.backports.email.errors.MessageError

Base class for errors in the email package.

classsrc.future.backports.email.errors.MessageParseError

Base class for message parsing errors.

classsrc.future.backports.email.errors.MultipartConversionError

Conversion to a multipart is prohibited.

classsrc.future.backports.email.errors.NonASCIILocalPartDefect

local_part contains non-ASCII characters

classsrc.future.backports.email.errors.ObsoleteHeaderDefect

Header uses syntax declared obsolete by RFC 5322

classsrc.future.backports.email.errors.StartBoundaryNotFoundDefect

The claimed start boundary was never found.

classsrc.future.backports.email.errors.UndecodableBytesDefect

Header contained bytes that could not be decoded

classsrc.future.backports.email.feedparser.BytesFeedParser

Like FeedParser, but feed accepts bytes.

classsrc.future.backports.email.feedparser.FeedParser

A feed-style parser of email.

classsrc.future.backports.email.generator.DecodedGenerator

Generates a text representation of a message.

classsrc.future.backports.email.generator.Generator

Generates output from a Message object tree.

classsrc.future.backports.email.headerregistry.BaseHeader

Base class for message headers.

classsrc.future.backports.email.headerregistry.DateHeader

Header whose value consists of a single timestamp.

classsrc.future.backports.email.headerregistry.HeaderRegistry

A header_factory and header registry.

classsrc.future.backports.email.message.Message

Basic message object.

methodsrc.future.backports.email.message.Message.add_header(_name, _value, **_params)

Extended header setting.

methodsrc.future.backports.email.message.Message.get(name, failobj=None)

Get a header value.

methodsrc.future.backports.email.message.Message.items()

Get all the message's header fields and values.

methodsrc.future.backports.email.message.Message.replace_header(_name, _value)

Replace a header.

classsrc.future.backports.email.mime.audio.MIMEAudio

Class for generating audio/* MIME documents.

classsrc.future.backports.email.mime.base.MIMEBase

Base class for MIME specializations.

classsrc.future.backports.email.mime.image.MIMEImage

Class for generating image/* type MIME documents.

classsrc.future.backports.email.mime.message.MIMEMessage

Class representing message/* MIME documents.

classsrc.future.backports.email.mime.multipart.MIMEMultipart

Base class for MIME multipart/* type messages.

classsrc.future.backports.email.mime.nonmultipart.MIMENonMultipart

Base class for MIME multipart/* type messages.

classsrc.future.backports.email.mime.text.MIMEText

Class for generating text/* type MIME documents.

funcsrc.future.backports.email.utils.unquote(str)

Remove quotes from a string.

classsrc.future.backports.html.parser.HTMLParseError

Exception raised for all parse errors.

methodsrc.future.backports.html.parser.HTMLParser.close()

Handle any buffered data.

methodsrc.future.backports.html.parser.HTMLParser.feed(data)

Feed data to the parser.

methodsrc.future.backports.html.parser.HTMLParser.reset()

Reset this instance.

methodsrc.future.backports.http.client.HTTPConnection.send(data)

Send `data' to the server.

classsrc.future.backports.http.client.HTTPSConnection

This class allows communication via SSL.

classsrc.future.backports.http.cookiejar.Cookie

HTTP Cookie.

classsrc.future.backports.http.cookiejar.CookieJar

Collection of HTTP cookies.

methodsrc.future.backports.http.cookiejar.CookieJar.clear(domain=None, path=None, name=None)

Clear some cookies.

classsrc.future.backports.http.cookies.BaseCookie

A container class for a set of Morsels.

classsrc.future.backports.http.cookies.Morsel

A class to hold ONE (key, value) pair.

classsrc.future.backports.http.cookies.SimpleCookie

SimpleCookie supports strings as cookie values.

classsrc.future.backports.http.server.BaseHTTPRequestHandler

HTTP request handler base class.

methodsrc.future.backports.http.server.BaseHTTPRequestHandler.address_string()

Return the client address.

methodsrc.future.backports.http.server.BaseHTTPRequestHandler.log_error(format, *args)

Log an error.

methodsrc.future.backports.http.server.BaseHTTPRequestHandler.log_message(format, *args)

Log an arbitrary message.

funcsrc.future.backports.http.server.executable(path)

Test for executable file.

methodsrc.future.backports.misc.ChainMap.parents()

New ChainMap from maps[1:].

classsrc.future.backports.misc.Counter

Dict subclass for counting hashable items.

methodsrc.future.backports.misc.Counter.copy()

Return a shallow copy.

classsrc.future.backports.misc.OrderedDict

Dictionary that remembers insertion order

methodsrc.future.backports.misc.OrderedDict.clear()

od.clear() -> None.

methodsrc.future.backports.misc.OrderedDict.copy()

od.copy() -> a shallow copy of od

funcsrc.future.backports.misc.ceil(x)

Return the ceiling of x as an int.

classsrc.future.backports.socket.SocketIO

Raw I/O implementation for stream sockets.

methodsrc.future.backports.socket.SocketIO.close()

Close the SocketIO object.

classsrc.future.backports.socket.socket

A subclass of _socket.socket adding the makefile() method.

classsrc.future.backports.socketserver.BaseRequestHandler

Base class for request handler classes.

classsrc.future.backports.socketserver.BaseServer

Base class for server classes.

methodsrc.future.backports.socketserver.BaseServer.handle_error(request, client_address)

Handle an error gracefully.

methodsrc.future.backports.socketserver.BaseServer.process_request(request, client_address)

Call finish_request.

methodsrc.future.backports.socketserver.BaseServer.shutdown()

Stops the serve_forever loop.

methodsrc.future.backports.socketserver.BaseServer.verify_request(request, client_address)

Verify the request.

classsrc.future.backports.socketserver.TCPServer

Base class for various socket-based server classes.

methodsrc.future.backports.socketserver.TCPServer.fileno()

Return socket file number.

classsrc.future.backports.socketserver.UDPServer

UDP server class.

classsrc.future.backports.urllib.parse.Quoter

A mapping from bytes (in range(0,256)) to strings.

funcsrc.future.backports.urllib.parse.to_bytes(url)

to_bytes(u"URL") --> 'URL'.

classsrc.future.backports.urllib.request.HTTPErrorProcessor

Process HTTP error responses.

classsrc.future.backports.urllib.request.URLopener

Class to open URLs.

methodsrc.future.backports.urllib.request.URLopener.http_error(url, fp, errcode, errmsg, headers, data=None)

Handle http errors.

methodsrc.future.backports.urllib.request.URLopener.open_data(url, data=None)

Use "data" URL.

methodsrc.future.backports.urllib.request.URLopener.open_ftp(url)

Use FTP protocol.

methodsrc.future.backports.urllib.request.URLopener.open_http(url, data=None)

Use HTTP protocol.

methodsrc.future.backports.urllib.request.URLopener.open_https(url, data=None)

Use HTTPS protocol.

methodsrc.future.backports.urllib.request.URLopener.open_local_file(url)

Use local file.

classsrc.future.backports.urllib.response.addbase

Base class for addinfo and addclosehook.

classsrc.future.backports.urllib.response.addclosehook

Class to add a close hook to an open file.

classsrc.future.backports.urllib.response.addinfo

class to add an info() method to an open file.

classsrc.future.backports.urllib.response.addinfourl

class to add info() and geturl() methods to an open file.

classsrc.future.backports.xmlrpc.client.Binary

Wrapper for binary data.

classsrc.future.backports.xmlrpc.client.Error

Base class for client errors.

classsrc.future.backports.xmlrpc.client.Fault

Indicates an XML-RPC fault package.

classsrc.future.backports.xmlrpc.client.MultiCallIterator

Iterates over the results of a multicall.

classsrc.future.backports.xmlrpc.client.ProtocolError

Indicates an HTTP protocol error.

classsrc.future.backports.xmlrpc.client.ResponseError

Indicates a broken response package.

classsrc.future.backports.xmlrpc.client.SafeTransport

Handles an HTTPS transaction to an XML-RPC server.

classsrc.future.backports.xmlrpc.client.Transport

Handles an HTTP transaction to an XML-RPC server.

classsrc.future.backports.xmlrpc.server.DocXMLRPCRequestHandler

XML-RPC and documentation request handler class.

classsrc.future.backports.xmlrpc.server.DocXMLRPCServer

XML-RPC and HTML documentation server.

classsrc.future.backports.xmlrpc.server.ServerHTMLDoc

Class used to generate pydoc HTML document for a server

classsrc.future.backports.xmlrpc.server.SimpleXMLRPCDispatcher

Mix-in class that dispatches XML-RPC requests.

classsrc.future.backports.xmlrpc.server.SimpleXMLRPCRequestHandler

Simple XML-RPC request handler class.

classsrc.future.backports.xmlrpc.server.SimpleXMLRPCServer

Simple XML-RPC server.

classsrc.future.backports.xmlrpc.server.XMLRPCDocGenerator

Generates documentation for an XML-RPC server.

classsrc.future.standard_library.RenameImport

A class for import hooks mapping Py3 module names etc.

funcsrc.future.standard_library.disable_hooks()

Deprecated.

funcsrc.future.standard_library.enable_hooks()

Deprecated.

classsrc.future.standard_library.hooks

Acts as a context manager.

funcsrc.future.standard_library.scrub_future_sys_modules()

Deprecated.

classsrc.future.standard_library.suspend_hooks

Acts as a context manager.

classsrc.future.types.newbytes.newbytes

A backport of the Python 3 bytes object to Py2

methodsrc.future.types.newbytes.newbytes.decode(encoding='utf-8', errors='strict')

Returns a newstr (i.e.

methodsrc.future.types.newbytes.newbytes.index(sub, *args)

Returns index of sub in bytes.

classsrc.future.types.newdict.newdict

A backport of the Python 3 dict object to Py2

classsrc.future.types.newint.newint

A backport of the Python 3 int object to Py2

classsrc.future.types.newlist.newlist

A backport of the Python 3 list object to Py2

classsrc.future.types.newopen.newopen

Wrapper providing key part of Python 3 open() interface.

classsrc.future.types.newrange.newrange

Pure-Python backport of Python 3's range object.

classsrc.future.types.newrange.range_iterator

An iterator for a :class:`range`.

classsrc.future.types.newstr.newstr

A backport of the Python 3 str object to Py2

funcsrc.future.utils.exec_(code, globs=None, locs=None)

Execute code in a namespace.

funcsrc.future.utils.implements_iterator(cls)

From jinja2/_compat.py.

funcsrc.future.utils.isbytes(obj)

Deprecated.

funcsrc.future.utils.isint(obj)

Deprecated.

funcsrc.future.utils.istext(obj)

Deprecated.

funcsrc.future.utils.surrogateescape.replace_surrogate_decode(mybytes)

Returns a (unicode) string

funcsrc.future.utils.with_metaclass(meta, *bases)

Function from jinja2/_compat.py.

funcsrc.libfuturize.fixer_util.future_import(feature, node)

This seems to work

funcsrc.libfuturize.main.main(args=None)

Main program.

funcsrc.libpasteurize.main.main(args=None)

Main program.

classsrc.past.translation.RTs

A namespace for the refactoring tools.

classsrc.past.translation.hooks

Acts as a context manager.

funcsrc.past.translation.splitall(path)

Split a path into all components.

classsrc.past.translation.suspend_hooks

Acts as a context manager.

classsrc.past.types.olddict.olddict

A backport of the Python 3 dict object to Py2

classsrc.past.types.oldstr.oldstr

A forward port of the Python 2 8-bit string object to Py3

funcsrc.past.utils.with_metaclass(meta, *bases)

Function from jinja2/_compat.py.

About this data

These signatures were extracted from the public source of PythonCharmers/python-future using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries