Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Why are commas not needed for modulo string formatting when printing?
Suppose I have two variables that are called animal and age, and print them as a string in the console like so:
animal = "giraffe"
age = 25
print("A %s can live up to %d years" %(animal,age))
Why shouldn't there be a comma between the string and the %(animal,age) part? Does Python automatically detect that it needs two parameters to execute?
3 answers
You are accessing this answer with a direct link, so it's being shown above all other answers regardless of its score. You can return to the normal view.
% is one of the oldest Python syntaxes for interpolating strings. It basically works like:
template_string % data_tuple
In fact, you can literally do that:
>>> s = "%d %d"
>>> t = (1, 2)
>>> s % t
'1 2'
template_string is the template, data_tuple is the values to be used for rendering the template. Obviously they must match in number - if you have too few values in your tuple you'll get an error.
These days, there are much better ways to do the same thing and I would recommend avoiding %:
-
"A {} can live up to {} years".format(animal, age)"- looks like a plain old function call, like"HeLLo".lower(). -
f"A {animal} can live up to {age}"("f-string") - syntactic sugar to make the above call to.formateasier.
0 comment threads
It is, as you said, an operator so it doesn't make any sense to place a comma somewhere between the operator and the two operands. The first operand is the template string, and the second operand is the tuple with the values to format into the template string. The print() function gets one argument — the result of the formatting operation.
Maybe it helps to bind both operands to names, so the expression becomes a bit simpler:
animal = "giraffe"
age = 25
template = "A %s can live up to %d years"
values = (animal, age)
print(template % values)
The % operator is syntactically no different than other binary operators like + or / and so on.
The following users marked this post as Works for me:
| User | Comment | Date |
|---|---|---|
| Bennshinpoes |
Thread: Works for me Very good explained, and gives me good advice for using the modulo operator. |
Mar 26, 2023 at 18:47 |
The modulo operator is a binary (2 argument) operator which returns a single value, and can be used for both numeric calculations and strings:
x = 5 % 2
print(x) # prints "1"
y = "hello %s" % 3
print(y) # prints "hello 3"
When you use a modulo operator for string substitution, you are creating a single string as the result. In your example, you then pass this created string directly to print() as a single argument. There is no need for a comma because commas are used to separate arguments, and you have only a single argument: the result of the string substitution. The substitution is not being performed by print(), but by the modulo operator itself, as you can see if you construct the string in an interactive Python session without ever calling print():
>>> animal = "giraffe"
>>> age = 25
>>> "A %s can live up to %d years" %(animal,age)
'A giraffe can live up to 25 years'
To put it another way, you don't put a comma before the modulo operator for the same reason you don't put a comma before the plus operator (or any other kind of 2-argument operator):
print(2 + 2) # single argument to print() with the value 4
String formatting
Although it doesn't directly relate to your specific question, be aware that using the modulo operator for string formatting is no longer recommended for new Python code.
You should either use the format() method:
print("A {} can live up to {} years".format(animal, age))
or in Python 3.6 or above, the even more readable f-strings:
print(f"A {animal} can live up to {age} years")
1 comment thread