strip "_command" suffix when generating command name

You often want a command to have the same name as a function it is wrapping. However, this will cause a name collision, if your command is going to call init_data its function can't also be called init_data. So instead it's written as init_data_command, and then the command name has to be specified manually @command("init-data"). Click should remove a _command suffix when generating the command name from the function name.

def init_data(external=False):
    ...

@cli.command
@click.option("--external/--internal")
def init_data_command(external):
    init_data(external=external)

Currently this command would be named init-data-command. After the change, it would be init-data.

@davidism

Hi @davidism, Am I right in assuming the expected behaviour would be that both _command and _cmd suffixes are dropped?

An example using _cmd as a suffix:

click/examples/imagepipe/imagepipe.py

Lines 74 to 98 in fb43272

    
           @cli.command("open") 
        
           @click.option( 
        
               "-i", 
        
               "--image", 
        
               "images", 
        
               type=click.Path(), 
        
               multiple=True, 
        
               help="The image file to open.", 
        
           ) 
        
           @generator 
        
           def open_cmd(images): 
        
               """Loads one or multiple images for processing.  The input parameter 
        
               can be specified multiple times to load more than one image. 
        
               """ 
        
               for image in images: 
        
                   try: 
        
                       click.echo(f"Opening '{image}'") 
        
                       if image == "-": 
        
                           img = Image.open(click.get_binary_stdin()) 
        
                           img.filename = "-" 
        
                       else: 
        
                           img = Image.open(image) 
        
                       yield img 
        
                   except Exception as e: 
        
                       click.echo(f"Could not open image '{image}': {e}", err=True)

Navigation Menu

Repository navigation

strip "_command" suffix when generating command name #2322

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	@cli.command("open")
	@click.option(
	"-i",
	"--image",
	"images",
	type=click.Path(),
	multiple=True,
	help="The image file to open.",
	)
	@generator
	def open_cmd(images):
	"""Loads one or multiple images for processing. The input parameter
	can be specified multiple times to load more than one image.
	"""
	for image in images:
	try:
	click.echo(f"Opening '{image}'")
	if image == "-":
	img = Image.open(click.get_binary_stdin())
	img.filename = "-"
	else:
	img = Image.open(image)
	yield img
	except Exception as e:
	click.echo(f"Could not open image '{image}': {e}", err=True)

strip "_command" suffix when generating command name #2322

Description

Activity

bebleo commented on Sep 10, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions