examples/network: Support IPv4 and IPv6 in HTTP client examples.

The main changes here are to pass the address family and socket type to
`getaddrinfo()`, and then use the result of the address lookup when
creating the socket, so it has the correct address family.

This allows both IPv4 and IPv6 to work, because the socket is created with
the correct AF_INETx type for the address.

Also add some more comments to the examples to explain what's going on.

Fixes issue #15580.

Signed-off-by: Damien George <damien@micropython.org>

1 files changed, 28 insertions, 6 deletions

diff --git a/examples/network/https_client.py b/examples/network/https_client.py
index 323971c0e..d20f283d7 100644
--- a/examples/network/https_client.py
+++ b/examples/network/https_client.py
@@ -1,20 +1,41 @@
+# Very simple HTTPS client example:
+# - Connects to a server.
+# - Upgrades the connection to a TLS connection.
+# - Sends a HTTP request.
+# - Reads the result.
+#
+# This example works in both MicroPython and CPython.
+#
+# To implement an HTTPS client using less code, use mip to install the requests package:
+# https://github.com/micropython/micropython-lib/tree/master/python-ecosys/requests
+
 import socket
 import ssl
 
 
-def main(use_stream=True):
-    s = socket.socket()
-
-    ai = socket.getaddrinfo("google.com", 443)
+# `addr_family` selects IPv4 vs IPv6: 0 means either, or use
+# socket.AF_INET or socket.AF_INET6 to select a particular one.
+def main(domain, addr_family=0, use_stream=True):
+    # Lookup the server address, for the given family and socket type.
+    ai = socket.getaddrinfo(domain, 443, addr_family, socket.SOCK_STREAM)
     print("Address infos:", ai)
-    addr = ai[0][-1]
 
+    # Select the first address.
+    ai = ai[0]
+
+    # Create a socket with the server's family, type and proto.
+    s = socket.socket(ai[0], ai[1], ai[2])
+
+    # Connect to the server.
+    addr = ai[-1]
     print("Connect address:", addr)
     s.connect(addr)
 
+    # Upgrade the socket to a TLS connection.
     s = ssl.wrap_socket(s)
     print(s)
 
+    # Send request and read response.
     if use_stream:
         # Both CPython and MicroPython SSLSocket objects support read() and
         # write() methods.
@@ -26,7 +47,8 @@ def main(use_stream=True):
         s.send(b"GET / HTTP/1.0\r\n\r\n")
         print(s.recv(4096))
 
+    # Close the socket.
     s.close()
 
 
-main()
+main("google.com")