summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsblondon <stephane.blondon@gmail.com>2023-02-16 15:13:21 (GMT)
committerGitHub <noreply@github.com>2023-02-16 15:13:21 (GMT)
commit924a3bfa28578802eb9ca77a66fb5d4762a62f14 (patch)
treef16fad89a3e3e096f791cc773d4e13b0407cee60
parent739c026f4488bd2e37d500a2c3d948aaf929b641 (diff)
downloadcpython-924a3bfa28578802eb9ca77a66fb5d4762a62f14.zip
cpython-924a3bfa28578802eb9ca77a66fb5d4762a62f14.tar.gz
cpython-924a3bfa28578802eb9ca77a66fb5d4762a62f14.tar.bz2
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
* Replace bitbucket.org domain by forge.example * Update example to python.org * Use explicitly invalid domain topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
-rw-r--r--Doc/library/configparser.rst46
1 files changed, 23 insertions, 23 deletions
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index a925a3d..a7f75fd 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -69,10 +69,10 @@ Let's take a very basic configuration file that looks like this:
CompressionLevel = 9
ForwardX11 = yes
- [bitbucket.org]
+ [forge.example]
User = hg
- [topsecret.server.com]
+ [topsecret.server.example]
Port = 50022
ForwardX11 = no
@@ -89,10 +89,10 @@ creating the above configuration file programmatically.
>>> config['DEFAULT'] = {'ServerAliveInterval': '45',
... 'Compression': 'yes',
... 'CompressionLevel': '9'}
- >>> config['bitbucket.org'] = {}
- >>> config['bitbucket.org']['User'] = 'hg'
- >>> config['topsecret.server.com'] = {}
- >>> topsecret = config['topsecret.server.com']
+ >>> config['forge.example'] = {}
+ >>> config['forge.example']['User'] = 'hg'
+ >>> config['topsecret.server.example'] = {}
+ >>> topsecret = config['topsecret.server.example']
>>> topsecret['Port'] = '50022' # mutates the parser
>>> topsecret['ForwardX11'] = 'no' # same here
>>> config['DEFAULT']['ForwardX11'] = 'yes'
@@ -115,28 +115,28 @@ back and explore the data it holds.
>>> config.read('example.ini')
['example.ini']
>>> config.sections()
- ['bitbucket.org', 'topsecret.server.com']
- >>> 'bitbucket.org' in config
+ ['forge.example', 'topsecret.server.example']
+ >>> 'forge.example' in config
True
- >>> 'bytebong.com' in config
+ >>> 'python.org' in config
False
- >>> config['bitbucket.org']['User']
+ >>> config['forge.example']['User']
'hg'
>>> config['DEFAULT']['Compression']
'yes'
- >>> topsecret = config['topsecret.server.com']
+ >>> topsecret = config['topsecret.server.example']
>>> topsecret['ForwardX11']
'no'
>>> topsecret['Port']
'50022'
- >>> for key in config['bitbucket.org']: # doctest: +SKIP
+ >>> for key in config['forge.example']: # doctest: +SKIP
... print(key)
user
compressionlevel
serveraliveinterval
compression
forwardx11
- >>> config['bitbucket.org']['ForwardX11']
+ >>> config['forge.example']['ForwardX11']
'yes'
As we can see above, the API is pretty straightforward. The only bit of magic
@@ -154,15 +154,15 @@ configuration while the previously existing keys are retained.
>>> another_config = configparser.ConfigParser()
>>> another_config.read('example.ini')
['example.ini']
- >>> another_config['topsecret.server.com']['Port']
+ >>> another_config['topsecret.server.example']['Port']
'50022'
- >>> another_config.read_string("[topsecret.server.com]\nPort=48484")
- >>> another_config['topsecret.server.com']['Port']
+ >>> another_config.read_string("[topsecret.server.example]\nPort=48484")
+ >>> another_config['topsecret.server.example']['Port']
'48484'
- >>> another_config.read_dict({"topsecret.server.com": {"Port": 21212}})
- >>> another_config['topsecret.server.com']['Port']
+ >>> another_config.read_dict({"topsecret.server.example": {"Port": 21212}})
+ >>> another_config['topsecret.server.example']['Port']
'21212'
- >>> another_config['topsecret.server.com']['ForwardX11']
+ >>> another_config['topsecret.server.example']['ForwardX11']
'no'
This behaviour is equivalent to a :meth:`ConfigParser.read` call with several
@@ -195,9 +195,9 @@ recognizes Boolean values from ``'yes'``/``'no'``, ``'on'``/``'off'``,
>>> topsecret.getboolean('ForwardX11')
False
- >>> config['bitbucket.org'].getboolean('ForwardX11')
+ >>> config['forge.example'].getboolean('ForwardX11')
True
- >>> config.getboolean('bitbucket.org', 'Compression')
+ >>> config.getboolean('forge.example', 'Compression')
True
Apart from :meth:`~ConfigParser.getboolean`, config parsers also
@@ -224,7 +224,7 @@ provide fallback values:
Please note that default values have precedence over fallback values.
For instance, in our example the ``'CompressionLevel'`` key was
specified only in the ``'DEFAULT'`` section. If we try to get it from
-the section ``'topsecret.server.com'``, we will always get the default,
+the section ``'topsecret.server.example'``, we will always get the default,
even if we specify a fallback:
.. doctest::
@@ -239,7 +239,7 @@ the ``fallback`` keyword-only argument:
.. doctest::
- >>> config.get('bitbucket.org', 'monster',
+ >>> config.get('forge.example', 'monster',
... fallback='No such things as monsters')
'No such things as monsters'