From 991489091495d30dc982f12acc8b5143ac9f4df1 Mon Sep 17 00:00:00 2001 From: Samuel Bennett Date: Tue, 27 Feb 2024 11:43:42 +0000 Subject: [PATCH] Codestyle upstream (#54) * Update {{ cookiecutter.package_name }}/.github/workflows/sub_package_update.yml Co-authored-by: Stuart Mumford * Upstreaming lessons from SunPy application * Apply suggestions from code review --------- Co-authored-by: Stuart Mumford --- tests/conftest.py | 9 ++++++--- tox.ini | 7 +++++++ {{ cookiecutter.package_name }}/MANIFEST.in | 2 +- {{ cookiecutter.package_name }}/docs/conf.py | 10 ++++------ {{ cookiecutter.package_name }}/pyproject.toml | 1 + .../{{ cookiecutter.module_name }}/__init__.py | 2 +- .../{{ cookiecutter.module_name }}/_dev/scm_version.py | 2 +- .../{{ cookiecutter.module_name }}/example_mod.py | 8 ++++---- 8 files changed, 25 insertions(+), 16 deletions(-) diff --git a/tests/conftest.py b/tests/conftest.py index 2810f0c..6f27dfa 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -64,7 +64,8 @@ def bake_examples(cookies): """ Examples on. """ - result = cookies.bake(extra_context={"include_example_code": "y"}) + result = cookies.bake(extra_context={"include_example_code": "y", + "author_name": "test"}) return _handle_cookiecutter_errors(result) @@ -74,7 +75,8 @@ def bake_examples_compiled(cookies): Examples on. """ result = cookies.bake(extra_context={"include_example_code": "y", - "use_compiled_extensions": "y"}) + "use_compiled_extensions": "y", + "author_name": "test"}) return _handle_cookiecutter_errors(result) @@ -85,5 +87,6 @@ def bake_examples_compiled_dev_version(cookies): """ result = cookies.bake(extra_context={"include_example_code": "y", "use_compiled_extensions": "y", - "enable_dynamic_dev_versions": "y"}) + "enable_dynamic_dev_versions": "y", + "author_name": "test"}) return _handle_cookiecutter_errors(result) diff --git a/tox.ini b/tox.ini index 1e98147..504a53d 100644 --- a/tox.ini +++ b/tox.ini @@ -4,6 +4,13 @@ envlist = build-docs [testenv] +pass_env = + # Custom compiler locations (such as ccache) + CC + # Location of locales (needed by sphinx on some systems) + LOCALE_ARCHIVE + # If the user has set a LC override we should follow it + LC_ALL description = render the template and run all the rendered tox environments skip_install = true deps = diff --git a/{{ cookiecutter.package_name }}/MANIFEST.in b/{{ cookiecutter.package_name }}/MANIFEST.in index cda3fc5..6c13d99 100644 --- a/{{ cookiecutter.package_name }}/MANIFEST.in +++ b/{{ cookiecutter.package_name }}/MANIFEST.in @@ -10,4 +10,4 @@ global-exclude *.pyc *.o # This subpackage is only used in development checkouts # and should not be included in built tarballs prune {{ cookiecutter.module_name }}/_dev -{% endif -%} +{%- endif %} diff --git a/{{ cookiecutter.package_name }}/docs/conf.py b/{{ cookiecutter.package_name }}/docs/conf.py index acbdf7c..fb8c519 100644 --- a/{{ cookiecutter.package_name }}/docs/conf.py +++ b/{{ cookiecutter.package_name }}/docs/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- -# # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a @@ -9,14 +7,14 @@ # -- Project information ----------------------------------------------------- -project = "{{ cookiecutter.package_name }}" -copyright = "2022, {{ cookiecutter.author_name }}" -author = "{{ cookiecutter.author_name }}" - # The full version, including alpha/beta/rc tags from {{ cookiecutter.module_name }} import __version__ release = __version__ +project = "{{ cookiecutter.package_name }}" +copyright = "2022, {{ cookiecutter.author_name }}" +author = "{{ cookiecutter.author_name }}" + # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be diff --git a/{{ cookiecutter.package_name }}/pyproject.toml b/{{ cookiecutter.package_name }}/pyproject.toml index ab3efcf..0c67824 100644 --- a/{{ cookiecutter.package_name }}/pyproject.toml +++ b/{{ cookiecutter.package_name }}/pyproject.toml @@ -36,6 +36,7 @@ open_astronomy_package_template_example = "{{ cookiecutter.module_name }}.exampl test = [ "pytest", "pytest-doctestplus", + "pytest-cov" ] docs = [ "sphinx", diff --git a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/__init__.py b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/__init__.py index c94805a..5bd9399 100644 --- a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/__init__.py +++ b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/__init__.py @@ -6,4 +6,4 @@ __all__ = ['do_primes'] {% else %} __all__ = [] -{%- endif %} +{%- endif -%} diff --git a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/_dev/scm_version.py b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/_dev/scm_version.py index 6c6da82..1bcf0dd 100644 --- a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/_dev/scm_version.py +++ b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/_dev/scm_version.py @@ -9,4 +9,4 @@ except ImportError: raise except Exception as e: - raise ValueError(f'setuptools_scm can not determine version.') from e + raise ValueError('setuptools_scm can not determine version.') from e diff --git a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/example_mod.py b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/example_mod.py index 6f4e0c5..c262053 100644 --- a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/example_mod.py +++ b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/example_mod.py @@ -73,11 +73,11 @@ def main(args=None): primes = do_primes(res.n, res.cy) post = time() - print('Found {0} prime numbers'.format(len(primes))) - print('Largest prime: {0}'.format(primes[-1])) + print(f'Found {len(primes)} prime numbers') + print(f'Largest prime: {primes[-1]}') if res.time: - print('Running time: {0} s'.format(post - pre)) + print(f'Running time: {post - pre} s') if res.prnt: - print('Primes: {0}'.format(primes)) + print(f'Primes: {primes}')