]> granicus.if.org Git - python/commitdiff
bpo-21018: added missing documentation about escaping characters for configparser...
authorArun Persaud <arun@nubati.net>
Tue, 10 Sep 2019 12:51:09 +0000 (05:51 -0700)
committerJulien Palard <julien@palard.fr>
Tue, 10 Sep 2019 12:51:09 +0000 (14:51 +0200)
Document how $ and % can be escaped in configparser.

Doc/library/configparser.rst

index 04b52dc7b215315a4758212d87b2366af95ffc49..739477f55fddda8f3bd27ac49760552d3b13f7ea 100644 (file)
@@ -313,6 +313,8 @@ from ``get()`` calls.
       my_dir: %(home_dir)s/lumberjack
       my_pictures: %(my_dir)s/Pictures
 
+      [Escape]
+      gain: 80%%  # use a %% to escape the % sign (% is the only character that needs to be escaped)
 
    In the example above, :class:`ConfigParser` with *interpolation* set to
    ``BasicInterpolation()`` would resolve ``%(home_dir)s`` to the value of
@@ -346,6 +348,9 @@ from ``get()`` calls.
       my_dir: ${home_dir}/lumberjack
       my_pictures: ${my_dir}/Pictures
 
+      [Escape]
+      cost: $$80  # use a $$ to escape the $ sign ($ is the only character that needs to be escaped)
+
    Values from other sections can be fetched as well:
 
    .. code-block:: ini