目录:
1. 异常
2. 地址族
3. 套接字类型
4. 模块方法
socket模块提供了Python中的低层网络连接接口,用于操作套接字操作。
异常
socket模块共定义了4种异常:
socket.error
套接字相关的错误将会抛出该异常,伴随的值是解释错误信息的字符串或 (errno, string) 形式的系统调用异常返回。socket.error 是 IOError 的一个子类。
socket.herror
地址相关的错误、C API 调用等可能会抛出该异常,例如使用 h_errno 的C API,比如 gethostbyname_ex() 和 gethostbyaddr() 。伴随的值是一个 (h_errno, string) 二元组,代表一个由库函数调用返回的错误, string 描述 h_errno ,由C的 hstrerror() 函数返回。
socket.gaierror
地址相关的错误将会抛出该异常,例如 getaddrinfo() 和 getnameinfo() 函数。伴随的值是一个 (error, string)二元组,代表一个由库函数调用返回的错误,其中string描述error,由C的 gai_strerror() 函数返回。
socket.timeout
套接字超时时抛出该异常。套接字的超时由 实例方法settimeout() 函数设置,目前该异常的伴随值总是字符串“timed out”。
其他常量
socket.has_ipv6
布尔型的常量,显示当前平台是否支持IPV6协议。
例如:
>>> sys.platform
'win32'
>>> socket.has_ipv6
True
模块方法
socket.create_connection(addr[, timeout[, source_addr]])
作用:连接到一个监听地址addr的TCP服务上,并返回一个新的套接字对象。这个函数比socket.connetc()更高级,如果addr(host, port)中的host是一个非数值的值,那么该函数会同时尝试AF_INET和AF_INET6来解析它,然后尝试所有获得的可能地址,该方法可以用来编写同时支持IPv4和IPv6的客户端。
参数:
addr —— 服务器套接字地址
timeout —— 套接字的超时限制,如果没有提供,那么使用getdefaulttimeout()的设置
source_address —— 如果提供的话,该参数必须是(host, port)形式的二元组,套接字会在连接前绑定到这个指定的地址。
返回:
返回一个连接到目标地址的新的套接字对象。
socket.getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
至少需要两个参数,将一个host/port信息转化为一个五元组,该五元组包含了一切连到目标host/port上需要的套接字信息。返回的五元组具有如下的形式: (family, socktype, proto, canonname, sockaddr) 。
将 host/port 参数转化为一个包含用于创建套接字的所有参数的5元组。host 代表域名,可以是 IPv4/v6 地址或者 None。port 可以是一个服务的字符串名称如'http',也可以是一个数字端口号或 None。传递 None 作为 host 和 port 的值等价于传递 NULL 给底层的 C API。
参数 family, socktype 和 proto 是可选的,默认为0,意味着选取所有的结果。参数 flags 可以是 ‘AI_*’常量中的一个或几个,可以影响结果是如何被计算和返回的,默认值也是0。例如, AI_NUMERICHOST 会关闭域名查询,如果 host 是一个域名,那么这里将会抛出一个异常。
该函数返回一个5元组,5元组的结构如下:
(family, socktype, proto, canonname, sockaddr)
其中 family,socktype,proto 全是整数,用于传递给 socket() 函数。
canonname will be a string representing the canonical name of the host if AI_CANONNAME is part of the flags argument; else canonname will be empty.
sockaddr 是一个描述套接字地址的元组,其格式依赖于返回结果中的 family (比如 family 是 AF_INET 时 sockaddr 是一个 (address, port) 二元组;而当 family 是 AF_INET6 时 sockaddr 是一个 (address, port, flow info, scope id) 四元组),该部分的结果可以传递给 socket.connect() 方法。
下面的例子给出了一个获取HTTP连接到www.python.org的80端口的连接信息:
>>> socket.getaddrinfo("www.python.org", 80, 0, 0, socket.IPPROTO_TCP)
[(2, 1, 6, '', ('82.94.164.162', 80)),
(10, 1, 6, '', ('2001:888:2000:d::a2', 80, 0, 0))]
socket.getfqdn(name='')
作用:返回参数的全称域名(fully qualified domain name string),如果参数name='',那么将会返回本地主机的全称域名
参数:字符串name,是要查询的目标主机名;
返回值:返回目标主机的全称域名。
socket.gethostbyname(hostname)
作用:将主机名翻译成IPv4地址,不支持IPv6的域名解析
参数:
hostname——目标主机的域名
返回:目标主机的IPv4地址
socket.gethostname()
作用:获取当前主机的主机名;
参数:无
返回:当前主机的主机名。
socket.gethostbyaddr(ip_address)
作用:返回目标IP地址的一些信息;
参数:ip_address——目标IP地址;
返回值:三元组 (hostname, aliaslist, ipaddrlist) ,其中:
hostname: 给定ip_address的主要主机名(primary host name);
aliaslist: 给定ip_address的备用主机名(alternative host names)构成的列表,可能为空;
ipaddrlist: 给定ip_address主机的IP地址列表,很可能只有一个IP地址。
socket.gethostbyname_ex(hostname)
作用:效果等用于 gethostbyaddr() ,但是参数hostname既可以是IP地址,也可以是目标主机名;
参数:hostname——点分式的IP地址或DNS主机名;
返回值:返回值的形式等同于 gethostbyaddr() 。
socket.getnameinfo(sockaddr, flags)
作用:将sockaddr转成(host, port)形式的二元组形式。
参数:
sockaddr —— 二元组,首元可以是IP地址,也可以是域名;次元是端口;
flags —— 通常是0。
返回:(host, port)形式的二元组,目标地址的IP地址和端口。
socket.getprotobyname(protocolname)
作用:获得网络协议名(如:'icmp')对应的值,可以用来传递给 socket() 函数作为可选的第三个参数,通常只用于以“raw”(SOCK_RAW)方式打开的套接字。对于正常的套接字,一般协议值会自动选取。
参数:
protocolname —— 网络协议名,如“icmp”、“tcp”等
返回:网络协议名对应的值。
socket.getservbyname(servicename[, protocolname])
作用:返回一个服务注册绑定的端口号,如FTP是21,SSH是22等。
参数:
servicename —— 要查询的服务的名称;
protocolname —— 可选,取值'tcp' 或 'udp'。
返回:
目标服务注册监听的端口号。
socket.getservbyport(port[, protocolname])
作用:与 getservbyname() 刚好相反,可以通过指定端口号查询一般情况下是哪些服务注册监听这些端口。
参数:
port —— 目标端口号,
protocolname —— 可选,取值'tcp' 或 'udp'。
返回:
通常监听目标端口的服务名称。
socket.socketpair([family[, type[, proto]]])
作用:(只在Unix平台上可用)创建一对连接的套接字对象。
参数:参数family, type, proto同 socket.socket() 方法。不过,如果平台定义了的话,默认的地址族是AF_UNIX,否则是AF_INET。
返回:一个二元组,包含两个已经连接的套接字对象。
socket.fromfd(fd, family, type[, proto])
作用:(只在Unix平台上可用)Duplicate the file descriptor fd (an integer as returned by a file object’s fileno() method) and build a socket object from the result. Address family, socket type and protocol number are as for the socket() function above. The file descriptor should refer to a socket, but this is not checked — subsequent operations on the object may fail if the file descriptor is invalid. This function is rarely needed, but can be used to get or set socket options on a socket passed to a program as standard input or output (such as a server started by the Unix inet daemon). The socket is assumed to be in blocking mode.
socket.ntohl(x)
作用:将32位网络字节序的正整型转换成主机字节序;
参数:x——4字节网络字节序的正整型;
返回:适合主机字节序的相同整数。
socket.ntohs(x)
作用:将16位网络字节序的正整型转换成主机字节序;
参数:x——2字节网络字节序的正整型;
返回:适合主机字节序的相同整数。
socket.htonl(x)
作用:将32位主机字节序的正整型转换成32位网络字节序的整型;
参数:x——4字节正整数;
返回:4字节网络字节序的相同整型变量。
socket.htons(x)
作用:将16位的主机字节序的正整数转换成16位网络字节序整型;
参数:x——2字节正整数;
返回:2字节网络字节序的相同整型变量。
socket.inet_aton(ip_string)
作用:将IPv4点分地址转换成32位二进制数(4字节长的字符串)的格式,不支持IPv6。
参数:点分格式的IPv4地址
返回:4字节打包后的字符串
socket.inet_ntoa(packed_ip)
作用:将32位打包的IPv4地址转换成点分形式,不支持IPv6。
参数:4字节打包后的IPv4地址
返回:对应IP地址的点分形式
socket.inet_pton(address_family, ip_string)
作用:将一个IP地址由它的地址族对应的字符串形式转换成打包后的二进制格式,支持IPv4和IPv6.
参数:
address_family——AF_INET 或 AF_INET6;
ip_string——IP地址串
返回:对应IP地址打包后的二进制形式。
socket.inet_ntop(address_family, packed_ip)
作用:将一个IP地址由它的地址族对应的字符串形式转换成打包后的二进制格式,支持IPv4和IPv6。
参数:
address_family——AF_INET 或 AF_INET6;
packed_ip——网络格式的,打包后的二进制形式的IP地址
返回:IPv4或IPv6的普通字符串形式的IP地址。
socket.getdefaulttimeout()
作用:返回默认的套接字超时时限(单位:秒)。
参数:不用参数;
返回值:
浮点数——默认的套接字超时秒数;
None——套接字没有默认的超时限制。
socket.setdefaulttimeout(timeout)
作用:设置默认的套接字超时。
参数:
返回: