Bash pass string argument to python script

Question

I have a bash script which reads variable from environment and then passes it to the python script like this

#!/usr/bin/env bash

if [ -n "${my_param}" ]
then
    my_param_str="--my_param ${my_param}"
fi

python -u my_script.py ${my_param_str}

Corresponding python script look like this

parser = argparse.ArgumentParser(description='My script')
parser.add_argument('--my_param',
                    type=str,
                    default='')

parsed_args = parser.parse_args()
print(parsed_args.description)

I want to provide string with dash characters "Some -- string" as an argument, but it doesn't work via bash script, but calling directly through command line works ok.

export my_param="Some -- string"
./launch_my_script.sh

gives an error unrecognized arguments: -- string and python my_script.py --my_param "Some -- string" works well. I've tried to play with nargs and escape my_param_str="--my_param '${my_param}'" this way, but both solutions didn't work. Any workaround for this case? Or different approach how to handle this?

-- marks the end of arguments for a command in the normal case. — sjsam
– sjsam, Commented May 19, 2016 at 7:47
You should always double-quote Bash parameter expansions unless you explicitly want Bash to perform word splitting... and you probably don't really want word splitting. :) See the BashGuide and ShellCheck. — PM 2Ring
– PM 2Ring, Commented May 19, 2016 at 7:51
Look at sys.argv to see what bash is giving your script. argparse can only parse the strings in that list. — hpaulj
– hpaulj, Commented May 19, 2016 at 18:55

Colin Emonds · Accepted Answer · 2016-05-19 10:03:48Z

6

Your bash needs to look like this:

if [ -n "${my_param}" ]
then
    my_param_str="--my_param \"${my_param}\""
fi

echo ${my_param_str}|xargs python -u my_script.py

Otherwise, the quotes around the parameter string will not be preserved, and "Some", "--" and "thing" will be passed as three separate arguments.

edited May 19, 2016 at 10:03

answered May 19, 2016 at 8:53

Colin Emonds

7956 silver badges21 bronze badges

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

1 Comment

taranaki Over a year ago

Really nice xargs-fu! Works perfectly with python argparse.

renefritze · Accepted Answer · 2016-05-19 07:44:18Z

2

For the limited example you can basically get the same behavior just using

arg = os.environ.get('my_param', '')

where the first argument to get is the variable name and the second is the default value used should the var not be in the environment.

answered May 19, 2016 at 7:44

renefritze

2,26415 silver badges25 bronze badges

1 Comment

Most Wanted Over a year ago

Thanks, but I tied to bash passing case

Byte Commander · Accepted Answer · 2016-05-19 13:29:43Z

0

The quotes you write around the string do not get preserved when you assign a Bash string variable:

$ export my_param="Some -- string"
$ echo $my_param
Some -- string

You need to place the quotes around the variable again when you use it to create the my_param_str:

my_param_str="--my_param \"${my_param}\""

edited May 19, 2016 at 13:29

answered May 19, 2016 at 7:45

Byte Commander

6,8467 gold badges48 silver badges77 bronze badges

2 Comments

Aran-Fey Over a year ago

That's not right. That would turn my_param_str into a single argument of the form --my_param Some -- string. The quotes should be around Some -- string.

Byte Commander Over a year ago

@Rawing In that case they would have to be written in this line: my_param_str="--my_param \"${my_param}\""

Collectives™ on Stack Overflow

Bash pass string argument to python script

3 Answers 3

1 Comment

1 Comment

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

2 Comments

Related