python (3.12.0)
ˑel \ d Z dZddlZddlZddlZddlZddlZddlmZ ddl m
Z g dZ e ed re j g d e ed r/e j g d
e ed re j d d g e ed
r
ej Zn ej Z G d d Z G d de Z G d de Z e ed r
G d d Z G d de Z G d d Z G d d Z e ed r G d d ee Z G d d ee Z G d d!ee Z G d" d#ee Z e ed rO G d$ d%e Z G d& d'e Z G d( d)ee Z G d* d+ee Z e ed r G d, d ee Z! G d- d ee Z" G d. d/ Z# G d0 d1e# Z$ G d2 d3e Z% G d4 d5e# Z&y)6aq Generic socket server classes.
This module tries to capture the various aspects of defining a server:
For socket-based servers:
- address family:
- AF_INET{,6}: IP (Internet Protocol) sockets (default)
- AF_UNIX: Unix domain sockets
- others, e.g. AF_DECNET are conceivable (see <socket.h>
- socket type:
- SOCK_STREAM (reliable stream, e.g. TCP)
- SOCK_DGRAM (datagrams, e.g. UDP)
For request-based servers (including socket-based):
- client address verification before further looking at the request
(This is actually a hook for any processing that needs to look
at the request before anything else, e.g. logging)
- how to handle multiple requests:
- synchronous (one request is handled at a time)
- forking (each request is handled by a new process)
- threading (each request is handled by a new thread)
The classes in this module favor the server type that is simplest to
write: a synchronous TCP/IP server. This is bad class design, but
saves some typing. (There's also the issue that a deep class hierarchy
slows down method lookups.)
There are five classes in an inheritance diagram, four of which represent
synchronous servers of four types:
+------------+
| BaseServer |
+------------+
|
v
+-----------+ +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+ +------------------+
|
v
+-----------+ +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+ +--------------------+
Note that UnixDatagramServer derives from UDPServer, not from
UnixStreamServer -- the only difference between an IP and a Unix
stream server is the address family, which is simply repeated in both
unix server classes.
Forking and threading versions of each type of server can be created
using the ForkingMixIn and ThreadingMixIn mix-in classes. For
instance, a threading UDP server class is created as follows:
class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
The Mix-in class must come first, since it overrides a method defined
in UDPServer! Setting the various member variables also changes
the behavior of the underlying server mechanism.
To implement a service, you must derive a class from
BaseRequestHandler and redefine its handle() method. You can then run
various versions of the service by combining one of the server classes
with your request handler class.
The request handler class must be different for datagram or stream
services. This can be hidden by using the request handler
subclasses StreamRequestHandler or DatagramRequestHandler.
Of course, you still have to use your head!
For instance, it makes no sense to use a forking server if the service
contains state in memory that can be modified by requests (since the
modifications in the child process would never reach the initial state
kept in the parent process and passed to each child). In this case,
you can use a threading server, but you will probably have to use
locks to avoid two requests that come in nearly simultaneous to apply
conflicting changes to the server state.
On the other hand, if you are building e.g. an HTTP server, where all
data is stored externally (e.g. in the file system), a synchronous
class will essentially render the service "deaf" while one request is
being handled -- which may be for a very long time if a client is slow
to read all the data it has requested. Here a threading or forking
server is appropriate.
In some cases, it may be appropriate to process part of a request
synchronously, but to finish processing in a forked child depending on
the request data. This can be implemented by using a synchronous
server and doing an explicit fork in the request handler class
handle() method.
Another approach to handling multiple simultaneous requests in an
environment that supports neither threads nor fork (or where these are
too expensive or inappropriate for the service) is to maintain an
explicit table of partially finished requests and to use a selector to
decide which request to work on next (or whether to handle a new
incoming request). This is particularly important for stream services
where each client can potentially be connected for a long time (if
threads or subprocesses cannot be used).
Future work:
- Standard classes for Sun RPC (which uses either UDP or TCP)
- Standard mix-in classes to implement various authentication
and encryption schemes
XXX Open problems:
- What to do with out-of-band data?
BaseServer:
- split generic "request" functionality out into BaseServer class.
Copyright (C) 2000 Luke Kenneth Casson Leighton <lkcl@samba.org>
example: read entries from a SQL database (requires overriding
get_request() to return a table entry from the database).
entry is processed by a RequestHandlerClass.
z0.4 N)BufferedIOBase) monotonic)
BaseServer TCPServer UDPServerThreadingUDPServerThreadingTCPServerBaseRequestHandlerStreamRequestHandlerDatagramRequestHandlerThreadingMixInfork)ForkingUDPServerForkingTCPServer ForkingMixInAF_UNIX)UnixStreamServerUnixDatagramServerThreadingUnixStreamServerThreadingUnixDatagramServerForkingUnixStreamServerForkingUnixDatagramServer PollSelectorc | e Zd ZdZdZd Zd ZddZd Zd Z d Z
d Z d
Z d Z
d Zd
Zd Zd Zd Zd Zd Zd Zy)r a Base class for server classes.
Methods for the caller:
- __init__(server_address, RequestHandlerClass)
- serve_forever(poll_interval=0.5)
- shutdown()
- handle_request() # if you do not use serve_forever()
- fileno() -> int # for selector
Methods that may be overridden:
- server_bind()
- server_activate()
- get_request() -> request, client_address
- handle_timeout()
- verify_request(request, client_address)
- server_close()
- process_request(request, client_address)
- shutdown_request(request)
- close_request(request)
- service_actions()
- handle_error()
Methods for derived classes:
- finish_request(request, client_address)
Class variables that may be overridden by derived classes or
instances:
- timeout
- address_family
- socket_type
- allow_reuse_address
- allow_reuse_port
Instance variables:
- RequestHandlerClass
- socket
Nc ` || _ || _ t j | _ d| _ y)/Constructor. May be extended, do not override.FN)server_addressRequestHandlerClass threadingEvent_BaseServer__is_shut_down _BaseServer__shutdown_request)selfr r s @/BuggyBox/python/3.12.0/bootstrap/lib/python3.12/socketserver.py__init__zBaseServer.__init__ s) ,#6 'oo /"' c yzSCalled by constructor to activate the server.
May be overridden.
N r# s r$ server_activatezBaseServer.server_activate
r& c | j j t 5 }|j | t j
| j sM|j | }| j rn/|r| j | j | j sMddd d| _ | j j y# 1 sw Y +xY w# d| _ | j j w xY w)zHandle one request at a time until shutdown.
Polls for shutdown every poll_interval seconds. Ignores
self.timeout. If you need to do periodic tasks, do them in
another thread.
NF) r! clear_ServerSelectorregister selectors
EVENT_READr" select_handle_request_noblockservice_actionsset)r#
poll_intervalselectorreadys r$
serve_foreverzBaseServer.serve_forever s
!!# &
!"
+h!!$ (<(<= 11 $OOM :E.. 446((* 11
+ ',D # # # %
+
+ ',D # # # %s#
C A9C
C
CC #C9c F d| _ | j j y)zStops the serve_forever loop.
Blocks until the loop has finished. This must be called while
serve_forever() is running in another thread, or it will
deadlock.
TN)r" r! waitr* s r$ shutdownzBaseServer.shutdown s #' "r& c y)zCalled by the serve_forever() loop.
May be overridden by a subclass / Mixin to implement any code that
needs to be run during the loop.
Nr) r* s r$ r5 zBaseServer.service_actions r, r& c | j j }|
| j }n"| j t || j }|
t |z }t 5 }|j
| t j |j | r| j cddd S |+t z
}|dk r| j cddd S X# 1 sw Y yxY w)zOHandle one request, possibly blocking.
Respects self.timeout.
Nr ) socket
gettimeouttimeoutmintimer/ r0 r1 r2 r3 r4 handle_timeout)r# rB deadliner8 s r$ handle_requestzBaseServer.handle_request s ++((* ?llG
\\
%'4<<0G v'H
9( dI$8$8 9??7+ 779
9
9 *"*TV"3"Q;#'#6#6#8
9
9
9
9s %AC 1#C C C(c @ | j \ }}| j || r | j || y| j
| y# t $ r Y yw xY w# t $ r& | j || | j
| Y y | j
| xY w)zHandle one request, without blocking.
I assume that selector.select() has returned that the socket is
readable before this function was called, so there should be no risk of
blocking in get_request().
N) get_requestOSErrorverify_requestprocess_request Exception handle_errorshutdown_requestr# requestclient_addresss r$ r4 z"BaseServer._handle_request_noblock1 s &*&6&6&8 #G^ w 7
$$Wn=
! !' *
/!!'>:%%g.
%%g.s" A
A
AA ,B
B c y)zcCalled if no new request arrives within self.timeout.
Overridden by ForkingMixIn.
Nr) r* s r$ rE zBaseServer.handle_timeoutH s
r& c y)znVerify the request. May be overridden.
Return True if we should proceed with this request.
Tr) rP s r$ rK zBaseServer.verify_requestO s r& c J | j || | j | y)zVCall finish_request.
Overridden by ForkingMixIn and ThreadingMixIn.
N)finish_requestrO rP s r$ rL zBaseServer.process_requestW s"
G^4 g&r& c yzDCalled to clean-up the server.
May be overridden.
Nr) r* s r$ server_closezBaseServer.server_close` r, r& c * | j ||| y)z8Finish one request by instantiating RequestHandlerClass.N)r rP s r$ rV zBaseServer.finish_requesth s .$?r& c & | j | yz3Called to shutdown and close an individual request.N
close_requestr# rQ s r$ rO zBaseServer.shutdown_requestl 7#r& c yz)Called to clean up an individual request.Nr) r_ s r$ r^ zBaseServer.close_requestp r& c t dt j t d|t j ddl}|j t dt j y)ztHandle an error gracefully. May be overridden.
The default is to print a traceback and continue.
z(----------------------------------------)filez4Exception occurred during processing of request fromr N)printsysstderr traceback print_exc)r# rQ rR ri s r$ rN zBaseServer.handle_errort sC f3::&
D -
f3::&r& c | S Nr) r* s r$ __enter__zBaseServer.__enter__ s r& c $ | j y rl )rY )r# argss r$ __exit__zBaseServer.__exit__ s r& )g ?)__name__
__module__ __qualname____doc__rB r% r+ r: r= r5 rG r4 rE rK rL rY rV rO r^ rN rm rp r) r& r$ r r se *X G(
&:#
&9:+.
'
@$
' r& r c ~ e Zd ZdZej
Zej ZdZ dZ
dZ d
dZ d Z
d Zd Zd Zd Zd
Zd Zy )r aJ Base class for various socket-based server classes.
Defaults to synchronous IP stream (i.e., TCP).
Methods for the caller:
- __init__(server_address, RequestHandlerClass, bind_and_activate=True)
- serve_forever(poll_interval=0.5)
- shutdown()
- handle_request() # if you don't use serve_forever()
- fileno() -> int # for selector
Methods that may be overridden:
- server_bind()
- server_activate()
- get_request() -> request, client_address
- handle_timeout()
- verify_request(request, client_address)
- process_request(request, client_address)
- shutdown_request(request)
- close_request(request)
- handle_error()
Methods for derived classes:
- finish_request(request, client_address)
Class variables that may be overridden by derived classes or
instances:
- timeout
- address_family
- socket_type
- request_queue_size (only for stream sockets)
- allow_reuse_address
- allow_reuse_port
Instance variables:
- server_address
- RequestHandlerClass
- socket
Fc t j | || t j | j | j | _ |r" | j | j
yy# | j xY w)r N)r r% r@ address_family socket_type server_bindr+ rY )r# r r bind_and_activates r$ r% zTCPServer.__init__ sq D.2EF mmD$7$7$($4$46
"$$&
!!#s
A, ,A?c | j rIt t d r9| j j t j t j
d | j rIt t d r9| j j t j t j d | j j | j | j j | _ y)zOCalled by constructor to bind the socket.
May be overridden.
SO_REUSEADDR SO_REUSEPORTN) allow_reuse_addresshasattrr@
setsockopt
SOL_SOCKETr} allow_reuse_portr bindr getsocknamer* s r$ rz zTCPServer.server_bind s # #(G KK " "6#4#4f6I6I1 M WV^%D KK " "6#4#4f6I6I1 M ,,- "kk 5 5 7r& c N | j j | j yr( )r@ listenrequest_queue_sizer* s r$ r+ zTCPServer.server_activate s
4223r& c 8 | j j yrX )r@ closer* s r$ rY zTCPServer.server_close s
r& c 6 | j j S )zMReturn socket file number.
Interface required by selector.
)r@ filenor* s r$ r zTCPServer.fileno {{!!##r& c 6 | j j S )zYGet the request and client address from the socket.
May be overridden.
)r@ acceptr* s r$ rI zTCPServer.get_request r r& c |j t j | j | y# t $ r Y w xY wr\ )r= r@ SHUT_WRrJ r^ r_ s r$ rO zTCPServer.shutdown_request s?
V^^ ,
7# s 3 ??c $ |j yrb )r r_ s r$ r^ zTCPServer.close_request s
r& N)T)rq rr rs rt r@ AF_INETrx SOCK_STREAMry r r r r% rz r+ rY r rI rO r^ r) r& r$ r r sX ,\ ^^N$$K 84 $$$r& r c L e Zd ZdZdZdZej ZdZ d Z
d Z d Z d Z
y) r zUDP server class.Fi c r | j j | j \ }}|| j f|fS rl )r@ recvfrommax_packet_size)r# data client_addrs r$ rI zUDPServer.get_request s5 KK 0 01E1E Fkdkk"K//r& c y rl r) r* s r$ r+ zUDPServer.server_activate rc r& c & | j | y rl r] r_ s r$ rO zUDPServer.shutdown_request r` r& c y rl r) r_ s r$ r^ zUDPServer.close_request# rc r& N)rq rr rs rt r r r@
SOCK_DGRAMry r rI r+ rO r^ r) r& r$ r r s5 ##KO0
$
r& r c P e Zd ZdZdZdZdZdZdddZd Z d
Z
d Z fd Z xZ
S )
r z5Mix-in class to handle each request in a new process.i, N( TFblockingc | j yt | j | j k\ rX t j dd \ }}| j j | t | j | j k\ rX| j j D ]K } |rdnt j }t j || \ }}| j j | M y# t $ r | j j Y t $ r Y w xY w# t $ r | j j | Y t $ r Y w xY w)z7Internal routine to wait for children that have exited.Nr ) active_childrenlen max_childrenoswaitpiddiscardChildProcessErrorr. rJ copyWNOHANG)r# r pid_flagss r$ collect_childrenz ForkingMixIn.collect_children1 s- ##+ d**+t/@/@@ ZZA .FC((005 d**+t/@/@@ ++002
!)ArzzE ZZU 3FC ((005
) 1((..0 ) 6((005 s0 4C1 &AD$1#D!D! D!$$E
EEc $ | j y)zvWait for zombies after self.timeout seconds of inactivity.
May be extended, do not override.
Nr r* s r$ rE zForkingMixIn.handle_timeoutT
! ! #r& c $ | j y)zCollect the zombie child processes regularly in the ForkingMixIn.
service_actions is called in the BaseServer's serve_forever loop.
Nr r* s r$ r5 z ForkingMixIn.service_actions[ r r& c > t j }|rH| j t | _ | j j | | j | yd} | j
|| d} | j | t j | y# t $ r | j || Y Ew xY w# t j | w xY w# | j | t j | w # t j | w xY wxY w)z-Fork a new subprocess to process the request.Nr~ r ) r r r r6 addr^ rV rM rN rO _exit)r# rQ rR r statuss r$ rL z ForkingMixIn.process_requestb s '')C''/+.5D($$((-""7+ )'' @ F) --g6(
! ?%%g~>? () --g6((sH "B 7B? B<9C ;B<<C ?CD D,D DD c Z t | | j | j y )Nr )superrY r block_on_closer# __class__s r$ rY zForkingMixIn.server_close{ s% G " ! !4+>+> ! ?r& )rq rr rs rt rB r r r r rE r5 rL rY
__classcell__r s @r$ r r ( s> C /4 ! F $ $ )2 @ @r& r c 4 e Zd ZdZ fdZd Zd Zd Z xZS )_Threadsz2
Joinable list of all non-daemon threads.
c ^ | j |j ry t |
| y rl )reapdaemonr append)r# threadr s r$ r z_Threads.append s" ==
v r& c g | d d c| d d }|S rl r) )r# results r$ pop_allz_Threads.pop_all s d1gQ
r& c N | j D ] }|j y rl )r joinr# r s r$ r z
_Threads.join s lln F KKM r& c d | D | d d y )Nc 3 B K | ] }|j s| y wrl )is_alive).0r s r$ <genexpr>z _Threads.reap.<locals>.<genexpr> s Bf0A6Bs r) r* s r$ r z
_Threads.reap s BBQr& ) rq rr rs rt r r r r r r s @r$ r r s Cr& r c e Zd ZdZd Zd Zy)
_NoThreadsz)
Degenerate version of _Threads.
c y rl r) r s r$ r z_NoThreads.append r& c y rl r) r* s r$ r z_NoThreads.join r r& N)rq rr rs rt r r r) r& r$ r r s
r& r c D e Zd ZdZdZdZ e Zd Zd Z fdZ
xZ S )r
z4Mix-in class to handle each request in a new thread.FTc | j || | j | y# t $ r | j || Y /w xY w# | j | w xY w)zgSame as in BaseServer but as a thread.
In addition, exception handling is done here.
N)rV rM rN rO rP s r$ process_request_threadz%ThreadingMixIn.process_request_thread sY + 8
! !' * 7 g~ 6 7
! !' *s! & AA AA Ac | j r#t | j dt t j
| j ||f }| j |_ | j j | |j y)z*Start a new thread to process the request._threads)targetro N) r vars
setdefaultr r Threadr daemon_threadsr r r start)r# rQ rR ts r$ rL z ThreadingMixIn.process_request si J ! !*hj 9 d&A&A%,n$=
?&&
Q r& c V t | | j j y rl )r rY r r r s r$ rY zThreadingMixIn.server_close s
r& ) rq rr rs rt r r r r r rL rY r r s @r$ r
r
s/ > NN |H + r& r
c e Zd Zy)r Nrq rr rs r) r& r$ r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& r c $ e Zd Zej Zy)r Nrq rr rs r@ r rx r) r& r$ r r r& r c $ e Zd Zej Zy)r Nr r) r& r$ r r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& r c e Zd Zy)r Nr r) r& r$ r r r r& c e Zd Zy)r Nr r) r& r$ r r r r& c ( e Zd ZdZd Zd Zd Zd Zy)r
a Base class for request handler classes.
This class is instantiated for each request to be handled. The
constructor sets the instance variables request, client_address
and server, and then calls the handle() method. To implement a
specific service, all you need to do is to derive a class which
defines a handle() method.
The handle() method can find the request as self.request, the
client address as self.client_address, and the server (in case it
needs access to per-server information) as self.server. Since a
separate instance is created for each request, the handle() method
can define other arbitrary instance variables.
c || _ || _ || _ | j | j | j y # | j w xY wrl )rQ rR serversetuphandlefinish)r# rQ rR r s r$ r% zBaseRequestHandler.__init__ sB ,
KKM KKMDKKMs A Ac y rl r) r* s r$ r zBaseRequestHandler.setup r r& c y rl r) r* s r$ r zBaseRequestHandler.handle r r& c y rl r) r* s r$ r zBaseRequestHandler.finish r r& N)rq rr rs rt r% r r r r) r& r$ r
r
s
r& r
c , e Zd ZdZdZdZdZdZd Zd Z y)r z4Define self.rfile and self.wfile for stream sockets.r r NFc | j | _ | j %| j j | j | j r9| j j t j t j d | j j d| j | _ | j dk( rt | j | _ y | j j d| j | _ y )NTrbr wb)rQ
connectionrB
settimeoutdisable_nagle_algorithmr r@ IPPROTO_TCP TCP_NODELAYmakefilerbufsizerfilewbufsize
_SocketWriterwfiler* s r$ r zStreamRequestHandler.setup$ s ,, << # OO & &t|| 4 ' ' OO & &v'9'9'-'9'94
A__--dDMMB
==A &t7DJ 11$
FDJr& c | j j s | j j | j j | j j y # t j $ r Y Jw xY wrl )r closedflushr@ errorr r r* s r$ r zStreamRequestHandler.finish1 s` zz
"
<<
s A' 'A=<A=)
rq rr rs rt r r rB r r r r) r& r$ r r s+ > HH G $ G r& r c ( e Zd ZdZd Zd Zd Zd Zy)r
zSimple writable BufferedIOBase implementation for a socket
Does not hold data in a buffer, avoiding any need to call flush().c || _ y rl )_sock)r# socks r$ r% z_SocketWriter.__init__A s
r& c y)NTr) r* s r$ writablez_SocketWriter.writableD s r& c | j j | t | 5 }|j cd d d S # 1 sw Y y xY wrl )r sendall
memoryviewnbytes)r# bviews r$ writez_SocketWriter.writeG s9
1
] d;; s =Ac 6 | j j S rl )r r r* s r$ r z_SocketWriter.filenoL s zz ""r& N)rq rr rs rt r% r r r r) r& r$ r
r
< s J
#r& r
c e Zd ZdZd Zd Zy)r z6Define self.rfile and self.wfile for datagram sockets.c ddl m} | j \ | _ | _ || j | _ | | _ y )Nr )BytesIO)ior rQ packetr@ r r )r# r s r$ r z DatagramRequestHandler.setupS s0 #'<< T[ T[[)
Y
r& c | j j | j j | j y rl )r@ sendtor getvaluerR r* s r$ r z DatagramRequestHandler.finishY s) 4::..0$2E2EFr& N)rq rr rs rt r r r) r& r$ r r O s @ Gr& r )'rt __version__r@ r1 r rg r r! r rD r __all__r extendr r/ SelectSelectorr r r r listr r r
r r r r r r r r r r r
r r
r r) r& r$ <module>r+ s vt
" 7 2v NNJK
69 NN 3 4 r613NOP 9n% ,,O ..Oj j Z@
@F
8 2vU@ U@pCt C,
% % P 2v9<99<9 9 9 9 9
69 (9 ((Y ( LN4DKOn6HOr6Kl4DKO 6HO#
#
\+- +Z#N #& G / Gr& 
Browse
Usage
Versions