Update project from its own template via Copier. (v1.10)

.auxiliary/configuration/copier-answers.yaml

@@ -1,15 +1,17 @@
 # Changes here will be overwritten by Copier
-_commit: v1.9
+_commit: v1.10
 _src_path: gh:emcd/python-project-common
 author_email: emcd@users.noreply.github.com
 author_name: Eric McDonald
 description: Project management utilities.
 development_status: 3 - Alpha
 distribution_name: emcd-projects
+enable_cli: false
 enable_property_tests: false
 enable_publication: false
 enable_rust_extension: false
 gh_owner: emcd
+include_data_resources: false
 inject_docstring_utils: false
 inject_exceptions: true
 inject_foundations: true

.editorconfig

@@ -6,22 +6,20 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = space
-indent_size = 4
 end_of_line = lf
-insert_final_newline = false
+indent_size = 4
+indent_style = space
+insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
 max_line_length = 79
 
 [*.{py,py.jinja}]
 max_line_length = 79
-insert_final_newline = true
 
 [*.{rs,rs.jinja}]
 max_line_length = 79
-insert_final_newline = true
 
 [*.{rst,rst.jinja}]
 indent_size = 2
@@ -31,4 +29,4 @@ max_line_length = 79
 indent_size = 2
 
 [*.yaml]
-indent_size = 2
+indent_size = 2

.github/workflows/releaser.yaml

@@ -24,7 +24,7 @@ jobs:
 
   test:
     needs: [initialize]
-    uses: emcd/python-project-common/.github/workflows/xrepo--tester.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--tester.yaml@v1.10
     with:
       matrix-exclusions: '${{ needs.initialize.outputs.matrix-exclusions }}'
       platforms: '${{ needs.initialize.outputs.platforms }}'
@@ -34,7 +34,7 @@ jobs:
 
   report:
     needs: [initialize, test]
-    uses: emcd/python-project-common/.github/workflows/xrepo--reporter.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--reporter.yaml@v1.10
     with:
       python-version: '${{ fromJSON(needs.initialize.outputs.python-versions)[0] }}'
 
@@ -44,18 +44,20 @@ jobs:
       contents: write
       id-token: write
       pages: write
-    uses: emcd/python-project-common/.github/workflows/xrepo--documenter.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--documenter.yaml@v1.10
     with:
       include-reports: true
       python-version: '${{ fromJSON(needs.initialize.outputs.python-versions)[0] }}'
 
   package:
     needs: [initialize, docsgen]
-    uses: emcd/python-project-common/.github/workflows/xrepo--packager.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--packager.yaml@v1.10
     with:
       artifacts-path: '.auxiliary/artifacts/hatch-build' # TODO: Use environment.
       python-version: '${{ fromJSON(needs.initialize.outputs.python-versions)[0] }}'
 
 
 
 
+
+

.github/workflows/tester.yaml

@@ -14,7 +14,7 @@ jobs:
 
   test:
     needs: [initialize]
-    uses: emcd/python-project-common/.github/workflows/xrepo--tester.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--tester.yaml@v1.10
     with:
       matrix-exclusions: '${{ needs.initialize.outputs.matrix-exclusions }}'
       platforms: '${{ needs.initialize.outputs.platforms }}'
@@ -24,6 +24,6 @@ jobs:
 
   report:
     needs: [initialize, test]
-    uses: emcd/python-project-common/.github/workflows/xrepo--reporter.yaml@v1.9
+    uses: emcd/python-project-common/.github/workflows/xrepo--reporter.yaml@v1.10
     with:
       python-version: '${{ fromJSON(needs.initialize.outputs.python-versions)[0] }}'

pyproject.toml

@@ -1,3 +1,6 @@
+# vim: set filetype=toml fileencoding=utf-8:
+# -*- mode: toml ; coding: utf-8 -*-
+
 [build-system]
 requires = [
   'hatchling',
@@ -13,6 +16,9 @@ readme = { 'file' = 'README.rst', 'content-type' = 'text/x-rst' }
 requires-python = '>= 3.10'
 dependencies = [
   'typing-extensions',
+  # --- BEGIN: Injected by Copier ---
+
+  # --- END: Injected by Copier ---
 ]
 classifiers = [ # https://pypi.org/classifiers
   'Development Status :: 3 - Alpha',
@@ -49,7 +55,7 @@ branch = true
 command_line = '-m pytest' # TODO? '--fail-under'
 data_file = '.auxiliary/caches/pytest/coverage.sqlite3'
 parallel = true
-source = [ 'sources', 'tests' ]
+source = [ 'sources' ]
 [tool.coverage.html]
 directory = '.auxiliary/artifacts/coverage-pytest'
 [tool.coverage.xml]
@@ -59,13 +65,23 @@ output = '.auxiliary/artifacts/coverage-pytest/coverage.xml'
 [tool.hatch.build]
 directory = '.auxiliary/artifacts/hatch-build'
 [tool.hatch.build.targets.sdist]
-only-include = [ 'sources/emcd_projects' ]
+only-include = [
+  'sources/emcd_projects',
+  # --- BEGIN: Injected by Copier ---
+
+  # --- END: Injected by Copier ---
+]
 strict-naming = false
 [tool.hatch.build.targets.wheel]
-only-include = [ 'sources/emcd_projects' ]
+only-include = [
+  'sources/emcd_projects',
+  # --- BEGIN: Injected by Copier ---
+
+  # --- END: Injected by Copier ---
+]
 strict-naming = false
 [tool.hatch.build.targets.wheel.sources]
-'sources/emcd_projects' = 'emcd_projects'
+'sources/emcd_projects' = 'emcd_projects' 
 [tool.hatch.envs.default]
 python = '3.10'
 [tool.hatch.envs.develop]
@@ -76,6 +92,7 @@ dependencies = [
   'coverage[toml]',
   'furo',
   'icecream',
+  'isort',
   'packaging',
   'pre-commit',
   'pylint',
@@ -90,8 +107,16 @@ dependencies = [
   'towncrier',
   'tryceratops',
   'yapf',
+  # --- BEGIN: Injected by Copier ---
+
+
+
+  # --- END: Injected by Copier ---
 ]
 post-install-commands = [
+  # --- BEGIN: Injected by Copier ---
+
+  # --- END: Injected by Copier ---
 ]
 [tool.hatch.envs.develop.env-vars]
 PYTHONUNBUFFERED = 'TRUE' # TODO: Only for coverage/pytest.
@@ -114,8 +139,10 @@ linters = [
      sources/emcd_projects''',
 ]
 packagers = [
-  'hatch build',
-  # TODO? Sign packages.
+  '''hatch build''',
+  # --- BEGIN: Injected by Copier ---
+
+  # --- END: Injected by Copier ---
 ]
 testers = [
   'coverage erase',
@@ -239,6 +266,8 @@ ignored-parents = [
   'builtins.TypeError',
   'builtins.ValueError',
   'builtins.type',
+  'typing.Protocol',
+  'typing_extensions.Protocol',
   # --- BEGIN: Injected by Copier ---
   'emcd_projects.exceptions.Omnierror',
   'emcd_projects.exceptions.Omniexception',
@@ -290,15 +319,17 @@ disable = [
   'multiple-statements',
   'reimported',
   'too-few-public-methods',
+  'too-many-positional-arguments',  # 'too-many-arguments' is good enough
   'ungrouped-imports',
+  'unused-wildcard-import',
   'use-dict-literal',
   'using-exception-groups-in-unsupported-version',
   'wrong-import-order',
   'wrong-import-position',
 ]
 # TODO: Latest 'per-file-ignores' code may supports dicts and lists in addition to strings.
 per-file-ignores = '''
-  /tests/:attribute-defined-outside-init,comparison-with-itself,magic-value-comparison,missing-class-docstring,missing-function-docstring,protected-access,singleton-comparison,superfluous-parens,unexpected-keyword-arg
+  /tests/:attribute-defined-outside-init,comparison-with-itself,magic-value-comparison,missing-class-docstring,missing-function-docstring,protected-access,singleton-comparison,superfluous-parens,too-many-try-statements,unexpected-keyword-arg
   __init__\.py:unused-import
 ''' # Note: Paths are regexes.
 [tool.pylint.refactoring]
@@ -349,6 +380,7 @@ reportMatchNotExhaustive = true
 reportMissingImports = true
 reportMissingTypeStubs = true
 reportMissingTypeArgument = true
+reportPossiblyUnboundVariable = false # Covered by other linters.
 reportPrivateImportUsage = false      # Covered by other linters.
 reportPrivateUsage = false            # Covered by other linters.
 reportSelfClsParameterName = false    # Too opinionated.
@@ -374,8 +406,8 @@ stubPath = 'sources/emcd_projects/_typedecls'
 #       attribute on protected modules. Instead, we use Sphinx to run doctests.
 minversion = '8.1'
 addopts = '--capture=no --exitfirst -rfE'
-testpaths = [ 'tests', 'sources' ]
-python_files = [ '*.py' ]
+testpaths = [ 'tests' ]
+python_files = [ 'test_*.py' ]
 python_functions = [ 'test_[0-9][0-9][0-9]_*' ]
 cache_dir = '.auxiliary/caches/pytest'
 

sources/emcd_projects/__/imports.py

@@ -30,6 +30,9 @@
 import types
 
 import typing_extensions as typx
+# --- BEGIN: Injected by Copier ---
+
+# --- END: Injected by Copier ---
 
 
 ComparisonResult: typx.TypeAlias = bool | types.NotImplementedType

sources/emcd_projects/__init__.py

@@ -22,7 +22,9 @@
 
 
 from . import __
+# --- BEGIN: Injected by Copier ---
 from . import exceptions
+# --- END: Injected by Copier ---
 
 
 __version__ = '1.7a0'

tests/test_000_emcd_projects/__init__.py

@@ -24,14 +24,17 @@
 '''
 
 
+import types
+
+
 from types import MappingProxyType as DictionaryProxy
 
 
 PACKAGE_NAME = 'emcd_projects'
 PACKAGES_NAMES = ( PACKAGE_NAME, )
 
 
-_modules_cache = { }
+_modules_cache: dict[ str, types.ModuleType ] = { }
 def cache_import_module( qname ):
     ''' Imports module from package by name and caches it. '''
     from importlib import import_module
@@ -49,7 +52,8 @@ def _discover_module_names( package_name ):
     return tuple(
         path.stem
         for path in Path( package.__file__ ).parent.glob( '*.py' )
-        if '__init__.py' != path.name and path.is_file( ) )
+        if      path.name not in ( '__init__.py', '__main__.py' )
+            and path.is_file( ) )
 
 
 MODULES_NAMES_BY_PACKAGE_NAME = DictionaryProxy( {

tests/test_000_emcd_projects/test_000_package.py

@@ -24,7 +24,7 @@
 import pytest
 
 from . import (
-    MODULES_NAMES_BY_MODULE_QNAME,
+    # MODULES_NAMES_BY_MODULE_QNAME,
     MODULES_QNAMES,
     PACKAGES_NAMES,
     PACKAGES_NAMES_BY_MODULE_QNAME,
@@ -40,23 +40,23 @@ def test_000_sanity( package_name ):
     assert package.__name__ == package_name
 
 
-@pytest.mark.parametrize( 'module_qname', MODULES_QNAMES )
-def test_010_attribute_module_existence( module_qname ):
-    ''' Package module is attribute of package. '''
-    package_name = PACKAGES_NAMES_BY_MODULE_QNAME[ module_qname ]
-    package = cache_import_module( package_name )
-    module_name = MODULES_NAMES_BY_MODULE_QNAME[ module_qname ]
-    assert module_name in package.__dict__
+# @pytest.mark.parametrize( 'module_qname', MODULES_QNAMES )
+# def test_010_attribute_module_existence( module_qname ):
+#     ''' Package module is attribute of package. '''
+#     package_name = PACKAGES_NAMES_BY_MODULE_QNAME[ module_qname ]
+#     package = cache_import_module( package_name )
+#     module_name = MODULES_NAMES_BY_MODULE_QNAME[ module_qname ]
+#     assert module_name in package.__dict__
 
 
-@pytest.mark.parametrize( 'module_qname', MODULES_QNAMES )
-def test_011_attribute_module_classification( module_qname ):
-    ''' Package attribute is module. '''
-    from inspect import ismodule
-    package_name = PACKAGES_NAMES_BY_MODULE_QNAME[ module_qname ]
-    package = cache_import_module( package_name )
-    module_name = MODULES_NAMES_BY_MODULE_QNAME[ module_qname ]
-    assert ismodule( getattr( package, module_name ) )
+# @pytest.mark.parametrize( 'module_qname', MODULES_QNAMES )
+# def test_011_attribute_module_classification( module_qname ):
+#     ''' Package attribute is module. '''
+#     from inspect import ismodule
+#     package_name = PACKAGES_NAMES_BY_MODULE_QNAME[ module_qname ]
+#     package = cache_import_module( package_name )
+#     module_name = MODULES_NAMES_BY_MODULE_QNAME[ module_qname ]
+#     assert ismodule( getattr( package, module_name ) )
 
 
 @pytest.mark.parametrize( 'module_qname', MODULES_QNAMES )