B ”܇\öWã@s*dZddlmZddlmZddlmZddlZddlZddlmZddl Z ddl Z ddl Z ddl m Z ddlmZdd lmZd Zd ZGd d „d ejƒZdd„Zdd„Zed$dd„ƒZGdd„dejƒZGdd„deƒZe jdd„ƒZdd„Ze j dddd„ƒZ!Gd d!„d!eƒZ"Gd"d#„d#ejƒZ#dS)%z# Access and control log capturing. é)Úabsolute_import)Údivision)Úprint_functionN)Úcontextmanager)Údummy_context_manager)Úcreate_terminal_writer)ÚPathz7%(filename)-25s %(lineno)4d %(levelname)-8s %(message)sz%H:%M:%ScsteZdZdZejdhejddhejdhejdhej dhej dhej e ƒiZ e d¡Z‡fdd „Z‡fd d „Z‡ZS) ÚColoredLevelFormatterzQ Colorize the %(levelname)..s part of the log format passed to __init__. ZredÚboldZyellowZgreenZpurplez%\(levelname\)([+-]?\d*s)c s°tt|ƒj||Žtjr"|j|_n |jj|_i|_|j   |j¡}|sHdS|  ¡}xZ|j   ¡D]L\}}|dt |¡i}dd„|Dƒ} |j|f| Ž} |j  | |j¡|j|<q\WdS)NZ levelnamecSsi|] }d|“qS)T©)Ú.0Únamer r ú.lib/python3.7/site-packages/_pytest/logging.pyú 9sz2ColoredLevelFormatter.__init__..)Úsuperr Ú__init__ÚsixÚPY2Ú_fmtÚ _original_fmtÚ_styleÚ_level_to_fmt_mappingÚLEVELNAME_FMT_REGEXÚsearchÚgroupÚLOGLEVEL_COLOROPTSÚitemsÚloggingZ getLevelNameZmarkupÚsub) ÚselfZterminalwriterÚargsÚkwargsZlevelname_fmt_matchZ levelname_fmtÚlevelZ color_optsZformatted_levelnameZ color_kwargsZcolorized_formatted_levelname)Ú __class__r rr&s"   zColoredLevelFormatter.__init__cs8|j |j|j¡}tjr ||_n||j_tt |ƒ  |¡S)N) rÚgetÚlevelnorrrrrrr Úformat)rÚrecordZfmt)r#r rr&As zColoredLevelFormatter.format)Ú__name__Ú __module__Ú __qualname__Ú__doc__rZCRITICALZERRORZWARNINGZWARNÚINFOÚDEBUGZNOTSETÚsetrÚreÚcompilerrr&Ú __classcell__r r )r#rr s    r cGs6x0|D](}| |¡}|dkr&| |¡}|r|SqWdS)N)Ú getoptionÚgetini)ÚconfigÚnamesr Zretr r rÚget_option_iniJs    r6c s戠d¡‰d+‡‡fdd„ }|ddddd d d d |d dddd|ddtdd|ddtddˆjddd dd|ddddd|ddddd|dd ddd|d!d"dd#d|d$d%dd&d|d'd(tdd|d)d*tdddS),z%Add options to control log capturing.rNcs0ˆj|||d|dˆj|fd|i|—ŽdS)Nzdefault value for )ÚdefaultÚtypeÚhelpÚdest)ÚaddiniZ addoption)Úoptionr:r7r8r!)rÚparserr rÚadd_option_iniWsz(pytest_addoption..add_option_iniz--no-print-logsÚ log_printZ store_constFTÚboolz-disable printing caught logs on failed tests.)r:ÚactionZconstr7r8r9z --log-levelÚ log_levelz(logging level used by the logging module)r:r7r9z --log-formatÚ log_formatz)log format as used by the logging module.z--log-date-formatÚlog_date_formatz.log date format as used by the logging module.Úlog_clizBenable log display during test run (also known as "live logging").)r7r8r9z--log-cli-levelÚ log_cli_levelzcli logging level.z--log-cli-formatÚlog_cli_formatz--log-cli-date-formatÚlog_cli_date_formatz --log-fileÚlog_filez/path to a file when logging will be written to.z--log-file-levelÚlog_file_levelzlog file logging level.z--log-file-formatÚlog_file_formatz--log-file-date-formatÚlog_file_date_format)NN)ZgetgroupÚDEFAULT_LOG_FORMATÚDEFAULT_LOG_DATE_FORMATr;)r=r>r )rr=rÚpytest_addoptionSs| rOc cs”t ¡}|dk r| |¡|dk r,| |¡||jk}|rD| |¡|dk rb|j}| t||ƒ¡z |VWd|dk r€| |¡|rŽ| |¡XdS)zCContext manager that prepares the whole logging machinery properly.N) rÚ getLoggerÚ setFormatterÚsetLevelZhandlersZ addHandlerr"ÚminZ removeHandler)ÚhandlerÚ formatterr"Z root_loggerZadd_new_handlerÚ orig_levelr r rÚ catching_logs§s"      rWc@s(eZdZdZdd„Zdd„Zdd„ZdS) ÚLogCaptureHandlerz;A logging handler that stores log records and the log text.cCstj |tj ¡¡g|_dS)zCreates a new log handler.N)rÚ StreamHandlerrÚpyÚioÚTextIOÚrecords)rr r rrÆszLogCaptureHandler.__init__cCs|j |¡tj ||¡dS)z;Keep the log records in a list in addition to the log text.N)r]ÚappendrrYÚemit)rr'r r rr_Ës zLogCaptureHandler.emitcCsg|_tj ¡|_dS)N)r]rZr[r\Ústream)rr r rÚresetÐszLogCaptureHandler.resetN)r(r)r*r+rr_rar r r rrXÃsrXc@s„eZdZdZdd„Zdd„Zedd„ƒZdd „Zed d „ƒZ ed d „ƒZ edd„ƒZ edd„ƒZ dd„Z ddd„Zeddd„ƒZdS)ÚLogCaptureFixturez-Provides access and control of log capturing.cCs||_i|_dS)zCreates a new funcarg.N)Ú_itemÚ_initial_log_levels)rÚitemr r rrØszLogCaptureFixture.__init__cCs0x*|j ¡D]\}}t |¡}| |¡q WdS)zcFinalizes the fixture. This restores the log levels changed by :meth:`set_level`. N)rdrrrPrR)rÚ logger_namer"Úloggerr r rÚ _finalizeÞs zLogCaptureFixture._finalizecCs|jjS)z+ :rtype: LogCaptureHandler )rcÚcatch_log_handler)rr r rrTèszLogCaptureFixture.handlercCs |jj |¡}|r|jSgSdS)a\ Get the logging records for one of the possible test phases. :param str when: Which test phase to obtain the records from. Valid values are: "setup", "call" and "teardown". :rtype: List[logging.LogRecord] :return: the list of captured records at the given stage .. versionadded:: 3.4 N)rcÚcatch_log_handlersr$r])rÚwhenrTr r rÚ get_recordsïs zLogCaptureFixture.get_recordscCs |jj ¡S)zReturns the log text.)rTr`Úgetvalue)rr r rÚtextszLogCaptureFixture.textcCs|jjS)z Returns the list of log records.)rTr])rr r rr]szLogCaptureFixture.recordscCsdd„|jDƒS)zÇReturns a list of a stripped down version of log records intended for use in assertion comparison. The format of the tuple is: (logger_name, log_level, message) cSsg|]}|j|j| ¡f‘qSr )r r%Ú getMessage)r Úrr r rú sz3LogCaptureFixture.record_tuples..)r])rr r rÚ record_tuples s zLogCaptureFixture.record_tuplescCsdd„|jDƒS)a†Returns a list of format-interpolated log messages. Unlike 'records', which contains the format string and parameters for interpolation, log messages in this list are all interpolated. Unlike 'text', which contains the output from the handler, log messages in this list are unadorned with levels, timestamps, etc, making exact comparisons more reliable. Note that traceback or stack info (from :func:`logging.exception` or the `exc_info` or `stack_info` arguments to the logging functions) is not included, as this is added by the formatter in the handler. .. versionadded:: 3.7 cSsg|] }| ¡‘qSr )ro)r rpr r rrq$sz.LogCaptureFixture.messages..)r])rr r rÚmessagesszLogCaptureFixture.messagescCs|j ¡dS)z8Reset the list of log records and the captured log text.N)rTra)rr r rÚclear&szLogCaptureFixture.clearNcCs,|}t |¡}|j ||j¡| |¡dS)aÇSets the level for capturing of logs. The level will be restored to its previous value at the end of the test. :param int level: the logger to level. :param str logger: the logger to update the level. If not given, the root logger level is updated. .. versionchanged:: 3.4 The levels of the loggers changed by this function will be restored to their initial values at the end of the test. N)rrPrdÚ setdefaultr"rR)rr"rgrfr r rÚ set_level*s  zLogCaptureFixture.set_levelc cs6t |¡}|j}| |¡z dVWd| |¡XdS)a9Context manager that sets the level for capturing of logs. After the end of the 'with' statement the level is restored to its original value. :param int level: the logger to level. :param str logger: the logger to update the level. If not given, the root logger level is updated. N)rrPr"rR)rr"rgrVr r rÚat_level;s    zLogCaptureFixture.at_level)N)N)r(r)r*r+rrhÚpropertyrTrlrnr]rrrsrtrvrrwr r r rrbÕs     rbccst|jƒ}|V| ¡dS)a¢Access and control log capturing. Captured logs are available through the following properties/methods:: * caplog.text -> string containing formatted log output * caplog.records -> list of logging.LogRecord instances * caplog.record_tuples -> list of (logger_name, level, message) tuples * caplog.clear() -> clear captured records and formatted log output string N)rbZnoderh)ZrequestÚresultr r rÚcaplogLs rzc Gs„x2|D]&}| |¡}|dkr&| |¡}|rPqWdSt|tjƒrH| ¡}yttt||ƒƒSt k r~t   d  ||¡¡‚YnXdS)z Return the actual logging level.Nzo'{}' is not recognized as a logging level name for '{}'. Please consider passing the logging level num instead.) r2r3Ú isinstancerZ string_typesÚupperÚintÚgetattrrÚ ValueErrorÚpytestZ UsageErrorr&)r4Z setting_namesZ setting_namerBr r rÚget_actual_log_level\s    rT)ZtrylastcCs|j t|ƒd¡dS)Nzlogging-plugin)Ú pluginmanagerÚregisterÚ LoggingPlugin)r4r r rÚpytest_configurevsr…c@seZdZdZdd„Zdd„Zdd„Zdd „Zej d d d d d „ƒZ e dd„ƒZ e dd„ƒZ ej d ddd„ƒZej d ddd„ƒZej d ddd„ƒZej d ddd„ƒZej d ddd„ƒZej d ddd„ƒZej d d d dd „ƒZej d d d d!d"„ƒZej d dd#d$„ƒZd%S)&r„zLAttaches to the logging module and captures log messages for each test. cCsè||_| ¡r | d¡s d|j_t|dƒ|_t t|dƒt|dƒ¡|_ t |dƒ|_ t |dƒ|_ t|ddƒ|_ t|d dƒ|_tj|j |jd |_t|d ƒ}|r¾tj|d d d|_|j |j¡nd|_d|_dd„|_| ¡rä| ¡dS)z·Creates a new plugin to capture log messages. The formatter can be safely shared across all handlers so create a single one for the entire test session here. Úverboseér?rCrDrBrJrKrL)ÚdatefmtrIÚwzUTF-8)ÚmodeÚencodingNcSstƒS)N)rr r r rÚ¦sz(LoggingPlugin.__init__..)Ú_configÚ_log_cli_enabledr2r<r†r6Ú print_logsrÚ FormatterrUrrBrJrKrLÚlog_file_formatterÚ FileHandlerÚlog_file_handlerrQÚlog_cli_handlerÚlive_logs_contextÚ_setup_cli_logging)rr4rIr r rrs0      zLoggingPlugin.__init__cs®|j}|j d¡}|dkrdS|j d¡}t||ƒ‰t|ddƒ}t|ddƒ}|jjdkrxtj  |¡rxtt |ƒ||d‰nt j ||d‰t |d d ƒ‰ˆ|_‡‡‡fd d „|_dS) NZterminalreporterZcapturemanagerrGrCrHrDZno)rˆrFrBcstˆˆˆdS)N)rUr")rWr )Úlog_cli_formatterr”rFr rrŒËsz2LoggingPlugin._setup_cli_logging..)rr‚Z get_pluginÚ_LiveLoggingStreamHandlerr6r<Zcolorr rrrrrrr”r•)rr4Úterminal_reporterÚcapture_managerrGrHr )r—r”rFrr–®s(          z LoggingPlugin._setup_cli_loggingcCs`t|ƒ}| ¡st|jj|ƒ}|j ¡s8|jjdddtjt |ƒddd|_ |j   |j ¡dS)zãPublic method, which can set filename parameter for Logging.FileHandler(). Also creates parent directory if it does not exist. .. warning:: Please considered as an experimental API. T)Úexist_okÚparentsr‰zUTF-8)rŠr‹N) rZ is_absoluterZrootdirÚparentÚexistsÚmkdirrr’Ústrr“rQr‘)rÚfnamer r rÚ set_log_pathÏs zLoggingPlugin.set_log_pathcCs|j d¡dk p|j d¡S)z‘Return True if log_cli should be considered enabled, either explicitly or because --log-cli-level was given in the command-line. z--log-cli-levelNrE)rr2r3)rr r rrŽäszLoggingPlugin._log_cli_enabledT)Ú hookwrapperZtryfirstc cs^| ¡L|jr|j d¡|jdk rJt|j|jd dVWdQRXndVWdQRXdS)NZ collection)r")r•r”Úset_whenr“rWrJ)rr r rÚpytest_collectionìs   zLoggingPlugin.pytest_collectionc csP| ||¡:|jdk rs   z"LoggingPlugin.pytest_sessionfinishc cs^| ¡L|jr|j d¡|jdk rJt|j|jd dVWdQRXndVWdQRXdS)NZ sessionstart)r")r•r”r¤r“rWrJ)rr r rÚpytest_sessionstartIs   z!LoggingPlugin.pytest_sessionstartc csL| ¡:|jdk r8t|j|jd dVWdQRXndVWdQRXdS)zRuns all collected test items.N)r")r•r“rWrJ)rZsessionr r rÚpytest_runtestloopTs   z LoggingPlugin.pytest_runtestloopN)r(r)r*r+rr–r¢rŽr€Úhookimplr¥rr§r¦r¬r­r®r°r²r³r´rµr¶r r r rr„{s"/!   r„c@s0eZdZdZdd„Zdd„Zdd„Zdd „Zd S) r˜a Custom StreamHandler used by the live logging feature: it will write a newline before the first log message in each test. During live logging we must also explicitly disable stdout/stderr capturing otherwise it will get captured and won't appear in the terminal. cCs2tjj||d||_| ¡| d¡d|_dS)zŒ :param _pytest.terminal.TerminalReporter terminal_reporter: :param _pytest.capture.CaptureManager capture_manager: )r`NF)rrYrršrar¤Ú_test_outcome_written)rr™ršr r rrhs  z"_LiveLoggingStreamHandler.__init__cCs d|_dS)zAReset the handler; should be called before the start of each testFN)Ú_first_record_emitted)rr r rrassz_LiveLoggingStreamHandler.resetcCs||_d|_|dkrd|_dS)z7Prepares for the given test phase (setup/call/teardown)Fr¯N)Ú_whenÚ_section_name_shownr¸)rrkr r rr¤wsz"_LiveLoggingStreamHandler.set_whenc Csž|jr|j ¡ntƒ}|z|js6|j d¡d|_n"|jdkrX|jsXd|_|j d¡|js‚|jr‚|jj d|jdddd|_t j   ||¡WdQRXdS)NÚ T)r¨r±z live log ú-)Úsepr ) ršZglobal_and_fixture_disabledrr¹r`Úwriterºr¸r»ZsectionrrYr_)rr'Z ctx_managerr r rr_~s    z_LiveLoggingStreamHandler.emitN)r(r)r*r+rrar¤r_r r r rr˜_s  r˜)NN)$r+Z __future__rrrrr/Ú contextlibrrZrr€Z_pytest.compatrZ_pytest.configrZ_pytest.pathlibrrMrNrr r6rOrWrYrXÚobjectrbZfixturerzrr·r…r„r˜r r r rÚs6       4 T we