aboutsummaryrefslogtreecommitdiff
path: root/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs
diff options
context:
space:
mode:
Diffstat (limited to 'vim/bundle/YouCompleteMe/third_party/pythonfutures/docs')
m---------vim/bundle/YouCompleteMe0
-rwxr-xr-xvim/bundle/YouCompleteMe/third_party/pythonfutures/docs/conf.py194
-rwxr-xr-xvim/bundle/YouCompleteMe/third_party/pythonfutures/docs/index.rst345
-rwxr-xr-xvim/bundle/YouCompleteMe/third_party/pythonfutures/docs/make.bat112
4 files changed, 0 insertions, 651 deletions
diff --git a/vim/bundle/YouCompleteMe b/vim/bundle/YouCompleteMe
new file mode 160000
+Subproject 0de1c0c9bb13ce82172b472c676035cd47cf6a6
diff --git a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/conf.py b/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/conf.py
deleted file mode 100755
index 124cd51..0000000
--- a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/conf.py
+++ /dev/null
@@ -1,194 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# futures documentation build configuration file, created by
-# sphinx-quickstart on Wed Jun 3 19:35:34 2009.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'futures'
-copyright = u'2009-2011, Brian Quinlan'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '2.1.3'
-# The full version, including alpha/beta/rc tags.
-release = '2.1.3'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'futuresdoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'futures.tex', u'futures Documentation',
- u'Brian Quinlan', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
diff --git a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/index.rst b/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/index.rst
deleted file mode 100755
index 525ce6a..0000000
--- a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/index.rst
+++ /dev/null
@@ -1,345 +0,0 @@
-:mod:`concurrent.futures` --- Asynchronous computation
-======================================================
-
-.. module:: concurrent.futures
- :synopsis: Execute computations asynchronously using threads or processes.
-
-The :mod:`concurrent.futures` module provides a high-level interface for
-asynchronously executing callables.
-
-The asynchronous execution can be be performed by threads using
-:class:`ThreadPoolExecutor` or seperate processes using
-:class:`ProcessPoolExecutor`. Both implement the same interface, which is
-defined by the abstract :class:`Executor` class.
-
-Executor Objects
-----------------
-
-:class:`Executor` is an abstract class that provides methods to execute calls
-asynchronously. It should not be used directly, but through its two
-subclasses: :class:`ThreadPoolExecutor` and :class:`ProcessPoolExecutor`.
-
-.. method:: Executor.submit(fn, *args, **kwargs)
-
- Schedules the callable to be executed as *fn*(*\*args*, *\*\*kwargs*) and
- returns a :class:`Future` representing the execution of the callable.
-
-::
-
- with ThreadPoolExecutor(max_workers=1) as executor:
- future = executor.submit(pow, 323, 1235)
- print(future.result())
-
-.. method:: Executor.map(func, *iterables, timeout=None)
-
- Equivalent to map(*func*, *\*iterables*) but func is executed asynchronously
- and several calls to *func* may be made concurrently. The returned iterator
- raises a :exc:`TimeoutError` if :meth:`__next__()` is called and the result
- isn't available after *timeout* seconds from the original call to
- :meth:`map()`. *timeout* can be an int or float. If *timeout* is not
- specified or ``None`` then there is no limit to the wait time. If a call
- raises an exception then that exception will be raised when its value is
- retrieved from the iterator.
-
-.. method:: Executor.shutdown(wait=True)
-
- Signal the executor that it should free any resources that it is using when
- the currently pending futures are done executing. Calls to
- :meth:`Executor.submit` and :meth:`Executor.map` made after shutdown will
- raise :exc:`RuntimeError`.
-
- If *wait* is `True` then this method will not return until all the pending
- futures are done executing and the resources associated with the executor
- have been freed. If *wait* is `False` then this method will return
- immediately and the resources associated with the executor will be freed
- when all pending futures are done executing. Regardless of the value of
- *wait*, the entire Python program will not exit until all pending futures
- are done executing.
-
- You can avoid having to call this method explicitly if you use the `with`
- statement, which will shutdown the `Executor` (waiting as if
- `Executor.shutdown` were called with *wait* set to `True`):
-
-::
-
- import shutil
- with ThreadPoolExecutor(max_workers=4) as e:
- e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
- e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
- e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
- e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
-
-
-ThreadPoolExecutor Objects
---------------------------
-
-The :class:`ThreadPoolExecutor` class is an :class:`Executor` subclass that uses
-a pool of threads to execute calls asynchronously.
-
-Deadlock can occur when the callable associated with a :class:`Future` waits on
-the results of another :class:`Future`. For example:
-
-::
-
- import time
- def wait_on_b():
- time.sleep(5)
- print(b.result()) # b will never complete because it is waiting on a.
- return 5
-
- def wait_on_a():
- time.sleep(5)
- print(a.result()) # a will never complete because it is waiting on b.
- return 6
-
-
- executor = ThreadPoolExecutor(max_workers=2)
- a = executor.submit(wait_on_b)
- b = executor.submit(wait_on_a)
-
-And:
-
-::
-
- def wait_on_future():
- f = executor.submit(pow, 5, 2)
- # This will never complete because there is only one worker thread and
- # it is executing this function.
- print(f.result())
-
- executor = ThreadPoolExecutor(max_workers=1)
- executor.submit(wait_on_future)
-
-.. class:: ThreadPoolExecutor(max_workers)
-
- Executes calls asynchronously using at pool of at most *max_workers* threads.
-
-.. _threadpoolexecutor-example:
-
-ThreadPoolExecutor Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-::
-
- from concurrent import futures
- import urllib.request
-
- URLS = ['http://www.foxnews.com/',
- 'http://www.cnn.com/',
- 'http://europe.wsj.com/',
- 'http://www.bbc.co.uk/',
- 'http://some-made-up-domain.com/']
-
- def load_url(url, timeout):
- return urllib.request.urlopen(url, timeout=timeout).read()
-
- with futures.ThreadPoolExecutor(max_workers=5) as executor:
- future_to_url = dict((executor.submit(load_url, url, 60), url)
- for url in URLS)
-
- for future in futures.as_completed(future_to_url):
- url = future_to_url[future]
- if future.exception() is not None:
- print('%r generated an exception: %s' % (url,
- future.exception()))
- else:
- print('%r page is %d bytes' % (url, len(future.result())))
-
-ProcessPoolExecutor Objects
----------------------------
-
-The :class:`ProcessPoolExecutor` class is an :class:`Executor` subclass that
-uses a pool of processes to execute calls asynchronously.
-:class:`ProcessPoolExecutor` uses the :mod:`multiprocessing` module, which
-allows it to side-step the :term:`Global Interpreter Lock` but also means that
-only picklable objects can be executed and returned.
-
-Calling :class:`Executor` or :class:`Future` methods from a callable submitted
-to a :class:`ProcessPoolExecutor` will result in deadlock.
-
-.. class:: ProcessPoolExecutor(max_workers=None)
-
- Executes calls asynchronously using a pool of at most *max_workers*
- processes. If *max_workers* is ``None`` or not given then as many worker
- processes will be created as the machine has processors.
-
-.. _processpoolexecutor-example:
-
-ProcessPoolExecutor Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-::
-
- import math
-
- PRIMES = [
- 112272535095293,
- 112582705942171,
- 112272535095293,
- 115280095190773,
- 115797848077099,
- 1099726899285419]
-
- def is_prime(n):
- if n % 2 == 0:
- return False
-
- sqrt_n = int(math.floor(math.sqrt(n)))
- for i in range(3, sqrt_n + 1, 2):
- if n % i == 0:
- return False
- return True
-
- def main():
- with futures.ProcessPoolExecutor() as executor:
- for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):
- print('%d is prime: %s' % (number, prime))
-
- if __name__ == '__main__':
- main()
-
-Future Objects
---------------
-
-The :class:`Future` class encapulates the asynchronous execution of a callable.
-:class:`Future` instances are created by :meth:`Executor.submit`.
-
-.. method:: Future.cancel()
-
- Attempt to cancel the call. If the call is currently being executed then
- it cannot be cancelled and the method will return `False`, otherwise the call
- will be cancelled and the method will return `True`.
-
-.. method:: Future.cancelled()
-
- Return `True` if the call was successfully cancelled.
-
-.. method:: Future.running()
-
- Return `True` if the call is currently being executed and cannot be
- cancelled.
-
-.. method:: Future.done()
-
- Return `True` if the call was successfully cancelled or finished running.
-
-.. method:: Future.result(timeout=None)
-
- Return the value returned by the call. If the call hasn't yet completed then
- this method will wait up to *timeout* seconds. If the call hasn't completed
- in *timeout* seconds then a :exc:`TimeoutError` will be raised. *timeout* can
- be an int or float.If *timeout* is not specified or ``None`` then there is no
- limit to the wait time.
-
- If the future is cancelled before completing then :exc:`CancelledError` will
- be raised.
-
- If the call raised then this method will raise the same exception.
-
-.. method:: Future.exception(timeout=None)
-
- Return the exception raised by the call. If the call hasn't yet completed
- then this method will wait up to *timeout* seconds. If the call hasn't
- completed in *timeout* seconds then a :exc:`TimeoutError` will be raised.
- *timeout* can be an int or float. If *timeout* is not specified or ``None``
- then there is no limit to the wait time.
-
- If the future is cancelled before completing then :exc:`CancelledError` will
- be raised.
-
- If the call completed without raising then ``None`` is returned.
-
-.. method:: Future.add_done_callback(fn)
-
- Attaches the callable *fn* to the future. *fn* will be called, with the
- future as its only argument, when the future is cancelled or finishes
- running.
-
- Added callables are called in the order that they were added and are always
- called in a thread belonging to the process that added them. If the callable
- raises an :exc:`Exception` then it will be logged and ignored. If the
- callable raises another :exc:`BaseException` then the behavior is not
- defined.
-
- If the future has already completed or been cancelled then *fn* will be
- called immediately.
-
-Internal Future Methods
-^^^^^^^^^^^^^^^^^^^^^^^
-
-The following :class:`Future` methods are meant for use in unit tests and
-:class:`Executor` implementations.
-
-.. method:: Future.set_running_or_notify_cancel()
-
- This method should only be called by :class:`Executor` implementations before
- executing the work associated with the :class:`Future` and by unit tests.
-
- If the method returns `False` then the :class:`Future` was cancelled i.e.
- :meth:`Future.cancel` was called and returned `True`. Any threads waiting
- on the :class:`Future` completing (i.e. through :func:`as_completed` or
- :func:`wait`) will be woken up.
-
- If the method returns `True` then the :class:`Future` was not cancelled
- and has been put in the running state i.e. calls to
- :meth:`Future.running` will return `True`.
-
- This method can only be called once and cannot be called after
- :meth:`Future.set_result` or :meth:`Future.set_exception` have been
- called.
-
-.. method:: Future.set_result(result)
-
- Sets the result of the work associated with the :class:`Future` to *result*.
-
- This method should only be used by Executor implementations and unit tests.
-
-.. method:: Future.set_exception(exception)
-
- Sets the result of the work associated with the :class:`Future` to the
- :class:`Exception` *exception*.
-
- This method should only be used by Executor implementations and unit tests.
-
-Module Functions
-----------------
-
-.. function:: wait(fs, timeout=None, return_when=ALL_COMPLETED)
-
- Wait for the :class:`Future` instances (possibly created by different
- :class:`Executor` instances) given by *fs* to complete. Returns a named
- 2-tuple of sets. The first set, named "done", contains the futures that
- completed (finished or were cancelled) before the wait completed. The second
- set, named "not_done", contains uncompleted futures.
-
- *timeout* can be used to control the maximum number of seconds to wait before
- returning. *timeout* can be an int or float. If *timeout* is not specified or
- ``None`` then there is no limit to the wait time.
-
- *return_when* indicates when this function should return. It must be one of
- the following constants:
-
- +-----------------------------+----------------------------------------+
- | Constant | Description |
- +=============================+========================================+
- | :const:`FIRST_COMPLETED` | The function will return when any |
- | | future finishes or is cancelled. |
- +-----------------------------+----------------------------------------+
- | :const:`FIRST_EXCEPTION` | The function will return when any |
- | | future finishes by raising an |
- | | exception. If no future raises an |
- | | exception then it is equivalent to |
- | | `ALL_COMPLETED`. |
- +-----------------------------+----------------------------------------+
- | :const:`ALL_COMPLETED` | The function will return when all |
- | | futures finish or are cancelled. |
- +-----------------------------+----------------------------------------+
-
-.. function:: as_completed(fs, timeout=None)
-
- Returns an iterator over the :class:`Future` instances (possibly created
- by different :class:`Executor` instances) given by *fs* that yields futures
- as they complete (finished or were cancelled). Any futures that completed
- before :func:`as_completed()` was called will be yielded first. The returned
- iterator raises a :exc:`TimeoutError` if :meth:`__next__()` is called and
- the result isn't available after *timeout* seconds from the original call
- to :func:`as_completed()`. *timeout* can be an int or float. If *timeout*
- is not specified or ``None`` then there is no limit to the wait time.
diff --git a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/make.bat b/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/make.bat
deleted file mode 100755
index 3e8021b..0000000
--- a/vim/bundle/YouCompleteMe/third_party/pythonfutures/docs/make.bat
+++ /dev/null
@@ -1,112 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-set SPHINXBUILD=sphinx-build
-set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (_build\*) do rmdir /q /s %%i
- del /q /s _build\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
- echo.
- echo.Build finished. The HTML pages are in _build/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml
- echo.
- echo.Build finished. The HTML pages are in _build/dirhtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in _build/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in _build/qthelp, like this:
- echo.^> qcollectiongenerator _build\qthelp\futures.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile _build\qthelp\futures.ghc
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex
- echo.
- echo.Build finished; the LaTeX files are in _build/latex.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
- echo.
- echo.The overview file is in _build/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in _build/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in _build/doctest/output.txt.
- goto end
-)
-
-:end