File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/logger.tar
Back
usr/bin/logger 0000755 00000105740 15027401326 0007341 0 ustar 00 ELF > `C @ � @ 8 @ @ @ @ � � x x �; �; ` ` ` ( ( �w �� �� � � @{ @� @� 8 8 8 0 0 h h h D D S�td 8 8 8 0 0 P�td ho ho ho � � Q�td R�td �w �� �� P P /lib64/ld-linux-x86-64.so.2 GNU � � � GNU �]ɔ��D���S���Gm�� GNU T � T �e�m ; � � 6 p � / � k f � G e � � � x � � � \ ^ � � � # x r � � ( � � � � � � � � � � q Q ~ U � � e � F � � � S � ] " � l I � � 6 � � Q N B " __cxa_finalize __libc_start_main __cxa_atexit stdout __errno_location ferror stderr fflush dcgettext warn _exit fileno warnx malloc __vasprintf_chk __stack_chk_fail __ctype_b_loc strcasecmp strtol gettimeofday localtime_r __snprintf_chk sysconf gethostname strchr free strdup strcmp calloc errx __assert_fail getaddrinfo socket connect freeaddrinfo strlen __strcpy_chk gai_strerror sendmsg writev getpid geteuid kill realloc memcpy strndup stpcpy strftime ntp_gettimex setlocale bindtextdomain getopt_long optarg strtok fopen stdin freopen program_invocation_short_name __progname __printf_chk strtoumax strtoul localeconv strncmp optind __getdelim __fprintf_chk fclose memmove fputs fputc getc getuid getpwuid __gmon_start__ _ITM_deregisterTMCloneTable _ITM_registerTMCloneTable sd_booted sd_journal_sendv libsystemd.so.0 libc.so.6 LIBSYSTEMD_209 GLIBC_2.3 GLIBC_2.12 GLIBC_2.8 GLIBC_2.14 GLIBC_2.4 GLIBC_2.34 GLIBC_2.3.4 GLIBC_2.2.5 ( ��b B 8 ii Q ��� [ ii f ��� p ii { ��� � ti � ui � �� @D �� D �� b � �d � �d � �d @� �d `� �d �� �d �� �d �� �d � �d � �d � �d @� 5c `� Jc �� �d �� �d �� �d � �d � sb � e @� e `� e �� e �� #e � ,e � 0e � 4e �� 8e � <e � @e � De � He � Le (� Pe 0� Te 8� Xe � � � �c 0� �c @� �c P� �c `� �d p� ` �� �c �� �c �� �c �� �c �� d А d � d � d � d 0� $d @� +d P� /d `� 4d p� 8d �� =d �� Bd �� Gd �� �` �� Pd Б Ud � Zd � ad � hd � od � vd 0� }d @� �d P� �d �� �� �� �� �� �� . ȏ / Џ K ؏ N � T � R X� `� h� p� x� �� �� �� �� �� �� �� �� �� ȍ Ѝ ؍ � � � �� � � � � � (� ! 0� " 8� # @� $ H� % P� & X� ' `� ( h� ) p� * x� + �� , �� - �� 0 �� 1 �� 2 �� 3 �� 4 �� 5 �� 6 Ȏ 7 Ў 8 ؎ 9 � : � ; � < �� = � > � ? � @ � A � B (� C 0� D 8� E @� F H� G P� H X� I `� J h� L p� M x� O �� P �� Q �� S � �H��H��o H��t��H��� �5"m �%#m � �h ������ �h ������� �h ������ �h ������ �h ������ �h ������ �h ������ �h ��q����� �h ��a����� �h ��Q����� �h ��A����� �h ��1����� �h ��!����� �h ������� �h ������� �h ����� �h ������ �h ������� �h ������ �h ������ �h ������ �h ������ �h ������ �h ��q����� �h ��a����� �h ��Q����� �h ��A����� �h ��1����� �h ��!����� �h ������� �h ������� �h ����� �h ������ �h! ������� �h" ������ �h# ������ �h$ ������ �h% ������ �h& ������ �h' ��q����� �h( ��a����� �h) ��Q����� �h* ��A����� �h+ ��1����� �h, ��!����� �h- ������� �h. ������� �h/ ����� �h0 ������ �h1 ������� �h2 ������ �h3 ������ �h4 ������ �h5 ������ �h6 ������ �h7 ��q����� �h8 ��a����� �h9 ��Q����� �h: ��A����� �h; ��1����� �h< ��!����� �h= ������� �h> ������� �h? ����� �h@ ������ �hA ������� �hB ������ �hC ������ �hD ������ �hE ������ �hF ������ �hG ��q����� ��%%k D � ��%�h D � ��%�h D � ��%}h D � ��%uh D � ��%mh D � ��%eh D � ��%]h D � ��%Uh D � ��%Mh D � ��%Eh D � ��%=h D � ��%5h D � ��%-h D � ��%%h D � ��% h D � ��%h D � ��% h D � ��%h D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%�g D � ��%}g D � ��%ug D � ��%mg D � ��%eg D � ��%]g D � ��%Ug D � ��%Mg D � ��%Eg D � ��%=g D � ��%5g D � ��%-g D � ��%%g D � ��% g D � ��%g D � ��% g D � ��%g D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%�f D � ��%}f D � ��%uf D � ��%mf D � ��%ef D � ��%]f D � ��%Uf D � �AW� L�=n^ AVI��H�57: AUA��ATL�%4: UH�-�8 SH�� dH�%( H��$� 1�H�|$x�D$p�����D$t �H�� Ƅ$� pDŽ$� HDŽ$� � ���H�58 H�����H�����H�=b �1 H��$� H�$ H�D$H��$� H��$� H��$� H��$� H��$� �D$P �D$ E1�L��L��L��D����������� ��P��:�� H� �C Hc�H�>�������D$x�H�4e H� H��$� �H� e �= H�(H������" H��H�D$�~���H��H��t<H�x�" �h���H��t)H�|$H��t H9�sH9�sH��H��H9�u H9��� H�,$� H�5�; � H��d �@ L� L��L�D$� ���L�D$H���� I9��G �X���; L�D$ H�hH�D$���L�D$ H�t$H��H����]H�E���/ H��DZu�H9��� �} � �} .�� �]���� H�EH����H�-�c H�} ������ H�5!6 1����H�] H�D$h H�D$���� H��H��t �; �! H��H�T$H�� 1�H�5�5 ����$� ���H�oc � H�H������H���� H��$� ����H�Bc H�5F6 H�(H������D$P�������H�5�6 H���u������� H�56 H���^����D$P ���n���1�� H�5�9 ���H��H��1��^����I���H��) H� �5 H��$� H��b H�8H��� ���H�����H��H��� ���H�5O5 H���������� ��$� �1���H�� H��$� ������$� ������$� ���H�4b H�(H���� �. H�����H���� � H�5Hc H��H�D$�� H�T$�����B H�jH�5Ab H��� ���q ��u� ���� ؉D$t�4���H� �a H�;H��� H�57 ���H�$H������L�#� H�5u4 1����L�� H��1�������$� ����H�La H� H��$� ���H�5a H� H��$� ���H� a H�a H�5�6 H�H�;����H��� �D$ �o�����$� ��b���DŽ$� �R���H��` � H�5�3 1�L� ����� H� �3 H��L��1����1����DŽ$� ����� H�53 1����H�D$H�f` H�H���< �; �3 ���H�D$8H�0H��� � H����DN u�-� �L���H�|$h1�H�D$h � H��H�|$HH��H�D$(�q���H�l$hH�D$0H��H9��� H�t$(����� H�W�H����� H�D$0 �؉Ņ��� �� H�D$0H��$� ����H��_ H� H��$� ���H�\$(H�t$H1�L��H�D$h � ����H�L$hL9��� ����* H�p�H����� H��t �9 �� H�\$@����D��ډ�9�H�T$H��H�5X1 �8 � � tf���f D H�5�1 H���1�����u��$� �1�� ���H�5�1 H��������� ��$� �1����H��^ H� H�$�������H�D$h� H��H��� ����U ��� H�T$hH9������H�������: ���������D$P ���H��������} �x���H�D$ 1�L�t$XH�\$@H��H�l$8D�l$TA���C<i�_ ��߀�B�� �{ �� �}�H�������H�8H�������H�|$8���H�|$ I���|����; �s���H�|$8H��H�������[���I�I�<0u A�UD)� @ F�,2I�FI��<0t�H�U �DB����L�t$h1�L��H�D$ H���;�������L�$� H�5�3 1��4�H�$� H��1��q�H9�s�L��� �Bu�H��H9�vV��Hހ�9w�H���������H�H�ـ�u��L��H�5�. ��L�D$��t L��H�5�/ ��L�D$��� H�|$L��� � �����H�o\ Hc(A)�E��t$�|$ t 1�� H�5�9 �r�H��1����H�<$ � �� E1�L�|$hH�D$` H�D$h �� �D$P H�D$H�D$`H�D$f�H� $H�|$� L��H�D$` �1�L�d$`H���tEM��t@L����I���$ @ � ���C�T4�I�n�H� �DP � I��M��u�A�$ L�d$`L������$� ��4 1�t@H�D$Ic�L�%�. H��I��H�� I�L�� I��H�j[ H�81��H�L9�u�E��t/H�t$A�E�H��H��L�df � H�;H����I9�u�H�|$��H��Z H�4$H90t H�<$���� H��$� dH+%( �� H�� 1�[]A\A]A^A_�f � C�4 H�l$`� H�5�. H�������u���usD��D;l$Pt Ic�A��H��HD$H�(L�p�S���C�D- �D$P= � Lcd$PH�|$I��L����H�D$H��u�M��t�L��H�5`* � ��Hc�H��Hl$H�EH�} M�d�L�����H��uM��u�H�E HEI�V�H�x� H�D$`H�p�:�H�|$`��H�EI�D�H�E���� H�50 1���H��H��1���1�����H�5�Y H���H �������H�,$� H�5�+ �0���H�݃�"�����H�T$H�ٿ 1�H�5�+ ���L��$� L�|$M9�t)H� �* I�}�H��tH���Z���0 M�m M9�uދD$P���� 1҃��w ��$� L�l$pL��� Ј�$� �P H��$� �� H��$� �� H��$� ��L��HDŽ$� ��$� E���A H��$� M�|�H�{� L�l$I��H�D�H�$L���BI9�tH�|$L���8 M�o�H��$� L��K� 4I9�vZA�D H�|$I�w�� I��M�o�M���� L����I��H�\ H9 $r�H��$� I9�w�I9�t �E H��J�\5 H��L��L��H������ �H��W � H�55 1�L� ��� H��H��W L��H�81��w� �M�H�>W � 1�H�5�* H�(�`�H��H����H�FW 1�� H�5g* L� �8�� H��L��H��1���H�� ��� 1�H�5. ��H��H����� 1�H�5,* ���H��H����� 1�H�5. ���H��H���|�� 1�H�5 . ��H��H���^�� 1�H�5H. ��H��H���@�� 1�H�5j. �m�H��H���"�� 1�H�5�. �O�H��H����� 1�H�5�. �1�H��H�����1�� H�5�. ��H��H������ 1�H�5/ ��H��H����� 1�H�54/ ���H��H����� 1�H�5^/ ��H��H���n�� 1�H�5�/ ��H��H���P�� 1�H�5�/ �}�H��H���2�� 1�H�5�/ �_�H��H����� 1�H�5�/ �A�H��H����� 1�H�5�/ �#�H��H������ 1�H�50 ��H��H����� 1�H�5$0 ���H��H����� H�5�0 1����H��H���~�� H�5�0 1���H��H���`�� H�5�0 1���H��H���B�� H�5�0 1��o�H��H���$�� H�51 1��Q�H��H����� H�5b1 1��3�H��H�����H�� ��� H�5\' 1���� H�5Y' 1�H�����I��L�W' H�_' H��H�5a' � 1����� H�5Z' 1���� H�b' H��1���1��k�L��H�5�& ���L�D$���4���������$� � �� Ј�$� � �����$� �� ��T���D�t$tH��$� D�t$ �>�L��$� I)�I�|$�� H� �R H��H�;�'��$ D�t$A��A���� ��$� t A��<� E1�A���@��A�� ��@��t6M9�w �/ @ M9�s&I��H�;F�t=�������A��@�ƃ� ��@��u�B�D= M��u ��$� x �<$ �� H��L���S �$ A�� �Z���H�;�j�A���J���� �G���H��$� H�8 H�� HD�H��$� �O����x �,�H�|$H��� �T���� H�����; ��u��H��tH�8H��t �? � H��% H��$� ����C���<B���{ ���D�l$(H��D�l$TA� H�\$@L�t$X�m H�$ D�T$8H����D�T$8H���e H��# H)ЍpL�\$0A��A��Ic�� L��H��H����A����H���� I��E��u�H�|$ L�\$0�8���0�1�Ic�� H��H����A����H��uH��E��u�H�D$ � � I��������H9��� L9��� 1�H����H��$� �}�L��HDŽ$� ��$� �������x�����H�|$D���������$� ��H�D$(� ������W�H��������L�l$I9�t L��L��� L�����|$p���t ������� H��$� �������$� �����H�����Hk� �����E <A� ���1�H�D$���� @k� I��F�t=�A�t6�H�D$H�;�t$PL� L�D$��L�D$�t$PA��H�A�D@u�A���@��A�� ��@ �@�|$t F�t= I��A��>u��� v`�t$ �t$t;t$tiH��$� �t$P�#��$ �t$PL��$� I)Ā|$ �t$�a���H�;�t$���t$A�Ɖt$��������t$tE1�;t$u��͋t$ �1�A� I���������1�I���;|$(t L9�w�Hk� �� A� I��H��1�M��H��1�Hk� I��L��I��I��H��t L9�wL��I��1�I��1�I��H��I��HD$0I�� w��\�H�|$ L�\$0����������!������D�l$(H��D�l$TA�� H�\$@L�t$X�s�����H�-� D�T$8H���2�H�����H)�D�T$8�p�y������H��t|H��$� ���H�\$@D�l$T��L�t$XH�D$0 �ى���H�D$(H�\$@D�l$TL�t$X����#��κ H�5+ 1��L�� � H��1����S�H�5� � ��H�5� 1�� ��� H��1���L�#� H�5 �S�� H�5�* 1����� H��1���H�,$� H�5 �z�� H�5h ��H� �+ �� H�5S H�=� �8� � � �1�I��^H��H���PTE1�1�H�=���L �f. � H�=�N H��N H9�tH��K H��t �� � � � H�=�N H�5�N H)�H��H��?H��H�H�tH��K H��t��f D � � � ��=uN u+UH�=�K H��t H�=�K ���d����MN ]� � � � ��w��� � � �USH��H�GK H�(��� H��H��������� ��� u?H�XK H�(� H������uH�������tW � �; u;H��[]� @ �� t�� H�5+ 1����� ��H��1��>�f D � � �f D H���P��Dž�x��U��Dž�x�����t�� @ H���X����B���H�����Dž��0������Dž��!����j������������h�H��1�����q���f � ATI�����H��uM��uA\�L��H�5_ � �� D H��� I��H�T$0H�L$8L�D$@L�L$H��t7)D$P)L$`)T$p)�$� )�$� )�$� )�$� )�$� dH�%( H�D$1�H��$� H��L��H�D$� H�D$ �$ �D$0 H�D$�A���xH�T$dH+%( uH��� �H�5� � 1�����m��ff. � f�ATUSH��dH�%( H�D$1�H��t?L�'H��E��t3H���?�H� B�D`t�Bf�H��������� H��H�3H��u����H�T$dH+%( �� H��[]A\�f�H�$ ����� H��H��� I������A� $H�¸������u�H� $H9�t�H��t�9 u�H�; ��t� � 9Ct�H��H�; u��p��� @ �C�i����c�� AT1�L�%uK UH��XdH�%( H�D$H1�H��H�����H�t$H���8���D$HcT$ L��L�V � � P�D$ P�D$(P�D$4PH��B L� к 1����H��H�D$HdH+%( u H��XL��]A\������ �ATUSH��H��0D�OdH�%( H�D$(1�E��uH�$ H��L�c�(����SH�{I��H��M��H�5� 1��*���H�D$(dH+%( u-H��0[]A\ÐH�� � � L�� H��������(�� � � �AUATUSH��H��8D�OdH�%( H�D$(1��$ E���� �� A�A A�@ ���H��~I��L�`L���D��H��H���� L��H���=������ B�D- �. H������H��t� L�c�!���H���SH�{H��H�D$M��I��PH�5� 1�����XZH�D$(dH+%( urH��8H��[]A\A]��� D H�� � � L�q ����� ��� D H������H�=f ����H��H���^���H�5P � 1��E������L��H�5� � 1��*��f. � AUATUSH��H���� H� H��I��H9�t$ � H�{�H��t L�������t{H�H9�u� � �\��H��H��tDL�hL��L�hL�h�0��H���� H�H�EH�kL�mH�CL�(H��[]A\A]�f D � H�5 � 1��h��� H�5L 1�����L�� H��1����H� $ �J H�5_ H�=� �D��H�5 � ��� AWAVAUATUSH��H��xL�0dH�%( H�D$h1�M���� H�G8� L�d$0�D$ H�D$I��H�D$(H�D$f�A)$A)D$A)D$ ���� �C@� H�|$ H�� � �D$8 LD�H�L$L��L��L���������R H�D$(�P �p�x���A�ƃ���� H�D$(D���PH�p�v��H�|$(����� ����9k@tn�k@�if � L�g(M���� L���k��H��k�� � �l L��H�=�E f��E ����C@�uJ��� f��Cx�� A�����D�3H�D$hdH+%( �X H��x[]A\A]A^A_�f. � 1Ҿ � A� ���� A�ƃ��tD�n H�5pE D��������t9k@� ���� � D���x��A���^���f D �C@�F���1Ҿ � ���A�ƃ���3���A� � �f D �C@t,H�|$ H� �D$8 LD��8��� @ H�|$(�N���|$ � uB� H�5� 1�����L��L��� H��1��*��f. � L�%� L�g(�o����D$ ��� ����D���������� H�5 1����L�� H��1������������ H�5 1�H���Z��I��L��L��H�ƿ 1����� H�5C 1��/��L�� H��1����ff. � f�AWAVI��AUATUSH��H��� dH�%( H��$� 1�H�D$ �Gxu �?���� �Cy�3 A� � E1�H�{Mc�H��I��J�|<p���L��L�t,pJ�D<x���H�D,x�Cx�uc�;��x]f�{@H�D$@ )D$)D$0�v H�D$p�kH�D$ Ic�H�D$(��� H�l$� @ H�����H���~ �Cx�tSA�D$�H�H��H�Dp�8 �M A���� A�T$Mc�H�� I��J�D$pJ�D$x H�t$p� �3��H�|$���H��$� dH+%( �� H��� []A\A]A^A_�H�{���L��H�����H�|$H�5� H�T 1��D���H�|$H�H�|$pH��u�^��H�D$xA� � A� �~��� H�{0 ������9�t �������� �;���� � ���t���������H���h������� �Cy�����I��H� J�D$pJ�D$x E�e�^��� @ D������ � �;���uI�����H��� ����;� @ H������H���U���1�� H�5� �`��H��1�����3�����;��밋{1�������(���H�D$8 H�D$P�;H�D$0H� H�D$X�CH�D$P �D$`�������H� j � H�5� H�=� ���f. � H��t{ATI��UH��SH�?H��tYH�? tSH��1�f D H���ڃ�H�8 u�rH��H��9�r>�V��H��t4��H�,ЍSH�� I�$1�[]A\� D � 1��� � 1�ø���f D ATUH��� H�T$@H�L$HL�D$PL�L$X��t:)D$`)L$p)�$� )�$� )�$� )�$� )�$� )�$� dH�%( H�D$(1�H;?�� H�WH��$ �D$ H�L$H�L$0H9�H�B� H�L$ HD�H�L$H�� H�|$�D$0 H�h�5����x9L�d$H��L�������x u#H�D$(dH+%( uQH��� ]A\�L���(���u H�� H�5= 1�� ���H� 2 �l H�5� H�=/ ������ D UH��SH��H;?�� H��thH�W� H9�H�B�H��HE�����H��H��t%H�{H��������x uH��[]� @ H������b H�C H�5� 1�� ���H� � �] H�5 H�=� ���� H�5~ 1��?��H�� H��1��}��ff. � f�H��H �txAWAVI��AUATI��UH��SH��H��tlH���� ���J� 0I��H�{�~��I��H��t$L��H��H���(��K�|= L��L�����A�D H��L��[]A\A]A^A_�H�=N ��� @ H��L��H��[]A\A]A^A_��� � H��[]A\A]A^A_�m��ff. � f�AWAVAUE1�ATUSH��(L�'H�|$dH�%( H�D$1�L9��� f D I�\$�H���� L�;M���� I��L��1�� @ H��H������I�~I��H�H��u�H�}�j��H��H��t:H�� � L��H�����L�;H��M��tH9�t� H��f�G��� D I�T$�H��H�|$1�H�5� �M�H���U��H�l$H��t,H���c��H��L��H���%���L��H���*��H��I��� ��M�$$L9d$����H�D$dH+%( uH��(L��[]A\A]A^A_����f � � �AWAVAUATL�%j USH��H��� dH�%( H��$� H�GH� H��ID�H�D$���H���% �kxI��@���} L�����H��� ��@H�D$�� �� A�A �@ ���H��~H��L�xL������I��H���� L��H���������� A�, L���)��H=� �t L�{L�����H��0� �S���� H�|$ H�5� 1���L�{`H�k`�Cx �� L9{`�] H�{PH;{P�g �Z���H��H���V H���SM��H�{UH�5u 1�AU�t$8L�L$(H�L$8�Q�H�|$8H�� �S��L���K��H�|$ �A��L���9��H���1��H��$� dH+%( �v H��� []A\A]A^A_� � H�l$ 1�L�d$0H�����L��H���!��H���t H��$� L��@ H��H� ����H�T$(H��H�|$�L~�L�L}�D}:�L~1��~��kx��@�#���H�= ���I��H���l���H�5 � 1����f D L������H�{PH��H;{P�������I��H���U H���C H���5��L��H��H�����H��I�����L��L�������U��� @ H�=~ ���H���j���H�D$ H�k`L�{`�Cx ����L�5m L9�t"H�}�H��tL���������G���H�m L9�u�L��L����L��H�5= ���H�|$0������uvL��H�5, �w���H�T$@L��1�H�5# ������� @ H�=� �L��H��H���������� L�����H�=� �$��I��H�������� H�5� L��1�����#���H���C���L���2���� H�5] 1�����L��� H��1��������L��H�5� � 1��)��� H�5 1����L�� H��1�����H�5� 1�� �a��� H��1�����f�� �H�m4 1����� � �H��H��� write error cannot allocate %zu bytes cannot allocate string %s %2d %2.2d:%2.2d:%2.2d [%d] <%d>%s %s%s: - cannot duplicate string <%d>%.15s %s %.200s%s: misc-utils/logger.c syslog /dev/log syslog-conn openlog %s: pathname too long socket %s %zu send message failed !list_empty(ls) [%s %s] %Y-%m-%dT%H:%M:%S.%%06u%z localtime() failed hostname '%s' is too long tag '%s' is too long %d timeQuality tzKnown="1" isSynced="1" syncAccuracy="%ld" isSynced="0" <%d>1 %s %s %s %s %s %s /usr/share/locale util-linux file %s failed to parse id %s: '%s' unknown facility name: %s unknown priority name: %s failed to parse message size KMGTPEZY kmgtpezy notime notq nohost , --msgid cannot contain space cannot open %s off auto origin meta %s from %s util-linux 2.37.2 Usage: %s [options] [<message>] Options: display version display this help -V, --version -h, --help %-26s%s %-26s%s For more details see %s. logger(1) ef:ip:S:st:u:dTn:P:Vh <someone> close failed MESSAGE= alert crit debug emerg info none notice panic warn warning auth authpriv cron daemon ftp kern lpr mail mark news security user uucp local0 local1 local2 local3 local4 local5 local6 local7 stderr file no-act priority tag socket socket-errors udp tcp server port octet-count prio-prefix rfc3164 rfc5424 msgid skip-empty sd-id sd-param journald Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec structured data ID '%s' is not unique failed to resolve name %s port %s: %s failed to connect to %s port %s ARRAY_SIZE(iov) > (size_t)iovlen %s: %u: cannot allocate memory --sd-id was not specified for --sd-param %s ignoring unknown option argument: %s invalid argument: %s: using automatic errors invalid structured data ID: '%s' invalid structured data parameter: '%s' Enter messages into the system log. -i log the logger command's PID --id[=<id>] log the given <id>, or otherwise the PID -f, --file <file> log the contents of this file -e, --skip-empty do not log empty lines when processing files --no-act do everything except the write the log -p, --priority <prio> mark given message with this priority --octet-count use rfc6587 octet counting --prio-prefix look for a prefix on every line read from stdin -s, --stderr output message to standard error as well -S, --size <size> maximum size for a single message -t, --tag <tag> mark every line with this tag -n, --server <name> write to this remote syslog server -P, --port <port> use this port for UDP or TCP connection -T, --tcp use TCP only -d, --udp use UDP only --rfc3164 use the obsolete BSD syslog protocol --rfc5424[=<snip>] use the syslog protocol (the default for remote); <snip> can be notime, or notq, and/or nohost --sd-id <id> rfc5424 structured data ID --sd-param <data> rfc5424 structured data name=value --msgid <msgid> set rfc5424 message id field -u, --socket <socket> write to this Unix socket --socket-errors[=<on|off|auto>] print connection errors when using Unix sockets --journald[=<file>] write journald entry Try '%s --help' for more information. --file <file> and <message> are mutually exclusive, message is ignored maximum input lines (%d) exceeded journald entry could not be written /�� �� ��;���+��� ���� �� �� �� �� �� �� �� �� �� �� �� �� ������������ ��c��z��� �� �� �� ������ ������ �� ��x�������m��� �� �� �� �� �� �� �� �� �� ��`��� ���W�������w���J���=���̽���������k��� pencode add_structured_data_paramf add_structured_data_param add_structured_data_id write_output ;� ����� H��� X���0 ع��T ���� ���H (��t X��� 8��� 8��� ��� x��T ���� ���� h��( ��x 8�� ��� X� (�� ��� (�� zR x � ��& D $ 4 ����� FJ w� ?:*3$" \ (��� t ���� ( � ���7 E�A�D g AAE � ���+ B�T A � ���� G�� A 0 � ���� B�A�A �D0q AABC < $ P��� B�J�DpFxE�E�E�ZpT DBA 0 d ���� F�A�A �GP[ AABB D � ��f F�B�A �A(�G`�hVpOhA`T (D ABBJ 8 � D�� B�B�A �A(�D0� (A ABBG L ��c B�B�B �B(�A0�A8�G�z 8A0A(B BBBK L l 8��6 B�B�E �B(�A0�A8�J�^ 8A0A(B BBBA 8 � (��� G�D�D �X ABF P���C ���( � |��K B�A�G�� ABA ( $ ��� A�D�D H AAE � P D�� J�B�E �B(�D0�D8�D@S8D0A(B BBBA������P@������D 8G�0A�(B� B�B�B�L D8A�0A�(B� B�B�B� H � |�W B�B�B �E(�A0�A8�D`3 8D0A(B BBBA ` 4 ��� F�B�B �B(�H0�A8�J�7�K�K�D�X�E 8A0A(B BBBI P � |��� F�N�L �E(�H0�H8�G�� 8C0A(B BBBJ � x� @D D b � �d s �d f �d � �d p �d t �d u �d � �d d �d T �d n �d P 5c V Jc h �d � �d � �d � �d � sb S e � e e e � e � #e � ,e 0e 4e 8e <e @e De He Le Pe Te Xe ( 8 �[ �� �� ���o � � � � @� � � � � ���o ���o ( ���o �o x ���o I @� 0 @ P ` p � � � � � � � � ! ! ! 0! @! P! `! p! �! �! �! �! �! �! �! �! " " " 0" @" P" `" p" �" �" �" �" �" �" �" �" # # # 0# @# P# `# p# �# �# �# �# �# �# �# �# $ $ $ 0$ @$ P$ `$ p$ �$ �$ �$ � �c �c �c �c �d ` �c �c �c �c d d ���� d d P d H $d +d X /d 4d 0 8d =d � Bd 8 Gd �` ( Pd Ud @ Zd � ad � hd � od � vd � }d � �d � �d � ���� /usr/lib/debug/.dwz/x86_64-linux-gnu/bsdutils.debug �Ft�˷�i�,X`� Z4�1F5dc994eae2448ec3d6539815fe9f476de9f4fd.debug �J�� .shstrtab .interp .note.gnu.property .note.gnu.build-id .note.ABI-tag .gnu.hash .dynsym .dynstr .gnu.version .gnu.version_r .rela.dyn .rela.plt .init .plt.got .plt.sec .text .fini .rodata .eh_frame_hdr .eh_frame .init_array .fini_array .data.rel.ro .dynamic .data .bss .gnu_debugaltlink .gnu_debuglink 8 8 0 & h h $ 9 � � G ���o � � $ Q � � � Y � � � a ���o x x � n ���o ( ( � } � � � � B � � � � � � � �$ �$ � �$ �$ � � @) @) b2 � �[ �[ � ` ` e � ho ho � � (p (p � �� �w � �� �w � �� �w � � @� @{ � @� @} � � � p �� p� � p� H �� 4 � / usr/share/bash-completion/completions/logger 0000644 00000003021 15027623053 0015300 0 ustar 00 _logger_module() { local cur prev OPTS COMPREPLY=() cur="${COMP_WORDS[COMP_CWORD]}" prev="${COMP_WORDS[COMP_CWORD-1]}" case $prev in '-f'|'--file'|'--journald') local IFS=$'\n' compopt -o filenames COMPREPLY=( $(compgen -f -- $cur) ) return 0 ;; '-n'|'--server') COMPREPLY=( $(compgen -A hostname -- $cur) ) return 0 ;; '-P'|'--port') COMPREPLY=( $(compgen -W "$(awk '$1 ~ /^syslog$/ {split($2, a, "/"); print a[1]}' /etc/services)" -- $cur) ) return 0 ;; '-p'|'--priority') COMPREPLY=( $(compgen -W "{auth,authpriv,cron,daemon,ftp,lpr,mail,news,security}.{alert,crit,debug,emerg,err,error}" -- $cur) ) return 0 ;; '-t'|'--tag') COMPREPLY=( $(compgen -W "tag" -- $cur) ) return 0 ;; '-u'|'--socket') COMPREPLY=( $(compgen -W "$(awk '$NF ~ /^\// {print $NF}' /proc/net/unix)" -- $cur) ) return 0 ;; '--socket-errors') COMPREPLY=( $(compgen -W "on off auto" -- $cur) ) return 0 ;; '--msgid') COMPREPLY=( $(compgen -W "msgid" -- $cur) ) return 0 ;; '-h'|'--help'|'-V'|'--version') return 0 ;; esac case $cur in -*) OPTS=" --file --help --id --journald --msgid --no-act --octet-count --port --prio-prefix --priority --rfc3164 --rfc5424 --server --size --skip-empty --socket --socket-errors --stderr --tag --tcp --udp --version " COMPREPLY=( $(compgen -W "${OPTS[*]}" -- $cur) ) return 0 ;; esac return 0 } complete -F _logger_module logger _levels.py 0000644 00000005651 15027667615 0006575 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_levels -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Log levels. """ from constantly import NamedConstant, Names # type: ignore[import] class InvalidLogLevelError(Exception): """ Someone tried to use a L{LogLevel} that is unknown to the logging system. """ def __init__(self, level: NamedConstant) -> None: """ @param level: A log level from L{LogLevel}. """ super().__init__(str(level)) self.level = level class LogLevel(Names): """ Constants describing log levels. @cvar debug: Debugging events: Information of use to a developer of the software, not generally of interest to someone running the software unless they are attempting to diagnose a software issue. @cvar info: Informational events: Routine information about the status of an application, such as incoming connections, startup of a subsystem, etc. @cvar warn: Warning events: Events that may require greater attention than informational events but are not a systemic failure condition, such as authorization failures, bad data from a network client, etc. Such events are of potential interest to system administrators, and should ideally be phrased in such a way, or documented, so as to indicate an action that an administrator might take to mitigate the warning. @cvar error: Error conditions: Events indicating a systemic failure, such as programming errors in the form of unhandled exceptions, loss of connectivity to an external system without which no useful work can proceed, such as a database or API endpoint, or resource exhaustion. Similarly to warnings, errors that are related to operational parameters may be actionable to system administrators and should provide references to resources which an administrator might use to resolve them. @cvar critical: Critical failures: Errors indicating systemic failure (ie. service outage), data corruption, imminent data loss, etc. which must be handled immediately. This includes errors unanticipated by the software, such as unhandled exceptions, wherein the cause and consequences are unknown. """ debug = NamedConstant() info = NamedConstant() warn = NamedConstant() error = NamedConstant() critical = NamedConstant() @classmethod def levelWithName(cls, name: str) -> NamedConstant: """ Get the log level with the given name. @param name: The name of a log level. @return: The L{LogLevel} with the specified C{name}. @raise InvalidLogLevelError: if the C{name} does not name a valid log level. """ try: return cls.lookupByName(name) except ValueError: raise InvalidLogLevelError(name) __pycache__/_global.cpython-310.pyc 0000644 00000017211 15027667615 0013075 0 ustar 00 o �b�! � @ s� d Z ddlZddlZddlmZmZmZmZmZ ddl m Z ddl m Z ddl mZ ddlmZ dd lmZmZ dd lmZ dd lmZ dd lmZ dd lmZ ddl m Z ddl m Z dZ G dd� d�Z!e � Z"e!e"ej#ee�Z$dS )z� This module includes process-global state associated with the logging system, and implementation of logic for managing that global state. � N)�IO�Any�Iterable�Optional�Type)� currentframe)�qual� )�LimitedHistoryLogObserver)�FileLogObserver)�FilteringLogObserver�LogLevelFilterPredicate�� eventAsText)� ILogObserver)� LoggingFile)�LogLevel)�Logger)� LogPublisherz�Warning: primary log target selected twice at <{fileNow}:{lineNow}> - previously selected at <{fileThen}:{lineThen}>. Remove one of the calls to beginLoggingTo.c @ s� e Zd ZdZdZ ddedee dedede e d df d d �Z d de e deded dfdd�Z d dedee dede de ee de e d dfdd�ZdS ) � LogBeginnera� A L{LogBeginner} holds state related to logging before logging has begun, and begins logging when told to do so. Logging "begins" when someone has selected a set of observers, like, for example, a L{FileLogObserver} that writes to a file on disk, or to standard output. Applications will not typically need to instantiate this class, except those which intend to initialize the global logging system themselves, which may wish to instantiate this for testing. The global instance for the current process is exposed as L{twisted.logger.globalLogBeginner}. Before logging has begun, a L{LogBeginner} will: 1. Log any critical messages (e.g.: unhandled exceptions) to the given file-like object. 2. Save (a limited number of) log events in a L{LimitedHistoryLogObserver}. @cvar _DEFAULT_BUFFER_SIZE: The default size for the initial log events buffer. @ivar _initialBuffer: A buffer of messages logged before logging began. @ivar _publisher: The log publisher passed in to L{LogBeginner}'s constructor. @ivar _log: The logger used to log messages about the operation of the L{LogBeginner} itself. @ivar _stdio: An object with C{stderr} and C{stdout} attributes (like the L{sys} module) which will be replaced when redirecting standard I/O. @ivar _temporaryObserver: If not L{None}, an L{ILogObserver} that observes events on C{_publisher} for this L{LogBeginner}. �� N� publisher� errorStream�stdio�warningsModule�initialBufferSize�returnc C s~ |du r| j }t|d�| _|| _t|d�| _|| _|| _t| jt t |dd� �t t j d�g��| _d| _|�| j� |j| _dS )z� Initialize this L{LogBeginner}. @param initialBufferSize: The size of the event buffer into which events are collected until C{beginLoggingTo} is called. Or C{None} to use the default size. N)�size)�observerc S s t | ddd�d S )NF)�includeTimestamp� includeSystem� r )�event� r# �8/usr/lib/python3/dist-packages/twisted/logger/_global.py�<lambda>a s ��z&LogBeginner.__init__.<locals>.<lambda>)�defaultLogLevel)� r )�_DEFAULT_BUFFER_SIZEr �_initialBuffer� _publisherr �_log�_stdio�_warningsModuler r r r r �critical�_temporaryObserver�_previousBegin� addObserver� showwarning�_oldshowwarning)�selfr r r r r r# r# r$ �__init__F s( � �� zLogBeginner.__init__FT� observers� discardBuffer�redirectStandardIOc C s� t d�}|jj}|j}|D ]}| j�|� q | jdur4| j�| j� |s+| j� | j� d| _| j | j _ n| j \}} | j jt|||| d� ||f| _ |rVdtjfdtjfg} ng } | D ]!\} } t| j| �} tt| | jd�| t| dd�d�}t| j| |� qZdS ) aw Begin logging to the given set of observers. This will: 1. Add all the observers given in C{observers} to the L{LogPublisher} associated with this L{LogBeginner}. 2. Optionally re-direct standard output and standard error streams to the logging system. 3. Re-play any messages that were previously logged to that publisher to the new observers, if C{discardBuffer} is not set. 4. Stop logging critical errors from the L{LogPublisher} as strings to the C{errorStream} associated with this L{LogBeginner}, and allow them to be logged normally. 5. Re-direct warnings from the L{warnings} module associated with this L{LogBeginner} to log messages. @note: Since a L{LogBeginner} is designed to encapsulate the transition between process-startup and log-system-configuration, this method is intended to be invoked I{once}. @param observers: The observers to register. @param discardBuffer: Whether to discard the buffer and not re-play it to the added observers. (This argument is provided mainly for compatibility with legacy concerns.) @param redirectStandardIO: If true, redirect standard output and standard error to the observers. r N)�fileNow�lineNow�fileThen�lineThen�stdout�stderr)� namespacer �encoding)�logger�levelr@ )r �f_code� co_filename�f_linenor* r1 r/ �removeObserverr) �replayTor2 r- r0 r+ �warn�MORE_THAN_ONCE_WARNINGr �info�error�getattrr, r r �setattr)r4 r6 r7 r8 �caller�filename�linenor � previousFile� previousLine�streams�streamrB � oldStream� loggingFiler# r# r$ �beginLoggingToo s@ $ � ��zLogBeginner.beginLoggingTo�message�categoryrO rP �file�linec C s> |du r| j jd|t|�||d� dS | �||||||� dS )a] Twisted-enabled wrapper around L{warnings.showwarning}. If C{file} is L{None}, the default behaviour is to emit the warning to the log system, otherwise the original L{warnings.showwarning} Python function is called. @param message: A warning message to emit. @param category: A warning category to associate with C{message}. @param filename: A file name for the source code file issuing the warning. @param lineno: A line number in the source file where the warning was issued. @param file: A file to write the warning message to. If L{None}, write to L{sys.stderr}. @param line: A line of source code to include with the warning message. If L{None}, attempt to read the line from C{filename} and C{lineno}. Nz*{filename}:{lineno}: {category}: {warning})�warningrY rO rP )r+ rH r r3 )r4 rX rY rO rP rZ r[ r# r# r$ r2 � s �zLogBeginner.showwarning)N)FT)NN)�__name__� __module__� __qualname__�__doc__r( r r r �objectr �intr5 r r �boolrW �strr �Warningr2 r# r# r# r$ r ! sZ "������ �,���� �P����� ���r )%r` �sys�warnings�typingr r r r r �twisted.python.compatr �twisted.python.reflectr �_bufferr �_filer �_filterr r �_formatr � _interfacesr �_ior �_levelsr �_loggerr � _observerr rI r �globalLogPublisherr> �globalLogBeginnerr# r# r# r$ �<module> s* � A __pycache__/_interfaces.cpython-310.pyc 0000644 00000005230 15027667615 0013756 0 ustar 00 o �b, � @ sh d Z ddlmZmZmZmZmZ ddlmZ er ddl m Z ee ef Z eed Z G dd� de�Zd S ) z Logger interfaces. � )� TYPE_CHECKING�Any�Dict�List�Tuple)� Interface� )�Logger)r � ILogObserverc @ s" e Zd ZdZdeddfdd�ZdS )r a An observer which can handle log events. Unlike most interfaces within Twisted, an L{ILogObserver} I{must be thread-safe}. Log observers may be called indiscriminately from many different threads, as any thread may wish to log a message at any time. �event�returnNc C s dS )ap Log an event. @param event: A dictionary with arbitrary keys as defined by the application emitting logging events, as well as keys added by the logging system. The logging system reserves the right to set any key beginning with the prefix C{"log_"}; applications should not use any key so named. Currently, the following keys are used by the logging system in some way, if they are present (they are all optional): - C{"log_format"}: a PEP-3101-style format string which draws upon the keys in the event as its values, used to format the event for human consumption. - C{"log_flattened"}: a dictionary mapping keys derived from the names and format values used in the C{"log_format"} string to their values. This is used to preserve some structured information for use with L{twisted.logger.extractField}. - C{"log_trace"}: A L{list} designed to capture information about which L{LogPublisher}s have observed the event. - C{"log_level"}: a L{log level <twisted.logger.LogLevel>} constant, indicating the importance of and audience for this event. - C{"log_namespace"}: a namespace for the emitter of the event, given as a L{str}. - C{"log_system"}: a string indicating the network event or method call which resulted in the message being logged. N� )r r r �</usr/lib/python3/dist-packages/twisted/logger/_interfaces.py�__call__ s zILogObserver.__call__)�__name__� __module__� __qualname__�__doc__�LogEventr r r r r r s r N)r �typingr r r r r �zope.interfacer �_loggerr �strr �LogTracer r r r r �<module> s __pycache__/_flatten.cpython-310.pyc 0000644 00000010410 15027667615 0013264 0 ustar 00 o �b� � @ s� d Z ddlmZ ddlmZ ddlmZmZmZ ddl m Z e� Z G dd� d�Z d e d d fd d �Z ded e d efdd�Zd e d efdd�Zd S )z� Code related to "flattening" events; that is, extracting a description of all relevant fields from the format string and persisting them for later examination. � )� defaultdict)� Formatter)�Any�Dict�Optional� )�LogEventc @ s< e Zd ZdZd dd�Zdedee dee defd d �ZdS ) � KeyFlattenerz� A L{KeyFlattener} computes keys for the things within curly braces in PEP-3101-style format strings as parsed by L{string.Formatter.parse}. �returnNc C s t dd� �| _dS )z/ Initialize a L{KeyFlattener}. c S s dS )Nr � r r r �9/usr/lib/python3/dist-packages/twisted/logger/_flatten.py�<lambda> s z'KeyFlattener.__init__.<locals>.<lambda>N)r �keys)�selfr r r �__init__ s zKeyFlattener.__init__� fieldName� formatSpec� conversionc C sf |du rd}|du r d}dj |||d�}| j| d7 < | j| }|dkr1|dt| j| � 7 }|S )a� Compute a string key for a given field/format/conversion. @param fieldName: A format field name. @param formatSpec: A format spec. @param conversion: A format field conversion type. @return: A key specific to the given field, format and conversion, as well as the occurrence of that combination within this L{KeyFlattener}'s lifetime. N� z%{fieldName}!{conversion}:{formatSpec})r r r r �/)�formatr �str)r r r r �result�nr r r �flatKey s � zKeyFlattener.flatKey)r N)�__name__� __module__� __qualname__�__doc__r r r r r r r r r s ����r �eventr Nc C s | � dd�du r dS d| v r| d }ni }t� }t�| d �D ]Y\}}}}|du r*q |dkr0d}|�|||�}|�||d�}||v rCq |�d�rQ|dd� }d } nd } t�|d | �} | d } |dkret} nt} | rl| � } | | �} | ||< | ||< q |r�|| d< dS dS ) z� Flatten the given event by pre-associating format fields with specific objects and callable results in a L{dict} put into the C{"log_flattened"} key in the event. @param event: A logging event. � log_formatN� log_flattened�r�sr z()���TFr r ) �getr � aFormatter�parser �endswith� get_field�reprr )r �fields� keyFlattener� literalTextr r r � flattenedKey� structuredKey�callit�field� fieldValue�conversionFunction�flattenedValuer r r � flattenEvent@ sD � �r5 r1 c C sX t � }t�d| d �\\}}}}|dusJ �|�|||�}d|vr&t|� |d | S )a. Extract a given format field from the given event. @param field: A string describing a format field or log key. This is the text that would normally fall between a pair of curly braces in a format string: for example, C{"key[2].attribute"}. If a conversion is specified (the thing after the C{"!"} character in a format field) then the result will always be str. @param event: A log event. @return: A value extracted from the field. @raise KeyError: if the field is not found in the given event. �{�}Nr! )r r& r' r r5 )r1 r r, r- r r r �keyr r r � extractField{ s � r9 c C sn | d }t � }g }t�| d �D ]!\}}}}|�|� |dur1|�|||p&d�}|�t|| �� qd�|�S )z� Format an event which has been flattened with L{flattenEvent}. @param event: A logging event. @return: A formatted string. r! r Nr# r )r r& r' �appendr r �join) r � fieldValuesr, r# r- r r r r8 r r r � flatFormat� s � � r= )r � collectionsr �stringr �typingr r r � _interfacesr r& r r5 r r9 r= r r r r �<module> s ,; __pycache__/_io.cpython-310.pyc 0000644 00000012214 15027667615 0012242 0 ustar 00 o �b� � @ sn d Z ddlZddlmZmZmZ ddlmZ ddlm Z ddl m Z ddl m Z dd lmZ G d d � d �ZdS ) z File-like object that logs. � N)�AnyStr�Iterable�Optional)� NamedConstant)�Version)�deprecatedProperty� )�LogLevel)�Loggerc @ sB e Zd ZdZdZeedddd��dd� �Zejdd� �Ze j d fd e d e d e e d d fdd�Zed efdd��Zed efdd��Zed efdd��Zed+dd��Zed efdd��Zd+dd�Zd+d d �Zd efd d �Zd efd d!�Zd"e d d fd#d$�Z d%e e d d fd&d'�Z d(e d d fd)d*�Z!e!Z"e!Z#e!Z$e!Z%e!Z&e!Z'e!Z(e!Z)d S ),� LoggingFileac File-like object that turns C{write()} calls into logging events. Note that because event formats are L{str}, C{bytes} received via C{write()} are converted to C{str}, which is the opposite of what C{file} does. @ivar softspace: Attribute to make this class more file-like under Python 2; value is zero or one. Do not use. r �Twisted� � c C � | j S �N�� _softspace��self� r �4/usr/lib/python3/dist-packages/twisted/logger/_io.py� softspace! s zLoggingFile.softspacec C s || _ d S r r )r �valuer r r r % s N�logger�level�encoding�returnc C s6 || _ || _|du rt�� | _n|| _d| _d| _dS )a @param logger: the logger to log through. @param level: the log level to emit events with. @param encoding: The encoding to expect when receiving bytes via C{write()}. If L{None}, use C{sys.getdefaultencoding()}. N� F)r �log�sys�getdefaultencoding� _encoding�_buffer�_closed)r r r r r r r �__init__) s zLoggingFile.__init__c C r )zm Read-only property. Is the file closed? @return: true if closed, otherwise false. �r# r r r r �closed@ � zLoggingFile.closedc C r )zU Read-only property. File encoding. @return: an encoding. )r! r r r r r I r' zLoggingFile.encodingc C � dS )zG Read-only property. File mode. @return: "w" �wr r r r r �modeR � zLoggingFile.modec C r( )z_ Read-only property. Types of newlines encountered. @return: L{None} Nr r r r r �newlines[ r+ zLoggingFile.newlinesc C s d� | jj| jj| jj�S )z� The name of this file; a repr-style string giving information about its namespace. @return: A file name. z <{} {}#{}>)�format� __class__�__name__r � namespacer �namer r r r r1 d s �zLoggingFile.namec C s d| _ dS )zD Close this file so it can no longer be written to. TNr% r r r r �closer s zLoggingFile.closec C r( )z3 No-op; this file does not buffer. Nr r r r r �flushx s zLoggingFile.flushc C r( )zp Returns an invalid file descriptor, since this is not backed by an FD. @return: C{-1} ���r r r r r �fileno~ � zLoggingFile.filenoc C r( )zK A L{LoggingFile} is not a TTY. @return: C{False} Fr r r r r �isatty� r6 zLoggingFile.isatty�messagec C sr | j rtd��t|t�r|�| j�}n|}| j| �d�}|d | _|dd� }|D ] }| jj | j d|d� q*dS )zW Log the given message. @param message: The message to write. z I/O operation on closed file� r4 r z{log_io})r- �log_ioN) r# � ValueError� isinstance�bytes�decoder! r" �splitr �emitr )r r8 �text�lines�liner r r �write� s �zLoggingFile.writerB c C s |D ]}| � |� qdS )zj Log each of the given lines as a separate message. @param lines: Data to write. N)rD )r rB rC r r r � writelines� s �zLoggingFile.writelines�argsc G s t d��)zW Template for unsupported operations. @param args: Arguments. zunsupported operation)�OSError)r rF r r r � _unsupported� s zLoggingFile._unsupported)r N)*r/ � __module__� __qualname__�__doc__r r r r �setterr �infor r r �strr$ �property�boolr& r r* r, r1 r2 r3 �intr5 r7 r rD r rE �objectrH �read�next�readline� readlines� xreadlines�seek�tell�truncater r r r r sV ���� � r )rK r �typingr r r � constantlyr � incrementalr �twisted.python.deprecater �_levelsr �_loggerr r r r r r �<module> s __pycache__/_legacy.cpython-310.pyc 0000644 00000007503 15027667615 0013104 0 ustar 00 o �by � @ s� d Z ddlmZmZmZmZmZ ddlmZ ddl m Z ddl m Z m Z ddlmZ ddlmZmZ er:dd lm Z ee �G d d � d ��Zd e d eeef deeeef gee f ddfdd�ZdS )z) Integration with L{twisted.python.log}. � )� TYPE_CHECKING�Any�Callable�Dict�Optional)� implementer� )� formatEvent)� ILogObserver�LogEvent)�LogLevel)�StringifiableFromEvent�fromStdlibLogLevelMapping)r c @ s: e Zd ZdZd dd�Zdefdd �Zd eddfd d �ZdS )�LegacyLogObserverWrapperz� L{ILogObserver} that wraps a L{twisted.python.log.ILogObserver}. Received (new-style) events are modified prior to forwarding to the legacy observer to ensure compatibility with observers that expect legacy events. �legacyObserver�ILegacyLogObserver�returnNc C s || _ dS )zr @param legacyObserver: a legacy observer to which this observer will forward events. N)r )�selfr � r �8/usr/lib/python3/dist-packages/twisted/logger/_legacy.py�__init__ s z!LegacyLogObserverWrapper.__init__c C s dj | d�S )Nz0{self.__class__.__name__}({self.legacyObserver})�r )�formatr r r r �__repr__' s z!LegacyLogObserverWrapper.__repr__�eventc C s d|vrd|d< d|vr|d |d< d|vr |� dd�|d< d|vrA|� d d �d urAd |d< t|�� �|d < t|d t�sAd|d< d |v rbd|vrO|d |d< d|vrWd|d< d|vrat|�|d< nd|vry|d tjtjfv rud|d< nd|d< | � |� d S )z� Forward events to the legacy observer after editing them to ensure compatibility. @param event: an event �messager �time�log_time�system� log_system�-r � log_formatNz%(log_legacy)s� log_legacy� log_failure�failure�isErrorr �why� log_levelr ) �getr �copy� isinstance�tupler r �error�criticalr )r r r r r �__call__* s0 � z!LegacyLogObserverWrapper.__call__)r r r N) �__name__� __module__� __qualname__�__doc__r �strr r r. r r r r r s r �observer� eventDict�textFromEventDictr Nc C s� d|vr |d |d< d|vr ||�}|dur ||d< d|d< d|vrUd|v r:zt |d }W n ty9 d}Y nw d |v rJ|d rFtj}ntj}ntj}|durU||d< d |vr]d |d < d |vrkd |v rk|d |d < | |� dS )a" Publish an old-style (L{twisted.python.log}) event to a new-style (L{twisted.logger}) observer. @note: It's possible that a new-style event was sent to a L{LegacyLogObserverWrapper}, and may now be getting sent back to a new-style observer. In this case, it's already a new-style event, adapted to also look like an old-style event, and we don't need to tweak it again to be a new-style event, hence this checks for already-defined new-style keys. @param observer: A new-style observer to handle this event. @param eventDict: An L{old-style <twisted.python.log>}, log event. @param textFromEventDict: callable that can format an old-style event as a string. Passed here rather than imported to avoid circular dependency. r r r! N�log_textz {log_text}r' �logLevelr% � log_namespacer" r r )r �KeyErrorr r- �info)r4 r5 r6 �text�levelr r r �publishToNewObserver] s4 � r> )r2 �typingr r r r r �zope.interfacer �_formatr � _interfacesr r �_levelsr �_stdlibr r �twisted.python.logr r r3 r> r r r r �<module> s( F� ��� __pycache__/_file.cpython-310.pyc 0000644 00000005270 15027667615 0012556 0 ustar 00 o �b! � @ s� d Z ddlmZmZmZmZ ddlmZ ddlm Z ddl m Z m Z m Z ddlmZmZ ee�G dd � d ��Ze fd ee d ee d efd d�ZdS )z File log observer. � )�IO�Any�Callable�Optional)� implementer)�ioType� )�formatEventAsClassicLogText� formatTime�timeFormatRFC3339)� ILogObserver�LogEventc @ sJ e Zd ZdZdee deegee f ddfdd�Z deddfd d �Z dS ) �FileLogObserverz9 Log observer that writes to a file-like object. �outFile� formatEvent�returnNc C s* t |�tur d| _nd| _|| _|| _dS )z� @param outFile: A file-like object. Ideally one should be passed which accepts text data. Otherwise, UTF-8 L{bytes} will be used. @param formatEvent: A callable that formats an event. zutf-8N)r �str� _encoding�_outFiler )�selfr r � r �6/usr/lib/python3/dist-packages/twisted/logger/_file.py�__init__ s zFileLogObserver.__init__�eventc C sL | � |�}|r$| jdu r| j�|� n | j�|�| j�� | j�� dS dS )zG Write event to file. @param event: An event. N)r r r �write�encode�flush)r r �textr r r �__call__( s �zFileLogObserver.__call__) �__name__� __module__� __qualname__�__doc__r r r r r r r r r r r r r s �� �r r � timeFormatr c s$ dt dtt f� fdd� }t| |�S )a� Create a L{FileLogObserver} that emits text to a specified (writable) file-like object. @param outFile: A file-like object. Ideally one should be passed which accepts text data. Otherwise, UTF-8 L{bytes} will be used. @param timeFormat: The format to use when adding timestamp prefixes to logged events. If L{None}, or for events with no C{"log_timestamp"} key, the default timestamp prefix of C{"-"} is used. @return: A file log observer. r r c s t | � fdd�d�S )Nc s t | � �S )N�r )�e�r# r r �<lambda>J s z:textFileLogObserver.<locals>.formatEvent.<locals>.<lambda>r$ )r )r r& r r r H s �z(textFileLogObserver.<locals>.formatEvent)r r r r )r r# r r r& r �textFileLogObserver8 s r( N)r" �typingr r r r �zope.interfacer �twisted.python.compatr �_formatr r r � _interfacesr r r r r( r r r r �<module> s &���� __pycache__/_capture.cpython-310.pyc 0000644 00000001323 15027667615 0013275 0 ustar 00 o �bp � @ sb d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl m Z m Z edeee fdd ��Z d S ) z% Context manager for capturing logs. � )�contextmanager)�Iterator�List�Sequence�cast)�globalLogPublisher� )� ILogObserver�LogEvent�returnc c s0 � g } t t| j�}t�|� | V t�|� d S )N)r r �appendr � addObserver�removeObserver)�events�observer� r �9/usr/lib/python3/dist-packages/twisted/logger/_capture.py� capturedLogs s � r N)�__doc__� contextlibr �typingr r r r �twisted.loggerr � _interfacesr r r r r r r �<module> s __pycache__/__init__.cpython-310.pyc 0000644 00000005314 15027667615 0013236 0 ustar 00 o �b) � @ s d Z g d�ZddlmZmZ ddlmZ ddlmZm Z m Z m Z m Z ddl mZmZ ddlmZmZ ddlmZ dd lmZ dd lmZmZ dd lmZm Z m Z m Z dd l m Z dd l!m"Z" ddl#m$Z$ ddl%m&Z&m'Z'm(Z( ddl)m*Z*m+Z+m,Z,m-Z- ddl.m/Z/ dS )a Twisted Logger: Classes and functions to do granular logging. Example usage in a module C{some.module}:: from twisted.logger import Logger log = Logger() def handleData(data): log.debug("Got data: {data!r}.", data=data) Or in a class:: from twisted.logger import Logger class Foo: log = Logger() def oops(self, data): self.log.error("Oops! Invalid data from server: {data!r}", data=data) C{Logger}s have namespaces, for which logging can be configured independently. Namespaces may be specified by passing in a C{namespace} argument to L{Logger} when instantiating it, but if none is given, the logger will derive its own namespace by using the module name of the callable that instantiated it, or, in the case of a class, by using the fully qualified name of the class. In the first example above, the namespace would be C{some.module}, and in the second example, it would be C{some.module.Foo}. @var globalLogPublisher: The L{LogPublisher} that all L{Logger} instances that are not otherwise parameterized will publish events to by default. @var globalLogBeginner: The L{LogBeginner} used to activate the main log observer, whether it's a log file, or an observer pointing at stderr. ) �InvalidLogLevelError�LogLevel� formatEvent�formatEventAsClassicLogText� formatTime�timeFormatRFC3339� eventAsText� extractField� ILogObserver�LogEvent�Logger� _loggerFor� LogPublisher�LimitedHistoryLogObserver�FileLogObserver�textFileLogObserver�PredicateResult�ILogFilterPredicate�FilteringLogObserver�LogLevelFilterPredicate�STDLibLogObserver� LoggingFile�LegacyLogObserverWrapper�globalLogPublisher�globalLogBeginner� LogBeginner� eventAsJSON� eventFromJSON�jsonFileLogObserver�eventsFromJSONLogFile� capturedLogs� )r r )r )r r r r r )r r )r r )r )r )r r )r r r r )r )r )r )r r r )r r r r )r N)0�__doc__�__all__�_levelsr r �_flattenr �_formatr r r r r � _interfacesr r �_loggerr r � _observerr �_bufferr �_filer r �_filterr r r r �_stdlibr �_ior �_legacyr �_globalr r r �_jsonr r r r �_capturer � r2 r2 �9/usr/lib/python3/dist-packages/twisted/logger/__init__.py�<module> s" %1 __pycache__/_filter.cpython-310.pyc 0000644 00000015477 15027667615 0013136 0 ustar 00 o �b� � @ s� d Z ddlmZ ddlmZmZ ddlmZmZ ddl m Z m Z ddl m Z mZ ddlmZmZ dd lmZ G d d � d e �ZG d d � d e�Zdee dedefdd�Zee �G dd� d��Zee�G dd� d��ZdS )z Filtering log observer. � )�partial)�Dict�Iterable)� Interface� implementer)� NamedConstant�Names� )� ILogObserver�LogEvent)�InvalidLogLevelError�LogLevel)�bitbucketLogObserverc @ s" e Zd ZdZe� Ze� Ze� ZdS )�PredicateResulta� Predicate results. @see: L{LogLevelFilterPredicate} @cvar yes: Log the specified event. When this value is used, L{FilteringLogObserver} will always log the message, without evaluating other predicates. @cvar no: Do not log the specified event. When this value is used, L{FilteringLogObserver} will I{not} log the message, without evaluating other predicates. @cvar maybe: Do not have an opinion on the event. When this value is used, L{FilteringLogObserver} will consider subsequent predicate results; if returned by the last predicate being considered, then the event will be logged. N)�__name__� __module__� __qualname__�__doc__r �yes�no�maybe� r r �8/usr/lib/python3/dist-packages/twisted/logger/_filter.pyr s r c @ s" e Zd ZdZdedefdd�ZdS )�ILogFilterPredicatezH A predicate that determined whether an event should be logged. �event�returnc C s dS )zg Determine whether an event should be logged. @returns: a L{PredicateResult}. Nr )r r r r �__call__3 s z ILogFilterPredicate.__call__N)r r r r r r r r r r r r . s r � predicatesr r c C sN | D ]"}||�}|t jkr dS |t jkr dS |t jkr qtd|����dS )ax Determine whether an event should be logged, based on the result of C{predicates}. By default, the result is C{True}; so if there are no predicates, everything will be logged. If any predicate returns C{yes}, then we will immediately return C{True}. If any predicate returns C{no}, then we will immediately return C{False}. As predicates return C{maybe}, we keep calling the next predicate until we run out, at which point we return C{True}. @param predicates: The predicates to use. @param event: An event @return: True if the message should be forwarded on, C{False} if not. TFzInvalid predicate result: )r r r r � TypeError)r r � predicate�resultr r r �shouldLogEvent; s r! c @ sD e Zd ZdZefdedee deddfdd�Zd e ddfd d �Z dS ) �FilteringLogObserverz� L{ILogObserver} that wraps another L{ILogObserver}, but filters out events based on applying a series of L{ILogFilterPredicate}s. �observerr �negativeObserverr Nc C s || _ ttt|��| _|| _dS )a� @param observer: An observer to which this observer will forward events when C{predictates} yield a positive result. @param predicates: Predicates to apply to events before forwarding to the wrapped observer. @param negativeObserver: An observer to which this observer will forward events when C{predictates} yield a negative result. N)� _observerr r! �list�_shouldLogEvent�_negativeObserver)�selfr# r r$ r r r �__init__b s z FilteringLogObserver.__init__r c C sB | � |�rd|v r|d �| | jf� | �|� dS | �|� dS )zB Forward to next observer if predicate allows it. � log_traceN)r' �appendr% r( )r) r r r r r t s z FilteringLogObserver.__call__) r r r r r r r r r* r r r r r r r" [ s ���� �r" c @ sl e Zd ZdZejfdeddfdd�Zdedefdd �Z ded eddfd d �Z dd d�Z de defdd�Z dS )�LogLevelFilterPredicatez� L{ILogFilterPredicate} that filters out events with a log level lower than the log level for the event's namespace. Events that not not have a log level or namespace are also dropped. �defaultLogLevelr Nc C s i | _ || _| �� dS )zH @param defaultLogLevel: The default minimum log level. N)�_logLevelsByNamespacer. �clearLogLevels)r) r. r r r r* � s z LogLevelFilterPredicate.__init__� namespacec C s� |s| j d S || j v r| j | S |�d�}t|�d }|dkr;d�|d|� �}|| j v r3| j | S |d8 }|dks | j d S )a� Determine an appropriate log level for the given namespace. This respects dots in namespaces; for example, if you have previously invoked C{setLogLevelForNamespace("mypackage", LogLevel.debug)}, then C{logLevelForNamespace("mypackage.subpackage")} will return C{LogLevel.debug}. @param namespace: A logging namespace. Use C{""} for the default namespace. @return: The log level for the specified namespace. � �.r r N)r/ �split�len�join)r) r1 �segments�indexr r r �logLevelForNamespace� s � z,LogLevelFilterPredicate.logLevelForNamespace�levelc C s4 |t �� vr t|��|r|| j|< dS || jd< dS )z� Sets the log level for a logging namespace. @param namespace: A logging namespace. @param level: The log level for the given namespace. r2 N)r � iterconstantsr r/ )r) r1 r: r r r �setLogLevelForNamespace� s z/LogLevelFilterPredicate.setLogLevelForNamespacec C s | j �� | j| j d< dS )z7 Clears all log levels to the default. r2 N)r/ �clearr. )r) r r r r0 � s z&LogLevelFilterPredicate.clearLogLevelsr c C sN |� dd �}|d u r tjS |� dd�}|stjS | �|�}||k r$tjS tjS )N� log_level� log_namespacer2 )�getr r r9 r )r) r � eventLevelr1 �namespaceLevelr r r r � s z LogLevelFilterPredicate.__call__)r N)r r r r r �infor r* �strr9 r< r0 r r r r r r r- � s r- N)r � functoolsr �typingr r �zope.interfacer r � constantlyr r � _interfacesr r �_levelsr r r% r r r �boolr! r" r- r r r r �<module> s $ __pycache__/_levels.cpython-310.pyc 0000644 00000006424 15027667615 0013133 0 ustar 00 o �b� � @ s8 d Z ddlmZmZ G dd� de�ZG dd� de�ZdS )z Log levels. � )� NamedConstant�Namesc s* e Zd ZdZdeddf� fdd� Z� ZS )�InvalidLogLevelErrorzS Someone tried to use a L{LogLevel} that is unknown to the logging system. �level�returnNc s t � �t|�� || _dS )z= @param level: A log level from L{LogLevel}. N)�super�__init__�strr )�selfr �� __class__� �8/usr/lib/python3/dist-packages/twisted/logger/_levels.pyr s z InvalidLogLevelError.__init__)�__name__� __module__� __qualname__�__doc__r r � __classcell__r r r r r s r c @ sD e Zd ZdZe� Ze� Ze� Ze� Ze� Z e de defdd��Z dS )�LogLevela� Constants describing log levels. @cvar debug: Debugging events: Information of use to a developer of the software, not generally of interest to someone running the software unless they are attempting to diagnose a software issue. @cvar info: Informational events: Routine information about the status of an application, such as incoming connections, startup of a subsystem, etc. @cvar warn: Warning events: Events that may require greater attention than informational events but are not a systemic failure condition, such as authorization failures, bad data from a network client, etc. Such events are of potential interest to system administrators, and should ideally be phrased in such a way, or documented, so as to indicate an action that an administrator might take to mitigate the warning. @cvar error: Error conditions: Events indicating a systemic failure, such as programming errors in the form of unhandled exceptions, loss of connectivity to an external system without which no useful work can proceed, such as a database or API endpoint, or resource exhaustion. Similarly to warnings, errors that are related to operational parameters may be actionable to system administrators and should provide references to resources which an administrator might use to resolve them. @cvar critical: Critical failures: Errors indicating systemic failure (ie. service outage), data corruption, imminent data loss, etc. which must be handled immediately. This includes errors unanticipated by the software, such as unhandled exceptions, wherein the cause and consequences are unknown. �namer c C s$ z| � |�W S ty t|��w )a Get the log level with the given name. @param name: The name of a log level. @return: The L{LogLevel} with the specified C{name}. @raise InvalidLogLevelError: if the C{name} does not name a valid log level. )� lookupByName� ValueErrorr )�clsr r r r � levelWithNameB s �zLogLevel.levelWithNameN) r r r r r �debug�info�warn�error�critical� classmethodr r r r r r r s "r N)r � constantlyr r � Exceptionr r r r r r �<module> s __pycache__/_stdlib.cpython-310.pyc 0000644 00000011574 15027667615 0013124 0 ustar 00 o �b� � @ s� U d Z ddlZddlmZmZ ddlmZ ddlm Z ddl m Z ddl m Z dd lmZmZ dd lmZ ejejejejejejejejejej iZ ee e f e d < d ee e f fd d�Z e � Z!ee�G dd� d��Z"G dd� d�Z#dS )z3 Integration with Python standard library logging. � N)�Mapping�Tuple)� implementer)� NamedConstant)� currentframe� )� formatEvent)� ILogObserver�LogEvent)�LogLevel�toStdlibLogLevelMapping�returnc C s0 i } t �� D ]\}}|| |< || t�|�< q| S )z� Reverse the above mapping, adding both the numerical keys used above and the corresponding string keys also used by python logging. @return: the reversed mapping )r �items� stdlibLogging� getLevelName)�mapping�logLevel� pyLogLevel� r �8/usr/lib/python3/dist-packages/twisted/logger/_stdlib.py�_reverseLogLevelMapping s r c @ sh e Zd ZdZdZdefdededdfdd �Z dd ed ede eeedf fdd�Z de ddfdd�Z dS )�STDLibLogObserverae Log observer that writes to the python standard library's C{logging} module. @note: Warning: specific logging configurations (example: network) can lead to this observer blocking. Nothing is done here to prevent that, so be sure to not to configure the standard library logging module to block when used in conjunction with this module: code within Twisted, such as twisted.web, assumes that logging does not block. @cvar defaultStackDepth: This is the default number of frames that it takes to get from L{STDLibLogObserver} through the logging module, plus one; in other words, the number of frames if you were to call a L{STDLibLogObserver} directly. This is useful to use as an offset for the C{stackDepth} parameter to C{__init__}, to add frames for other publishers. � �twisted�name� stackDepthr Nc C s t �|�| _| j| j_|| _dS )z� @param name: logger identifier. @param stackDepth: The depth of the stack to investigate for caller metadata. N)r � getLogger�logger� _findCaller� findCallerr )�selfr r r r r �__init__E s zSTDLibLogObserver.__init__Fr � stackInfo� stackLevelc C s( t | j�}|j}d}|j|j|jf| S )a Based on the stack depth passed to this L{STDLibLogObserver}, identify the calling function. @param stackInfo: Whether or not to construct stack information. (Currently ignored.) @param stackLevel: The number of stack frames to skip when determining the caller (currently ignored; use stackDepth on the instance). @return: Depending on Python version, either a 3-tuple of (filename, lineno, name) or a 4-tuple of that plus stack information. �N)r r �f_code� co_filename�f_lineno�co_name)r r" r# �f�co�extrar r r r Q s z STDLibLogObserver._findCaller�eventc C s` |� dtj�}|� d�}|du rd}n |j|j|�� f}t� |tj�}| j j |t |�|d� dS )zB Format an event and bridge it to Python logging. � log_level� log_failureN)�exc_info) �getr �info�type�value�getTracebackObjectr r �INFOr �log�StringifiableFromEvent)r r, �level�failure�excInfo� stdlibLevelr r r �__call__e s zSTDLibLogObserver.__call__)Fr ) �__name__� __module__� __qualname__�__doc__�defaultStackDepth�str�intr! �boolr r r r< r r r r r / s( ��� � ��� �r c @ s> e Zd ZdZdeddfdd�Zdefdd�Zdefd d �Z dS ) r7 z� An object that implements C{__str__()} in order to defer the work of formatting until it's converted into a C{str}. r, r Nc C s || _ dS )z) @param event: An event. N)r, )r r, r r r r! y s z StringifiableFromEvent.__init__c C s t | j�S r$ )r r, �r r r r �__str__ s z StringifiableFromEvent.__str__c C s t | ��d�S )Nzutf-8)rB �encoderE r r r � __bytes__� s z StringifiableFromEvent.__bytes__) r= r> r? r@ r r! rB rF �bytesrH r r r r r7 s s r7 )$r@ �loggingr �typingr r �zope.interfacer � constantlyr �twisted.python.compatr �_formatr � _interfacesr r �_levelsr �debug�DEBUGr1 r5 �warn�WARNING�error�ERROR�critical�CRITICALr rC �__annotations__r �fromStdlibLogLevelMappingr r7 r r r r �<module> s( � C __pycache__/_buffer.cpython-310.pyc 0000644 00000003665 15027667615 0013116 0 ustar 00 o �b� � @ sZ d Z ddlmZ ddlmZmZ ddlmZ ddlm Z m Z dZ ee �G dd � d ��Z d S ) z' Log observer that maintains a buffer. � )�deque)�Deque�Optional)� implementer� )� ILogObserver�LogEventi c @ sN e Zd ZdZefdee ddfdd�Zdeddfdd �Z d e ddfd d �Z dS ) �LimitedHistoryLogObservera� L{ILogObserver} that stores events in a buffer of a fixed size:: >>> from twisted.logger import LimitedHistoryLogObserver >>> history = LimitedHistoryLogObserver(5) >>> for n in range(10): history({'n': n}) ... >>> repeats = [] >>> history.replayTo(repeats.append) >>> len(repeats) 5 >>> repeats [{'n': 5}, {'n': 6}, {'n': 7}, {'n': 8}, {'n': 9}] >>> �size�returnNc C s t |d�| _dS )zx @param size: The maximum number of events to buffer. If L{None}, the buffer is unbounded. )�maxlenN)r �_buffer)�selfr � r �8/usr/lib/python3/dist-packages/twisted/logger/_buffer.py�__init__% s z"LimitedHistoryLogObserver.__init__�eventc C s | j �|� d S )N)r �append)r r r r r �__call__, s z"LimitedHistoryLogObserver.__call__� otherObserverc C s | j D ]}||� qdS )z� Re-play the buffered events to another log observer. @param otherObserver: An observer to replay events to. N)r )r r r r r r �replayTo/ s �z"LimitedHistoryLogObserver.replayTo) �__name__� __module__� __qualname__�__doc__�_DEFAULT_BUFFER_MAXIMUMr �intr r r r r r r r r r s r N) r � collectionsr �typingr r �zope.interfacer � _interfacesr r r r r r r r �<module> s __pycache__/_format.cpython-310.pyc 0000644 00000026455 15027667615 0013137 0 ustar 00 o �bb. � @ s� d Z ddlmZ ddlmZ ddlmZmZm Z mZm Z m Z m Z ddl mZ ddlmZ ddlmZ ddlmZ d d lmZmZ d d lmZ d Zd edefdd�Z d ede defdd�Z edfde e de e dedefdd�Z e fd edee e gef de e fdd�Z!G d d � d e�Z"d ed eeef defd d!�Z#d edefd"d#�Z$d$edefd%d&�Z%d edefd'd(�Z&d)d)d)e fd ed*e'd+e'd,e'dee gef def d-d.�Z(d/S )0z& Tools for formatting logging events. � )�Mapping)�datetime)�Any�Callable�Iteratorr �Optional�Union�cast)� NamedConstant)�FixedOffsetTimeZone)�Failure)� safe_repr� )� aFormatter� flatFormat)�LogEventz%Y-%m-%dT%H:%M:%S%z�event�returnc C s t | dddd�S )aa Formats an event as text, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. F)�includeTraceback�includeTimestamp� includeSystem)� eventAsText)r � r �8/usr/lib/python3/dist-packages/twisted/logger/_format.py� formatEvent s �r �errorc C sV zdj | |d�W S ty* t� }d�dd� | �� D ��}dj t|�||d� Y S w )z� Formats an event as text that describes the event generically and a formatting error. @param event: A logging event. @param error: The formatting error. @return: A formatted string. z)Unable to format event {event!r}: {error})r r z, c s s* � | ]\}}d � t|�t|�f�V qdS )z = N)�joinr )�.0�key�valuer r r � <genexpr>B s � � �z+formatUnformattableEvent.<locals>.<genexpr>zrMESSAGE LOST: unformattable object logged: {error} Recoverable data: {text} Exception during formatting: {failure})r �failure�text)�format� BaseExceptionr r �itemsr )r r r! r" r r r �formatUnformattableEvent, s � � ���r& �-�when� timeFormat�defaultc C s8 |du s| du r |S t �| �}t�| |�}t|�|��S )a� Format a timestamp as text. Example:: >>> from time import time >>> from twisted.logger import formatTime >>> >>> t = time() >>> formatTime(t) u'2013-10-22T14:19:11-0700' >>> formatTime(t, timeFormat="%Y/%W") # Year and week number u'2013/42' >>> @param when: A timestamp. @param timeFormat: A time format. @param default: Text to return if C{when} or C{timeFormat} is L{None}. @return: A formatted time. N)r �fromLocalTimeStamp�DateTime� fromtimestamp�str�strftime)r( r) r* �tzr r r r � formatTimeP s r1 c C s( t | |d�}|s dS |�dd�}|d S )a& Format an event as a line of human-readable text for, e.g. traditional log file output. The output format is C{"{timeStamp} [{system}] {event}\n"}, where: - C{timeStamp} is computed by calling the given C{formatTime} callable on the event's C{"log_time"} value - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. Example:: >>> from time import time >>> from twisted.logger import formatEventAsClassicLogText >>> from twisted.logger import LogLevel >>> >>> formatEventAsClassicLogText(dict()) # No format, returns None >>> formatEventAsClassicLogText(dict(log_format="Hello!")) u'- [-#-] Hello!\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_namespace="my_namespace", ... log_level=LogLevel.info, ... )) u'2013-10-22T17:30:02-0700 [my_namespace#info] Hello!\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_system="my_system", ... )) u'2013-11-11T17:22:06-0800 [my_system] Hello!\n' >>> @param event: an event. @param formatTime: A time formatter @return: A formatted event, or L{None} if no output is appropriate. )r1 N� z )r �replace)r r1 � eventTextr r r �formatEventAsClassicLogTextr s / r5 c @ sX e Zd ZdZdeeef ddfdd�Zdefdd�Z de fd d �Z d edefd d �Z dS )� CallMappingz� Read-only mapping that turns a C{()}-suffix in key names into an invocation of the key rather than a lookup of the key. Implementation support for L{formatWithCall}. � submappingr Nc C s || _ dS )zo @param submapping: Another read-only mapping which will be used to look up items. N)� _submapping)�selfr7 r r r �__init__� s zCallMapping.__init__c C � t | j�S �N)�iterr8 �r9 r r r �__iter__� � zCallMapping.__iter__c C r; r< )�lenr8 r> r r r �__len__� r@ zCallMapping.__len__r c C s6 |� d�}|r |dd� n|}| j| }|r|� }|S )z| Look up an item in the submapping for this L{CallMapping}, calling it if C{key} ends with C{"()"}. z()N���)�endswithr8 )r9 r �callit�realKeyr r r r � __getitem__� s zCallMapping.__getitem__) �__name__� __module__� __qualname__�__doc__r r. r r: r r? �intrB rG r r r r r6 � s r6 � formatString�mappingc C s t t�| dt|���S )a� Format a string like L{str.format}, but: - taking only a name mapping; no positional arguments - with the additional syntax that an empty set of parentheses correspond to a formatting item that should be called, and its result C{str}'d, rather than calling C{str} on the element directly as normal. For example:: >>> formatWithCall("{string}, {function()}.", ... dict(string="just a string", ... function=lambda: "a function")) 'just a string, a function.' @param formatString: A PEP-3101 format string. @param mapping: A L{dict}-like object to format. @return: The string with formatted values interpolated. r )r. r �vformatr6 )rM rN r r r �formatWithCall� s rP c C s� z=d| v r t | �W S tttttf | �dd��}|du r W dS t|t�r&nt|t�r1|�d�}nt d|����t || �W S t yT } z t | |�W Y d}~S d}~ww )ae Formats an event as a string, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. � log_flattened� log_formatN� zutf-8z Log format must be str, not ) r r r r r. �bytes�get� isinstance�decode� TypeErrorrP r$ r& )r r# �er r r � _formatEvent� s ��rZ r! c C sB z| � � }W |S ty } z dt|� }W Y d}~|S d}~ww )a^ Format a failure traceback, assuming UTF-8 and using a replacement strategy for errors. Every effort is made to provide a usable traceback, but should not that not be possible, a message and the captured exception are logged. @param failure: The failure to retrieve a traceback from. @return: The formatted traceback. z((UNABLE TO OBTAIN TRACEBACK FROM EVENT):N)� getTracebackr$ r. )r! � tracebackrY r r r �_formatTraceback s ���r] c C s� t tt | �dd��}|du r4t tt | �dd��}|du r!d}n|j}djt t| �dd��|d�}|S zt|�}W |S tyG d}Y |S w ) a� Format the system specified in the event in the "log_system" key if set, otherwise the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. If formatting fails completely, "UNFORMATTABLE" is returned. @param event: The event containing the system specification. @return: A formatted string representing the "log_system" key. � log_systemN� log_levelr' z{namespace}#{level}� log_namespace)� namespace�level� UNFORMATTABLE)r r r. rU r �namer# � Exception)r �systemrb � levelNamer r r � _formatSystem s$ � � ��rh Tr r r c C s� t | �}|rd| v r| d }t|�}d�||f�}|s |S d}|r1d�|tt| �dd���dg�}d} |r@d�dt| �ddg�} d j|| |d �S ) ah Format an event as text. Optionally, attach timestamp, traceback, and system information. The full output format is: C{"{timeStamp} [{system}] {event}\n{traceback}\n"} where: - C{timeStamp} is the event's C{"log_time"} value formatted with the provided C{formatTime} callable. - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. - C{traceback} is the traceback if the event contains a C{"log_failure"} key. In the event the original traceback cannot be formatted, a message indicating the failure will be substituted. If the event cannot be formatted, and no traceback exists, an empty string is returned, even if includeSystem or includeTimestamp are true. @param event: A logging event. @param includeTraceback: If true and a C{"log_failure"} key exists, append a traceback. @param includeTimestamp: If true include a formatted timestamp before the event. @param includeSystem: If true, include the event's C{"log_system"} value. @param formatTime: A time formatter @return: A formatted string with specified options. @since: Twisted 18.9.0 � log_failurer2 rS �log_timeN� �[�]z {timeStamp}{system}{eventText})� timeStamprf r4 )rZ r] r r �floatrU rh r# ) r r r r r1 r4 �fr\ rn rf r r r r 7 s$ * �r N))rK �collections.abcr � MappingABCr r, �typingr r r r r r � constantlyr �twisted.python._tzhelperr �twisted.python.failurer �twisted.python.reflectr �_flattenr r � _interfacesr �timeFormatRFC3339r. r r$ r& ro r1 r5 r6 rP rZ r] rh �boolr r r r r �<module> sl $ &���� �#��� �6 ""!����� �� __pycache__/_json.cpython-310.pyc 0000644 00000020144 15027667615 0012605 0 ustar 00 o �b� � @ s� d Z ddlmZmZ ddlmZmZmZmZm Z m Z m Z m Z ddl mZ ddlmZ ddlmZ ddlmZ dd lmZ dd lmZ dd lmZ dd lm Z e � Z ee ef Z d ede fdd�Z de defdd�Z!dd� ed�dd� dd� fdd� ed�e e!fgZ"dd � e"D �Z#d e de$fd d �Z%d e$de fd!d"�Z&d#ede fd$d%�Z'd&e de fd'd(�Z( )d4d*ee d+e defd,d-�Z) . /d5d0ee d+e e d1e*de e fd2d3�Z+d.S )6zA Tools for saving and loading log events in a structured format. � )�dumps�loads)�IO�Any�AnyStr�Dict�Iterable�Optional�Union�cast)�UUID)� NamedConstant)�Failure� ��FileLogObserver)� flattenEvent)�LogEvent)�LogLevel)�Logger�failure�returnc C s t | �� t | jj| jjd�d�S )z� Convert a failure to a JSON-serializable data structure. @param failure: A failure to serialize. @return: a mapping of strings to ... stuff, mostly reminiscent of L{Failure.__getstate__} )� __module__�__name__)�type)�dict� __getstate__r r r )r � r �6/usr/lib/python3/dist-packages/twisted/logger/_json.py� failureAsJSON s ��r � failureDictc C s0 t �t �}| d }t|d d|�| d< | |_|S )z� Load a L{Failure} from a dictionary deserialized from JSON. @param failureDict: a JSON-deserialized object like one previously returned by L{failureAsJSON}. @return: L{Failure} r r r )r �__new__r �__dict__)r �f�typeInfor r r �failureFromJSON. s r% c C s t | t�o tt| jd �| u S �N)� isinstancer �getattrr �name��levelr r r �<lambda>@ s r, z$02E59486-F24D-46AD-8224-3ACDF2A5732Ac C s t | jd�S )N)r) )r r) r* r r r r, E s c C s t t| d d �S )Nr) )r( r r* r r r r, F s c C s t | t�S r& )r' r )�or r r r, I s z$E76887E2-20ED-49BF-A8F8-BA25CC586F2Dc C s i | ] \}}}}||�qS r r )�.0� predicate�uuid�saver�loaderr r r � <dictcomp>Q s r3 �aDictc C s d| v rt t| d � | �S | S )a# Dictionary-to-object-translation hook for certain value types used within the logging system. @see: the C{object_hook} parameter to L{json.load} @param aDict: A dictionary loaded from a JSON object. @return: C{aDict} itself, or the object represented by C{aDict} �__class_uuid__)� uuidToLoaderr )r4 r r r �objectLoadHookT s r7 � pythonObjectc C s> t D ]\}}}}|| �r|| �}t|�|d< | S qddiS )a� Object-to-serializable hook for certain value types used within the logging system. @see: the C{default} parameter to L{json.dump} @param pythonObject: Any object. @return: If the object is one of the special types the logging system supports, a specially-formatted dictionary; otherwise, a marker dictionary indicating that it could not be serialized. r5 � unpersistableT)� classInfo�str)r8 r/ r0 r1 r2 �resultr r r �objectSaveHookd s �r= �eventc C s0 dt dtttf fdd�}t| � t| |dd�S )a� Encode an event as JSON, flattening it if necessary to preserve as much structure as possible. Not all structure from the log event will be preserved when it is serialized. @param event: A log event dictionary. @return: A string of the serialized JSON; note that this will contain no newline characters, and may thus safely be stored in a line-delimited file. � unencodabler c S s t | t�r | �d�S t| �S )z� Serialize an object not otherwise serializable by L{dumps}. @param unencodable: An unencodable object. @return: C{unencodable}, serialized �charmap)r' �bytes�decoder= )r? r r r �default� s z eventAsJSON.<locals>.defaultT)rC �skipkeys)�objectr �JSONDictr; r r )r> rC r r r � eventAsJSONy s rG � eventTextc C s t tt| td��S )z� Decode a log event from JSON. @param eventText: The output of a previous call to L{eventAsJSON} @return: A reconstructed version of the log event. )� object_hook)r rF r r7 )rH r r r � eventFromJSON� s rJ � �outFile�recordSeparatorc s t | � fdd��S )a� Create a L{FileLogObserver} that emits JSON-serialized events to a specified (writable) file-like object. Events are written in the following form:: RS + JSON + NL C{JSON} is the serialized event, which is JSON text. C{NL} is a newline (C{"\n"}). C{RS} is a record separator. By default, this is a single RS character (C{"\x1e"}), which makes the default output conform to the IETF draft document "draft-ietf-json-text-sequence-13". @param outFile: A file-like object. Ideally one should be passed which accepts L{str} data. Otherwise, UTF-8 L{bytes} will be used. @param recordSeparator: The record separator to use. @return: A file log observer. c s � � t | �� d�S )N� )rG )r> �rM r r r, � s z%jsonFileLogObserver.<locals>.<lambda>r )rL rM r rO r �jsonFileLogObserver� s �rP N� �inFile� bufferSizec # s � dt dtfdd�}dtdtt fdd�� |du r*|| �d ��}|d kr'|}n d }n||�}d }|d kr9d }� }n dtdtt f� fd d� }t|�} | �|�}|set|�dkrc||�} | durc| V dS |||�7 }|�|�} | dd� D ]} t| �dkr�|| �} | dur�| V qv| d }qK)aM Load events from a file previously saved with L{jsonFileLogObserver}. Event records that are truncated or otherwise unreadable are ignored. @param inFile: A (readable) file-like object. Data read from C{inFile} should be L{str} or UTF-8 L{bytes}. @param recordSeparator: The expected record separator. If L{None}, attempt to automatically detect the record separator from one of C{"\x1e"} or C{""}. @param bufferSize: The size of the read buffer used while reading from C{inFile}. @return: Log events as read from C{inFile}. �sr c S s t | t�r| S | �d�S )N�utf-8)r' rA �encode)rT r r r �asBytes� s z&eventsFromJSONLogFile.<locals>.asBytes�recordc S sl z t | ��d�}W n ty tjdt | �d� Y d S w zt|�W S ty5 tjdt | �d� Y d S w )NrU z2Unable to decode UTF-8 for JSON record: {record!r}�rX z&Unable to read JSON record: {record!r})rA rB �UnicodeDecodeError�log�errorrJ � ValueError)rX �textr r r �eventFromBytearray� s �� �z1eventsFromJSONLogFile.<locals>.eventFromBytearrayNr � � � c s. | d t d�kr � | �S tjdt| �d� d S )N���rN z0Unable to read truncated JSON record: {record!r}rY )�ordr[ r\ rA rY �r_ r r �eventFromRecord� s �z.eventsFromJSONLogFile.<locals>.eventFromRecordTr rc )r rA � bytearrayr r �read�len�split) rR rM rS rW �first�recordSeparatorBytesrf �buffer�newDatar> �recordsrX r re r �eventsFromJSONLogFile� sB � ��rp )rK )NrQ ),�__doc__�jsonr r �typingr r r r r r r r r0 r � constantlyr �twisted.python.failurer �_filer �_flattenr � _interfacesr �_levelsr �_loggerr r[ r; rF r r% r: r6 rE r7 r= rG rJ rP �intrp r r r r �<module> sd ( � �� ��� � ����� __pycache__/_util.cpython-310.pyc 0000644 00000002447 15027667615 0012617 0 ustar 00 o �bx � @ s> d Z ddlmZ ddlmZ ddlmZ dedefdd �Zd S ) z Logging utilities. � )�List� )�LogTrace)�Logger�trace�returnc C s� dt dtfdd�}g }g }| D ]F\}}|r|d |urA||v r0|d |ur/|�� |d |us%n|s<|�||�� d�� |�|� |�dt|� � |�d||�� d�� qd �|�S ) ay Format a trace (that is, the contents of the C{log_trace} key of a log event) as a visual indication of the message's propagation through various observers. @param trace: the contents of the C{log_trace} key from an event. @return: A multi-line string with indentation and arrows indicating the flow of the message through various observers. �objr c S s" t | d�r| � d| j� d�S | � S )N�namez (�))�hasattrr )r � r �6/usr/lib/python3/dist-packages/twisted/logger/_util.py�formatWithName s z#formatTrace.<locals>.formatWithName���� z z-> � )�object�str�pop�append�len�join)r r �result�lineage�parent�childr r r � formatTrace s �� r N) �__doc__�typingr � _interfacesr �_loggerr r r r r r r �<module> s __pycache__/_logger.cpython-310.pyc 0000644 00000023360 15027667615 0013116 0 ustar 00 o �b�& � @ s| d Z ddlmZ ddlmZmZmZ ddlmZ ddlm Z ddl m Z m Z ddl mZmZ G d d � d �Ze� Zd d � Zd S )z Logger class. � )�time)�Any�Optional�cast)� currentframe)�Failure� )� ILogObserver�LogTrace)�InvalidLogLevelError�LogLevelc @ sR e Zd ZdZedefdd��Z d$dee dee ded ddfd d �Z d%d ed ee dd fdd�Z defdd�Z d%de dee deddfdd�Zde jfdedee de deddf dd�Zd%dee deddfdd�Zd%dee deddfd d �Zd%dee deddfd d �Zd%dee deddfd d!�Zd%dee deddfd"d#�ZdS )&�Loggera~ A L{Logger} emits log messages to an observer. You should instantiate it as a class or module attribute, as documented in L{this module's documentation <twisted.logger>}. @ivar namespace: the namespace for this logger @ivar source: The object which is emitting events via this logger @ivar observer: The observer that this logger will send events to. �returnc C s, z t ttd�jd �W S ty Y dS w )z� Derive a namespace from the module containing the caller's caller. @return: the fully qualified python name of a module. � �__name__z <unknown>)r �strr � f_globals�KeyError� r r �8/usr/lib/python3/dist-packages/twisted/logger/_logger.py� _namespaceFromCallingContext s �z#Logger._namespaceFromCallingContextN� namespace�source�observerr c C sD |du r| � � }|| _|| _|du r ddlm} || _dS || _dS )a3 @param namespace: The namespace for this logger. Uses a dotted notation, as used by python modules. If not L{None}, then the name of the module of the caller is used. @param source: The object which is emitting events via this logger; this is automatically set on instances of a class if this L{Logger} is an attribute of that class. @param observer: The observer that this logger will send events to. If L{None}, use the L{global log publisher <globalLogPublisher>}. Nr )�globalLogPublisher)r r r �_globalr r )�selfr r r r r r r �__init__) s zLogger.__init__�instance�ownerc C s> |dusJ �|du r |}n|}| j d�|j|jg�|| jd�S )a� When used as a descriptor, i.e.:: # File: athing.py class Something: log = Logger() def hello(self): self.log.info("Hello") a L{Logger}'s namespace will be set to the name of the class it is declared on. In the above example, the namespace would be C{athing.Something}. Additionally, its source will be set to the actual object referring to the L{Logger}. In the above example, C{Something.log.source} would be C{Something}, and C{Something().log.source} would be an instance of C{Something}. N�.)r )� __class__�join� __module__r r )r r r r r r r �__get__F s �zLogger.__get__c C s d| j j� d| j�d�S )N�<� �>)r! r r )r r r r �__repr__f s zLogger.__repr__�level�format�kwargsc K sz |t �� vr| jdtt|��|| d� dS |}|j| || j| j|t� d� d|v r6t t |d �� | | j f� | � |� dS )a Emit a log event to all log observers at the given level. @param level: a L{LogLevel} @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. z:Got invalid log level {invalidLevel!r} in {logger}.emit().)� invalidLevel�loggerN)� log_logger� log_level� log_namespace� log_source� log_format�log_time� log_trace) r � iterconstants�failurer r �updater r r r r �appendr )r r) r* r+ �eventr r r �emiti s( �� z Logger.emitr6 c K s* |du rt � }| j||fd|i|�� dS )a2 Log a failure and emit a traceback. For example:: try: frob(knob) except Exception: log.failure("While frobbing {knob}", knob=knob) or:: d = deferredFrob(knob) d.addErrback(lambda f: log.failure("While frobbing {knob}", f, knob=knob)) This method is generally meant to capture unexpected exceptions in code; an exception that is caught and handled somehow should be logged, if appropriate, via L{Logger.error} instead. If some unknown exception occurs and your code doesn't know how to handle it, as in the above example, then this method provides a means to describe the failure in nerd-speak. This is done at L{LogLevel.critical} by default, since no corrective guidance can be offered to an user/administrator, and the impact of the condition is unknown. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param failure: a L{Failure} to log. If L{None}, a L{Failure} is created from the exception in flight. @param level: a L{LogLevel} to use. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N� log_failure)r r: )r r* r6 r) r+ r r r r6 � s + zLogger.failurec K � | j tj|fi |�� dS )a� Emit a log event at log level L{LogLevel.debug}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)r: r �debug�r r* r+ r r r r= � � z Logger.debugc K r< )a� Emit a log event at log level L{LogLevel.info}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)r: r �infor> r r r r@ � r? z Logger.infoc K r< )a� Emit a log event at log level L{LogLevel.warn}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)r: r �warnr> r r r rA � r? z Logger.warnc K r< )a� Emit a log event at log level L{LogLevel.error}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)r: r �errorr> r r r rB � r? z Logger.errorc K r< )a� Emit a log event at log level L{LogLevel.critical}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)r: r �criticalr> r r r rC � r? zLogger.critical)NNN�N)r r# � __qualname__�__doc__� staticmethodr r r �objectr �typer$ r( r r: rC r r6 r= r@ rA rB r r r r r s\ ���� � ���� �*����� � 0 r c C s t �| | j�S rD )�_logr$ r! )�objr r r �<lambda> s rL N)rF r �typingr r r �twisted.python.compatr �twisted.python.failurer � _interfacesr r �_levelsr r r rJ � _loggerForr r r r �<module> s { __pycache__/_observer.cpython-310.pyc 0000644 00000006726 15027667615 0013475 0 ustar 00 o �b� � @ s� d Z ddlmZmZ ddlmZ ddlmZ ddlm Z m Z ddl m Z dZ ee �G d d � d ��Zee �d e d d fdd��Zd S )z Basic log observers. � )�Callable�Optional)� implementer)�Failure� )� ILogObserver�LogEvent)�LoggerzITemporarily disabling observer {observer} due to exception: {log_failure}c @ sj e Zd ZdZdeddfdd�Zdeddfdd �Zdeddfd d �Zd eddfd d�Z dede fdd�Z dS )� LogPublisherz� I{ILogObserver} that fans out events to other observers. Keeps track of a set of L{ILogObserver} objects and forwards events to each. � observers�returnNc G s t |�| _t| d�| _d S )N��observer)�list� _observersr �log)�selfr � r �:/usr/lib/python3/dist-packages/twisted/logger/_observer.py�__init__ s zLogPublisher.__init__r c C s4 t |�s td|����|| jvr| j�|� dS dS )zq Registers an observer with this publisher. @param observer: An L{ILogObserver} to add. zObserver is not callable: N)�callable� TypeErrorr �append�r r r r r � addObserver# s �zLogPublisher.addObserverc C s( z | j �|� W dS ty Y dS w )zv Unregisters an observer with this publisher. @param observer: An L{ILogObserver} to remove. N)r �remove� ValueErrorr r r r �removeObserver. s �zLogPublisher.removeObserver�eventc s� d� vrd}n dt ddf� �fdd� }g }�jD ]!}|dur"||� z|� � W q ty9 |�|t� f� Y qw |D ]\}}��|�}|jt||d� q<dS )z8 Forward events to contained observers. � log_traceNr r c s � d � �| f� dS )z� Add tracing information for an observer. @param observer: an observer being forwarded to r N)r r �r r r r �traceB s z$LogPublisher.__call__.<locals>.trace)�failurer )r r � Exceptionr r �_errorLoggerForObserverr" �OBSERVER_DISABLED)r r r! �brokenObserversr �brokenObserverr" � errorLoggerr r r �__call__9 s( � ��zLogPublisher.__call__c s" t � fdd�| jD �� }t|d�S )z� Create an error-logger based on this logger, which does not contain the given bad observer. @param observer: The observer which previously had an error. @return: A L{Logger} without the given observer. c 3 s � | ] }|� ur|V qd S )Nr )�.0�obsr r r � <genexpr>g s � z7LogPublisher._errorLoggerForObserver.<locals>.<genexpr>r )r r r )r r �errorPublisherr r r r$ ] s � z$LogPublisher._errorLoggerForObserver) �__name__� __module__� __qualname__�__doc__r r r r r r) r r$ r r r r r s $r r r Nc C s dS )zD I{ILogObserver} that does nothing with the events it sees. Nr )r r r r �bitbucketLogObserverl s r2 )r1 �typingr r �zope.interfacer �twisted.python.failurer � _interfacesr r �_loggerr r% r r2 r r r r �<module> s �U _filter.py 0000644 00000015357 15027667615 0006574 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_filter -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Filtering log observer. """ from functools import partial from typing import Dict, Iterable from zope.interface import Interface, implementer from constantly import NamedConstant, Names # type: ignore[import] from ._interfaces import ILogObserver, LogEvent from ._levels import InvalidLogLevelError, LogLevel from ._observer import bitbucketLogObserver class PredicateResult(Names): """ Predicate results. @see: L{LogLevelFilterPredicate} @cvar yes: Log the specified event. When this value is used, L{FilteringLogObserver} will always log the message, without evaluating other predicates. @cvar no: Do not log the specified event. When this value is used, L{FilteringLogObserver} will I{not} log the message, without evaluating other predicates. @cvar maybe: Do not have an opinion on the event. When this value is used, L{FilteringLogObserver} will consider subsequent predicate results; if returned by the last predicate being considered, then the event will be logged. """ yes = NamedConstant() no = NamedConstant() maybe = NamedConstant() class ILogFilterPredicate(Interface): """ A predicate that determined whether an event should be logged. """ def __call__(event: LogEvent) -> NamedConstant: """ Determine whether an event should be logged. @returns: a L{PredicateResult}. """ def shouldLogEvent(predicates: Iterable[ILogFilterPredicate], event: LogEvent) -> bool: """ Determine whether an event should be logged, based on the result of C{predicates}. By default, the result is C{True}; so if there are no predicates, everything will be logged. If any predicate returns C{yes}, then we will immediately return C{True}. If any predicate returns C{no}, then we will immediately return C{False}. As predicates return C{maybe}, we keep calling the next predicate until we run out, at which point we return C{True}. @param predicates: The predicates to use. @param event: An event @return: True if the message should be forwarded on, C{False} if not. """ for predicate in predicates: result = predicate(event) if result == PredicateResult.yes: return True if result == PredicateResult.no: return False if result == PredicateResult.maybe: continue raise TypeError(f"Invalid predicate result: {result!r}") return True @implementer(ILogObserver) class FilteringLogObserver: """ L{ILogObserver} that wraps another L{ILogObserver}, but filters out events based on applying a series of L{ILogFilterPredicate}s. """ def __init__( self, observer: ILogObserver, predicates: Iterable[ILogFilterPredicate], negativeObserver: ILogObserver = bitbucketLogObserver, ) -> None: """ @param observer: An observer to which this observer will forward events when C{predictates} yield a positive result. @param predicates: Predicates to apply to events before forwarding to the wrapped observer. @param negativeObserver: An observer to which this observer will forward events when C{predictates} yield a negative result. """ self._observer = observer self._shouldLogEvent = partial(shouldLogEvent, list(predicates)) self._negativeObserver = negativeObserver def __call__(self, event: LogEvent) -> None: """ Forward to next observer if predicate allows it. """ if self._shouldLogEvent(event): if "log_trace" in event: event["log_trace"].append((self, self._observer)) self._observer(event) else: self._negativeObserver(event) @implementer(ILogFilterPredicate) class LogLevelFilterPredicate: """ L{ILogFilterPredicate} that filters out events with a log level lower than the log level for the event's namespace. Events that not not have a log level or namespace are also dropped. """ def __init__(self, defaultLogLevel: NamedConstant = LogLevel.info) -> None: """ @param defaultLogLevel: The default minimum log level. """ self._logLevelsByNamespace: Dict[str, NamedConstant] = {} self.defaultLogLevel = defaultLogLevel self.clearLogLevels() def logLevelForNamespace(self, namespace: str) -> NamedConstant: """ Determine an appropriate log level for the given namespace. This respects dots in namespaces; for example, if you have previously invoked C{setLogLevelForNamespace("mypackage", LogLevel.debug)}, then C{logLevelForNamespace("mypackage.subpackage")} will return C{LogLevel.debug}. @param namespace: A logging namespace. Use C{""} for the default namespace. @return: The log level for the specified namespace. """ if not namespace: return self._logLevelsByNamespace[""] if namespace in self._logLevelsByNamespace: return self._logLevelsByNamespace[namespace] segments = namespace.split(".") index = len(segments) - 1 while index > 0: namespace = ".".join(segments[:index]) if namespace in self._logLevelsByNamespace: return self._logLevelsByNamespace[namespace] index -= 1 return self._logLevelsByNamespace[""] def setLogLevelForNamespace(self, namespace: str, level: NamedConstant) -> None: """ Sets the log level for a logging namespace. @param namespace: A logging namespace. @param level: The log level for the given namespace. """ if level not in LogLevel.iterconstants(): raise InvalidLogLevelError(level) if namespace: self._logLevelsByNamespace[namespace] = level else: self._logLevelsByNamespace[""] = level def clearLogLevels(self) -> None: """ Clears all log levels to the default. """ self._logLevelsByNamespace.clear() self._logLevelsByNamespace[""] = self.defaultLogLevel def __call__(self, event: LogEvent) -> NamedConstant: eventLevel = event.get("log_level", None) if eventLevel is None: return PredicateResult.no namespace = event.get("log_namespace", "") if not namespace: return PredicateResult.no namespaceLevel = self.logLevelForNamespace(namespace) if eventLevel < namespaceLevel: return PredicateResult.no return PredicateResult.maybe _util.py 0000644 00000002570 15027667615 0006255 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_util -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Logging utilities. """ from typing import List from ._interfaces import LogTrace from ._logger import Logger def formatTrace(trace: LogTrace) -> str: """ Format a trace (that is, the contents of the C{log_trace} key of a log event) as a visual indication of the message's propagation through various observers. @param trace: the contents of the C{log_trace} key from an event. @return: A multi-line string with indentation and arrows indicating the flow of the message through various observers. """ def formatWithName(obj: object) -> str: if hasattr(obj, "name"): return f"{obj} ({obj.name})" # type: ignore[attr-defined] else: return f"{obj}" result = [] lineage: List[Logger] = [] for parent, child in trace: if not lineage or lineage[-1] is not parent: if parent in lineage: while lineage[-1] is not parent: lineage.pop() else: if not lineage: result.append(f"{formatWithName(parent)}\n") lineage.append(parent) result.append(" " * len(lineage)) result.append(f"-> {formatWithName(child)}\n") return "".join(result) _capture.py 0000644 00000001160 15027667615 0006735 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_capture -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Context manager for capturing logs. """ from contextlib import contextmanager from typing import Iterator, List, Sequence, cast from twisted.logger import globalLogPublisher from ._interfaces import ILogObserver, LogEvent @contextmanager def capturedLogs() -> Iterator[Sequence[LogEvent]]: events: List[LogEvent] = [] observer = cast(ILogObserver, events.append) globalLogPublisher.addObserver(observer) yield events globalLogPublisher.removeObserver(observer) _buffer.py 0000644 00000002771 15027667615 0006554 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_buffer -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Log observer that maintains a buffer. """ from collections import deque from typing import Deque, Optional from zope.interface import implementer from ._interfaces import ILogObserver, LogEvent _DEFAULT_BUFFER_MAXIMUM = 64 * 1024 @implementer(ILogObserver) class LimitedHistoryLogObserver: """ L{ILogObserver} that stores events in a buffer of a fixed size:: >>> from twisted.logger import LimitedHistoryLogObserver >>> history = LimitedHistoryLogObserver(5) >>> for n in range(10): history({'n': n}) ... >>> repeats = [] >>> history.replayTo(repeats.append) >>> len(repeats) 5 >>> repeats [{'n': 5}, {'n': 6}, {'n': 7}, {'n': 8}, {'n': 9}] >>> """ def __init__(self, size: Optional[int] = _DEFAULT_BUFFER_MAXIMUM) -> None: """ @param size: The maximum number of events to buffer. If L{None}, the buffer is unbounded. """ self._buffer: Deque[LogEvent] = deque(maxlen=size) def __call__(self, event: LogEvent) -> None: self._buffer.append(event) def replayTo(self, otherObserver: ILogObserver) -> None: """ Re-play the buffered events to another log observer. @param otherObserver: An observer to replay events to. """ for event in self._buffer: otherObserver(event) _stdlib.py 0000644 00000010702 15027667615 0006555 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_stdlib -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Integration with Python standard library logging. """ import logging as stdlibLogging from typing import Mapping, Tuple from zope.interface import implementer from constantly import NamedConstant # type: ignore[import] from twisted.python.compat import currentframe from ._format import formatEvent from ._interfaces import ILogObserver, LogEvent from ._levels import LogLevel # Mappings to Python's logging module toStdlibLogLevelMapping: Mapping[NamedConstant, int] = { LogLevel.debug: stdlibLogging.DEBUG, LogLevel.info: stdlibLogging.INFO, LogLevel.warn: stdlibLogging.WARNING, LogLevel.error: stdlibLogging.ERROR, LogLevel.critical: stdlibLogging.CRITICAL, } def _reverseLogLevelMapping() -> Mapping[int, NamedConstant]: """ Reverse the above mapping, adding both the numerical keys used above and the corresponding string keys also used by python logging. @return: the reversed mapping """ mapping = {} for logLevel, pyLogLevel in toStdlibLogLevelMapping.items(): mapping[pyLogLevel] = logLevel mapping[stdlibLogging.getLevelName(pyLogLevel)] = logLevel return mapping fromStdlibLogLevelMapping = _reverseLogLevelMapping() @implementer(ILogObserver) class STDLibLogObserver: """ Log observer that writes to the python standard library's C{logging} module. @note: Warning: specific logging configurations (example: network) can lead to this observer blocking. Nothing is done here to prevent that, so be sure to not to configure the standard library logging module to block when used in conjunction with this module: code within Twisted, such as twisted.web, assumes that logging does not block. @cvar defaultStackDepth: This is the default number of frames that it takes to get from L{STDLibLogObserver} through the logging module, plus one; in other words, the number of frames if you were to call a L{STDLibLogObserver} directly. This is useful to use as an offset for the C{stackDepth} parameter to C{__init__}, to add frames for other publishers. """ defaultStackDepth = 4 def __init__( self, name: str = "twisted", stackDepth: int = defaultStackDepth ) -> None: """ @param name: logger identifier. @param stackDepth: The depth of the stack to investigate for caller metadata. """ self.logger = stdlibLogging.getLogger(name) self.logger.findCaller = self._findCaller # type: ignore[assignment] self.stackDepth = stackDepth def _findCaller( self, stackInfo: bool = False, stackLevel: int = 1 ) -> Tuple[str, int, str, None]: """ Based on the stack depth passed to this L{STDLibLogObserver}, identify the calling function. @param stackInfo: Whether or not to construct stack information. (Currently ignored.) @param stackLevel: The number of stack frames to skip when determining the caller (currently ignored; use stackDepth on the instance). @return: Depending on Python version, either a 3-tuple of (filename, lineno, name) or a 4-tuple of that plus stack information. """ f = currentframe(self.stackDepth) co = f.f_code extra = (None,) return (co.co_filename, f.f_lineno, co.co_name) + extra def __call__(self, event: LogEvent) -> None: """ Format an event and bridge it to Python logging. """ level = event.get("log_level", LogLevel.info) failure = event.get("log_failure") if failure is None: excInfo = None else: excInfo = (failure.type, failure.value, failure.getTracebackObject()) stdlibLevel = toStdlibLogLevelMapping.get(level, stdlibLogging.INFO) self.logger.log(stdlibLevel, StringifiableFromEvent(event), exc_info=excInfo) class StringifiableFromEvent: """ An object that implements C{__str__()} in order to defer the work of formatting until it's converted into a C{str}. """ def __init__(self, event: LogEvent) -> None: """ @param event: An event. """ self.event = event def __str__(self) -> str: return formatEvent(self.event) def __bytes__(self) -> bytes: return str(self).encode("utf-8") test/test_logger.py 0000644 00000020040 15027667615 0010426 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._logger}. """ from typing import List, Optional, Type, cast from zope.interface import implementer from constantly import NamedConstant # type: ignore[import] from twisted.trial import unittest from .._format import formatEvent from .._global import globalLogPublisher from .._interfaces import ILogObserver, LogEvent from .._levels import InvalidLogLevelError, LogLevel from .._logger import Logger class TestLogger(Logger): """ L{Logger} with an overridden C{emit} method that keeps track of received events. """ def emit( self, level: NamedConstant, format: Optional[str] = None, **kwargs: object ) -> None: @implementer(ILogObserver) def observer(event: LogEvent) -> None: self.event = event globalLogPublisher.addObserver(observer) try: Logger.emit(self, level, format, **kwargs) finally: globalLogPublisher.removeObserver(observer) self.emitted = { "level": level, "format": format, "kwargs": kwargs, } class LogComposedObject: """ A regular object, with a logger attached. """ log = TestLogger() def __init__(self, state: Optional[str] = None) -> None: self.state = state def __str__(self) -> str: return f"<LogComposedObject {self.state}>" class LoggerTests(unittest.TestCase): """ Tests for L{Logger}. """ def test_repr(self) -> None: """ repr() on Logger """ namespace = "bleargh" log = Logger(namespace) self.assertEqual(repr(log), f"<Logger {repr(namespace)}>") def test_namespaceDefault(self) -> None: """ Default namespace is module name. """ log = Logger() self.assertEqual(log.namespace, __name__) def test_namespaceOMGItsTooHard(self) -> None: """ Default namespace is C{"<unknown>"} when a logger is created from a context in which is can't be determined automatically and no namespace was specified. """ result: List[Logger] = [] exec( "result.append(Logger())", dict(Logger=Logger), locals(), ) self.assertEqual(result[0].namespace, "<unknown>") def test_namespaceAttribute(self) -> None: """ Default namespace for classes using L{Logger} as a descriptor is the class name they were retrieved from. """ obj = LogComposedObject() expectedNamespace = "{}.{}".format( obj.__module__, obj.__class__.__name__, ) self.assertEqual(cast(TestLogger, obj.log).namespace, expectedNamespace) self.assertEqual( cast(Type[TestLogger], LogComposedObject.log).namespace, expectedNamespace ) self.assertIs( cast(Type[TestLogger], LogComposedObject.log).source, LogComposedObject ) self.assertIs(cast(TestLogger, obj.log).source, obj) self.assertIsNone(Logger().source) def test_descriptorObserver(self) -> None: """ When used as a descriptor, the observer is propagated. """ observed: List[LogEvent] = [] class MyObject: log = Logger(observer=cast(ILogObserver, observed.append)) MyObject.log.info("hello") self.assertEqual(len(observed), 1) self.assertEqual(observed[0]["log_format"], "hello") def test_sourceAvailableForFormatting(self) -> None: """ On instances that have a L{Logger} class attribute, the C{log_source} key is available to format strings. """ obj = LogComposedObject("hello") log = cast(TestLogger, obj.log) log.error("Hello, {log_source}.") self.assertIn("log_source", log.event) self.assertEqual(log.event["log_source"], obj) stuff = formatEvent(log.event) self.assertIn("Hello, <LogComposedObject hello>.", stuff) def test_basicLogger(self) -> None: """ Test that log levels and messages are emitted correctly for Logger. """ log = TestLogger() for level in LogLevel.iterconstants(): format = "This is a {level_name} message" message = format.format(level_name=level.name) logMethod = getattr(log, level.name) logMethod(format, junk=message, level_name=level.name) # Ensure that test_emit got called with expected arguments self.assertEqual(log.emitted["level"], level) self.assertEqual(log.emitted["format"], format) self.assertEqual(log.emitted["kwargs"]["junk"], message) self.assertTrue(hasattr(log, "event"), "No event observed.") self.assertEqual(log.event["log_format"], format) self.assertEqual(log.event["log_level"], level) self.assertEqual(log.event["log_namespace"], __name__) self.assertIsNone(log.event["log_source"]) self.assertEqual(log.event["junk"], message) self.assertEqual(formatEvent(log.event), message) def test_sourceOnClass(self) -> None: """ C{log_source} event key refers to the class. """ @implementer(ILogObserver) def observer(event: LogEvent) -> None: self.assertEqual(event["log_source"], Thingo) class Thingo: log = TestLogger(observer=observer) cast(TestLogger, Thingo.log).info() def test_sourceOnInstance(self) -> None: """ C{log_source} event key refers to the instance. """ @implementer(ILogObserver) def observer(event: LogEvent) -> None: self.assertEqual(event["log_source"], thingo) class Thingo: log = TestLogger(observer=observer) thingo = Thingo() cast(TestLogger, thingo.log).info() def test_sourceUnbound(self) -> None: """ C{log_source} event key is L{None}. """ @implementer(ILogObserver) def observer(event: LogEvent) -> None: self.assertIsNone(event["log_source"]) log = TestLogger(observer=observer) log.info() def test_defaultFailure(self) -> None: """ Test that log.failure() emits the right data. """ log = TestLogger() try: raise RuntimeError("baloney!") except RuntimeError: log.failure("Whoops") errors = self.flushLoggedErrors(RuntimeError) self.assertEqual(len(errors), 1) self.assertEqual(log.emitted["level"], LogLevel.critical) self.assertEqual(log.emitted["format"], "Whoops") def test_conflictingKwargs(self) -> None: """ Make sure that kwargs conflicting with args don't pass through. """ log = TestLogger() log.warn( "*", log_format="#", log_level=LogLevel.error, log_namespace="*namespace*", log_source="*source*", ) self.assertEqual(log.event["log_format"], "*") self.assertEqual(log.event["log_level"], LogLevel.warn) self.assertEqual(log.event["log_namespace"], log.namespace) self.assertIsNone(log.event["log_source"]) def test_logInvalidLogLevel(self) -> None: """ Test passing in a bogus log level to C{emit()}. """ log = TestLogger() log.emit("*bogus*") errors = self.flushLoggedErrors(InvalidLogLevelError) self.assertEqual(len(errors), 1) def test_trace(self) -> None: """ Tracing keeps track of forwarding to the publisher. """ @implementer(ILogObserver) def publisher(event: LogEvent) -> None: observer(event) @implementer(ILogObserver) def observer(event: LogEvent) -> None: self.assertEqual(event["log_trace"], [(log, publisher)]) log = TestLogger(observer=publisher) log.info("Hello.", log_trace=[]) test/test_filter.py 0000644 00000031757 15027667615 0010455 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._filter}. """ from typing import Iterable, List, Tuple, Union, cast from zope.interface import implementer from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from constantly import NamedConstant # type: ignore[import] from twisted.trial import unittest from .._filter import ( FilteringLogObserver, ILogFilterPredicate, LogLevelFilterPredicate, PredicateResult, ) from .._interfaces import ILogObserver, LogEvent from .._levels import InvalidLogLevelError, LogLevel from .._observer import LogPublisher, bitbucketLogObserver class FilteringLogObserverTests(unittest.TestCase): """ Tests for L{FilteringLogObserver}. """ def test_interface(self) -> None: """ L{FilteringLogObserver} is an L{ILogObserver}. """ observer = FilteringLogObserver(cast(ILogObserver, lambda e: None), ()) try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def filterWith( self, filters: Iterable[str], other: bool = False ) -> Union[List[int], Tuple[List[int], List[int]]]: """ Apply a set of pre-defined filters on a known set of events and return the filtered list of event numbers. The pre-defined events are four events with a C{count} attribute set to C{0}, C{1}, C{2}, and C{3}. @param filters: names of the filters to apply. Options are: - C{"twoMinus"} (count <=2), - C{"twoPlus"} (count >= 2), - C{"notTwo"} (count != 2), - C{"no"} (False). @param other: Whether to return a list of filtered events as well. @return: event numbers or 2-tuple of lists of event numbers. """ events: List[LogEvent] = [ dict(count=0), dict(count=1), dict(count=2), dict(count=3), ] class Filters: @staticmethod def twoMinus(event: LogEvent) -> NamedConstant: """ count <= 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] <= 2}, otherwise L{PredicateResult.maybe}. """ if event["count"] <= 2: return PredicateResult.yes return PredicateResult.maybe @staticmethod def twoPlus(event: LogEvent) -> NamedConstant: """ count >= 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] >= 2}, otherwise L{PredicateResult.maybe}. """ if event["count"] >= 2: return PredicateResult.yes return PredicateResult.maybe @staticmethod def notTwo(event: LogEvent) -> NamedConstant: """ count != 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] != 2}, otherwise L{PredicateResult.maybe}. """ if event["count"] == 2: return PredicateResult.no return PredicateResult.maybe @staticmethod def no(event: LogEvent) -> NamedConstant: """ No way, man. @param event: an event @return: L{PredicateResult.no} """ return PredicateResult.no @staticmethod def bogus(event: LogEvent) -> NamedConstant: """ Bogus result. @param event: an event @return: something other than a valid predicate result. """ return None predicates = (getattr(Filters, f) for f in filters) eventsSeen: List[LogEvent] = [] eventsNotSeen: List[LogEvent] = [] trackingObserver = cast(ILogObserver, eventsSeen.append) if other: negativeObserver = cast(ILogObserver, eventsNotSeen.append) else: negativeObserver = bitbucketLogObserver filteringObserver = FilteringLogObserver( trackingObserver, predicates, negativeObserver ) for e in events: filteringObserver(e) if other: return ( [cast(int, e["count"]) for e in eventsSeen], [cast(int, e["count"]) for e in eventsNotSeen], ) else: return [cast(int, e["count"]) for e in eventsSeen] def test_shouldLogEventNoFilters(self) -> None: """ No filters: all events come through. """ self.assertEqual(self.filterWith([]), [0, 1, 2, 3]) def test_shouldLogEventNoFilter(self) -> None: """ Filter with negative predicate result. """ self.assertEqual(self.filterWith(["notTwo"]), [0, 1, 3]) def test_shouldLogEventOtherObserver(self) -> None: """ Filtered results get sent to the other observer, if passed. """ self.assertEqual(self.filterWith(["notTwo"], True), ([0, 1, 3], [2])) def test_shouldLogEventYesFilter(self) -> None: """ Filter with positive predicate result. """ self.assertEqual(self.filterWith(["twoPlus"]), [0, 1, 2, 3]) def test_shouldLogEventYesNoFilter(self) -> None: """ Series of filters with positive and negative predicate results. """ self.assertEqual(self.filterWith(["twoPlus", "no"]), [2, 3]) def test_shouldLogEventYesYesNoFilter(self) -> None: """ Series of filters with positive, positive and negative predicate results. """ self.assertEqual(self.filterWith(["twoPlus", "twoMinus", "no"]), [0, 1, 2, 3]) def test_shouldLogEventBadPredicateResult(self) -> None: """ Filter with invalid predicate result. """ self.assertRaises(TypeError, self.filterWith, ["bogus"]) def test_call(self) -> None: """ Test filtering results from each predicate type. """ e: LogEvent = dict(obj=object()) def callWithPredicateResult(result: NamedConstant) -> List[LogEvent]: seen: List[LogEvent] = [] observer = FilteringLogObserver( cast(ILogObserver, lambda e: seen.append(e)), (cast(ILogFilterPredicate, lambda e: result),), ) observer(e) return seen self.assertIn(e, callWithPredicateResult(PredicateResult.yes)) self.assertIn(e, callWithPredicateResult(PredicateResult.maybe)) self.assertNotIn(e, callWithPredicateResult(PredicateResult.no)) def test_trace(self) -> None: """ Tracing keeps track of forwarding through the filtering observer. """ event: LogEvent = dict(log_trace=[]) oYes = cast(ILogObserver, lambda e: None) oNo = cast(ILogObserver, lambda e: None) @implementer(ILogObserver) def testObserver(e: LogEvent) -> None: self.assertIs(e, event) self.assertEqual( event["log_trace"], [ (publisher, yesFilter), (yesFilter, oYes), (publisher, noFilter), # ... noFilter doesn't call oNo (publisher, oTest), ], ) oTest = testObserver yesFilter = FilteringLogObserver( oYes, (cast(ILogFilterPredicate, lambda e: PredicateResult.yes),) ) noFilter = FilteringLogObserver( oNo, (cast(ILogFilterPredicate, lambda e: PredicateResult.no),) ) publisher = LogPublisher(yesFilter, noFilter, testObserver) publisher(event) class LogLevelFilterPredicateTests(unittest.TestCase): """ Tests for L{LogLevelFilterPredicate}. """ def test_defaultLogLevel(self) -> None: """ Default log level is used. """ predicate = LogLevelFilterPredicate() # Test using both "" and None as default namespace, because None was the # documented default value in the past. for default in ("", cast(str, None)): self.assertEqual( predicate.logLevelForNamespace(default), predicate.defaultLogLevel ) self.assertEqual( predicate.logLevelForNamespace("rocker.cool.namespace"), predicate.defaultLogLevel, ) def test_setLogLevel(self) -> None: """ Setting and retrieving log levels. """ predicate = LogLevelFilterPredicate() # Test using both "" and None as default namespace, because None was the # documented default value in the past. for default in ("", cast(str, None)): predicate.setLogLevelForNamespace(default, LogLevel.error) predicate.setLogLevelForNamespace("twext.web2", LogLevel.debug) predicate.setLogLevelForNamespace("twext.web2.dav", LogLevel.warn) self.assertEqual(predicate.logLevelForNamespace(""), LogLevel.error) self.assertEqual( predicate.logLevelForNamespace(cast(str, None)), LogLevel.error ) self.assertEqual(predicate.logLevelForNamespace("twisted"), LogLevel.error) self.assertEqual( predicate.logLevelForNamespace("twext.web2"), LogLevel.debug ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav"), LogLevel.warn ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav.test"), LogLevel.warn ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav.test1.test2"), LogLevel.warn, ) def test_setInvalidLogLevel(self) -> None: """ Can't pass invalid log levels to C{setLogLevelForNamespace()}. """ predicate = LogLevelFilterPredicate() self.assertRaises( InvalidLogLevelError, predicate.setLogLevelForNamespace, "twext.web2", object(), ) # Level must be a constant, not the name of a constant self.assertRaises( InvalidLogLevelError, predicate.setLogLevelForNamespace, "twext.web2", "debug", ) def test_clearLogLevels(self) -> None: """ Clearing log levels. """ predicate = LogLevelFilterPredicate() predicate.setLogLevelForNamespace("twext.web2", LogLevel.debug) predicate.setLogLevelForNamespace("twext.web2.dav", LogLevel.error) predicate.clearLogLevels() self.assertEqual( predicate.logLevelForNamespace("twisted"), predicate.defaultLogLevel ) self.assertEqual( predicate.logLevelForNamespace("twext.web2"), predicate.defaultLogLevel ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav"), predicate.defaultLogLevel ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav.test"), predicate.defaultLogLevel, ) self.assertEqual( predicate.logLevelForNamespace("twext.web2.dav.test1.test2"), predicate.defaultLogLevel, ) def test_filtering(self) -> None: """ Events are filtered based on log level/namespace. """ predicate = LogLevelFilterPredicate() predicate.setLogLevelForNamespace("", LogLevel.error) predicate.setLogLevelForNamespace("twext.web2", LogLevel.debug) predicate.setLogLevelForNamespace("twext.web2.dav", LogLevel.warn) def checkPredicate( namespace: str, level: NamedConstant, expectedResult: NamedConstant ) -> None: event: LogEvent = dict(log_namespace=namespace, log_level=level) self.assertEqual(expectedResult, predicate(event)) checkPredicate("", LogLevel.debug, PredicateResult.no) checkPredicate(cast(str, None), LogLevel.debug, PredicateResult.no) checkPredicate("", LogLevel.error, PredicateResult.no) checkPredicate(cast(str, None), LogLevel.error, PredicateResult.no) checkPredicate("twext.web2", LogLevel.debug, PredicateResult.maybe) checkPredicate("twext.web2", LogLevel.error, PredicateResult.maybe) checkPredicate("twext.web2.dav", LogLevel.debug, PredicateResult.no) checkPredicate("twext.web2.dav", LogLevel.error, PredicateResult.maybe) checkPredicate("", LogLevel.critical, PredicateResult.no) checkPredicate(cast(str, None), LogLevel.critical, PredicateResult.no) checkPredicate("twext.web2", None, PredicateResult.no) test/__pycache__/test_flatten.cpython-310.pyc 0000644 00000025040 15027667615 0015150 0 ustar 00 o �b�% � @ s� d Z ddlZddlmZ ddlmZmZmZ zddlm Z W n e y) dZ Y nw ddl m Z ddl mZmZmZmZ dd lmZ dd lmZ G d d � d e j�ZdS ) z+ Test cases for L{twisted.logger._format}. � N)�count)�Any�Callable�Optional)�tzset)�unittest� )� KeyFlattener� aFormatter� extractField� flattenEvent)� formatEvent)�LogEventc @ s� e Zd ZdZd"dd�Zd"dd�Zd"dd �Zd"d d �Z d#d ee de fd d�Z d"dd�Z d"dd�Z d"dd�Z dd� fdee ge f ddfdd�Zd"dd�Zd"d d �Zd"d d �Zd"d d!�ZdS )$�FlatFormattingTestsz9 Tests for flattened event formatting functions. �returnNc sr t � � G dd� d�}td� fdd�|� dddd �}t|� t|�}|d = |d = t�t�|��}| �t|�d � d S )a) L{flattenEvent} will "flatten" an event so that, if scrubbed of all but serializable objects, it will preserve all necessary data to be formatted once serialized. When presented with an event thusly flattened, L{formatEvent} will produce the same output. c @ s e Zd ZdZdS )z;FlatFormattingTests.test_formatFlatEvent.<locals>.Ephemeral�valueN)�__name__� __module__� __qualname__� attribute� r r �B/usr/lib/python3/dist-packages/twisted/logger/test/test_flatten.py� Ephemeral% s r z�callable: {callme()} attribute: {object.attribute} numrepr: {number!r} numstr: {number!s} strrepr: {string!r} unistr: {unistr!s}c s t � �S �N)�nextr ��counterr r �<lambda>1 s z:FlatFormattingTests.test_formatFlatEvent.<locals>.<lambda>� �hello� ö)� log_format�callme�object�number�string�unistrr" r# uM callable: 0 attribute: value numrepr: 7 numstr: 7 strrepr: 'hello' unistr: öN)r �dictr �json�loads�dumps� assertEqualr )�selfr �event1�event2�event3r r r �test_formatFlatEvent s& ��z(FlatFormattingTests.test_formatFlatEventc C s< t ddd�}t|� t�t�|��}| �t|��d�� dS )zH If the format string is invalid, an error is produced. zstrrepr: {string!X}r )r! r% zUnable to format eventN)r' r r( r) r* � assertTruer � startswith)r, r- r. r r r � test_formatFlatEventBadFormatJ s �z1FlatFormattingTests.test_formatFlatEventBadFormatc C sD G dd� d�}|� }t d|d�}t|� |�� | �t|�d� dS )z� L{formatEvent} will prefer the stored C{str()} or C{repr()} value for an object, in case the other version. c @ s, e Zd ZdZdZd dd�Zdefdd�ZdS ) zPFlatFormattingTests.test_formatFlatEventWithMutatedFields.<locals>.Unpersistablez. Unpersitable object. Fr Nc S s d| _ dS )z0 Self destruct. TN�� destructed�r, r r r � selfDestructe s z]FlatFormattingTests.test_formatFlatEventWithMutatedFields.<locals>.Unpersistable.selfDestructc S s | j rdS dS )Nzpost-serialization garbagezun-persistabler4 r6 r r r �__repr__k s zYFlatFormattingTests.test_formatFlatEventWithMutatedFields.<locals>.Unpersistable.__repr__�r N)r r r �__doc__r5 r7 �strr8 r r r r � Unpersistable^ s r< z unpersistable: {unpersistable})r! � unpersistablez unpersistable: un-persistableN)r' r r7 r+ r )r, r< �upr- r r r �%test_formatFlatEventWithMutatedFieldsX s z9FlatFormattingTests.test_formatFlatEventWithMutatedFieldsc C s dt dt fdd�}z | �|d�d� W n ty � w | �|d�d� | �|d �d � | �|d �d � | �|d �d� | �|d�d� | �|d�d� | �|d�d� | �|d�d� | �|d�d� t� }t�d�\\}}}}|duswJ �| �|�|||�d� | �|�|||�d � dS ) zh Test that L{KeyFlattener.flatKey} returns the expected keys for format fields. �formatr c S s> t �| �D ]\}}}}|d usJ �t� �|||� S J d��)NFz*Unable to derive key from format: {format})r �parser �flatKey)r@ � literalText� fieldName� formatSpec� conversionr r r � keyFromFormat s � z=FlatFormattingTests.test_keyFlattening.<locals>.keyFromFormatz{}z!:z{foo}zfoo!:z{foo!s}zfoo!s:z{foo!r}zfoo!r:z{foo:%s}zfoo!:%sz{foo:!}zfoo!:!z{foo::}zfoo!::z {foo!s:%s}zfoo!s:%sz {foo!s:!}zfoo!s:!z {foo!s::}zfoo!s::z{x}Nzx!:zx!:/2)r; r+ � ValueErrorr r rA rB )r, rG � sameFlattenerrC rD rE rF r r r �test_keyFlatteningy s< �� ��z&FlatFormattingTests.test_keyFlattening�eventc sJ |du rt � � G � fdd�d�}td|� d�}t|� | �t|�d� |S )z� The same format field used twice in one event is rendered twice. @param event: An event to flatten. If L{None}, create a new event. @return: C{event} or the event created. Nc s" e Zd ZdZdef� fdd� ZdS )zJFlatFormattingTests._test_formatFlatEvent_fieldNamesSame.<locals>.CountStrz& Hack r c s t t� ��S r )r; r r6 r r r �__str__� s zRFlatFormattingTests._test_formatFlatEvent_fieldNamesSame.<locals>.CountStr.__str__N)r r r r: r; rL r r r r �CountStr� s rM z{x} {x}�r! �xz0 1)r r' r r+ r )r, rK rM r r r �$_test_formatFlatEvent_fieldNamesSame� s �z8FlatFormattingTests._test_formatFlatEvent_fieldNamesSamec C s | � � dS )zR The same format field used twice in one event is rendered twice. N�rP r6 r r r �"test_formatFlatEventFieldNamesSame� s z6FlatFormattingTests.test_formatFlatEventFieldNamesSamec C s | � � }| � |� dS )zb The same event flattened twice gives the same (already rendered) result. NrQ )r, rK r r r �'test_formatFlatEventFieldNamesSameAgain� s z;FlatFormattingTests.test_formatFlatEventFieldNamesSameAgainc C s, t ddd�}t|� t|�}| �|d� dS )zs L{formatEvent} will handle a flattened event with tailing text after a replacement field. ztest {x} trailingr rN ztest value trailingN)r' r r r+ )r, rK �resultr r r � test_formatEventFlatTrailingText� s �z4FlatFormattingTests.test_formatEventFlatTrailingTextc C s | S r r )rO r r r r � s z FlatFormattingTests.<lambda>� flattenFirstc s� G dd� d�� G � fdd�d�}t d|� d�}||��dtdtf�fd d � }| �|d �d � | �|d �d� | �|d�d� dS )z� L{extractField} will extract a field used in the format string. @param flattenFirst: callable to flatten an event c @ s e Zd Zdefdd�ZdS )z=FlatFormattingTests.test_extractField.<locals>.ObjectWithReprr c S s dS )N�reprr r6 r r r r8 � s zFFlatFormattingTests.test_extractField.<locals>.ObjectWithRepr.__repr__N)r r r r; r8 r r r r �ObjectWithRepr� s rX c s$ e Zd Zd� fdd� Zddd�ZdS )z8FlatFormattingTests.test_extractField.<locals>.Somethingr Nc s d| _ � � | _d S )Nr )r$ r# r6 �rX r r �__init__� s zAFlatFormattingTests.test_extractField.<locals>.Something.__init__c S s t d��)Nz Just in case.)�NotImplementedErrorr6 r r r � __getstate__ s zEFlatFormattingTests.test_extractField.<locals>.Something.__getstate__r9 )r r r rZ r\ r rY r r � Something� s r] z%{something.number} {something.object})r! � something�fieldr c s t | � �S r )r )r_ )� flattenedr r �extract s z6FlatFormattingTests.test_extractField.<locals>.extractzsomething.numberr zsomething.number!s�7zsomething.object!srW N)r' r; r r+ )r, rV r] rK ra r )rX r` r �test_extractField� s �z%FlatFormattingTests.test_extractFieldc C s dt dt fdd�}| �|� dS )zi L{extractField} behaves identically if the event is explicitly flattened first. rK r c S s t | � | S r )r )rK r r r r` s zDFlatFormattingTests.test_extractFieldFlattenFirst.<locals>.flattenedN)r rc )r, r` r r r � test_extractFieldFlattenFirst s z1FlatFormattingTests.test_extractFieldFlattenFirstc C s( ddd�}t |� | �|ddd�� dS )zT L{flattenEvent} will do nothing to an event with no format string. �b� )�a�cN�r r+ �r, � inputEventr r r � test_flattenEventWithoutFormat s z2FlatFormattingTests.test_flattenEventWithoutFormatc C s, dddd�}t |� | �|dddd�� dS )zz L{flattenEvent} will do nothing to an event with a format string that contains no format fields. re rf zsimple message�rg rh r! Nri rj r r r � test_flattenEventWithInertFormat( � ��z4FlatFormattingTests.test_flattenEventWithInertFormatc C s, dddd�}t |� | �|dddd�� dS )zb L{flattenEvent} will do nothing to an event with log_format set to None. re rf Nrm ri rj r r r � test_flattenEventWithNoneFormat8 ro z3FlatFormattingTests.test_flattenEventWithNoneFormatr9 r )r r r r: r0 r3 r? rJ r r rP rR rS rU r rc rd rl rn rp r r r r r s2 . !>�� � � � � # r )r: r( � itertoolsr �typingr r r �timer � ImportError� twisted.trialr �_flattenr r r r �_formatr � _interfacesr �TestCaser r r r r �<module> s � test/__pycache__/test_levels.cpython-310.pyc 0000644 00000002342 15027667615 0015005 0 ustar 00 o �bc � @ s6 d Z ddlmZ ddlmZmZ G dd� dej�ZdS )z+ Test cases for L{twisted.logger._levels}. � )�unittest� )�InvalidLogLevelError�LogLevelc @ s$ e Zd ZdZddd�Zddd�ZdS ) � LogLevelTestsz Tests for L{LogLevel}. �returnNc C s& t �� D ] }| �t �|j�|� qdS )z, Look up log level by name. N)r � iterconstants�assertIs� levelWithName�name)�self�level� r �A/usr/lib/python3/dist-packages/twisted/logger/test/test_levels.py�test_levelWithName s �z LogLevelTests.test_levelWithNamec C sV d}zt �|� W n ty# } z| �|j|� W Y d}~dS d}~ww | �d� dS )z4 You can't make up log level names. z*bogus*Nz Expected InvalidLogLevelError.)r r r r r �fail)r �bogus�er r r �test_levelWithInvalidName s ��z'LogLevelTests.test_levelWithInvalidName)r N)�__name__� __module__� __qualname__�__doc__r r r r r r r s r N)r � twisted.trialr �_levelsr r �TestCaser r r r r �<module> s test/__pycache__/test_filter.cpython-310.pyc 0000644 00000030744 15027667615 0015007 0 ustar 00 o �b�3 � @ s� d Z ddlmZmZmZmZmZ ddlmZ ddl m Z ddl m Z ddl mZ ddlmZ dd lmZmZmZmZ dd lmZmZ dd lmZmZ dd l m Z m Z G d d� dej �Z G dd� dej �Z!dS )z+ Test cases for L{twisted.logger._filter}. � )�Iterable�List�Tuple�Union�cast)� implementer)�BrokenMethodImplementation)� verifyObject)� NamedConstant)�unittest� )�FilteringLogObserver�ILogFilterPredicate�LogLevelFilterPredicate�PredicateResult)� ILogObserver�LogEvent)�InvalidLogLevelError�LogLevel)� LogPublisher�bitbucketLogObserverc @ s� e Zd ZdZd dd�Z d dee dedee e e e e e e f f fd d �Z d d d �Z d d d�Zd dd�Zd dd�Zd dd�Zd dd�Zd dd�Zd dd�Zd dd �ZdS ) �FilteringLogObserverTestsz, Tests for L{FilteringLogObserver}. �returnNc C sV t ttdd� �d�}ztt|� W dS ty* } z | �|� W Y d}~dS d}~ww )z@ L{FilteringLogObserver} is an L{ILogObserver}. c S � d S �N� ��er r �A/usr/lib/python3/dist-packages/twisted/logger/test/test_filter.py�<lambda>% � z:FilteringLogObserverTests.test_interface.<locals>.<lambda>r N)r r r r r �fail)�self�observerr r r r �test_interface! s ��z(FilteringLogObserverTests.test_interfaceF�filters�otherc s� t dd�t dd�t dd�t dd�g}G dd� d�� � fdd �|D �}g }g }tt|j�}|r5tt|j�}nt}t|||�} |D ]} | | � q?|rVd d � |D �d d � |D �fS d d � |D �S )a� Apply a set of pre-defined filters on a known set of events and return the filtered list of event numbers. The pre-defined events are four events with a C{count} attribute set to C{0}, C{1}, C{2}, and C{3}. @param filters: names of the filters to apply. Options are: - C{"twoMinus"} (count <=2), - C{"twoPlus"} (count >= 2), - C{"notTwo"} (count != 2), - C{"no"} (False). @param other: Whether to return a list of filtered events as well. @return: event numbers or 2-tuple of lists of event numbers. r ��count� r � c @ sz e Zd Zededefdd��Zededefdd��Zededefdd��Zededefd d ��Z ededefd d ��Z d S )z5FilteringLogObserverTests.filterWith.<locals>.Filters�eventr c S s | d dkr t jS t jS )z� count <= 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] <= 2}, otherwise L{PredicateResult.maybe}. r( r �r �yes�maybe�r+ r r r �twoMinusG � z>FilteringLogObserverTests.filterWith.<locals>.Filters.twoMinusc S s | d dkr t jS t jS )z� count >= 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] >= 2}, otherwise L{PredicateResult.maybe}. r( r r, r/ r r r �twoPlusU r1 z=FilteringLogObserverTests.filterWith.<locals>.Filters.twoPlusc S s | d dkr t jS t jS )z� count != 2 @param event: an event @return: L{PredicateResult.yes} if C{event["count"] != 2}, otherwise L{PredicateResult.maybe}. r( r )r �nor. r/ r r r �notTwoc r1 z<FilteringLogObserverTests.filterWith.<locals>.Filters.notTwoc S � t jS )z� No way, man. @param event: an event @return: L{PredicateResult.no} �r r3 r/ r r r r3 q s z8FilteringLogObserverTests.filterWith.<locals>.Filters.noc S s dS )z� Bogus result. @param event: an event @return: something other than a valid predicate result. Nr r/ r r r �bogus| s z;FilteringLogObserverTests.filterWith.<locals>.Filters.bogusN) �__name__� __module__� __qualname__� staticmethodr r r0 r2 r4 r3 r7 r r r r �FiltersF s r< c 3 s � | ]}t � |�V qd S r )�getattr)�.0�f�r< r r � <genexpr>� s � z7FilteringLogObserverTests.filterWith.<locals>.<genexpr>c S � g | ] }t t|d ��qS r' �r �int�r> r r r r � <listcomp>� � z8FilteringLogObserverTests.filterWith.<locals>.<listcomp>c S rB r' rC rE r r r rF � rG c S rB r' rC rE r r r rF � rG )�dictr r �appendr r ) r" r% r& �events� predicates� eventsSeen� eventsNotSeen�trackingObserver�negativeObserver�filteringObserverr r r@ r � filterWith+ s. �A � �z$FilteringLogObserverTests.filterWithc C s | � | �g �g d�� dS )z6 No filters: all events come through. �r r) r r* N�� assertEqualrQ �r" r r r � test_shouldLogEventNoFilters� s z6FilteringLogObserverTests.test_shouldLogEventNoFiltersc C � | � | �dg�g d�� dS )z8 Filter with negative predicate result. r4 �r r) r* NrS rU r r r �test_shouldLogEventNoFilter� � z5FilteringLogObserverTests.test_shouldLogEventNoFilterc C s$ | � | �dgd�g d�dgf� dS )zM Filtered results get sent to the other observer, if passed. r4 TrX r NrS rU r r r � test_shouldLogEventOtherObserver� s $z:FilteringLogObserverTests.test_shouldLogEventOtherObserverc C rW )z8 Filter with positive predicate result. r2 rR NrS rU r r r � test_shouldLogEventYesFilter� rZ z6FilteringLogObserverTests.test_shouldLogEventYesFilterc C s | � | �ddg�ddg� dS )zQ Series of filters with positive and negative predicate results. r2 r3 r r* NrS rU r r r � test_shouldLogEventYesNoFilter� s z8FilteringLogObserverTests.test_shouldLogEventYesNoFilterc C s | � | �g d��g d�� dS )zc Series of filters with positive, positive and negative predicate results. )r2 r0 r3 rR NrS rU r r r �!test_shouldLogEventYesYesNoFilter� s z;FilteringLogObserverTests.test_shouldLogEventYesYesNoFilterc C s | � t| jdg� dS )z7 Filter with invalid predicate result. r7 N)� assertRaises� TypeErrorrQ rU r r r �%test_shouldLogEventBadPredicateResult� s z?FilteringLogObserverTests.test_shouldLogEventBadPredicateResultc s` t t� d�� dtdtt f� fdd� }| �� |tj�� | �� |tj�� | � � |tj �� dS )zB Test filtering results from each predicate type. )�obj�resultr c s8 g �t tt�fdd��tt� fdd��f�}|�� �S )Nc s � � | �S r )rI r )�seenr r r � s zVFilteringLogObserverTests.test_call.<locals>.callWithPredicateResult.<locals>.<lambda>c s � S r r r )rc r r r � r )r r r r )rc r# r )rc rd r �callWithPredicateResult� s �zDFilteringLogObserverTests.test_call.<locals>.callWithPredicateResultN) rH �objectr r r �assertInr r- r. � assertNotInr3 )r" re r r r � test_call� s z#FilteringLogObserverTests.test_callc s� t g d�� ttdd� ��ttdd� �}tt�dtddf� ������fdd � �}|�t�ttd d� �f��t|ttd d� �f��t��|���� � dS ) zS Tracing keeps track of forwarding through the filtering observer. )� log_tracec S r r r r r r r r � r z6FilteringLogObserverTests.test_trace.<locals>.<lambda>c S r r r r r r r r � r r r Nc s8 �� | � � ��� d ��f��f��f��fg� d S )Nrj )�assertIsrT r �r+ �noFilter�oTest�oYes� publisherr" � yesFilterr r � testObserver� s ��z:FilteringLogObserverTests.test_trace.<locals>.testObserverc S r5 r )r r- r r r r r � � c S r5 r r6 r r r r r � rs )rH r r r r r r r )r" �oNorr r rl r � test_trace� s $ �� z$FilteringLogObserverTests.test_trace�r N)F)r8 r9 r: �__doc__r$ r �str�boolr r rD r rQ rV rY r[ r\ r] r^ ra ri ru r r r r r s( ��� � u r c @ sB e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �ZdS )� LogLevelFilterPredicateTestsz/ Tests for L{LogLevelFilterPredicate}. r Nc C sF t � }dttd�fD ]}| �|�|�|j� | �|�d�|j� q dS )z, Default log level is used. � Nzrocker.cool.namespace)r r rx rT �logLevelForNamespace�defaultLogLevel�r" � predicate�defaultr r r �test_defaultLogLevel s ���z1LogLevelFilterPredicateTests.test_defaultLogLevelc C s� t � }dttd�fD ]`}|�|tj� |�dtj� |�dtj� | �|� d�tj� | �|� ttd��tj� | �|� d�tj� | �|� d�tj� | �|� d�tj� | �|� d�tj� | �|� d�tj� q dS )z4 Setting and retrieving log levels. r{ N� twext.web2�twext.web2.dav�twisted�twext.web2.dav.test�twext.web2.dav.test1.test2) r r rx �setLogLevelForNamespacer �error�debug�warnrT r| r~ r r r �test_setLogLevel s0 � � � ���z-LogLevelFilterPredicateTests.test_setLogLevelc C s0 t � }| �t|jdt� � | �t|jdd� dS )zP Can't pass invalid log levels to C{setLogLevelForNamespace()}. r� r� N)r r_ r r� rf �r" r r r r �test_setInvalidLogLevel: s ��z4LogLevelFilterPredicateTests.test_setInvalidLogLevelc C s� t � }|�dtj� |�dtj� |�� | �|�d�|j� | �|�d�|j� | �|�d�|j� | �|�d�|j� | �|�d�|j� dS )z& Clearing log levels. r� r� r� r� r� N) r r� r r� r� �clearLogLevelsrT r| r} r� r r r �test_clearLogLevelsO s* � � ���z0LogLevelFilterPredicateTests.test_clearLogLevelsc s t � � � �dtj� � �dtj� � �dtj� dtdtdtddf� �fd d � }|dtjtj � |t td�tjtj � |dtjtj � |t td�tjtj � |dtjtj � |dtjtj � |dtjtj � |dtjtj � |dtj tj � |t td�tj tj � |ddtj � dS ) zC Events are filtered based on log level/namespace. r{ r� r� � namespace�level�expectedResultr Nc s t | |d�}��|� |�� d S )N)� log_namespace� log_level)rH rT )r� r� r� r+ �r r" r r �checkPredicatev s zCLogLevelFilterPredicateTests.test_filtering.<locals>.checkPredicate) r r� r r� r� r� rx r r r3 r r. �critical)r" r� r r� r �test_filteringl s0 ����z+LogLevelFilterPredicateTests.test_filteringrv ) r8 r9 r: rw r� r� r� r� r� r r r r rz s ! rz N)"rw �typingr r r r r �zope.interfacer �zope.interface.exceptionsr �zope.interface.verifyr � constantlyr � twisted.trialr �_filterr r r r � _interfacesr r �_levelsr r � _observerr r �TestCaser rz r r r r �<module> s g test/__pycache__/__init__.cpython-310.pyc 0000644 00000000312 15027667615 0014206 0 ustar 00 o �b� � @ s d Z dS )z# Unit tests for L{twisted.logger}. N)�__doc__� r r �>/usr/lib/python3/dist-packages/twisted/logger/test/__init__.py�<module> s test/__pycache__/test_capture.cpython-310.pyc 0000644 00000002346 15027667615 0015162 0 ustar 00 o �b@ � @ s@ d Z ddlmZmZ ddlmZ ddlmZ G dd� de�ZdS ) z, Test cases for L{twisted.logger._capture}. � )�Logger�LogLevel)�TestCase� )� capturedLogsc @ s e Zd ZdZe� Zddd�ZdS )�LogCaptureTestsz' Tests for L{LogCaptureTests}. �returnNc C s� t � }t� �}| jjd|d� | jjd|d� W d � n1 s!w Y | �t|�dk� | �|d d d� | �|d d tj� | �|d d |� | �|d d d� | �|d d tj� | �|d d |� dS ) z< Events logged within context are captured. zCapture this, please)�foozCapture this too, pleaseNr r � log_format� log_levelr � ) �objectr �log�debug�info� assertTrue�len� assertEqualr )�selfr �captured� r �B/usr/lib/python3/dist-packages/twisted/logger/test/test_capture.py� test_capture s �z LogCaptureTests.test_capture)r N)�__name__� __module__� __qualname__�__doc__r r r r r r r r s r N) r �twisted.loggerr r �twisted.trial.unittestr �_capturer r r r r r �<module> s test/__pycache__/test_logger.cpython-310.pyc 0000644 00000022342 15027667615 0014774 0 ustar 00 o �b � @ s� d Z ddlmZmZmZmZ ddlmZ ddlm Z ddl m Z ddl m Z ddlmZ dd lmZmZ dd lmZmZ dd lmZ G d d � d e�ZG dd� d�ZG dd� de j�ZdS )z+ Test cases for L{twisted.logger._logger}. � )�List�Optional�Type�cast)� implementer)� NamedConstant)�unittest� )� formatEvent)�globalLogPublisher)� ILogObserver�LogEvent)�InvalidLogLevelError�LogLevel��Loggerc @ s2 e Zd ZdZ d dedee deddfdd�ZdS ) � TestLoggerz^ L{Logger} with an overridden C{emit} method that keeps track of received events. N�level�format�kwargs�returnc sl t t�dtdd f� fdd� �}t�|� ztj� ||fi |�� W t�|� nt�|� w |||d�� _d S )N�eventr c s | � _ d S �N�r r ��self� �A/usr/lib/python3/dist-packages/twisted/logger/test/test_logger.py�observer s z!TestLogger.emit.<locals>.observer)r r r ) r r r r � addObserverr �emit�removeObserver�emitted)r r r r r r r r r s �zTestLogger.emitr ) �__name__� __module__� __qualname__�__doc__r r �str�objectr r r r r r s �����r c @ s< e Zd ZdZe� Zd dee ddfdd�Zdefdd�Z dS ) �LogComposedObjectz3 A regular object, with a logger attached. N�stater c C s || _ d S r �r* )r r* r r r �__init__7 s zLogComposedObject.__init__c C s d| j � d�S )Nz<LogComposedObject �>r+ r r r r �__str__: s zLogComposedObject.__str__r ) r# r$ r% r& r �logr r' r, r. r r r r r) 0 s r) c @ s� e Zd ZdZd dd�Zd dd�Zd dd �Zd d d �Zd d d �Zd dd�Z d dd�Z d dd�Z d dd�Z d dd�Z d dd�Zd dd�Zd d d �Zd d d �ZdS )!� LoggerTestsz Tests for L{Logger}. r Nc C s, d}t |�}| �t|�dt|�� d�� dS )z" repr() on Logger �blearghz<Logger r- N)r � assertEqual�repr)r � namespacer/ r r r � test_reprC s zLoggerTests.test_reprc C s t � }| �|jt� dS )z3 Default namespace is module name. N)r r2 r4 r# �r r/ r r r �test_namespaceDefaultK s z!LoggerTests.test_namespaceDefaultc C s. g }t dttd�t� � | �|d jd� dS )z� Default namespace is C{"<unknown>"} when a logger is created from a context in which is can't be determined automatically and no namespace was specified. zresult.append(Logger())r r z <unknown>N)�exec�dictr �localsr2 r4 )r �resultr r r �test_namespaceOMGItsTooHardR s �z'LoggerTests.test_namespaceOMGItsTooHardc C s� t � }d�|j|jj�}| �tt|j�j |� | �tt t t j�j |� | � tt t t j�j t � | � tt|j�j |� | � t� j � dS )z� Default namespace for classes using L{Logger} as a descriptor is the class name they were retrieved from. z{}.{}N)r) r r$ � __class__r# r2 r r r/ r4 r �assertIs�source� assertIsNoner )r �obj�expectedNamespacer r r �test_namespaceAttribute` s ���z#LoggerTests.test_namespaceAttributec sJ g � G � fdd�d�}|j �d� | �t� �d� | �� d d d� dS )zH When used as a descriptor, the observer is propagated. c s e Zd Zeee� j�d�ZdS )z5LoggerTests.test_descriptorObserver.<locals>.MyObject�r N)r# r$ r% r r r �appendr/ r ��observedr r �MyObject| s rH �hello� r � log_formatN)r/ �infor2 �len)r rH r rF r �test_descriptorObserverv s z#LoggerTests.test_descriptorObserverc C sX t d�}tt|j�}|�d� | �d|j� | �|jd |� t|j�}| �d|� dS )z� On instances that have a L{Logger} class attribute, the C{log_source} key is available to format strings. rI zHello, {log_source}.� log_sourcez!Hello, <LogComposedObject hello>.N) r) r r r/ �error�assertInr r2 r )r rA r/ �stuffr r r �!test_sourceAvailableForFormatting� s z-LoggerTests.test_sourceAvailableForFormattingc C s� t � }t�� D ]t}d}|j|jd�}t||j�}||||jd� | �|jd |� | �|jd |� | �|jd d |� | �t |d�d � | �|j d |� | �|j d |� | �|j d t � | � |j d � | �|j d |� | �t |j �|� qdS )z] Test that log levels and messages are emitted correctly for Logger. z This is a {level_name} message)� level_name)�junkrT r r r rU r zNo event observed.rK � log_level� log_namespacerO N)r r � iterconstantsr �name�getattrr2 r" � assertTrue�hasattrr r# r@ r )r r/ r r �message� logMethodr r r �test_basicLogger� s" �z LoggerTests.test_basicLoggerc sF t t�dtddf� �fdd� ��G �fdd�d�� tt� j��� dS )z> C{log_source} event key refers to the class. r r Nc s �� | d � � d S �NrO �r2 r )�Thingor r r r � � z0LoggerTests.test_sourceOnClass.<locals>.observerc � e Zd Ze� d�ZdS )z.LoggerTests.test_sourceOnClass.<locals>.ThingorD N�r# r$ r% r r/ r rD r r rb � � rb �r r r r r r/ rL r r )rb r r r �test_sourceOnClass� s z LoggerTests.test_sourceOnClassc sL t t�dtddf��fdd� �� G � fdd�d�}|� �tt�j��� dS )zA C{log_source} event key refers to the instance. r r Nc s � � | d �� d S r` ra r )r �thingor r r � rc z3LoggerTests.test_sourceOnInstance.<locals>.observerc rd )z1LoggerTests.test_sourceOnInstance.<locals>.ThingorD Nre r rD r r rb � rf rb rg )r rb r )r r ri r �test_sourceOnInstance� s z!LoggerTests.test_sourceOnInstancec s4 t t�dtddf� fdd� �}t|d�}|�� dS )z5 C{log_source} event key is L{None}. r r Nc s � � | d � d S r` )r@ r r r r r � s z0LoggerTests.test_sourceUnbound.<locals>.observerrD �r r r r rL )r r r/ r r r �test_sourceUnbound� s z LoggerTests.test_sourceUnboundc C sp t � }ztd�� ty |�d� Y nw | �t�}| �t|�d� | �|jd tj� | �|jd d� dS )z? Test that log.failure() emits the right data. zbaloney!�WhoopsrJ r r N) r � RuntimeError�failure�flushLoggedErrorsr2 rM r" r �critical�r r/ �errorsr r r �test_defaultFailure� s � z LoggerTests.test_defaultFailurec C sj t � }|jddtjddd� | �|jd d� | �|jd tj� | �|jd |j� | �|jd � d S ) zQ Make sure that kwargs conflicting with args don't pass through. �*�#z *namespace*z*source*)rK rV rW rO rK rV rW rO N)r �warnr rP r2 r r4 r@ r6 r r r �test_conflictingKwargs� s �z"LoggerTests.test_conflictingKwargsc C s. t � }|�d� | �t�}| �t|�d� dS )zA Test passing in a bogus log level to C{emit()}. z*bogus*rJ N)r r rp r r2 rM rr r r r �test_logInvalidLogLevel� s z#LoggerTests.test_logInvalidLogLevelc s\ t t�dtddf�fdd� ��t t�dtddf� ��fdd� ��t�d�� � jd g d � dS ) zE Tracing keeps track of forwarding to the publisher. r r Nc s � | � d S r r r rD r r � publisher s z)LoggerTests.test_trace.<locals>.publisherc s �� | d � �fg� d S )N� log_tracera r )r/ rz r r r r s z(LoggerTests.test_trace.<locals>.observerrD zHello.)r{ rk r r )r/ r rz r r � test_trace s zLoggerTests.test_trace)r N)r# r$ r% r& r5 r7 r< rC rN rS r_ rh rj rl rt rx ry r| r r r r r0 > s r0 N) r& �typingr r r r �zope.interfacer � constantlyr � twisted.trialr �_formatr �_globalr � _interfacesr r �_levelsr r �_loggerr r r) �TestCaser0 r r r r �<module> s test/__pycache__/test_format.cpython-310.pyc 0000644 00000051567 15027667615 0015020 0 ustar 00 o �bU � @ s0 d Z ddlmZmZmZ z ddlmZ e W n ey! dZY nw ddlm Z ddl m Z m Z m Z ddlmZ ddlmZ d d lmZmZmZmZmZmZ d d lmZ d d lm Z G d d� dej �Z G dd� dej �Z G dd� dej �Z G dd� dej �Z!G dd� d�Z"G dd� de#�Z$G dd� dej �Z%dS )z+ Test cases for L{twisted.logger._format}. � )�AnyStr�Optional�cast)�tzsetN)�Failure)� addTZCleanup�mktime�setTZ)�unittest)�SkipTest� )� eventAsText� formatEvent�formatEventAsClassicLogText� formatTime�formatUnformattableEvent�formatWithCall)�LogEvent)�LogLevelc @ sV e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �Zddd�Z ddd�Z dS )�FormattingTestsz5 Tests for basic event formatting functions. �returnNc s� dt dtdtf� fdd� }� �d|d�� � �d|d�� � �d|d dd �� � �d |d d dd� d�� � �d|d�� � �d|d�� |ddd�}� �d|� ttd��}� �d| d |ddd�� d S ) ac L{formatEvent} will format an event according to several rules: - A string with no formatting instructions will be passed straight through. - PEP 3101 strings will be formatted using the keys and values of the event as named fields. - PEP 3101 keys ending with C{()} will be treated as instructions to call that key (which ought to be a callable) before formatting. L{formatEvent} will always return L{str}, and if given bytes, will always treat its format string as UTF-8 encoded. � logFormat�eventr c s$ | |d< t |�}� �t|�t� |S )N� log_format)r �assertIs�type�str)r r �result��self� �A/usr/lib/python3/dist-packages/twisted/logger/test/test_format.py�format9 s z0FormattingTests.test_formatEvent.<locals>.format� � �abcz{x})�xzno, yes.z{not_called}, {called()}.�noc S � dS )N�yesr r r r r! �<lambda>D � z2FormattingTests.test_formatEvent.<locals>.<lambda>)� not_called�calledu Sánchezs Sánchez�Unable to format events S�nchezs S{a!s}nchez� �)�az Sb'\xe1'nchez�S�nchezs S{a!r}nchezN)r �objectr � assertEqual�assertIn�repr)r r" � maybeResult�xe1r r r! �test_formatEvent' s � z FormattingTests.test_formatEventc C s$ t ddd�}t|�}| �d|� dS )z5 Formatting an event with no format. � r )�foo�barr# N)�dictr r4 �r r r r r r! �test_formatEventNoFormatN s z(FormattingTests.test_formatEventNoFormatc C s8 t t� ddd�}t|�}| �d|� | �t|�|� dS )z: Formatting an event with a bogus format. r: r )r r; r< zLog format must be strN)r= r3 r r5 r6 r> r r r! �test_formatEventWeirdFormatW � z+FormattingTests.test_formatEventWeirdFormatc C s8 t ddd� d�}t|�}| �d|� | �t|�|� dS )zF Formatting an event that's just plain out to get us. �{evil()}c S � dd S �Nr: r r r r r r! r* e � z?FormattingTests.test_formatUnformattableEvent.<locals>.<lambda>�r �evilr. N)r= r r5 r6 r> r r r! � test_formatUnformattableEventa rA z-FormattingTests.test_formatUnformattableEventc C sL ddddd� t tt� �di}t|�}| �d|� | �d|� | �d |� d S ) zR Formatting an unformattable event that has an unformattable key. r rB rG c S rC rD r r r r r! r* q rE zSFormattingTests.test_formatUnformattableEventWithUnformattableKey.<locals>.<lambda>�gurk�*MESSAGE LOST: unformattable object logged:�Recoverable data:� Exception during formatting:N)r r � Unformattabler r5 r> r r r! �1test_formatUnformattableEventWithUnformattableKeyk s � zAFormattingTests.test_formatUnformattableEventWithUnformattableKeyc C sD t ddd� t� d�}t|�}| �d|� | �d|� | �d|� dS ) �T Formatting an unformattable event that has an unformattable value. rB c S rC rD r r r r r! r* rE zUFormattingTests.test_formatUnformattableEventWithUnformattableValue.<locals>.<lambda>)r rG rI rJ rK rL N)r= rM r r5 r> r r r! �3test_formatUnformattableEventWithUnformattableValuey s � zCFormattingTests.test_formatUnformattableEventWithUnformattableValuec C sP t ddd� dd�}t|ttt� ��}| �d|� | �td�d td� |� d S ) rO rB c S rC rD r r r r r! r* � rE zbFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop.<locals>.<lambda>�okay)r rG � recoverablerJ rR z = N)r= r r � BaseExceptionrM r5 r6 r> r r r! �@test_formatUnformattableEventWithUnformattableErrorOMGWillItStop� s � zPFormattingTests.test_formatUnformattableEventWithUnformattableErrorOMGWillItStop�r N) �__name__� __module__� __qualname__�__doc__r9 r? r@ rH rN rP rT r r r r! r " s ' r c @ sL e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �Zddd�Z dS )�TimeFormattingTestsz. Tests for time formatting functions. r Nc C s t | � d S )N)r r r r r! �setUp� � zTimeFormattingTests.setUpc sb t du rtd��dtdtdtddf� fdd� }|d d d � |d d d� |ddd� |ddd� dS )z� Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. N�:Platform cannot change timezone; unable to verify offsets.�name� expectedDST� expectedSTDr c s< t | � td�}td�}� �t|�|� � �t|�|� d S )N) i� � � r r r � � r: ) i� r: � r r r r re r )r r r4 r )r^ r_ r` �localDST�localSTDr r r! �testForTimeZone� s zMTimeFormattingTests.test_formatTimeWithDefaultFormat.<locals>.testForTimeZone�UTC+00z2006-06-30T00:00:00+0000z2007-01-31T00:00:00+0000zEST+05EDT,M4.1.0,M10.5.0z2006-06-30T00:00:00-0400z2007-01-31T00:00:00-0500zCEST-01CEDT,M4.1.0,M10.5.0z2006-06-30T00:00:00+0200z2007-01-31T00:00:00+0100zCST+06z2006-06-30T00:00:00-0600z2007-01-31T00:00:00-0600)r r r )r rh r r r! � test_formatTimeWithDefaultFormat� s. ����z4TimeFormattingTests.test_formatTimeWithDefaultFormatc C s( | � td�d� | � tddd�d� dS )zL If C{when} argument is L{None}, we get the default output. N�-�!)�default�r4 r r r r r! �test_formatTimeWithNoTime� s z-TimeFormattingTests.test_formatTimeWithNoTimec C s6 t d�}| �t|dd�d� | �t|ddd�d� dS )zR If C{timeFormat} argument is L{None}, we get the default output. � i� � � � �( �/ r: i r: N�� timeFormatrk rl )rw rm �r r4 r �r �tr r r! �test_formatTimeWithNoFormat� s z/TimeFormattingTests.test_formatTimeWithNoFormatc C s t d�}| �t|dd�d� dS )z2 Alternate time format in output. rp z%Y/%Wrv z2013/38Nrx ry r r r! �&test_formatTimeWithAlternateTimeFormat� s z:TimeFormattingTests.test_formatTimeWithAlternateTimeFormatc C s | � tddd�d� dS )z0 "%f" supported in time format. g�?x��.Az%frv �234560Nrn r r r r! �test_formatTimePercentF� s z+TimeFormattingTests.test_formatTimePercentFrU ) rV rW rX rY r[ rj ro r{ r| r~ r r r r! rZ � s - rZ c @ s~ e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �Zddd�Z ddd�Z ddd�Z ddd�Z ddd�Z ddd�ZdS )�ClassicLogFormattingTestsz@ Tests for classic text log event formatting functions. r Nc C sH t du rtd��t| � td� td�}td|d�}| �t|�d� dS )z� Time is first field. Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. Nr] ri rp �XYZZY�r �log_timez%2013-09-24T11:40:47+0000 [-#-] XYZZY )r r r r r r= r4 r )r rz r r r r! �test_formatTimeDefault� s �z0ClassicLogFormattingTests.test_formatTimeDefaultc C s: dt t dtfdd�}tddd�}| �t||d�d � d S ) zc Time is first field. Custom formatting function is an optional argument. rz r c S s d| � d�S )N�__r )rz r r r! r r\ zCClassicLogFormattingTests.test_formatTimeCustom.<locals>.formatTimer� i90 r� )r z__12345__ [-#-] XYZZY N)r �floatr r= r4 r )r r r r r r! �test_formatTimeCustom s �z/ClassicLogFormattingTests.test_formatTimeCustomc C � t ddd�}| �t|�d� dS )z: Namespace is first part of second field. r� � my.namespace)r � log_namespacez- [my.namespace#-] XYZZY N�r= r4 r �r r r r r! �test_formatNamespace � �z.ClassicLogFormattingTests.test_formatNamespacec C s" t dtjd�}| �t|�d� dS )z7 Level is second part of second field. r� )r � log_levelz- [-#warn] XYZZY N�r= r �warnr4 r r� r r r! �test_formatLevel � �z*ClassicLogFormattingTests.test_formatLevelc C r� )z) System is second field. r� � S.Y.S.T.E.M.�r � log_system�- [S.Y.S.T.E.M.] XYZZY Nr� r� r r r! �test_formatSystem# r� z+ClassicLogFormattingTests.test_formatSystemc C s& t ddtjdd�}| �t|�d� dS )�B System is not supplanted by namespace and level. r� r� r� )r r� r� r� r� Nr� r� r r r! �test_formatSystemRulz- s ��z/ClassicLogFormattingTests.test_formatSystemRulzc C s" t dt� d�}| �t|�d� dS )r� r� r� z- [UNFORMATTABLE] XYZZY N)r= rM r4 r r� r r r! � test_formatSystemUnformattable< r� z8ClassicLogFormattingTests.test_formatSystemUnformattablec C r� )z0 Formatted event is last field. zid:{id}�123�r �idz- [-#-] id:123 Nr� r� r r r! �test_formatFormatF r� z+ClassicLogFormattingTests.test_formatFormatc C s t dd�}| �t|�d� dS )z# No format string. r� )r� N�r= r r r� r r r! �test_formatNoFormatP s z-ClassicLogFormattingTests.test_formatNoFormatc C s t ddd�}| �t|�d� dS )z& Empty format string. r# r� r� Nr� r� r r r! �test_formatEmptyFormatW s z0ClassicLogFormattingTests.test_formatEmptyFormatc C s t dd�}| �t|�d� dS )zO If the formatted event has newlines, indent additional lines. z"XYZZY A hollow voice says: "Plugh")r z-- [-#-] XYZZY A hollow voice says: "Plugh" Nr� r� r r r! �test_formatFormatMultiLine^ s �z4ClassicLogFormattingTests.test_formatFormatMultiLinerU )rV rW rX rY r� r� r� r� r� r� r� r� r� r� r� r r r r! r � s r c @ s e Zd ZdZddd�ZdS )�FormatFieldTestsz+ Tests for format field functions. r Nc C s> | � tdtddd� d��d� | � tdtdd� d ��d � d S ) z� L{formatWithCall} is an extended version of L{str.format} that will interpret a set of parentheses "C{()}" at the end of a format key to mean that the format key ought to be I{called} rather than stringified. zHello, {world}. {callme()}.�earthc S r( )N�mayber r r r r! r* x r+ z6FormatFieldTests.test_formatWithCall.<locals>.<lambda>)�world�callmezHello, earth. maybe.zHello, {repr()!r}.c S r( )Nr6 r r r r r! r* } r+ )r6 zHello, 'repr'.N)r4 r r= r r r r! �test_formatWithCalln s ���z$FormatFieldTests.test_formatWithCallrU )rV rW rX rY r� r r r r! r� i s r� c @ s e Zd ZdZdefdd�ZdS )rM z> An object that raises an exception from C{__repr__}. r c C s t dd �S rD )r r r r r! �__repr__� r\ zUnformattable.__repr__N)rV rW rX rY r r� r r r r! rM � s rM c @ s e Zd ZdZdS )� CapturedErrorz3 A captured error for use in format tests. N)rV rW rX rY r r r r! r� � s r� c @ s� e Zd ZdZd dd�Zd dd�Zd dd �Zd d d �Zd d d �Zd dd�Z d dd�Z d dd�Z d dd�Z d dd�Z d dd�Zd dd�Zd d d �ZdS ) �EventAsTextTestszi Tests for L{eventAsText}, all of which ensure that the returned type is UTF-8 decoded text. r Nc C sd zt d�� t y t� }Y nw ddi}||d< t|ddd�}| �t|�� �|� | �d|� dS ) zT An event with a C{log_failure} key will have a traceback appended. �This is a fake errorr �This is a test log message� log_failureTF��includeTimestamp� includeSystemN�r� r r r5 r � getTraceback�r �fr � eventTextr r r! �test_eventWithTraceback� s �z(EventAsTextTests.test_eventWithTracebackc C sd zt d�� t y t� }Y nw ddi}||d< t|ddd�}| �t|�� �|� | �d|� dS ) zu An event with an empty C{log_format} key appends a traceback from the accompanying failure. r� r r# r� TFr� Nr� r� r r r! �"test_formatEmptyEventWithTraceback� s �z3EventAsTextTests.test_formatEmptyEventWithTracebackc C sv zt d�� t y t� }Y nw ddd� d�}||d< t|ddd �}| �|t� | �t|�� �|� | �d|� d S ) zw An event with an unformattable value in the C{log_format} key still has a traceback appended. r� rB c S rC rD r r r r r! r* � rE zHEventAsTextTests.test_formatUnformattableWithTraceback.<locals>.<lambda>rF r� TFr� N)r� r r �assertIsInstancer r5 r� r� r r r! �%test_formatUnformattableWithTraceback� s �� z6EventAsTextTests.test_formatUnformattableWithTracebackc C s� zt d�� t y t� }Y nw ddddd� ttt� �di}||d< t|d d d �}| �|t� | �d |� | �t|�� �|� | �d|� d S )z� An event with an unformattable value in the C{log_format} key, that throws an exception when __repr__ is invoked still has a traceback appended. r� r rB rG c S rC rD r r r r r! r* � rE zMEventAsTextTests.test_formatUnformattableErrorWithTraceback.<locals>.<lambda>rI r� TFr� z MESSAGE LOSTN) r� r r r rM r r� r5 r� r� r r r! �*test_formatUnformattableErrorWithTraceback� s � � z;EventAsTextTests.test_formatUnformattableErrorWithTracebackc C s< ddi}t � |d< t|ddd�}| �|t� | �d|� dS ) zk If a traceback cannot be appended, a message indicating this is true is appended. r r# r� TFr� z'(UNABLE TO OBTAIN TRACEBACK FROM EVENT)N)r3 r r� r r5 �r r r� r r r! �&test_formatEventUnformattableTraceback� s z7EventAsTextTests.test_formatEventUnformattableTracebackc C s2 ddi}t |ddd�}| �|t� | �d|� dS )zY An event with no C{log_failure} key will not have a traceback appended. r r� TFr� N)r r� r r5 r� r r r! �test_formatEventNonCritical� s z,EventAsTextTests.test_formatEventNonCriticalc C s\ zt d�� t y t� }Y nw ddi}||d< t|ddd�}| �d|� | �d|� d S ) zU An exception message with multibyte characters is properly handled. u €r r� r� TFr� � TracebackN�r� r r r5 r� r r r! � test_formatTracebackMultibyte� s � z.EventAsTextTests.test_formatTracebackMultibytec C s\ zt d�� t y t� }Y nw ddi}||d< t|ddd�}| �d|� | �d |� d S ) zj An error raised attempting to decode the UTF still produces a valid log message. s ��t e s t r r� r� TFr� r� z.CapturedError(b"\xff\xfet\x00e\x00s\x00t\x00")Nr� r� r r r! �,test_formatTracebackHandlesUTF8DecodeFailure s � z=EventAsTextTests.test_formatTracebackHandlesUTF8DecodeFailurec C s^ zt d�� t y t� }Y nw td�}dd|d�}||d< t|dddd �}| �|d � d S ) zq If includeSystem is specified as the only option no timestamp or traceback are printed. r� rp �ABCD� fake_system�r r� r� r� FT�r� �includeTracebackr� z[fake_system] ABCDN�r� r r r r4 �r r� rz r r� r r r! �test_eventAsTextSystemOnly s* ����z+EventAsTextTests.test_eventAsTextSystemOnlyc C s~ t du rtd��t| � td� ztd�� ty t� }Y nw td�}dd|d�}||d < t|d d d d �}| �|d � dS )zq If includeTimestamp is specified as the only option no system or traceback are printed. Nr] ri r� rp r� r� r� r� TFr� z 2013-09-24T11:40:47+0000 ABCD) r r r r r� r r r r4 r� r r r! � test_eventAsTextTimestampOnly0 s2 ����z.EventAsTextTests.test_eventAsTextTimestampOnlyc C s\ zt d�� t y t� }Y nw td�}d|d�}||d< t|dddd�}| �|d � d S ) z\ If includeSystem is specified with a missing system [-#-] is used. r� rp r� r� r� FTr� z [-#-] ABCDNr� r� r r r! � test_eventAsTextSystemMissingR s( ����z.EventAsTextTests.test_eventAsTextSystemMissingc C sb zt d�� t y t� }Y nw td�}d|tjdd�}||d< t|dddd �}| �|d � d S ) z� If includeSystem is specified with a missing system but namespace and level are present they are used. r� rp r� �test)r r� r� r� r� FTr� z[test#info] ABCDN�r� r r r �infor r4 r� r r r! �.test_eventAsTextSystemMissingNamespaceAndLevelm s, ����z?EventAsTextTests.test_eventAsTextSystemMissingNamespaceAndLevelc C s` zt d�� t y t� }Y nw td�}d|tjd�}||d< t|dddd�}| �|d � d S ) zv If includeSystem is specified with a missing system but level is present, level is included. r� rp r� )r r� r� r� FTr� z [-#info] ABCDNr� r� r r r! �&test_eventAsTextSystemMissingLevelOnly� s* ����z7EventAsTextTests.test_eventAsTextSystemMissingLevelOnlyrU )rV rW rX rY r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r! r� � s " r� )&rY �typingr r r �timer � ImportError�twisted.python.failurer �!twisted.python.test.test_tzhelperr r r � twisted.trialr �twisted.trial.unittestr �_formatr r r r r r � _interfacesr �_levelsr �TestCaser rZ r r� rM � Exceptionr� r� r r r r! �<module> s. � tR test/__pycache__/test_stdlib.cpython-310.pyc 0000644 00000021400 15027667615 0014770 0 ustar 00 o �b�! � @ s& d Z ddlZddlZddlmZ ddlmZmZ ddlm Z m Z m Z m Z ddl mZmZmZ ddlmZ ddlmZ dd lmZ dd lmZ dd lmZ d d lm Z m Z d dl m Z d dl m!Z! deee" e#f fdd�Z$G dd� d�Z%G dd� dej&�Z'dee ef fdd�Z(G dd� dej)�Z*dS )z+ Test cases for L{twisted.logger._format}. � N)� getsourcefile)�BytesIO� TextIOWrapper)� Formatter� LogRecord� StreamHandler� getLogger)�List�Optional�Tuple)�BrokenMethodImplementation)� verifyObject)� currentframe)�Failure)�unittest� )� ILogObserver�LogEvent)�LogLevel)�STDLibLogObserver�returnc C s& t d�} ttj| jd �| jd fS )z� Retrive the file name and line number immediately after where this function is called. @return: the file name and line number � �__name__)r r �sys�modules� f_globals�f_lineno)�caller� r �A/usr/lib/python3/dist-packages/twisted/logger/test/test_stdlib.py�nextLine s �r c @ s2 e Zd ZdZd dd�Zd dd�Zdefdd �ZdS ) �StdlibLoggingContainerzF Continer for a test configuration of stdlib logging objects. r Nc C sZ t d�| _| j�� | _| j�tj� t� | _| j� | j� t � \| _ | _ | j� | j � d S )N� ) r � rootLogger�getEffectiveLevel� originalLevel�setLevel� py_logging�DEBUG�BufferedHandler�bufferedHandler� addHandler�handlerAndBytesIO� streamHandler�output��selfr r r �__init__- s z StdlibLoggingContainer.__init__c C sB | j �| j� | j �| j� | j �| j� | j�� | j�� dS )z# Close the logger. N)r# r& r% � removeHandlerr* r- �closer. r/ r r r r3 9 s z StdlibLoggingContainer.closec C s | j �� �d�S )zd Get the output to the underlying stream as text. @return: the output text �utf-8)r. �getvalue�decoder/ r r r � outputAsTextC s z#StdlibLoggingContainer.outputAsText�r N)r � __module__� __qualname__�__doc__r1 r3 �strr7 r r r r r! ( s r! c @ s� e Zd ZdZddd�Zdefdd�Zdedee e e f fd d �Z dd d �Z dd d�Zddd�Zddd�Zddd�Zddd�Zddd�Zddd�ZdS ) �STDLibLogObserverTestsz) Tests for L{STDLibLogObserver}. r Nc C sH t � }ztt|� W dS ty# } z | �|� W Y d}~dS d}~ww )z= L{STDLibLogObserver} is an L{ILogObserver}. N)r r r r �fail)r0 �observer�er r r �test_interfaceQ s ��z%STDLibLogObserverTests.test_interfacec C s t � }| �|j� |S )zj Create a logging object we can use to test with. @return: a stdlib-style logger )r! � addCleanupr3 )r0 �loggerr r r � py_logger[ s z STDLibLogObserverTests.py_logger�eventsc G s: | � � }ttjd d�}|D ]}||� q|jj|�� fS )z� Send one or more events to Python's logging module, and capture the emitted L{LogRecord}s and output stream as a string. @param events: events @return: a tuple: (records, output) r )� stackDepth)rD r �defaultStackDepthr* �recordsr7 )r0 rE �plr? �eventr r r �logEvente s �� z STDLibLogObserverTests.logEventc C s4 | � i �\}}| �t|�d� | �|d jd� dS )z Logger name. r r �twistedN)rK � assertEqual�len�name�r0 rH r. r r r � test_name{ s z STDLibLogObserverTests.test_namec C s� dt jtjt jtjt jtjt jtjt j tj t j i}g }|� � D ]\}}i }|dur-||d< t |�|d< |�|� q | j|� \}}| �t|�t|�� tt|��D ]}| �|| j|| d � qPdS )z Log levels. N� log_level� py_levelno)r' �INFOr �debugr( �info�warn�WARNING�error�ERROR�critical�CRITICAL�items�int�appendrK rM rN �range�levelno) r0 � levelMappingrE �level�pyLevelrJ rH r. �ir r r � test_levels� s& � �z"STDLibLogObserverTests.test_levelsc C s` t � \}}| �i �\}}| �t|�d� | �|d j|� | �|d j|� | �|d j� dS )zb C{pathname}, C{lineno}, C{exc_info}, C{func} is set properly on records. r r N)r rK rM rN �pathname�lineno� assertIsNone�exc_info)r0 �filename�logLinerH r. r r r �test_callerInfo� s z&STDLibLogObserverTests.test_callerInfoc C sV t ddd�}| �|�\}}| �t|�d� | �t|d j�d� | �|d jd� dS ) zL Basic formattable event passes the format along correctly. � Hello, {who}!�dude�� log_format�whor r z Hello, dude!r N)�dictrK rM rN r< �msg�args�r0 rJ rH r. r r r �test_basicFormat� s z'STDLibLogObserverTests.test_basicFormatc C sD t ddd�}| �|�\}}| �t|�d� | �|�d�t|�� dS )z< Basic formattable event renders correctly. rn ro rp r z:Hello, dude! N)rs rK rM rN � assertTrue�endswith�reprrv r r r �test_basicFormatRendered� s z/STDLibLogObserverTests.test_basicFormatRenderedc C s8 | � i �\}}| �t|�d� | �t|d j�d� dS )z' Event with no format. r r r" N)rK rM rN r< rt rP r r r � test_noFormat� s z$STDLibLogObserverTests.test_noFormatc C s� d dd�}z|� W n t y t� }Y nw tdd|d�}| �|�\}}| �t|�d� | �d|� | �d |� | �d |� dS ) zK An event with a failure logs the failure details as well. r Nc S � dd d S �Nr r r r r r r � failing_func� � z9STDLibLogObserverTests.test_failure.<locals>.failing_func�Hi mom�me�rq rr � log_failurer �in failing_func�ZeroDivisionErrorr8 )r� r rs rK rM rN �assertIn�r0 r �failurerJ rH r. r r r � test_failure� s � z#STDLibLogObserverTests.test_failurec C s� d dd�}z|� W n t y t� }|�� Y nw tdd|d�}| �|�\}}| �t|�d� | �d|� | �d |� | �d |� dS ) z� A cleaned Failure object has a fake traceback object; make sure that logging such a failure still results in the exception details being logged. r Nc S r} r~ r r r r r r � r� z@STDLibLogObserverTests.test_cleanedFailure.<locals>.failing_funcr� r� r� r r� r� r8 )r� r � cleanFailurers rK rM rN r� r� r r r �test_cleanedFailure� s � z*STDLibLogObserverTests.test_cleanedFailurer8 )r r9 r: r; rA r! rD r r r r r< rK rQ rf rm rw r{ r| r� r� r r r r r= L s # r= c C s< t � } tj}t| ddd�}t|�}t|�}|�|� || fS )z� Construct a 2-tuple of C{(StreamHandler, BytesIO)} for testing interaction with the 'logging' module. @return: handler and io object r4 � )�encoding�newline)r r' � BASIC_FORMATr r r � setFormatter)r. �template�stream� formatter�handlerr r r r, s r, c @ s, e Zd ZdZd dd�Zdeddfdd�ZdS ) r) zN A L{py_logging.Handler} that remembers all logged records in a list. r Nc C s t j�| � g | _dS )z5 Initialize this L{BufferedHandler}. N)r' �Handlerr1 rH r/ r r r r1 s zBufferedHandler.__init__�recordc C s | j �|� dS )z& Remember the record. N)rH r_ )r0 r� r r r �emit s zBufferedHandler.emitr8 )r r9 r: r; r1 r r� r r r r r) s r) )+r; �loggingr' r �inspectr �ior r r r r r �typingr r r �zope.interface.exceptionsr �zope.interface.verifyr �twisted.python.compatr �twisted.python.failurer � twisted.trialr � _interfacesr r �_levelsr �_stdlibr r< r^ r r! �TestCaser= r, r� r) r r r r �<module> s* $ 9 test/__pycache__/test_util.cpython-310.pyc 0000644 00000006564 15027667615 0014502 0 ustar 00 o �b� � @ sZ d Z ddlmZ ddlmZ ddlmZmZ ddlm Z ddl m Z G dd � d ej �Z d S ) z) Test cases for L{twisted.logger._util}. � )� implementer)�unittest� )� ILogObserver�LogEvent)� LogPublisher)� formatTracec @ s$ e Zd ZdZddd�Zddd�ZdS ) � UtilTestsz Utility tests. �returnNc s� t � �tg d�� tt�dtddfdd���tt�dtddf� ����fdd� ��tt�dtddf� �����fd d � ������ ���� ���� �� � dS ) zJ Tracing keeps track of forwarding done by the publisher. �� log_trace�er Nc S � d S �N� �r r r �?/usr/lib/python3/dist-packages/twisted/logger/test/test_util.py�o1 � z UtilTests.test_trace.<locals>.o1c s, �� | � � ��| d ��f��fg� d S �Nr ��assertIs� assertEqualr )�eventr �o2� publisher�selfr r r ! s ��z UtilTests.test_trace.<locals>.o2c s2 �� | � � ��| d ��f��f��fg� d S r r r �r r r �o3r r r r r - s ��z UtilTests.test_trace.<locals>.o3)r �dictr r r � addObserver)r r r r � test_trace s " zUtilTests.test_tracec s t g d�� tt�dtddfdd���tt�dtddfdd���tt�dtddfd d ���tt�dtddfd d ���tt�dtddfd d���d�_d�_d�_d�_d�_tt�dtddf� ��������� � f dd� �}|�t���t�����d�_d�_t������ d� _� � � dS )z) Format trace as string. r r r Nc S r r r r r r r r D r z&UtilTests.test_formatTrace.<locals>.o1c S r r r r r r r r H r z&UtilTests.test_formatTrace.<locals>.o2c S r r r r r r r r L r z&UtilTests.test_formatTrace.<locals>.o3c S r r r r r r r �o4P r z&UtilTests.test_formatTrace.<locals>.o4c S r r r r r r r �o5T r z&UtilTests.test_formatTrace.<locals>.o5zroot/o1z root/p1/o2z root/p1/o3z root/p1/p2/o4zroot/o5c s@ � � | � � t| d �}� �|dj� ��������d� � d S )Nr z�{root} ({root.name}) -> {o1} ({o1.name}) -> {p1} ({p1.name}) -> {o2} ({o2.name}) -> {o3} ({o3.name}) -> {p2} ({p2.name}) -> {o4} ({o4.name}) -> {o5} ({o5.name}) -> {oTest} ) �rootr r r r" r# �p1�p2�oTest)r r r �format)r �trace� r r r r r" r# r' r% r& r$ r r r � testObserver^ s" ��z0UtilTests.test_formatTrace.<locals>.testObserverz root/p1/p2/zroot/p1/zroot/)r r r r �namer )r r+ r r* r �test_formatTrace> s4 , zUtilTests.test_formatTrace)r N)�__name__� __module__� __qualname__�__doc__r! r- r r r r r s )r N)r1 �zope.interfacer � twisted.trialr � _interfacesr r � _observerr �_utilr �TestCaser r r r r �<module> s test/__pycache__/test_io.cpython-310.pyc 0000644 00000021457 15027667615 0014132 0 ustar 00 o �b�" � @ s� d Z ddlZddlmZmZ ddlmZ ddlmZ ddl m Z ddl m Z m Z dd lmZ dd lmZ dd lmZ dd lmZ ee �G d d� de��ZG dd� de j�ZdS )z' Test cases for L{twisted.logger._io}. � N)�List�Optional)� implementer)� NamedConstant)�unittest� )� ILogObserver�LogEvent)� LoggingFile)�LogLevel)�Logger)� LogPublisherc sP e Zd ZdZejdfdededee ddf� fdd� Z d e ddfd d �Z � Z S ) �TestLoggingFilezU L{LoggingFile} that is also an observer which captures events and messages. N�logger�level�encoding�returnc s" t � j|||d� g | _g | _d S )N�r r r )�super�__init__�events�messages)�selfr r r �� __class__� �=/usr/lib/python3/dist-packages/twisted/logger/test/test_io.pyr s zTestLoggingFile.__init__�eventc C s, | j �|� d|v r| j�|d � d S d S )N�log_io)r �appendr )r r r r r �__call__' s �zTestLoggingFile.__call__)�__name__� __module__� __qualname__�__doc__r �infor r r �strr r r � __classcell__r r r r r s ����� r c @ s� e Zd ZdZd0dd�Zd0dd�Zd0dd �Zd0d d �Zd0d d �Zd0dd�Z d0dd�Z d0dd�Z d0dd�Z d0dd�Z d0dd�Zd0dd�Zd0d d �Zd0d d �Zd0d d!�Zd0d"d#�Zd0d$d%�Zd0d&d'�Zd0d(d)�Zd0d*d+�Zejdfd,ed-ee de fd.d/�Z dS )1�LoggingFileTestsz# Tests for L{LoggingFile}. r Nc C s t � | _t| jd�| _dS )zK Create a logger for test L{LoggingFile} instances to use. ��observerN)r � publisherr r )r r r r �setUp2 s zLoggingFileTests.setUpc C sf | � t| j�jd� | �| jg�}| � t|�d� | � |d d t� d}| � |d d d| � dS )z0 L{LoggingFile.softspace} is 0. r � �categoryz(twisted.logger._io.LoggingFile.softspace�messagez#%s was deprecated in Twisted 21.2.0N)� assertEqualr r � softspace� flushWarnings�test_softspace�len�DeprecationWarning)r � warningsShown�deprecatedClassr r r r3 9 s �z LoggingFileTests.test_softspacec C sj t | j�}| �tt|dd� | �tt|dd� | �tt|dd� | �tt|ddg� | �tt|d d � d S ) z? Some L{LoggingFile} attributes are read-only. �closedTr �utf-8�mode�r�newlines� �name�fooN)r r � assertRaises�AttributeError�setattr�r �fr r r �test_readOnlyAttributesH s z(LoggingFileTests.test_readOnlyAttributesc C s~ t | j�}| �t|j� | �t|j� | �t|j� | �t|j� | �t|j� | �t|j � | �t|j � | �t|j � dS )z> Some L{LoggingFile} methods are unsupported. N) r r r@ �IOError�read�next�readline� readlines� xreadlines�seek�tell�truncaterC r r r �test_unsupportedMethodsT s z(LoggingFileTests.test_unsupportedMethodsc C s> t | j�}| �|jtj� t | jtjd�}| �|jtj� dS )z? Default level is L{LogLevel.info} if not set. �r N)r r r0 r r r% �errorrC r r r � test_levelc s zLoggingFileTests.test_levelc C s< t | j�}| �|jt�� � t | jdd�}| �|jd� dS )zM Default encoding is C{sys.getdefaultencoding()} if not set. r9 �r N)r r r0 r �sys�getdefaultencodingrC r r r � test_encodingm s z LoggingFileTests.test_encodingc C � t | j�}| �|jd� dS )z* Reported mode is C{"w"}. �wN)r r r0 r: rC r r r � test_modew � zLoggingFileTests.test_modec C s t | j�}| �|j� dS )z7 The C{newlines} attribute is L{None}. N)r r � assertIsNoner< rC r r r � test_newlines~ s z LoggingFileTests.test_newlinesc C rW )z1 The C{name} attribute is fixed. z.<LoggingFile twisted.logger.test.test_io#info>N)r r r0 r> rC r r r � test_name� rZ zLoggingFileTests.test_namec C s2 t | j�}|�� | �|j� | �t|jd� dS )z7 L{LoggingFile.close} closes the file. �HelloN)r r �close� assertTruer8 r@ � ValueError�writerC r r r � test_close� s zLoggingFileTests.test_closec C s t | j�}|�� dS )z4 L{LoggingFile.flush} does nothing. N)r r �flushrC r r r � test_flush� s zLoggingFileTests.test_flushc C s t | j�}| �|�� d� dS )z6 L{LoggingFile.fileno} returns C{-1}. ���N)r r r0 �filenorC r r r � test_fileno� s z LoggingFileTests.test_filenoc C s t | j�}| �|�� � dS )z9 L{LoggingFile.isatty} returns C{False}. N)r r � assertFalse�isattyrC r r r � test_isatty� rZ z LoggingFileTests.test_isattyc C �Z | � � }|�d� | �|jg � |�d� | �|jdg� |�d� | �|jg d�� dS )z, Writing buffers correctly. r^ z , world! � Hello, world!z It's nice to meet you. Indeed.�rm zIt's nice to meet you.� N�� observedFilerb r0 r rC r r r �test_writeBuffering� s �z$LoggingFileTests.test_writeBufferingc C �* | j dd�}|�d� | �|jdg� dS )z, Bytes are decoded to text. r9 rS s Hello, Mr. Sánchez � Hello, Mr. SánchezNrp rC r r r �test_writeBytesDecoded� � z'LoggingFileTests.test_writeBytesDecodedc C rs )z( Unicode is unmodified. r9 rS u Hello, Mr. Sánchez rt Nrp rC r r r �test_writeUnicode� rv z"LoggingFileTests.test_writeUnicodec C s� | � � }|�d� | �t|j�d� | �|jd d tj� | j tjd�}|�d� | �t|j�d� | �|jd d tj� dS )z0 Log level is emitted properly. �Hello r- r � log_levelrP N)rq rb r0 r4 r r r% rQ rC r r r �test_writeLevel� s z LoggingFileTests.test_writeLevelc C s> | � � }|�d� | �t|j�d� | �|jd d d� dS )z/ Log format is C{"{message}"}. rx r- r � log_formatz{log_io}N)rq rb r0 r4 r rC r r r �test_writeFormat� s z!LoggingFileTests.test_writeFormatc C rl )z6 C{writelines} does not add newlines. )r^ z, ro )zworld! rm )zIt's nice to meet you. zIndeed.rn N)rq � writelinesr0 r rC r r r �test_writelinesBuffering� s �z)LoggingFileTests.test_writelinesBufferingc C s> | � � }| �td|� tddd� td� | �|jdg� dS )z; L{LoggingFile} can replace L{sys.stdout}. �stdoutzHello,� )�endzworld.z Hello, world.N)rq �patchrT �printr0 r rC r r r � test_print� s zLoggingFileTests.test_printr r c sH g � t t�dtddf� fdd� �}t|d�}� �t|||d�� � d S ) a� Construct a L{LoggingFile} with a built-in observer. @param level: C{level} argument to L{LoggingFile} @param encoding: C{encoding} argument to L{LoggingFile} @return: a L{TestLoggingFile} with an observer that appends received events into the file's C{events} attribute (a L{list}) and event messages into the file's C{messages} attribute (a L{list}). r r Nc s � d | � d S )Nr r )r �� loggingFilesr r r* s z/LoggingFileTests.observedFile.<locals>.observerr) r r )r r r r r r )r r r r* �logr r� r rq s z LoggingFileTests.observedFile)r N) r! r" r# r$ r, r3 rE rO rR rV rY r\ r] rc re rh rk rr ru rw rz r| r~ r� r r% r r r& r rq r r r r r( - s> ����r( )r$ rT �typingr r �zope.interfacer � constantlyr � twisted.trialr � _interfacesr r �_ior �_levelsr �_loggerr � _observerr r �TestCaser( r r r r �<module> s test/__pycache__/test_global.cpython-310.pyc 0000644 00000030055 15027667615 0014755 0 ustar 00 o �b�1 � @ s� d Z ddlZddlmZmZmZmZmZmZm Z m Z ddl m Z ddl mZ ddlmZ ddlmZmZ dd lmZmZ dd lmZ dd lmZ dd lm Z dd l m Z dej dee dee ddfdd�Z G dd� dej �Z!dS )z+ Test cases for L{twisted.logger._global}. � N)�IO�Any�List�Optional�TextIO�Tuple�Type�cast)�Failure)�unittest� )�textFileLogObserver)�MORE_THAN_ONCE_WARNING� LogBeginner)� ILogObserver�LogEvent)�LogLevel)�Logger)� LogPublisher)�nextLine�test� actualEvents�expectedEvents�returnc st t |�t |�kr| �||� t� � |D ] }� t|�� �O � qdtdtf� fdd� ��fdd�|D �}| �||� dS )a7 Compare two sequences of log events, examining only the the keys which are present in both. @param test: a test case doing the comparison @param actualEvents: A list of log events that were emitted by a logger. @param expectedEvents: A list of log events that were expected by a test. �eventr c s, | � � }| �� D ] }|� vr|�|� q|S �N)�copy�keys�pop)r r �key)� allMergedKeys� �A/usr/lib/python3/dist-packages/twisted/logger/test/test_global.py�simplify* s �z compareEvents.<locals>.simplifyc s g | ]}� |��qS r! r! ��.0r )r# r! r" � <listcomp>1 s z!compareEvents.<locals>.<listcomp>N)�len� assertEqual�setr r )r r r r �simplifiedActualr! )r r# r" � compareEvents s r+ c @ s� e Zd ZdZd"dd�Zd"dd�Zd"dd �Zd ed eddfd d �Z d"dd�Z d"dd�Z d"dd�Z d"dd�Z d"dd�Zd"dd�Zd"dd�Zd"d d �Zd"d d �Zd"d d!�ZdS )#�LogBeginnerTestsz# Tests for L{LogBeginner}. r Nc C sZ t � | _t�� | _G dd� d�}G dd� d�}|� | _|� | _t| j| j| j| j�| _d S )Nc @ s e Zd Ze� Ze� ZdS )z&LogBeginnerTests.setUp.<locals>.NotSysN)�__name__� __module__� __qualname__�object�stdout�stderrr! r! r! r" �NotSys> s r3 c @ sR e Zd Zd dd�Z ddedee deded ee e d ee ddfd d �Z dS )z+LogBeginnerTests.setUp.<locals>.NotWarningsr Nc S s g | _ d S r )�warnings)�selfr! r! r" �__init__C s �z4LogBeginnerTests.setUp.<locals>.NotWarnings.__init__�message�category�filename�lineno�file�linec S s | j �||||||f� dS )a Emulate warnings.showwarning. @param message: A warning message to emit. @param category: A warning category to associate with C{message}. @param filename: A file name for the source code file issuing the warning. @param lineno: A line number in the source file where the warning was issued. @param file: A file to write the warning message to. If L{None}, write to L{sys.stderr}. @param line: A line of source code to include with the warning message. If L{None}, attempt to read the line from C{filename} and C{lineno}. N)r4 �append)r5 r7 r8 r9 r: r; r< r! r! r" � showwarningJ s z7LogBeginnerTests.setUp.<locals>.NotWarnings.showwarning�r N)NN) r- r. r/ r6 �strr �Warning�intr r r r> r! r! r! r" � NotWarningsB s& ����� ���rC ) r � publisher�io�StringIO� errorStream� sysModule�warningsModuler �beginner)r5 r3 rC r! r! r" �setUp: s # �zLogBeginnerTests.setUpc sr t ddd�}g � g �tt� fdd��}tt�fdd��}| j�||f� | �|� | �|g� � | �|g�� dS )z? Test that C{beginLoggingTo()} adds observers. � r ��foo�barc � � � | �S r �r= ��e��events1r! r" �<lambda>t � zBLogBeginnerTests.test_beginLoggingToAddObservers.<locals>.<lambda>c rP r rQ rR ��events2r! r" rV u rW N)�dictr r rJ �beginLoggingTorD r( �r5 r �o1�o2r! �rU rY r" � test_beginLoggingToAddObserversk s z0LogBeginnerTests.test_beginLoggingToAddObserversc sr t ddd�}g � g �tt� fdd��}tt�fdd��}| �|� | j�||f� | �|g� � | �|g�� dS )z\ Test that events are buffered until C{beginLoggingTo()} is called. rL r rM c rP r rQ rR rT r! r" rV � rW zDLogBeginnerTests.test_beginLoggingToBufferedEvents.<locals>.<lambda>c rP r rQ rR rX r! r" rV � rW N)rZ r r rD rJ r[ r( r\ r! r_ r" �!test_beginLoggingToBufferedEvents} s z2LogBeginnerTests.test_beginLoggingToBufferedEvents�limitrJ c C sf t |d �D ] }| �t|d�� qg }|�tt|j�g� | �tt d|d ��tdd� |D ��� dS )a� Verify that when more than C{limit} events are logged to L{LogBeginner}, only the last C{limit} are replayed by L{LogBeginner.beginLoggingTo}. @param limit: The maximum number of events the log beginner should buffer. @param beginner: The L{LogBeginner} against which to verify. @raise: C{self.failureException} if the wrong events are replayed by C{beginner}. rL )�countc s s � | ]}|d V qdS )rc Nr! r$ r! r! r" � <genexpr>� s � z4LogBeginnerTests._bufferLimitTest.<locals>.<genexpr>N) �rangerD rZ r[ r r r= r( �list)r5 rb rJ rc �eventsr! r! r" �_bufferLimitTest� s �z!LogBeginnerTests._bufferLimitTestc C s t j}| �|| j� dS )z� Up to C{LogBeginner._DEFAULT_BUFFER_SIZE} log events are buffered for replay by L{LogBeginner.beginLoggingTo}. N)r �_DEFAULT_BUFFER_SIZErh rJ )r5 rb r! r! r" �test_defaultBufferLimit� s z(LogBeginnerTests.test_defaultBufferLimitc C s. d}t | j| j| j| j|d�}| �||� dS )z� The size of the L{LogBeginner} event buffer can be overridden with the C{initialBufferSize} initilizer argument. � )�initialBufferSizeN)r rD rG rH rI rh )r5 rb rJ r! r! r" �test_overrideBufferLimit� s �z)LogBeginnerTests.test_overrideBufferLimitc C s$ g }g }t �� }t|�}| �tdd�� t� \}}| j�tt |j �|g� | �tdd�� t� \}}| j�tt |j �|g� | �tdd�� tt t j ||||d�} d| _t| |tdd�tdd�| tdd�g� t| || tdd�g� |�� } | �d|� d|� d �| � | �d|� d|� d �| � dS ) z� When invoked twice, L{LogBeginner.beginLoggingTo} will emit a log message warning the user that they previously began logging, and add the new log observers. � prebuffer)r � postbuffer�postwarn)� log_format� log_level�fileNow�lineNow�fileThen�lineThenN�<�:�>)rE rF r rD rZ r rJ r[ r r r= r r �warn�maxDiffr+ �getvalue�assertIn) r5 rU rY � fileHandle� textObserver� firstFilename� firstLine�secondFilename� secondLine�warning�outputr! r! r" �test_beginLoggingToTwice� sB � �� z)LogBeginnerTests.test_beginLoggingToTwicec C s: t | jd�}|�d� |jddd� | �| j�� d� dS )zP Critical messages will be written as text to the error stream. ��observerz ignore thisza critical {message}r7 )r7 za critical message N)r rD �info�criticalr( rG r| �r5 �logr! r! r" �test_criticalLogging� s z%LogBeginnerTests.test_criticalLoggingc C s8 t | jd�}| j�d� |�d� | �| j�� d� dS )z� Once logging has begun with C{beginLoggingTo}, critical messages are no longer written to the output stream. r� r! zanother critical message� N)r rD rJ r[ r� r( rG r| r� r! r! r" �test_criticalLoggingStops� s z*LogBeginnerTests.test_criticalLoggingStopsc C s� g }| j �tt|j�g� tdtt| jj�d� t | |t ddd�g� |dd�= tdtt| jj �d� t | |t ddd�g� dS )z� L{LogBeginner.beginLoggingTo} will re-direct the standard output and error streams by setting the C{stdio} and C{stderr} attributes on its sys module object. z Hello, world.�r; r1 )� log_namespace�log_ioNz Error, world.r2 ) rJ r[ r r r= �printr rH r1 r+ rZ r2 )r5 rg r! r! r" �%test_beginLoggingToRedirectStandardIO� s � �z6LogBeginnerTests.test_beginLoggingToRedirectStandardIOc C sD | j j}| j j}| jjddd� | �| j j|� | �| j j|� dS )z� L{LogBeginner.beginLoggingTo} will leave the existing stdout/stderr in place if it has been told not to replace them. r! F)�redirectStandardION)rH r1 r2 rJ r[ �assertIs)r5 �oldOut�oldErrr! r! r" � test_beginLoggingToDontRedirect s z0LogBeginnerTests.test_beginLoggingToDontRedirectc C s� t �t �� d�}t �t �� d�}|| j_|| j_g }| j�tt |j �g� tt | jj�}tt | jj�}| � |j d� | � |j d� |�d� |�d� t| |tdd�tdd�g� dS ) z� When L{LogBeginner.beginLoggingTo} redirects stdout/stderr streams, the replacement streams will preserve the encoding of the replaced streams, to minimally disrupt any application relying on a specific encoding. z shift-JIS�big5s �� s �� u 李)r� u 瑩N)rE � TextIOWrapper�BytesIOrH r1 r2 rJ r[ r r r= r r( �encoding�writer+ rZ )r5 �weird�weirderrrg r1 r2 r! r! r" �$test_beginLoggingToPreservesEncoding s z5LogBeginnerTests.test_beginLoggingToPreservesEncodingc C s� | j �dttd� g }| j�tt|j�g� | j �dttd� t � � }| j jdttd|d� | � | j j dttdddfdttd|dfg� t | |tdtjd tj tdd �g� dS ) z� L{LogBeginner.beginLoggingTo} will redirect the warnings of its warnings module into the logging system. z a messagerL zanother messager z yet anotherrk r� N�.)r� r8 r9 r: )rI r> �DeprecationWarning�__file__rJ r[ r r r= rE rF r( r4 r+ rZ r. r- )r5 rg �fr! r! r" �test_warningsModule/ s> � ��������z$LogBeginnerTests.test_warningsModulec C sX t td��}t| jd�}|jd|d� | j�� }| �d|� | �d|� | �d|� dS )zR The string resulting from a logged failure contains a traceback. z,this is not the behavior you are looking forr� z a failure)�failure� TracebackN)r � Exceptionr rD r� rG r| r} )r5 r� r� �msgr! r! r" � test_failuresAppendTracebacksV s z.LogBeginnerTests.test_failuresAppendTracebacksr? )r- r. r/ �__doc__rK r` ra rB r rh rj rm r� r� r� r� r� r� r� r� r! r! r! r" r, 5 s 1 + 'r, )"r� rE �typingr r r r r r r r �twisted.python.failurer � twisted.trialr �_filer �_globalr r � _interfacesr r �_levelsr �_loggerr � _observerr �test.test_stdlibr �TestCaser+ r, r! r! r! r" �<module> s, ( ��� � test/__pycache__/test_file.cpython-310.pyc 0000644 00000017017 15027667615 0014437 0 ustar 00 o �b� � @ s� d Z ddlmZ ddlmZ ddlmZmZmZm Z m Z m Z ddl m Z ddlmZ ddlmZ ddlmZ d d lmZmZ d d lmZ G d d � d e�ZG dd� de�ZG dd� d�ZdS )z) Test cases for L{twisted.logger._file}. � )�StringIO)� TracebackType)�IO�Any�AnyStr�Optional�Type�cast)�BrokenMethodImplementation)� verifyObject)�Failure)�TestCase� )�FileLogObserver�textFileLogObserver)� ILogObserverc @ s\ e Zd ZdZddd�Zddd�Zdee d eddfd d �Z dd d �Z ddd�Z ddd�Z dS )�FileLogObserverTestsz' Tests for L{FileLogObserver}. �returnNc C s� t � �7}t|dd� �}ztt|� W n ty) } z | �|� W Y d}~n d}~ww W d � dS W d � dS 1 s=w Y dS )z; L{FileLogObserver} is an L{ILogObserver}. c S � t | �S �N��str��e� r �?/usr/lib/python3/dist-packages/twisted/logger/test/test_file.py�<lambda> � z5FileLogObserverTests.test_interface.<locals>.<lambda>N)r r r r r �fail)�self� fileHandle�observerr r r r �test_interface s ����"�z#FileLogObserverTests.test_interfacec C s` t � �#}t|dd� �}tdd�}||� | �|�� t|�� W d � dS 1 s)w Y dS )zV L{FileLogObserver} writes to the given file when it observes events. c S r r r r r r r r * r z9FileLogObserverTests.test_observeWrites.<locals>.<lambda>� ��xN)r r �dict� assertEqual�getvaluer �r r r! �eventr r r �test_observeWrites% s "�z'FileLogObserverTests.test_observeWrites�what�countc sh t � �'}tttt |�� fdd��}tdd�}||� | �|j|� W d � dS 1 s-w Y dS )z� Verify that observer performs an expected number of writes when the formatter returns a given value. @param what: the value for the formatter to return. @param count: the expected number of writes. c s � S r r r �r, r r r 8 s z:FileLogObserverTests._test_observeWrites.<locals>.<lambda>r# r$ N)� DummyFiler r r r r& r' �writes)r r, r- r r! r* r r. r �_test_observeWrites/ s "�z(FileLogObserverTests._test_observeWritesc C s | � dd� dS )z� L{FileLogObserver} does not write to the given file when it observes events and C{formatEvent} returns L{None}. Nr �r1 �r r r r �test_observeWritesNone= � z+FileLogObserverTests.test_observeWritesNonec C s | � dd� dS )z� L{FileLogObserver} does not write to the given file when it observes events and C{formatEvent} returns C{""}. � r Nr2 r3 r r r �test_observeWritesEmptyD r5 z,FileLogObserverTests.test_observeWritesEmptyc C sd t � �%}tttt |�dd� �}tdd�}||� | �|jd� W d � dS 1 s+w Y dS )zl L{FileLogObserver} calles C{flush()} on the output file when it observes an event. c S r r r r r r r r Q r z:FileLogObserverTests.test_observeFlushes.<locals>.<lambda>r# r$ N)r/ r r r r r& r' �flushesr) r r r �test_observeFlushesK s "�z(FileLogObserverTests.test_observeFlushes�r N) �__name__� __module__� __qualname__�__doc__r" r+ r r �intr1 r4 r7 r9 r r r r r s r c @ sB e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �ZdS )�TextFileLogObserverTestsz+ Tests for L{textFileLogObserver}. r Nc C s@ t � �}t|�}| �|t� W d � dS 1 sw Y dS )zF L{textFileLogObserver} returns a L{FileLogObserver}. N)r r �assertIsInstancer �r r r! r r r �test_returnsFileLogObserver\ s "�z4TextFileLogObserverTests.test_returnsFileLogObserverc C sB t � �}t|�}| �|j|� W d � dS 1 sw Y dS )�F Returned L{FileLogObserver} has the correct outFile. N)r r �assertIs�_outFilerB r r r � test_outFiled s "�z%TextFileLogObserverTests.test_outFilec C sX t � � }t|dd�}|tddd�� | �|�� d� W d � dS 1 s%w Y dS )rD z%f)� timeFormat�XYZZYg�����m�@)� log_format�log_timez600000 [-#-] XYZZY N)r r r& r' r( rB r r r �test_timeFormatl s "�z(TextFileLogObserverTests.test_timeFormatc C s� t � �>}t|�}zdd W n ty t� }Y nw t|d�}||� |�� }| j|�d�d �d�t |�d� W d � dS 1 sDw Y dS )z� If the C{"log_failure"} key exists in an event, the observer appends the failure's traceback to the output. r# r �� log_failure� z Traceback )�msgN) r r �ZeroDivisionErrorr r& r( � assertTrue�split� startswith�repr)r r r! �failurer* �outputr r r �test_observeFailureu s � �"�z,TextFileLogObserverTests.test_observeFailurec C s` t � �#}t|�}tt� d�}||� |�� }d}| �||� W d � dS 1 s)w Y dS )z� If the C{"log_failure"} key exists in an event, and contains an object that raises when you call its C{getTraceback()}, then the observer appends a message noting the problem, instead of raising. rM z'(UNABLE TO OBTAIN TRACEBACK FROM EVENT)N)r r r& �objectr( �assertIn)r r r! r* rW �expectedr r r �+test_observeFailureThatRaisesInGetTraceback� s "�zDTextFileLogObserverTests.test_observeFailureThatRaisesInGetTracebackr: ) r; r< r= r> rC rG rL rX r\ r r r r r@ W s r@ c @ sn e Zd ZdZddd�Zdeddfdd�Zdd d �Zdd d �Zd e e e de e de e de e fdd�ZdS )r/ z. File that counts writes and flushes. r Nc C s d| _ d| _d S )Nr )r0 r8 r3 r r r �__init__� s zDummyFile.__init__�datac C � | j d7 _ dS )z8 Write data. @param data: data r# N)r0 )r r^ r r r �write� s zDummyFile.writec C r_ )z Flush buffers. r# N)r8 r3 r r r �flush� s zDummyFile.flushc C s | S r r r3 r r r � __enter__� s zDummyFile.__enter__�exc_type� exc_value� tracebackc C s d S r r )r rc rd re r r r �__exit__� s zDummyFile.__exit__r: )r r/ )r; r< r= r> r] r r` ra rb r r � BaseExceptionr �boolrf r r r r r/ � s ����r/ N) r> �ior �typesr �typingr r r r r r �zope.interface.exceptionsr �zope.interface.verifyr �twisted.python.failurer �twisted.trial.unittestr �_filer r � _interfacesr r r@ r/ r r r r �<module> s BA test/__pycache__/test_buffer.cpython-310.pyc 0000644 00000004462 15027667615 0014771 0 ustar 00 o �b � @ sj d Z ddlmZmZ ddlmZ ddlmZ ddlm Z ddl m Z ddl m Z mZ G d d � d e j�Zd S ) z+ Test cases for L{twisted.logger._buffer}. � )�List�cast)�BrokenMethodImplementation)� verifyObject)�unittest� )�LimitedHistoryLogObserver)� ILogObserver�LogEventc @ s. e Zd ZdZd dd�Zd dd�Zd dd �ZdS ) � LimitedHistoryLogObserverTestsz1 Tests for L{LimitedHistoryLogObserver}. �returnNc C sJ t d�}ztt|� W dS ty$ } z | �|� W Y d}~dS d}~ww )zH L{LimitedHistoryLogObserver} provides L{ILogObserver}. r N)r r r r �fail)�self�observer�e� r �A/usr/lib/python3/dist-packages/twisted/logger/test/test_buffer.py�test_interface s ��z-LimitedHistoryLogObserverTests.test_interfacec C sZ d}dd� t |d �D �}t|�}|D ]}||� qg }|�tt|j�� | �||� dS )zY L{LimitedHistoryLogObserver} saves history in the order it is received. � c S � g | ]}t |d ��qS �)�n��dict��.0r r r r � <listcomp>& � z=LimitedHistoryLogObserverTests.test_order.<locals>.<listcomp>r N��ranger �replayTor r �append� assertEqual�r �size�eventsr �event� outEventsr r r � test_order! s z)LimitedHistoryLogObserverTests.test_orderc C sd d}dd� t |d �D �}t|�}|D ]}||� qg }|�tt|j�� | �|| d� |� dS )z� When more events than a L{LimitedHistoryLogObserver}'s maximum size are buffered, older events will be dropped. r c S r r r r r r r r 6 r z=LimitedHistoryLogObserverTests.test_limit.<locals>.<listcomp>r Nr r# r r r � test_limit0 s z)LimitedHistoryLogObserverTests.test_limit)r N)�__name__� __module__� __qualname__�__doc__r r( r) r r r r r s r N)r- �typingr r �zope.interface.exceptionsr �zope.interface.verifyr � twisted.trialr �_bufferr � _interfacesr r �TestCaser r r r r �<module> s test/__pycache__/test_observer.cpython-310.pyc 0000644 00000016510 15027667615 0015344 0 ustar 00 o �b* � @ s� d Z ddlmZmZmZmZ ddlmZ ddlm Z ddl m Z ddl m Z ddlmZmZ dd lmZ dd lmZ G d d � d e j�Zd S )z- Test cases for L{twisted.logger._observer}. � )�Dict�List�Tuple�cast)� implementer)�BrokenMethodImplementation)� verifyObject)�unittest� )� ILogObserver�LogEvent)�Logger)� LogPublisherc @ st e Zd ZdZddd�Zddd�Zddd �Zdd d �Zdd d �Zddd�Z ddd�Z ddd�Z ddd�Z ddd�Z dS )�LogPublisherTestsz$ Tests for L{LogPublisher}. �returnNc C sH t � }ztt|� W dS ty# } z | �|� W Y d}~dS d}~ww )z8 L{LogPublisher} is an L{ILogObserver}. N)r r r r �fail)�self� publisher�e� r �C/usr/lib/python3/dist-packages/twisted/logger/test/test_observer.py�test_interface s ��z LogPublisherTests.test_interfacec C s@ t tdd� �}t tdd� �}t||�}| �||ht|j�� dS )zB L{LogPublisher.observers} returns the observers. c S � d S �Nr �r r r r �<lambda>' � z2LogPublisherTests.test_observers.<locals>.<lambda>c S r r r r r r r r ( r N)r r r � assertEqual�set� _observers)r �o1�o2r r r r �test_observers# s z LogPublisherTests.test_observersc C sZ t tdd� �}t tdd� �}t tdd� �}t||�}|�|� | �|||ht|j�� dS )z? L{LogPublisher.addObserver} adds an observer. c S r r r r r r r r 1 r z4LogPublisherTests.test_addObserver.<locals>.<lambda>c S r r r r r r r r 2 r c S r r r r r r r r 3 r N)r r r � addObserverr r r �r r r! �o3r r r r �test_addObserver- s z"LogPublisherTests.test_addObserverc C s t � }| �t|jt� � dS )ze L{LogPublisher.addObserver} refuses to add an observer that's not callable. N)r � assertRaises� TypeErrorr# �object)r r r r r �test_addObserverNotCallable9 s z-LogPublisherTests.test_addObserverNotCallablec C sZ t tdd� �}t tdd� �}t tdd� �}t|||�}|�|� | �||ht|j�� dS )zE L{LogPublisher.removeObserver} removes an observer. c S r r r r r r r r E r z7LogPublisherTests.test_removeObserver.<locals>.<lambda>c S r r r r r r r r F r c S r r r r r r r r G r N�r r r �removeObserverr r r r$ r r r �test_removeObserverA s z%LogPublisherTests.test_removeObserverc C sX t tdd� �}t tdd� �}t tdd� �}t||�}|�|� | �||ht|j�� dS )zd L{LogPublisher.removeObserver} removes an observer that is not registered. c S r r r r r r r r R r zDLogPublisherTests.test_removeObserverNotRegistered.<locals>.<lambda>c S r r r r r r r r S r c S r r r r r r r r T r Nr+ r$ r r r � test_removeObserverNotRegisteredM s z2LogPublisherTests.test_removeObserverNotRegisteredc C sx t ddd�}g }g }g }tt|j�}tt|j�}tt|j�}t|||�}||� | �||� | �||� | �||� dS )z6 L{LogPublisher} calls its observers. � r ��foo�barN)�dictr r �appendr �assertIn) r �event�events1�events2�events3r r! r% r r r r � test_fanOutZ s z LogPublisherTests.test_fanOutc s� t ddd�}td��g � tt�dtddf� �fdd � �}g }t|tt|j��}||� | �|� � d d � |D �}| � t |�d� | � |d j �� | � t � �d� dS ) z} Observer raises an exception during fan out: a failure is logged, but not re-raised. Life goes on. r/ r r0 �ARGH! EVIL DEATH!r6 r Nc s � }� � | � |r ��d S r )r4 )r6 � shouldRaise��events� exceptionr r �observerx s �z7LogPublisherTests.test_observerRaises.<locals>.observerc S s g | ] }d |v r|d �qS )� log_failurer )�.0r r r r � <listcomp>� s z9LogPublisherTests.test_observerRaises.<locals>.<listcomp>r ) r3 � RuntimeErrorr r r r r r4 r5 r �len�assertIs�value)r r6 r@ � collectorr �errorsr r= r �test_observerRaisesn s z%LogPublisherTests.test_observerRaisesc s^ t ddd�}td�� tt�dtddfdd ��}G � fd d �d t�}t|�}|� |_||� dS ) z� Observer raises an exception during fan out and the publisher's Logger pukes when the failure is reported. The exception does not propagate back to the caller. r/ r r0 r; r6 r Nc S s t d��)Nz Sad panda)rD )r6 r r r r@ � s zGLogPublisherTests.test_observerRaisesAndLoggerHatesMe.<locals>.observerc s& e Zd Zdededdf� fdd� ZdS )zILogPublisherTests.test_observerRaisesAndLoggerHatesMe.<locals>.GurkLogger�args�kwargsr Nc s � �r r )r rK rL �r? r r �failure� s zQLogPublisherTests.test_observerRaisesAndLoggerHatesMe.<locals>.GurkLogger.failure)�__name__� __module__� __qualname__r) rN r rM r r � GurkLogger� s rR )r3 rD r r r r r �log)r r6 r@ rR r r rM r �#test_observerRaisesAndLoggerHatesMe� s z5LogPublisherTests.test_observerRaisesAndLoggerHatesMec s� t ddg d�}i � tt�dtddf� fdd� �}tt�dtddf� fd d � �}t||�}||� | �� d ||ff� | �� d ||f||ff� dS ) zA Tracing keeps track of forwarding to observers. r/ r )r1 r2 � log_tracer r Nc �* � � dtttttf t| d ��� d S )Nr/ rU �� setdefaultr r r r �tupler ��tracesr r r � � �z(LogPublisherTests.test_trace.<locals>.o1c rV )Nr rU rW r rZ r r r! � r\ z(LogPublisherTests.test_trace.<locals>.o2)r3 r r r r r )r r6 r r! r r rZ r � test_trace� s z LogPublisherTests.test_trace)r N)rO rP rQ �__doc__r r" r& r* r- r. r: rJ rT r] r r r r r s r N)r^ �typingr r r r �zope.interfacer �zope.interface.exceptionsr �zope.interface.verifyr � twisted.trialr � _interfacesr r �_loggerr � _observerr �TestCaser r r r r �<module> s test/__pycache__/test_legacy.cpython-310.pyc 0000644 00000037327 15027667615 0014772 0 ustar 00 o �b 9 � @ s� d Z ddlZddlmZ ddlmZmZ ddlmZ ddl m Z ddl m Z ddl mZmZ dd lmZ dd lmZ d d lmZ d d lmZmZ d dlmZm Z d dl m Z G dd� dej �Z G dd� dej �Z!dS )z+ Test cases for L{twisted.logger._legacy}. � N)�time)�List�cast)� implementer)�BrokenMethodImplementation)� verifyObject)�context�log)�Failure)�unittest� )� formatEvent)� ILogObserver�LogEvent)�LegacyLogObserverWrapper�publishToNewObserver)�LogLevelc @ s e Zd ZdZd4dd�Zd4dd�Zdedefd d �Zdedefd d �Zd4d d�Z d4dd�Z d4dd�Z d4dd�Z d4dd�Z d4dd�Zd4dd�Zd4dd �Zd4d d �Zd4d d �Zd4d!d"�Zd4d#d$�Zd4d%d&�Zd4d'd(�Zd)edefd*d+�Zd4d,d-�Zd4d.d/�Zd4d0d1�Zd4d2d3�Z dS )5� LegacyLogObserverWrapperTestsz0 Tests for L{LegacyLogObserverWrapper}. �returnNc C sZ t tjdd� �}t|�}ztt|� W dS ty, } z | �|� W Y d}~dS d}~ww )zD L{LegacyLogObserverWrapper} is an L{ILogObserver}. c S � d S �N� ��er r �A/usr/lib/python3/dist-packages/twisted/logger/test/test_legacy.py�<lambda>" s z>LegacyLogObserverWrapperTests.test_interface.<locals>.<lambda>N)r � legacyLogr r r r �fail)�self�legacyObserver�observerr r r r �test_interface s ��z,LegacyLogObserverWrapperTests.test_interfacec C s6 t tj�G dd� d��}t|� �}| �t|�d� dS )zJ L{LegacyLogObserverWrapper} returns the expected string. c @ s. e Zd Zdefdd�Zdejddfdd�ZdS )z?LegacyLogObserverWrapperTests.test_repr.<locals>.LegacyObserverr c S s dS )Nz<Legacy Observer>r �r r r r �__repr__0 � zHLegacyLogObserverWrapperTests.test_repr.<locals>.LegacyObserver.__repr__� eventDictNc S r r r )r r% r r r �__call__3 r$ zHLegacyLogObserverWrapperTests.test_repr.<locals>.LegacyObserver.__call__)�__name__� __module__� __qualname__�strr# r � EventDictr& r r r r �LegacyObserver. s r, z+LegacyLogObserverWrapper(<Legacy Observer>)N)r r r r � assertEqual�repr)r r, r r r r � test_repr) s z'LegacyLogObserverWrapperTests.test_repr�eventc s@ g � t tj� fdd��}t|�}||� | �t� �d� � d S )z� Send an event to a wrapped legacy observer and capture the event as seen by that observer. @param event: an event @return: the event as observed by the legacy wrapper c s � � | �S r )�appendr ��eventsr r r E s z7LegacyLogObserverWrapperTests.observe.<locals>.<lambda>� r )r r r r r- �len)r r0 r r r r2 r �observe: s z%LegacyLogObserverWrapperTests.observec C sX |� dt� � |� dd� |� dtj� | �t|��}|�� D ] \}}| �||� q |S )z� Send an event to a wrapped legacy observer and verify that its data is preserved. @param event: an event @return: the event as observed by the legacy wrapper �log_time� log_system�-� log_level)� setdefaultr r �infor6 �dict�items�assertIn)r r0 �observed�key�valuer r r �forwardAndVerifyL s z.LegacyLogObserverWrapperTests.forwardAndVerifyc C s | � tddd�� dS )ze Basic forwarding: event keys as observed by a legacy observer are the same. r4 r ��foo�barN)rC r= r" r r r � test_forwardc s z*LegacyLogObserverWrapperTests.test_forwardc C s* t � }| �t|d��}| �|d |� dS )zc The new-style C{"log_time"} key is copied to the old-style C{"time"} key. )r7 r N�r rC r= r- �r �stampr0 r r r � test_timej s z'LegacyLogObserverWrapperTests.test_timec C s0 t � }| �t|d |d��}| �|d |� dS )zr The new-style C{"log_time"} key does not step on a pre-existing old-style C{"time"} key. r4 )r7 r r NrH rI r r r �test_timeAlreadySets s z1LegacyLogObserverWrapperTests.test_timeAlreadySetc C �$ | � tdd��}| �|d d� dS )zg The new-style C{"log_system"} key is copied to the old-style C{"system"} key. rE )r8 �systemN�rC r= r- �r r0 r r r � test_system| s z)LegacyLogObserverWrapperTests.test_systemc C s& | � tddd��}| �|d d� dS )zv The new-style C{"log_system"} key does not step on a pre-existing old-style C{"system"} key. rE rF )r8 rN rN NrO rP r r r �test_systemAlreadySet� s z3LegacyLogObserverWrapperTests.test_systemAlreadySetc C s2 t t� tjd�}| �t |��}| �|d d� dS )zy If the new-style C{"log_system"} key is absent, the old-style C{"system"} key is set to C{"-"}. )r7 r: rN r9 N)r= r r r< r6 r- )r r0 r@ r r r � test_noSystem� s z+LegacyLogObserverWrapperTests.test_noSystemc C sT | � ttjdd�� | � ttjdd�� | � ttjdd�� | � ttjdd�� dS )z� If explicitly set, the C{isError} key will be preserved when forwarding from a new-style logging emitter to a legacy logging observer, regardless of log level. r4 )r: �isErrorr N)rC r= r r< �warn�error�criticalr" r r r �test_levelNotChange� s z1LegacyLogObserverWrapperTests.test_levelNotChangec C s" | � ttjd��}| �d|� dS )a) The new-style C{"log_level"} key is not translated to the old-style C{"logLevel"} key. Events are forwarded from the old module from to new module and are then seen by old-style observers. We don't want to add unexpected keys to old-style events. )r: �logLevelN)rC r= r r< � assertNotInrP r r r �test_pythonLogLevelNotSet� s z7LegacyLogObserverWrapperTests.test_pythonLogLevelNotSetc C rM )a If a stdlib log level was provided as a string (eg. C{"WARNING"}) in the legacy "logLevel" key, it does not get converted to a number. The documentation suggested that numerical values should be used but this was not a requirement. �WARNING�rY rY NrO rP r r r �test_stringPythonLogLevel� s ��z7LegacyLogObserverWrapperTests.test_stringPythonLogLevelc C s | � t� �}| �|d d� dS )z� The old-style C{"message"} key is added, even if no new-style C{"log_format"} is given, as it is required, but may be empty. �messager NrO rP r r r � test_message� � z*LegacyLogObserverWrapperTests.test_messagec C rM )zV The old-style C{"message"} key is not modified if it already exists. rD )r_ r_ NrO rP r r r �test_messageAlreadySet� s z4LegacyLogObserverWrapperTests.test_messageAlreadySetc C �( | � tddd��}| �t�|�d� dS )z� Formatting is translated such that text is rendered correctly, even though old-style logging doesn't use PEP 3101 formatting. z Hello, {who}!�world)� log_format�who� Hello, world!N�rC r= r- r �textFromEventDictrP r r r � test_format� � z)LegacyLogObserverWrapperTests.test_formatc C rc )zo Using the message key, which is special in old-style, works for new-style formatting. zHello, {message}!rd )re r_ rg Nrh rP r r r �test_formatMessage� s �z0LegacyLogObserverWrapperTests.test_formatMessagec C s( | � tddd��}| �t�|�d� dS )zd Formatting is not altered if the old-style C{"format"} key already exists. zHello!zHowdy!)re �formatNrh rP r r r �test_formatAlreadySet� rk z3LegacyLogObserverWrapperTests.test_formatAlreadySet�valuesc K s& t td��}| �td|dd�|���S )z� Create a new-style event with a captured failure. @param values: Additional values to include in the event. @return: the new event znyargh!� oopsie...)� log_failurere Nr )r � RuntimeErrorrC r= )r ro �failurer r r �eventWithFailure� s �z.LegacyLogObserverWrapperTests.eventWithFailurec C s> | � � }| �|d |d � | �|d � | �|d d� dS )z} Captured failures in the new style set the old-style C{"failure"}, C{"isError"}, and C{"why"} keys. rs rq rT �whyrp N)rt �assertIs� assertTruer- rP r r r � test_failure� s z*LegacyLogObserverWrapperTests.test_failurec C s, t td��}| j|d�}| �|d |� dS )�v Captured failures in the new style do not step on a pre-existing old-style C{"failure"} key. z Weak salsa!)rs rs N)r rr rt rv )r rs r0 r r r �test_failureAlreadySet� s z4LegacyLogObserverWrapperTests.test_failureAlreadySetc C � | j dd�}| �|d d� dS )zv Captured failures in the new style do not step on a pre-existing old-style C{"isError"} key. r �rT rT N�rt r- rP r r r �test_isErrorAlreadySet ra z4LegacyLogObserverWrapperTests.test_isErrorAlreadySetc C r{ )ry �blah)ru ru Nr} rP r r r �test_whyAlreadySet ra z0LegacyLogObserverWrapperTests.test_whyAlreadySet�r N) r' r( r) �__doc__r! r/ r r6 rC rG rK rL rQ rR rS rX r[ r^ r` rb rj rl rn �objectrt rx rz r~ r� r r r r r s2 r c @ s� e Zd ZdZd dd�Zdededejfdd �Z d d d �Z d d d �Z d dd�Z d dd�Z d dd�Zd dd�Zd dd�Zd dd�Zd dd�Zd d d �ZdS ) �PublishToNewObserverTestsz, Tests for L{publishToNewObserver}. r Nc C s g | _ tt| j j�| _d S r )r3 r r r1 r r" r r r �setUp s z PublishToNewObserverTests.setUpr_ ro c O sD t �tj�pi �� }|�|� ||d< t� |d< d|vr d|d< |S )a Return a basic old-style event as would be created by L{legacyLog.msg}. @param message: a message event value in the legacy event format @param values: additional event values in the legacy event format @return: a legacy event r_ r rT r )r �getr � ILogContext�copy�updater )r r_ ro r0 r r r � legacyEvent s z%PublishToNewObserverTests.legacyEventc C s* t | j| �� tj� | �t| j�d� dS )z6 The observer is called exactly once. r4 N)r r r� r ri r- r5 r3 r" r r r � test_observed/ s �z'PublishToNewObserverTests.test_observedc C �8 t | j| �� tj� | �| jd d | jd d � dS )zc The old-style C{"time"} key is copied to the new-style C{"log_time"} key. r r7 r N�r r r� r ri r- r3 r" r r r rK 8 � �$z#PublishToNewObserverTests.test_timec C sN dt dtfdd�}| �dd�}||�}t| j||� | �t| jd �|� dS ) z� A published old-style event should format as text in the same way as the given C{textFromEventDict} callable would format it. r0 r c S s d� td� | d ���S )N� � r_ )�join�reversed)r0 r r r ri H s zAPublishToNewObserverTests.test_message.<locals>.textFromEventDictzHello,zworld!r N)r r* r� r r r- r r3 )r ri r0 �textr r r r` B s z&PublishToNewObserverTests.test_messagec C s0 t | j| �� tj� | �| jd d tj� dS )zL Published event should have log level of L{LogLevel.info}. r r: N) r r r� r ri r- r3 r r< r" r r r �test_defaultLogLevelQ s � z.PublishToNewObserverTests.test_defaultLogLevelc C �4 t | j| jdd�tj� | �| jd d tj� dS )z� If C{"isError"} is set to C{1} (true) on the legacy event, the C{"log_level"} key should get set to L{LogLevel.critical}. r4 r| r r: N) r r r� r ri r- r3 r rW r" r r r � test_isErrorZ s � z&PublishToNewObserverTests.test_isErrorc C s6 t | j| jtjd�tj� | �| jd d t j � dS )z� If the old-style C{"logLevel"} key is set to a standard library logging level, using a predefined (L{int}) constant, the new-style C{"log_level"} key should get set to the corresponding log level. r] r r: N) r r r� � py_loggingr\ r ri r- r3 r rU r" r r r �test_stdlibLogLeveld s � z-PublishToNewObserverTests.test_stdlibLogLevelc C r� )z� If the old-style C{"logLevel"} key is set to a standard library logging level, using a string value, the new-style C{"log_level"} key should get set to the corresponding log level. r\ r] r r: N) r r r� r ri r- r3 r rU r" r r r � test_stdlibLogLevelWithStringq s � z7PublishToNewObserverTests.test_stdlibLogLevelWithStringc C s. t | j| jdd�tj� | �d| jd � dS )z� If the old-style C{"logLevel"} key is set to a standard library logging level, using an unknown value, the new-style C{"log_level"} key should not get set. zFoo!!!!!r] r: r N)r r r� r ri rZ r3 r" r r r � test_stdlibLogLevelWithGarbage~ s �z8PublishToNewObserverTests.test_stdlibLogLevelWithGarbagec C s. t | j| �� tj� | �| jd d d� dS )z� Published event should have a namespace of C{"log_legacy"} to indicate that it was forwarded from legacy logging. r � log_namespace� log_legacyNr� r" r r r �test_defaultNamespace� s �z/PublishToNewObserverTests.test_defaultNamespacec C r� )zg The old-style C{"system"} key is copied to the new-style C{"log_system"} key. r r8 rN Nr� r" r r r rQ � r� z%PublishToNewObserverTests.test_systemr� )r' r( r) r� r� r* r� r r+ r� r� rK r` r� r� r� r� r� r� rQ r r r r r� s r� )"r� �loggingr� r �typingr r �zope.interfacer �zope.interface.exceptionsr �zope.interface.verifyr �twisted.pythonr r r �twisted.python.failurer � twisted.trialr �_formatr � _interfacesr r �_legacyr r �_levelsr �TestCaser r� r r r r �<module> s" } test/__pycache__/test_json.cpython-310.pyc 0000644 00000042400 15027667615 0014463 0 ustar 00 o �bbG � @ s. d Z ddlmZmZ ddlmZmZmZmZm Z m Z ddl m Z ddl mZ ddlmZ ddlmZ ddlmZ d d lmZ d d lmZ d d lmZ d d lm Z m Z d dl m Z m Z m!Z!m"Z"m#Z$ d dl%m&Z& d dl'm(Z( d dl)m*Z* dede+de+fdd�Z,G dd� de�Z-G dd� de�Z.G dd � d e�Z/d S ) z$ Tests for L{twisted.logger._json}. � )�BytesIO�StringIO)�IO�Any�List�Optional�Sequence�cast)� implementer)�BrokenMethodImplementation)� verifyObject)�Failure)�TestCase� )� extractField)� formatEvent)�globalLogPublisher)� ILogObserver�LogEvent)� eventAsJSON� eventFromJSON�eventsFromJSONLogFile�jsonFileLogObserver�log)�LogLevel)�Logger)� LogPublisher�testCase� savedJSON�returnc C s" | � |t� | �|�d�d� |S )a* Assert a few things about the result of L{eventAsJSON}, then return it. @param testCase: The L{TestCase} with which to perform the assertions. @param savedJSON: The result of L{eventAsJSON}. @return: C{savedJSON} @raise AssertionError: If any of the preconditions fail. � r )�assertIsInstance�str� assertEqual�count)r r � r% �?/usr/lib/python3/dist-packages/twisted/logger/test/test_json.py�savedJSONInvariants! s r' c @ s� e Zd ZdZdedefdd�Zddd�Zdd d �Zdd d �Z dd d�Z ddd�Z ddd�Z ddd�Z ddd�Zddd�Zddd�ZdS ) � SaveLoadTestsz2 Tests for loading and saving log events. �eventr c C s t | t|��S )z� Serialize some an events, assert some things about it, and return the JSON. @param event: An event. @return: JSON. )r' r )�selfr) r% r% r& �savedEventJSON6 s z SaveLoadTests.savedEventJSONNc C s | � t| �i ��i � dS )zX Saving and loading an empty dictionary results in an empty dictionary. N�r# r r+ �r* r% r% r& �test_simpleSaveLoadA s z!SaveLoadTests.test_simpleSaveLoadc C s& | � t| �ddd���ddd�� dS )a Saving and loading a dictionary with some simple values in it results in those same simple values in the output; according to JSON's rules, though, all dictionary keys must be L{str} and any non-L{str} keys will be converted. r �4)� �3��1r1 Nr, r- r% r% r& � test_saveLoadG s �zSaveLoadTests.test_saveLoadc C �, | � t| �dt� d���dddid�� dS )zx Saving and loading an object which cannot be represented in JSON will result in a placeholder. r r2 � unpersistableTN�r# r r+ �objectr- r% r% r& �test_saveUnPersistableS s �z$SaveLoadTests.test_saveUnPersistablec C r5 )zD Non-ASCII keys and values can be saved and loaded. u 䌡)u ሴr1 r6 TNr7 r- r% r% r& �test_saveNonASCII] s �z SaveLoadTests.test_saveNonASCIIc C sJ dt td��i}|�ddi� | �t| �|��dt td���d�i� dS )zx Any L{bytes} objects will be saved as if they are latin-1 so they can be faithfully re-loaded. �hello� s skipped�okay�charmapN)�bytes�range�updater# r r+ �decode)r* � inputEventr% r% r& �test_saveBytesf s �z SaveLoadTests.test_saveBytesc C s> G dd� d�}d|d�d�}t | �|��}| �t|�d� dS )a Saving and loading an object which cannot be represented in JSON, but has a string representation which I{can} be saved as JSON, will result in the same string formatting; any extractable fields will retain their data types. c @ s, e Zd Zdeddfdd�Zdefdd�ZdS )z@SaveLoadTests.test_saveUnPersistableThenFormat.<locals>.Reprable�valuer Nc S s || _ d S �N�rE )r* rE r% r% r& �__init__~ � zISaveLoadTests.test_saveUnPersistableThenFormat.<locals>.Reprable.__init__c S s dS )N�reprabler% r- r% r% r& �__repr__� s zISaveLoadTests.test_saveUnPersistableThenFormat.<locals>.Reprable.__repr__)�__name__� __module__� __qualname__r8 rH r" rK r% r% r% r& �Reprable} s rO z{object} {object.value}� �� log_formatr8 z reprable 7N)r r+ r# r )r* rO rC � outputEventr% r% r& � test_saveUnPersistableThenFormatu s z.SaveLoadTests.test_saveUnPersistableThenFormatc C s` G dd� d�}t d|� d�}t| �|��}| �td|�d� | �ttd|� | �ttd|� dS ) zs L{extractField} can extract fields from an object that's been saved and loaded from JSON. c @ s e Zd Zddd�ZdS )z8SaveLoadTests.test_extractingFieldsPostLoad.<locals>.Objr Nc S s d| _ d S )N�Y rG r- r% r% r& rH � rI zASaveLoadTests.test_extractingFieldsPostLoad.<locals>.Obj.__init__�r N)rL rM rN rH r% r% r% r& �Obj� s rW z{object.value}rQ z object.valuerU r8 N)�dictr r+ r# r � assertRaises�KeyError)r* rW rC � loadedEventr% r% r& � test_extractingFieldsPostLoad� s z+SaveLoadTests.test_extractingFieldsPostLoadc C s� g }t tt|j�d�}zdd W n ty# t� }|�d|� Y nw | �t|�d� t | � |d ��d }| � |t� | � |� t�� | � |�� t� dS )zl Round-tripping a failure through L{eventAsJSON} preserves its class and structure. ��observerr0 r za message about failure� log_failureN)r r r �append�ZeroDivisionErrorr �failurer# �lenr r+ r! � assertTrue�check� getTracebackr" )r* �eventsr �f�loadedr% r% r& � test_failureStructurePreserved� s � z,SaveLoadTests.test_failureStructurePreservedc C s0 t tjd�}t| �|��}| �|d tj� dS )zo It's important that the C{log_level} key remain a L{constantly.NamedConstant} object. �� log_levelrl N)rX r �warnr r+ �assertIs)r* rC r[ r% r% r& �test_saveLoadLevel� s z SaveLoadTests.test_saveLoadLevelc C s t d�}| �|tdd�� dS )z� If a saved bit of JSON (let's say, from a future version of Twisted) were to persist a different log_level, it will resolve as None. zZ{"log_level": {"name": "other", "__class_uuid__": "02E59486-F24D-46AD-8224-3ACDF2A5732A"}}Nrk )r r# rX )r* r[ r% r% r& �test_saveLoadUnknownLevel� s �z'SaveLoadTests.test_saveLoadUnknownLevelrV )rL rM rN �__doc__r r" r+ r. r4 r9 r: rD rT r\ rj ro rp r% r% r% r& r( 1 s r( c @ sL e Zd ZdZddd�Zddeddfdd �Zdd d �Zdd d �Zddd�Z dS )�FileLogObserverTestsz+ Tests for L{jsonFileLogObserver}. r Nc C s� t � �4}t|�}ztt|� W n ty& } z | �|� W Y d}~n d}~ww W d � dS W d � dS 1 s:w Y dS )zh A L{FileLogObserver} returned by L{jsonFileLogObserver} is an L{ILogObserver}. N)r r r r r �fail)r* � fileHandler^ �er% r% r& �test_interface� s ����"�z#FileLogObserverTests.test_interface� �recordSeparatorc C s^ t � �"}t||�}tdd�}||� | �|�� |� d�� W d � dS 1 s(w Y dS )a! Asserts that an observer created by L{jsonFileLogObserver} with the given arguments writes events serialized as JSON text, using the given record separator. @param recordSeparator: C{recordSeparator} argument to L{jsonFileLogObserver} r0 ��xz {"x": 1} N)r r rX r# �getvalue)r* rx rt r^ r) r% r% r& �assertObserverWritesJSON� s "�z-FileLogObserverTests.assertObserverWritesJSONc C s | � � dS )z� A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. By default, the record separator is C{"\x1e"}. N�r| r- r% r% r& �(test_observeWritesDefaultRecordSeparator� s z=FileLogObserverTests.test_observeWritesDefaultRecordSeparatorc C s | j dd� dS )z� A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. This test sets the record separator to C{""}. � �rx Nr} r- r% r% r& �&test_observeWritesEmptyRecordSeparator� s z;FileLogObserverTests.test_observeWritesEmptyRecordSeparatorc s� t � }t� }g }|�tt|j�� |�t|�� t|d�}zdd W n ty1 |� d� Y nw t |� � �}t t |��}dt t ddf� fdd � }||� ||� dS ) z� A L{FileLogObserver} created by L{jsonFileLogObserver} writes failures serialized as JSON text to a file when it observes events. r] r0 r zfailed as expected� logEventsr Nc s` � � t| �d� | \}� �d|� |d }� �|t� |�� }� � |jjj� d�t � d�� d S )Nr0 r_ �co) r# rc �assertInr! r �getTracebackObject�tb_frame�f_code� co_filename�rstrip�__file__)r� � failureEvent� failureObject�tracebackObjectr- r% r& � checkEvents s �z@FileLogObserverTests.test_failureFormatting.<locals>.checkEvents)r r � addObserverr r r` r r � BaseExceptionrb r{ �listr r r )r* �io� publisher�logged�logger�reader� deserializedr� r% r- r& �test_failureFormatting� s � z+FileLogObserverTests.test_failureFormattingrV )rw ) rL rM rN rq rv r" r| r~ r� r� r% r% r% r& rr � s rr c @ s� e Zd ZdZd&dd�Zd&dd�Z d'd ee d ee d e ddfd d �Z d&dd�Z d&dd�Z d&dd�Zd&dd�Zd&dd�Zd&dd�Zd&dd�Zd&d d �Zd&d d �Zd&d d!�Zd&d"d#�Zd&d$d%�ZdS )(�LogFileReaderTestsz- Tests for L{eventsFromJSONLogFile}. r Nc s8 g � _ tt�dtdd f� fdd� �}|� _t�|� d S )Nr) r c s. | d t jkrd| v r� j�| � d S d S d S )N� log_namespace�record)�jsonLog� namespace� errorEventsr` )r) r- r% r& r^ s �z*LogFileReaderTests.setUp.<locals>.observer)r� r r r � logObserverr r� )r* r^ r% r- r& �setUp s zLogFileReaderTests.setUpc C s t �| j� d S rF )r �removeObserverr� r- r% r% r& �tearDown& s zLogFileReaderTests.tearDown� �inFilerx � bufferSizec C sJ t t|||��}| �t|�ddi� | �t|�ddi� | �tt|� dS )a| Test that L{eventsFromJSONLogFile} reads two pre-defined events from a file: C{{"x": 1}} and C{{"y": 2}}. @param inFile: C{inFile} argument to L{eventsFromJSONLogFile} @param recordSeparator: C{recordSeparator} argument to L{eventsFromJSONLogFile} @param bufferSize: C{bufferSize} argument to L{eventsFromJSONLogFile} rz r0 �yr N)�iterr r# �nextrY � StopIteration)r* r� rx r� rg r% r% r& � _readEvents) s z LogFileReaderTests._readEventsc C �J t d��}| �|� | �t| j�d� W d � dS 1 s w Y dS )z� L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{"\x1e"} as the record separator. � {"x": 1} {"y": 2} r N�r r� r# rc r� �r* rt r% r% r& �&test_readEventsAutoWithRecordSeparator> � "�z9LogFileReaderTests.test_readEventsAutoWithRecordSeparatorc C r� )z� L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{""} as the record separator. z{"x": 1} {"y": 2} r Nr� r� r% r% r& �'test_readEventsAutoEmptyRecordSeparatorG r� z:LogFileReaderTests.test_readEventsAutoEmptyRecordSeparatorc C �N t d��}| j|dd� | �t| j�d� W d � dS 1 s w Y dS )z{ L{eventsFromJSONLogFile} reads events from a file and is told to use a specific record separator. z{"x": 1} {"y": 2} �r� r Nr� r� r% r% r& �&test_readEventsExplicitRecordSeparatorP s "�z9LogFileReaderTests.test_readEventsExplicitRecordSeparatorc C r� )zM L{eventsFromJSONLogFile} handles buffering a partial event. r� r0 �r� r Nr� r� r% r% r& � test_readEventsPartialBufferZ s "�z/LogFileReaderTests.test_readEventsPartialBufferc C � t d��?}tt|��}| �t|�ddi� | �tt|� | �t| j�d� | �| jd d d� | �| jd d d � W d � d S 1 sFw Y d S ) zF If the JSON text for a record is truncated, skip it. z {"x": 1 {"y": 2} r� r r0 r rR z0Unable to read truncated JSON record: {record!r}r� s {"x": 1N� r r� r r# r� rY r� rc r� �r* rt rg r% r% r& �test_readTruncatedc � �"�z%LogFileReaderTests.test_readTruncatedc C �n t d��)}tt|��}| �t|�ddi� | �tt|� | �t| j�d� W d � dS 1 s0w Y dS )zc If the file being read from vends L{str}, strings decode from JSON as-is. u {"currency": "€"} �currency� €r Nr� r� r% r% r& �test_readUnicodeu s "�z#LogFileReaderTests.test_readUnicodec C r� )zh If the file being read from vends L{bytes}, strings decode from JSON as UTF-8. s {"currency": "€"} r� r� r N� r r� r r# r� rY r� rc r� r� r% r% r& �test_readUTF8Bytes� s "�z%LogFileReaderTests.test_readUTF8Bytesc C sr t d��+}tt|dd��}| �t|�ddi� | �tt|� | �t| j�d� W d � dS 1 s2w Y dS )z� If the JSON text for a record is truncated in the middle of a two-byte Unicode codepoint, we don't want to see a codec exception and the stream is read properly when the additional data arrives. s {"x": "€"} � r� rz r� r Nr� r� r% r% r& �test_readTruncatedUTF8Bytes� s "�z.LogFileReaderTests.test_readTruncatedUTF8Bytesc C r� ) zh If the JSON text for a record contains invalid UTF-8 text, ignore that record. s {"x": "�"} {"y": 2} r� r r0 r rR z2Unable to decode UTF-8 for JSON record: {record!r}r� s {"x": "�"} Nr� r� r% r% r& �test_readInvalidUTF8Bytes� s �"�z,LogFileReaderTests.test_readInvalidUTF8Bytesc C r� ) zD If the JSON text for a record is invalid, skip it. z {"x": } {"y": 2} r� r r0 r rR �&Unable to read JSON record: {record!r}r� s {"x": } Nr� r� r% r% r& �test_readInvalidJSON� r� z'LogFileReaderTests.test_readInvalidJSONc C s� t d��3}t|�}| �tt|� | �t| j�d� | �| jd d d� | �| jd d d� W d � dS 1 s:w Y dS ) zI Multiple events without a record separator are skipped. z {"x": 1} {"y": 2} r0 r rR r� r� s {"x": 1} {"y": 2} N)r r rY r� r� r# rc r� r� r% r% r& �test_readUnseparated� s �"�z'LogFileReaderTests.test_readUnseparatedc C s| t dd�}t� �,}t|�}||� |�d� t|�}| �t|�|f� | �t| j�d� W d � dS 1 s7w Y dS )z� Data written by a L{FileLogObserver} returned by L{jsonFileLogObserver} and read by L{eventsFromJSONLogFile} is reconstructed properly. r0 ry r N) rX r r �seekr r# �tuplerc r� )r* r) rt r^ rg r% r% r& �test_roundTrip� s "�z!LogFileReaderTests.test_roundTriprV )Nr� )rL rM rN rq r� r� r r r r" �intr� r� r� r� r� r� r� r� r� r� r� r� r� r% r% r% r& r� s6 ���� � r� N)0rq r� r r �typingr r r r r r �zope.interfacer �zope.interface.exceptionsr �zope.interface.verifyr �twisted.python.failurer �twisted.trial.unittestr �_flattenr �_formatr �_globalr � _interfacesr r �_jsonr r r r r r� �_levelsr �_loggerr � _observerr r" r' r( rr r� r% r% r% r& �<module> s* R test/test_format.py 0000644 00000052406 15027667615 0010452 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._format}. """ from typing import AnyStr, Optional, cast try: from time import tzset # We should upgrade to a version of pyflakes that does not require this. tzset except ImportError: tzset = None # type: ignore[assignment] from twisted.python.failure import Failure from twisted.python.test.test_tzhelper import addTZCleanup, mktime, setTZ from twisted.trial import unittest from twisted.trial.unittest import SkipTest from .._format import ( eventAsText, formatEvent, formatEventAsClassicLogText, formatTime, formatUnformattableEvent, formatWithCall, ) from .._interfaces import LogEvent from .._levels import LogLevel class FormattingTests(unittest.TestCase): """ Tests for basic event formatting functions. """ def test_formatEvent(self) -> None: """ L{formatEvent} will format an event according to several rules: - A string with no formatting instructions will be passed straight through. - PEP 3101 strings will be formatted using the keys and values of the event as named fields. - PEP 3101 keys ending with C{()} will be treated as instructions to call that key (which ought to be a callable) before formatting. L{formatEvent} will always return L{str}, and if given bytes, will always treat its format string as UTF-8 encoded. """ def format(logFormat: AnyStr, **event: object) -> str: event["log_format"] = logFormat result = formatEvent(event) self.assertIs(type(result), str) return result self.assertEqual("", format(b"")) self.assertEqual("", format("")) self.assertEqual("abc", format("{x}", x="abc")) self.assertEqual( "no, yes.", format("{not_called}, {called()}.", not_called="no", called=lambda: "yes"), ) self.assertEqual("S\xe1nchez", format(b"S\xc3\xa1nchez")) self.assertIn("Unable to format event", format(b"S\xe1nchez")) maybeResult = format(b"S{a!s}nchez", a=b"\xe1") self.assertIn("Sb'\\xe1'nchez", maybeResult) xe1 = str(repr(b"\xe1")) self.assertIn("S" + xe1 + "nchez", format(b"S{a!r}nchez", a=b"\xe1")) def test_formatEventNoFormat(self) -> None: """ Formatting an event with no format. """ event = dict(foo=1, bar=2) result = formatEvent(event) self.assertEqual("", result) def test_formatEventWeirdFormat(self) -> None: """ Formatting an event with a bogus format. """ event = dict(log_format=object(), foo=1, bar=2) result = formatEvent(event) self.assertIn("Log format must be str", result) self.assertIn(repr(event), result) def test_formatUnformattableEvent(self) -> None: """ Formatting an event that's just plain out to get us. """ event = dict(log_format="{evil()}", evil=lambda: 1 / 0) result = formatEvent(event) self.assertIn("Unable to format event", result) self.assertIn(repr(event), result) def test_formatUnformattableEventWithUnformattableKey(self) -> None: """ Formatting an unformattable event that has an unformattable key. """ event: LogEvent = { "log_format": "{evil()}", "evil": lambda: 1 / 0, cast(str, Unformattable()): "gurk", } result = formatEvent(event) self.assertIn("MESSAGE LOST: unformattable object logged:", result) self.assertIn("Recoverable data:", result) self.assertIn("Exception during formatting:", result) def test_formatUnformattableEventWithUnformattableValue(self) -> None: """ Formatting an unformattable event that has an unformattable value. """ event = dict( log_format="{evil()}", evil=lambda: 1 / 0, gurk=Unformattable(), ) result = formatEvent(event) self.assertIn("MESSAGE LOST: unformattable object logged:", result) self.assertIn("Recoverable data:", result) self.assertIn("Exception during formatting:", result) def test_formatUnformattableEventWithUnformattableErrorOMGWillItStop(self) -> None: """ Formatting an unformattable event that has an unformattable value. """ event = dict( log_format="{evil()}", evil=lambda: 1 / 0, recoverable="okay", ) # Call formatUnformattableEvent() directly with a bogus exception. result = formatUnformattableEvent(event, cast(BaseException, Unformattable())) self.assertIn("MESSAGE LOST: unformattable object logged:", result) self.assertIn(repr("recoverable") + " = " + repr("okay"), result) class TimeFormattingTests(unittest.TestCase): """ Tests for time formatting functions. """ def setUp(self) -> None: addTZCleanup(self) def test_formatTimeWithDefaultFormat(self) -> None: """ Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. """ if tzset is None: raise SkipTest("Platform cannot change timezone; unable to verify offsets.") def testForTimeZone(name: str, expectedDST: str, expectedSTD: str) -> None: setTZ(name) localDST = mktime((2006, 6, 30, 0, 0, 0, 4, 181, 1)) localSTD = mktime((2007, 1, 31, 0, 0, 0, 2, 31, 0)) self.assertEqual(formatTime(localDST), expectedDST) self.assertEqual(formatTime(localSTD), expectedSTD) # UTC testForTimeZone( "UTC+00", "2006-06-30T00:00:00+0000", "2007-01-31T00:00:00+0000", ) # West of UTC testForTimeZone( "EST+05EDT,M4.1.0,M10.5.0", "2006-06-30T00:00:00-0400", "2007-01-31T00:00:00-0500", ) # East of UTC testForTimeZone( "CEST-01CEDT,M4.1.0,M10.5.0", "2006-06-30T00:00:00+0200", "2007-01-31T00:00:00+0100", ) # No DST testForTimeZone( "CST+06", "2006-06-30T00:00:00-0600", "2007-01-31T00:00:00-0600", ) def test_formatTimeWithNoTime(self) -> None: """ If C{when} argument is L{None}, we get the default output. """ self.assertEqual(formatTime(None), "-") self.assertEqual(formatTime(None, default="!"), "!") def test_formatTimeWithNoFormat(self) -> None: """ If C{timeFormat} argument is L{None}, we get the default output. """ t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) self.assertEqual(formatTime(t, timeFormat=None), "-") self.assertEqual(formatTime(t, timeFormat=None, default="!"), "!") def test_formatTimeWithAlternateTimeFormat(self) -> None: """ Alternate time format in output. """ t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) self.assertEqual(formatTime(t, timeFormat="%Y/%W"), "2013/38") def test_formatTimePercentF(self) -> None: """ "%f" supported in time format. """ self.assertEqual(formatTime(1000000.23456, timeFormat="%f"), "234560") class ClassicLogFormattingTests(unittest.TestCase): """ Tests for classic text log event formatting functions. """ def test_formatTimeDefault(self) -> None: """ Time is first field. Default time stamp format is RFC 3339 and offset respects the timezone as set by the standard C{TZ} environment variable and L{tzset} API. """ if tzset is None: raise SkipTest("Platform cannot change timezone; unable to verify offsets.") addTZCleanup(self) setTZ("UTC+00") t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event = dict(log_format="XYZZY", log_time=t) self.assertEqual( formatEventAsClassicLogText(event), "2013-09-24T11:40:47+0000 [-\x23-] XYZZY\n", ) def test_formatTimeCustom(self) -> None: """ Time is first field. Custom formatting function is an optional argument. """ def formatTime(t: Optional[float]) -> str: return f"__{t}__" event = dict(log_format="XYZZY", log_time=12345) self.assertEqual( formatEventAsClassicLogText(event, formatTime=formatTime), "__12345__ [-\x23-] XYZZY\n", ) def test_formatNamespace(self) -> None: """ Namespace is first part of second field. """ event = dict(log_format="XYZZY", log_namespace="my.namespace") self.assertEqual( formatEventAsClassicLogText(event), "- [my.namespace\x23-] XYZZY\n", ) def test_formatLevel(self) -> None: """ Level is second part of second field. """ event = dict(log_format="XYZZY", log_level=LogLevel.warn) self.assertEqual( formatEventAsClassicLogText(event), "- [-\x23warn] XYZZY\n", ) def test_formatSystem(self) -> None: """ System is second field. """ event = dict(log_format="XYZZY", log_system="S.Y.S.T.E.M.") self.assertEqual( formatEventAsClassicLogText(event), "- [S.Y.S.T.E.M.] XYZZY\n", ) def test_formatSystemRulz(self) -> None: """ System is not supplanted by namespace and level. """ event = dict( log_format="XYZZY", log_namespace="my.namespace", log_level=LogLevel.warn, log_system="S.Y.S.T.E.M.", ) self.assertEqual( formatEventAsClassicLogText(event), "- [S.Y.S.T.E.M.] XYZZY\n", ) def test_formatSystemUnformattable(self) -> None: """ System is not supplanted by namespace and level. """ event = dict(log_format="XYZZY", log_system=Unformattable()) self.assertEqual( formatEventAsClassicLogText(event), "- [UNFORMATTABLE] XYZZY\n", ) def test_formatFormat(self) -> None: """ Formatted event is last field. """ event = dict(log_format="id:{id}", id="123") self.assertEqual( formatEventAsClassicLogText(event), "- [-\x23-] id:123\n", ) def test_formatNoFormat(self) -> None: """ No format string. """ event = dict(id="123") self.assertIs(formatEventAsClassicLogText(event), None) def test_formatEmptyFormat(self) -> None: """ Empty format string. """ event = dict(log_format="", id="123") self.assertIs(formatEventAsClassicLogText(event), None) def test_formatFormatMultiLine(self) -> None: """ If the formatted event has newlines, indent additional lines. """ event = dict(log_format='XYZZY\nA hollow voice says:\n"Plugh"') self.assertEqual( formatEventAsClassicLogText(event), '- [-\x23-] XYZZY\n\tA hollow voice says:\n\t"Plugh"\n', ) class FormatFieldTests(unittest.TestCase): """ Tests for format field functions. """ def test_formatWithCall(self) -> None: """ L{formatWithCall} is an extended version of L{str.format} that will interpret a set of parentheses "C{()}" at the end of a format key to mean that the format key ought to be I{called} rather than stringified. """ self.assertEqual( formatWithCall( "Hello, {world}. {callme()}.", dict(world="earth", callme=lambda: "maybe"), ), "Hello, earth. maybe.", ) self.assertEqual( formatWithCall("Hello, {repr()!r}.", dict(repr=lambda: "repr")), "Hello, 'repr'.", ) class Unformattable: """ An object that raises an exception from C{__repr__}. """ def __repr__(self) -> str: return str(1 / 0) class CapturedError(Exception): """ A captured error for use in format tests. """ class EventAsTextTests(unittest.TestCase): """ Tests for L{eventAsText}, all of which ensure that the returned type is UTF-8 decoded text. """ def test_eventWithTraceback(self) -> None: """ An event with a C{log_failure} key will have a traceback appended. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() event: LogEvent = {"log_format": "This is a test log message"} event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIn(str(f.getTraceback()), eventText) self.assertIn("This is a test log message", eventText) def test_formatEmptyEventWithTraceback(self) -> None: """ An event with an empty C{log_format} key appends a traceback from the accompanying failure. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() event: LogEvent = {"log_format": ""} event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIn(str(f.getTraceback()), eventText) self.assertIn("This is a fake error", eventText) def test_formatUnformattableWithTraceback(self) -> None: """ An event with an unformattable value in the C{log_format} key still has a traceback appended. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() event = { "log_format": "{evil()}", "evil": lambda: 1 / 0, } event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIsInstance(eventText, str) self.assertIn(str(f.getTraceback()), eventText) self.assertIn("This is a fake error", eventText) def test_formatUnformattableErrorWithTraceback(self) -> None: """ An event with an unformattable value in the C{log_format} key, that throws an exception when __repr__ is invoked still has a traceback appended. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() event: LogEvent = { "log_format": "{evil()}", "evil": lambda: 1 / 0, cast(str, Unformattable()): "gurk", } event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIsInstance(eventText, str) self.assertIn("MESSAGE LOST", eventText) self.assertIn(str(f.getTraceback()), eventText) self.assertIn("This is a fake error", eventText) def test_formatEventUnformattableTraceback(self) -> None: """ If a traceback cannot be appended, a message indicating this is true is appended. """ event: LogEvent = {"log_format": ""} event["log_failure"] = object() eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIsInstance(eventText, str) self.assertIn("(UNABLE TO OBTAIN TRACEBACK FROM EVENT)", eventText) def test_formatEventNonCritical(self) -> None: """ An event with no C{log_failure} key will not have a traceback appended. """ event: LogEvent = {"log_format": "This is a test log message"} eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIsInstance(eventText, str) self.assertIn("This is a test log message", eventText) def test_formatTracebackMultibyte(self) -> None: """ An exception message with multibyte characters is properly handled. """ try: raise CapturedError("€") except CapturedError: f = Failure() event: LogEvent = {"log_format": "This is a test log message"} event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIn("€", eventText) self.assertIn("Traceback", eventText) def test_formatTracebackHandlesUTF8DecodeFailure(self) -> None: """ An error raised attempting to decode the UTF still produces a valid log message. """ try: # 'test' in utf-16 raise CapturedError(b"\xff\xfet\x00e\x00s\x00t\x00") except CapturedError: f = Failure() event: LogEvent = {"log_format": "This is a test log message"} event["log_failure"] = f eventText = eventAsText(event, includeTimestamp=True, includeSystem=False) self.assertIn("Traceback", eventText) self.assertIn(r'CapturedError(b"\xff\xfet\x00e\x00s\x00t\x00")', eventText) def test_eventAsTextSystemOnly(self) -> None: """ If includeSystem is specified as the only option no timestamp or traceback are printed. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event: LogEvent = { "log_format": "ABCD", "log_system": "fake_system", "log_time": t, } event["log_failure"] = f eventText = eventAsText( event, includeTimestamp=False, includeTraceback=False, includeSystem=True, ) self.assertEqual( eventText, "[fake_system] ABCD", ) def test_eventAsTextTimestampOnly(self) -> None: """ If includeTimestamp is specified as the only option no system or traceback are printed. """ if tzset is None: raise SkipTest("Platform cannot change timezone; unable to verify offsets.") addTZCleanup(self) setTZ("UTC+00") try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event: LogEvent = { "log_format": "ABCD", "log_system": "fake_system", "log_time": t, } event["log_failure"] = f eventText = eventAsText( event, includeTimestamp=True, includeTraceback=False, includeSystem=False, ) self.assertEqual( eventText, "2013-09-24T11:40:47+0000 ABCD", ) def test_eventAsTextSystemMissing(self) -> None: """ If includeSystem is specified with a missing system [-#-] is used. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event: LogEvent = { "log_format": "ABCD", "log_time": t, } event["log_failure"] = f eventText = eventAsText( event, includeTimestamp=False, includeTraceback=False, includeSystem=True, ) self.assertEqual( eventText, "[-\x23-] ABCD", ) def test_eventAsTextSystemMissingNamespaceAndLevel(self) -> None: """ If includeSystem is specified with a missing system but namespace and level are present they are used. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event: LogEvent = { "log_format": "ABCD", "log_time": t, "log_level": LogLevel.info, "log_namespace": "test", } event["log_failure"] = f eventText = eventAsText( event, includeTimestamp=False, includeTraceback=False, includeSystem=True, ) self.assertEqual( eventText, "[test\x23info] ABCD", ) def test_eventAsTextSystemMissingLevelOnly(self) -> None: """ If includeSystem is specified with a missing system but level is present, level is included. """ try: raise CapturedError("This is a fake error") except CapturedError: f = Failure() t = mktime((2013, 9, 24, 11, 40, 47, 1, 267, 1)) event: LogEvent = { "log_format": "ABCD", "log_time": t, "log_level": LogLevel.info, } event["log_failure"] = f eventText = eventAsText( event, includeTimestamp=False, includeTraceback=False, includeSystem=True, ) self.assertEqual( eventText, "[-\x23info] ABCD", ) test/test_legacy.py 0000644 00000034411 15027667615 0010422 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._legacy}. """ import logging as py_logging from time import time from typing import List, cast from zope.interface import implementer from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.python import context, log as legacyLog from twisted.python.failure import Failure from twisted.trial import unittest from .._format import formatEvent from .._interfaces import ILogObserver, LogEvent from .._legacy import LegacyLogObserverWrapper, publishToNewObserver from .._levels import LogLevel class LegacyLogObserverWrapperTests(unittest.TestCase): """ Tests for L{LegacyLogObserverWrapper}. """ def test_interface(self) -> None: """ L{LegacyLogObserverWrapper} is an L{ILogObserver}. """ legacyObserver = cast(legacyLog.ILogObserver, lambda e: None) observer = LegacyLogObserverWrapper(legacyObserver) try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def test_repr(self) -> None: """ L{LegacyLogObserverWrapper} returns the expected string. """ @implementer(legacyLog.ILogObserver) class LegacyObserver: def __repr__(self) -> str: return "<Legacy Observer>" def __call__(self, eventDict: legacyLog.EventDict) -> None: return observer = LegacyLogObserverWrapper(LegacyObserver()) self.assertEqual(repr(observer), "LegacyLogObserverWrapper(<Legacy Observer>)") def observe(self, event: LogEvent) -> LogEvent: """ Send an event to a wrapped legacy observer and capture the event as seen by that observer. @param event: an event @return: the event as observed by the legacy wrapper """ events: List[LogEvent] = [] legacyObserver = cast(legacyLog.ILogObserver, lambda e: events.append(e)) observer = LegacyLogObserverWrapper(legacyObserver) observer(event) self.assertEqual(len(events), 1) return events[0] def forwardAndVerify(self, event: LogEvent) -> LogEvent: """ Send an event to a wrapped legacy observer and verify that its data is preserved. @param event: an event @return: the event as observed by the legacy wrapper """ # Make sure keys that are expected by the logging system are present event.setdefault("log_time", time()) event.setdefault("log_system", "-") event.setdefault("log_level", LogLevel.info) # Send a copy: don't mutate me, bro observed = self.observe(dict(event)) # Don't expect modifications for key, value in event.items(): self.assertIn(key, observed) return observed def test_forward(self) -> None: """ Basic forwarding: event keys as observed by a legacy observer are the same. """ self.forwardAndVerify(dict(foo=1, bar=2)) def test_time(self) -> None: """ The new-style C{"log_time"} key is copied to the old-style C{"time"} key. """ stamp = time() event = self.forwardAndVerify(dict(log_time=stamp)) self.assertEqual(event["time"], stamp) def test_timeAlreadySet(self) -> None: """ The new-style C{"log_time"} key does not step on a pre-existing old-style C{"time"} key. """ stamp = time() event = self.forwardAndVerify(dict(log_time=stamp + 1, time=stamp)) self.assertEqual(event["time"], stamp) def test_system(self) -> None: """ The new-style C{"log_system"} key is copied to the old-style C{"system"} key. """ event = self.forwardAndVerify(dict(log_system="foo")) self.assertEqual(event["system"], "foo") def test_systemAlreadySet(self) -> None: """ The new-style C{"log_system"} key does not step on a pre-existing old-style C{"system"} key. """ event = self.forwardAndVerify(dict(log_system="foo", system="bar")) self.assertEqual(event["system"], "bar") def test_noSystem(self) -> None: """ If the new-style C{"log_system"} key is absent, the old-style C{"system"} key is set to C{"-"}. """ # Don't use forwardAndVerify(), since that sets log_system. event = dict(log_time=time(), log_level=LogLevel.info) observed = self.observe(dict(event)) self.assertEqual(observed["system"], "-") def test_levelNotChange(self) -> None: """ If explicitly set, the C{isError} key will be preserved when forwarding from a new-style logging emitter to a legacy logging observer, regardless of log level. """ self.forwardAndVerify(dict(log_level=LogLevel.info, isError=1)) self.forwardAndVerify(dict(log_level=LogLevel.warn, isError=1)) self.forwardAndVerify(dict(log_level=LogLevel.error, isError=0)) self.forwardAndVerify(dict(log_level=LogLevel.critical, isError=0)) def test_pythonLogLevelNotSet(self) -> None: """ The new-style C{"log_level"} key is not translated to the old-style C{"logLevel"} key. Events are forwarded from the old module from to new module and are then seen by old-style observers. We don't want to add unexpected keys to old-style events. """ event = self.forwardAndVerify(dict(log_level=LogLevel.info)) self.assertNotIn("logLevel", event) def test_stringPythonLogLevel(self) -> None: """ If a stdlib log level was provided as a string (eg. C{"WARNING"}) in the legacy "logLevel" key, it does not get converted to a number. The documentation suggested that numerical values should be used but this was not a requirement. """ event = self.forwardAndVerify( dict( logLevel="WARNING", # py_logging.WARNING is 30 ) ) self.assertEqual(event["logLevel"], "WARNING") def test_message(self) -> None: """ The old-style C{"message"} key is added, even if no new-style C{"log_format"} is given, as it is required, but may be empty. """ event = self.forwardAndVerify(dict()) self.assertEqual(event["message"], ()) # "message" is a tuple def test_messageAlreadySet(self) -> None: """ The old-style C{"message"} key is not modified if it already exists. """ event = self.forwardAndVerify(dict(message=("foo", "bar"))) self.assertEqual(event["message"], ("foo", "bar")) def test_format(self) -> None: """ Formatting is translated such that text is rendered correctly, even though old-style logging doesn't use PEP 3101 formatting. """ event = self.forwardAndVerify(dict(log_format="Hello, {who}!", who="world")) self.assertEqual(legacyLog.textFromEventDict(event), "Hello, world!") def test_formatMessage(self) -> None: """ Using the message key, which is special in old-style, works for new-style formatting. """ event = self.forwardAndVerify( dict(log_format="Hello, {message}!", message="world") ) self.assertEqual(legacyLog.textFromEventDict(event), "Hello, world!") def test_formatAlreadySet(self) -> None: """ Formatting is not altered if the old-style C{"format"} key already exists. """ event = self.forwardAndVerify(dict(log_format="Hello!", format="Howdy!")) self.assertEqual(legacyLog.textFromEventDict(event), "Howdy!") def eventWithFailure(self, **values: object) -> LogEvent: """ Create a new-style event with a captured failure. @param values: Additional values to include in the event. @return: the new event """ failure = Failure(RuntimeError("nyargh!")) return self.forwardAndVerify( dict(log_failure=failure, log_format="oopsie...", **values) ) def test_failure(self) -> None: """ Captured failures in the new style set the old-style C{"failure"}, C{"isError"}, and C{"why"} keys. """ event = self.eventWithFailure() self.assertIs(event["failure"], event["log_failure"]) self.assertTrue(event["isError"]) self.assertEqual(event["why"], "oopsie...") def test_failureAlreadySet(self) -> None: """ Captured failures in the new style do not step on a pre-existing old-style C{"failure"} key. """ failure = Failure(RuntimeError("Weak salsa!")) event = self.eventWithFailure(failure=failure) self.assertIs(event["failure"], failure) def test_isErrorAlreadySet(self) -> None: """ Captured failures in the new style do not step on a pre-existing old-style C{"isError"} key. """ event = self.eventWithFailure(isError=0) self.assertEqual(event["isError"], 0) def test_whyAlreadySet(self) -> None: """ Captured failures in the new style do not step on a pre-existing old-style C{"failure"} key. """ event = self.eventWithFailure(why="blah") self.assertEqual(event["why"], "blah") class PublishToNewObserverTests(unittest.TestCase): """ Tests for L{publishToNewObserver}. """ def setUp(self) -> None: self.events: List[LogEvent] = [] self.observer = cast(ILogObserver, self.events.append) def legacyEvent(self, *message: str, **values: object) -> legacyLog.EventDict: """ Return a basic old-style event as would be created by L{legacyLog.msg}. @param message: a message event value in the legacy event format @param values: additional event values in the legacy event format @return: a legacy event """ event = (context.get(legacyLog.ILogContext) or {}).copy() event.update(values) event["message"] = message event["time"] = time() if "isError" not in event: event["isError"] = 0 return event def test_observed(self) -> None: """ The observer is called exactly once. """ publishToNewObserver( self.observer, self.legacyEvent(), legacyLog.textFromEventDict ) self.assertEqual(len(self.events), 1) def test_time(self) -> None: """ The old-style C{"time"} key is copied to the new-style C{"log_time"} key. """ publishToNewObserver( self.observer, self.legacyEvent(), legacyLog.textFromEventDict ) self.assertEqual(self.events[0]["log_time"], self.events[0]["time"]) def test_message(self) -> None: """ A published old-style event should format as text in the same way as the given C{textFromEventDict} callable would format it. """ def textFromEventDict(event: LogEvent) -> str: return "".join(reversed(" ".join(event["message"]))) event = self.legacyEvent("Hello,", "world!") text = textFromEventDict(event) publishToNewObserver(self.observer, event, textFromEventDict) self.assertEqual(formatEvent(self.events[0]), text) def test_defaultLogLevel(self) -> None: """ Published event should have log level of L{LogLevel.info}. """ publishToNewObserver( self.observer, self.legacyEvent(), legacyLog.textFromEventDict ) self.assertEqual(self.events[0]["log_level"], LogLevel.info) def test_isError(self) -> None: """ If C{"isError"} is set to C{1} (true) on the legacy event, the C{"log_level"} key should get set to L{LogLevel.critical}. """ publishToNewObserver( self.observer, self.legacyEvent(isError=1), legacyLog.textFromEventDict ) self.assertEqual(self.events[0]["log_level"], LogLevel.critical) def test_stdlibLogLevel(self) -> None: """ If the old-style C{"logLevel"} key is set to a standard library logging level, using a predefined (L{int}) constant, the new-style C{"log_level"} key should get set to the corresponding log level. """ publishToNewObserver( self.observer, self.legacyEvent(logLevel=py_logging.WARNING), legacyLog.textFromEventDict, ) self.assertEqual(self.events[0]["log_level"], LogLevel.warn) def test_stdlibLogLevelWithString(self) -> None: """ If the old-style C{"logLevel"} key is set to a standard library logging level, using a string value, the new-style C{"log_level"} key should get set to the corresponding log level. """ publishToNewObserver( self.observer, self.legacyEvent(logLevel="WARNING"), legacyLog.textFromEventDict, ) self.assertEqual(self.events[0]["log_level"], LogLevel.warn) def test_stdlibLogLevelWithGarbage(self) -> None: """ If the old-style C{"logLevel"} key is set to a standard library logging level, using an unknown value, the new-style C{"log_level"} key should not get set. """ publishToNewObserver( self.observer, self.legacyEvent(logLevel="Foo!!!!!"), legacyLog.textFromEventDict, ) self.assertNotIn("log_level", self.events[0]) def test_defaultNamespace(self) -> None: """ Published event should have a namespace of C{"log_legacy"} to indicate that it was forwarded from legacy logging. """ publishToNewObserver( self.observer, self.legacyEvent(), legacyLog.textFromEventDict ) self.assertEqual(self.events[0]["log_namespace"], "log_legacy") def test_system(self) -> None: """ The old-style C{"system"} key is copied to the new-style C{"log_system"} key. """ publishToNewObserver( self.observer, self.legacyEvent(), legacyLog.textFromEventDict ) self.assertEqual(self.events[0]["log_system"], self.events[0]["system"]) test/test_stdlib.py 0000644 00000020757 15027667615 0010447 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._format}. """ import logging as py_logging import sys from inspect import getsourcefile from io import BytesIO, TextIOWrapper from logging import Formatter, LogRecord, StreamHandler, getLogger from typing import List, Optional, Tuple from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.python.compat import currentframe from twisted.python.failure import Failure from twisted.trial import unittest from .._interfaces import ILogObserver, LogEvent from .._levels import LogLevel from .._stdlib import STDLibLogObserver def nextLine() -> Tuple[Optional[str], int]: """ Retrive the file name and line number immediately after where this function is called. @return: the file name and line number """ caller = currentframe(1) return ( getsourcefile(sys.modules[caller.f_globals["__name__"]]), caller.f_lineno + 1, ) class StdlibLoggingContainer: """ Continer for a test configuration of stdlib logging objects. """ def __init__(self) -> None: self.rootLogger = getLogger("") self.originalLevel = self.rootLogger.getEffectiveLevel() self.rootLogger.setLevel(py_logging.DEBUG) self.bufferedHandler = BufferedHandler() self.rootLogger.addHandler(self.bufferedHandler) self.streamHandler, self.output = handlerAndBytesIO() self.rootLogger.addHandler(self.streamHandler) def close(self) -> None: """ Close the logger. """ self.rootLogger.setLevel(self.originalLevel) self.rootLogger.removeHandler(self.bufferedHandler) self.rootLogger.removeHandler(self.streamHandler) self.streamHandler.close() self.output.close() def outputAsText(self) -> str: """ Get the output to the underlying stream as text. @return: the output text """ return self.output.getvalue().decode("utf-8") class STDLibLogObserverTests(unittest.TestCase): """ Tests for L{STDLibLogObserver}. """ def test_interface(self) -> None: """ L{STDLibLogObserver} is an L{ILogObserver}. """ observer = STDLibLogObserver() try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def py_logger(self) -> StdlibLoggingContainer: """ Create a logging object we can use to test with. @return: a stdlib-style logger """ logger = StdlibLoggingContainer() self.addCleanup(logger.close) return logger def logEvent(self, *events: LogEvent) -> Tuple[List[LogRecord], str]: """ Send one or more events to Python's logging module, and capture the emitted L{LogRecord}s and output stream as a string. @param events: events @return: a tuple: (records, output) """ pl = self.py_logger() observer = STDLibLogObserver( # Add 1 to default stack depth to skip *this* frame, since # tests will want to know about their own frames. stackDepth=STDLibLogObserver.defaultStackDepth + 1 ) for event in events: observer(event) return pl.bufferedHandler.records, pl.outputAsText() def test_name(self) -> None: """ Logger name. """ records, output = self.logEvent({}) self.assertEqual(len(records), 1) self.assertEqual(records[0].name, "twisted") def test_levels(self) -> None: """ Log levels. """ levelMapping = { None: py_logging.INFO, # Default LogLevel.debug: py_logging.DEBUG, LogLevel.info: py_logging.INFO, LogLevel.warn: py_logging.WARNING, LogLevel.error: py_logging.ERROR, LogLevel.critical: py_logging.CRITICAL, } # Build a set of events for each log level events = [] for level, pyLevel in levelMapping.items(): event = {} # Set the log level on the event, except for default if level is not None: event["log_level"] = level # Remember the Python log level we expect to see for this # event (as an int) event["py_levelno"] = int(pyLevel) events.append(event) records, output = self.logEvent(*events) self.assertEqual(len(records), len(levelMapping)) # Check that each event has the correct level for i in range(len(records)): self.assertEqual(records[i].levelno, events[i]["py_levelno"]) def test_callerInfo(self) -> None: """ C{pathname}, C{lineno}, C{exc_info}, C{func} is set properly on records. """ filename, logLine = nextLine() records, output = self.logEvent({}) self.assertEqual(len(records), 1) self.assertEqual(records[0].pathname, filename) self.assertEqual(records[0].lineno, logLine) self.assertIsNone(records[0].exc_info) # Attribute "func" is missing from record, which is weird because it's # documented. # self.assertEqual(records[0].func, "test_callerInfo") def test_basicFormat(self) -> None: """ Basic formattable event passes the format along correctly. """ event = dict(log_format="Hello, {who}!", who="dude") records, output = self.logEvent(event) self.assertEqual(len(records), 1) self.assertEqual(str(records[0].msg), "Hello, dude!") self.assertEqual(records[0].args, ()) def test_basicFormatRendered(self) -> None: """ Basic formattable event renders correctly. """ event = dict(log_format="Hello, {who}!", who="dude") records, output = self.logEvent(event) self.assertEqual(len(records), 1) self.assertTrue(output.endswith(":Hello, dude!\n"), repr(output)) def test_noFormat(self) -> None: """ Event with no format. """ records, output = self.logEvent({}) self.assertEqual(len(records), 1) self.assertEqual(str(records[0].msg), "") def test_failure(self) -> None: """ An event with a failure logs the failure details as well. """ def failing_func() -> None: 1 / 0 try: failing_func() except ZeroDivisionError: failure = Failure() event = dict(log_format="Hi mom", who="me", log_failure=failure) records, output = self.logEvent(event) self.assertEqual(len(records), 1) self.assertIn("Hi mom", output) self.assertIn("in failing_func", output) self.assertIn("ZeroDivisionError", output) def test_cleanedFailure(self) -> None: """ A cleaned Failure object has a fake traceback object; make sure that logging such a failure still results in the exception details being logged. """ def failing_func() -> None: 1 / 0 try: failing_func() except ZeroDivisionError: failure = Failure() failure.cleanFailure() event = dict(log_format="Hi mom", who="me", log_failure=failure) records, output = self.logEvent(event) self.assertEqual(len(records), 1) self.assertIn("Hi mom", output) self.assertIn("in failing_func", output) self.assertIn("ZeroDivisionError", output) def handlerAndBytesIO() -> Tuple[StreamHandler, BytesIO]: """ Construct a 2-tuple of C{(StreamHandler, BytesIO)} for testing interaction with the 'logging' module. @return: handler and io object """ output = BytesIO() template = py_logging.BASIC_FORMAT stream = TextIOWrapper(output, encoding="utf-8", newline="\n") formatter = Formatter(template) handler = StreamHandler(stream) handler.setFormatter(formatter) return handler, output class BufferedHandler(py_logging.Handler): """ A L{py_logging.Handler} that remembers all logged records in a list. """ def __init__(self) -> None: """ Initialize this L{BufferedHandler}. """ py_logging.Handler.__init__(self) self.records: List[LogRecord] = [] def emit(self, record: LogRecord) -> None: """ Remember the record. """ self.records.append(record) test/test_json.py 0000644 00000043542 15027667615 0010134 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Tests for L{twisted.logger._json}. """ from io import BytesIO, StringIO from typing import IO, Any, List, Optional, Sequence, cast from zope.interface import implementer from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.python.failure import Failure from twisted.trial.unittest import TestCase from .._flatten import extractField from .._format import formatEvent from .._global import globalLogPublisher from .._interfaces import ILogObserver, LogEvent from .._json import ( eventAsJSON, eventFromJSON, eventsFromJSONLogFile, jsonFileLogObserver, log as jsonLog, ) from .._levels import LogLevel from .._logger import Logger from .._observer import LogPublisher def savedJSONInvariants(testCase: TestCase, savedJSON: str) -> str: """ Assert a few things about the result of L{eventAsJSON}, then return it. @param testCase: The L{TestCase} with which to perform the assertions. @param savedJSON: The result of L{eventAsJSON}. @return: C{savedJSON} @raise AssertionError: If any of the preconditions fail. """ testCase.assertIsInstance(savedJSON, str) testCase.assertEqual(savedJSON.count("\n"), 0) return savedJSON class SaveLoadTests(TestCase): """ Tests for loading and saving log events. """ def savedEventJSON(self, event: LogEvent) -> str: """ Serialize some an events, assert some things about it, and return the JSON. @param event: An event. @return: JSON. """ return savedJSONInvariants(self, eventAsJSON(event)) def test_simpleSaveLoad(self) -> None: """ Saving and loading an empty dictionary results in an empty dictionary. """ self.assertEqual(eventFromJSON(self.savedEventJSON({})), {}) def test_saveLoad(self) -> None: """ Saving and loading a dictionary with some simple values in it results in those same simple values in the output; according to JSON's rules, though, all dictionary keys must be L{str} and any non-L{str} keys will be converted. """ self.assertEqual( eventFromJSON(self.savedEventJSON({1: 2, "3": "4"})), # type: ignore[dict-item] {"1": 2, "3": "4"}, ) def test_saveUnPersistable(self) -> None: """ Saving and loading an object which cannot be represented in JSON will result in a placeholder. """ self.assertEqual( eventFromJSON(self.savedEventJSON({"1": 2, "3": object()})), {"1": 2, "3": {"unpersistable": True}}, ) def test_saveNonASCII(self) -> None: """ Non-ASCII keys and values can be saved and loaded. """ self.assertEqual( eventFromJSON(self.savedEventJSON({"\u1234": "\u4321", "3": object()})), {"\u1234": "\u4321", "3": {"unpersistable": True}}, ) def test_saveBytes(self) -> None: """ Any L{bytes} objects will be saved as if they are latin-1 so they can be faithfully re-loaded. """ inputEvent = {"hello": bytes(range(255))} # On Python 3, bytes keys will be skipped by the JSON encoder. Not # much we can do about that. Let's make sure that we don't get an # error, though. inputEvent.update({b"skipped": "okay"}) # type: ignore[dict-item] self.assertEqual( eventFromJSON(self.savedEventJSON(inputEvent)), {"hello": bytes(range(255)).decode("charmap")}, ) def test_saveUnPersistableThenFormat(self) -> None: """ Saving and loading an object which cannot be represented in JSON, but has a string representation which I{can} be saved as JSON, will result in the same string formatting; any extractable fields will retain their data types. """ class Reprable: def __init__(self, value: object) -> None: self.value = value def __repr__(self) -> str: return "reprable" inputEvent = {"log_format": "{object} {object.value}", "object": Reprable(7)} outputEvent = eventFromJSON(self.savedEventJSON(inputEvent)) self.assertEqual(formatEvent(outputEvent), "reprable 7") def test_extractingFieldsPostLoad(self) -> None: """ L{extractField} can extract fields from an object that's been saved and loaded from JSON. """ class Obj: def __init__(self) -> None: self.value = 345 inputEvent = dict(log_format="{object.value}", object=Obj()) loadedEvent = eventFromJSON(self.savedEventJSON(inputEvent)) self.assertEqual(extractField("object.value", loadedEvent), 345) # The behavior of extractField is consistent between pre-persistence # and post-persistence events, although looking up the key directly # won't be: self.assertRaises(KeyError, extractField, "object", loadedEvent) self.assertRaises(KeyError, extractField, "object", inputEvent) def test_failureStructurePreserved(self) -> None: """ Round-tripping a failure through L{eventAsJSON} preserves its class and structure. """ events: List[LogEvent] = [] log = Logger(observer=cast(ILogObserver, events.append)) try: 1 / 0 except ZeroDivisionError: f = Failure() log.failure("a message about failure", f) self.assertEqual(len(events), 1) loaded = eventFromJSON(self.savedEventJSON(events[0]))["log_failure"] self.assertIsInstance(loaded, Failure) self.assertTrue(loaded.check(ZeroDivisionError)) self.assertIsInstance(loaded.getTraceback(), str) def test_saveLoadLevel(self) -> None: """ It's important that the C{log_level} key remain a L{constantly.NamedConstant} object. """ inputEvent = dict(log_level=LogLevel.warn) loadedEvent = eventFromJSON(self.savedEventJSON(inputEvent)) self.assertIs(loadedEvent["log_level"], LogLevel.warn) def test_saveLoadUnknownLevel(self) -> None: """ If a saved bit of JSON (let's say, from a future version of Twisted) were to persist a different log_level, it will resolve as None. """ loadedEvent = eventFromJSON( '{"log_level": {"name": "other", ' '"__class_uuid__": "02E59486-F24D-46AD-8224-3ACDF2A5732A"}}' ) self.assertEqual(loadedEvent, dict(log_level=None)) class FileLogObserverTests(TestCase): """ Tests for L{jsonFileLogObserver}. """ def test_interface(self) -> None: """ A L{FileLogObserver} returned by L{jsonFileLogObserver} is an L{ILogObserver}. """ with StringIO() as fileHandle: observer = jsonFileLogObserver(fileHandle) try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def assertObserverWritesJSON(self, recordSeparator: str = "\x1e") -> None: """ Asserts that an observer created by L{jsonFileLogObserver} with the given arguments writes events serialized as JSON text, using the given record separator. @param recordSeparator: C{recordSeparator} argument to L{jsonFileLogObserver} """ with StringIO() as fileHandle: observer = jsonFileLogObserver(fileHandle, recordSeparator) event = dict(x=1) observer(event) self.assertEqual(fileHandle.getvalue(), f'{recordSeparator}{{"x": 1}}\n') def test_observeWritesDefaultRecordSeparator(self) -> None: """ A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. By default, the record separator is C{"\\x1e"}. """ self.assertObserverWritesJSON() def test_observeWritesEmptyRecordSeparator(self) -> None: """ A L{FileLogObserver} created by L{jsonFileLogObserver} writes events serialzed as JSON text to a file when it observes events. This test sets the record separator to C{""}. """ self.assertObserverWritesJSON(recordSeparator="") def test_failureFormatting(self) -> None: """ A L{FileLogObserver} created by L{jsonFileLogObserver} writes failures serialized as JSON text to a file when it observes events. """ io = StringIO() publisher = LogPublisher() logged: List[LogEvent] = [] publisher.addObserver(cast(ILogObserver, logged.append)) publisher.addObserver(jsonFileLogObserver(io)) logger = Logger(observer=publisher) try: 1 / 0 except BaseException: logger.failure("failed as expected") reader = StringIO(io.getvalue()) deserialized = list(eventsFromJSONLogFile(reader)) def checkEvents(logEvents: Sequence[LogEvent]) -> None: self.assertEqual(len(logEvents), 1) [failureEvent] = logEvents self.assertIn("log_failure", failureEvent) failureObject = failureEvent["log_failure"] self.assertIsInstance(failureObject, Failure) tracebackObject = failureObject.getTracebackObject() self.assertEqual( tracebackObject.tb_frame.f_code.co_filename.rstrip("co"), __file__.rstrip("co"), ) checkEvents(logged) checkEvents(deserialized) class LogFileReaderTests(TestCase): """ Tests for L{eventsFromJSONLogFile}. """ def setUp(self) -> None: self.errorEvents: List[LogEvent] = [] @implementer(ILogObserver) def observer(event: LogEvent) -> None: if event["log_namespace"] == jsonLog.namespace and "record" in event: self.errorEvents.append(event) self.logObserver = observer globalLogPublisher.addObserver(observer) def tearDown(self) -> None: globalLogPublisher.removeObserver(self.logObserver) def _readEvents( self, inFile: IO[Any], recordSeparator: Optional[str] = None, bufferSize: int = 4096, ) -> None: """ Test that L{eventsFromJSONLogFile} reads two pre-defined events from a file: C{{"x": 1}} and C{{"y": 2}}. @param inFile: C{inFile} argument to L{eventsFromJSONLogFile} @param recordSeparator: C{recordSeparator} argument to L{eventsFromJSONLogFile} @param bufferSize: C{bufferSize} argument to L{eventsFromJSONLogFile} """ events = iter(eventsFromJSONLogFile(inFile, recordSeparator, bufferSize)) self.assertEqual(next(events), {"x": 1}) self.assertEqual(next(events), {"y": 2}) self.assertRaises(StopIteration, next, events) # No more events def test_readEventsAutoWithRecordSeparator(self) -> None: """ L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{"\\x1e"} as the record separator. """ with StringIO('\x1e{"x": 1}\n' '\x1e{"y": 2}\n') as fileHandle: self._readEvents(fileHandle) self.assertEqual(len(self.errorEvents), 0) def test_readEventsAutoEmptyRecordSeparator(self) -> None: """ L{eventsFromJSONLogFile} reads events from a file and automatically detects use of C{""} as the record separator. """ with StringIO('{"x": 1}\n' '{"y": 2}\n') as fileHandle: self._readEvents(fileHandle) self.assertEqual(len(self.errorEvents), 0) def test_readEventsExplicitRecordSeparator(self) -> None: """ L{eventsFromJSONLogFile} reads events from a file and is told to use a specific record separator. """ # Use "\x08" (backspace)... because that seems weird enough. with StringIO('\x08{"x": 1}\n' '\x08{"y": 2}\n') as fileHandle: self._readEvents(fileHandle, recordSeparator="\x08") self.assertEqual(len(self.errorEvents), 0) def test_readEventsPartialBuffer(self) -> None: """ L{eventsFromJSONLogFile} handles buffering a partial event. """ with StringIO('\x1e{"x": 1}\n' '\x1e{"y": 2}\n') as fileHandle: # Use a buffer size smaller than the event text. self._readEvents(fileHandle, bufferSize=1) self.assertEqual(len(self.errorEvents), 0) def test_readTruncated(self) -> None: """ If the JSON text for a record is truncated, skip it. """ with StringIO('\x1e{"x": 1' '\x1e{"y": 2}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle)) self.assertEqual(next(events), {"y": 2}) self.assertRaises(StopIteration, next, events) # No more events # We should have logged the lost record self.assertEqual(len(self.errorEvents), 1) self.assertEqual( self.errorEvents[0]["log_format"], "Unable to read truncated JSON record: {record!r}", ) self.assertEqual(self.errorEvents[0]["record"], b'{"x": 1') def test_readUnicode(self) -> None: """ If the file being read from vends L{str}, strings decode from JSON as-is. """ # The Euro currency sign is "\u20ac" with StringIO('\x1e{"currency": "\u20ac"}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle)) self.assertEqual(next(events), {"currency": "\u20ac"}) self.assertRaises(StopIteration, next, events) # No more events self.assertEqual(len(self.errorEvents), 0) def test_readUTF8Bytes(self) -> None: """ If the file being read from vends L{bytes}, strings decode from JSON as UTF-8. """ # The Euro currency sign is b"\xe2\x82\xac" in UTF-8 with BytesIO(b'\x1e{"currency": "\xe2\x82\xac"}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle)) # The Euro currency sign is "\u20ac" self.assertEqual(next(events), {"currency": "\u20ac"}) self.assertRaises(StopIteration, next, events) # No more events self.assertEqual(len(self.errorEvents), 0) def test_readTruncatedUTF8Bytes(self) -> None: """ If the JSON text for a record is truncated in the middle of a two-byte Unicode codepoint, we don't want to see a codec exception and the stream is read properly when the additional data arrives. """ # The Euro currency sign is "\u20ac" and encodes in UTF-8 as three # bytes: b"\xe2\x82\xac". with BytesIO(b'\x1e{"x": "\xe2\x82\xac"}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle, bufferSize=8)) self.assertEqual(next(events), {"x": "\u20ac"}) # Got text self.assertRaises(StopIteration, next, events) # No more events self.assertEqual(len(self.errorEvents), 0) def test_readInvalidUTF8Bytes(self) -> None: """ If the JSON text for a record contains invalid UTF-8 text, ignore that record. """ # The string b"\xe2\xac" is bogus with BytesIO(b'\x1e{"x": "\xe2\xac"}\n' b'\x1e{"y": 2}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle)) self.assertEqual(next(events), {"y": 2}) self.assertRaises(StopIteration, next, events) # No more events # We should have logged the lost record self.assertEqual(len(self.errorEvents), 1) self.assertEqual( self.errorEvents[0]["log_format"], "Unable to decode UTF-8 for JSON record: {record!r}", ) self.assertEqual(self.errorEvents[0]["record"], b'{"x": "\xe2\xac"}\n') def test_readInvalidJSON(self) -> None: """ If the JSON text for a record is invalid, skip it. """ with StringIO('\x1e{"x": }\n' '\x1e{"y": 2}\n') as fileHandle: events = iter(eventsFromJSONLogFile(fileHandle)) self.assertEqual(next(events), {"y": 2}) self.assertRaises(StopIteration, next, events) # No more events # We should have logged the lost record self.assertEqual(len(self.errorEvents), 1) self.assertEqual( self.errorEvents[0]["log_format"], "Unable to read JSON record: {record!r}", ) self.assertEqual(self.errorEvents[0]["record"], b'{"x": }\n') def test_readUnseparated(self) -> None: """ Multiple events without a record separator are skipped. """ with StringIO('\x1e{"x": 1}\n' '{"y": 2}\n') as fileHandle: events = eventsFromJSONLogFile(fileHandle) self.assertRaises(StopIteration, next, events) # No more events # We should have logged the lost record self.assertEqual(len(self.errorEvents), 1) self.assertEqual( self.errorEvents[0]["log_format"], "Unable to read JSON record: {record!r}", ) self.assertEqual(self.errorEvents[0]["record"], b'{"x": 1}\n{"y": 2}\n') def test_roundTrip(self) -> None: """ Data written by a L{FileLogObserver} returned by L{jsonFileLogObserver} and read by L{eventsFromJSONLogFile} is reconstructed properly. """ event = dict(x=1) with StringIO() as fileHandle: observer = jsonFileLogObserver(fileHandle) observer(event) fileHandle.seek(0) events = eventsFromJSONLogFile(fileHandle) self.assertEqual(tuple(events), (event,)) self.assertEqual(len(self.errorEvents), 0) test/test_global.py 0000644 00000030725 15027667615 0010422 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._global}. """ import io from typing import IO, Any, List, Optional, TextIO, Tuple, Type, cast from twisted.python.failure import Failure from twisted.trial import unittest from .._file import textFileLogObserver from .._global import MORE_THAN_ONCE_WARNING, LogBeginner from .._interfaces import ILogObserver, LogEvent from .._levels import LogLevel from .._logger import Logger from .._observer import LogPublisher from ..test.test_stdlib import nextLine def compareEvents( test: unittest.TestCase, actualEvents: List[LogEvent], expectedEvents: List[LogEvent], ) -> None: """ Compare two sequences of log events, examining only the the keys which are present in both. @param test: a test case doing the comparison @param actualEvents: A list of log events that were emitted by a logger. @param expectedEvents: A list of log events that were expected by a test. """ if len(actualEvents) != len(expectedEvents): test.assertEqual(actualEvents, expectedEvents) allMergedKeys = set() for event in expectedEvents: allMergedKeys |= set(event.keys()) def simplify(event: LogEvent) -> LogEvent: copy = event.copy() for key in event.keys(): if key not in allMergedKeys: copy.pop(key) return copy simplifiedActual = [simplify(event) for event in actualEvents] test.assertEqual(simplifiedActual, expectedEvents) class LogBeginnerTests(unittest.TestCase): """ Tests for L{LogBeginner}. """ def setUp(self) -> None: self.publisher = LogPublisher() self.errorStream = io.StringIO() class NotSys: stdout = object() stderr = object() class NotWarnings: def __init__(self) -> None: self.warnings: List[ Tuple[ str, Type[Warning], str, int, Optional[IO[Any]], Optional[int] ] ] = [] def showwarning( self, message: str, category: Type[Warning], filename: str, lineno: int, file: Optional[IO[Any]] = None, line: Optional[int] = None, ) -> None: """ Emulate warnings.showwarning. @param message: A warning message to emit. @param category: A warning category to associate with C{message}. @param filename: A file name for the source code file issuing the warning. @param lineno: A line number in the source file where the warning was issued. @param file: A file to write the warning message to. If L{None}, write to L{sys.stderr}. @param line: A line of source code to include with the warning message. If L{None}, attempt to read the line from C{filename} and C{lineno}. """ self.warnings.append((message, category, filename, lineno, file, line)) self.sysModule = NotSys() self.warningsModule = NotWarnings() self.beginner = LogBeginner( self.publisher, self.errorStream, self.sysModule, self.warningsModule ) def test_beginLoggingToAddObservers(self) -> None: """ Test that C{beginLoggingTo()} adds observers. """ event = dict(foo=1, bar=2) events1: List[LogEvent] = [] events2: List[LogEvent] = [] o1 = cast(ILogObserver, lambda e: events1.append(e)) o2 = cast(ILogObserver, lambda e: events2.append(e)) self.beginner.beginLoggingTo((o1, o2)) self.publisher(event) self.assertEqual([event], events1) self.assertEqual([event], events2) def test_beginLoggingToBufferedEvents(self) -> None: """ Test that events are buffered until C{beginLoggingTo()} is called. """ event = dict(foo=1, bar=2) events1: List[LogEvent] = [] events2: List[LogEvent] = [] o1 = cast(ILogObserver, lambda e: events1.append(e)) o2 = cast(ILogObserver, lambda e: events2.append(e)) self.publisher(event) # Before beginLoggingTo; this is buffered self.beginner.beginLoggingTo((o1, o2)) self.assertEqual([event], events1) self.assertEqual([event], events2) def _bufferLimitTest(self, limit: int, beginner: LogBeginner) -> None: """ Verify that when more than C{limit} events are logged to L{LogBeginner}, only the last C{limit} are replayed by L{LogBeginner.beginLoggingTo}. @param limit: The maximum number of events the log beginner should buffer. @param beginner: The L{LogBeginner} against which to verify. @raise: C{self.failureException} if the wrong events are replayed by C{beginner}. """ for count in range(limit + 1): self.publisher(dict(count=count)) events: List[LogEvent] = [] beginner.beginLoggingTo([cast(ILogObserver, events.append)]) self.assertEqual( list(range(1, limit + 1)), list(event["count"] for event in events), ) def test_defaultBufferLimit(self) -> None: """ Up to C{LogBeginner._DEFAULT_BUFFER_SIZE} log events are buffered for replay by L{LogBeginner.beginLoggingTo}. """ limit = LogBeginner._DEFAULT_BUFFER_SIZE self._bufferLimitTest(limit, self.beginner) def test_overrideBufferLimit(self) -> None: """ The size of the L{LogBeginner} event buffer can be overridden with the C{initialBufferSize} initilizer argument. """ limit = 3 beginner = LogBeginner( self.publisher, self.errorStream, self.sysModule, self.warningsModule, initialBufferSize=limit, ) self._bufferLimitTest(limit, beginner) def test_beginLoggingToTwice(self) -> None: """ When invoked twice, L{LogBeginner.beginLoggingTo} will emit a log message warning the user that they previously began logging, and add the new log observers. """ events1: List[LogEvent] = [] events2: List[LogEvent] = [] fileHandle = io.StringIO() textObserver = textFileLogObserver(fileHandle) self.publisher(dict(event="prebuffer")) firstFilename, firstLine = nextLine() self.beginner.beginLoggingTo([cast(ILogObserver, events1.append), textObserver]) self.publisher(dict(event="postbuffer")) secondFilename, secondLine = nextLine() self.beginner.beginLoggingTo([cast(ILogObserver, events2.append), textObserver]) self.publisher(dict(event="postwarn")) warning = dict( log_format=MORE_THAN_ONCE_WARNING, log_level=LogLevel.warn, fileNow=secondFilename, lineNow=secondLine, fileThen=firstFilename, lineThen=firstLine, ) self.maxDiff = None compareEvents( self, events1, [ dict(event="prebuffer"), dict(event="postbuffer"), warning, dict(event="postwarn"), ], ) compareEvents(self, events2, [warning, dict(event="postwarn")]) output = fileHandle.getvalue() self.assertIn(f"<{firstFilename}:{firstLine}>", output) self.assertIn(f"<{secondFilename}:{secondLine}>", output) def test_criticalLogging(self) -> None: """ Critical messages will be written as text to the error stream. """ log = Logger(observer=self.publisher) log.info("ignore this") log.critical("a critical {message}", message="message") self.assertEqual(self.errorStream.getvalue(), "a critical message\n") def test_criticalLoggingStops(self) -> None: """ Once logging has begun with C{beginLoggingTo}, critical messages are no longer written to the output stream. """ log = Logger(observer=self.publisher) self.beginner.beginLoggingTo(()) log.critical("another critical message") self.assertEqual(self.errorStream.getvalue(), "") def test_beginLoggingToRedirectStandardIO(self) -> None: """ L{LogBeginner.beginLoggingTo} will re-direct the standard output and error streams by setting the C{stdio} and C{stderr} attributes on its sys module object. """ events: List[LogEvent] = [] self.beginner.beginLoggingTo([cast(ILogObserver, events.append)]) print("Hello, world.", file=cast(TextIO, self.sysModule.stdout)) compareEvents( self, events, [dict(log_namespace="stdout", log_io="Hello, world.")] ) del events[:] print("Error, world.", file=cast(TextIO, self.sysModule.stderr)) compareEvents( self, events, [dict(log_namespace="stderr", log_io="Error, world.")] ) def test_beginLoggingToDontRedirect(self) -> None: """ L{LogBeginner.beginLoggingTo} will leave the existing stdout/stderr in place if it has been told not to replace them. """ oldOut = self.sysModule.stdout oldErr = self.sysModule.stderr self.beginner.beginLoggingTo((), redirectStandardIO=False) self.assertIs(self.sysModule.stdout, oldOut) self.assertIs(self.sysModule.stderr, oldErr) def test_beginLoggingToPreservesEncoding(self) -> None: """ When L{LogBeginner.beginLoggingTo} redirects stdout/stderr streams, the replacement streams will preserve the encoding of the replaced streams, to minimally disrupt any application relying on a specific encoding. """ weird = io.TextIOWrapper(io.BytesIO(), "shift-JIS") weirderr = io.TextIOWrapper(io.BytesIO(), "big5") self.sysModule.stdout = weird self.sysModule.stderr = weirderr events: List[LogEvent] = [] self.beginner.beginLoggingTo([cast(ILogObserver, events.append)]) stdout = cast(TextIO, self.sysModule.stdout) stderr = cast(TextIO, self.sysModule.stderr) self.assertEqual(stdout.encoding, "shift-JIS") self.assertEqual(stderr.encoding, "big5") stdout.write(b"\x97\x9B\n") # type: ignore[arg-type] stderr.write(b"\xBC\xFC\n") # type: ignore[arg-type] compareEvents(self, events, [dict(log_io="\u674e"), dict(log_io="\u7469")]) def test_warningsModule(self) -> None: """ L{LogBeginner.beginLoggingTo} will redirect the warnings of its warnings module into the logging system. """ self.warningsModule.showwarning("a message", DeprecationWarning, __file__, 1) events: List[LogEvent] = [] self.beginner.beginLoggingTo([cast(ILogObserver, events.append)]) self.warningsModule.showwarning( "another message", DeprecationWarning, __file__, 2 ) f = io.StringIO() self.warningsModule.showwarning( "yet another", DeprecationWarning, __file__, 3, file=f ) self.assertEqual( self.warningsModule.warnings, [ ("a message", DeprecationWarning, __file__, 1, None, None), ("yet another", DeprecationWarning, __file__, 3, f, None), ], ) compareEvents( self, events, [ dict( warning="another message", category=( DeprecationWarning.__module__ + "." + DeprecationWarning.__name__ ), filename=__file__, lineno=2, ) ], ) def test_failuresAppendTracebacks(self) -> None: """ The string resulting from a logged failure contains a traceback. """ f = Failure(Exception("this is not the behavior you are looking for")) log = Logger(observer=self.publisher) log.failure("a failure", failure=f) msg = self.errorStream.getvalue() self.assertIn("a failure", msg) self.assertIn("this is not the behavior you are looking for", msg) self.assertIn("Traceback", msg) test/test_capture.py 0000644 00000002100 15027667615 0010607 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._capture}. """ from twisted.logger import Logger, LogLevel from twisted.trial.unittest import TestCase from .._capture import capturedLogs class LogCaptureTests(TestCase): """ Tests for L{LogCaptureTests}. """ log = Logger() def test_capture(self) -> None: """ Events logged within context are captured. """ foo = object() with capturedLogs() as captured: self.log.debug("Capture this, please", foo=foo) self.log.info("Capture this too, please", foo=foo) self.assertTrue(len(captured) == 2) self.assertEqual(captured[0]["log_format"], "Capture this, please") self.assertEqual(captured[0]["log_level"], LogLevel.debug) self.assertEqual(captured[0]["foo"], foo) self.assertEqual(captured[1]["log_format"], "Capture this too, please") self.assertEqual(captured[1]["log_level"], LogLevel.info) self.assertEqual(captured[1]["foo"], foo) test/test_util.py 0000644 00000006775 15027667615 0010147 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._util}. """ from zope.interface import implementer from twisted.trial import unittest from .._interfaces import ILogObserver, LogEvent from .._observer import LogPublisher from .._util import formatTrace class UtilTests(unittest.TestCase): """ Utility tests. """ def test_trace(self) -> None: """ Tracing keeps track of forwarding done by the publisher. """ publisher = LogPublisher() event: LogEvent = dict(log_trace=[]) @implementer(ILogObserver) def o1(e: LogEvent) -> None: pass @implementer(ILogObserver) def o2(e: LogEvent) -> None: self.assertIs(e, event) self.assertEqual( e["log_trace"], [ (publisher, o1), (publisher, o2), # Event hasn't been sent to o3 yet ], ) @implementer(ILogObserver) def o3(e: LogEvent) -> None: self.assertIs(e, event) self.assertEqual( e["log_trace"], [ (publisher, o1), (publisher, o2), (publisher, o3), ], ) publisher.addObserver(o1) publisher.addObserver(o2) publisher.addObserver(o3) publisher(event) def test_formatTrace(self) -> None: """ Format trace as string. """ event: LogEvent = dict(log_trace=[]) @implementer(ILogObserver) def o1(e: LogEvent) -> None: pass @implementer(ILogObserver) def o2(e: LogEvent) -> None: pass @implementer(ILogObserver) def o3(e: LogEvent) -> None: pass @implementer(ILogObserver) def o4(e: LogEvent) -> None: pass @implementer(ILogObserver) def o5(e: LogEvent) -> None: pass o1.name = "root/o1" # type: ignore[attr-defined] o2.name = "root/p1/o2" o3.name = "root/p1/o3" o4.name = "root/p1/p2/o4" o5.name = "root/o5" @implementer(ILogObserver) def testObserver(e: LogEvent) -> None: self.assertIs(e, event) trace = formatTrace(e["log_trace"]) self.assertEqual( trace, ( "{root} ({root.name})\n" " -> {o1} ({o1.name})\n" " -> {p1} ({p1.name})\n" " -> {o2} ({o2.name})\n" " -> {o3} ({o3.name})\n" " -> {p2} ({p2.name})\n" " -> {o4} ({o4.name})\n" " -> {o5} ({o5.name})\n" " -> {oTest}\n" ).format( root=root, o1=o1, o2=o2, o3=o3, o4=o4, o5=o5, p1=p1, p2=p2, oTest=oTest, ), ) oTest = testObserver p2 = LogPublisher(o4) p1 = LogPublisher(o2, o3, p2) p2.name = "root/p1/p2/" # type: ignore[attr-defined] p1.name = "root/p1/" # type: ignore[attr-defined] root = LogPublisher(o1, p1, o5, oTest) root.name = "root/" # type: ignore[attr-defined] root(event) test/test_flatten.py 0000644 00000022657 15027667615 0010624 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._format}. """ import json from itertools import count from typing import Any, Callable, Optional try: from time import tzset except ImportError: tzset = None # type: ignore[assignment] from twisted.trial import unittest from .._flatten import KeyFlattener, aFormatter, extractField, flattenEvent from .._format import formatEvent from .._interfaces import LogEvent class FlatFormattingTests(unittest.TestCase): """ Tests for flattened event formatting functions. """ def test_formatFlatEvent(self) -> None: """ L{flattenEvent} will "flatten" an event so that, if scrubbed of all but serializable objects, it will preserve all necessary data to be formatted once serialized. When presented with an event thusly flattened, L{formatEvent} will produce the same output. """ counter = count() class Ephemeral: attribute = "value" event1 = dict( log_format=( "callable: {callme()} " "attribute: {object.attribute} " "numrepr: {number!r} " "numstr: {number!s} " "strrepr: {string!r} " "unistr: {unistr!s}" ), callme=lambda: next(counter), object=Ephemeral(), number=7, string="hello", unistr="ö", ) flattenEvent(event1) event2 = dict(event1) del event2["callme"] del event2["object"] event3 = json.loads(json.dumps(event2)) self.assertEqual( formatEvent(event3), ( "callable: 0 " "attribute: value " "numrepr: 7 " "numstr: 7 " "strrepr: 'hello' " "unistr: ö" ), ) def test_formatFlatEventBadFormat(self) -> None: """ If the format string is invalid, an error is produced. """ event1 = dict( log_format=("strrepr: {string!X}"), string="hello", ) flattenEvent(event1) event2 = json.loads(json.dumps(event1)) self.assertTrue(formatEvent(event2).startswith("Unable to format event")) def test_formatFlatEventWithMutatedFields(self) -> None: """ L{formatEvent} will prefer the stored C{str()} or C{repr()} value for an object, in case the other version. """ class Unpersistable: """ Unpersitable object. """ destructed = False def selfDestruct(self) -> None: """ Self destruct. """ self.destructed = True def __repr__(self) -> str: if self.destructed: return "post-serialization garbage" else: return "un-persistable" up = Unpersistable() event1 = dict(log_format="unpersistable: {unpersistable}", unpersistable=up) flattenEvent(event1) up.selfDestruct() self.assertEqual(formatEvent(event1), "unpersistable: un-persistable") def test_keyFlattening(self) -> None: """ Test that L{KeyFlattener.flatKey} returns the expected keys for format fields. """ def keyFromFormat(format: str) -> str: for ( literalText, fieldName, formatSpec, conversion, ) in aFormatter.parse(format): assert fieldName is not None return KeyFlattener().flatKey(fieldName, formatSpec, conversion) assert False, "Unable to derive key from format: {format}" # No name try: self.assertEqual(keyFromFormat("{}"), "!:") except ValueError: # In python 2.6, an empty field name causes Formatter.parse to # raise ValueError. # In Python 2.7, it's allowed, so this exception is unexpected. raise # Just a name self.assertEqual(keyFromFormat("{foo}"), "foo!:") # Add conversion self.assertEqual(keyFromFormat("{foo!s}"), "foo!s:") self.assertEqual(keyFromFormat("{foo!r}"), "foo!r:") # Add format spec self.assertEqual(keyFromFormat("{foo:%s}"), "foo!:%s") self.assertEqual(keyFromFormat("{foo:!}"), "foo!:!") self.assertEqual(keyFromFormat("{foo::}"), "foo!::") # Both self.assertEqual(keyFromFormat("{foo!s:%s}"), "foo!s:%s") self.assertEqual(keyFromFormat("{foo!s:!}"), "foo!s:!") self.assertEqual(keyFromFormat("{foo!s::}"), "foo!s::") sameFlattener = KeyFlattener() ( ( literalText, fieldName, formatSpec, conversion, ), ) = aFormatter.parse("{x}") assert fieldName is not None self.assertEqual( sameFlattener.flatKey(fieldName, formatSpec, conversion), "x!:" ) self.assertEqual( sameFlattener.flatKey(fieldName, formatSpec, conversion), "x!:/2" ) def _test_formatFlatEvent_fieldNamesSame( self, event: Optional[LogEvent] = None ) -> LogEvent: """ The same format field used twice in one event is rendered twice. @param event: An event to flatten. If L{None}, create a new event. @return: C{event} or the event created. """ if event is None: counter = count() class CountStr: """ Hack """ def __str__(self) -> str: return str(next(counter)) event = dict( log_format="{x} {x}", x=CountStr(), ) flattenEvent(event) self.assertEqual(formatEvent(event), "0 1") return event def test_formatFlatEventFieldNamesSame(self) -> None: """ The same format field used twice in one event is rendered twice. """ self._test_formatFlatEvent_fieldNamesSame() def test_formatFlatEventFieldNamesSameAgain(self) -> None: """ The same event flattened twice gives the same (already rendered) result. """ event = self._test_formatFlatEvent_fieldNamesSame() self._test_formatFlatEvent_fieldNamesSame(event) def test_formatEventFlatTrailingText(self) -> None: """ L{formatEvent} will handle a flattened event with tailing text after a replacement field. """ event = dict( log_format="test {x} trailing", x="value", ) flattenEvent(event) result = formatEvent(event) self.assertEqual(result, "test value trailing") def test_extractField( self, flattenFirst: Callable[[LogEvent], LogEvent] = lambda x: x ) -> None: """ L{extractField} will extract a field used in the format string. @param flattenFirst: callable to flatten an event """ class ObjectWithRepr: def __repr__(self) -> str: return "repr" class Something: def __init__(self) -> None: self.number = 7 self.object = ObjectWithRepr() def __getstate__(self) -> None: raise NotImplementedError("Just in case.") event = dict( log_format="{something.number} {something.object}", something=Something(), ) flattened = flattenFirst(event) def extract(field: str) -> Any: return extractField(field, flattened) self.assertEqual(extract("something.number"), 7) self.assertEqual(extract("something.number!s"), "7") self.assertEqual(extract("something.object!s"), "repr") def test_extractFieldFlattenFirst(self) -> None: """ L{extractField} behaves identically if the event is explicitly flattened first. """ def flattened(event: LogEvent) -> LogEvent: flattenEvent(event) return event self.test_extractField(flattened) def test_flattenEventWithoutFormat(self) -> None: """ L{flattenEvent} will do nothing to an event with no format string. """ inputEvent = {"a": "b", "c": 1} flattenEvent(inputEvent) self.assertEqual(inputEvent, {"a": "b", "c": 1}) def test_flattenEventWithInertFormat(self) -> None: """ L{flattenEvent} will do nothing to an event with a format string that contains no format fields. """ inputEvent = {"a": "b", "c": 1, "log_format": "simple message"} flattenEvent(inputEvent) self.assertEqual( inputEvent, { "a": "b", "c": 1, "log_format": "simple message", }, ) def test_flattenEventWithNoneFormat(self) -> None: """ L{flattenEvent} will do nothing to an event with log_format set to None. """ inputEvent = {"a": "b", "c": 1, "log_format": None} flattenEvent(inputEvent) self.assertEqual( inputEvent, { "a": "b", "c": 1, "log_format": None, }, ) test/test_io.py 0000644 00000021264 15027667615 0007567 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._io}. """ import sys from typing import List, Optional from zope.interface import implementer from constantly import NamedConstant # type: ignore[import] from twisted.trial import unittest from .._interfaces import ILogObserver, LogEvent from .._io import LoggingFile from .._levels import LogLevel from .._logger import Logger from .._observer import LogPublisher @implementer(ILogObserver) class TestLoggingFile(LoggingFile): """ L{LoggingFile} that is also an observer which captures events and messages. """ def __init__( self, logger: Logger, level: NamedConstant = LogLevel.info, encoding: Optional[str] = None, ) -> None: super().__init__(logger=logger, level=level, encoding=encoding) self.events: List[LogEvent] = [] self.messages: List[str] = [] def __call__(self, event: LogEvent) -> None: self.events.append(event) if "log_io" in event: self.messages.append(event["log_io"]) class LoggingFileTests(unittest.TestCase): """ Tests for L{LoggingFile}. """ def setUp(self) -> None: """ Create a logger for test L{LoggingFile} instances to use. """ self.publisher = LogPublisher() self.logger = Logger(observer=self.publisher) def test_softspace(self) -> None: """ L{LoggingFile.softspace} is 0. """ self.assertEqual(LoggingFile(self.logger).softspace, 0) warningsShown = self.flushWarnings([self.test_softspace]) self.assertEqual(len(warningsShown), 1) self.assertEqual(warningsShown[0]["category"], DeprecationWarning) deprecatedClass = "twisted.logger._io.LoggingFile.softspace" self.assertEqual( warningsShown[0]["message"], "%s was deprecated in Twisted 21.2.0" % (deprecatedClass), ) def test_readOnlyAttributes(self) -> None: """ Some L{LoggingFile} attributes are read-only. """ f = LoggingFile(self.logger) self.assertRaises(AttributeError, setattr, f, "closed", True) self.assertRaises(AttributeError, setattr, f, "encoding", "utf-8") self.assertRaises(AttributeError, setattr, f, "mode", "r") self.assertRaises(AttributeError, setattr, f, "newlines", ["\n"]) self.assertRaises(AttributeError, setattr, f, "name", "foo") def test_unsupportedMethods(self) -> None: """ Some L{LoggingFile} methods are unsupported. """ f = LoggingFile(self.logger) self.assertRaises(IOError, f.read) self.assertRaises(IOError, f.next) self.assertRaises(IOError, f.readline) self.assertRaises(IOError, f.readlines) self.assertRaises(IOError, f.xreadlines) self.assertRaises(IOError, f.seek) self.assertRaises(IOError, f.tell) self.assertRaises(IOError, f.truncate) def test_level(self) -> None: """ Default level is L{LogLevel.info} if not set. """ f = LoggingFile(self.logger) self.assertEqual(f.level, LogLevel.info) f = LoggingFile(self.logger, level=LogLevel.error) self.assertEqual(f.level, LogLevel.error) def test_encoding(self) -> None: """ Default encoding is C{sys.getdefaultencoding()} if not set. """ f = LoggingFile(self.logger) self.assertEqual(f.encoding, sys.getdefaultencoding()) f = LoggingFile(self.logger, encoding="utf-8") self.assertEqual(f.encoding, "utf-8") def test_mode(self) -> None: """ Reported mode is C{"w"}. """ f = LoggingFile(self.logger) self.assertEqual(f.mode, "w") def test_newlines(self) -> None: """ The C{newlines} attribute is L{None}. """ f = LoggingFile(self.logger) self.assertIsNone(f.newlines) def test_name(self) -> None: """ The C{name} attribute is fixed. """ f = LoggingFile(self.logger) self.assertEqual(f.name, "<LoggingFile twisted.logger.test.test_io#info>") def test_close(self) -> None: """ L{LoggingFile.close} closes the file. """ f = LoggingFile(self.logger) f.close() self.assertTrue(f.closed) self.assertRaises(ValueError, f.write, "Hello") def test_flush(self) -> None: """ L{LoggingFile.flush} does nothing. """ f = LoggingFile(self.logger) f.flush() def test_fileno(self) -> None: """ L{LoggingFile.fileno} returns C{-1}. """ f = LoggingFile(self.logger) self.assertEqual(f.fileno(), -1) def test_isatty(self) -> None: """ L{LoggingFile.isatty} returns C{False}. """ f = LoggingFile(self.logger) self.assertFalse(f.isatty()) def test_writeBuffering(self) -> None: """ Writing buffers correctly. """ f = self.observedFile() f.write("Hello") self.assertEqual(f.messages, []) f.write(", world!\n") self.assertEqual(f.messages, ["Hello, world!"]) f.write("It's nice to meet you.\n\nIndeed.") self.assertEqual( f.messages, [ "Hello, world!", "It's nice to meet you.", "", ], ) def test_writeBytesDecoded(self) -> None: """ Bytes are decoded to text. """ f = self.observedFile(encoding="utf-8") f.write(b"Hello, Mr. S\xc3\xa1nchez\n") self.assertEqual(f.messages, ["Hello, Mr. S\xe1nchez"]) def test_writeUnicode(self) -> None: """ Unicode is unmodified. """ f = self.observedFile(encoding="utf-8") f.write("Hello, Mr. S\xe1nchez\n") self.assertEqual(f.messages, ["Hello, Mr. S\xe1nchez"]) def test_writeLevel(self) -> None: """ Log level is emitted properly. """ f = self.observedFile() f.write("Hello\n") self.assertEqual(len(f.events), 1) self.assertEqual(f.events[0]["log_level"], LogLevel.info) f = self.observedFile(level=LogLevel.error) f.write("Hello\n") self.assertEqual(len(f.events), 1) self.assertEqual(f.events[0]["log_level"], LogLevel.error) def test_writeFormat(self) -> None: """ Log format is C{"{message}"}. """ f = self.observedFile() f.write("Hello\n") self.assertEqual(len(f.events), 1) self.assertEqual(f.events[0]["log_format"], "{log_io}") def test_writelinesBuffering(self) -> None: """ C{writelines} does not add newlines. """ # Note this is different behavior than t.p.log.StdioOnnaStick. f = self.observedFile() f.writelines(("Hello", ", ", "")) self.assertEqual(f.messages, []) f.writelines(("world!\n",)) self.assertEqual(f.messages, ["Hello, world!"]) f.writelines(("It's nice to meet you.\n\n", "Indeed.")) self.assertEqual( f.messages, [ "Hello, world!", "It's nice to meet you.", "", ], ) def test_print(self) -> None: """ L{LoggingFile} can replace L{sys.stdout}. """ f = self.observedFile() self.patch(sys, "stdout", f) print("Hello,", end=" ") print("world.") self.assertEqual(f.messages, ["Hello, world."]) def observedFile( self, level: NamedConstant = LogLevel.info, encoding: Optional[str] = None, ) -> TestLoggingFile: """ Construct a L{LoggingFile} with a built-in observer. @param level: C{level} argument to L{LoggingFile} @param encoding: C{encoding} argument to L{LoggingFile} @return: a L{TestLoggingFile} with an observer that appends received events into the file's C{events} attribute (a L{list}) and event messages into the file's C{messages} attribute (a L{list}). """ # Logger takes an observer argument, for which we want to use the # TestLoggingFile we will create, but that takes the Logger as an # argument, so we'll use an array to indirectly reference the # TestLoggingFile. loggingFiles: List[TestLoggingFile] = [] @implementer(ILogObserver) def observer(event: LogEvent) -> None: loggingFiles[0](event) log = Logger(observer=observer) loggingFiles.append(TestLoggingFile(logger=log, level=level, encoding=encoding)) return loggingFiles[0] test/test_levels.py 0000644 00000001543 15027667615 0010450 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._levels}. """ from twisted.trial import unittest from .._levels import InvalidLogLevelError, LogLevel class LogLevelTests(unittest.TestCase): """ Tests for L{LogLevel}. """ def test_levelWithName(self) -> None: """ Look up log level by name. """ for level in LogLevel.iterconstants(): self.assertIs(LogLevel.levelWithName(level.name), level) def test_levelWithInvalidName(self) -> None: """ You can't make up log level names. """ bogus = "*bogus*" try: LogLevel.levelWithName(bogus) except InvalidLogLevelError as e: self.assertIs(e.level, bogus) else: self.fail("Expected InvalidLogLevelError.") test/test_buffer.py 0000644 00000003433 15027667615 0010427 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._buffer}. """ from typing import List, cast from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.trial import unittest from .._buffer import LimitedHistoryLogObserver from .._interfaces import ILogObserver, LogEvent class LimitedHistoryLogObserverTests(unittest.TestCase): """ Tests for L{LimitedHistoryLogObserver}. """ def test_interface(self) -> None: """ L{LimitedHistoryLogObserver} provides L{ILogObserver}. """ observer = LimitedHistoryLogObserver(0) try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def test_order(self) -> None: """ L{LimitedHistoryLogObserver} saves history in the order it is received. """ size = 4 events = [dict(n=n) for n in range(size // 2)] observer = LimitedHistoryLogObserver(size) for event in events: observer(event) outEvents: List[LogEvent] = [] observer.replayTo(cast(ILogObserver, outEvents.append)) self.assertEqual(events, outEvents) def test_limit(self) -> None: """ When more events than a L{LimitedHistoryLogObserver}'s maximum size are buffered, older events will be dropped. """ size = 4 events = [dict(n=n) for n in range(size * 2)] observer = LimitedHistoryLogObserver(size) for event in events: observer(event) outEvents: List[LogEvent] = [] observer.replayTo(cast(ILogObserver, outEvents.append)) self.assertEqual(events[-size:], outEvents) test/test_file.py 0000644 00000013313 15027667615 0010073 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._file}. """ from io import StringIO from types import TracebackType from typing import IO, Any, AnyStr, Optional, Type, cast from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.python.failure import Failure from twisted.trial.unittest import TestCase from .._file import FileLogObserver, textFileLogObserver from .._interfaces import ILogObserver class FileLogObserverTests(TestCase): """ Tests for L{FileLogObserver}. """ def test_interface(self) -> None: """ L{FileLogObserver} is an L{ILogObserver}. """ with StringIO() as fileHandle: observer = FileLogObserver(fileHandle, lambda e: str(e)) try: verifyObject(ILogObserver, observer) except BrokenMethodImplementation as e: self.fail(e) def test_observeWrites(self) -> None: """ L{FileLogObserver} writes to the given file when it observes events. """ with StringIO() as fileHandle: observer = FileLogObserver(fileHandle, lambda e: str(e)) event = dict(x=1) observer(event) self.assertEqual(fileHandle.getvalue(), str(event)) def _test_observeWrites(self, what: Optional[str], count: int) -> None: """ Verify that observer performs an expected number of writes when the formatter returns a given value. @param what: the value for the formatter to return. @param count: the expected number of writes. """ with DummyFile() as fileHandle: observer = FileLogObserver(cast(IO[Any], fileHandle), lambda e: what) event = dict(x=1) observer(event) self.assertEqual(fileHandle.writes, count) def test_observeWritesNone(self) -> None: """ L{FileLogObserver} does not write to the given file when it observes events and C{formatEvent} returns L{None}. """ self._test_observeWrites(None, 0) def test_observeWritesEmpty(self) -> None: """ L{FileLogObserver} does not write to the given file when it observes events and C{formatEvent} returns C{""}. """ self._test_observeWrites("", 0) def test_observeFlushes(self) -> None: """ L{FileLogObserver} calles C{flush()} on the output file when it observes an event. """ with DummyFile() as fileHandle: observer = FileLogObserver(cast(IO[Any], fileHandle), lambda e: str(e)) event = dict(x=1) observer(event) self.assertEqual(fileHandle.flushes, 1) class TextFileLogObserverTests(TestCase): """ Tests for L{textFileLogObserver}. """ def test_returnsFileLogObserver(self) -> None: """ L{textFileLogObserver} returns a L{FileLogObserver}. """ with StringIO() as fileHandle: observer = textFileLogObserver(fileHandle) self.assertIsInstance(observer, FileLogObserver) def test_outFile(self) -> None: """ Returned L{FileLogObserver} has the correct outFile. """ with StringIO() as fileHandle: observer = textFileLogObserver(fileHandle) self.assertIs(observer._outFile, fileHandle) def test_timeFormat(self) -> None: """ Returned L{FileLogObserver} has the correct outFile. """ with StringIO() as fileHandle: observer = textFileLogObserver(fileHandle, timeFormat="%f") observer(dict(log_format="XYZZY", log_time=112345.6)) self.assertEqual(fileHandle.getvalue(), "600000 [-#-] XYZZY\n") def test_observeFailure(self) -> None: """ If the C{"log_failure"} key exists in an event, the observer appends the failure's traceback to the output. """ with StringIO() as fileHandle: observer = textFileLogObserver(fileHandle) try: 1 / 0 except ZeroDivisionError: failure = Failure() event = dict(log_failure=failure) observer(event) output = fileHandle.getvalue() self.assertTrue( output.split("\n")[1].startswith("\tTraceback "), msg=repr(output) ) def test_observeFailureThatRaisesInGetTraceback(self) -> None: """ If the C{"log_failure"} key exists in an event, and contains an object that raises when you call its C{getTraceback()}, then the observer appends a message noting the problem, instead of raising. """ with StringIO() as fileHandle: observer = textFileLogObserver(fileHandle) event = dict(log_failure=object()) # object has no getTraceback() observer(event) output = fileHandle.getvalue() expected = "(UNABLE TO OBTAIN TRACEBACK FROM EVENT)" self.assertIn(expected, output) class DummyFile: """ File that counts writes and flushes. """ def __init__(self) -> None: self.writes = 0 self.flushes = 0 def write(self, data: AnyStr) -> None: """ Write data. @param data: data """ self.writes += 1 def flush(self) -> None: """ Flush buffers. """ self.flushes += 1 def __enter__(self) -> "DummyFile": return self def __exit__( self, exc_type: Optional[Type[BaseException]], exc_value: Optional[BaseException], traceback: Optional[TracebackType], ) -> Optional[bool]: pass test/test_observer.py 0000644 00000014052 15027667615 0011004 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Test cases for L{twisted.logger._observer}. """ from typing import Dict, List, Tuple, cast from zope.interface import implementer from zope.interface.exceptions import BrokenMethodImplementation from zope.interface.verify import verifyObject from twisted.trial import unittest from .._interfaces import ILogObserver, LogEvent from .._logger import Logger from .._observer import LogPublisher class LogPublisherTests(unittest.TestCase): """ Tests for L{LogPublisher}. """ def test_interface(self) -> None: """ L{LogPublisher} is an L{ILogObserver}. """ publisher = LogPublisher() try: verifyObject(ILogObserver, publisher) except BrokenMethodImplementation as e: self.fail(e) def test_observers(self) -> None: """ L{LogPublisher.observers} returns the observers. """ o1 = cast(ILogObserver, lambda e: None) o2 = cast(ILogObserver, lambda e: None) publisher = LogPublisher(o1, o2) self.assertEqual({o1, o2}, set(publisher._observers)) def test_addObserver(self) -> None: """ L{LogPublisher.addObserver} adds an observer. """ o1 = cast(ILogObserver, lambda e: None) o2 = cast(ILogObserver, lambda e: None) o3 = cast(ILogObserver, lambda e: None) publisher = LogPublisher(o1, o2) publisher.addObserver(o3) self.assertEqual({o1, o2, o3}, set(publisher._observers)) def test_addObserverNotCallable(self) -> None: """ L{LogPublisher.addObserver} refuses to add an observer that's not callable. """ publisher = LogPublisher() self.assertRaises(TypeError, publisher.addObserver, object()) def test_removeObserver(self) -> None: """ L{LogPublisher.removeObserver} removes an observer. """ o1 = cast(ILogObserver, lambda e: None) o2 = cast(ILogObserver, lambda e: None) o3 = cast(ILogObserver, lambda e: None) publisher = LogPublisher(o1, o2, o3) publisher.removeObserver(o2) self.assertEqual({o1, o3}, set(publisher._observers)) def test_removeObserverNotRegistered(self) -> None: """ L{LogPublisher.removeObserver} removes an observer that is not registered. """ o1 = cast(ILogObserver, lambda e: None) o2 = cast(ILogObserver, lambda e: None) o3 = cast(ILogObserver, lambda e: None) publisher = LogPublisher(o1, o2) publisher.removeObserver(o3) self.assertEqual({o1, o2}, set(publisher._observers)) def test_fanOut(self) -> None: """ L{LogPublisher} calls its observers. """ event = dict(foo=1, bar=2) events1: List[LogEvent] = [] events2: List[LogEvent] = [] events3: List[LogEvent] = [] o1 = cast(ILogObserver, events1.append) o2 = cast(ILogObserver, events2.append) o3 = cast(ILogObserver, events3.append) publisher = LogPublisher(o1, o2, o3) publisher(event) self.assertIn(event, events1) self.assertIn(event, events2) self.assertIn(event, events3) def test_observerRaises(self) -> None: """ Observer raises an exception during fan out: a failure is logged, but not re-raised. Life goes on. """ event = dict(foo=1, bar=2) exception = RuntimeError("ARGH! EVIL DEATH!") events: List[LogEvent] = [] @implementer(ILogObserver) def observer(event: LogEvent) -> None: shouldRaise = not events events.append(event) if shouldRaise: raise exception collector: List[LogEvent] = [] publisher = LogPublisher(observer, cast(ILogObserver, collector.append)) publisher(event) # Verify that the observer saw my event self.assertIn(event, events) # Verify that the observer raised my exception errors = [e["log_failure"] for e in collector if "log_failure" in e] self.assertEqual(len(errors), 1) self.assertIs(errors[0].value, exception) # Make sure the exceptional observer does not receive its own error. self.assertEqual(len(events), 1) def test_observerRaisesAndLoggerHatesMe(self) -> None: """ Observer raises an exception during fan out and the publisher's Logger pukes when the failure is reported. The exception does not propagate back to the caller. """ event = dict(foo=1, bar=2) exception = RuntimeError("ARGH! EVIL DEATH!") @implementer(ILogObserver) def observer(event: LogEvent) -> None: raise RuntimeError("Sad panda") class GurkLogger(Logger): def failure(self, *args: object, **kwargs: object) -> None: raise exception publisher = LogPublisher(observer) publisher.log = GurkLogger() publisher(event) # Here, the lack of an exception thus far is a success, of sorts def test_trace(self) -> None: """ Tracing keeps track of forwarding to observers. """ event = dict(foo=1, bar=2, log_trace=[]) traces: Dict[int, Tuple[Tuple[Logger, ILogObserver]]] = {} # Copy trace to a tuple; otherwise, both observers will store the same # mutable list, and we won't be able to see o1's view distinctly. @implementer(ILogObserver) def o1(e: LogEvent) -> None: traces.setdefault( 1, cast(Tuple[Tuple[Logger, ILogObserver]], tuple(e["log_trace"])) ) @implementer(ILogObserver) def o2(e: LogEvent) -> None: traces.setdefault( 2, cast(Tuple[Tuple[Logger, ILogObserver]], tuple(e["log_trace"])) ) publisher = LogPublisher(o1, o2) publisher(event) self.assertEqual(traces[1], ((publisher, o1),)) self.assertEqual(traces[2], ((publisher, o1), (publisher, o2))) test/__init__.py 0000644 00000000241 15027667615 0007650 0 ustar 00 # -*- test-case-name: twisted.logger.test -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Unit tests for L{twisted.logger}. """ _logger.py 0000644 00000023376 15027667615 0006566 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_logger -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Logger class. """ from time import time from typing import Any, Optional, cast from twisted.python.compat import currentframe from twisted.python.failure import Failure from ._interfaces import ILogObserver, LogTrace from ._levels import InvalidLogLevelError, LogLevel class Logger: """ A L{Logger} emits log messages to an observer. You should instantiate it as a class or module attribute, as documented in L{this module's documentation <twisted.logger>}. @ivar namespace: the namespace for this logger @ivar source: The object which is emitting events via this logger @ivar observer: The observer that this logger will send events to. """ @staticmethod def _namespaceFromCallingContext() -> str: """ Derive a namespace from the module containing the caller's caller. @return: the fully qualified python name of a module. """ try: return cast(str, currentframe(2).f_globals["__name__"]) except KeyError: return "<unknown>" def __init__( self, namespace: Optional[str] = None, source: Optional[object] = None, observer: Optional["ILogObserver"] = None, ) -> None: """ @param namespace: The namespace for this logger. Uses a dotted notation, as used by python modules. If not L{None}, then the name of the module of the caller is used. @param source: The object which is emitting events via this logger; this is automatically set on instances of a class if this L{Logger} is an attribute of that class. @param observer: The observer that this logger will send events to. If L{None}, use the L{global log publisher <globalLogPublisher>}. """ if namespace is None: namespace = self._namespaceFromCallingContext() self.namespace = namespace self.source = source if observer is None: from ._global import globalLogPublisher self.observer: ILogObserver = globalLogPublisher else: self.observer = observer def __get__(self, instance: object, owner: Optional[type] = None) -> "Logger": """ When used as a descriptor, i.e.:: # File: athing.py class Something: log = Logger() def hello(self): self.log.info("Hello") a L{Logger}'s namespace will be set to the name of the class it is declared on. In the above example, the namespace would be C{athing.Something}. Additionally, its source will be set to the actual object referring to the L{Logger}. In the above example, C{Something.log.source} would be C{Something}, and C{Something().log.source} would be an instance of C{Something}. """ assert owner is not None if instance is None: source: Any = owner else: source = instance return self.__class__( ".".join([owner.__module__, owner.__name__]), source, observer=self.observer, ) def __repr__(self) -> str: return f"<{self.__class__.__name__} {self.namespace!r}>" def emit( self, level: LogLevel, format: Optional[str] = None, **kwargs: object ) -> None: """ Emit a log event to all log observers at the given level. @param level: a L{LogLevel} @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ if level not in LogLevel.iterconstants(): self.failure( "Got invalid log level {invalidLevel!r} in {logger}.emit().", Failure(InvalidLogLevelError(level)), invalidLevel=level, logger=self, ) return event = kwargs event.update( log_logger=self, log_level=level, log_namespace=self.namespace, log_source=self.source, log_format=format, log_time=time(), ) if "log_trace" in event: cast(LogTrace, event["log_trace"]).append((self, self.observer)) self.observer(event) def failure( self, format: str, failure: Optional[Failure] = None, level: LogLevel = LogLevel.critical, **kwargs: object, ) -> None: """ Log a failure and emit a traceback. For example:: try: frob(knob) except Exception: log.failure("While frobbing {knob}", knob=knob) or:: d = deferredFrob(knob) d.addErrback(lambda f: log.failure("While frobbing {knob}", f, knob=knob)) This method is generally meant to capture unexpected exceptions in code; an exception that is caught and handled somehow should be logged, if appropriate, via L{Logger.error} instead. If some unknown exception occurs and your code doesn't know how to handle it, as in the above example, then this method provides a means to describe the failure in nerd-speak. This is done at L{LogLevel.critical} by default, since no corrective guidance can be offered to an user/administrator, and the impact of the condition is unknown. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param failure: a L{Failure} to log. If L{None}, a L{Failure} is created from the exception in flight. @param level: a L{LogLevel} to use. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ if failure is None: failure = Failure() self.emit(level, format, log_failure=failure, **kwargs) def debug(self, format: Optional[str] = None, **kwargs: object) -> None: """ Emit a log event at log level L{LogLevel.debug}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ self.emit(LogLevel.debug, format, **kwargs) def info(self, format: Optional[str] = None, **kwargs: object) -> None: """ Emit a log event at log level L{LogLevel.info}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ self.emit(LogLevel.info, format, **kwargs) def warn(self, format: Optional[str] = None, **kwargs: object) -> None: """ Emit a log event at log level L{LogLevel.warn}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ self.emit(LogLevel.warn, format, **kwargs) def error(self, format: Optional[str] = None, **kwargs: object) -> None: """ Emit a log event at log level L{LogLevel.error}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ self.emit(LogLevel.error, format, **kwargs) def critical(self, format: Optional[str] = None, **kwargs: object) -> None: """ Emit a log event at log level L{LogLevel.critical}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. """ self.emit(LogLevel.critical, format, **kwargs) _log = Logger() _loggerFor = lambda obj: _log.__get__(obj, obj.__class__) _io.py 0000644 00000010730 15027667615 0005704 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_io -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ File-like object that logs. """ import sys from typing import AnyStr, Iterable, Optional from constantly import NamedConstant # type: ignore[import] from incremental import Version from twisted.python.deprecate import deprecatedProperty from ._levels import LogLevel from ._logger import Logger class LoggingFile: """ File-like object that turns C{write()} calls into logging events. Note that because event formats are L{str}, C{bytes} received via C{write()} are converted to C{str}, which is the opposite of what C{file} does. @ivar softspace: Attribute to make this class more file-like under Python 2; value is zero or one. Do not use. """ _softspace = 0 @deprecatedProperty(Version("Twisted", 21, 2, 0)) def softspace(self): return self._softspace @softspace.setter # type: ignore[no-redef] def softspace(self, value): self._softspace = value def __init__( self, logger: Logger, level: NamedConstant = LogLevel.info, encoding: Optional[str] = None, ) -> None: """ @param logger: the logger to log through. @param level: the log level to emit events with. @param encoding: The encoding to expect when receiving bytes via C{write()}. If L{None}, use C{sys.getdefaultencoding()}. """ self.level = level self.log = logger if encoding is None: self._encoding = sys.getdefaultencoding() else: self._encoding = encoding self._buffer = "" self._closed = False @property def closed(self) -> bool: """ Read-only property. Is the file closed? @return: true if closed, otherwise false. """ return self._closed @property def encoding(self) -> str: """ Read-only property. File encoding. @return: an encoding. """ return self._encoding @property def mode(self) -> str: """ Read-only property. File mode. @return: "w" """ return "w" @property def newlines(self) -> None: """ Read-only property. Types of newlines encountered. @return: L{None} """ return None @property def name(self) -> str: """ The name of this file; a repr-style string giving information about its namespace. @return: A file name. """ return "<{} {}#{}>".format( self.__class__.__name__, self.log.namespace, self.level.name, ) def close(self) -> None: """ Close this file so it can no longer be written to. """ self._closed = True def flush(self) -> None: """ No-op; this file does not buffer. """ pass def fileno(self) -> int: """ Returns an invalid file descriptor, since this is not backed by an FD. @return: C{-1} """ return -1 def isatty(self) -> bool: """ A L{LoggingFile} is not a TTY. @return: C{False} """ return False def write(self, message: AnyStr) -> None: """ Log the given message. @param message: The message to write. """ if self._closed: raise ValueError("I/O operation on closed file") if isinstance(message, bytes): text = message.decode(self._encoding) else: text = message lines = (self._buffer + text).split("\n") self._buffer = lines[-1] lines = lines[0:-1] for line in lines: self.log.emit(self.level, format="{log_io}", log_io=line) def writelines(self, lines: Iterable[AnyStr]) -> None: """ Log each of the given lines as a separate message. @param lines: Data to write. """ for line in lines: self.write(line) def _unsupported(self, *args: object) -> None: """ Template for unsupported operations. @param args: Arguments. """ raise OSError("unsupported operation") read = _unsupported next = _unsupported readline = _unsupported readlines = _unsupported xreadlines = _unsupported seek = _unsupported tell = _unsupported truncate = _unsupported _observer.py 0000644 00000006251 15027667615 0007127 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_observer -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Basic log observers. """ from typing import Callable, Optional from zope.interface import implementer from twisted.python.failure import Failure from ._interfaces import ILogObserver, LogEvent from ._logger import Logger OBSERVER_DISABLED = ( "Temporarily disabling observer {observer} due to exception: {log_failure}" ) @implementer(ILogObserver) class LogPublisher: """ I{ILogObserver} that fans out events to other observers. Keeps track of a set of L{ILogObserver} objects and forwards events to each. """ def __init__(self, *observers: ILogObserver) -> None: self._observers = list(observers) self.log = Logger(observer=self) def addObserver(self, observer: ILogObserver) -> None: """ Registers an observer with this publisher. @param observer: An L{ILogObserver} to add. """ if not callable(observer): raise TypeError(f"Observer is not callable: {observer!r}") if observer not in self._observers: self._observers.append(observer) def removeObserver(self, observer: ILogObserver) -> None: """ Unregisters an observer with this publisher. @param observer: An L{ILogObserver} to remove. """ try: self._observers.remove(observer) except ValueError: pass def __call__(self, event: LogEvent) -> None: """ Forward events to contained observers. """ if "log_trace" not in event: trace: Optional[Callable[[ILogObserver], None]] = None else: def trace(observer: ILogObserver) -> None: """ Add tracing information for an observer. @param observer: an observer being forwarded to """ event["log_trace"].append((self, observer)) brokenObservers = [] for observer in self._observers: if trace is not None: trace(observer) try: observer(event) except Exception: brokenObservers.append((observer, Failure())) for brokenObserver, failure in brokenObservers: errorLogger = self._errorLoggerForObserver(brokenObserver) errorLogger.failure( OBSERVER_DISABLED, failure=failure, observer=brokenObserver, ) def _errorLoggerForObserver(self, observer: ILogObserver) -> Logger: """ Create an error-logger based on this logger, which does not contain the given bad observer. @param observer: The observer which previously had an error. @return: A L{Logger} without the given observer. """ errorPublisher = LogPublisher( *(obs for obs in self._observers if obs is not observer) ) return Logger(observer=errorPublisher) @implementer(ILogObserver) def bitbucketLogObserver(event: LogEvent) -> None: """ I{ILogObserver} that does nothing with the events it sees. """ _flatten.py 0000644 00000011604 15027667615 0006733 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_flatten -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Code related to "flattening" events; that is, extracting a description of all relevant fields from the format string and persisting them for later examination. """ from collections import defaultdict from string import Formatter from typing import Any, Dict, Optional from ._interfaces import LogEvent aFormatter = Formatter() class KeyFlattener: """ A L{KeyFlattener} computes keys for the things within curly braces in PEP-3101-style format strings as parsed by L{string.Formatter.parse}. """ def __init__(self) -> None: """ Initialize a L{KeyFlattener}. """ self.keys: Dict[str, int] = defaultdict(lambda: 0) def flatKey( self, fieldName: str, formatSpec: Optional[str], conversion: Optional[str] ) -> str: """ Compute a string key for a given field/format/conversion. @param fieldName: A format field name. @param formatSpec: A format spec. @param conversion: A format field conversion type. @return: A key specific to the given field, format and conversion, as well as the occurrence of that combination within this L{KeyFlattener}'s lifetime. """ if formatSpec is None: formatSpec = "" if conversion is None: conversion = "" result = "{fieldName}!{conversion}:{formatSpec}".format( fieldName=fieldName, formatSpec=formatSpec, conversion=conversion, ) self.keys[result] += 1 n = self.keys[result] if n != 1: result += "/" + str(self.keys[result]) return result def flattenEvent(event: LogEvent) -> None: """ Flatten the given event by pre-associating format fields with specific objects and callable results in a L{dict} put into the C{"log_flattened"} key in the event. @param event: A logging event. """ if event.get("log_format", None) is None: return if "log_flattened" in event: fields = event["log_flattened"] else: fields = {} keyFlattener = KeyFlattener() for (literalText, fieldName, formatSpec, conversion) in aFormatter.parse( event["log_format"] ): if fieldName is None: continue if conversion != "r": conversion = "s" flattenedKey = keyFlattener.flatKey(fieldName, formatSpec, conversion) structuredKey = keyFlattener.flatKey(fieldName, formatSpec, "") if flattenedKey in fields: # We've already seen and handled this key continue if fieldName.endswith("()"): fieldName = fieldName[:-2] callit = True else: callit = False field = aFormatter.get_field(fieldName, (), event) fieldValue = field[0] if conversion == "r": conversionFunction = repr else: # Above: if conversion is not "r", it's "s" conversionFunction = str if callit: fieldValue = fieldValue() flattenedValue = conversionFunction(fieldValue) fields[flattenedKey] = flattenedValue fields[structuredKey] = fieldValue if fields: event["log_flattened"] = fields def extractField(field: str, event: LogEvent) -> Any: """ Extract a given format field from the given event. @param field: A string describing a format field or log key. This is the text that would normally fall between a pair of curly braces in a format string: for example, C{"key[2].attribute"}. If a conversion is specified (the thing after the C{"!"} character in a format field) then the result will always be str. @param event: A log event. @return: A value extracted from the field. @raise KeyError: if the field is not found in the given event. """ keyFlattener = KeyFlattener() [[literalText, fieldName, formatSpec, conversion]] = aFormatter.parse( "{" + field + "}" ) assert fieldName is not None key = keyFlattener.flatKey(fieldName, formatSpec, conversion) if "log_flattened" not in event: flattenEvent(event) return event["log_flattened"][key] def flatFormat(event: LogEvent) -> str: """ Format an event which has been flattened with L{flattenEvent}. @param event: A logging event. @return: A formatted string. """ fieldValues = event["log_flattened"] keyFlattener = KeyFlattener() s = [] for literalText, fieldName, formatSpec, conversion in aFormatter.parse( event["log_format"] ): s.append(literalText) if fieldName is not None: key = keyFlattener.flatKey(fieldName, formatSpec, conversion or "s") s.append(str(fieldValues[key])) return "".join(s) _interfaces.py 0000644 00000004454 15027667615 0007426 0 ustar 00 # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Logger interfaces. """ from typing import TYPE_CHECKING, Any, Dict, List, Tuple from zope.interface import Interface if TYPE_CHECKING: from ._logger import Logger LogEvent = Dict[str, Any] LogTrace = List[Tuple["Logger", "ILogObserver"]] class ILogObserver(Interface): """ An observer which can handle log events. Unlike most interfaces within Twisted, an L{ILogObserver} I{must be thread-safe}. Log observers may be called indiscriminately from many different threads, as any thread may wish to log a message at any time. """ def __call__(event: LogEvent) -> None: """ Log an event. @param event: A dictionary with arbitrary keys as defined by the application emitting logging events, as well as keys added by the logging system. The logging system reserves the right to set any key beginning with the prefix C{"log_"}; applications should not use any key so named. Currently, the following keys are used by the logging system in some way, if they are present (they are all optional): - C{"log_format"}: a PEP-3101-style format string which draws upon the keys in the event as its values, used to format the event for human consumption. - C{"log_flattened"}: a dictionary mapping keys derived from the names and format values used in the C{"log_format"} string to their values. This is used to preserve some structured information for use with L{twisted.logger.extractField}. - C{"log_trace"}: A L{list} designed to capture information about which L{LogPublisher}s have observed the event. - C{"log_level"}: a L{log level <twisted.logger.LogLevel>} constant, indicating the importance of and audience for this event. - C{"log_namespace"}: a namespace for the emitter of the event, given as a L{str}. - C{"log_system"}: a string indicating the network event or method call which resulted in the message being logged. """ _file.py 0000644 00000004441 15027667615 0006216 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_file -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ File log observer. """ from typing import IO, Any, Callable, Optional from zope.interface import implementer from twisted.python.compat import ioType from ._format import formatEventAsClassicLogText, formatTime, timeFormatRFC3339 from ._interfaces import ILogObserver, LogEvent @implementer(ILogObserver) class FileLogObserver: """ Log observer that writes to a file-like object. """ def __init__( self, outFile: IO[Any], formatEvent: Callable[[LogEvent], Optional[str]] ) -> None: """ @param outFile: A file-like object. Ideally one should be passed which accepts text data. Otherwise, UTF-8 L{bytes} will be used. @param formatEvent: A callable that formats an event. """ if ioType(outFile) is not str: self._encoding: Optional[str] = "utf-8" else: self._encoding = None self._outFile = outFile self.formatEvent = formatEvent def __call__(self, event: LogEvent) -> None: """ Write event to file. @param event: An event. """ text = self.formatEvent(event) if text: if self._encoding is None: self._outFile.write(text) else: self._outFile.write(text.encode(self._encoding)) self._outFile.flush() def textFileLogObserver( outFile: IO[Any], timeFormat: Optional[str] = timeFormatRFC3339 ) -> FileLogObserver: """ Create a L{FileLogObserver} that emits text to a specified (writable) file-like object. @param outFile: A file-like object. Ideally one should be passed which accepts text data. Otherwise, UTF-8 L{bytes} will be used. @param timeFormat: The format to use when adding timestamp prefixes to logged events. If L{None}, or for events with no C{"log_timestamp"} key, the default timestamp prefix of C{"-"} is used. @return: A file log observer. """ def formatEvent(event: LogEvent) -> Optional[str]: return formatEventAsClassicLogText( event, formatTime=lambda e: formatTime(e, timeFormat) ) return FileLogObserver(outFile, formatEvent) _json.py 0000644 00000020361 15027667615 0006247 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_json -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Tools for saving and loading log events in a structured format. """ from json import dumps, loads from typing import IO, Any, AnyStr, Dict, Iterable, Optional, Union, cast from uuid import UUID from constantly import NamedConstant # type: ignore[import] from twisted.python.failure import Failure from ._file import FileLogObserver from ._flatten import flattenEvent from ._interfaces import LogEvent from ._levels import LogLevel from ._logger import Logger log = Logger() JSONDict = Dict[str, Any] def failureAsJSON(failure: Failure) -> JSONDict: """ Convert a failure to a JSON-serializable data structure. @param failure: A failure to serialize. @return: a mapping of strings to ... stuff, mostly reminiscent of L{Failure.__getstate__} """ return dict( failure.__getstate__(), type=dict( __module__=failure.type.__module__, __name__=failure.type.__name__, ), ) def failureFromJSON(failureDict: JSONDict) -> Failure: """ Load a L{Failure} from a dictionary deserialized from JSON. @param failureDict: a JSON-deserialized object like one previously returned by L{failureAsJSON}. @return: L{Failure} """ f = Failure.__new__(Failure) typeInfo = failureDict["type"] failureDict["type"] = type(typeInfo["__name__"], (), typeInfo) f.__dict__ = failureDict return f classInfo = [ ( lambda level: ( isinstance(level, NamedConstant) and getattr(LogLevel, level.name, None) is level ), UUID("02E59486-F24D-46AD-8224-3ACDF2A5732A"), lambda level: dict(name=level.name), lambda level: getattr(LogLevel, level["name"], None), ), ( lambda o: isinstance(o, Failure), UUID("E76887E2-20ED-49BF-A8F8-BA25CC586F2D"), failureAsJSON, failureFromJSON, ), ] uuidToLoader = {uuid: loader for (predicate, uuid, saver, loader) in classInfo} def objectLoadHook(aDict: JSONDict) -> object: """ Dictionary-to-object-translation hook for certain value types used within the logging system. @see: the C{object_hook} parameter to L{json.load} @param aDict: A dictionary loaded from a JSON object. @return: C{aDict} itself, or the object represented by C{aDict} """ if "__class_uuid__" in aDict: return uuidToLoader[UUID(aDict["__class_uuid__"])](aDict) return aDict def objectSaveHook(pythonObject: object) -> JSONDict: """ Object-to-serializable hook for certain value types used within the logging system. @see: the C{default} parameter to L{json.dump} @param pythonObject: Any object. @return: If the object is one of the special types the logging system supports, a specially-formatted dictionary; otherwise, a marker dictionary indicating that it could not be serialized. """ for (predicate, uuid, saver, loader) in classInfo: if predicate(pythonObject): result = saver(pythonObject) result["__class_uuid__"] = str(uuid) return result return {"unpersistable": True} def eventAsJSON(event: LogEvent) -> str: """ Encode an event as JSON, flattening it if necessary to preserve as much structure as possible. Not all structure from the log event will be preserved when it is serialized. @param event: A log event dictionary. @return: A string of the serialized JSON; note that this will contain no newline characters, and may thus safely be stored in a line-delimited file. """ def default(unencodable: object) -> Union[JSONDict, str]: """ Serialize an object not otherwise serializable by L{dumps}. @param unencodable: An unencodable object. @return: C{unencodable}, serialized """ if isinstance(unencodable, bytes): return unencodable.decode("charmap") return objectSaveHook(unencodable) flattenEvent(event) return dumps(event, default=default, skipkeys=True) def eventFromJSON(eventText: str) -> JSONDict: """ Decode a log event from JSON. @param eventText: The output of a previous call to L{eventAsJSON} @return: A reconstructed version of the log event. """ return cast(JSONDict, loads(eventText, object_hook=objectLoadHook)) def jsonFileLogObserver( outFile: IO[Any], recordSeparator: str = "\x1e" ) -> FileLogObserver: """ Create a L{FileLogObserver} that emits JSON-serialized events to a specified (writable) file-like object. Events are written in the following form:: RS + JSON + NL C{JSON} is the serialized event, which is JSON text. C{NL} is a newline (C{"\\n"}). C{RS} is a record separator. By default, this is a single RS character (C{"\\x1e"}), which makes the default output conform to the IETF draft document "draft-ietf-json-text-sequence-13". @param outFile: A file-like object. Ideally one should be passed which accepts L{str} data. Otherwise, UTF-8 L{bytes} will be used. @param recordSeparator: The record separator to use. @return: A file log observer. """ return FileLogObserver( outFile, lambda event: f"{recordSeparator}{eventAsJSON(event)}\n" ) def eventsFromJSONLogFile( inFile: IO[Any], recordSeparator: Optional[str] = None, bufferSize: int = 4096, ) -> Iterable[LogEvent]: """ Load events from a file previously saved with L{jsonFileLogObserver}. Event records that are truncated or otherwise unreadable are ignored. @param inFile: A (readable) file-like object. Data read from C{inFile} should be L{str} or UTF-8 L{bytes}. @param recordSeparator: The expected record separator. If L{None}, attempt to automatically detect the record separator from one of C{"\\x1e"} or C{""}. @param bufferSize: The size of the read buffer used while reading from C{inFile}. @return: Log events as read from C{inFile}. """ def asBytes(s: AnyStr) -> bytes: if isinstance(s, bytes): return s else: return s.encode("utf-8") def eventFromBytearray(record: bytearray) -> Optional[LogEvent]: try: text = bytes(record).decode("utf-8") except UnicodeDecodeError: log.error( "Unable to decode UTF-8 for JSON record: {record!r}", record=bytes(record), ) return None try: return eventFromJSON(text) except ValueError: log.error("Unable to read JSON record: {record!r}", record=bytes(record)) return None if recordSeparator is None: first = asBytes(inFile.read(1)) if first == b"\x1e": # This looks json-text-sequence compliant. recordSeparatorBytes = first else: # Default to simpler newline-separated stream, which does not use # a record separator. recordSeparatorBytes = b"" else: recordSeparatorBytes = asBytes(recordSeparator) first = b"" if recordSeparatorBytes == b"": recordSeparatorBytes = b"\n" # Split on newlines below eventFromRecord = eventFromBytearray else: def eventFromRecord(record: bytearray) -> Optional[LogEvent]: if record[-1] == ord("\n"): return eventFromBytearray(record) else: log.error( "Unable to read truncated JSON record: {record!r}", record=bytes(record), ) return None buffer = bytearray(first) while True: newData = inFile.read(bufferSize) if not newData: if len(buffer) > 0: event = eventFromRecord(buffer) if event is not None: yield event break buffer += asBytes(newData) records = buffer.split(recordSeparatorBytes) for record in records[:-1]: if len(record) > 0: event = eventFromRecord(record) if event is not None: yield event buffer = records[-1] _global.py 0000644 00000020676 15027667615 0006547 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_global -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ This module includes process-global state associated with the logging system, and implementation of logic for managing that global state. """ import sys import warnings from typing import IO, Any, Iterable, Optional, Type from twisted.python.compat import currentframe from twisted.python.reflect import qual from ._buffer import LimitedHistoryLogObserver from ._file import FileLogObserver from ._filter import FilteringLogObserver, LogLevelFilterPredicate from ._format import eventAsText from ._interfaces import ILogObserver from ._io import LoggingFile from ._levels import LogLevel from ._logger import Logger from ._observer import LogPublisher MORE_THAN_ONCE_WARNING = ( "Warning: primary log target selected twice at <{fileNow}:{lineNow}> - " "previously selected at <{fileThen}:{lineThen}>. Remove one of the calls " "to beginLoggingTo." ) class LogBeginner: """ A L{LogBeginner} holds state related to logging before logging has begun, and begins logging when told to do so. Logging "begins" when someone has selected a set of observers, like, for example, a L{FileLogObserver} that writes to a file on disk, or to standard output. Applications will not typically need to instantiate this class, except those which intend to initialize the global logging system themselves, which may wish to instantiate this for testing. The global instance for the current process is exposed as L{twisted.logger.globalLogBeginner}. Before logging has begun, a L{LogBeginner} will: 1. Log any critical messages (e.g.: unhandled exceptions) to the given file-like object. 2. Save (a limited number of) log events in a L{LimitedHistoryLogObserver}. @cvar _DEFAULT_BUFFER_SIZE: The default size for the initial log events buffer. @ivar _initialBuffer: A buffer of messages logged before logging began. @ivar _publisher: The log publisher passed in to L{LogBeginner}'s constructor. @ivar _log: The logger used to log messages about the operation of the L{LogBeginner} itself. @ivar _stdio: An object with C{stderr} and C{stdout} attributes (like the L{sys} module) which will be replaced when redirecting standard I/O. @ivar _temporaryObserver: If not L{None}, an L{ILogObserver} that observes events on C{_publisher} for this L{LogBeginner}. """ _DEFAULT_BUFFER_SIZE = 200 def __init__( self, publisher: LogPublisher, errorStream: IO[Any], stdio: object, warningsModule: Any, initialBufferSize: Optional[int] = None, ) -> None: """ Initialize this L{LogBeginner}. @param initialBufferSize: The size of the event buffer into which events are collected until C{beginLoggingTo} is called. Or C{None} to use the default size. """ if initialBufferSize is None: initialBufferSize = self._DEFAULT_BUFFER_SIZE self._initialBuffer = LimitedHistoryLogObserver(size=initialBufferSize) self._publisher = publisher self._log = Logger(observer=publisher) self._stdio = stdio self._warningsModule = warningsModule self._temporaryObserver: Optional[ILogObserver] = LogPublisher( self._initialBuffer, FilteringLogObserver( FileLogObserver( errorStream, lambda event: eventAsText( event, includeTimestamp=False, includeSystem=False, ) + "\n", ), [LogLevelFilterPredicate(defaultLogLevel=LogLevel.critical)], ), ) self._previousBegin = ("", 0) publisher.addObserver(self._temporaryObserver) self._oldshowwarning = warningsModule.showwarning def beginLoggingTo( self, observers: Iterable[ILogObserver], discardBuffer: bool = False, redirectStandardIO: bool = True, ) -> None: """ Begin logging to the given set of observers. This will: 1. Add all the observers given in C{observers} to the L{LogPublisher} associated with this L{LogBeginner}. 2. Optionally re-direct standard output and standard error streams to the logging system. 3. Re-play any messages that were previously logged to that publisher to the new observers, if C{discardBuffer} is not set. 4. Stop logging critical errors from the L{LogPublisher} as strings to the C{errorStream} associated with this L{LogBeginner}, and allow them to be logged normally. 5. Re-direct warnings from the L{warnings} module associated with this L{LogBeginner} to log messages. @note: Since a L{LogBeginner} is designed to encapsulate the transition between process-startup and log-system-configuration, this method is intended to be invoked I{once}. @param observers: The observers to register. @param discardBuffer: Whether to discard the buffer and not re-play it to the added observers. (This argument is provided mainly for compatibility with legacy concerns.) @param redirectStandardIO: If true, redirect standard output and standard error to the observers. """ caller = currentframe(1) filename = caller.f_code.co_filename lineno = caller.f_lineno for observer in observers: self._publisher.addObserver(observer) if self._temporaryObserver is not None: self._publisher.removeObserver(self._temporaryObserver) if not discardBuffer: self._initialBuffer.replayTo(self._publisher) self._temporaryObserver = None self._warningsModule.showwarning = self.showwarning else: previousFile, previousLine = self._previousBegin self._log.warn( MORE_THAN_ONCE_WARNING, fileNow=filename, lineNow=lineno, fileThen=previousFile, lineThen=previousLine, ) self._previousBegin = (filename, lineno) if redirectStandardIO: streams = [("stdout", LogLevel.info), ("stderr", LogLevel.error)] else: streams = [] for (stream, level) in streams: oldStream = getattr(self._stdio, stream) loggingFile = LoggingFile( logger=Logger(namespace=stream, observer=self._publisher), level=level, encoding=getattr(oldStream, "encoding", None), ) setattr(self._stdio, stream, loggingFile) def showwarning( self, message: str, category: Type[Warning], filename: str, lineno: int, file: Optional[IO[Any]] = None, line: Optional[str] = None, ) -> None: """ Twisted-enabled wrapper around L{warnings.showwarning}. If C{file} is L{None}, the default behaviour is to emit the warning to the log system, otherwise the original L{warnings.showwarning} Python function is called. @param message: A warning message to emit. @param category: A warning category to associate with C{message}. @param filename: A file name for the source code file issuing the warning. @param lineno: A line number in the source file where the warning was issued. @param file: A file to write the warning message to. If L{None}, write to L{sys.stderr}. @param line: A line of source code to include with the warning message. If L{None}, attempt to read the line from C{filename} and C{lineno}. """ if file is None: self._log.warn( "{filename}:{lineno}: {category}: {warning}", warning=message, category=qual(category), filename=filename, lineno=lineno, ) else: self._oldshowwarning(message, category, filename, lineno, file, line) globalLogPublisher = LogPublisher() globalLogBeginner = LogBeginner(globalLogPublisher, sys.stderr, sys, warnings) _format.py 0000644 00000027142 15027667615 0006572 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_format -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Tools for formatting logging events. """ from collections.abc import Mapping as MappingABC from datetime import datetime as DateTime from typing import Any, Callable, Iterator, Mapping, Optional, Union, cast from constantly import NamedConstant # type: ignore[import] from twisted.python._tzhelper import FixedOffsetTimeZone from twisted.python.failure import Failure from twisted.python.reflect import safe_repr from ._flatten import aFormatter, flatFormat from ._interfaces import LogEvent timeFormatRFC3339 = "%Y-%m-%dT%H:%M:%S%z" def formatEvent(event: LogEvent) -> str: """ Formats an event as text, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. """ return eventAsText( event, includeTraceback=False, includeTimestamp=False, includeSystem=False, ) def formatUnformattableEvent(event: LogEvent, error: BaseException) -> str: """ Formats an event as text that describes the event generically and a formatting error. @param event: A logging event. @param error: The formatting error. @return: A formatted string. """ try: return "Unable to format event {event!r}: {error}".format( event=event, error=error ) except BaseException: # Yikes, something really nasty happened. # # Try to recover as much formattable data as possible; hopefully at # least the namespace is sane, which will help you find the offending # logger. failure = Failure() text = ", ".join( " = ".join((safe_repr(key), safe_repr(value))) for key, value in event.items() ) return ( "MESSAGE LOST: unformattable object logged: {error}\n" "Recoverable data: {text}\n" "Exception during formatting:\n{failure}".format( error=safe_repr(error), failure=failure, text=text ) ) def formatTime( when: Optional[float], timeFormat: Optional[str] = timeFormatRFC3339, default: str = "-", ) -> str: """ Format a timestamp as text. Example:: >>> from time import time >>> from twisted.logger import formatTime >>> >>> t = time() >>> formatTime(t) u'2013-10-22T14:19:11-0700' >>> formatTime(t, timeFormat="%Y/%W") # Year and week number u'2013/42' >>> @param when: A timestamp. @param timeFormat: A time format. @param default: Text to return if C{when} or C{timeFormat} is L{None}. @return: A formatted time. """ if timeFormat is None or when is None: return default else: tz = FixedOffsetTimeZone.fromLocalTimeStamp(when) datetime = DateTime.fromtimestamp(when, tz) return str(datetime.strftime(timeFormat)) def formatEventAsClassicLogText( event: LogEvent, formatTime: Callable[[Optional[float]], str] = formatTime ) -> Optional[str]: """ Format an event as a line of human-readable text for, e.g. traditional log file output. The output format is C{"{timeStamp} [{system}] {event}\\n"}, where: - C{timeStamp} is computed by calling the given C{formatTime} callable on the event's C{"log_time"} value - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. Example:: >>> from time import time >>> from twisted.logger import formatEventAsClassicLogText >>> from twisted.logger import LogLevel >>> >>> formatEventAsClassicLogText(dict()) # No format, returns None >>> formatEventAsClassicLogText(dict(log_format="Hello!")) u'- [-#-] Hello!\\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_namespace="my_namespace", ... log_level=LogLevel.info, ... )) u'2013-10-22T17:30:02-0700 [my_namespace#info] Hello!\\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_system="my_system", ... )) u'2013-11-11T17:22:06-0800 [my_system] Hello!\\n' >>> @param event: an event. @param formatTime: A time formatter @return: A formatted event, or L{None} if no output is appropriate. """ eventText = eventAsText(event, formatTime=formatTime) if not eventText: return None eventText = eventText.replace("\n", "\n\t") return eventText + "\n" class CallMapping(MappingABC): """ Read-only mapping that turns a C{()}-suffix in key names into an invocation of the key rather than a lookup of the key. Implementation support for L{formatWithCall}. """ def __init__(self, submapping: Mapping[str, Any]) -> None: """ @param submapping: Another read-only mapping which will be used to look up items. """ self._submapping = submapping def __iter__(self) -> Iterator: return iter(self._submapping) def __len__(self) -> int: return len(self._submapping) def __getitem__(self, key: str) -> Any: """ Look up an item in the submapping for this L{CallMapping}, calling it if C{key} ends with C{"()"}. """ callit = key.endswith("()") realKey = key[:-2] if callit else key value = self._submapping[realKey] if callit: value = value() return value def formatWithCall(formatString: str, mapping: Mapping[str, Any]) -> str: """ Format a string like L{str.format}, but: - taking only a name mapping; no positional arguments - with the additional syntax that an empty set of parentheses correspond to a formatting item that should be called, and its result C{str}'d, rather than calling C{str} on the element directly as normal. For example:: >>> formatWithCall("{string}, {function()}.", ... dict(string="just a string", ... function=lambda: "a function")) 'just a string, a function.' @param formatString: A PEP-3101 format string. @param mapping: A L{dict}-like object to format. @return: The string with formatted values interpolated. """ return str(aFormatter.vformat(formatString, (), CallMapping(mapping))) def _formatEvent(event: LogEvent) -> str: """ Formats an event as a string, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. """ try: if "log_flattened" in event: return flatFormat(event) format = cast(Optional[Union[str, bytes]], event.get("log_format", None)) if format is None: return "" # Make sure format is text. if isinstance(format, str): pass elif isinstance(format, bytes): format = format.decode("utf-8") else: raise TypeError(f"Log format must be str, not {format!r}") return formatWithCall(format, event) except BaseException as e: return formatUnformattableEvent(event, e) def _formatTraceback(failure: Failure) -> str: """ Format a failure traceback, assuming UTF-8 and using a replacement strategy for errors. Every effort is made to provide a usable traceback, but should not that not be possible, a message and the captured exception are logged. @param failure: The failure to retrieve a traceback from. @return: The formatted traceback. """ try: traceback = failure.getTraceback() except BaseException as e: traceback = "(UNABLE TO OBTAIN TRACEBACK FROM EVENT):" + str(e) return traceback def _formatSystem(event: LogEvent) -> str: """ Format the system specified in the event in the "log_system" key if set, otherwise the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. If formatting fails completely, "UNFORMATTABLE" is returned. @param event: The event containing the system specification. @return: A formatted string representing the "log_system" key. """ system = cast(Optional[str], event.get("log_system", None)) if system is None: level = cast(Optional[NamedConstant], event.get("log_level", None)) if level is None: levelName = "-" else: levelName = level.name system = "{namespace}#{level}".format( namespace=cast(str, event.get("log_namespace", "-")), level=levelName, ) else: try: system = str(system) except Exception: system = "UNFORMATTABLE" return system def eventAsText( event: LogEvent, includeTraceback: bool = True, includeTimestamp: bool = True, includeSystem: bool = True, formatTime: Callable[[float], str] = formatTime, ) -> str: r""" Format an event as text. Optionally, attach timestamp, traceback, and system information. The full output format is: C{"{timeStamp} [{system}] {event}\n{traceback}\n"} where: - C{timeStamp} is the event's C{"log_time"} value formatted with the provided C{formatTime} callable. - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. - C{traceback} is the traceback if the event contains a C{"log_failure"} key. In the event the original traceback cannot be formatted, a message indicating the failure will be substituted. If the event cannot be formatted, and no traceback exists, an empty string is returned, even if includeSystem or includeTimestamp are true. @param event: A logging event. @param includeTraceback: If true and a C{"log_failure"} key exists, append a traceback. @param includeTimestamp: If true include a formatted timestamp before the event. @param includeSystem: If true, include the event's C{"log_system"} value. @param formatTime: A time formatter @return: A formatted string with specified options. @since: Twisted 18.9.0 """ eventText = _formatEvent(event) if includeTraceback and "log_failure" in event: f = event["log_failure"] traceback = _formatTraceback(f) eventText = "\n".join((eventText, traceback)) if not eventText: return eventText timeStamp = "" if includeTimestamp: timeStamp = "".join([formatTime(cast(float, event.get("log_time", None))), " "]) system = "" if includeSystem: system = "".join(["[", _formatSystem(event), "]", " "]) return "{timeStamp}{system}{eventText}".format( timeStamp=timeStamp, system=system, eventText=eventText, ) __init__.py 0000644 00000006451 15027667615 0006702 0 ustar 00 # -*- test-case-name: twisted.logger.test -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Twisted Logger: Classes and functions to do granular logging. Example usage in a module C{some.module}:: from twisted.logger import Logger log = Logger() def handleData(data): log.debug("Got data: {data!r}.", data=data) Or in a class:: from twisted.logger import Logger class Foo: log = Logger() def oops(self, data): self.log.error("Oops! Invalid data from server: {data!r}", data=data) C{Logger}s have namespaces, for which logging can be configured independently. Namespaces may be specified by passing in a C{namespace} argument to L{Logger} when instantiating it, but if none is given, the logger will derive its own namespace by using the module name of the callable that instantiated it, or, in the case of a class, by using the fully qualified name of the class. In the first example above, the namespace would be C{some.module}, and in the second example, it would be C{some.module.Foo}. @var globalLogPublisher: The L{LogPublisher} that all L{Logger} instances that are not otherwise parameterized will publish events to by default. @var globalLogBeginner: The L{LogBeginner} used to activate the main log observer, whether it's a log file, or an observer pointing at stderr. """ __all__ = [ # From ._levels "InvalidLogLevelError", "LogLevel", # From ._format "formatEvent", "formatEventAsClassicLogText", "formatTime", "timeFormatRFC3339", "eventAsText", # From ._flatten "extractField", # From ._interfaces "ILogObserver", "LogEvent", # From ._logger "Logger", "_loggerFor", # From ._observer "LogPublisher", # From ._buffer "LimitedHistoryLogObserver", # From ._file "FileLogObserver", "textFileLogObserver", # From ._filter "PredicateResult", "ILogFilterPredicate", "FilteringLogObserver", "LogLevelFilterPredicate", # From ._stdlib "STDLibLogObserver", # From ._io "LoggingFile", # From ._legacy "LegacyLogObserverWrapper", # From ._global "globalLogPublisher", "globalLogBeginner", "LogBeginner", # From ._json "eventAsJSON", "eventFromJSON", "jsonFileLogObserver", "eventsFromJSONLogFile", # From ._capture "capturedLogs", ] from ._levels import InvalidLogLevelError, LogLevel from ._flatten import extractField from ._format import ( formatEvent, formatEventAsClassicLogText, formatTime, timeFormatRFC3339, eventAsText, ) from ._interfaces import ILogObserver, LogEvent from ._logger import Logger, _loggerFor from ._observer import LogPublisher from ._buffer import LimitedHistoryLogObserver from ._file import FileLogObserver, textFileLogObserver from ._filter import ( PredicateResult, ILogFilterPredicate, FilteringLogObserver, LogLevelFilterPredicate, ) from ._stdlib import STDLibLogObserver from ._io import LoggingFile from ._legacy import LegacyLogObserverWrapper from ._global import globalLogPublisher, globalLogBeginner, LogBeginner from ._json import ( eventAsJSON, eventFromJSON, jsonFileLogObserver, eventsFromJSONLogFile, ) from ._capture import capturedLogs _legacy.py 0000644 00000012171 15027667615 0006542 0 ustar 00 # -*- test-case-name: twisted.logger.test.test_legacy -*- # Copyright (c) Twisted Matrix Laboratories. # See LICENSE for details. """ Integration with L{twisted.python.log}. """ from typing import TYPE_CHECKING, Any, Callable, Dict, Optional from zope.interface import implementer from ._format import formatEvent from ._interfaces import ILogObserver, LogEvent from ._levels import LogLevel from ._stdlib import StringifiableFromEvent, fromStdlibLogLevelMapping if TYPE_CHECKING: from twisted.python.log import ILogObserver as ILegacyLogObserver @implementer(ILogObserver) class LegacyLogObserverWrapper: """ L{ILogObserver} that wraps a L{twisted.python.log.ILogObserver}. Received (new-style) events are modified prior to forwarding to the legacy observer to ensure compatibility with observers that expect legacy events. """ def __init__(self, legacyObserver: "ILegacyLogObserver") -> None: """ @param legacyObserver: a legacy observer to which this observer will forward events. """ self.legacyObserver = legacyObserver def __repr__(self) -> str: return "{self.__class__.__name__}({self.legacyObserver})".format(self=self) def __call__(self, event: LogEvent) -> None: """ Forward events to the legacy observer after editing them to ensure compatibility. @param event: an event """ # The "message" key is required by textFromEventDict() if "message" not in event: event["message"] = () if "time" not in event: event["time"] = event["log_time"] if "system" not in event: event["system"] = event.get("log_system", "-") # Format new style -> old style if "format" not in event and event.get("log_format", None) is not None: # Create an object that implements __str__() in order to defer the # work of formatting until it's needed by a legacy log observer. event["format"] = "%(log_legacy)s" event["log_legacy"] = StringifiableFromEvent(event.copy()) # In the old-style system, the 'message' key always holds a tuple # of messages. If we find the 'message' key here to not be a # tuple, it has been passed as new-style parameter. We drop it # here because we render it using the old-style 'format' key, # which otherwise doesn't get precedence, and the original event # has been copied above. if not isinstance(event["message"], tuple): event["message"] = () # From log.failure() -> isError blah blah if "log_failure" in event: if "failure" not in event: event["failure"] = event["log_failure"] if "isError" not in event: event["isError"] = 1 if "why" not in event: event["why"] = formatEvent(event) elif "isError" not in event: if event["log_level"] in (LogLevel.error, LogLevel.critical): event["isError"] = 1 else: event["isError"] = 0 self.legacyObserver(event) def publishToNewObserver( observer: ILogObserver, eventDict: Dict[str, Any], textFromEventDict: Callable[[Dict[str, Any]], Optional[str]], ) -> None: """ Publish an old-style (L{twisted.python.log}) event to a new-style (L{twisted.logger}) observer. @note: It's possible that a new-style event was sent to a L{LegacyLogObserverWrapper}, and may now be getting sent back to a new-style observer. In this case, it's already a new-style event, adapted to also look like an old-style event, and we don't need to tweak it again to be a new-style event, hence this checks for already-defined new-style keys. @param observer: A new-style observer to handle this event. @param eventDict: An L{old-style <twisted.python.log>}, log event. @param textFromEventDict: callable that can format an old-style event as a string. Passed here rather than imported to avoid circular dependency. """ if "log_time" not in eventDict: eventDict["log_time"] = eventDict["time"] if "log_format" not in eventDict: text = textFromEventDict(eventDict) if text is not None: eventDict["log_text"] = text eventDict["log_format"] = "{log_text}" if "log_level" not in eventDict: if "logLevel" in eventDict: try: level = fromStdlibLogLevelMapping[eventDict["logLevel"]] except KeyError: level = None elif "isError" in eventDict: if eventDict["isError"]: level = LogLevel.critical else: level = LogLevel.info else: level = LogLevel.info if level is not None: eventDict["log_level"] = level if "log_namespace" not in eventDict: eventDict["log_namespace"] = "log_legacy" if "log_system" not in eventDict and "system" in eventDict: eventDict["log_system"] = eventDict["system"] observer(eventDict)
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.03 |
proxy
|
phpinfo
|
Settings