; ?c@sgdZdkZdkZdkZdkZdkZdkZdkZdkZdk Z dk l Z l Z dZ dZdZdZdZdeifd YZd eifd YZd efd YZdeifdYZdeifdYZdeifdYZdeifdYZdeifdYZdefdYZdS(sb Logging package for Python. Based on PEP 282 and comments thereto in comp.lang.python, and influenced by Apache's log4j system. Should work under Python versions >= 1.5.2, except that source line information is not available unless 'inspect' is. Copyright (C) 2001-2002 Vinay Sajip. All Rights Reserved. To use, simply 'import logging' and log away! N(sThreadingTCPServersStreamRequestHandleri<#i=#i>#i?#isRotatingFileHandlercBs,tZddddZdZdZRS(NsaicCsFtii|||||_||_|djo d|_ndS(s Open the specified file and use it as the stream for logging. By default, the file grows indefinitely. You can specify particular values of maxBytes and backupCount to allow the file to rollover at a predetermined size. Rollover occurs whenever the current log file is nearly maxBytes in length. If backupCount is >= 1, the system will successively create new files with the same pathname as the base file, but with extensions ".1", ".2" etc. appended to it. For example, with a backupCount of 5 and a base file name of "app.log", you would get "app.log", "app.log.1", "app.log.2", ... through to "app.log.5". The file being written to is always "app.log" - when it gets filled up, it is closed and renamed to "app.log.1", and if files "app.log.1", "app.log.2" etc. exist, then they are renamed to "app.log.2", "app.log.3" etc. respectively. If maxBytes is zero, rollover never occurs. isaN(sloggings FileHandlers__init__sselfsfilenamesmodesmaxBytess backupCount(sselfsfilenamesmodesmaxBytess backupCount((s-/mit/python/lib/python2.3/logging/handlers.pys__init__-s    cCs|ii|idjoxt|idddD]{}d|i|f}d|i|df}t i i |o8t i i |ot i |nt i ||q7q7W|id}t i i |ot i |nt i |i|nt|id|_dS(s< Do a rollover, as described in __init__(). iiis%s.%ds.1swN(sselfsstreamscloses backupCountsrangesis baseFilenamessfnsdfnsosspathsexistssremovesrenamesopen(sselfsissfnsdfn((s-/mit/python/lib/python2.3/logging/handlers.pys doRolloverHs   cCs|idjo[d|i|}|iidd|iit||ijo|i qknt i i ||dS(s Emit a record. Output the record to the file, catering for rollover as described in doRollover(). is%s iN( sselfsmaxBytessformatsrecordsmsgsstreamsseekstellslens doRolloversloggings FileHandlersemit(sselfsrecordsmsg((s-/mit/python/lib/python2.3/logging/handlers.pysemit^s#(s__name__s __module__s__init__s doRolloversemit(((s-/mit/python/lib/python2.3/logging/handlers.pysRotatingFileHandler,s s SocketHandlercBsMtZdZdZdZdZdZdZdZdZ RS(s A handler class which writes logging records, in pickle format, to a streaming socket. The socket is kept open across logging calls. If the peer resets it, an attempt is made to reconnect on the next call. The pickle which is sent is that of the LogRecord's attribute dictionary (__dict__), so that the receiver does not need to have the logging module installed in order to process the logging event. To unpickle the record at the receiving end into a LogRecord, use the makeLogRecord function. cCs8tii|||_||_t|_d|_dS(s  Initializes the handler with a specific host address and port. The attribute 'closeOnError' is set to 1 - which means that if a socket error occurs, the socket is silently closed and then reopened on the next logging call. iN( sloggingsHandlers__init__sselfshostsportsNonessocks closeOnError(sselfshostsport((s-/mit/python/lib/python2.3/logging/handlers.pys__init__zs    cCs9tititi}|i|i|if|SdS(sr A factory method which allows subclasses to define the precise type of socket they want. N(ssocketsAF_INETs SOCK_STREAMsssconnectsselfshostsport(sselfss((s-/mit/python/lib/python2.3/logging/handlers.pys makeSocketscCs|t|ido|ii|nRd}t|}x<|djo.|ii||}||}||}q<WdS(s Send a pickled string to the socket. This function allows for partial sends which can happen when the network is busy. ssendalliN( shasattrsselfssockssendallsss sentsofarslensleftssendssent(sselfssssents sentsofarsleft((s-/mit/python/lib/python2.3/logging/handlers.pyssends   cCs9ti|id}tidt|}||SdS(s Pickles the record in binary format with a length prefix, and returns it ready for transmission across the socket. is>LN( scPicklesdumpssrecords__dict__sssstructspackslensslen(sselfsrecordsslenss((s-/mit/python/lib/python2.3/logging/handlers.pys makePicklescCsE|io|io|iit|_ntii||dS(s Handle an error during logging. An error has occurred during logging. Most likely cause - connection lost. Close the socket so that we can retry on the next event. N( sselfs closeOnErrorssocksclosesNonesloggingsHandlers handleErrorsrecord(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys handleErrors   cCsYy>|i|}|i o|i|_n|i|Wn|i|nXdS(s Emit a record. Pickles the record and writes it to the socket in binary format. If there is an error with the socket, silently drop the packet. If there was a problem with the socket, re-establishes the socket. N(sselfs makePicklesrecordssssocks makeSocketssends handleError(sselfsrecordss((s-/mit/python/lib/python2.3/logging/handlers.pysemits cCs(|io|iit|_ndS(s$ Closes the socket. N(sselfssocksclosesNone(sself((s-/mit/python/lib/python2.3/logging/handlers.pyscloses  ( s__name__s __module__s__doc__s__init__s makeSocketssends makePickles handleErrorsemitsclose(((s-/mit/python/lib/python2.3/logging/handlers.pys SocketHandlerms     sDatagramHandlercBs)tZdZdZdZdZRS(s A handler class which writes logging records, in pickle format, to a datagram socket. The pickle which is sent is that of the LogRecord's attribute dictionary (__dict__), so that the receiver does not need to have the logging module installed in order to process the logging event. To unpickle the record at the receiving end into a LogRecord, use the makeLogRecord function. cCs ti|||d|_dS(sP Initializes the handler with a specific host address and port. iN(s SocketHandlers__init__sselfshostsports closeOnError(sselfshostsport((s-/mit/python/lib/python2.3/logging/handlers.pys__init__scCs tititi}|SdS(su The factory method of SocketHandler is here overridden to create a UDP socket (SOCK_DGRAM). N(ssocketsAF_INETs SOCK_DGRAMss(sselfss((s-/mit/python/lib/python2.3/logging/handlers.pys makeSocketscCs#|ii||i|ifdS(s Send a pickled string to a socket. This function no longer allows for partial sends which can happen when the network is busy - UDP does not guarantee delivery and can deliver packets out of sequence. N(sselfssockssendtossshostsport(sselfss((s-/mit/python/lib/python2.3/logging/handlers.pyssends(s__name__s __module__s__doc__s__init__s makeSocketssend(((s-/mit/python/lib/python2.3/logging/handlers.pysDatagramHandlers   s SysLogHandlercBstZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdZdZdZdZd Zd Zd Zd Zd ZdZdZdZdZdZdZhde<de<de<de <de<de<de<de <de<de<de<det i j o/|i it i t i t i|_ nX|i i |d|_n%t i t it i |_ d|_t|_dS(s Initialize a handler. If address is specified as a string, UNIX socket is used. If facility is not specified, LOG_USER is used. iiN(sloggingsHandlers__init__sselfsaddresssfacilitystypestypess StringTypessocketsAF_UNIXs SOCK_DGRAMsconnectserrorscloses SOCK_STREAMs unixsocketsAF_INETsNones formatter(sselfsaddresssfacility((s-/mit/python/lib/python2.3/logging/handlers.pys__init__Qs       s<%d>%scCs^t|tijo|i|}nt|tijo|i|}n|d>|BSdS(s Encode the facility and priority. You can pass in strings or integers - if strings are passed, the facility_names and priority_names mapping dictionaries are used to convert them to integers. iN(stypesfacilitystypess StringTypesselfsfacility_namesspriorityspriority_names(sselfsfacilityspriority((s-/mit/python/lib/python2.3/logging/handlers.pysencodePriorityrs cCs|io|iindS(s$ Closes the socket. N(sselfs unixsocketssocketsclose(sself((s-/mit/python/lib/python2.3/logging/handlers.pyscloses cCs|i|}|i|i|iti|i |f}y8|i o|i i |n|i i ||iWn|i|nXdS(s Emit a record. The record is formatted, and then sent to the syslog server. If exception information is present, it is NOT sent to the server. N(sselfsformatsrecordsmsgslog_format_stringsencodePrioritysfacilitysstringslowers levelnames unixsocketssocketssendssendtosaddresss handleError(sselfsrecordsmsg((s-/mit/python/lib/python2.3/logging/handlers.pysemits (&s__name__s __module__s__doc__s LOG_EMERGs LOG_ALERTsLOG_CRITsLOG_ERRs LOG_WARNINGs LOG_NOTICEsLOG_INFOs LOG_DEBUGsLOG_KERNsLOG_USERsLOG_MAILs LOG_DAEMONsLOG_AUTHs LOG_SYSLOGsLOG_LPRsLOG_NEWSsLOG_UUCPsLOG_CRONs LOG_AUTHPRIVs LOG_LOCAL0s LOG_LOCAL1s LOG_LOCAL2s LOG_LOCAL3s LOG_LOCAL4s LOG_LOCAL5s LOG_LOCAL6s LOG_LOCAL7spriority_namessfacility_namessSYSLOG_UDP_PORTs__init__slog_format_stringsencodePrioritysclosesemit(((s-/mit/python/lib/python2.3/logging/handlers.pys SysLogHandlersF  r s SMTPHandlerc BsztZdZdZdZddddddd gZed d d d ddddddddg ZdZdZ RS(sK A handler class which sends an SMTP email for each logging event. cCstii|t|tijo"|\}}||_||_ n||_t |_ ||_ t|tijo |g}n||_ ||_dS(s Initialize the handler. Initialize the instance with the from and to addresses and subject line of the email. To specify a non-standard SMTP port, use the (host, port) tuple format for the mailhost argument. N(sloggingsHandlers__init__sselfstypesmailhoststypess TupleTypeshostsportsmailportsNonesfromaddrstoaddrss StringTypessubject(sselfsmailhostsfromaddrstoaddrsssubjectshostsport((s-/mit/python/lib/python2.3/logging/handlers.pys__init__s        cCs |iSdS(s Determine the subject for the email. If you want to specify a subject line which is record-dependent, override this method. N(sselfssubject(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys getSubjectssMonsTuesWedsThusFrisSatsSunsJansFebsMarsAprsMaysJunsJulsAugsSepsOctsNovsDecc Csetiti\ }}} }}}}}} d|i || |i |||||f}|SdS(s=Return the current date and time formatted for a MIME header.s#%s, %02d %3s %4d %02d:%02d:%02d GMTN(stimesgmtimesyearsmonthsdayshhsmmsssswdsyszsselfs weekdaynames monthnamess( sselfswdsmmsssmonthsssshhsyearsyszsday((s-/mit/python/lib/python2.3/logging/handlers.pys date_times0-cCsydk}|i}| o |i}n|i|i|}|i|}d|i t i |id|i||i|f}|i|i |i||iWn|i|nXdS(sd Emit a record. Format the record and send it to the specified addressees. Ns-From: %s To: %s Subject: %s Date: %s %ss,(ssmtplibsselfsmailportsports SMTP_PORTsSMTPsmailhostssmtpsformatsrecordsmsgsfromaddrsstringsjoinstoaddrss getSubjects date_timessendmailsquits handleError(sselfsrecordssmtpsmsgssmtplibsport((s-/mit/python/lib/python2.3/logging/handlers.pysemits   :( s__name__s __module__s__doc__s__init__s getSubjects weekdaynamesNones monthnames date_timesemit(((s-/mit/python/lib/python2.3/logging/handlers.pys SMTPHandlers   - sNTEventLogHandlercBsJtZdZeddZdZdZdZdZdZ RS(s A handler class which sends events to the NT Event Log. Adds a registry entry for the specified application name. If no dllname is provided, win32service.pyd (which contains some basic message placeholders) is used. Note that use of these placeholders will make your event logs big, as the entire message source is held in the log. If you want slimmer logs, you have to pass in the name of your own DLL which contains the message definitions you want to use in the event log. s ApplicationcCs;tii|ydk}dk}||_||_| oKt i i |ii }t i i |d}t i i |dd}n||_||_|ii||||i|_hti|i<ti|i<ti|i<ti|i<ti|i<|_Wn!tj odGHt|_nXdS(Niswin32service.pydsWThe Python Win32 extensions for NT (service, event logging) appear not to be available.(sloggingsHandlers__init__sselfswin32evtlogutils win32evtlogsappnames_welusdllnamesosspathssplits__file__sjoinslogtypesAddSourceToRegistrysEVENTLOG_ERROR_TYPEsdeftypesDEBUGsEVENTLOG_INFORMATION_TYPEsINFOsWARNINGsEVENTLOG_WARNING_TYPEsERRORsCRITICALstypemaps ImportErrorsNone(sselfsappnamesdllnameslogtypes win32evtlogswin32evtlogutil((s-/mit/python/lib/python2.3/logging/handlers.pys__init__s"     XcCsdSdS(sy Return the message ID for the event record. If you are using your own messages, you could do this by having the msg passed to the logger being an ID rather than a formatting string. Then, in here, you could use a dictionary lookup to get the message ID. This version returns 1, which is the base message ID in win32service.pyd. iN((sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys getMessageID scCsdSdS(s Return the event category for the record. Override this if you want to specify your own categories. This version returns 0. iN((sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pysgetEventCategoryscCs|ii|i|iSdS(s Return the event type for the record. Override this if you want to specify your own types. This version does a mapping using the handler's typemap attribute, which is set up in __init__() to a dictionary which contains mappings for DEBUG, INFO, WARNING, ERROR and CRITICAL. If you are using your own levels you will either need to override this method or place a suitable dictionary in the handler's typemap attribute. N(sselfstypemapsgetsrecordslevelnosdeftype(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys getEventTypes cCs|io}yb|i|}|i|}|i|}|i |}|ii |i ||||gWq|i |qXndS(s Emit a record. Determine the message ID, event category and event type. Then log the message in the NT event log. N(sselfs_welus getMessageIDsrecordsidsgetEventCategoryscats getEventTypestypesformatsmsgs ReportEventsappnames handleError(sselfsrecordscatsmsgstypesid((s-/mit/python/lib/python2.3/logging/handlers.pysemit+s &cCsdS(sS Clean up this handler. You can remove the application name from the registry as a source of event log entries. However, if you do this, you will not be able to see the events as you intended in the Event Log Viewer - it needs to be able to access the registry to get the DLL name. N((sself((s-/mit/python/lib/python2.3/logging/handlers.pysclose<s ( s__name__s __module__s__doc__sNones__init__s getMessageIDsgetEventCategorys getEventTypesemitsclose(((s-/mit/python/lib/python2.3/logging/handlers.pysNTEventLogHandlers  s HTTPHandlercBs,tZdZddZdZdZRS(s^ A class which sends records to a Web server, using either GET or POST semantics. sGETcCs^tii|ti|}|ddgjo tdn||_||_ ||_dS(sr Initialize the instance with the host, the request URL, and the method ("GET" or "POST") sGETsPOSTsmethod must be GET or POSTN( sloggingsHandlers__init__sselfsstringsuppersmethods ValueErrorshostsurl(sselfshostsurlsmethod((s-/mit/python/lib/python2.3/logging/handlers.pys__init__Ns   cCs |iSdS(s Default implementation of mapping the log record into a dict that is send as the CGI data. Overwrite in your class. Contributed by Franz Glasner. N(srecords__dict__(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys mapLogRecord[scCs-ydk}dk}|i|i}|i}|i|i|}|i djoAt i |ddjo d}nd}|d||f}n|i|i ||i djo |idtt|n|i|i djo|i|n|iWn|i|nXdS( sh Emit a record. Send the record to the Web server as an URL-encoded dictionary NsGETs?is&s%c%ssPOSTsContent-length(shttplibsurllibsHTTPsselfshostshsurls urlencodes mapLogRecordsrecordsdatasmethodsstringsfindsseps putrequests putheadersstrslens endheadersssendsgetreplys handleError(sselfsrecordshttplibssepsurlshsurllibsdata((s-/mit/python/lib/python2.3/logging/handlers.pysemitcs(    (s__name__s __module__s__doc__s__init__s mapLogRecordsemit(((s-/mit/python/lib/python2.3/logging/handlers.pys HTTPHandlerIs  sBufferingHandlercBs2tZdZdZdZdZdZRS(s A handler class which buffers logging records in memory. Whenever each record is added to the buffer, a check is made to see if the buffer should be flushed. If it should, then flush() is expected to do what's needed. cCs&tii|||_g|_dS(s> Initialize the handler with the buffer size. N(sloggingsHandlers__init__sselfscapacitysbuffer(sselfscapacity((s-/mit/python/lib/python2.3/logging/handlers.pys__init__s cCst|i|ijSdS(s Should the handler flush its buffer? Returns true if the buffer is up to capacity. This method can be overridden to implement custom flushing strategies. N(slensselfsbufferscapacity(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys shouldFlushscCs2|ii||i|o|indS(s Emit a record. Append the record. If shouldFlush() tells us to, call flush() to process the buffer. N(sselfsbuffersappendsrecords shouldFlushsflush(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pysemitscCs g|_dS(sw Override to implement custom flushing behaviour. This version just zaps the buffer to empty. N(sselfsbuffer(sself((s-/mit/python/lib/python2.3/logging/handlers.pysflushs(s__name__s __module__s__doc__s__init__s shouldFlushsemitsflush(((s-/mit/python/lib/python2.3/logging/handlers.pysBufferingHandler~s   s MemoryHandlercBsDtZdZeiedZdZdZdZ dZ RS(s A handler class which buffers logging records in memory, periodically flushing them to a target handler. Flushing occurs whenever the buffer is full, or when an event of a certain severity or greater is seen. cCs&ti||||_||_dS(s Initialize the handler with the buffer size, the level at which flushing should occur and an optional target. Note that without a target being set either here or via setTarget(), a MemoryHandler is no use to anyone! N(sBufferingHandlers__init__sselfscapacitys flushLevelstarget(sselfscapacitys flushLevelstarget((s-/mit/python/lib/python2.3/logging/handlers.pys__init__s cCs-t|i|ijp|i|ijSdS(sP Check for buffer full or a record at the flushLevel or higher. N(slensselfsbufferscapacitysrecordslevelnos flushLevel(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pys shouldFlushscCs ||_dS(s: Set the target handler for this handler. N(stargetsself(sselfstarget((s-/mit/python/lib/python2.3/logging/handlers.pys setTargetscCs?|io1x!|iD]}|ii|qWg|_ndS(s For a MemoryHandler, flushing means just sending the buffered records to the target, if there is one. Override if you want different behaviour. N(sselfstargetsbuffersrecordshandle(sselfsrecord((s-/mit/python/lib/python2.3/logging/handlers.pysflushs   cCs |it|_g|_dS(sD Flush, set the target to None and lose the buffer. N(sselfsflushsNonestargetsbuffer(sself((s-/mit/python/lib/python2.3/logging/handlers.pyscloses  ( s__name__s __module__s__doc__sloggingsERRORsNones__init__s shouldFlushs setTargetsflushsclose(((s-/mit/python/lib/python2.3/logging/handlers.pys MemoryHandlers    (s__doc__ssyssloggingssocketstypessossstringscPicklesstructstimes SocketServersThreadingTCPServersStreamRequestHandlersDEFAULT_TCP_LOGGING_PORTsDEFAULT_UDP_LOGGING_PORTsDEFAULT_HTTP_LOGGING_PORTsDEFAULT_SOAP_LOGGING_PORTsSYSLOG_UDP_PORTs FileHandlersRotatingFileHandlersHandlers SocketHandlersDatagramHandlers SysLogHandlers SMTPHandlersNTEventLogHandlers HTTPHandlersBufferingHandlers MemoryHandler(sDatagramHandlersRotatingFileHandlersThreadingTCPServers HTTPHandlersDEFAULT_TCP_LOGGING_PORTsstructsDEFAULT_HTTP_LOGGING_PORTsDEFAULT_UDP_LOGGING_PORTsSYSLOG_UDP_PORTsDEFAULT_SOAP_LOGGING_PORTscPicklesstringsNTEventLogHandlersStreamRequestHandlers MemoryHandlerssyss SMTPHandlerstypessloggingssockets SysLogHandlersBufferingHandlerstimes SocketHandlersos((s-/mit/python/lib/python2.3/logging/handlers.pys?s QAg$Ib5*