GSrSSKJr SSKrSSKrSSKrSSKrSSKrSSKrSr \RS:XaSSK r Sr \R\R4\R\R 4/r\"5r\"5r\"5r"SS\5rSrS rS rS\R64S jrS rSS jrSSjrSSjr Sr!SSjr"Sr#Sr$SSjr%\r&\%r'\r(\r)Sr*\+S:Xa\*"\RX5 gg!\ a Sr Nf=f)ahPure python code for finding unused ports on a host. This module provides a pick_unused_port() function. It can also be called via the command line for use in shell scripts. When called from the command line, it takes one optional argument, which, if given, is sent to portserver instead of portpicker's PID. To reserve a port for the lifetime of a bash script, use $BASHPID as this argument. There is a race condition between picking a port and your application code binding to it. The use of a port server to prevent that is recommended on loaded test hosts running many tests at a time. If your code can accept a bound socket as input rather than being handed a port number consider using socket.bind(('localhost', 0)) to bind to an available port without a race condition rather than using this library. Typical usage: test_port = portpicker.pick_unused_port() )print_functionNwin32)bind is_port_freepick_unused_port return_portadd_reserved_portget_port_from_port_serverc\rSrSrSrSrg)NoFreePortFoundErrorKz6Exception indicating that no free port could be found.N)__name__ __module__ __qualname____firstlineno____doc____static_attributes__r&lib/third_party/portpicker/__init__.pyr r Ks@rr c.[RU5 g)zAAdd a port that was acquired by means other than the port server.N) _free_portsaddports rr r OsOODrc U[;a[RU5 gU[;a+[RU5 [R U5 gU[;a[ R "SU5 g[ R "SU5 g)z?Return a port that is no longer being used so it can be reused.z.Returning a port that was already returned: %sz4Returning a port that wasn't given by portpicker: %sN) _random_portsremove _owned_portsrrlogginginfors rrrTsc }T"  D!   EtL K rc[XU5$)a\Try to bind to a socket of the specified type, protocol, and port. This is primarily a helper function for PickUnusedPort, used to see if a particular port number is available. For the port to be considered available, the kernel must support at least one of (IPv6, IPv4), and the port must be available on each supported family. Args: port: The port number to bind to, or 0 to have the OS pick a free port. socket_type: The type of the socket (ex: socket.SOCK_STREAM). socket_proto: The protocol of the socket (ex: socket.IPPROTO_TCP). Returns: The port number on success or None on failure. )_bind)r socket_type socket_protos rrrbs$ L 11rcUbU[R:Xa![R[R4nOCU[R:Xa![R[R4nO[SU-5eSnUHn[R"XqU5nSnUR [R [RS5 URSU45 U[R:XaURS5 UR5SnUbXt:wa0UR[R5 UR5 UcMXt:XdMUR!U5 O U(aU$S$![Ra GMf=f![RaO UbXt:waCUR[R5 O![a Of=fUR5 g gf=f![a Nf=f!UbXt:waBUR[R5 O![a Of=fUR5 ff=f)aKInternal implementation of bind. Args: port, socket_type, socket_proto: see bind(). return_socket: If supplied, a list that we will append an open bound reuseaddr socket on the port in question to. return_family: The socket family to return in return_socket. Returns: The port number on success or None on failure. Nzunknown return_family %sFT)socketAF_INETAF_INET6 ValueErrorerror setsockopt SOL_SOCKET SO_REUSEADDRr SOCK_STREAMlisten getsocknameshutdown SHUT_RDWROSErrorcloseappend) rr$r% return_socket return_familysocket_families got_socketfamilysocks rr#r#ws   ?!??FNN; &// )!>>6??;3mCDDJ! ==lCDJ  OOF--v/B/BA F IIr4j !f000 A##%a(D$(? MM&"2"23  $)@   & 7"84'4'1||   || $(? MM&"2"23 )@ $(? MM&"2"23 )@sE=A:F"G?=FFG<-H7G G$#G$;G<<H? H  H  IH98I9 I II Ic[U5$)zCheck if specified port is free. Args: port: integer, port to check Returns: bool, whether port is free to use for both TCP and UDP. ) _is_port_freers rrrs  rch[U/[SQ7SU06=(a [U/[SQ7SU06$)aInternal implementation of is_port_free. Args: port: integer, port to check return_sockets: If supplied, a list that we will append open bound sockets on the port in question to rather than closing them. Returns: bool, whether port is free to use for both TCP and UDP. rr9r')r#_PROTOS)rreturn_socketss rr@r@s< $ B B> B C $ B B> BDrc[X5$)aPicks an unused port and reserves it for use by a given process id. Args: pid: PID to tell the portserver to associate the reservation with. If None, the current process's PID is used. portserver_address: The address (path) of a unix domain socket with which to connect to a portserver, a leading '@' character indicates an address in the "abstract namespace". OR On systems without socket.AF_UNIX, this is an AF_INET address. If None, or no port is returned by the portserver at the provided address, the environment will be checked for a PORTSERVER_ADDRESS variable. If that is not set, no port server will be used. If no portserver is used, no pid based reservation is managed by any central authority. Race conditions and duplicate assignments may occur. Returns: A port number that is unused on both TCP and UDP. Raises: NoFreePortFoundError: No free port could be found. )_pick_unused_port)pidportserver_addresss rrrs. S 55rc.[R5n[RU5 U$![a Of=fU(a[ XS9nU(aU$S[ R;a$[ [ RSUS9nU(aU$[US9$)aInternal implementation of pick_unused_port. Args: pid, portserver_address: See pick_unused_port(). noserver_bind_timeout: If no portserver was used, this is the number of seconds we will attempt to keep a child process around with the ports returned open and bound SO_REUSEADDR style to help avoid race condition port reuse. A non-zero value attempts os.fork(). Do not use it in a multithreaded process. )rFPORTSERVER_ADDRESS) bind_timeout) rpoprrKeyErrorr osenviron _pick_unused_port_without_server)rFrGnoserver_bind_timeoutrs rrErEs      ();E Krzz)(4H)I-02 K +9N OOs - ::c U(GaUS:a[R"5nUS:Xa[R"[RR 55 [R"[R R 55 [R"[RR 55 [R"U5 UHnUR5 M [R"S5 gggg![R"S5 f=f![a%n[SUSU[RS9 SnAgSnAff=f)aIf possible, fork()s a daemon process to hold bound_sockets open. Emits a warning to stderr if it cannot. Args: port: The port number the sockets are bound to (informational). bound_sockets: The list of bound sockets our child process will hold open. If the list is empty, no action is taken. timeout: A positive number of seconds the child should sleep for before closing the sockets and exiting. rz/WARNING: Cannot timeout unbinding close of portz closing on exit. -fileN) rMforkr7sysstdinfilenostdoutstderrtimesleep_exit Exceptionprint)r bound_socketstimeoutfork_pid held_socketerrs r _spawn_bound_port_holding_daemonrds1 wwyH 1}  HHSYY--/0HHSZZ..01HHSZZ..01JJw''4 #))+(5HHQK%}*HHQK% ? CT'3:: ? ?s#D&CD D#& E0EEcSnUS:a/OSn[S5Hn[S[R[RU5nU(a^U[ ;aT[U[R [RU5(a%[ RU5 [XU5 Us $U(dMUHnUR5 M USS2 M [R"5n[S5Hn[URSS55nU[ ;dM*[X5(a%[ RU5 [XU5 Us $U(dMhUHnUR5 M USS2 M [!5e)a9Pick an available network port without the help of a port server. This code ensures that the port is available on both TCP and UDP. This function is an implementation detail of PickUnusedPort(), and should not be called by code outside of this module. Args: bind_timeout: number of seconds to attempt to keep a child process process around bound SO_REUSEADDR style to the port. If we cannot do that we emit a warning to stderr. Returns: A port number that is unused on both TCP and UDP. Raises: NoFreePortFoundError: No free port could be found. Nr i:ia)ranger#r)r1 IPPROTO_TCPr SOCK_DGRAM IPPROTO_UDPrrdr7randomRandomint randranger@r )rJrr__rbrngs rrOrO&s9, D&*BM 2YQ**F,>,> N T. $))6+=+=} M M   d # ,T, OK =, !!# -a  --/C 2Y3==./ } $T11!!$'0\; }#0K%%'$1!!$   rchUSS:XaSUSS-n[[S5(a4[R"[R[R5nO3[R"[R[R5nUR U5 UR SU-RS55 URS5UR5 $!UR5 f=f![Ra#n[S U[RS 9 SnAgSnAff=f) Nr@r'AF_UNIX%d asciiiz+Socket error when connecting to portserver:rR)hasattrr)rtr1r*connectsendallencoderecvr7r-r^rUrY)rGrFr>r-s r _posix_get_port_from_port_serverr|_s !#!$6qr$:: 69 % %==1C1CDD==1C1CDD  LL+ , LL&3,..w7 899T? JJLDJJL << ;U:: s1ArsF"0& <<7  =    2 2 3   v11 2 4 e u  A9A 2*:>3(l  D6448+,P@! H6!rB.)\ 1  !#L zNy sC00C;:C;