51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
93 lines
3.8 KiB
Plaintext
93 lines
3.8 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Formatting strings, either with the ``++%++`` operator or ``++str.format++`` method, requires a valid string and arguments matching this string's replacement fields.
|
|
|
|
|
|
This also applies to loggers from the ``++logging++`` module. Internally they use ``++%-formatting++``. The only difference is that they will log an error instead of raising an exception when provided arguments are invalid.
|
|
|
|
|
|
Formatted string literals, also called "f-strings", are generally simpler to use, and any syntax mistake will fail at compile time. However it is easy to forget curly braces and it won't raise any error.
|
|
|
|
|
|
This rule raises an issue when:
|
|
|
|
* A string formatted with ``++%++`` will not return the expected string because some arguments are not used.
|
|
* A string formatted with ``++str.format++`` will not return the expected string because some arguments are not used.
|
|
* An "f-string" doesn't contain any replacement field, which probably means that some curly braces are missing.
|
|
* Loggers will log an error because their message is not formatted properly.
|
|
|
|
Rule S2275 covers cases where formatting a string will raise an exception.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
"Error %(message)s" % {"message": "something failed", "extra": "some dead code"} # Noncompliant. Remove the unused argument "extra" or add a replacement field.
|
|
|
|
"Error: User {} has not been able to access []".format("Alice", "MyFile") # Noncompliant. Remove 1 unexpected argument or add a replacement field.
|
|
|
|
user = "Alice"
|
|
resource = "MyFile"
|
|
message = f"Error: User [user] has not been able to access [resource]" # Noncompliant. Add replacement fields or use a normal string instead of an f-string.
|
|
|
|
import logging
|
|
logging.error("Error: User %s has not been able to access %s", "Alice") # Noncompliant. Add 1 missing argument.
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
"Error %(message)s" % {"message": "something failed"}
|
|
|
|
"Error: User {} has not been able to access {}".format("Alice", "MyFile")
|
|
|
|
user = "Alice"
|
|
resource = "MyFile"
|
|
message = f"Error: User {user} has not been able to access {resource}"
|
|
|
|
import logging
|
|
logging.error("Error: User %s has not been able to access %s", "Alice", "MyFile")
|
|
----
|
|
|
|
== Resources
|
|
|
|
* https://docs.python.org/3/library/string.html#format-string-syntax[Python documentation - Format String Syntax]
|
|
* https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting[Python documentation - printf-style String Formatting]
|
|
* https://docs.python.org/3/howto/logging.html#loggers[Python documentation - Loggers]
|
|
* https://docs.python.org/3/howto/logging-cookbook.html#using-particular-formatting-styles-throughout-your-application[Python documentation - Using particular formatting styles throughout your application]
|
|
* https://docs.python.org/3/reference/lexical_analysis.html#formatted-string-literals[Python documentation - Formatted string literals]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
* Add replacement fields or use a normal string instead of an f-string.
|
|
* Remove this unused argument.
|
|
* Remove X unused positional arguments.
|
|
* Fix this formatted string's syntax.
|
|
* Name unnamed replacement field(s).
|
|
* Replace formatting argument(s) with a mapping; Replacement fields are named.
|
|
* Use only positional or named fields, don't mix them.
|
|
* Replace this value with a number as "%d" requires.
|
|
* Replace this value with an integer as "%X" requires.
|
|
* Replace this value with an integer as "*" requires.
|
|
* Add X missing argument(s).
|
|
* Remove X unexpected argument(s); format string expects Y arguments.
|
|
* Replace this key; %-format accepts only string keys.
|
|
* Provide a value for field "X".
|
|
* Remove this unused argument or add a replacement field.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|