How to invoke @Click (Python) but also pass in other parameters that aren't from Click?

Question

I have a python script that I am trying to invoke from bash/shell/cli. I have used a module called 'Click' before; however, I don't think it's possible to both pass in parameters using 'Click' AND passing in non-click parameters (such as a dictionary or list). Is there a way I can still pass in the non-click parameter? (Below is my attempt at trying to accomplish this:)

response_dict = json.loads(response.text)

@click.command()
@click.argument("md5hash_passed")

def find_pr_id (response, md5hash_passed):
   values = response["values"]
   for item in values:
      item_id = item["id"]
      fromref = item["fromRef"]
      md5_hash = fromref["latestCommit"]
      branch_name = fromref["displayId"]
      if md5_hash == md5hash_passed:
         return item_id

find_pr_id(response_dict)

Thanks in advance.

Philippe · Accepted Answer · 2022-11-08 17:53:43Z

1

You don't run find_pr_id directly, try this:

import click

@click.group()
@click.pass_context
def cli(ctx):
    ctx.obj = json.loads(response.text)

@cli.command()
@click.pass_obj
@click.argument("md5hash_passed")
def find_pr_id (request, md5hash_passed):
    values = request["values"]
    for item in values:
        item_id = item["id"]
        fromref = item["fromRef"]
        md5_hash = fromref["latestCommit"]
        branch_name = fromref["displayId"]
        if md5_hash == md5hash_passed:
            return item_id

if __name__ == "__main__":
    cli()

run with :

python test.py find-pr-id 123

answered Nov 8, 2022 at 17:53

Philippe

27.7k4 gold badges28 silver badges45 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

John Wick Over a year ago

(BTW): find-pr-id is considered a "object" right?

Philippe Over a year ago

ctx.obj is the object, I renamed to request in function find_pr_id.

John Wick Over a year ago

Oh I know :) I was just wondering how to properly reference it. (Thanks again)

Collectives™ on Stack Overflow

How to invoke @Click (Python) but also pass in other parameters that aren't from Click?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related