[Python-modules-commits] [python-conditional] 01/03: Imported Upstream version 1.1
Sandro Tosi
morph at moszumanska.debian.org
Tue Jun 30 22:00:16 UTC 2015
This is an automated email from the git hooks/post-receive script.
morph pushed a commit to branch master
in repository python-conditional.
commit 552643791b1bc6c4b644d496df8cb321dd4ff51c
Author: Sandro Tosi <morph at debian.org>
Date: Tue Jun 30 17:32:36 2015 -0400
Imported Upstream version 1.1
---
CHANGES.rst | 14 ++
PKG-INFO | 75 +++++++++
README.rst | 43 +++++
conditional.egg-info/PKG-INFO | 75 +++++++++
conditional.egg-info/SOURCES.txt | 20 +++
conditional.egg-info/dependency_links.txt | 1 +
conditional.egg-info/top_level.txt | 1 +
conditional.egg-info/zip-safe | 1 +
conditional/__init__.py | 3 +
conditional/conditional.py | 18 +++
conditional/tests/__init__.py | 0
conditional/tests/test_conditional.py | 62 ++++++++
docs/Makefile | 153 ++++++++++++++++++
docs/_build/.placeholder | 0
docs/_static/.placeholder | 0
docs/_static/nature-plus.css | 9 ++
docs/_templates/.placeholder | 0
docs/conf.py | 254 ++++++++++++++++++++++++++++++
docs/index.rst | 45 ++++++
setup.cfg | 13 ++
setup.py | 31 ++++
21 files changed, 818 insertions(+)
diff --git a/CHANGES.rst b/CHANGES.rst
new file mode 100644
index 0000000..b651790
--- /dev/null
+++ b/CHANGES.rst
@@ -0,0 +1,14 @@
+Changelog
+=========
+
+1.1 - 2014-04-19
+----------------
+
+- Remove setuptools from install_requires because it isn't.
+ [stefan]
+
+1.0 - 2012-05-16
+----------------
+
+- Initial release.
+ [stefan]
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..f2c3b73
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,75 @@
+Metadata-Version: 1.1
+Name: conditional
+Version: 1.1
+Summary: Conditionally enter a context manager
+Home-page: https://pypi.python.org/pypi/conditional
+Author: Stefan H. Holek
+Author-email: stefan at epy.co.at
+License: BSD
+Description: ===========
+ conditional
+ ===========
+ -------------------------------------------------------------------
+ Conditionally enter a context manager
+ -------------------------------------------------------------------
+
+ Package Contents
+ ================
+
+ conditional(condition, contextmanager)
+ Enter contextmanager only if condition is true.
+
+ Overview
+ ========
+
+ The *conditional* context manager comes handy when you always want to
+ execute a with-block but only conditionally want to apply its context
+ manager.
+
+ If you find yourself writing code like this::
+
+ if CONDITION:
+ with CONTEXTMANAGER():
+ BODY()
+ else:
+ BODY()
+
+ Consider replacing it with::
+
+ with conditional(CONDITION, CONTEXTMANAGER()):
+ BODY()
+
+ Examples
+ ========
+
+ Say we want to ignore signals when a pager application is in the
+ foreground, but not otherwise::
+
+ from conditional import conditional
+
+ with conditional(has_pager(cmd), ignoresignals()):
+ os.system(cmd)
+
+ Changelog
+ =========
+
+ 1.1 - 2014-04-19
+ ----------------
+
+ - Remove setuptools from install_requires because it isn't.
+ [stefan]
+
+ 1.0 - 2012-05-16
+ ----------------
+
+ - Initial release.
+ [stefan]
+
+Keywords: conditional context manager with
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..488d9ea
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+===========
+conditional
+===========
+-------------------------------------------------------------------
+Conditionally enter a context manager
+-------------------------------------------------------------------
+
+Package Contents
+================
+
+conditional(condition, contextmanager)
+ Enter contextmanager only if condition is true.
+
+Overview
+========
+
+The *conditional* context manager comes handy when you always want to
+execute a with-block but only conditionally want to apply its context
+manager.
+
+If you find yourself writing code like this::
+
+ if CONDITION:
+ with CONTEXTMANAGER():
+ BODY()
+ else:
+ BODY()
+
+Consider replacing it with::
+
+ with conditional(CONDITION, CONTEXTMANAGER()):
+ BODY()
+
+Examples
+========
+
+Say we want to ignore signals when a pager application is in the
+foreground, but not otherwise::
+
+ from conditional import conditional
+
+ with conditional(has_pager(cmd), ignoresignals()):
+ os.system(cmd)
diff --git a/conditional.egg-info/PKG-INFO b/conditional.egg-info/PKG-INFO
new file mode 100644
index 0000000..f2c3b73
--- /dev/null
+++ b/conditional.egg-info/PKG-INFO
@@ -0,0 +1,75 @@
+Metadata-Version: 1.1
+Name: conditional
+Version: 1.1
+Summary: Conditionally enter a context manager
+Home-page: https://pypi.python.org/pypi/conditional
+Author: Stefan H. Holek
+Author-email: stefan at epy.co.at
+License: BSD
+Description: ===========
+ conditional
+ ===========
+ -------------------------------------------------------------------
+ Conditionally enter a context manager
+ -------------------------------------------------------------------
+
+ Package Contents
+ ================
+
+ conditional(condition, contextmanager)
+ Enter contextmanager only if condition is true.
+
+ Overview
+ ========
+
+ The *conditional* context manager comes handy when you always want to
+ execute a with-block but only conditionally want to apply its context
+ manager.
+
+ If you find yourself writing code like this::
+
+ if CONDITION:
+ with CONTEXTMANAGER():
+ BODY()
+ else:
+ BODY()
+
+ Consider replacing it with::
+
+ with conditional(CONDITION, CONTEXTMANAGER()):
+ BODY()
+
+ Examples
+ ========
+
+ Say we want to ignore signals when a pager application is in the
+ foreground, but not otherwise::
+
+ from conditional import conditional
+
+ with conditional(has_pager(cmd), ignoresignals()):
+ os.system(cmd)
+
+ Changelog
+ =========
+
+ 1.1 - 2014-04-19
+ ----------------
+
+ - Remove setuptools from install_requires because it isn't.
+ [stefan]
+
+ 1.0 - 2012-05-16
+ ----------------
+
+ - Initial release.
+ [stefan]
+
+Keywords: conditional context manager with
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
diff --git a/conditional.egg-info/SOURCES.txt b/conditional.egg-info/SOURCES.txt
new file mode 100644
index 0000000..5f4ec45
--- /dev/null
+++ b/conditional.egg-info/SOURCES.txt
@@ -0,0 +1,20 @@
+CHANGES.rst
+README.rst
+setup.cfg
+setup.py
+conditional/__init__.py
+conditional/conditional.py
+conditional.egg-info/PKG-INFO
+conditional.egg-info/SOURCES.txt
+conditional.egg-info/dependency_links.txt
+conditional.egg-info/top_level.txt
+conditional.egg-info/zip-safe
+conditional/tests/__init__.py
+conditional/tests/test_conditional.py
+docs/Makefile
+docs/conf.py
+docs/index.rst
+docs/_build/.placeholder
+docs/_static/.placeholder
+docs/_static/nature-plus.css
+docs/_templates/.placeholder
\ No newline at end of file
diff --git a/conditional.egg-info/dependency_links.txt b/conditional.egg-info/dependency_links.txt
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/conditional.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/conditional.egg-info/top_level.txt b/conditional.egg-info/top_level.txt
new file mode 100644
index 0000000..bb859b2
--- /dev/null
+++ b/conditional.egg-info/top_level.txt
@@ -0,0 +1 @@
+conditional
diff --git a/conditional.egg-info/zip-safe b/conditional.egg-info/zip-safe
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/conditional.egg-info/zip-safe
@@ -0,0 +1 @@
+
diff --git a/conditional/__init__.py b/conditional/__init__.py
new file mode 100644
index 0000000..c925cd0
--- /dev/null
+++ b/conditional/__init__.py
@@ -0,0 +1,3 @@
+"""The conditional module."""
+
+from conditional import conditional
diff --git a/conditional/conditional.py b/conditional/conditional.py
new file mode 100644
index 0000000..ab40a9c
--- /dev/null
+++ b/conditional/conditional.py
@@ -0,0 +1,18 @@
+"""Conditionally enter a context manager."""
+
+
+class conditional(object):
+ """Wrap another context manager and enter it only if condition is true.
+ """
+
+ def __init__(self, condition, contextmanager):
+ self.condition = condition
+ self.contextmanager = contextmanager
+
+ def __enter__(self):
+ if self.condition:
+ return self.contextmanager.__enter__()
+
+ def __exit__(self, *args):
+ if self.condition:
+ return self.contextmanager.__exit__(*args)
diff --git a/conditional/tests/__init__.py b/conditional/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/conditional/tests/test_conditional.py b/conditional/tests/test_conditional.py
new file mode 100644
index 0000000..ea21751
--- /dev/null
+++ b/conditional/tests/test_conditional.py
@@ -0,0 +1,62 @@
+import unittest
+
+from flexmock import flexmock
+from conditional import conditional
+
+
+class ConditionalTests(unittest.TestCase):
+
+ def make_one(self, **kw):
+ attrs = dict(__enter__=lambda:None, __exit__=lambda x,y,z:None)
+ attrs.update(kw)
+ return flexmock(**attrs)
+
+ def test_true_condition_enters_context_manager(self):
+ cm = self.make_one()
+ flexmock(cm).should_call('__enter__').once
+ flexmock(cm).should_call('__exit__').once
+
+ with conditional(True, cm):
+ pass
+
+ def test_false_condition_does_not_enter_context_manager(self):
+ cm = self.make_one()
+ flexmock(cm).should_call('__enter__').never
+ flexmock(cm).should_call('__exit__').never
+
+ with conditional(False, cm):
+ pass
+
+ def test_true_condition_returns_enter_result(self):
+ cm = self.make_one(__enter__=lambda:42)
+ flexmock(cm).should_call('__enter__').once
+ flexmock(cm).should_call('__exit__').once
+
+ with conditional(True, cm) as value:
+ self.assertEqual(value, 42)
+
+ def test_false_condition_returns_None(self):
+ cm = self.make_one()
+ flexmock(cm).should_call('__enter__').never
+ flexmock(cm).should_call('__exit__').never
+
+ with conditional(False, cm) as value:
+ self.assertEqual(value, None)
+
+ def test_returning_true_from_exit_handles_exception(self):
+ cm = self.make_one(__exit__=lambda x,y,z:True)
+ flexmock(cm).should_call('__enter__').once
+ flexmock(cm).should_call('__exit__').once
+
+ with conditional(True, cm):
+ raise RuntimeError()
+
+ def test_returning_None_from_exit_lets_exception_propagate(self):
+ cm = self.make_one()
+ flexmock(cm).should_call('__enter__').once
+ flexmock(cm).should_call('__exit__').once
+
+ with self.assertRaises(RuntimeError):
+ with conditional(True, cm):
+ raise RuntimeError()
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..b14845f
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = ../bin/sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 " singlehtml to make a single large HTML file"
+ @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 " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of 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)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/term.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/term.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/term"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/term"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/_build/.placeholder b/docs/_build/.placeholder
new file mode 100644
index 0000000..e69de29
diff --git a/docs/_static/.placeholder b/docs/_static/.placeholder
new file mode 100644
index 0000000..e69de29
diff --git a/docs/_static/nature-plus.css b/docs/_static/nature-plus.css
new file mode 100644
index 0000000..89faee0
--- /dev/null
+++ b/docs/_static/nature-plus.css
@@ -0,0 +1,9 @@
+ at import url('nature.css');
+
+a tt.xref {
+ color: #005b81;
+}
+
+h1 a tt.xref {
+ color: black;
+}
diff --git a/docs/_templates/.placeholder b/docs/_templates/.placeholder
new file mode 100644
index 0000000..e69de29
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..040e4c5
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+#
+# conditional documentation build configuration file, created by
+# sphinx-quickstart on Thu May 10 17:11:01 2012.
+#
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'conditional'
+copyright = u'2012-2014, Stefan H. Holek'
+
+# 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 full version, including alpha/beta/rc tags.
+release = '1.1'
+# The short X.Y version.
+version = '1.1'
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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. See the documentation for
+# a list of builtin themes.
+#html_theme = 'default'
+html_theme = 'nature'
+html_style = 'nature-plus.css'
+
+# 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_domain_indices = 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
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'conditionaldoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'conditional.tex', u'conditional Documentation',
+ u'Stefan H. Holek', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'conditional', u'conditional Documentation',
+ [u'Stefan H. Holek'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'conditional', u'conditional Documentation',
+ u'Stefan H. Holek', 'conditional', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# -- Intersphinx configuration -------------------------------------------------
+
+intersphinx_mapping = {
+ 'py': ('http://docs.python.org/2', 'http://docs.python.org/2/objects.inv'),
+ 'py3k': ('http://docs.python.org/3', 'http://docs.python.org/3/objects.inv'),
+}
+
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..895180f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
+.. conditional documentation master file, created by
+ sphinx-quickstart on Thu May 10 17:11:01 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+====================================================
+conditional |version| -- Conditional Context
+====================================================
+
+.. toctree::
+ :maxdepth: 2
+
+.. module:: conditional
+
+The :class:`~conditional.conditional` context manager comes handy when you
+always want to execute a with-block but only conditionally want to apply its
+context manager.
+
+If you find yourself writing code like this::
+
+ if CONDITION:
+ with CONTEXTMANAGER():
+ BODY()
+ else:
+ BODY()
+
+Consider replacing it with::
+
+ with conditional(CONDITION, CONTEXTMANAGER()):
+ BODY()
+
+API Documentation
+=================
+
+.. function:: conditional(condition, contextmanager)
+
+ Wrap a context manager and enter it only if condition is true.
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..5ee064b
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,13 @@
+[egg_info]
+tag_build =
+tag_svn_revision = 0
+tag_date = 0
+
+[build_sphinx]
+source-dir = docs/
+build-dir = docs/_build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = docs/_build/html
+
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..6416195
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+
+version = '1.1'
+
+setup(name='conditional',
+ version=version,
+ description='Conditionally enter a context manager',
+ long_description=open('README.rst').read() + '\n' +
+ open('CHANGES.rst').read(),
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: BSD License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 3',
+ ],
+ keywords='conditional context manager with',
+ author='Stefan H. Holek',
+ author_email='stefan at epy.co.at',
+ url='https://pypi.python.org/pypi/conditional',
+ license='BSD',
+ packages=find_packages(),
+ include_package_data=True,
+ zip_safe=True,
+ use_2to3=True,
+ test_suite='conditional.tests',
+ tests_require=[
+ 'flexmock',
+ ],
+)
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-conditional.git
More information about the Python-modules-commits
mailing list