JezK
Edit File: socketserver.cpython-39.pyc
a �i�j � @ s� d Z dZddlZddlZddlZddlZddlZddlmZ ddl m Z g d�Z e ed�rhe � g d�� e ed �r�e � g d �� e ed �r�ejZnejZG d d � d �ZG dd� de�ZG dd� de�Ze ed�r�G dd� d�ZG dd� de�ZG dd� d�ZG dd� d�Ze ed��r:G dd� dee�ZG d d � d ee�ZG d d � d ee�ZG d d!� d!ee�Z e ed ��r�G d"d#� d#e�Z G d$d%� d%e�Z G d&d'� d'ee �Z G d(d)� d)ee �Z G d*d+� d+�Z!G d,d-� d-e!�Z"G d.d/� d/e�Z#G d0d1� d1e!�Z$dS )2aq 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� UDPServer�ThreadingUDPServer�ThreadingTCPServer�BaseRequestHandler�StreamRequestHandler�DatagramRequestHandler�ThreadingMixIn�fork)�ForkingUDPServer�ForkingTCPServer� ForkingMixIn�AF_UNIX)�UnixStreamServer�UnixDatagramServer�ThreadingUnixStreamServer�ThreadingUnixDatagramServer� PollSelectorc @ s� e Zd ZdZdZdd� Zdd� Zd&dd �Zd d � Zd d � Z dd� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� ZdS )'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 Instance variables: - RequestHandlerClass - socket Nc C s || _ || _t�� | _d| _dS )�/Constructor. May be extended, do not override.FN)�server_address�RequestHandlerClass� threading�Event�_BaseServer__is_shut_down� _BaseServer__shutdown_request)�selfr r � r �$/usr/lib64/python3.9/socketserver.py�__init__� s zBaseServer.__init__c C s dS �zSCalled by constructor to activate the server. May be overridden. Nr �r r r r �server_activate� s zBaseServer.server_activate� �?c C s� | j �� zvt� �L}|�| tj� | jsP|�|�}| jr:qP|rF| �� | � � q"W d � n1 sd0 Y W d| _| j � � nd| _| j � � 0 dS )z�Handle 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�_ServerSelector�register� selectors� EVENT_READr �select�_handle_request_noblock�service_actions�set)r Z poll_interval�selector�readyr r r � serve_forever� s * �zBaseServer.serve_foreverc C s d| _ | j�� dS )z�Stops 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# r r r �shutdown� s zBaseServer.shutdownc C s dS )z�Called 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# r r r r- � s zBaseServer.service_actionsc C s� | j �� }|du r| j}n| jdur0t|| j�}|durBt� | }t� �t}|�| tj� |� |�}|r|| � � W d � S |durX|t� }|dk rX| � � W d � S qXW d � n1 s�0 Y dS )zOHandle one request, possibly blocking. Respects self.timeout. Nr ) �socket� gettimeout�timeout�min�timer' r( r) r* r+ r, �handle_timeout)r r6 �deadliner/ r0 r r r �handle_request s zBaseServer.handle_requestc C s� z| � � \}}W n ty$ Y dS 0 | �||�r�z| �||� W q� tyj | �||� | �|� Y q� | �|� � Y q�0 n | �|� dS )z�Handle 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_request�OSError�verify_request�process_request� Exception� handle_error�shutdown_request�r �request�client_addressr r r r, / s z"BaseServer._handle_request_noblockc C s dS )zcCalled if no new request arrives within self.timeout. Overridden by ForkingMixIn. Nr r# r r r r9 F s zBaseServer.handle_timeoutc C s dS )znVerify the request. May be overridden. Return True if we should proceed with this request. Tr rC r r r r> M s zBaseServer.verify_requestc C s | � ||� | �|� dS )zVCall finish_request. Overridden by ForkingMixIn and ThreadingMixIn. N)�finish_requestrB rC r r r r? U s zBaseServer.process_requestc C s dS �zDCalled to clean-up the server. May be overridden. Nr r# r r r � server_close^ s zBaseServer.server_closec C s | � ||| � dS )z8Finish one request by instantiating RequestHandlerClass.N)r rC r r r rF f s zBaseServer.finish_requestc C s | � |� dS �z3Called to shutdown and close an individual request.N�� close_request�r rD r r r rB j s zBaseServer.shutdown_requestc C s dS �z)Called to clean up an individual request.Nr rL r r r rK n s zBaseServer.close_requestc C s@ t dtjd� t d|tjd� ddl}|�� t dtjd� dS )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)�print�sys�stderr� traceback� print_exc)r rD rE rR r r r rA r s �zBaseServer.handle_errorc C s | S �Nr r# r r r � __enter__ s zBaseServer.__enter__c G s | � � d S rT )rH )r �argsr r r �__exit__� s zBaseServer.__exit__)r% )�__name__� __module__� __qualname__�__doc__r6 r! r$ r1 r3 r- r; r, r9 r> r? rH rF rB rK rA rU rW r r r r r � s& + r c @ sf e Zd ZdZejZejZdZ dZ ddd�Z dd� Z d d � Z d d � Zd d� Zdd� Zdd� Zdd� ZdS )r a3 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 Instance variables: - server_address - RequestHandlerClass - socket � FTc C sT t �| ||� t�| j| j�| _|rPz| �� | �� W n | �� � Y n0 dS )r N)r r! r4 �address_family� socket_type� server_bindr$ rH )r r r Zbind_and_activater r r r! � s � zTCPServer.__init__c C s8 | j r| j�tjtjd� | j�| j� | j�� | _dS )zOCalled by constructor to bind the socket. May be overridden. � N)�allow_reuse_addressr4 � setsockopt� SOL_SOCKET� SO_REUSEADDR�bindr � getsocknamer# r r r r_ � s zTCPServer.server_bindc C s | j �| j� dS r" )r4 �listen�request_queue_sizer# r r r r$ � s zTCPServer.server_activatec C s | j �� dS rG )r4 �closer# r r r rH � s zTCPServer.server_closec C s | j �� S )zMReturn socket file number. Interface required by selector. )r4 �filenor# r r r rj � s zTCPServer.filenoc C s | j �� S )zYGet the request and client address from the socket. May be overridden. )r4 �acceptr# r r r r< � s zTCPServer.get_requestc C s2 z|� tj� W n ty" Y n0 | �|� dS rI )r3 r4 �SHUT_WRr= rK rL r r r rB � s zTCPServer.shutdown_requestc C s |� � dS rM )ri rL r r r rK � s zTCPServer.close_requestN)T)rX rY rZ r[ r4 �AF_INETr] � SOCK_STREAMr^ rh ra r! r_ r$ rH rj r< rB rK r r r r r � s - r c @ s> e Zd ZdZdZejZdZdd� Z dd� Z dd � Z d d � Z d S ) r zUDP server class.Fi c C s | j �| j�\}}|| j f|fS rT )r4 �recvfrom�max_packet_size)r �dataZ client_addrr r r r< s zUDPServer.get_requestc C s d S rT r r# r r r r$ s zUDPServer.server_activatec C s | � |� d S rT rJ rL r r r rB s zUDPServer.shutdown_requestc C s d S rT r rL r r r rK s zUDPServer.close_requestN) rX rY rZ r[ ra r4 � SOCK_DGRAMr^ rp r< r$ rB rK r r r r r s r c sV e Zd ZdZdZdZdZdZdd�dd �Zd d � Z d d � Z dd� Z � fdd�Z � Z S )r z5Mix-in class to handle each request in a new process.i, N�( TF��blockingc C s� | j du rdS t| j �| jkrrz t�dd�\}}| j �|� W q tyZ | j �� Y q tyn Y qrY q0 q| j � � D ]b}z.|r�dntj }t�||�\}}| j �|� W q| ty� | j �|� Y q| ty� Y q|0 q|dS )z7Internal routine to wait for children that have exited.N���r ) �active_children�len� max_children�os�waitpid�discard�ChildProcessErrorr& r= �copy�WNOHANG)r ru �pid�_�flagsr r r �collect_children( s& z ForkingMixIn.collect_childrenc C s | � � dS )zvWait for zombies after self.timeout seconds of inactivity. May be extended, do not override. N�r� r# r r r r9 K s zForkingMixIn.handle_timeoutc C s | � � dS )z�Collect the zombie child processes regularly in the ForkingMixIn. service_actions is called in the BaseServer's serve_forever loop. Nr� r# r r r r- R s z ForkingMixIn.service_actionsc C s� t �� }|r8| jdu r t� | _| j�|� | �|� dS d}z^z| �||� d}W n typ | �||� Y n0 W z| � |� W t � |� q�t � |� 0 n(z| � |� W t � |� n t � |� 0 0 dS )z-Fork a new subprocess to process the request.Nr` r ) rz r rw r. �addrK rF r@ rA rB �_exit)r rD rE r� �statusr r r r? Y s& � z ForkingMixIn.process_requestc s t � �� | j| jd� d S )Nrt )�superrH r� �block_on_closer# �� __class__r r rH r s zForkingMixIn.server_close)rX rY rZ r[ r6 rw ry r� r� r9 r- r? rH � __classcell__r r r� r r s #r c s8 e Zd ZdZ� fdd�Zdd� Zdd� Zdd � Z� ZS ) �_Threadsz2 Joinable list of all non-daemon threads. c s" | � � |jrd S t� �|� d S rT )�reap�daemonr� �append�r �threadr� r r r� { s z_Threads.appendc C s g | d d � | d d �< }|S rT r )r �resultr r r �pop_all� s z_Threads.pop_allc C s | � � D ] }|�� qd S rT )r� �joinr� r r r r� � s z _Threads.joinc C s dd� | D �| d d �< d S )Nc s s | ]}|� � r|V qd S rT )�is_alive)�.0r� r r r � <genexpr>� � z _Threads.reap.<locals>.<genexpr>r r# r r r r� � s z _Threads.reap) rX rY rZ r[ r� r� r� r� r� r r r� r r� w s r� c @ s e Zd ZdZdd� Zdd� ZdS )� _NoThreadsz) Degenerate version of _Threads. c C s d S rT r r� r r r r� � s z_NoThreads.appendc C s d S rT r r# r r r r� � s z_NoThreads.joinN)rX rY rZ r[ r� r� r r r r r� � s r� c s> e Zd ZdZdZdZe� Zdd� Zdd� Z � fdd �Z � Z S ) r z4Mix-in class to handle each request in a new thread.FTc C sP z>z| � ||� W n ty0 | �||� Y n0 W | �|� n | �|� 0 dS )zgSame as in BaseServer but as a thread. In addition, exception handling is done here. N)rF r@ rA rB rC r r r �process_request_thread� s z%ThreadingMixIn.process_request_threadc C sL | j rt| ��dt� � tj| j||fd�}| j|_| j � |� |� � dS )z*Start a new thread to process the request.�_threads)�targetrV N) r� �vars� setdefaultr� r �Threadr� �daemon_threadsr� r� r� �start)r rD rE �tr r r r? � s � z ThreadingMixIn.process_requestc s t � �� | j�� d S rT )r� rH r� r� r# r� r r rH � s zThreadingMixIn.server_close) rX rY rZ r[ r� r� r� r� r� r? rH r� r r r� r r � s r c @ s e Zd ZdS )r N�rX rY rZ r r r r r � r� r c @ s e Zd ZdS )r Nr� r r r r r � r� r c @ s e Zd ZdS )r Nr� r r r r r � r� r c @ s e Zd ZdS )r Nr� r r r r r � r� r c @ s e Zd ZejZdS )r N�rX rY rZ r4 r r] r r r r r � s r c @ s e Zd ZejZdS )r Nr� r r r r r � s r c @ s e Zd ZdS )r Nr� r r r r r � r� r c @ s e Zd ZdS )r Nr� r r r r r � r� r c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) 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 C s> || _ || _|| _| �� z| �� W | �� n | �� 0 d S rT )rD rE �server�setup�handle�finish)r rD rE r� r r r r! � s zBaseRequestHandler.__init__c C s d S rT r r# r r r r� � s zBaseRequestHandler.setupc C s d S rT r r# r r r r� � s zBaseRequestHandler.handlec C s d S rT r r# r r r r� � s zBaseRequestHandler.finishN)rX rY rZ r[ r! r� r� r� r r r r r � s r c @ s0 e Zd ZdZdZdZdZdZdd� Zdd � Z dS ) r z4Define self.rfile and self.wfile for stream sockets.rv r NFc C sz | j | _| jd ur | j�| j� | jr:| j�tjtjd� | j� d| j �| _ | j dkrdt | j�| _n| j� d| j �| _d S )NT�rbr �wb)rD � connectionr6 � settimeout�disable_nagle_algorithmrb r4 � IPPROTO_TCP� TCP_NODELAY�makefile�rbufsize�rfile�wbufsize� _SocketWriter�wfiler# r r r r� s � zStreamRequestHandler.setupc C sD | j js,z| j �� W n tjy* Y n0 | j �� | j�� d S rT )r� �closed�flushr4 �errorri r� r# r r r r� # s zStreamRequestHandler.finish) rX rY rZ r[ r� r� r6 r� r� r� r r r r r s r c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) r� z�Simple writable BufferedIOBase implementation for a socket Does not hold data in a buffer, avoiding any need to call flush().c C s || _ d S rT )�_sock)r �sockr r r r! 3 s z_SocketWriter.__init__c C s dS )NTr r# r r r �writable6 s z_SocketWriter.writablec C s> | j �|� t|��}|jW d � S 1 s00 Y d S rT )r� �sendall� memoryview�nbytes)r �b�viewr r r �write9 s z_SocketWriter.writec C s | j �� S rT )r� rj r# r r r rj > s z_SocketWriter.filenoN)rX rY rZ r[ r! r� r� rj r r r r r� . s r� c @ s e Zd ZdZdd� Zdd� ZdS )r z6Define self.rfile and self.wfile for datagram sockets.c C s2 ddl m} | j\| _| _|| j�| _|� | _d S )Nr )�BytesIO)�ior� rD Zpacketr4 r� r� )r r� r r r r� E s z DatagramRequestHandler.setupc C s | j �| j�� | j� d S rT )r4 �sendtor� �getvaluerE r# r r r r� K s z DatagramRequestHandler.finishN)rX rY rZ r[ r� r� r r r r r A s r )%r[ � __version__r4 r) rz rP r r� r r8 r �__all__�hasattr�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 �<module> sN z n~ X ( .-