sphinxtesters-0.2.1/0000755000076500000240000000000013337304544014412 5ustar mb312staff00000000000000sphinxtesters-0.2.1/PKG-INFO0000644000076500000240000001321213337304544015506 0ustar mb312staff00000000000000Metadata-Version: 2.1 Name: sphinxtesters Version: 0.2.1 Summary: Utilities for testing Sphinx extensions Home-page: http://github.com/matthew-brett/sphinxtesters Author: Matthew Brett Author-email: matthew.brett@gmail.com Maintainer: Matthew Brett Maintainer-email: matthew.brett@gmail.com License: BSD license Description: ####################################################### Sphinxtesters - utilities for testing Sphinx extensions ####################################################### .. shared-text-body ********** Quickstart ********** If you have a directory containing a sphinx project, test that it builds with something like: .. code:: python class TestMyProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' def test_basic_build(self): # Get doctree for page "a_page.rst" doctree = self.get_doctree('a_page') # Assert stuff about doctree version of page html = self.get_built_file('a_page.html') # Assert stuff about html version of page You can try adding other page content by using the ``rst_sources`` dictionary: .. code:: python class TestChangedProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here Set the text of the ``conf.py`` file with the ``conf_source`` attribute: .. code:: python class TestConfeddProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} conf_source = """ # This overwrites existing conf.py """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here You don't need to set ``page_source_template``; if you don't, you start with a fresh project, where the only pages are the ones you specify in ``rst_sources``. .. code:: python class TestFreshProject(SourcesBuilder): rst_sources = {'a_page': """A new page""", 'b_page': """Another new page"""} conf_source = """ # Stuff for the conf.py file """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here See the tests for examples of using Sphinxtesters for testing builds of Sphinx projects. ************ Installation ************ :: pip install sphinxtesters **** Code **** See https://github.com/matthew-brett/sphinxtesters 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/sphinxtesters ***** Tests ***** * Install ``sphinxtesters`` * Install the pytest_ testing framework:: pip install pytest * Run the tests with:: pytest sphinxtesters ******* Support ******* Please put up issues on the `sphinxtesters issue tracker`_. .. standalone-references .. |sphinxtesters-documentation| replace:: `sphinxtesters documentation`_ .. _sphinxtesters documentation: https://matthew-brett.github.com/sphinxtesters/sphinxtesters.html .. _documentation: https://matthew-brett.github.com/sphinxtesters .. _pandoc: http://pandoc.org .. _jupyter: jupyter.org .. _homebrew: brew.sh .. _sphinx: http://sphinx-doc.org .. _rest: http://docutils.sourceforge.net/rst.html .. _sphinxtesters issue tracker: https://github.com/matthew-brett/sphinxtesters/issues .. _pytest: https://pytest.org .. _mock: https://github.com/testing-cabal/mock Platform: UNKNOWN Classifier: Development Status :: 2 - Pre-Alpha 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 Provides-Extra: test sphinxtesters-0.2.1/LICENSE0000644000076500000240000000312613143700626015415 0ustar mb312staff00000000000000.. _license: ********************** Copyright and Licenses ********************** sphinxtesters ============= The sphinxtesters package, including all examples, code snippets and attached documentation is covered by the 2-clause BSD license. Copyright (c) 2017, 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. sphinxtesters-0.2.1/requirements.txt0000644000076500000240000000004513142135475017674 0ustar mb312staff00000000000000# Minimum requirements # sphinx>=1.4 sphinxtesters-0.2.1/test-requirements.txt0000644000076500000240000000007413327136107020651 0ustar mb312staff00000000000000# Requirements for running tests -r requirements.txt pytest sphinxtesters-0.2.1/MANIFEST.in0000644000076500000240000000047013142135636016147 0ustar mb312staff00000000000000include versioneer.py include sphinxtesters/_version.py include README.rst include LICENSE include *requirements.txt recursive-include sphinxtesters/tests/proj1 * recursive-include sphinxtesters/tests/data * recursive-include sphinxtesters/tests/rst_md_files * recursive-include sphinxtesters/tests/otherpages * sphinxtesters-0.2.1/sphinxtesters.egg-info/0000755000076500000240000000000013337304544021027 5ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters.egg-info/PKG-INFO0000644000076500000240000001321213337304544022123 0ustar mb312staff00000000000000Metadata-Version: 2.1 Name: sphinxtesters Version: 0.2.1 Summary: Utilities for testing Sphinx extensions Home-page: http://github.com/matthew-brett/sphinxtesters Author: Matthew Brett Author-email: matthew.brett@gmail.com Maintainer: Matthew Brett Maintainer-email: matthew.brett@gmail.com License: BSD license Description: ####################################################### Sphinxtesters - utilities for testing Sphinx extensions ####################################################### .. shared-text-body ********** Quickstart ********** If you have a directory containing a sphinx project, test that it builds with something like: .. code:: python class TestMyProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' def test_basic_build(self): # Get doctree for page "a_page.rst" doctree = self.get_doctree('a_page') # Assert stuff about doctree version of page html = self.get_built_file('a_page.html') # Assert stuff about html version of page You can try adding other page content by using the ``rst_sources`` dictionary: .. code:: python class TestChangedProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here Set the text of the ``conf.py`` file with the ``conf_source`` attribute: .. code:: python class TestConfeddProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} conf_source = """ # This overwrites existing conf.py """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here You don't need to set ``page_source_template``; if you don't, you start with a fresh project, where the only pages are the ones you specify in ``rst_sources``. .. code:: python class TestFreshProject(SourcesBuilder): rst_sources = {'a_page': """A new page""", 'b_page': """Another new page"""} conf_source = """ # Stuff for the conf.py file """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here See the tests for examples of using Sphinxtesters for testing builds of Sphinx projects. ************ Installation ************ :: pip install sphinxtesters **** Code **** See https://github.com/matthew-brett/sphinxtesters 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/sphinxtesters ***** Tests ***** * Install ``sphinxtesters`` * Install the pytest_ testing framework:: pip install pytest * Run the tests with:: pytest sphinxtesters ******* Support ******* Please put up issues on the `sphinxtesters issue tracker`_. .. standalone-references .. |sphinxtesters-documentation| replace:: `sphinxtesters documentation`_ .. _sphinxtesters documentation: https://matthew-brett.github.com/sphinxtesters/sphinxtesters.html .. _documentation: https://matthew-brett.github.com/sphinxtesters .. _pandoc: http://pandoc.org .. _jupyter: jupyter.org .. _homebrew: brew.sh .. _sphinx: http://sphinx-doc.org .. _rest: http://docutils.sourceforge.net/rst.html .. _sphinxtesters issue tracker: https://github.com/matthew-brett/sphinxtesters/issues .. _pytest: https://pytest.org .. _mock: https://github.com/testing-cabal/mock Platform: UNKNOWN Classifier: Development Status :: 2 - Pre-Alpha 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 Provides-Extra: test sphinxtesters-0.2.1/sphinxtesters.egg-info/SOURCES.txt0000644000076500000240000000167213337304544022721 0ustar mb312staff00000000000000LICENSE MANIFEST.in README.rst doc-requirements.txt requirements.txt setup.cfg setup.py test-requirements.txt versioneer.py sphinxtesters/__init__.py sphinxtesters/_version.py sphinxtesters/sphinxutils.py sphinxtesters/tmpdirs.py sphinxtesters.egg-info/PKG-INFO sphinxtesters.egg-info/SOURCES.txt sphinxtesters.egg-info/dependency_links.txt sphinxtesters.egg-info/requires.txt sphinxtesters.egg-info/top_level.txt sphinxtesters/tests/__init__.py sphinxtesters/tests/test_modified_pagebuilder.py sphinxtesters/tests/test_pagebuilder.py sphinxtesters/tests/test_proj1.py sphinxtesters/tests/test_sources_builder.py sphinxtesters/tests/test_testapp.py sphinxtesters/tests/test_tmpdirs.py sphinxtesters/tests/proj1/.gitignore sphinxtesters/tests/proj1/README.md sphinxtesters/tests/proj1/a_page.rst sphinxtesters/tests/proj1/conf.py sphinxtesters/tests/proj1/index.rst sphinxtesters/tests/proj1/_static/.gitignore sphinxtesters/tests/proj1/_static/README.txtsphinxtesters-0.2.1/sphinxtesters.egg-info/requires.txt0000644000076500000240000000001713337304544023425 0ustar mb312staff00000000000000 [test] pytest sphinxtesters-0.2.1/sphinxtesters.egg-info/top_level.txt0000644000076500000240000000001613337304544023556 0ustar mb312staff00000000000000sphinxtesters sphinxtesters-0.2.1/sphinxtesters.egg-info/dependency_links.txt0000644000076500000240000000000113337304544025075 0ustar mb312staff00000000000000 sphinxtesters-0.2.1/setup.py0000755000076500000240000000442313142135546016130 0ustar mb312staff00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- ''' Installation script for sphinxtesters package ''' import os from os.path import join as pjoin, split as psplit, splitext import re import setuptools from distutils.core import setup import versioneer # Get install requirements from requirements.txt file with open('requirements.txt', 'rt') as fobj: install_requires = [line.strip() for line in fobj if line.strip() and not line[0] in '#-'] # Get any extra test requirements with open('test-requirements.txt', 'rt') as fobj: test_requires = [line.strip() for line in fobj if line.strip() and not line[0] in '#-'] # Requires for distutils (only used in pypi interface?) break_ver = re.compile(r'(\S+?)(\[\S+\])?([=<>!]+\S+)') requires = [break_ver.sub(r'\1 (\3)', req) for req in install_requires] cmdclass = versioneer.get_cmdclass() setup(name='sphinxtesters', version=versioneer.get_version(), cmdclass=cmdclass, description='Utilities for testing Sphinx extensions', author='Matthew Brett', author_email='matthew.brett@gmail.com', maintainer='Matthew Brett', maintainer_email='matthew.brett@gmail.com', url='http://github.com/matthew-brett/sphinxtesters', packages=['sphinxtesters', 'sphinxtesters.tests'], package_data = {'sphinxtesters': [ 'tests/data/*.rst', 'tests/rst_md_files/*', 'tests/data/*', 'tests/proj1/*.rst', 'tests/proj1/*.py', 'tests/proj1/_static/*', 'tests/otherpages/*', ]}, license='BSD license', classifiers = [ 'Development Status :: 2 - Pre-Alpha', '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(), extras_require = {'test': test_requires} ) sphinxtesters-0.2.1/setup.cfg0000644000076500000240000000033413337304544016233 0ustar mb312staff00000000000000[versioneer] vcs = git style = pep440 versionfile_source = sphinxtesters/_version.py versionfile_build = sphinxtesters/_version.py tag_prefix = "" parentdir_prefix = sphinxtesters- [egg_info] tag_build = tag_date = 0 sphinxtesters-0.2.1/sphinxtesters/0000755000076500000240000000000013337304544017335 5ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/sphinxutils.py0000644000076500000240000003356713337237714022323 0ustar mb312staff00000000000000""" Utilities for running sphinx tasks in-process """ import sys import os from os.path import join as pjoin, isdir, split as psplit, isfile import shutil from contextlib import contextmanager from copy import copy from tempfile import mkdtemp import pickle import warnings from docutils import nodes from docutils.parsers.rst import directives, roles from sphinx.application import Sphinx from sphinx.domains.std import StandardDomain fresh_roles = copy(roles._roles) fresh_directives = copy(directives._directives) fresh_visitor_dict = nodes.GenericNodeVisitor.__dict__.copy() fresh_std_domain_init_labels = StandardDomain.initial_data['labels'].copy() @contextmanager def in_dir(path): """ Change into directory for duration of context """ cwd = os.getcwd() try: os.chdir(path) yield finally: os.chdir(cwd) def reset_class(cls, original_dict): for key in list(cls.__dict__): if key not in original_dict: delattr(cls, key) else: setattr(cls, key, original_dict[key]) class TestApp(Sphinx): def __init__(self, *args, **kwargs): self._set_cache() with self.own_namespace(): super(TestApp, self).__init__(*args, **kwargs) def _set_cache(self): self._global_cache = dict( directives=copy(fresh_directives), roles=copy(fresh_roles), visitor_dict = copy(fresh_visitor_dict), std_domain_init_labels = copy(fresh_std_domain_init_labels)) @contextmanager def own_namespace(self): """ Set docutils namespace for builds """ cache = self._global_cache _directives = directives._directives _roles = roles._roles _visitor_dict = nodes.GenericNodeVisitor.__dict__.copy() _std_domain_init_labels = StandardDomain.initial_data['labels'] directives._directives = cache['directives'] roles._roles = cache['roles'] reset_class(nodes.GenericNodeVisitor, cache['visitor_dict']) StandardDomain.initial_data['labels'] = cache['std_domain_init_labels'] try: yield finally: # Reset docutils, Sphinx global state directives._directives = _directives roles._roles = _roles reset_class(nodes.GenericNodeVisitor, _visitor_dict) StandardDomain.initial_data['labels'] = _std_domain_init_labels def build(self, *args, **kwargs): with self.own_namespace(): return super(TestApp, self).build(*args, **kwargs) class TempApp(TestApp): """ An application pointing to its own temporary directory. The instance deletes its temporary directory when garbage collected. Parameters ---------- rst_text : str String containing ReST to build. conf_text : str, optional Text for configuration ``conf.py`` file. buildername : str, optional Name of default builder. status : file-like object or None, optional File-like object to which to write build status messages, or None for no build status messages. warningiserror : {True, False}, optional If True, raise an error for warning during the Sphinx build. """ def __init__(self, rst_text, conf_text='', buildername='html', status=sys.stdout, warningiserror=True): self.tmp_dir = tmp_dir = mkdtemp() with open(pjoin(tmp_dir, 'conf.py'), 'wt') as fobj: fobj.write(conf_text) with open(pjoin(tmp_dir, 'contents.rst'), 'wt') as fobj: fobj.write(rst_text) self._set_cache() with self.own_namespace(): TestApp.__init__(self, srcdir=tmp_dir, confdir=tmp_dir, # Sphinx 1.8.0b1 does not allow srcdir==outdir outdir=pjoin(tmp_dir, 'build'), doctreedir=tmp_dir, buildername=buildername, status=status, warningiserror=warningiserror) def cleanup(self): if self.tmp_dir is None: return shutil.rmtree(self.tmp_dir) self.tmp_dir = None def __del__(self): # Sphinx application may or may not have a __del__ method. try: super(TempApp, self).__del__() except AttributeError: pass self.cleanup() class PageBuilder(object): """ Test class to build sphinx pages in temporary directory When child class has a name Pytest recognizes as a test class, Pytest will call :meth:`setup_class`. In this class method, :meth:`set_page_source` copies / makes / manipulates the source pages. It likely calls :meth:`modify_source` at the end, allowing you to hook in any other modifications. :meth:`setup_class` then initializes the Sphinx applicaton object, and builds the pages, using :meth:`build_source`. The default behavior is to initialize the source directory by copying from a template directory specified in ``page_source_template``. This can be None, to start with an empty source directory, before modifications by :meth:`modify_source`. """ # If True, assert that the build raised an error should_error = False # Builder builder = 'html' # Set to path containing any original sources that we copy to initialize # the source directory. Can be None (no pages copied). page_source_template = None @classmethod def setup_class(cls): cls.build_error = None cls.build_path = mkdtemp() try: # Catch exceptions during test setup # Sets page_source, maybe modifies source cls.set_page_source() cls.out_dir = pjoin(cls.build_path, cls.builder) cls.doctree_dir = pjoin(cls.build_path, 'doctrees') # App to build the pages with warnings turned into errors cls.build_app = TestApp( cls.page_source, cls.page_source, cls.out_dir, cls.doctree_dir, cls.builder, warningiserror=True) except Exception as e: # Exceptions during test setup shutil.rmtree(cls.build_path) raise e cls.build_source() @classmethod def set_page_source(cls): """ Set directory containing page sources, maybe modify source. """ cls.page_source = pjoin(cls.build_path, 'source') if cls.page_source_template: shutil.copytree(cls.page_source_template, cls.page_source) else: os.mkdir(cls.page_source) cls.modify_source() @classmethod def modify_source(cls): """ Override to modify sources before initial build """ @classmethod def build_source(cls): try: # Catch exceptions during sphinx build cls.build_app.build(False, []) if cls.build_app.statuscode != 0: cls.build_error = "Unknown error" except Exception as e: # Exceptions during sphinx build cls.build_error = e # We will later check if a page build that should error, did error if cls.build_error is None or cls.should_error: return # An unexpected error - delete temp dir and report. shutil.rmtree(cls.build_path) raise RuntimeError('page build failed with build error {}' .format(cls.build_error)) def get_doctree(self, name): """ Return doctree given by `name` from pickle in doctree file """ with open(pjoin(self.doctree_dir, name + '.doctree'), 'rb') as fobj: content = fobj.read() return pickle.loads(content) @classmethod def get_built_file(cls, basename, encoding='utf8'): """ Contents of file in build dir with basename `basename` Parameters ---------- basename : str Basename of file to load, including extension. encoding : str, optional If None, return contents as bytes. If not None, decode contents with the given encoding. Returns ------- content : str or bytes Return text contents of file if `encoding` not None, else return binary contents of file. """ with open(pjoin(cls.out_dir, basename), 'rb') as fobj: content = fobj.read() return content if encoding is None else content.decode(encoding) def doctree2str(self, doctree): """ Return simple string representation from `doctree` """ return '\n'.join(str(p) for p in doctree.document[0]) def test_build_error(self): # Check whether an expected build error has occurred assert self.should_error == (self.build_error is not None) @classmethod def append_conf(cls, string): """ Append stuff to the conf.py file """ with open(pjoin(cls.page_source, 'conf.py'), 'a') as fobj: fobj.write(string) @classmethod def teardown_class(cls): if isdir(cls.build_path): shutil.rmtree(cls.build_path) class SourcesBuilder(PageBuilder): """ Build pages with text in class attribute ``rst_sources``. Class that stores page names, page contents as key, value pairs in the ``rst_sources`` class attribute. ``conf.py`` contents can go in the ``conf_source`` class attribute. """ # rst_sources is a dict with key, value pairs, where the keys are the page # names, with directory names separated by / regardless of platform we're # running on. ``.rst`` extension assumed (do not add it). The values are # strings giving the page contents. rst_sources = dict() # Contents for conf.py. Can be empty to use existing contents. If not # empty, then contents overwrites any existing conf.py file. conf_source = '' # Pages to be listed in the master document toctree toctree_pages = [] @classmethod def _touch(cls, fname): if isfile(fname): return with open(fname, 'wt') as fobj: fobj.write('') @classmethod def modify_source(cls): conf_fname = pjoin(cls.page_source, 'conf.py') if cls.conf_source: with open(conf_fname, 'wt') as fobj: fobj.write(cls.conf_source) else: cls._touch(conf_fname) for page_root, page_content in cls.rst_sources.items(): # page root may contain directories page_root = page_root.replace('/', os.path.sep) page_dir, page_base = psplit(page_root) page_dir = pjoin(cls.page_source, page_dir) if not isdir(page_dir): os.makedirs(page_dir) page_path = pjoin(page_dir, page_base + '.rst') with open(page_path, 'wt') as fobj: # Avoid warning (-> error) when page not included in toctree fobj.write(":orphan:\n\n") fobj.write(page_content) master_fname = cls._get_master() # Always write blank master document, if not already present. cls._touch(master_fname) # Write toctree to master doc, if needed cls.write_toctree(cls.toctree_pages, master_fname) @classmethod def get_conf_vars(cls, force=False): vars = {} with in_dir(cls.page_source): with open('conf.py', 'rt') as fobj: conf = fobj.read() exec(conf, {}, vars) return vars @classmethod def _get_master(cls): """ Return filename of master page for project """ master_doc = cls.get_conf_vars().get('master_doc', 'contents') return pjoin(cls.page_source, master_doc + '.rst') @classmethod def write_toctree(cls, page_list, master_fname=None): """ Write toctree directive for given page list """ if len(page_list) == 0: return if master_fname is None: master_fname = cls._get_master() with open(master_fname, 'at') as fobj: fobj.write("\n\n.. toctree::\n\n {0}\n\n".format( '\n'.join(page_list))) class ModifiedPageBuilder(PageBuilder): """ Add utilities for changing pages from template. This class now deprecated, please use PageBuilder instead. """ # Default page. Should specify a path-less page name that can be replaced # in modified builds. default_page = None @classmethod def setup_class(cls): warnings.warn('ModifedPageBuilder deprecated, please ' 'use PageBuilder instead', DeprecationWarning, stacklevel=2) super(ModifiedPageBuilder, cls).setup_class() @classmethod def replace_page(cls, file_like): """ Replace default page with contents of `file_like` """ out_fname = pjoin(cls.page_source, cls.default_page + '.rst') if hasattr(file_like, 'read'): contents = file_like.read() with open(out_fname, 'wt') as fobj: fobj.write(contents) return shutil.copyfile(file_like, out_fname) @classmethod def add_page(cls, file_like, out_name): """ Add another page from `file_like` with name `out_name` Parameters ---------- file_like : file-like or str File-like object or filename. out_name : str Base of filename for output. We will prepend the ``cls.page_source`` path, and add a ``.rst`` suffix. """ out_fname = pjoin(cls.page_source, out_name + '.rst') if hasattr(file_like, 'read'): contents = file_like.read() with open(out_fname, 'wt') as fobj: fobj.write(contents) else: shutil.copyfile(file_like, out_fname) with open(pjoin(cls.page_source, 'index.rst'), 'a') as fobj: fobj.write("\n\n.. toctree::\n\n {0}\n\n".format(out_name)) sphinxtesters-0.2.1/sphinxtesters/_version.py0000644000076500000240000000076113337304544021537 0ustar mb312staff00000000000000 # This file was generated by 'versioneer.py' (0.18) 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-22T12:02:53+0100", "dirty": false, "error": null, "full-revisionid": "42e8318b246e6a2c4ff96b826e17ddf17a176b1d", "version": "0.2.1" } ''' # END VERSION_JSON def get_versions(): return json.loads(version_json) sphinxtesters-0.2.1/sphinxtesters/tests/0000755000076500000240000000000013337304544020477 5ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/tests/test_proj1.py0000644000076500000240000000204713327136026023143 0ustar mb312staff00000000000000""" Tests for proj1 build using sphinx extensions """ from os.path import (join as pjoin, dirname, isdir, exists, splitext) from sphinxtesters import ModifiedPageBuilder HERE = dirname(__file__) class Proj1Builder(ModifiedPageBuilder): """ Build using 'proj1' directory as template to modify """ page_source_template = pjoin(HERE, 'proj1') # default_page used in 'replace_page' class method default_page = 'a_page.rst' class TestProj1(Proj1Builder): def test_basic_build(self): assert isdir(self.out_dir) assert isdir(self.doctree_dir) doctree = self.get_doctree(splitext(self.default_page)[0]) assert len(doctree.document) == 1 doctree_str = self.doctree2str(doctree) expected = ( 'A section\n' 'Some text.\n' 'More text.\n' 'Text is endless.') assert doctree_str == expected assert exists(pjoin(self.doctree_dir, 'index.doctree')) sphinxtesters-0.2.1/sphinxtesters/tests/test_pagebuilder.py0000644000076500000240000000762013337241113024370 0ustar mb312staff00000000000000""" Test PageBuilder """ from os.path import (dirname, join as pjoin, isdir, isfile) try: # Sphinx 1.8.0b1 from sphinx.errors import ApplicationError as NoConfigError except ImportError: from sphinx.errors import ConfigError as NoConfigError from sphinxtesters.sphinxutils import PageBuilder import pytest HERE = dirname(__file__) PROJ1 = pjoin(HERE, 'proj1') class TestPageBuilder(PageBuilder): # Test a minmal source tree @classmethod def modify_source(cls): # Make an empty conf.py and contents.rst file with text cls.append_conf('') with open(pjoin(cls.page_source, 'contents.rst'), 'wt') as fobj: fobj.write('some text') def test_build(self): assert isdir(self.out_dir) assert isdir(self.doctree_dir) assert isfile(pjoin(self.out_dir, 'contents.html')) doctree = self.get_doctree('contents') assert doctree.document.astext() == 'some text' class TestMaster(PageBuilder): # Test we can change the master document @classmethod def modify_source(cls): cls.append_conf('master_doc = "foo"') with open(pjoin(cls.page_source, 'foo.rst'), 'wt') as fobj: fobj.write('more text') def test_build(self): assert not isfile(pjoin(self.out_dir, 'contents.html')) assert isfile(pjoin(self.out_dir, 'foo.html')) doctree = self.get_doctree('foo') assert doctree.document.astext() == 'more text' class TestTemplatePageBuilder(PageBuilder): page_source_template = PROJ1 def test_build(self): assert isdir(self.out_dir) assert isdir(self.doctree_dir) doctree = self.get_doctree('a_page') assert len(doctree.document) == 1 doctree_str = self.doctree2str(doctree) expected = ( 'A section\n' 'Some text.\n' 'More text.\n' 'Text is endless.') assert doctree_str == expected assert isfile(pjoin(self.doctree_dir, 'index.doctree')) html = self.get_built_file('a_page.html') assert 'Text is endless' in html def test_bad_pagebuilder(): class TestBadPageBuilder(PageBuilder): @classmethod def set_page_source(cls): cls.page_source = HERE # ConfigError as of Sphinx 1.6.6 # ApplicationError as of 1.8.0b1 # See imports. with pytest.raises((IOError, NoConfigError)): TestBadPageBuilder.setup_class() class TestRewrite(TestTemplatePageBuilder): # Replace page, check we get replacement page _page = u""" Fancy title +++++++++++ Compelling text """ @classmethod def modify_source(cls): fname = pjoin(cls.page_source, 'a_page.rst') with open(fname, 'wt') as fobj: fobj.write(cls._page) def test_build(self): doctree = self.get_doctree('a_page') doctree_str = self.doctree2str(doctree) expected = ( 'Fancy title\n' 'Compelling text') assert doctree_str == expected def test_bad_pagebuilder_with_template(): """ Tests that warning on build generates error """ class TestBadPageBuilder(TestRewrite): _page = u""" Fancy title +++++++++++ :ref:`not-a-target` """ with pytest.raises(RuntimeError): TestBadPageBuilder.setup_class() class TestAppendConf(TestRewrite): # Test append_conf method @classmethod def modify_source(cls): super(TestAppendConf, cls).modify_source() cls.append_conf('# Spurious comment') def test_append_conf(self): with open(pjoin(PROJ1, 'conf.py'), 'rt') as fobj: before_contents = fobj.read() with open(pjoin(self.page_source, 'conf.py'), 'rt') as fobj: after_contents = fobj.read() assert (after_contents == before_contents + '# Spurious comment') sphinxtesters-0.2.1/sphinxtesters/tests/__init__.py0000644000076500000240000000000013143670023022567 0ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/tests/test_sources_builder.py0000644000076500000240000000770013327724543025311 0ustar mb312staff00000000000000""" Tests for SourcesBuilder utility """ from os.path import (join as pjoin, isdir, exists, dirname) from sphinxtesters import SourcesBuilder import pytest HERE = dirname(__file__) PROJ1 = pjoin(HERE, 'proj1') A_PAGE = """\ ######### A section ######### Some text. More text. Text is endless.""" A_DOCTREE = """\ A section Some text. More text. Text is endless.""" B_PAGE = """\ ############### Another section ############### Some more text.""" B_DOCTREE = """\ Another section Some more text.""" NO_TITLE_PAGE = """\ Just text, no title.""" NO_TITLE_DOCTREE = """\ Just text, no title.""" class CheckSources(SourcesBuilder): """ Template for testing some pages """ def test_structure(self): assert isdir(self.out_dir) assert isdir(self.doctree_dir) assert exists(pjoin(self.doctree_dir, 'contents.doctree')) for page_name in self.rst_sources: assert exists(pjoin(self.doctree_dir, page_name + '.doctree')) def check_page(self, page_name, expected_doctree): doctree = self.get_doctree(page_name) assert len(doctree.document) == 1 doctree_str = self.doctree2str(doctree) assert doctree_str == expected_doctree class TestAPage(CheckSources): rst_sources = dict(a_page=A_PAGE) expected_doctree = A_DOCTREE def test_page(self): page_name = list(self.rst_sources)[0] self.check_page(page_name, self.expected_doctree) class TestBPage(TestAPage): rst_sources = dict(b_page=B_PAGE) expected_doctree = B_DOCTREE class TestNoTitlePage(TestAPage): rst_sources = dict(no_title_page=NO_TITLE_PAGE) expected_doctree = NO_TITLE_DOCTREE class TestTemplateSourcesBuilder(SourcesBuilder): # Replace page using rst_sources page_source_template = PROJ1 rst_sources = {'a_page': u""" Fancy title +++++++++++ Compelling text """} def test_a_build(self): doctree = self.get_doctree('a_page') doctree_str = self.doctree2str(doctree) expected = ( 'Fancy title\n' 'Compelling text') assert doctree_str == expected def test_bad_souurcesbuilder_with_template(): """ Tests that warning on build generates error """ class TestBadSourcesBuilder(TestTemplateSourcesBuilder): rst_sources = {'a_page': u""" Fancy title +++++++++++ :ref:`not-a-target` """} with pytest.raises(RuntimeError): TestBadSourcesBuilder.setup_class() class TestAppendConf(TestTemplateSourcesBuilder): # Test append_conf method @classmethod def modify_source(cls): super(TestAppendConf, cls).modify_source() cls.append_conf('# Spurious comment') def test_append_conf(self): with open(pjoin(PROJ1, 'conf.py'), 'rt') as fobj: before_contents = fobj.read() with open(pjoin(self.page_source, 'conf.py'), 'rt') as fobj: after_contents = fobj.read() assert (after_contents == before_contents + '# Spurious comment') class TestNoTocTree(SourcesBuilder): # Test no toctree write rst_sources = dict(a_page=A_PAGE) def test_master(self): doctree = self.get_doctree('contents') assert doctree.document.astext() == '' assert len(doctree.document.children) == 0 class TestTocTree(TestNoTocTree): # Test toctree write to master_doc toctree_pages = ['a_page'] master_name = 'contents' def test_master(self): doctree = self.get_doctree(self.master_name) assert len(doctree.document.children) == 1 toctree = doctree.document.children[0] entries = toctree[0]['entries'] assert entries == [(None, 'a_page')] class TestFooTocTree(TestTocTree): # Test toctree write to another master_doc conf_source = 'master_doc = "foo"' master_name = 'foo' sphinxtesters-0.2.1/sphinxtesters/tests/test_modified_pagebuilder.py0000644000076500000240000000616313327713533026242 0ustar mb312staff00000000000000""" Test ModifiedPageBuilder """ from io import StringIO from os.path import dirname, join as pjoin from sphinxtesters.sphinxutils import ModifiedPageBuilder from sphinxtesters.tmpdirs import in_dtemp import pytest HERE = dirname(__file__) PROJ1 = pjoin(HERE, 'proj1') class TestModifiedPageBuilder(ModifiedPageBuilder): # Replace page with file-like object page_source_template = PROJ1 default_page = 'a_page' _new_page = u""" Fancy title +++++++++++ Compelling text """ @classmethod def modify_source(cls): page_fobj = StringIO(cls._new_page) cls.replace_page(page_fobj) def test_a_build(self): doctree = self.get_doctree(self.default_page) doctree_str = self.doctree2str(doctree) expected = ( 'Fancy title\n' 'Compelling text') assert doctree_str == expected class TestFModifiedPageBuilder(TestModifiedPageBuilder): # Replace page, but with filename @classmethod def modify_source(cls): with in_dtemp(): with open('test.txt', 'wt') as fobj: fobj.write(cls._new_page) cls.replace_page('test.txt') def test_bad_pagebuilder(): """ Tests that warning on build generates error """ class TestBadPageBuilder(TestModifiedPageBuilder): _new_page = u""" Fancy title +++++++++++ :ref:`not-a-target` """ with pytest.raises(RuntimeError): TestBadPageBuilder.setup_class() class TestAppendConf(TestModifiedPageBuilder): # Test append_conf method @classmethod def modify_source(cls): super(TestAppendConf, cls).modify_source() cls.append_conf('# Spurious comment') def test_append_conf(self): with open(pjoin(PROJ1, 'conf.py'), 'rt') as fobj: before_contents = fobj.read() with open(pjoin(self.page_source, 'conf.py'), 'rt') as fobj: after_contents = fobj.read() assert (after_contents == before_contents + '# Spurious comment') class TestAddPage(TestModifiedPageBuilder): # Test ability to add a page @classmethod def modify_source(cls): page_fobj = StringIO(cls._new_page) cls.add_page(page_fobj, 'b_page') def test_a_build(self): doctree = self.get_doctree(self.default_page) doctree_str = self.doctree2str(doctree) expected = ( 'A section\n' 'Some text.\n' 'More text.\n' 'Text is endless.') assert doctree_str == expected expected = ( 'Fancy title\n' 'Compelling text') doctree = self.get_doctree('b_page') doctree_str = self.doctree2str(doctree) assert doctree_str == expected class TestAddFPage(TestAddPage): # Test ability to add a page as filename @classmethod def modify_source(cls): with in_dtemp(): with open('test.txt', 'wt') as fobj: fobj.write(cls._new_page) cls.add_page('test.txt', 'b_page') sphinxtesters-0.2.1/sphinxtesters/tests/proj1/0000755000076500000240000000000013337304544021532 5ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/tests/proj1/a_page.rst0000644000076500000240000000011013142140672023462 0ustar mb312staff00000000000000######### A section ######### Some text. More text. Text is endless. sphinxtesters-0.2.1/sphinxtesters/tests/proj1/index.rst0000644000076500000240000000027413142140651023365 0ustar mb312staff00000000000000Here start the pages ==================== Contents: .. toctree:: :maxdepth: 2 a_page Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` sphinxtesters-0.2.1/sphinxtesters/tests/proj1/conf.py0000644000076500000240000000006413142140625023021 0ustar mb312staff00000000000000# The master toctree document. master_doc = 'index' sphinxtesters-0.2.1/sphinxtesters/tests/proj1/_static/0000755000076500000240000000000013337304544023160 5ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/tests/proj1/_static/.gitignore0000644000076500000240000000000013142140072025122 0ustar mb312staff00000000000000sphinxtesters-0.2.1/sphinxtesters/tests/proj1/_static/README.txt0000644000076500000240000000046213142140072024644 0ustar mb312staff00000000000000############################### Static directory for test pages ############################### 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. sphinxtesters-0.2.1/sphinxtesters/tests/proj1/README.md0000644000076500000240000000005213142140231022767 0ustar mb312staff00000000000000# Test project A minimal Sphinx project. sphinxtesters-0.2.1/sphinxtesters/tests/proj1/.gitignore0000644000076500000240000000001013142140072023475 0ustar mb312staff00000000000000_build/ sphinxtesters-0.2.1/sphinxtesters/tests/test_tmpdirs.py0000644000076500000240000000161413143670011023562 0ustar mb312staff00000000000000""" Test tmpdirs module """ from __future__ import division, print_function, absolute_import from os import unlink from os.path import isfile, isdir from ..tmpdirs import in_dtemp, dtemporize def test_in_dtemp(): # Test working in temporary directory with in_dtemp() as tmpdir: with open('test.txt', 'wt') as fobj: fobj.write('Some text') assert not isdir(tmpdir) def test_dtmeporize(): # Test decorator to work in temporary directory def func1(): with open('test.txt', 'wt') as fobj: fobj.write('Some text') @dtemporize def func2(): with open('test.txt', 'wt') as fobj: fobj.write('Some text') with in_dtemp(): func1() assert isfile('test.txt') unlink('test.txt') # Next one should be in a temporary directory, not here func2() assert not isfile('test.txt') sphinxtesters-0.2.1/sphinxtesters/tests/test_testapp.py0000644000076500000240000000111713337237637023600 0ustar mb312staff00000000000000""" Test TempApp, TestApp classes """ from os.path import (join as pjoin, isdir) from sphinxtesters.sphinxutils import TempApp def assert_contents_equal(fname, contents, mode='t'): with open(fname, 'r' + mode) as fobj: f_contents = fobj.read() assert f_contents == contents def test_tempapp(): rst_txt = 'A simple page' app = TempApp(rst_txt) app.build() app_path = app.tmp_dir assert_contents_equal(pjoin(app_path, 'contents.rst'), rst_txt) assert_contents_equal(pjoin(app_path, 'conf.py'), '') app.cleanup() assert not isdir(app_path) sphinxtesters-0.2.1/sphinxtesters/__init__.py0000644000076500000240000000035313327703741021450 0ustar mb312staff00000000000000""" Sphinxtesters package """ from .sphinxutils import (PageBuilder, SourcesBuilder, ModifiedPageBuilder, TempApp) from ._version import get_versions __version__ = get_versions()['version'] del get_versions sphinxtesters-0.2.1/sphinxtesters/tmpdirs.py0000644000076500000240000000125613327701116021370 0ustar mb312staff00000000000000""" Utilities for running code in temporary directories """ from os import getcwd, chdir from tempfile import mkdtemp from functools import wraps from contextlib import contextmanager from shutil import rmtree @contextmanager def in_dtemp(): """ Change into temporary directory for duration of context """ tmpdir = mkdtemp() cwd = getcwd() try: chdir(tmpdir) yield tmpdir finally: chdir(cwd) rmtree(tmpdir) def dtemporize(func): """ Decorate a function to run in a temporary directory """ @wraps(func) def dfunc(*args, **kwargs): with in_dtemp(): return func(*args, **kwargs) return dfunc sphinxtesters-0.2.1/versioneer.py0000644000076500000240000020600313142136137017141 0ustar mb312staff00000000000000 # Version: 0.18 """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, 3.6, 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](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.18 (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.18) 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) sphinxtesters-0.2.1/README.rst0000644000076500000240000000735413327725724016120 0ustar mb312staff00000000000000####################################################### Sphinxtesters - utilities for testing Sphinx extensions ####################################################### .. shared-text-body ********** Quickstart ********** If you have a directory containing a sphinx project, test that it builds with something like: .. code:: python class TestMyProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' def test_basic_build(self): # Get doctree for page "a_page.rst" doctree = self.get_doctree('a_page') # Assert stuff about doctree version of page html = self.get_built_file('a_page.html') # Assert stuff about html version of page You can try adding other page content by using the ``rst_sources`` dictionary: .. code:: python class TestChangedProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here Set the text of the ``conf.py`` file with the ``conf_source`` attribute: .. code:: python class TestConfeddProject(SourcesBuilder): page_source_template = 'path/to/sphinx_dir' rst_sources = {'a_page': """Replacement text for page""", 'b_page': """An entirely new page"""} conf_source = """ # This overwrites existing conf.py """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here You don't need to set ``page_source_template``; if you don't, you start with a fresh project, where the only pages are the ones you specify in ``rst_sources``. .. code:: python class TestFreshProject(SourcesBuilder): rst_sources = {'a_page': """A new page""", 'b_page': """Another new page"""} conf_source = """ # Stuff for the conf.py file """ def test_basic_build(self): a_doctree = self.get_doctree('a_page') b_doctree = self.get_doctree('b_page') # Your tests for the new page content here See the tests for examples of using Sphinxtesters for testing builds of Sphinx projects. ************ Installation ************ :: pip install sphinxtesters **** Code **** See https://github.com/matthew-brett/sphinxtesters 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/sphinxtesters ***** Tests ***** * Install ``sphinxtesters`` * Install the pytest_ testing framework:: pip install pytest * Run the tests with:: pytest sphinxtesters ******* Support ******* Please put up issues on the `sphinxtesters issue tracker`_. .. standalone-references .. |sphinxtesters-documentation| replace:: `sphinxtesters documentation`_ .. _sphinxtesters documentation: https://matthew-brett.github.com/sphinxtesters/sphinxtesters.html .. _documentation: https://matthew-brett.github.com/sphinxtesters .. _pandoc: http://pandoc.org .. _jupyter: jupyter.org .. _homebrew: brew.sh .. _sphinx: http://sphinx-doc.org .. _rest: http://docutils.sourceforge.net/rst.html .. _sphinxtesters issue tracker: https://github.com/matthew-brett/sphinxtesters/issues .. _pytest: https://pytest.org .. _mock: https://github.com/testing-cabal/mock sphinxtesters-0.2.1/doc-requirements.txt0000644000076500000240000000011113142141305020416 0ustar mb312staff00000000000000# Requirements for building docs -r requirements.txt ghp-import numpydoc