Merge ~cjwatson/launchpadlib:py3-doctests into launchpadlib:main

[Colin Watson]

Fix doctests for Python 3

The doctests are currently only run via Launchpad's test suite, and we'd accidentally not been running them since renaming from `.txt` to `.rst` in 1.10.8.

[Jürgen Gmach (jugmac00)]

I was wondering why this package is not tested in isolation... but then again I found this line:

>>> web_root = "http://launchpad.test:8085/"

review: Approve

[Andrey Fedoseev (andrey-fedoseev)]

LGTM

> we'd accidentally not been running them since renaming from `.txt` to `.rst` in 1.10.8.

Shall we be running them from now on?

review: Approve

[Colin Watson (cjwatson)]

Indeed, at the moment we can only run these tests by using Launchpad itself as a test fixture.

We'll be running them again once we upgrade Launchpad to this version of launchpadlib. I'll get on that!

diff --git a/NEWS.rst b/NEWS.rst
index ac72636..d1ab45a 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -6,6 +6,7 @@ NEWS for launchpadlib
 ====================
 - Generate coverage report.
 - Use ``pytest`` as test runner.
+- Fix doctests for Python 3.
 
 1.10.16 (2022-01-21)
 ====================
diff --git a/src/launchpadlib/docs/command-line.rst b/src/launchpadlib/docs/command-line.rst
index 8fd0ef8..4f8d6e9 100644
--- a/src/launchpadlib/docs/command-line.rst
+++ b/src/launchpadlib/docs/command-line.rst
@@ -33,8 +33,8 @@ token and the available access levels.
     oauth_token_consumer
     oauth_token_secret
 
-    >>> print token_json['lp.context']
+    >>> print(token_json['lp.context'])
     context
 
-    >>> print token_json['oauth_token_consumer']
+    >>> print(token_json['oauth_token_consumer'])
     consumer
diff --git a/src/launchpadlib/docs/hosted-files.rst b/src/launchpadlib/docs/hosted-files.rst
index 98d8125..1ba1beb 100644
--- a/src/launchpadlib/docs/hosted-files.rst
+++ b/src/launchpadlib/docs/hosted-files.rst
@@ -16,11 +16,11 @@ you try to upload a non-image for a field that expects an image.
     'image/png'
     >>> file_handle.filename
     'nonimage.txt'
-    >>> file_handle.write("Not an image.")
+    >>> file_handle.write(b"Not an image.")
     >>> try:
     ...     file_handle.close()
-    ... except HTTPError, e:
-    ...     print e.content
+    ... except HTTPError as e:
+    ...     print(e.content.decode())
     <BLANKLINE>
     The file uploaded was not recognized as an image; please
     check it and retry.
@@ -31,7 +31,8 @@ Of course, uploading an image works fine.
     >>> def load_image(filename):
     ...     image_file = os.path.join(
     ...         os.path.dirname(__file__), 'files', filename)
-    ...     return open(image_file).read()
+    ...     with open(image_file, "rb") as f:
+    ...         return f.read()
     >>> image = load_image("mugshot.png")
     >>> len(image)
     2260
@@ -51,11 +52,11 @@ written to a particular file.
     'image/png'
     >>> file_handle.filename
     'nonimage.txt'
-    >>> file_handle.write("Not an image.")
+    >>> file_handle.write(b"Not an image.")
     >>> file_handle.close()
     Traceback (most recent call last):
     ...
-    BadRequest: HTTP Error 400: Bad Request
+    lazr.restfulclient.errors.BadRequest: HTTP Error 400: Bad Request
     ...
 
 == Caching ==
@@ -70,7 +71,7 @@ mechanism.
     >>> import httplib2
     >>> httplib2.debuglevel = 1
     >>> launchpad = salgado_with_full_permissions.login()
-    connect: ...
+    send: ...
     >>> mugshot = launchpad.me.mugshot
     send: ...
 
@@ -90,14 +91,13 @@ already have a fresh copy.
     >>> len(mugshot.open().read())
     send: ...
     reply: 'HTTP/1.1 303 See Other...
-    header: Location: http://.../image.png
-    ...
+    header: Location...
     2260
 
 Finally, some cleanup code that deletes the mugshot.
 
     >>> mugshot.delete()
-    send: 'DELETE...
+    send: b'DELETE...
     reply: 'HTTP/1.1 200...
 
     >>> httplib2.debuglevel = 0
diff --git a/src/launchpadlib/docs/introduction.rst b/src/launchpadlib/docs/introduction.rst
index 722ebac..0bb321e 100644
--- a/src/launchpadlib/docs/introduction.rst
+++ b/src/launchpadlib/docs/introduction.rst
@@ -75,9 +75,9 @@ behalf.
     >>> from launchpadlib.testing.helpers import (
     ...     TestableLaunchpad as Launchpad)
     >>> launchpad = Launchpad(credentials=credentials)
-    >>> sorted(launchpad.people)
+    >>> list(launchpad.people)
     [...]
-    >>> sorted(launchpad.bugs)
+    >>> list(launchpad.bugs)
     [...]
 
 If available, the Gnome keyring or KDE wallet will be used to store access
@@ -102,9 +102,9 @@ appropriate instance variables and use the save() method.
 And the credentials are perfectly valid for accessing Launchpad.
 
     >>> launchpad = Launchpad(credentials=credentials)
-    >>> sorted(launchpad.people)
+    >>> list(launchpad.people)
     [...]
-    >>> sorted(launchpad.bugs)
+    >>> list(launchpad.bugs)
     [...]
 
 The credentials can also be retrieved from the file, so that the OAuth request
@@ -126,22 +126,22 @@ dance can be avoided.
 These credentials too, are perfectly usable to access Launchpad.
 
     >>> launchpad = Launchpad(credentials=credentials)
-    >>> sorted(launchpad.people)
+    >>> list(launchpad.people)
     [...]
-    >>> sorted(launchpad.bugs)
+    >>> list(launchpad.bugs)
     [...]
 
 The security of the stored credentials is left up to the file-like object.
 Here, the application decides to use a dubious encryption algorithm to hide
 Salgado's credentials.
 
-    >>> from StringIO import StringIO
+    >>> import io
     >>> from codecs import EncodedFile
-    >>> encrypted_file = StringIO()
+    >>> encrypted_file = io.BytesIO()
     >>> stream = EncodedFile(encrypted_file, 'rot_13', 'ascii')
     >>> credentials.save(stream)
-    >>> stream.seek(0, 0)
-    >>> print ''.join(sorted(encrypted_file))
+    >>> _ = stream.seek(0, 0)
+    >>> print(''.join(sorted([line.decode() for line in encrypted_file])))
     [1]
     <BLANKLINE>
     <BLANKLINE>
@@ -150,7 +150,7 @@ Salgado's credentials.
     pbafhzre_frperg =
     pbafhzre_xrl = ynhapucnq-yvoenel
 
-    >>> stream.seek(0)
+    >>> _ = stream.seek(0)
     >>> credentials = Credentials()
     >>> credentials.load(stream)
     >>> credentials.consumer.key
@@ -179,7 +179,7 @@ of the Launchpad dataset.
     >>> launchpad = Launchpad(credentials=credentials)
 
     >>> salgado = launchpad.people['salgado']
-    >>> print salgado.display_name
+    >>> print(salgado.display_name)
     Guilherme Salgado
 
 An anonymous client can't modify the dataset, or read any data that's
@@ -188,14 +188,14 @@ permission-controlled or scoped to a particular user.
     >>> launchpad.me
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
     >>> salgado.display_name = "This won't work."
     >>> salgado.lp_save()
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
 Convenience
@@ -207,13 +207,13 @@ to provide is the consumer name.
 
     >>> launchpad = Launchpad.login_anonymously(
     ...     'launchpad-library', service_root="test_dev")
-    >>> sorted(launchpad.people)
+    >>> list(launchpad.people)
     [...]
 
     >>> launchpad.me
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
 Otherwise, the application should obtain authorization from the user
@@ -244,7 +244,7 @@ attribute of the Credentials object.
     True
     >>> credentials._request_token.secret is not None
     True
-    >>> print credentials._request_token.context
+    >>> print(credentials._request_token.context)
     firefox
 
 Now the user must authorize that token, and this is the part we can't
@@ -282,7 +282,7 @@ fields set as if you had asked for the default URI token format.
     True
     >>> credentials._request_token.secret is not None
     True
-    >>> print credentials._request_token.context
+    >>> print(credentials._request_token.context)
     firefox
 
 
@@ -292,32 +292,33 @@ Credentials file errors
 If the credentials file is empty, loading it raises an exception.
 
     >>> credentials = Credentials()
-    >>> credentials.load(StringIO())
+    >>> credentials.load(io.StringIO())
     Traceback (most recent call last):
     ...
-    CredentialsFileError: No configuration for version 1
+    lazr.restfulclient.errors.CredentialsFileError: No configuration for
+    version 1
 
 It is an error to save a credentials file when no consumer or access token is
 available.
 
     >>> credentials.consumer = None
-    >>> credentials.save(StringIO())
+    >>> credentials.save(io.StringIO())
     Traceback (most recent call last):
     ...
-    CredentialsFileError: No consumer
+    lazr.restfulclient.errors.CredentialsFileError: No consumer
 
     >>> credentials.consumer = consumer
     >>> credentials.access_token = None
-    >>> credentials.save(StringIO())
+    >>> credentials.save(io.StringIO())
     Traceback (most recent call last):
     ...
-    CredentialsFileError: No access token
+    lazr.restfulclient.errors.CredentialsFileError: No access token
 
 The credentials file is not intended to be edited, but because it's human
 readable, that's of course possible.  If the credentials file gets corrupted,
 an error is raised.
 
-    >>> credentials_file = StringIO("""\
+    >>> credentials_file = io.StringIO("""\
     ... [1]
     ... #consumer_key: aardvark
     ... consumer_secret: badger
@@ -327,9 +328,9 @@ an error is raised.
     >>> credentials.load(credentials_file)
     Traceback (most recent call last):
     ...
-    NoOptionError: No option 'consumer_key' in section: '1'
+    configparser.NoOptionError: No option 'consumer_key' in section: '1'
 
-    >>> credentials_file = StringIO("""\
+    >>> credentials_file = io.StringIO("""\
     ... [1]
     ... consumer_key: aardvark
     ... #consumer_secret: badger
@@ -339,9 +340,9 @@ an error is raised.
     >>> credentials.load(credentials_file)
     Traceback (most recent call last):
     ...
-    NoOptionError: No option 'consumer_secret' in section: '1'
+    configparser.NoOptionError: No option 'consumer_secret' in section: '1'
 
-    >>> credentials_file = StringIO("""\
+    >>> credentials_file = io.StringIO("""\
     ... [1]
     ... consumer_key: aardvark
     ... consumer_secret: badger
@@ -351,9 +352,9 @@ an error is raised.
     >>> credentials.load(credentials_file)
     Traceback (most recent call last):
     ...
-    NoOptionError: No option 'access_token' in section: '1'
+    configparser.NoOptionError: No option 'access_token' in section: '1'
 
-    >>> credentials_file = StringIO("""\
+    >>> credentials_file = io.StringIO("""\
     ... [1]
     ... consumer_key: aardvark
     ... consumer_secret: badger
@@ -363,7 +364,7 @@ an error is raised.
     >>> credentials.load(credentials_file)
     Traceback (most recent call last):
     ...
-    NoOptionError: No option 'access_secret' in section: '1'
+    configparser.NoOptionError: No option 'access_secret' in section: '1'
 
 
 Bad credentials
@@ -378,7 +379,7 @@ The application is not allowed to access Launchpad with a bad access token.
     >>> launchpad = Launchpad(credentials=credentials)
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
 The application is not allowed to access Launchpad with a consumer
@@ -391,7 +392,7 @@ name that doesn't match the credentials.
     >>> launchpad = Launchpad(credentials=credentials)
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
 The application is not allowed to access Launchpad with a bad access secret.
@@ -403,7 +404,7 @@ The application is not allowed to access Launchpad with a bad access secret.
     >>> launchpad = Launchpad(credentials=credentials)
     Traceback (most recent call last):
     ...
-    Unauthorized: HTTP Error 401: Unauthorized
+    lazr.restfulclient.errors.Unauthorized: HTTP Error 401: Unauthorized
     ...
 
 Clean up
diff --git a/src/launchpadlib/docs/people.rst b/src/launchpadlib/docs/people.rst
index d1dc629..83a98c8 100644
--- a/src/launchpadlib/docs/people.rst
+++ b/src/launchpadlib/docs/people.rst
@@ -21,29 +21,29 @@ The list of people is available from the service root.
 
 The list of people is not fetched until you actually use data.
 
-    >>> print people._wadl_resource.representation
+    >>> print(people._wadl_resource.representation)
     None
 
     >>> len(people)
     4
 
-    >>> print people._wadl_resource.representation
+    >>> print(people._wadl_resource.representation)
     {...}
 
 The 'me' attribute is also available from the service root. It's a
 quick way to get a reference to your own user account.
 
     >>> me = launchpad.me
-    >>> me.name
-    u'salgado'
+    >>> print(me.name)
+    salgado
 
 You can find a person by name.
 
     >>> salgado = launchpad.people['salgado']
-    >>> salgado.name
-    u'salgado'
-    >>> salgado.display_name
-    u'Guilherme Salgado'
+    >>> print(salgado.name)
+    salgado
+    >>> print(salgado.display_name)
+    Guilherme Salgado
     >>> salgado.is_team
     False
 
@@ -67,8 +67,8 @@ You can find a person by email.
 
     >>> email = salgado.preferred_email_address.email
     >>> salgado = launchpad.people.getByEmail(email=email)
-    >>> salgado.name
-    u'salgado'
+    >>> print(salgado.name)
+    salgado
 
 Besides a name and a display name, a person has many other attributes that you
 can read.
@@ -79,7 +79,7 @@ can read.
 
     >>> salgado.karma
     0
-    >>> print salgado.homepage_content
+    >>> print(salgado.homepage_content)
     None
     >>> #salgado.mugshot
     >>> #salgado.languages
@@ -87,7 +87,7 @@ can read.
     False
     >>> salgado.date_created
     datetime.datetime(2005, 6, 6, 8, 59, 51, 596025, ...)
-    >>> print salgado.time_zone
+    >>> print(salgado.time_zone)
     UTC
     >>> salgado.is_valid
     True
@@ -100,10 +100,10 @@ can read.
     >>> #salgado.teams_indirectly_participated_in
     >>> #salgado.confirmed_email_addresses
     >>> #salgado.preferred_email_address
-    >>> salgado.mailing_list_auto_subscribe_policy
-    u'Ask me when I join a team'
-    >>> salgado.visibility
-    u'Public'
+    >>> print(salgado.mailing_list_auto_subscribe_policy)
+    Ask me when I join a team
+    >>> print(salgado.visibility)
+    Public
 
 
 Teams
@@ -112,16 +112,16 @@ Teams
 You also access teams using the same interface.
 
     >>> team = launchpad.people['ubuntu-team']
-    >>> team.name
-    u'ubuntu-team'
-    >>> team.display_name
-    u'Ubuntu Team'
+    >>> print(team.name)
+    ubuntu-team
+    >>> print(team.display_name)
+    Ubuntu Team
     >>> team.is_team
     True
 
 Regular people have team attributes, but they're not used.
 
-    >>> print salgado.team_owner
+    >>> print(salgado.team_owner)
     None
 
 You can find out how a person has membership in a team.
@@ -143,27 +143,27 @@ this requires only the new team's name, owner and display name.
 
     >>> bassists = launchpad.people.newTeam(
     ...     name='bassists', display_name='Awesome Rock Bass Players')
-    >>> bassists.name
-    u'bassists'
-    >>> bassists.display_name
-    u'Awesome Rock Bass Players'
+    >>> print(bassists.name)
+    bassists
+    >>> print(bassists.display_name)
+    Awesome Rock Bass Players
     >>> bassists.is_team
     True
 
 And of course, that team is now accessible directly.
 
     >>> bassists = launchpad.people['bassists']
-    >>> bassists.name
-    u'bassists'
-    >>> bassists.display_name
-    u'Awesome Rock Bass Players'
+    >>> print(bassists.name)
+    bassists
+    >>> print(bassists.display_name)
+    Awesome Rock Bass Players
 
 You cannot create the same team twice.
 
     >>> launchpad.people.newTeam(name='bassists', display_name='Bass Gods')
     Traceback (most recent call last):
     ...
-    BadRequest: HTTP Error 400: Bad Request
+    lazr.restfulclient.errors.BadRequest: HTTP Error 400: Bad Request
     ...
 
 Actually, the exception contains other useful information.
@@ -172,25 +172,25 @@ Actually, the exception contains other useful information.
     >>> try:
     ...     launchpad.people.newTeam(
     ...         name='bassists', display_name='Bass Gods')
-    ... except HTTPError, error:
-    ...     pass
+    ... except HTTPError as e:
+    ...     error = e
     >>> error.response['status']
     '400'
-    >>> error.content
-    'name: bassists is already in use by another person or team.'
+    >>> print(error.content.decode())
+    name: bassists is already in use by another person or team.
 
 Besides a name and a display name, a team has many other attributes that you
 can read.
 
     >>> bassists.karma
     0
-    >>> print bassists.homepage_content
+    >>> print(bassists.homepage_content)
     None
     >>> bassists.hide_email_addresses
     False
     >>> bassists.date_created
     datetime.datetime(...)
-    >>> print bassists.time_zone
+    >>> print(bassists.time_zone)
     UTC
     >>> bassists.is_valid
     True
@@ -209,15 +209,15 @@ can read.
     >>> #bassists.invited_members
     >>> #bassists.member_memberships
     >>> #bassists.proposed_members
-    >>> bassists.visibility
-    u'Public'
-    >>> print bassists.team_description
+    >>> print(bassists.visibility)
+    Public
+    >>> print(bassists.team_description)
     None
-    >>> bassists.subscription_policy
-    u'Moderated Team'
-    >>> bassists.renewal_policy
-    u'invite them to apply for renewal'
-    >>> print bassists.default_membership_period
+    >>> print(bassists.subscription_policy)
+    Moderated Team
+    >>> print(bassists.renewal_policy)
+    invite them to apply for renewal
+    >>> print(bassists.default_membership_period)
     None
-    >>> print bassists.default_renewal_period
+    >>> print(bassists.default_renewal_period)
     None
diff --git a/src/launchpadlib/docs/toplevel.rst b/src/launchpadlib/docs/toplevel.rst
index 76d2a56..67c480a 100644
--- a/src/launchpadlib/docs/toplevel.rst
+++ b/src/launchpadlib/docs/toplevel.rst
@@ -10,14 +10,14 @@ Launchpad-wide objects like projects and people.
 
     >>> from launchpadlib.testing.helpers import salgado_with_full_permissions
     >>> launchpad = salgado_with_full_permissions.login()
-    connect: ...
+    send: ...
     ...
 
 It's possible to do key-based lookups on the top-level
 collections. The bug collection does lookups by bug ID.
 
     >>> bug = launchpad.bugs[1]
-    send: 'GET /.../bugs/1 ...'
+    send: b'GET /.../bugs/1 ...'
     ...
 
 To avoid triggering an HTTP request when simply looking up an object,
@@ -28,8 +28,8 @@ you can use a different syntax:
 The HTTP request will happen when you need information that can only
 be obtained from the web service.
 
-    >>> print bug.id
-    send: 'GET /.../bugs/1 ...'
+    >>> print(bug.id)
+    send: b'GET /.../bugs/1 ...'
     ...
     1
 
@@ -37,24 +37,24 @@ Let's look at some more collections. The project collection does
 lookups by project name.
 
     >>> project = launchpad.projects('firefox')
-    >>> print project.name
-    send: 'GET /.../firefox ...'
+    >>> print(project.name)
+    send: b'GET /.../firefox ...'
     ...
     firefox
 
 The project group collection does lookups by project group name.
 
     >>> group = launchpad.project_groups('gnome')
-    >>> print group.name
-    send: 'GET /.../gnome ...'
+    >>> print(group.name)
+    send: b'GET /.../gnome ...'
     ...
     gnome
 
 The distribution collection does lookups by distribution name.
 
     >>> distribution = launchpad.distributions('ubuntu')
-    >>> print distribution.name
-    send: 'GET /.../ubuntu ...'
+    >>> print(distribution.name)
+    send: b'GET /.../ubuntu ...'
     ...
     ubuntu
 
@@ -62,26 +62,26 @@ The person collection does lookups by a person's Launchpad
 name.
 
     >>> person = launchpad.people('salgado')
-    >>> print person.name
-    send: 'GET /.../~salgado ...'
+    >>> print(person.name)
+    send: b'GET /.../~salgado ...'
     ...
     salgado
 
     >>> team = launchpad.people('rosetta-admins')
-    >>> print team.name
-    send: 'GET /1.0/~rosetta-admins ...'
+    >>> print(team.name)
+    send: b'GET /1.0/~rosetta-admins ...'
     ...
     rosetta-admins
 
 How does launchpadlib know that 'salgado' is a person and
 'rosetta-admins' is a team?
 
-    >>> print person.resource_type_link
+    >>> print(person.resource_type_link)
     http://.../1.0/#person
     >>> 'default_membership_period' in person.lp_attributes
     False
 
-    >>> print team.resource_type_link
+    >>> print(team.resource_type_link)
     http://.../1.0/#team
     >>> 'default_membership_period' in team.lp_attributes
     True
@@ -99,8 +99,8 @@ But accessing any attribute of an object--even trying to see what kind
 of object 'salgado' is--will trigger the HTTP request that will
 determine that 'salgado' is actually a person.
 
-    >>> print person2.resource_type_link
-    send: 'GET /.../~salgado ...'
+    >>> print(person2.resource_type_link)
+    send: b'GET /.../~salgado ...'
     ...
     http://.../1.0/#person
 
@@ -118,4 +118,4 @@ to be a team.
 
 Cleanup.
 
-    >>> httplib2.debuglevel = None
+    >>> httplib2.debuglevel = 0