emcd-projects 1.17rc0__tar.gz → 1.18__tar.gz

{emcd_projects-1.17rc0 → emcd_projects-1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emcd-projects
-Version: 1.17rc0
+Version: 1.18
 Summary: Project management utilities.
 Project-URL: Homepage, https://github.com/emcd/python-project-common
 Project-URL: Documentation, https://emcd.github.io/python-project-common

{emcd_projects-1.17rc0 → emcd_projects-1.18}/data/copier/answers-maximum.yaml

@@ -10,5 +10,3 @@ enable_cli: true
 enable_executables: true
 inject_foundations: true
 inject_exceptions: true
-inject_immutables: true
-inject_docstring_utils: true

{emcd_projects-1.17rc0 → emcd_projects-1.18}/pyproject.toml

@@ -137,27 +137,31 @@ PYTHONUNBUFFERED = 'TRUE' # TODO: Only for coverage/pytest.
 # --- END: Injected by Copier ---
 [tool.hatch.envs.develop.scripts]
 docsgen = [
-  '''sphinx-build -E -b doctest -d .auxiliary/caches/sphinx \
-     documentation .auxiliary/artifacts/sphinx-doctest''',
-  '''sphinx-build -E -b linkcheck -d .auxiliary/caches/sphinx \
-     documentation .auxiliary/artifacts/sphinx-linkcheck''',
-  '''sphinx-build -a -d .auxiliary/caches/sphinx \
-     documentation .auxiliary/artifacts/sphinx-html''',
+  """sphinx-build -E -b linkcheck -d .auxiliary/caches/sphinx \
+     documentation .auxiliary/artifacts/sphinx-linkcheck""",
+  """sphinx-build -a -d .auxiliary/caches/sphinx \
+     documentation .auxiliary/artifacts/sphinx-html""",
 ]
 linters = [
-  '''ruff check --quiet sources documentation tests''',
+  """ruff check --quiet sources documentation tests""",
   # --- BEGIN: Injected by Copier ---
   # --- END: Injected by Copier ---
-  '''pyright sources''',
+  """pyright sources""",
 ]
 packagers = [
-  '''hatch build''',
+  """hatch build""",
   # --- BEGIN: Injected by Copier ---
   # --- END: Injected by Copier ---
 ]
-testers = [
+testers-no-reports = [
   'coverage erase',
   'coverage run',
+  """coverage run -m sphinx.cmd.build \
+     -E -b doctest -d .auxiliary/caches/sphinx \
+     documentation .auxiliary/artifacts/sphinx-doctest""",
+]
+testers = [
+  'testers-no-reports',
   'coverage combine',
   'coverage report --skip-covered',
   'coverage html',

{emcd_projects-1.17rc0 → emcd_projects-1.18}/sources/emcdproj/__/__init__.py

@@ -21,13 +21,8 @@
 ''' Common constants, imports, and utilities. '''
 
 
-# Expose everything from internal modules.
-from .imports import *
 from .application import Information as ApplicationInformation
 from .distribution import Information as DistributionInformation
 from .imports import *
 from .preparation import *
 from .state import Globals
-
-
-__all__ = ( )

{emcd_projects-1.17rc0 → emcd_projects-1.18}/sources/emcdproj/__/imports.py

@@ -35,6 +35,7 @@ import                      math
 import                      os
 import                      shutil
 import                      sys
+import                      tempfile
 import                      types
 
 from pathlib import Path

{emcd_projects-1.17rc0 → emcd_projects-1.18}/sources/emcdproj/__init__.py

@@ -27,7 +27,7 @@ from . import exceptions
 # --- END: Injected by Copier ---
 
 
-__version__ = '1.17rc0'
+__version__ = '1.18'
 
 
 def main( ):

{emcd_projects-1.17rc0 → emcd_projects-1.18}/sources/emcdproj/template.py

@@ -24,7 +24,6 @@
 from __future__ import annotations
 
 import subprocess as _subprocess
-import tempfile as _tempfile
 
 from . import __
 from . import interfaces as _interfaces
@@ -33,7 +32,7 @@ from . import interfaces as _interfaces
 class CommandDispatcher(
     _interfaces.CliCommand, decorators = ( __.standard_tyro_class, ),
 ):
-    ''' Dispatches commands for static website maintenance. '''
+    ''' Dispatches commands for Copier template maintenance. '''
 
     command: __.typx.Union[
         __.typx.Annotated[
@@ -76,13 +75,18 @@ class ValidateCommand(
         __.typx.Doc( ''' Configuration variant to validate. ''' ),
         __.tyro.conf.Positional,
     ]
+    preserve: __.typx.Annotated[
+        bool,
+        __.typx.Doc( ''' Preserve generated project for inspection? ''' ),
+    ] = False
 
     async def __call__(
         self, auxdata: __.Globals, display: _interfaces.ConsoleDisplay
     ) -> None:
         ''' Copies new project from template for configuration variant. '''
         # TODO: Validate variant argument.
-        validate_variant( auxdata, self.variant )
+        validate_variant(
+            auxdata, self.variant, preserve = self.preserve )
 
 
 def copy_template( answers_file: __.Path, projectdir: __.Path ) -> None:
@@ -103,7 +107,9 @@ def survey_variants( auxdata: __.Globals ) -> __.cabc.Sequence[ str ]:
         if fsent.is_file( ) )
 
 
-def validate_variant( auxdata: __.Globals, variant: str ) -> None:
+def validate_variant(
+    auxdata: __.Globals, variant: str, preserve: bool
+) -> None:
     ''' Validates configuration variant. '''
     answers_file = (
         auxdata.distribution.provide_data_location(
@@ -111,8 +117,8 @@ def validate_variant( auxdata: __.Globals, variant: str ) -> None:
     if not answers_file.is_file( ):
         # TODO: Raise error.
         return
-    with _tempfile.TemporaryDirectory( ) as tmpdir:
-        projectdir = __.Path( tmpdir ) / variant
+    with _manage_temporary_directory( preserve = preserve ) as tmpdir:
+        projectdir = tmpdir / variant
         copy_template( answers_file, projectdir )
         validate_variant_project( projectdir )
 
@@ -125,3 +131,14 @@ def validate_variant_project( projectdir: __.Path ) -> None:
             '--upgrade', 'pip', 'build' ),
         (   'hatch', '--env', 'develop', 'run', 'make-all' ),
     ): _subprocess.run( command, cwd = str( projectdir ), check = True ) # noqa: S603
+
+
+@__.ctxl.contextmanager
+def _manage_temporary_directory(
+    preserve: bool
+) -> __.cabc.Iterator[ __.Path ]:
+    # TODO: Python 3.12: Replace with tempfile.TemporaryDirectory,
+    #                    ( delete = not preserve )
+    location = __.Path( __.tempfile.mkdtemp( ) )
+    yield location
+    if not preserve: __.shutil.rmtree( location )