texext-0.6.1/0000755000076500000240000000000013337306262013013 5ustar mb312staff00000000000000texext-0.6.1/PKG-INFO0000644000076500000240000001572213337306262014117 0ustar mb312staff00000000000000Metadata-Version: 1.1 Name: texext Version: 0.6.1 Summary: Sphinx extensions for working with LaTeX math Home-page: http://github.com/matthew-brett/texext Author: Matthew Brett, Ondřej Čertík Author-email: matthew.brett@gmail.com License: BSD license Description: ###################################################### Texext - sphinx extensions for working with LaTeX math ###################################################### ``texext`` contains a couple of Sphinx_ extensions for working with LaTeX math. *********** math_dollar *********** ``math_dollar`` replaces math expressions between dollars in ReST_ with equivalent inline math. For example:: Here is some math: $a = 2$ will be replaced by:: Here is some math: :math:`a = 2` The extension makes some effort not to replace dollars that aren't meant as math, but please check your output carefully, and submit an issue on the `texext issue tracker`_ if we have messed up. To enable math_dollar, make sure that the ``texext`` package is on your Python path, and add ``texext.math_dollar`` to your list of extensions in the Sphinx ``conf.py``. If you want math_dollar to process docstrings, you should add ``sphinx.ext.autodoc`` higher up your extensions list than ``math_dollar``. ****************** mathcode directive ****************** Users of `sympy `_ may want to generate LaTeX expressions dynamically in Sympy, and then render them in LaTeX in the built pages. You can do this with the ``mathcode`` directive:: .. mathcode:: import sympy a, b = sympy.symbols('a, b') a * 10 + 2 * b The directive runs ``sympy.latex()`` on the return result of the final expression, and embeds it in a ``.. math::`` directive, resulting in equivalent output to sphinx of:: .. math:: 10 a + 2 b Context (namespace) is preserved by default, so you can use context in subsequent directives, e.g.:: .. mathcode:: a * 5 + 3 * b If the last expression in the mathcode block is not an expression, the context gets updated, but the extension generates no math directive to the output. This allows you to have blocks that fill in calculations without rendering to the page. For example, this generates no output:: .. mathcode:: expr = a * 4 You can use the generated context in a later directive:: .. mathcode:: expr To reset the context (namespace), use the ``newcontext`` option:: .. mathcode:: :newcontext: import sympy # again If you would like mathcode to share a namespace with the `matplotlib plot_directive`_, set the following in your ``conf.py``:: # Config of mathcode directive mathcode_use_plot_ns = True .. note:: If you want to use the plot_directive context from within mathcode directives, you need to list the plot_directive above the mathcode directive in your sphinx extension list. All the plot directives code will get run before all the mathcode directive code. Conversely, if you want to use the mathcode directive context from the plot_directive, list mathcode first in your sphinx extension list. .. note:: By default, the Matplotlib ``plot_directive`` will clear the namespace context for each directive, so you may want to use the ``:context:`` option to the plot directive, most of the time. If you are using Nb2plots_ for your plots, and you want Mathcode to share a namespace with the Nb2plots plot directive, you will need to specify the Nb2plots plot context directly:: # Config of mathcode directive mathcode_use_plot_ns = True mathcode_plot_context = 'nb2plots.nbplots.plot_context' More generally if you want to work with a customized version of the plot_directive, you need to supply the name of the plot context dictionary for the plot directive, as a string. For example, if you have a custom plot directive module importable as ``import my_path.plot_directive``, with the plot context in ``my_path.plot_directive.plot_context``, then your ``conf.py`` should have lines like these:: # Config of mathcode directive mathcode_plot_context = "my_path.plot_directive.plot_context" The plot context is a string rather than the attribute itself in order to let sphinx pickle the configuration between runs. This allows sphinx to avoid building pages that have not changed between calls to ``sphinx-build``. To enable the mathcode directive, make sure that the ``texext`` package is on your Python path, and add ``textext.mathcode`` to your list of extensions in the Sphinx ``conf.py``. **** Code **** See https://github.com/matthew-brett/texext Released under the BSD two-clause license - see the file ``LICENSE`` in the source distribution. `travis-ci `_ kindly tests the code automatically under Python versions 2.7, and 3.3 through 3.6. The latest released version is at https://pypi.python.org/pypi/texext ******* Support ******* Please put up issues on the `texext issue tracker`_. .. _sphinx: http://sphinx-doc.org .. _rest: http://docutils.sourceforge.net/rst.html .. _texext issue tracker: https://github.com/matthew-brett/texext/issues .. _matplotlib plot_directive: http://matplotlib.org/sampledoc/extensions.html .. _nb2plots: https://pypi.python.org/pypi/nb2plots Platform: UNKNOWN Classifier: Development Status :: 4 - Beta Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: Intended Audience :: Science/Research Classifier: License :: OSI Approved :: BSD License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Topic :: Scientific/Engineering Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: POSIX Classifier: Operating System :: Unix Classifier: Operating System :: MacOS texext-0.6.1/texext/0000755000076500000240000000000013337306262014334 5ustar mb312staff00000000000000texext-0.6.1/texext/_version.py0000644000076500000240000000076113337306262016536 0ustar mb312staff00000000000000 # This file was generated by 'versioneer.py' (0.17) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. import json version_json = ''' { "date": "2018-08-22T17:17:02+0100", "dirty": false, "error": null, "full-revisionid": "4a3de5ed82c43660a476f12af446284dd5570401", "version": "0.6.1" } ''' # END VERSION_JSON def get_versions(): return json.loads(version_json) texext-0.6.1/texext/tests/0000755000076500000240000000000013337306262015476 5ustar mb312staff00000000000000texext-0.6.1/texext/tests/conftest.py0000644000076500000240000000030213327735533017676 0ustar mb312staff00000000000000""" Skip the conf.py file in tinypages Otherwise it gets imported twice, raises an ImportMismatchError. """ from os.path import join as pjoin collect_ignore = [pjoin('tinypages', "conf.py")] texext-0.6.1/texext/tests/test_plotdirective.py0000644000076500000240000000535113337277542022000 0ustar mb312staff00000000000000""" Tests for plotdirective build using sphinx extensions Test ability to combine plot_directive with mathcode """ from os.path import dirname, join as pjoin import re from six import PY3 import sphinx SPHINX_ge_1p8 = sphinx.version_info[:2] >= (1, 8) SPHINX_ge_1p7 = sphinx.version_info[:2] >= (1, 7) SPHINX_ge_1p5 = sphinx.version_info[:2] >= (1, 5) from sphinxtesters import PageBuilder PAGES = pjoin(dirname(__file__), 'plotdirective') def format_math_block(name, latex, label=None, number=None, ids=None): """ Simulate math block output from Sphinx at different versions """ if SPHINX_ge_1p8: number = 'True' if number is None else number label = 'True' if label is None else label id_part = '' if ids is None else 'ids="{}" '.format(ids) return ( '{}' ''.format(name, id_part, label, number, latex) ) number = 'None' if number is None else number label = 'None' if label is None else label # Sphinx >= 1.5 has number="" clause in parameters number_part = ' number="{}"'.format(number) if SPHINX_ge_1p5 else '' u_prefix = '' if PY3 or SPHINX_ge_1p7 else 'u' id_part = '' if ids is None else """ids="[{}'{}']" """.format( u_prefix, ids) return ( ''.format( name, id_part, label, latex, number_part) ) EXP_PLOT_AND_MATH = ( 'Plot directive with mathcode\n' 'Some text\n' r'a = 101\n' '\n' '\n' '\n' 'More text\n' + format_math_block('plot_and_math', '101')) class TestPlotDirective(PageBuilder): # Test build and output of custom_plotdirective project page_source_template = PAGES def test_plot_and_math(self): doctree = self.get_doctree('plot_and_math') assert len(doctree.document) == 1 tree_str = self.doctree2str(doctree) assert re.compile(EXP_PLOT_AND_MATH).search(tree_str) class TestTopPlotDirective(TestPlotDirective): # Test we can import mathcode with just `texext` @classmethod def modify_source(cls): conf_fname = pjoin(cls.page_source, 'conf.py') with open(conf_fname, 'rt') as fobj: contents = fobj.read() contents = contents.replace("'texext.mathcode'", "'texext'") with open(conf_fname, 'wt') as fobj: fobj.write(contents) texext-0.6.1/texext/tests/__init__.py0000644000076500000240000000004112606054603017577 0ustar mb312staff00000000000000# Make tests directory a package texext-0.6.1/texext/tests/tinypages/0000755000076500000240000000000013337306262017501 5ustar mb312staff00000000000000texext-0.6.1/texext/tests/tinypages/index.rst0000644000076500000240000000067512606052612021345 0ustar mb312staff00000000000000.. tinypages documentation master file, created by sphinx-quickstart on Tue Mar 18 11:58:34 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to tinypages's documentation! ===================================== Contents: .. toctree:: :maxdepth: 2 some_math Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` texext-0.6.1/texext/tests/tinypages/conf.py0000644000076500000240000002045712606054343021006 0ustar mb312staff00000000000000# -*- coding: utf-8 -*- # # tinypages documentation build configuration file, created by # sphinx-quickstart on Tue Mar 18 11:58:34 2014. # # 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 from os.path import join as pjoin, abspath import sphinx from distutils.version import LooseVersion # 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('.')) sys.path.insert(0, abspath(pjoin('..', '..'))) # -- 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.mathjax', 'texext.mathcode', 'texext.math_dollar'] # 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'tinypages' copyright = u'2015, Matthew Brett' # 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 = '0.1' # The full version, including alpha/beta/rc tags. release = '0.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 = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. if LooseVersion(sphinx.__version__) >= LooseVersion('1.3'): html_theme = 'classic' else: 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 # " v 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'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # 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 # 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 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 = 'tinypagesdoc' # -- 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, or own class]). latex_documents = [ ('index', 'tinypages.tex', u'tinypages Documentation', u'Matplotlib developers', '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', 'tinypages', u'tinypages Documentation', [u'Matplotlib developers'], 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', 'tinypages', u'tinypages Documentation', u'Matplotlib developers', 'tinypages', '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' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False texext-0.6.1/texext/tests/tinypages/_static/0000755000076500000240000000000013337306262021127 5ustar mb312staff00000000000000texext-0.6.1/texext/tests/tinypages/_static/README.txt0000644000076500000240000000045712606042167022632 0ustar mb312staff00000000000000############################## Static directory for tinypages ############################## We need this README file to make sure the ``_static`` directory gets created in the installation. The tests check for warnings in builds, and, when the ``_static`` directory is absent, this raises a warning. texext-0.6.1/texext/tests/tinypages/some_math.rst0000644000076500000240000000140013032716005022172 0ustar mb312staff00000000000000######### Some math ######### Here $a = 1$, except `$b = 2$`. Here $c = 3$, except ``$d = 4$``. :: Here $e = 5$ * A list item containing $f = 6$ some mathematics. * A list item containing ``a literal across lines`` and also $g = 7$ some mathematics. .. mathcode:: import sympy a, b, foo = sympy.symbols('a, b, q') a * 10 + 2 * b + foo More text .. mathcode:: :label: some-label a * 5 + 3 * b Yet more text .. mathcode:: :newcontext: import sympy foo, b = sympy.symbols('w, x') foo * 5 + 3 * b Math with $\beta$ a backslash. A protected white\ space with $dollars$. Some \* asterisks \*. $dollars$. A line \ break. Protected \\ backslash. Protected \n in $a$ line. Refers to equation at :eq:`some-label`. texext-0.6.1/texext/tests/test_mathdollar.py0000644000076500000240000000616413274103243021237 0ustar mb312staff00000000000000""" Testing math_dollar module """ from ..math_dollar import d2m_source, rst_dollars_to_math def source_shim(in_str): # Shim to return source, so testing a bit more convenient source = [in_str] d2m_source(source) return "\n".join(source) def test_dollars_to_math(): # Simple inline math d2m = rst_dollars_to_math # For a few simple inputs, test list and string versions for f in (source_shim, d2m): assert f('Here be $a = b$ math') == 'Here be :math:`a = b` math' assert f('Here be $a =\nb$ math') == 'Here be :math:`a =\nb` math' # Dollars inside backticks don't get replaced assert d2m('Here be `$a = b$` math') == 'Here be `$a = b$` math' assert d2m('Here be ``$a = b$`` math') == 'Here be ``$a = b$`` math' assert d2m('Here `$a = b$` and `$c$`') == 'Here `$a = b$` and `$c$`' # In general this is because dollars before or after backticks stay same assert d2m('Here be `$a = b` math') == 'Here be `$a = b` math' assert d2m('Here be `a = b$` math') == 'Here be `a = b$` math' # And in general that's because everything between backticks stays the same assert d2m('Such as ``$1 $2 $3`` etc') == 'Such as ``$1 $2 $3`` etc' assert d2m('Such as `$1 $2 $3` etc') == 'Such as `$1 $2 $3` etc' # Can mix with and without backticks assert d2m('Here `$a$` and $c$') == 'Here `$a$` and :math:`c`' # Dollars inside curlies don't get replaced assert (d2m(r'Now $f(n) = 0 \text{ if $n$ is prime}$ then') == r'Now :math:`f(n) = 0 \text{ if $n$ is prime}` then') # We do now mathize dollars on lines with indents assert d2m(' $env$') == ' :math:`env`' assert d2m('::\n $env\n $var') == '::\n :math:`env\n `var' assert (d2m('::\n $env$\n\nHere $b$ there') == '::\n :math:`env`\n\nHere :math:`b` there') assert (d2m('and some `$real dollars`. More ``$real dollars``.') == 'and some `$real dollars`. More ``$real dollars``.') assert (d2m('\n\nSome $math dollars$. More $math dollars$.\n') == '\n\nSome :math:`math dollars`. More :math:`math dollars`.\n') # Lots of backticks in a heading assert (d2m( '\nWord\n\nHeading\n```````\nMore ``stuff`` here') == '\nWord\n\nHeading\n```````\nMore ``stuff`` here') mysterious_problem="""\ Some text short ``````````````` :: a b c d ``$H`` """ assert d2m(mysterious_problem) == mysterious_problem # Test case where text with markers may be substituted with another marker. # This depends on dictionary ordering, so will only sometimes catch errors. assert (d2m( 'She `is in ``her own`` new ``world``, always` leaving') == 'She `is in ``her own`` new ``world``, always` leaving') assert (d2m( "* A list item containing\n $f = 6$ some mathematics.") == "* A list item containing\n :math:`f = 6` some mathematics.") assert (d2m( "* A list item containing ``a literal across\n lines`` and also " "$g = 7$ some mathematics.") == "* A list item containing ``a literal across\n lines`` and also " ":math:`g = 7` some mathematics.") texext-0.6.1/texext/tests/test_custom_plotcontext.py0000644000076500000240000000135313337244745023075 0ustar mb312staff00000000000000""" Tests for plotcontext build using sphinx extensions Test ability to combine plot_context with mathcode """ from os.path import join as pjoin from .test_custom_plotdirective import TestCustomPlotDirective class TestPlotContext(TestCustomPlotDirective): # Test build and output of custom_plotcontext project @classmethod def modify_pages(cls): conf_fname = pjoin(cls.page_source, 'conf.py') with open(conf_fname, 'rt') as fobj: contents = fobj.read() contents = contents.replace( "'matplotlib.sphinxext.plot_directive'", '"plot_directive"') contents += """ # Use mpl plot_context mathcode_plot_context = 'matplotlib.sphinxext.plot_directive.plot_context' """ texext-0.6.1/texext/tests/test_docstrings.py0000644000076500000240000000543613274104316021272 0ustar mb312staff00000000000000""" Test building of docstrings into pages with autodoc """ import re from sphinxtesters import SourcesBuilder # Utilities for debugging # py.test texext/tests/test_docstrings.py --pdb # write_file(html) # IPython: run texext/tests/test_docstrings.py # check_re('some_regexp_pattern') def write_file(contents, fname='.html.txt'): with open(fname, 'wt') as fobj: fobj.write(contents) def read_file(fname='.html.txt'): with open(fname, 'rt') as fobj: contents = fobj.read() return contents def check_re(pattern, text=None): text = read_file() if text is None else text full_pattern = pattern.format(**FRAGMENTS) return re.search(full_pattern, text) # Docstring build regexp # sphinx 1.1.3 has for # sphinx 1.7b0 has "math notranslate" for "math" FRAGMENTS = dict(code=r'(code|tt)', cclass=r'"(docutils literal( notranslate)?)"', math=r'"math( notranslate)?( nohighlight)?"') DOCSTRING_RE = re.compile( r'

Here is the module docstring:

\n' r'' r'

A module to test docstring parsing with math such as ' r'\\\(\\gamma = \\cos\(\\alpha\)\\\)

\n' r'

Need to test other markup - so: ' r'a link\.

\n' r'

Here is the <{code} class={cclass}>' r'func docstring:

\n' r'
\n' r'
\n' r'<{code} class="descclassname">texext.tests.for_docstrings\.' r'' r'<{code} class="descname">func' '(' # beginning of regexp group r'\(\)' '|' r'\(\)' # sphinx 1.1.3 ')' # end of regexp group r'.+
\n' r'

A docstring with math in first line ' r'\\\(z = \\beta\\\)

\n' r'

With some more \\\(a = 1\\\) math\. ' r'Math across lines - \\\(b\n' r'= 2\\\)\.

\n' r'

Further, there is a link and a substituted\.

\n' '
'.format(**FRAGMENTS)) class TestDocstrings(SourcesBuilder): rst_sources = dict(a_page="""\ Here is the module docstring: .. automodule:: texext.tests.for_docstrings Here is the ``func`` docstring: .. autofunction:: texext.tests.for_docstrings.func """) conf_source = """\ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'texext.math_dollar'] """ def test_docstrings(self): html = self.get_built_file('a_page.html') assert DOCSTRING_RE.search(html) texext-0.6.1/texext/tests/plotdirective/0000755000076500000240000000000013337306262020353 5ustar mb312staff00000000000000texext-0.6.1/texext/tests/plotdirective/index.rst0000644000076500000240000000070112606776332022221 0ustar mb312staff00000000000000.. tinypages documentation master file, created by sphinx-quickstart on Tue Mar 18 11:58:34 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to tinypages's documentation! ===================================== Contents: .. toctree:: :maxdepth: 2 plot_and_math Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` texext-0.6.1/texext/tests/plotdirective/conf.py0000644000076500000240000002074312607001121021641 0ustar mb312staff00000000000000# -*- coding: utf-8 -*- # # plotdirective documentation build configuration file, created by # sphinx-quickstart on Tue Mar 18 11:58:34 2014. # # 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 from os.path import join as pjoin, abspath import sphinx from distutils.version import LooseVersion # 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('.')) sys.path.insert(0, abspath(pjoin('..', '..'))) # -- 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.mathjax', 'matplotlib.sphinxext.plot_directive', 'texext.mathcode'] # 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'plotdirective' copyright = u'2015, Matthew Brett' # 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 = '0.1' # The full version, including alpha/beta/rc tags. release = '0.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 = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. if LooseVersion(sphinx.__version__) >= LooseVersion('1.3'): html_theme = 'classic' else: 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 # " v 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'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # 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 # 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 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 = 'plotdirectivedoc' # -- 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, or own class]). latex_documents = [ ('index', 'plotdirective.tex', u'plotdirective Documentation', u'Matplotlib developers', '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', 'plotdirective', u'plotdirective Documentation', [u'Matplotlib developers'], 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', 'plotdirective', u'plotdirective Documentation', u'Matplotlib developers', 'plotdirective', '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' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # config of plot_directive plot_html_show_source_link = False # Config of mathcode directive mathcode_use_plot_ns = True texext-0.6.1/texext/tests/plotdirective/_static/0000755000076500000240000000000013337306262022001 5ustar mb312staff00000000000000texext-0.6.1/texext/tests/plotdirective/_static/README.txt0000644000076500000240000000045712606770476023517 0ustar mb312staff00000000000000############################## Static directory for tinypages ############################## We need this README file to make sure the ``_static`` directory gets created in the installation. The tests check for warnings in builds, and, when the ``_static`` directory is absent, this raises a warning. texext-0.6.1/texext/tests/plotdirective/plot_and_math.rst0000644000076500000240000000032012607001244023700 0ustar mb312staff00000000000000############################ Plot directive with mathcode ############################ Some text .. plot:: :context: :nofigs: :include-source: true a = 101 More text .. mathcode:: a texext-0.6.1/texext/tests/for_docstrings.py0000644000076500000240000000065413144351423021075 0ustar mb312staff00000000000000r""" A module to test docstring parsing with math such as $\gamma = \cos(\alpha)$ Need to test other markup - so: `a link `_. """ def func(): r""" A docstring with math in first line $z = \beta$ With some more $a = 1$ math. Math across lines - $b = 2$. Further, there is a link_ and a |substitution|. .. _link: https://python.org .. |substitution| replace:: substituted """ texext-0.6.1/texext/tests/test_custom_plotdirective.py0000644000076500000240000000254613337245326023370 0ustar mb312staff00000000000000""" Tests for plotdirective build using sphinx extensions Test ability to combine plot_directive with mathcode """ from os.path import dirname, join as pjoin import re import sphinx SPHINX_1p8 = sphinx.version_info[:2] >= (1, 8) from sphinxtesters import PageBuilder from texext.tests.test_plotdirective import EXP_PLOT_AND_MATH PAGES = pjoin(dirname(__file__), 'plotdirective') class TestCustomPlotDirective(PageBuilder): # Test build and output of custom_plotdirective project page_source_template = PAGES @classmethod def modify_pages(cls): conf_fname = pjoin(cls.page_source, 'conf.py') with open(conf_fname, 'rt') as fobj: contents = fobj.read() contents = contents.replace( "'matplotlib.sphinxext.plot_directive'", '"plot_directive"') contents += """ < # Use custom plot_directive < sys.path.insert(0, abspath(pjoin('.'))) < import plot_directive < mathcode_plot_directive = plot_directive """ with open(conf_fname, 'wt') as fobj: fobj.write(contents) def test_plot_and_math(self): doctree = self.get_doctree('plot_and_math') assert len(doctree.document) == 1 tree_str = self.doctree2str(doctree) # Sphinx by 1.3 adds "highlight_args={}", Sphinx at 1.1.3 does not assert re.compile(EXP_PLOT_AND_MATH).search(tree_str) texext-0.6.1/texext/tests/test_tinypages.py0000644000076500000240000000753713337277410021130 0ustar mb312staff00000000000000""" Tests for tinypages build using sphinx extensions """ from os.path import (join as pjoin, dirname, isdir) import sphinx SPHINX_ge_1p5 = sphinx.version_info[:2] >= (1, 5) from sphinxtesters import PageBuilder HERE = dirname(__file__) PAGES = pjoin(HERE, 'tinypages') from texext.tests.test_plotdirective import format_math_block def _pdiff(str1, str2): # For debugging from difflib import ndiff print(''.join(ndiff(str1.splitlines(True), str2.splitlines(True)))) class TestTinyPages(PageBuilder): # Test build and output of tinypages project page_source_template = PAGES def test_some_math(self): assert isdir(self.out_dir) assert isdir(self.doctree_dir) doctree = self.get_doctree('some_math') assert len(doctree.document) == 1 tree_str = self.doctree2str(doctree) if SPHINX_ge_1p5: back_ref = ( 'Refers to equation at ' '' 'some-label' '') else: back_ref=( 'Refers to equation at ' '(?)') expected = ( 'Some math\n' 'Here , except ' '$b = 2$.\n' 'Here , except ' '$d = 4$.\n' '' 'Here $e = 5$\n' '' '' '' 'A list item containing\n' ' some mathematics.' '' '' '' '' 'A list item containing ' 'a literal across\nlines ' 'and also some mathematics.' '' '' '\n' + format_math_block('some_math', "10 a + 2 b + q") + '\nMore text\n' '\n' + format_math_block( 'some_math', "5 a + 3 b", label='some-label', number='1', ids='equation-some-label') + '\nYet more text\n' + format_math_block( "some_math", latex="5 w + 3 x") + '\n' + r'Math with a backslash.' '\n' '' # What happens to backslashes? 'A protected whitespace with .' '\n' '' 'Some * asterisks *. . ' 'A line break. Protected \ backslash. ' 'Protected n in line.\n' # Do labels get set as targets? + back_ref + '.') assert tree_str == expected class TestTopLevel(TestTinyPages): # Test we can import math_dollar with just `texext` @classmethod def modify_source(cls): conf_fname = pjoin(cls.page_source, 'conf.py') with open(conf_fname, 'rt') as fobj: contents = fobj.read() contents = contents.replace("'texext.mathcode',\n", "") contents = contents.replace("'texext.math_dollar'", "'texext'") with open(conf_fname, 'wt') as fobj: fobj.write(contents) texext-0.6.1/texext/__init__.py0000644000076500000240000000035313274077677016465 0ustar mb312staff00000000000000""" Texext package """ from . import math_dollar from . import mathcode from ._version import get_versions __version__ = get_versions()['version'] del get_versions def setup(app): math_dollar.setup(app) mathcode.setup(app) texext-0.6.1/texext/math_dollar.py0000644000076500000240000001614213144351032017167 0ustar mb312staff00000000000000# emacs: -*- mode: python-mode; py-indent-offset: 4; indent-tabs-mode: nil -*- # vi: set ft=python sts=4 ts=4 sw=4 et: ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ## # # See LICENSE file distributed along with the texext package for the # copyright and license terms. # ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ## """ Sphinx source processor to replace $a=b$ with :math:`a=b` """ from warnings import warn import re from functools import partial from docutils import nodes from docutils.utils import escape2null, unescape from docutils.transforms import Transform from sphinx.errors import ExtensionError from sphinx.ext.mathbase import math def d2m_source(source): r""" Replace dollar signs with :math:`` within strings in `source` list See: :func:`rst_dollars_to_math` for details. Parameters ---------- source : sequence of str Sequence of strings, usually read from a ReST source file. `source` modified in place. """ s = "\n".join(source) source[:] = rst_dollars_to_math(s).split("\n") class StringProtector(object): """ Replace / restore text in regexp groups with markers. Replace identified text with markers using ``obj.protect(in_str)`` Restore replaced text in place of markers with ``obj.restore(in_str)`` """ def __init__(self, regexps): self.regexps = tuple(re.compile(r) for r in regexps) self._marker_contents = [] # Marker unique to this instance self._marker_fmt = "___XXX_REPL_{:d}_{{:d}}___".format(id(self)) def _repl(self, matchobj): content = matchobj.group(0) marker_contents = self._marker_contents marker = self._marker_fmt.format(len(marker_contents)) marker_contents.append((marker, content)) return marker def protect(self, in_str): out_str = in_str for regexp in self.regexps: out_str = regexp.sub(self._repl, out_str) return out_str def restore(self, in_str): # Change everything back that we pulled out # Put back in reverse order of removal. out_str = in_str for marker, content in self._marker_contents[::-1]: out_str = out_str.replace(marker, content) self._marker_contents = [] return out_str def __add__(self, other): return self.__class__(self.regexps + other.regexps) in_dollars_protector = StringProtector( ( # This searches for "$blah$" inside a pair of curly braces -- # don't change these, since they're probably coming from a nested # math environment. So for each match, we replace it with a temporary # string, and later on we substitute the original back. re.compile(r"({[^{}$]*\$[^{}$]*\$[^{}]*})"), ) ) rst_protector = StringProtector( ( # Line entirely containing backticks ending with optional whitespace # These happen in unusual heading underlines re.compile(r"^(`+\s*)$", flags=re.MULTILINE), # Anything between double backticks re.compile(r"(``[^`]*?``)"), # Anything between single backticks re.compile(r"(`[^`]*?`)"), ) ) + in_dollars_protector def rst_dollars_to_math(rst_str, protector=rst_protector, dollar_repl=r":math:`\1`"): """ Replace dollar signs with backticks in string `rst_str` More precisely, do a regular expression search. Replace a plain dollar sign ($) by a backtick (`). Replace an escaped dollar sign (\$) by a dollar sign ($). Don't change a dollar sign preceded or followed by a backtick (`$ or $`), because of strings like "``$HOME``". Don't make any changes on lines starting with spaces, because those are indented and hence part of a block of code or examples. This also does not replace dollar signs enclosed in curly braces, to avoid nested math environments, such as:: $f(n) = 0 \text{ if $n$ is prime}$ Thus the above line would get changed to `f(n) = 0 \text{ if $n$ is prime}` Parameters ---------- rst_str : str String, usually read from a ReST source file. protector : :class:`StringProtector` instance Object defining which regexps should be protected from dollar replacement. Default is module global ``rst_protector`` instance. dollar_repl : string or callable Replacement expression for found text between (and including) dollars. Returns ------- out_str : str Possibly modified string after replacing math dollar markers. """ if rst_str.find("$") == -1: return rst_str out_str = protector.protect(rst_str) # matches $...$ dollars = re.compile(r"(?', 'exec') last_line = mod.body.pop() if isinstance(mod.body[-1], Expr) else None to_exec = compile(mod, '', 'exec') exec_(to_exec, None, context) if last_line is None: return None to_eval = compile(Expression(last_line.value), '', 'eval') return eval(to_eval, None, context) class MathCodeDirective(MathDirective): """ Generate math environment from Sympy math expressions """ optional_arguments = 0 option_spec = { 'label': directives.unchanged, 'name': directives.unchanged, 'nowrap': directives.flag, 'newcontext': directives.flag, } def get_plot_directive(self): plot_directive = setup.config.mathcode_plot_directive if plot_directive is None: return None warnings.warn("mathcode_plot_directive deprecated; " "please use mathcode_plot_context instead", FutureWarning) return plot_directive def get_plot_context(self): # First try mathcode_plot_context dictionary plot_context = setup.config.mathcode_plot_context if plot_context is not None: # Plot context is a string naming a module attribute parts = plot_context.split('.') mod_name, el_name = '.'.join(parts[:-1]), parts[-1] mod = __import__(mod_name, globals(), locals(), el_name) return getattr(mod, el_name) # Next try getting dictionary from deprecated mathcode_plot_directive plot_directive = self.get_plot_directive() if plot_directive is not None: return plot_directive.plot_context # Default to matplotlib plot_context dictionary from matplotlib.sphinxext.plot_directive import plot_context return plot_context def get_context(self, newcontext=False): if setup.config.mathcode_use_plot_ns: plot_context = self.get_plot_context() else: plot_context = setup.code_context if newcontext: plot_context.clear() return plot_context def run(self): # Avoid depending on sympy unless running mathcode directive from sympy import latex want_new = True if 'newcontext' in self.options else False context = self.get_context(want_new) val = eval_code('\n'.join(self.content), context) if val is None: return [] self.content = latex(val).splitlines() return super(MathCodeDirective, self).run() def setup(app): # Global variables setup.app = app setup.config = app.config setup.confdir = app.confdir # Workspace for code run in Mathcode blocks setup.code_context = dict() app.add_directive('mathcode', MathCodeDirective) app.add_config_value('mathcode_use_plot_ns', False, 'env') app.add_config_value('mathcode_plot_context', None, 'env') # mathcode_plot_directive deprecated; prefer mathcode_plot_context app.add_config_value('mathcode_plot_directive', None, 'env') texext-0.6.1/LICENSE0000644000076500000240000000404413274146731014025 0ustar mb312staff00000000000000.. _license: ********************** Copyright and Licenses ********************** texext ====== The texext package, including all examples, code snippets and attached documentation is covered by the 2-clause BSD license. Copyright (c) 2015-2018, Ondřej Čertík, Matthew Brett All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3rd party code and data ======================= Some code distributed within the texext sources was developed by other projects. This code is distributed under its respective licenses that are listed below. Sphinx mathbase extension ------------------------- The mathcode directive is based on sphinx/ext/mathbase.py. That file has license: :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. texext-0.6.1/setup.py0000755000076500000240000000436313337266702014542 0ustar mb312staff00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- ''' Installation script for texext package ''' import sys # For some commands, use setuptools. if len(set(('develop', 'bdist_egg', 'bdist_rpm', 'bdist', 'bdist_dumb', 'install_egg_info', 'egg_info', 'easy_install', 'bdist_wheel', 'bdist_mpkg')).intersection(sys.argv)) > 0: import setuptools from distutils.core import setup import versioneer extra_setup_kwargs = ({} if 'setuptools' not in sys.modules else dict(install_requires=['six', 'sphinx>=1.3.1'])) setup(name='texext', version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), description='Sphinx extensions for working with LaTeX math', author='Ondřej Čertík, Matthew Brett', author_email='matthew.brett@gmail.com', maintainer='Matthew Brett, Ondřej Čertík', maintainer_email='matthew.brett@gmail.com', url='http://github.com/matthew-brett/texext', packages=['texext', 'texext.tests'], package_data = {'texext': [ 'tests/tinypages/*.rst', 'tests/tinypages/*.py', 'tests/tinypages/_static/*', 'tests/plotdirective/*.rst', 'tests/plotdirective/*.py', 'tests/plotdirective/_static/*', 'tests/custom_plotcontext/*.rst', 'tests/custom_plotcontext/*.py', 'tests/custom_plotcontext/_static/*', 'tests/custom_plotdirective/*.rst', 'tests/custom_plotdirective/*.py', 'tests/custom_plotdirective/_static/*']}, license='BSD license', classifiers = [ 'Development Status :: 4 - Beta', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: Science/Research', 'License :: OSI Approved :: BSD License', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Topic :: Scientific/Engineering', 'Operating System :: Microsoft :: Windows', 'Operating System :: POSIX', 'Operating System :: Unix', 'Operating System :: MacOS', ], long_description = open('README.rst', 'rt').read(), **extra_setup_kwargs ) texext-0.6.1/doc/0000755000076500000240000000000013337306262013560 5ustar mb312staff00000000000000texext-0.6.1/doc/devel/0000755000076500000240000000000013337306262014657 5ustar mb312staff00000000000000texext-0.6.1/doc/devel/make_release.rst0000644000076500000240000000406613274147074020040 0ustar mb312staff00000000000000################ Releasing texext ################ * Review the open list of `texext issues`_. Check whether there are outstanding issues that can be closed, and whether there are any issues that should delay the release. Label them. * Review and update the release notes. Review and update the :file:`Changelog` file. Get a partial list of contributors with something like:: git log 0.2.0.. | grep '^Author' | cut -d' ' -f 2- | sort | uniq where ``0.2.0`` was the last release tag name. Then manually go over ``git shortlog 0.2.0..`` to make sure the release notes are as complete as possible and that every contributor was recognized. * Use the opportunity to update the ``.mailmap`` file if there are any duplicate authors listed from ``git shortlog -ns``. * Check the copyright years in ``doc/conf.py`` and ``LICENSE`` * Check the output of:: rst2html.py README.rst > ~/tmp/readme.html because this will be the output used by pypi_ * Check `texext travis-ci`_. * Once everything looks good, you are ready to upload the source release to PyPi. See `setuptools intro`_. Make sure you have a file ``\$HOME/.pypirc``, of form:: [distutils] index-servers = pypi [pypi] username:your.pypi.username password:your-password [server-login] username:your.pypi.username password:your-password * Now tag the release. This will also set the version (we are using versioneer_ to manage versions via git tags). The ``-s`` flag below makes a signed tag:: git tag -s 0.3 * Now you can upload the source release to PyPi. See `setuptools intro`_:: git clean -fxd python setup.py sdist --formats=zip twine upload -s dist/texext*.zip * Upload the release commit and tag to github:: git push git push --tags .. _texext travis-ci: https://travis-ci.org/matthew-brett/texext .. _texext isses: https://github.com/matthew-brett/texext/issues .. _versioneer: https://github.com/warner/python-versioneer .. _setuptools intro: http://packages.python.org/an_example_pypi_project/setuptools.html texext-0.6.1/setup.cfg0000644000076500000240000000051212606037216014630 0ustar mb312staff00000000000000 # See the docstring in versioneer.py for instructions. Note that you must # re-run 'versioneer.py setup' after changing this section, and commit the # resulting files. [versioneer] VCS = git style = pep440 versionfile_source = texext/_version.py versionfile_build = texext/_version.py tag_prefix = "" parentdir_prefix = texext- texext-0.6.1/versioneer.py0000644000076500000240000020575313031676115015560 0ustar mb312staff00000000000000 # Version: 0.17 """The Versioneer - like a rocketeer, but for versions. The Versioneer ============== * like a rocketeer, but for versions! * https://github.com/warner/python-versioneer * Brian Warner * License: Public Domain * Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, and pypy * [![Latest Version] (https://pypip.in/version/versioneer/badge.svg?style=flat) ](https://pypi.python.org/pypi/versioneer/) * [![Build Status] (https://travis-ci.org/warner/python-versioneer.png?branch=master) ](https://travis-ci.org/warner/python-versioneer) This is a tool for managing a recorded version number in distutils-based python projects. The goal is to remove the tedious and error-prone "update the embedded version string" step from your release process. Making a new release should be as easy as recording a new tag in your version-control system, and maybe making new tarballs. ## Quick Install * `pip install versioneer` to somewhere to your $PATH * add a `[versioneer]` section to your setup.cfg (see below) * run `versioneer install` in your source tree, commit the results ## Version Identifiers Source trees come from a variety of places: * a version-control system checkout (mostly used by developers) * a nightly tarball, produced by build automation * a snapshot tarball, produced by a web-based VCS browser, like github's "tarball from tag" feature * a release tarball, produced by "setup.py sdist", distributed through PyPI Within each source tree, the version identifier (either a string or a number, this tool is format-agnostic) can come from a variety of places: * ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows about recent "tags" and an absolute revision-id * the name of the directory into which the tarball was unpacked * an expanded VCS keyword ($Id$, etc) * a `_version.py` created by some earlier build step For released software, the version identifier is closely related to a VCS tag. Some projects use tag names that include more than just the version string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool needs to strip the tag prefix to extract the version identifier. For unreleased software (between tags), the version identifier should provide enough information to help developers recreate the same tree, while also giving them an idea of roughly how old the tree is (after version 1.2, before version 1.3). Many VCS systems can report a description that captures this, for example `git describe --tags --dirty --always` reports things like "0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the 0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has uncommitted changes. The version identifier is used for multiple purposes: * to allow the module to self-identify its version: `myproject.__version__` * to choose a name and prefix for a 'setup.py sdist' tarball ## Theory of Operation Versioneer works by adding a special `_version.py` file into your source tree, where your `__init__.py` can import it. This `_version.py` knows how to dynamically ask the VCS tool for version information at import time. `_version.py` also contains `$Revision$` markers, and the installation process marks `_version.py` to have this marker rewritten with a tag name during the `git archive` command. As a result, generated tarballs will contain enough information to get the proper version. To allow `setup.py` to compute a version too, a `versioneer.py` is added to the top level of your source tree, next to `setup.py` and the `setup.cfg` that configures it. This overrides several distutils/setuptools commands to compute the version when invoked, and changes `setup.py build` and `setup.py sdist` to replace `_version.py` with a small static file that contains just the generated version data. ## Installation See [INSTALL.md](./INSTALL.md) for detailed installation instructions. ## Version-String Flavors Code which uses Versioneer can learn about its version string at runtime by importing `_version` from your main `__init__.py` file and running the `get_versions()` function. From the "outside" (e.g. in `setup.py`), you can import the top-level `versioneer.py` and run `get_versions()`. Both functions return a dictionary with different flavors of version information: * `['version']`: A condensed version string, rendered using the selected style. This is the most commonly used value for the project's version string. The default "pep440" style yields strings like `0.11`, `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section below for alternative styles. * `['full-revisionid']`: detailed revision identifier. For Git, this is the full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". * `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the commit date in ISO 8601 format. This will be None if the date is not available. * `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that this is only accurate if run in a VCS checkout, otherwise it is likely to be False or None * `['error']`: if the version string could not be computed, this will be set to a string describing the problem, otherwise it will be None. It may be useful to throw an exception in setup.py if this is set, to avoid e.g. creating tarballs with a version string of "unknown". Some variants are more useful than others. Including `full-revisionid` in a bug report should allow developers to reconstruct the exact code being tested (or indicate the presence of local changes that should be shared with the developers). `version` is suitable for display in an "about" box or a CLI `--version` output: it can be easily compared against release notes and lists of bugs fixed in various releases. The installer adds the following text to your `__init__.py` to place a basic version in `YOURPROJECT.__version__`: from ._version import get_versions __version__ = get_versions()['version'] del get_versions ## Styles The setup.cfg `style=` configuration controls how the VCS information is rendered into a version string. The default style, "pep440", produces a PEP440-compliant string, equal to the un-prefixed tag name for actual releases, and containing an additional "local version" section with more detail for in-between builds. For Git, this is TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags --dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and that this commit is two revisions ("+2") beyond the "0.11" tag. For released software (exactly equal to a known tag), the identifier will only contain the stripped tag, e.g. "0.11". Other styles are available. See details.md in the Versioneer source tree for descriptions. ## Debugging Versioneer tries to avoid fatal errors: if something goes wrong, it will tend to return a version of "0+unknown". To investigate the problem, run `setup.py version`, which will run the version-lookup code in a verbose mode, and will display the full contents of `get_versions()` (including the `error` string, which may help identify what went wrong). ## Known Limitations Some situations are known to cause problems for Versioneer. This details the most significant ones. More can be found on Github [issues page](https://github.com/warner/python-versioneer/issues). ### Subprojects Versioneer has limited support for source trees in which `setup.py` is not in the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are two common reasons why `setup.py` might not be in the root: * Source trees which contain multiple subprojects, such as [Buildbot](https://github.com/buildbot/buildbot), which contains both "master" and "slave" subprojects, each with their own `setup.py`, `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI distributions (and upload multiple independently-installable tarballs). * Source trees whose main purpose is to contain a C library, but which also provide bindings to Python (and perhaps other langauges) in subdirectories. Versioneer will look for `.git` in parent directories, and most operations should get the right version string. However `pip` and `setuptools` have bugs and implementation details which frequently cause `pip install .` from a subproject directory to fail to find a correct version string (so it usually defaults to `0+unknown`). `pip install --editable .` should work correctly. `setup.py install` might work too. Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in some later version. [Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking this issue. The discussion in [PR #61](https://github.com/warner/python-versioneer/pull/61) describes the issue from the Versioneer side in more detail. [pip PR#3176](https://github.com/pypa/pip/pull/3176) and [pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve pip to let Versioneer work correctly. Versioneer-0.16 and earlier only looked for a `.git` directory next to the `setup.cfg`, so subprojects were completely unsupported with those releases. ### Editable installs with setuptools <= 18.5 `setup.py develop` and `pip install --editable .` allow you to install a project into a virtualenv once, then continue editing the source code (and test) without re-installing after every change. "Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a convenient way to specify executable scripts that should be installed along with the python package. These both work as expected when using modern setuptools. When using setuptools-18.5 or earlier, however, certain operations will cause `pkg_resources.DistributionNotFound` errors when running the entrypoint script, which must be resolved by re-installing the package. This happens when the install happens with one version, then the egg_info data is regenerated while a different version is checked out. Many setup.py commands cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into a different virtualenv), so this can be surprising. [Bug #83](https://github.com/warner/python-versioneer/issues/83) describes this one, but upgrading to a newer version of setuptools should probably resolve it. ### Unicode version strings While Versioneer works (and is continually tested) with both Python 2 and Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. Newer releases probably generate unicode version strings on py2. It's not clear that this is wrong, but it may be surprising for applications when then write these strings to a network connection or include them in bytes-oriented APIs like cryptographic checksums. [Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates this question. ## Updating Versioneer To upgrade your project to a new release of Versioneer, do the following: * install the new Versioneer (`pip install -U versioneer` or equivalent) * edit `setup.cfg`, if necessary, to include any new configuration settings indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. * re-run `versioneer install` in your source tree, to replace `SRC/_version.py` * commit any changed files ## Future Directions This tool is designed to make it easily extended to other version-control systems: all VCS-specific components are in separate directories like src/git/ . The top-level `versioneer.py` script is assembled from these components by running make-versioneer.py . In the future, make-versioneer.py will take a VCS name as an argument, and will construct a version of `versioneer.py` that is specific to the given VCS. It might also take the configuration arguments that are currently provided manually during installation by editing setup.py . Alternatively, it might go the other direction and include code from all supported VCS systems, reducing the number of intermediate scripts. ## License To make Versioneer easier to embed, all its code is dedicated to the public domain. The `_version.py` that it creates is also in the public domain. Specifically, both are released under the Creative Commons "Public Domain Dedication" license (CC0-1.0), as described in https://creativecommons.org/publicdomain/zero/1.0/ . """ from __future__ import print_function try: import configparser except ImportError: import ConfigParser as configparser import errno import json import os import re import subprocess import sys class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_root(): """Get the project root directory. We require that all commands are run from the project root, i.e. the directory that contains setup.py, setup.cfg, and versioneer.py . """ root = os.path.realpath(os.path.abspath(os.getcwd())) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): # allow 'python path/to/setup.py COMMAND' root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): err = ("Versioneer was unable to run the project root directory. " "Versioneer requires setup.py to be executed from " "its immediate directory (like 'python setup.py COMMAND'), " "or in a way that lets it use sys.argv[0] to find the root " "(like 'python path/to/setup.py COMMAND').") raise VersioneerBadRootError(err) try: # Certain runtime workflows (setup.py install/develop in a setuptools # tree) execute all dependencies in a single python process, so # "versioneer" may be imported multiple times, and python's shared # module-import table will cache the first one. So we can't use # os.path.dirname(__file__), as that will find whichever # versioneer.py was first imported, even in later projects. me = os.path.realpath(os.path.abspath(__file__)) me_dir = os.path.normcase(os.path.splitext(me)[0]) vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) if me_dir != vsr_dir: print("Warning: build in %s is using versioneer.py from %s" % (os.path.dirname(me), versioneer_py)) except NameError: pass return root def get_config_from_root(root): """Read the project setup.cfg file to determine Versioneer config.""" # This might raise EnvironmentError (if setup.cfg is missing), or # configparser.NoSectionError (if it lacks a [versioneer] section), or # configparser.NoOptionError (if it lacks "VCS="). See the docstring at # the top of versioneer.py for instructions on writing your setup.cfg . setup_cfg = os.path.join(root, "setup.cfg") parser = configparser.SafeConfigParser() with open(setup_cfg, "r") as f: parser.readfp(f) VCS = parser.get("versioneer", "VCS") # mandatory def get(parser, name): if parser.has_option("versioneer", name): return parser.get("versioneer", name) return None cfg = VersioneerConfig() cfg.VCS = VCS cfg.style = get(parser, "style") or "" cfg.versionfile_source = get(parser, "versionfile_source") cfg.versionfile_build = get(parser, "versionfile_build") cfg.tag_prefix = get(parser, "tag_prefix") if cfg.tag_prefix in ("''", '""'): cfg.tag_prefix = "" cfg.parentdir_prefix = get(parser, "parentdir_prefix") cfg.verbose = get(parser, "verbose") return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" # these dictionaries contain VCS-specific tools LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, env=env, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %s" % dispcmd) print(e) return None, None else: if verbose: print("unable to find command, tried %s" % (commands,)) return None, None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) print("stdout was %s" % stdout) return None, p.returncode return stdout, p.returncode LONG_VERSION_PY['git'] = ''' # This file helps to compute a version number in source trees obtained from # git-archive tarball (such as those provided by githubs download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. # This file is released into the public domain. Generated by # versioneer-0.17 (https://github.com/warner/python-versioneer) """Git implementation of _version.py.""" import errno import os import re import subprocess import sys def get_keywords(): """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must # each be defined on a line of their own. _version.py will just call # get_keywords(). git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} return keywords class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_config(): """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py cfg = VersioneerConfig() cfg.VCS = "git" cfg.style = "%(STYLE)s" cfg.tag_prefix = "%(TAG_PREFIX)s" cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" cfg.verbose = False return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, env=env, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %%s" %% dispcmd) print(e) return None, None else: if verbose: print("unable to find command, tried %%s" %% (commands,)) return None, None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %%s (error)" %% dispcmd) print("stdout was %%s" %% stdout) return None, p.returncode return stdout, p.returncode def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. We will also support searching up two directory levels for an appropriately named parent directory """ rootdirs = [] for i in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} else: rootdirs.append(root) root = os.path.dirname(root) # up a level if verbose: print("Tried directories %%s but none started with prefix %%s" %% (str(rootdirs), parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) if line.strip().startswith("git_date ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["date"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") date = keywords.get("date") if date is not None: # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 # -like" string, which we must then edit to make compliant), because # it's been around since git-1.5.3, and it's too difficult to # discover which version we're using, or to work around using an # older one. date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = set([r.strip() for r in refnames.strip("()").split(",")]) # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %%d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%%s', no digits" %% ",".join(refs - tags)) if verbose: print("likely tags: %%s" %% ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %%s" %% r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None, "date": date} # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags", "date": None} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True) if rc != 0: if verbose: print("Directory %%s not under git control" %% root) raise NotThisMethod("'git rev-parse --git-dir' returned error") # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%%s*" %% tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%%s'" %% describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%%s' doesn't start with prefix '%%s'" print(fmt %% (full_tag, tag_prefix)) pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" %% (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], cwd=root)[0].strip() pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) return pieces def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%%d" %% pieces["distance"] else: # exception #1 rendered = "0.post.dev%%d" %% pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%%s" %% pieces["short"] else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%%s" %% pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"], "date": None} if not style or style == "default": style = "pep440" # the default if style == "pep440": rendered = render_pep440(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": rendered = render_git_describe(pieces) elif style == "git-describe-long": rendered = render_git_describe_long(pieces) else: raise ValueError("unknown style '%%s'" %% style) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None, "date": pieces.get("date")} def get_versions(): """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which # case we can only use expanded keywords. cfg = get_config() verbose = cfg.verbose try: return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose) except NotThisMethod: pass try: root = os.path.realpath(__file__) # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. for i in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to find root of source tree", "date": None} try: pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) return render(pieces, cfg.style) except NotThisMethod: pass try: if cfg.parentdir_prefix: return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) except NotThisMethod: pass return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version", "date": None} ''' @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) if line.strip().startswith("git_date ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["date"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") date = keywords.get("date") if date is not None: # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 # -like" string, which we must then edit to make compliant), because # it's been around since git-1.5.3, and it's too difficult to # discover which version we're using, or to work around using an # older one. date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = set([r.strip() for r in refnames.strip("()").split(",")]) # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%s', no digits" % ",".join(refs - tags)) if verbose: print("likely tags: %s" % ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %s" % r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None, "date": date} # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags", "date": None} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True) if rc != 0: if verbose: print("Directory %s not under git control" % root) raise NotThisMethod("'git rev-parse --git-dir' returned error") # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%s*" % tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%s' doesn't start with prefix '%s'" print(fmt % (full_tag, tag_prefix)) pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" % (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) return pieces def do_vcs_install(manifest_in, versionfile_source, ipy): """Git-specific installation logic for Versioneer. For Git, this means creating/changing .gitattributes to mark _version.py for export-subst keyword substitution. """ GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] files = [manifest_in, versionfile_source] if ipy: files.append(ipy) try: me = __file__ if me.endswith(".pyc") or me.endswith(".pyo"): me = os.path.splitext(me)[0] + ".py" versioneer_file = os.path.relpath(me) except NameError: versioneer_file = "versioneer.py" files.append(versioneer_file) present = False try: f = open(".gitattributes", "r") for line in f.readlines(): if line.strip().startswith(versionfile_source): if "export-subst" in line.strip().split()[1:]: present = True f.close() except EnvironmentError: pass if not present: f = open(".gitattributes", "a+") f.write("%s export-subst\n" % versionfile_source) f.close() files.append(".gitattributes") run_command(GITS, ["add", "--"] + files) def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. We will also support searching up two directory levels for an appropriately named parent directory """ rootdirs = [] for i in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} else: rootdirs.append(root) root = os.path.dirname(root) # up a level if verbose: print("Tried directories %s but none started with prefix %s" % (str(rootdirs), parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") SHORT_VERSION_PY = """ # This file was generated by 'versioneer.py' (0.17) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. import json version_json = ''' %s ''' # END VERSION_JSON def get_versions(): return json.loads(version_json) """ def versions_from_file(filename): """Try to determine the version from _version.py if present.""" try: with open(filename) as f: contents = f.read() except EnvironmentError: raise NotThisMethod("unable to read _version.py") mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) if not mo: mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) if not mo: raise NotThisMethod("no version_json in _version.py") return json.loads(mo.group(1)) def write_to_version_file(filename, versions): """Write the given version number to the given _version.py file.""" os.unlink(filename) contents = json.dumps(versions, sort_keys=True, indent=1, separators=(",", ": ")) with open(filename, "w") as f: f.write(SHORT_VERSION_PY % contents) print("set %s to '%s'" % (filename, versions["version"])) def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%d" % pieces["distance"] else: # exception #1 rendered = "0.post.dev%d" % pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%s" % pieces["short"] else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%s" % pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"], "date": None} if not style or style == "default": style = "pep440" # the default if style == "pep440": rendered = render_pep440(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": rendered = render_git_describe(pieces) elif style == "git-describe-long": rendered = render_git_describe_long(pieces) else: raise ValueError("unknown style '%s'" % style) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None, "date": pieces.get("date")} class VersioneerBadRootError(Exception): """The project root directory is unknown or missing key files.""" def get_versions(verbose=False): """Get the project version from whatever source is available. Returns dict with two keys: 'version' and 'full'. """ if "versioneer" in sys.modules: # see the discussion in cmdclass.py:get_cmdclass() del sys.modules["versioneer"] root = get_root() cfg = get_config_from_root(root) assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" handlers = HANDLERS.get(cfg.VCS) assert handlers, "unrecognized VCS '%s'" % cfg.VCS verbose = verbose or cfg.verbose assert cfg.versionfile_source is not None, \ "please set versioneer.versionfile_source" assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" versionfile_abs = os.path.join(root, cfg.versionfile_source) # extract version from first of: _version.py, VCS command (e.g. 'git # describe'), parentdir. This is meant to work for developers using a # source checkout, for users of a tarball created by 'setup.py sdist', # and for users of a tarball/zipball created by 'git archive' or github's # download-from-tag feature or the equivalent in other VCSes. get_keywords_f = handlers.get("get_keywords") from_keywords_f = handlers.get("keywords") if get_keywords_f and from_keywords_f: try: keywords = get_keywords_f(versionfile_abs) ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) if verbose: print("got version from expanded keyword %s" % ver) return ver except NotThisMethod: pass try: ver = versions_from_file(versionfile_abs) if verbose: print("got version from file %s %s" % (versionfile_abs, ver)) return ver except NotThisMethod: pass from_vcs_f = handlers.get("pieces_from_vcs") if from_vcs_f: try: pieces = from_vcs_f(cfg.tag_prefix, root, verbose) ver = render(pieces, cfg.style) if verbose: print("got version from VCS %s" % ver) return ver except NotThisMethod: pass try: if cfg.parentdir_prefix: ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) if verbose: print("got version from parentdir %s" % ver) return ver except NotThisMethod: pass if verbose: print("unable to compute version") return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version", "date": None} def get_version(): """Get the short version string for this project.""" return get_versions()["version"] def get_cmdclass(): """Get the custom setuptools/distutils subclasses used by Versioneer.""" if "versioneer" in sys.modules: del sys.modules["versioneer"] # this fixes the "python setup.py develop" case (also 'install' and # 'easy_install .'), in which subdependencies of the main project are # built (using setup.py bdist_egg) in the same python process. Assume # a main project A and a dependency B, which use different versions # of Versioneer. A's setup.py imports A's Versioneer, leaving it in # sys.modules by the time B's setup.py is executed, causing B to run # with the wrong versioneer. Setuptools wraps the sub-dep builds in a # sandbox that restores sys.modules to it's pre-build state, so the # parent is protected against the child's "import versioneer". By # removing ourselves from sys.modules here, before the child build # happens, we protect the child from the parent's versioneer too. # Also see https://github.com/warner/python-versioneer/issues/52 cmds = {} # we add "version" to both distutils and setuptools from distutils.core import Command class cmd_version(Command): description = "report generated version string" user_options = [] boolean_options = [] def initialize_options(self): pass def finalize_options(self): pass def run(self): vers = get_versions(verbose=True) print("Version: %s" % vers["version"]) print(" full-revisionid: %s" % vers.get("full-revisionid")) print(" dirty: %s" % vers.get("dirty")) print(" date: %s" % vers.get("date")) if vers["error"]: print(" error: %s" % vers["error"]) cmds["version"] = cmd_version # we override "build_py" in both distutils and setuptools # # most invocation pathways end up running build_py: # distutils/build -> build_py # distutils/install -> distutils/build ->.. # setuptools/bdist_wheel -> distutils/install ->.. # setuptools/bdist_egg -> distutils/install_lib -> build_py # setuptools/install -> bdist_egg ->.. # setuptools/develop -> ? # pip install: # copies source tree to a tempdir before running egg_info/etc # if .git isn't copied too, 'git describe' will fail # then does setup.py bdist_wheel, or sometimes setup.py install # setup.py egg_info -> ? # we override different "build_py" commands for both environments if "setuptools" in sys.modules: from setuptools.command.build_py import build_py as _build_py else: from distutils.command.build_py import build_py as _build_py class cmd_build_py(_build_py): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() _build_py.run(self) # now locate _version.py in the new build/ directory and replace # it with an updated value if cfg.versionfile_build: target_versionfile = os.path.join(self.build_lib, cfg.versionfile_build) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) cmds["build_py"] = cmd_build_py if "cx_Freeze" in sys.modules: # cx_freeze enabled? from cx_Freeze.dist import build_exe as _build_exe # nczeczulin reports that py2exe won't like the pep440-style string # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. # setup(console=[{ # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION # "product_version": versioneer.get_version(), # ... class cmd_build_exe(_build_exe): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() target_versionfile = cfg.versionfile_source print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) _build_exe.run(self) os.unlink(target_versionfile) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) cmds["build_exe"] = cmd_build_exe del cmds["build_py"] if 'py2exe' in sys.modules: # py2exe enabled? try: from py2exe.distutils_buildexe import py2exe as _py2exe # py3 except ImportError: from py2exe.build_exe import py2exe as _py2exe # py2 class cmd_py2exe(_py2exe): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() target_versionfile = cfg.versionfile_source print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) _py2exe.run(self) os.unlink(target_versionfile) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) cmds["py2exe"] = cmd_py2exe # we override different "sdist" commands for both environments if "setuptools" in sys.modules: from setuptools.command.sdist import sdist as _sdist else: from distutils.command.sdist import sdist as _sdist class cmd_sdist(_sdist): def run(self): versions = get_versions() self._versioneer_generated_versions = versions # unless we update this, the command will keep using the old # version self.distribution.metadata.version = versions["version"] return _sdist.run(self) def make_release_tree(self, base_dir, files): root = get_root() cfg = get_config_from_root(root) _sdist.make_release_tree(self, base_dir, files) # now locate _version.py in the new base_dir directory # (remembering that it may be a hardlink) and replace it with an # updated value target_versionfile = os.path.join(base_dir, cfg.versionfile_source) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, self._versioneer_generated_versions) cmds["sdist"] = cmd_sdist return cmds CONFIG_ERROR = """ setup.cfg is missing the necessary Versioneer configuration. You need a section like: [versioneer] VCS = git style = pep440 versionfile_source = src/myproject/_version.py versionfile_build = myproject/_version.py tag_prefix = parentdir_prefix = myproject- You will also need to edit your setup.py to use the results: import versioneer setup(version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), ...) Please read the docstring in ./versioneer.py for configuration instructions, edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. """ SAMPLE_CONFIG = """ # See the docstring in versioneer.py for instructions. Note that you must # re-run 'versioneer.py setup' after changing this section, and commit the # resulting files. [versioneer] #VCS = git #style = pep440 #versionfile_source = #versionfile_build = #tag_prefix = #parentdir_prefix = """ INIT_PY_SNIPPET = """ from ._version import get_versions __version__ = get_versions()['version'] del get_versions """ def do_setup(): """Main VCS-independent setup function for installing Versioneer.""" root = get_root() try: cfg = get_config_from_root(root) except (EnvironmentError, configparser.NoSectionError, configparser.NoOptionError) as e: if isinstance(e, (EnvironmentError, configparser.NoSectionError)): print("Adding sample versioneer config to setup.cfg", file=sys.stderr) with open(os.path.join(root, "setup.cfg"), "a") as f: f.write(SAMPLE_CONFIG) print(CONFIG_ERROR, file=sys.stderr) return 1 print(" creating %s" % cfg.versionfile_source) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) ipy = os.path.join(os.path.dirname(cfg.versionfile_source), "__init__.py") if os.path.exists(ipy): try: with open(ipy, "r") as f: old = f.read() except EnvironmentError: old = "" if INIT_PY_SNIPPET not in old: print(" appending to %s" % ipy) with open(ipy, "a") as f: f.write(INIT_PY_SNIPPET) else: print(" %s unmodified" % ipy) else: print(" %s doesn't exist, ok" % ipy) ipy = None # Make sure both the top-level "versioneer.py" and versionfile_source # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so # they'll be copied into source distributions. Pip won't be able to # install the package without this. manifest_in = os.path.join(root, "MANIFEST.in") simple_includes = set() try: with open(manifest_in, "r") as f: for line in f: if line.startswith("include "): for include in line.split()[1:]: simple_includes.add(include) except EnvironmentError: pass # That doesn't cover everything MANIFEST.in can do # (http://docs.python.org/2/distutils/sourcedist.html#commands), so # it might give some false negatives. Appending redundant 'include' # lines is safe, though. if "versioneer.py" not in simple_includes: print(" appending 'versioneer.py' to MANIFEST.in") with open(manifest_in, "a") as f: f.write("include versioneer.py\n") else: print(" 'versioneer.py' already in MANIFEST.in") if cfg.versionfile_source not in simple_includes: print(" appending versionfile_source ('%s') to MANIFEST.in" % cfg.versionfile_source) with open(manifest_in, "a") as f: f.write("include %s\n" % cfg.versionfile_source) else: print(" versionfile_source already in MANIFEST.in") # Make VCS-specific changes. For git, this means creating/changing # .gitattributes to mark _version.py for export-subst keyword # substitution. do_vcs_install(manifest_in, cfg.versionfile_source, ipy) return 0 def scan_setup_py(): """Validate the contents of setup.py against Versioneer's expectations.""" found = set() setters = False errors = 0 with open("setup.py", "r") as f: for line in f.readlines(): if "import versioneer" in line: found.add("import") if "versioneer.get_cmdclass()" in line: found.add("cmdclass") if "versioneer.get_version()" in line: found.add("get_version") if "versioneer.VCS" in line: setters = True if "versioneer.versionfile_source" in line: setters = True if len(found) != 3: print("") print("Your setup.py appears to be missing some important items") print("(but I might be wrong). Please make sure it has something") print("roughly like the following:") print("") print(" import versioneer") print(" setup( version=versioneer.get_version(),") print(" cmdclass=versioneer.get_cmdclass(), ...)") print("") errors += 1 if setters: print("You should remove lines like 'versioneer.VCS = ' and") print("'versioneer.versionfile_source = ' . This configuration") print("now lives in setup.cfg, and should be removed from setup.py") print("") errors += 1 return errors if __name__ == "__main__": cmd = sys.argv[1] if cmd == "setup": errors = do_setup() errors += scan_setup_py() if errors: sys.exit(1) texext-0.6.1/README.rst0000644000076500000240000001172013274146766014516 0ustar mb312staff00000000000000###################################################### Texext - sphinx extensions for working with LaTeX math ###################################################### ``texext`` contains a couple of Sphinx_ extensions for working with LaTeX math. *********** math_dollar *********** ``math_dollar`` replaces math expressions between dollars in ReST_ with equivalent inline math. For example:: Here is some math: $a = 2$ will be replaced by:: Here is some math: :math:`a = 2` The extension makes some effort not to replace dollars that aren't meant as math, but please check your output carefully, and submit an issue on the `texext issue tracker`_ if we have messed up. To enable math_dollar, make sure that the ``texext`` package is on your Python path, and add ``texext.math_dollar`` to your list of extensions in the Sphinx ``conf.py``. If you want math_dollar to process docstrings, you should add ``sphinx.ext.autodoc`` higher up your extensions list than ``math_dollar``. ****************** mathcode directive ****************** Users of `sympy `_ may want to generate LaTeX expressions dynamically in Sympy, and then render them in LaTeX in the built pages. You can do this with the ``mathcode`` directive:: .. mathcode:: import sympy a, b = sympy.symbols('a, b') a * 10 + 2 * b The directive runs ``sympy.latex()`` on the return result of the final expression, and embeds it in a ``.. math::`` directive, resulting in equivalent output to sphinx of:: .. math:: 10 a + 2 b Context (namespace) is preserved by default, so you can use context in subsequent directives, e.g.:: .. mathcode:: a * 5 + 3 * b If the last expression in the mathcode block is not an expression, the context gets updated, but the extension generates no math directive to the output. This allows you to have blocks that fill in calculations without rendering to the page. For example, this generates no output:: .. mathcode:: expr = a * 4 You can use the generated context in a later directive:: .. mathcode:: expr To reset the context (namespace), use the ``newcontext`` option:: .. mathcode:: :newcontext: import sympy # again If you would like mathcode to share a namespace with the `matplotlib plot_directive`_, set the following in your ``conf.py``:: # Config of mathcode directive mathcode_use_plot_ns = True .. note:: If you want to use the plot_directive context from within mathcode directives, you need to list the plot_directive above the mathcode directive in your sphinx extension list. All the plot directives code will get run before all the mathcode directive code. Conversely, if you want to use the mathcode directive context from the plot_directive, list mathcode first in your sphinx extension list. .. note:: By default, the Matplotlib ``plot_directive`` will clear the namespace context for each directive, so you may want to use the ``:context:`` option to the plot directive, most of the time. If you are using Nb2plots_ for your plots, and you want Mathcode to share a namespace with the Nb2plots plot directive, you will need to specify the Nb2plots plot context directly:: # Config of mathcode directive mathcode_use_plot_ns = True mathcode_plot_context = 'nb2plots.nbplots.plot_context' More generally if you want to work with a customized version of the plot_directive, you need to supply the name of the plot context dictionary for the plot directive, as a string. For example, if you have a custom plot directive module importable as ``import my_path.plot_directive``, with the plot context in ``my_path.plot_directive.plot_context``, then your ``conf.py`` should have lines like these:: # Config of mathcode directive mathcode_plot_context = "my_path.plot_directive.plot_context" The plot context is a string rather than the attribute itself in order to let sphinx pickle the configuration between runs. This allows sphinx to avoid building pages that have not changed between calls to ``sphinx-build``. To enable the mathcode directive, make sure that the ``texext`` package is on your Python path, and add ``textext.mathcode`` to your list of extensions in the Sphinx ``conf.py``. **** Code **** See https://github.com/matthew-brett/texext Released under the BSD two-clause license - see the file ``LICENSE`` in the source distribution. `travis-ci `_ kindly tests the code automatically under Python versions 2.7, and 3.3 through 3.6. The latest released version is at https://pypi.python.org/pypi/texext ******* Support ******* Please put up issues on the `texext issue tracker`_. .. _sphinx: http://sphinx-doc.org .. _rest: http://docutils.sourceforge.net/rst.html .. _texext issue tracker: https://github.com/matthew-brett/texext/issues .. _matplotlib plot_directive: http://matplotlib.org/sampledoc/extensions.html .. _nb2plots: https://pypi.python.org/pypi/nb2plots