`auto_dash_names` setting not working when using `Collection` with modules in `__init__`

Open
#1,008 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Reproduce the issue with invoke.yaml, tasks/init.py, tasks/module_a.py, and tasks/module_b.py, then run invoke --list. Trace how the Collection built in tasks/init.py applies auto_dash_names to imported modules. Done means the setting is respected and the listed task names match the configured underscore style.

Written by the indexing model from the issue text.

Description

We've found that auto_dash_names setting is not taking effect when setting up a collection from a module in the __init__.py file

Output
invoke --list             
Available tasks:

  module_a.a-task
  module_b.b-task

The only issue I could find was closed a while back, not sure if this is a symptom of that described in this comment? https://github.com/pyinvoke/invoke/issues/465#issuecomment-319767461

Repro

invoke.yaml:

tasks:
  auto_dash_names: false

tasks/__init__.py:

from invoke import Collection
from . import module_a, module_b
ns = Collection(module_a, module_b)

tasks/module_a.py:

from invoke import task

@task
def a_task(c):
    c.run('echo foo')

tasks/module_b.py:

from invoke import task

@task
def b_task(c):
    c.run('echo bar')
Versions

Python 3.12.2
Invoke 2.2.0

Dominant language
Python
Stars
4.8k
Forks
412
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyinvoke/invoke

All issues in pyinvoke/invoke

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.