wip

Author: ejfine

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: v0.0.31
+_commit: v0.0.31-2-g117b721
 _src_path: gh:LabAutomationAndScreening/copier-base-template.git
 description: Copier template for creating Python libraries and executables
 python_ci_versions:

.devcontainer/devcontainer.json

@@ -59,5 +59,5 @@
   "initializeCommand": "sh .devcontainer/initialize-command.sh",
   "onCreateCommand": "sh .devcontainer/on-create-command.sh",
   "postStartCommand": "sh .devcontainer/post-start-command.sh"
-  // Devcontainer context hash (do not manually edit this, it's managed by a pre-commit hook): bbebc7c9
+  // Devcontainer context hash (do not manually edit this, it's managed by a pre-commit hook): 2308a2ae # spellchecker:disable-line
 }

.github/workflows/hash_git_files.py

@@ -10,6 +10,10 @@
     "  // Devcontainer context hash (do not manually edit this, it's managed by a pre-commit hook): "
 )
 
+DEVCONTAINER_COMMENT_LINE_SUFFIX = (
+    " # spellchecker:disable-line"  # the typos hook can sometimes mess with the hash without this
+)
+
 
 def get_tracked_files(repo_path: Path) -> list[str]:
     """Return a list of files tracked by Git in the given repository folder, using the 'git ls-files' command."""
@@ -76,9 +80,13 @@ def find_devcontainer_hash_line(lines: list[str]) -> tuple[int, str | None]:
     for i in range(len(lines) - 1, -1, -1):
         if lines[i].strip() == "}":
             # Check the line above it
-            if i > 0 and lines[i - 1].startswith(DEVCONTAINER_COMMENT_LINE_PREFIX):
-                current_hash = lines[i - 1].split(": ", 1)[1].strip()
-                return i - 1, current_hash
+            if i > 0:
+                above_line = lines[i - 1]
+                if above_line.startswith(DEVCONTAINER_COMMENT_LINE_PREFIX):
+                    part_after_prefix = above_line.split(": ", 1)[1]
+                    part_before_suffix = part_after_prefix.split("#")[0]
+                    current_hash = part_before_suffix.strip()
+                    return i - 1, current_hash
             return i, None
     return -1, None
 
@@ -102,12 +110,13 @@ def update_devcontainer_context_hash(devcontainer_json_file: Path, new_hash: str
             lines = file.readlines()
 
         line_index, current_hash = find_devcontainer_hash_line(lines)
+        new_hash_line = f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}{DEVCONTAINER_COMMENT_LINE_SUFFIX}\n"
         if current_hash is not None:
             # Replace the old hash with the new hash
-            lines[line_index] = f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}\n"
+            lines[line_index] = new_hash_line
         else:
             # Insert the new hash line above the closing `}`
-            lines.insert(line_index, f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}\n")
+            lines.insert(line_index, new_hash_line)
 
         # Write the updated lines back to the file
         with devcontainer_json_file.open("w", encoding="utf-8") as file:

_typos.toml

@@ -1,3 +1,9 @@
+[default]
+extend-ignore-re = [
+# Line ignore with trailing: # spellchecker:disable-line
+"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"
+]
+
 [default.extend-words]
 # Words managed by the base template
 # `astroid` is the name of a python library, and it is used in pylint configuration. should not be corrected to asteroid

extensions/context.py

@@ -52,6 +52,8 @@ def hook(self, context: dict[Any, Any]) -> dict[Any, Any]:
         context["gha_setup_node"] = "v4.3.0"
         context["gha_action_gh_release"] = "v2.2.1"
         context["gha_mutex"] = "1ebad517141198e08d47cf72f3c0975316620a65 # v1.0.0-alpha.10"
+        context["gha_pypi_publish"] = v1.12.4"
+        context["gha_sleep"] = "v2.0.3"
         context["gha_linux_runner"] = "ubuntu-24.04"
         context["gha_windows_runner"] = "windows-2025"
 

template/.github/workflows/hash_git_files.py

@@ -10,6 +10,10 @@
     "  // Devcontainer context hash (do not manually edit this, it's managed by a pre-commit hook): "
 )
 
+DEVCONTAINER_COMMENT_LINE_SUFFIX = (
+    " # spellchecker:disable-line"  # the typos hook can sometimes mess with the hash without this
+)
+
 
 def get_tracked_files(repo_path: Path) -> list[str]:
     """Return a list of files tracked by Git in the given repository folder, using the 'git ls-files' command."""
@@ -76,9 +80,13 @@ def find_devcontainer_hash_line(lines: list[str]) -> tuple[int, str | None]:
     for i in range(len(lines) - 1, -1, -1):
         if lines[i].strip() == "}":
             # Check the line above it
-            if i > 0 and lines[i - 1].startswith(DEVCONTAINER_COMMENT_LINE_PREFIX):
-                current_hash = lines[i - 1].split(": ", 1)[1].strip()
-                return i - 1, current_hash
+            if i > 0:
+                above_line = lines[i - 1]
+                if above_line.startswith(DEVCONTAINER_COMMENT_LINE_PREFIX):
+                    part_after_prefix = above_line.split(": ", 1)[1]
+                    part_before_suffix = part_after_prefix.split("#")[0]
+                    current_hash = part_before_suffix.strip()
+                    return i - 1, current_hash
             return i, None
     return -1, None
 
@@ -102,12 +110,13 @@ def update_devcontainer_context_hash(devcontainer_json_file: Path, new_hash: str
             lines = file.readlines()
 
         line_index, current_hash = find_devcontainer_hash_line(lines)
+        new_hash_line = f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}{DEVCONTAINER_COMMENT_LINE_SUFFIX}\n"
         if current_hash is not None:
             # Replace the old hash with the new hash
-            lines[line_index] = f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}\n"
+            lines[line_index] = new_hash_line
         else:
             # Insert the new hash line above the closing `}`
-            lines.insert(line_index, f"{DEVCONTAINER_COMMENT_LINE_PREFIX}{new_hash}\n")
+            lines.insert(line_index, new_hash_line)
 
         # Write the updated lines back to the file
         with devcontainer_json_file.open("w", encoding="utf-8") as file:

template/.github/workflows/publish.yaml.jinja

@@ -171,7 +171,7 @@ jobs:
 
 {% endraw %}{% else %}{% raw %}
       - name: Publish distribution to Test PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@{% endraw %}{{ gha_pypi_publish }}{% raw %}
         with:
           attestations: false
           repository-url: https://test.pypi.org/legacy/
@@ -189,7 +189,7 @@ jobs:
           python-version: {% endraw %}{{ python_version }}{% raw %}
 {% endraw %}{% if python_package_registry == "PyPI" %}{% raw %}
       - name: Sleep to allow PyPI Index to update before proceeding to the next step
-        uses: juliangruber/sleep-action@v2.0.3
+        uses: juliangruber/sleep-action@{% endraw %}{{ gha_sleep }}{% raw %}
         with:
           time: 60s{% endraw %}{% endif %}{% raw %}
       - name: Install from staging registry
@@ -245,7 +245,7 @@ jobs:
 
 {% endraw %}{% else %}{% raw %}
       - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@{% endraw %}{{ gha_pypi_publish }}{% raw %}
         with:
           attestations: false{% endraw %}{% endif %}{% raw %}
 
@@ -261,7 +261,7 @@ jobs:
           python-version: {% endraw %}{{ python_version }}{% raw %}
 {% endraw %}{% if python_package_registry == "PyPI" %}{% raw %}
       - name: Sleep to allow PyPI Index to update before proceeding to the next step
-        uses: juliangruber/sleep-action@v2.0.3
+        uses: juliangruber/sleep-action@{% endraw %}{{ gha_sleep }}{% raw %}
         with:
           time: 60s{% endraw %}{% endif %}{% raw %}
       - name: Install from primary registry

template/_typos.toml

@@ -1,3 +1,9 @@
+[default]
+extend-ignore-re = [
+# Line ignore with trailing: # spellchecker:disable-line
+"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"
+]
+
 [default.extend-words]
 # Words managed by the base template
 # `astroid` is the name of a python library, and it is used in pylint configuration. should not be corrected to asteroid