update setup boilerplate

Author: mbdevpl

setup.py

@@ -9,7 +9,7 @@ class Package(setup_boilerplate.Package):
 
     name = 'open-fortran-parser'
     description = 'Python wrapper for XML output generator for Open Fortran Parser'
-    download_url = 'https://github.com/mbdevpl/open-fortran-parser-xml'
+    url = 'https://github.com/mbdevpl/open-fortran-parser-xml'
     classifiers = [
         'Development Status :: 3 - Alpha',
         'Environment :: Console',

setup_boilerplate.py

@@ -1,23 +1,20 @@
 """Below code is generic boilerplate and normally should not be changed.
 
-To avoid setup script boilerplate, create "setup.py" file with the following minimal contents
-and modify them according to the specifics of your package.
+To avoid setup script boilerplate, create "setup.py" file with the minimal contents as given
+in SETUP_TEMPLATE below, and modify it according to the specifics of your package.
 
 See the implementation of setup_boilerplate.Package for default metadata values and available
 options.
 """
 
-import importlib
 import pathlib
+import runpy
 import sys
 import typing as t
 
-import docutils.nodes
-import docutils.parsers.rst
-import docutils.utils
 import setuptools
 
-__updated__ = '2018-04-18'
+__updated__ = '2019-06-04'
 
 SETUP_TEMPLATE = '''"""Setup script."""
 
@@ -30,12 +27,13 @@ class Package(setup_boilerplate.Package):
 
     name = ''
     description = ''
-    download_url = 'https://github.com/mbdevpl/...'
+    url = 'https://github.com/mbdevpl/...'
     classifiers = [
         'Development Status :: 1 - Planning',
-        'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3 :: Only']
     keywords = []
 
@@ -50,10 +48,14 @@ class Package(setup_boilerplate.Package):
 def find_version(
         package_name: str, version_module_name: str = '_version',
         version_variable_name: str = 'VERSION') -> str:
-    """Simulate behaviour of "from package_name._version import VERSION", and return VERSION."""
-    version_module = importlib.import_module(
-        '{}.{}'.format(package_name.replace('-', '_'), version_module_name))
-    return getattr(version_module, version_variable_name)
+    """Simulate behaviour of "from package_name._version import VERSION", and return VERSION.
+
+    To avoid importing whole package only to read the version, just module containing the version
+    is imported. Therefore relative imports in that module will break the setup.
+    """
+    version_module_path = '{}/{}.py'.format(package_name.replace('-', '_'), version_module_name)
+    version_module_vars = runpy.run_path(version_module_path)
+    return version_module_vars[version_variable_name]
 
 
 def find_packages(root_directory: str = '.') -> t.List[str]:
@@ -126,57 +128,59 @@ def find_required_python_version(
     return None
 
 
-def parse_rst(text: str) -> docutils.nodes.document:
-    """Parse text assuming it's an RST markup."""
-    parser = docutils.parsers.rst.Parser()
-    components = (docutils.parsers.rst.Parser,)
-    settings = docutils.frontend.OptionParser(components=components).get_default_values()
-    document = docutils.utils.new_document('<rst-doc>', settings=settings)
-    parser.parse(text, document)
-    return document
-
-
-class SimpleRefCounter(docutils.nodes.NodeVisitor):
-
-    """Find all simple references in a given docutils document."""
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.references = []
-
-    def visit_reference(self, node: docutils.nodes.reference) -> None:
-        """Called for "reference" nodes."""
-        if len(node.children) != 1 or not isinstance(node.children[0], docutils.nodes.Text) \
-                or not all(_ in node.attributes for _ in ('name', 'refuri')):
-            return
-        path = pathlib.Path(node.attributes['refuri'])
-        try:
-            if path.is_absolute():
-                return
-            resolved_path = path.resolve()
-        except FileNotFoundError:  # in resolve(), prior to Python 3.6
-            return
-        except OSError:  # in is_absolute() and resolve(), on URLs in Windows
-            return
-        try:
-            resolved_path.relative_to(HERE)
-        except ValueError:
-            return
-        if not path.is_file():
-            return
-        assert node.attributes['name'] == node.children[0].astext()
-        self.references.append(node)
-
-    def unknown_visit(self, node: docutils.nodes.Node) -> None:
-        """Called for unknown node types."""
-        pass
-
-
 def resolve_relative_rst_links(text: str, base_link: str):
     """Resolve all relative links in a given RST document.
 
     All links of form `link`_ become `link <base_link/link>`_.
     """
+    import docutils.nodes
+    import docutils.parsers.rst
+    import docutils.utils
+
+    def parse_rst(text: str) -> docutils.nodes.document:
+        """Parse text assuming it's an RST markup."""
+        parser = docutils.parsers.rst.Parser()
+        components = (docutils.parsers.rst.Parser,)
+        settings = docutils.frontend.OptionParser(components=components).get_default_values()
+        document = docutils.utils.new_document('<rst-doc>', settings=settings)
+        parser.parse(text, document)
+        return document
+
+    class SimpleRefCounter(docutils.nodes.NodeVisitor):
+        """Find all simple references in a given docutils document."""
+
+        def __init__(self, *args, **kwargs):
+            """Initialize the SimpleRefCounter object."""
+            super().__init__(*args, **kwargs)
+            self.references = []
+
+        def visit_reference(self, node: docutils.nodes.reference) -> None:
+            """Call for "reference" nodes."""
+            if len(node.children) != 1 or not isinstance(node.children[0], docutils.nodes.Text) \
+                    or not all(_ in node.attributes for _ in ('name', 'refuri')):
+                return
+            path = pathlib.Path(node.attributes['refuri'])
+            try:
+                if path.is_absolute():
+                    return
+                resolved_path = path.resolve()
+            except FileNotFoundError:  # in resolve(), prior to Python 3.6
+                return
+            except OSError:  # in is_absolute() and resolve(), on URLs in Windows
+                return
+            try:
+                resolved_path.relative_to(HERE)
+            except ValueError:
+                return
+            if not path.is_file():
+                return
+            assert node.attributes['name'] == node.children[0].astext()
+            self.references.append(node)
+
+        def unknown_visit(self, node: docutils.nodes.Node) -> None:
+            """Call for unknown node types."""
+            return
+
     document = parse_rst(text)
     visitor = SimpleRefCounter(document)
     document.walk(visitor)
@@ -192,7 +196,6 @@ def resolve_relative_rst_links(text: str, base_link: str):
 
 
 class Package:
-
     """Default metadata and behaviour for a Python package setup script."""
 
     root_directory = '.'  # type: str
@@ -208,16 +211,22 @@ class Package:
     long_description = None  # type: str
     """If None, it will be generated from readme."""
 
-    url = 'https://mbdevpl.github.io/'  # type: str
-    download_url = 'https://github.com/mbdevpl'  # type: str
+    long_description_content_type = None  # type: str
+    """If None, it will be set accodring to readme file extension.
+
+    For this field to be automatically set, also long_description field has to be None.
+    """
+
+    url = 'https://github.com/mbdevpl'  # type: str
+    download_url = None  # type: str
     author = 'Mateusz Bysiek'  # type: str
-    author_email = 'mb@mbdev.pl'  # type: str
+    author_email = 'mateusz.bysiek@gmail.com'  # type: str
     # maintainer = None  # type: str
     # maintainer_email = None  # type: str
     license_str = 'Apache License 2.0'  # type: str
 
     classifiers = []  # type: t.List[str]
-    """List of valid project classifiers: https://pypi.python.org/pypi?:action=list_classifiers"""
+    """List of valid project classifiers: https://pypi.org/pypi?:action=list_classifiers"""
 
     keywords = []  # type: t.List[str]
 
@@ -254,27 +263,33 @@ def try_fields(cls, *names) -> t.Optional[t.Any]:
         raise AttributeError((cls, names))
 
     @classmethod
-    def parse_readme(cls, readme_path: str = 'README.rst', encoding: str = 'utf-8') -> str:
+    def parse_readme(cls, readme_path: str = 'README.rst',
+                     encoding: str = 'utf-8') -> t.Tuple[str, str]:
         """Parse readme and resolve relative links in it if it is feasible.
 
         Links are resolved if readme is in rst format and the package is hosted on GitHub.
         """
+        readme_path = pathlib.Path(readme_path)
         with HERE.joinpath(readme_path).open(encoding=encoding) as readme_file:
             long_description = readme_file.read()  # type: str
 
-        if readme_path.endswith('.rst') and cls.download_url.startswith('https://github.com/'):
-            base_url = '{}/blob/v{}/'.format(cls.download_url, cls.version)
+        if readme_path.suffix.lower() == '.rst' and cls.url.startswith('https://github.com/'):
+            base_url = '{}/blob/v{}/'.format(cls.url, cls.version)
             long_description = resolve_relative_rst_links(long_description, base_url)
 
-        return long_description
+        long_description_content_type = {'.rst': 'text/x-rst', '.md': 'text/markdown'}.get(
+            readme_path.suffix.lower(), 'text/plain')
+        long_description_content_type += '; charset=UTF-8'
+
+        return long_description, long_description_content_type
 
     @classmethod
     def prepare(cls) -> None:
         """Fill in possibly missing package metadata."""
         if cls.version is None:
             cls.version = find_version(cls.name)
         if cls.long_description is None:
-            cls.long_description = cls.parse_readme()
+            cls.long_description, cls.long_description_content_type = cls.parse_readme()
         if cls.packages is None:
             cls.packages = find_packages(cls.root_directory)
         if cls.install_requires is None:
@@ -284,11 +299,13 @@ def prepare(cls) -> None:
 
     @classmethod
     def setup(cls) -> None:
-        """Run setuptools.setup() with correct arguments."""
+        """Call setuptools.setup with correct arguments."""
         cls.prepare()
         setuptools.setup(
             name=cls.name, version=cls.version, description=cls.description,
-            long_description=cls.long_description, url=cls.url, download_url=cls.download_url,
+            long_description=cls.long_description,
+            long_description_content_type=cls.long_description_content_type,
+            url=cls.url, download_url=cls.download_url,
             author=cls.author, author_email=cls.author_email,
             maintainer=cls.try_fields('maintainer', 'author'),
             maintainer_email=cls.try_fields('maintainer_email', 'author_email'),

test/test_setup.py

@@ -8,10 +8,11 @@
 import subprocess
 import sys
 import tempfile
+import types
 import typing as t
 import unittest
 
-__updated__ = '2018-02-14'
+__updated__ = '2019-06-04'
 
 
 def run_program(*args, glob: bool = False):
@@ -41,7 +42,7 @@ def run_module(name: str, *args, run_name: str = '__main__') -> None:
     sys.argv = backup_sys_argv
 
 
-def import_module(name: str = 'setup') -> 'module':
+def import_module(name: str = 'setup') -> types.ModuleType:
     setup_module = importlib.import_module(name)
     return setup_module
 
@@ -51,11 +52,6 @@ def import_module_member(module_name: str, member_name: str) -> t.Any:
     return getattr(module, member_name)
 
 
-# def import_module_members(module_name: str, member_names: t.Iterable[str]) -> t.List[t.Any]:
-#    module = import_module(module_name)
-#    return [getattr(module, member_name) for member_name in member_names]
-
-
 CLASSIFIERS_LICENSES = (
     'License :: OSI Approved :: Python License (CNRI Python License)',
     'License :: OSI Approved :: Python Software Foundation License',
@@ -64,28 +60,17 @@ def import_module_member(module_name: str, member_name: str) -> t.Any:
 
 CLASSIFIERS_PYTHON_VERSIONS = tuple("""Programming Language :: Python
 Programming Language :: Python :: 2
-Programming Language :: Python :: 2.3
-Programming Language :: Python :: 2.4
-Programming Language :: Python :: 2.5
-Programming Language :: Python :: 2.6
+Programming Language :: Python :: 2.2
 Programming Language :: Python :: 2.7
 Programming Language :: Python :: 2 :: Only
 Programming Language :: Python :: 3
 Programming Language :: Python :: 3.0
-Programming Language :: Python :: 3.1
-Programming Language :: Python :: 3.2
-Programming Language :: Python :: 3.3
-Programming Language :: Python :: 3.4
 Programming Language :: Python :: 3.5
-Programming Language :: Python :: 3.6
-Programming Language :: Python :: 3.7
 Programming Language :: Python :: 3 :: Only""".splitlines())
 
 CLASSIFIERS_PYTHON_IMPLEMENTATIONS = tuple("""Programming Language :: Python :: Implementation
 Programming Language :: Python :: Implementation :: CPython
-Programming Language :: Python :: Implementation :: IronPython
 Programming Language :: Python :: Implementation :: Jython
-Programming Language :: Python :: Implementation :: MicroPython
 Programming Language :: Python :: Implementation :: PyPy
 Programming Language :: Python :: Implementation :: Stackless""".splitlines())
 
@@ -105,11 +90,6 @@ def import_module_member(module_name: str, member_name: str) -> t.Any:
 
 CLASSIFIERS_PYTHON_IMPLEMENTATIONS_TUPLES = tuple((_,) for _ in CLASSIFIERS_PYTHON_IMPLEMENTATIONS)
 
-# CLASSIFIERS_VARIOUS_PERMUTATIONS = tuple(itertools.chain.from_iterable(
-#    itertools.permutations(..., n)
-#    for n in range(...)
-#    ))
-
 CLASSIFIERS_VARIOUS_COMBINATIONS = tuple(itertools.combinations(
     CLASSIFIERS_VARIOUS, len(CLASSIFIERS_VARIOUS) - 1)) + (CLASSIFIERS_VARIOUS,)
 
@@ -261,23 +241,25 @@ class Package(package):  # pylint: disable=too-few-public-methods
             name = 'package name'
             description = 'package description'
             version = '1.2.3.4'
-            download_url = 'https://github.com/example'
+            url = 'https://github.com/example'
 
         with tempfile.NamedTemporaryFile('w', suffix='.md', delete=False) as temp_file:
             temp_file.write('test test test')
-        result = Package.parse_readme(temp_file.name)
+        result, content_type = Package.parse_readme(temp_file.name)
         os.remove(temp_file.name)
         self.assertIsInstance(result, str)
+        self.assertIsInstance(content_type, str)
 
         prefix = 'https://github.com/example/blob/v1.2.3.4/'
         for name, link, done in LINK_EXAMPLES:
             name = '' if name is None else name + ' '
             text = 'Please see `{}<{}>`_ for details.'.format(name, link)
             with tempfile.NamedTemporaryFile('w', suffix='.rst', delete=False) as temp_file:
                 temp_file.write(text)
-            result = Package.parse_readme(temp_file.name)
+            result, content_type = Package.parse_readme(temp_file.name)
             os.remove(temp_file.name)
             self.assertIsInstance(result, str)
+            self.assertIsInstance(content_type, str)
             if not done:
                 self.assertEqual(result, text)
                 continue
@@ -313,7 +295,7 @@ class Package(package):  # pylint: disable=too-few-public-methods, missing-docst
         Package.prepare()
 
         Package.version = None
-        with self.assertRaises(ImportError):
+        with self.assertRaises(FileNotFoundError):
             Package.prepare()