LSrSSKJr SSKJr SSKJr SSKrSSKrSSKrSSKrSSK r SSK r "SS\ 5r "SS \ 5r"S S \5r"S S \5r"SS\5r"SS\5r"SS\5r"SS\5rSrg)aTable formatting library. We define a TableFormatter interface, and create subclasses for several different print formats, including formats intended for both human and machine consumption: Human Consumption ----------------- PrettyFormatter: This prints ASCII-art bordered tables. Inspired by the prettytable python library. Example: +-----+---------------+ | foo | longer header | +-----+---------------+ | a | 3 | | ... | | abc | 123 | +-----+---------------+ SparsePrettyFormatter: This is a PrettyFormatter which simply doesn't print most of the border. Example: foo longer header ----- --------------- a 3 ... abc 123 PrettyJsonFormatter: Prints JSON output in a format easily read by a human. Example: [ { "foo": "a", "longer header": 3 }, ... { "foo": "abc", "longer header": 123 } ] Machine Consumption ------------------- CsvFormatter: Prints output in CSV form, with minimal quoting, '\n' separation between lines, and including a header line. Example: foo,longer header a,3 ... abc,123 JsonFormatter: Prints JSON output in the most compact form possible. Example: [{"foo":"a","longer header":3},...,{"foo":"abc","longer header":123}] Additional formatters can be added by subclassing TableFormatter and overriding the following methods: __len__, __unicode__, AddRow, column_names, AddColumn Formatters that require non-empty output to be valid should override `_empty_output_meaningful` For example JsonFormatter must emit '[]' to produce valid json. )absolute_import)division)print_functionNc\rSrSrSrg)FormatterExceptiondN)__name__ __module__ __qualname____firstlineno____static_attributes__r platform/bq/table_formatter.pyrrdsrrc\rSrSrSrSrSrSrSrSr Sr S r SS jr S r S rSrSrSr\S5rSSjrSSjrSrg )TableFormatterhzInterface for table formatters.Fc pUR[:Xa [S5eURSS5Ulg)aInitializes the base class. Keyword arguments: skip_header_when_empty: If true, does not print the table's header if there are zero rows. This argument has no effect on PrettyJsonFormatter. Ignored by the Print method, but respected if calling str or unicode on the formatter itself. Print will emit nothing if there are zero rows, unless the format being emitted requires text to be valid (eg json). z0Cannot instantiate abstract class TableFormatterskip_header_when_emptyFN) __class__rNotImplementedErrorgetr)selfkwdss r__init__TableFormatter.__init__ls4 ~~'  < >>"&((+CU"KDrc*[[U55$N)boollenrs r __nonzero__TableFormatter.__nonzero__|s D ?rc[S5e)Nz'__len__ must be implemented by subclassrr!s r__len__TableFormatter.__len__s G HHrcJUR[R"55$r) _EncodedStrsysgetdefaultencodingr!s r__str__TableFormatter.__str__s   C224 55rc[S5e)Nz+__unicode__ must be implemented by subclassr%r!s r __unicode__TableFormatter.__unicode__s K LLrc`UR5RUS5RU5$)Nbackslashreplace)r/encodedecode)rencodings rr)TableFormatter._EncodedStrs.     $ $X%7 99?9IJrNcU(dUR(aVU(aUO[Rn[RR=(d Sn[ UR U5US9 gg)Nutf8)file)_empty_output_meaningfulr*stdoutr5printr))routputr9r5s rPrintTableFormatter.PrintsJ t,,V3::d$$.h D  X &T2 -rc[S5e)z.Add a new row (an iterable) to this formatter.z&AddRow must be implemented by subclassr%rrows rAddRowTableFormatter.AddRows F GGrc8UHnURU5 M g)zAdd all rows to this table.NrCrrowsrBs rAddRowsTableFormatter.AddRowss kk#rc^URS/5S:XaSOSnURUSUS9 g)z.Add a field as a new column to this formatter.typeSTRINGlrname)alignN)r AddColumn)rfieldrQs rAddFieldTableFormatter.AddFields199VR(H4C#ENN5=N.rc8UHnURU5 M g)z+Convenience method to add a list of fields.N)rT)rfieldsrSs r AddFieldsTableFormatter.AddFieldss mmErc URURVs/sHo!RUS5PM sn5 gs snf)z2Add a dict as a row by using column names as keys.N)rC column_namesr)rdrPs rAddDictTableFormatter.AddDicts0KKT->->?->TtR->?@?s=c[S5e)z0Return the ordered list of column names in self.z,column_names must be implemented by subclassr%r!s rr\TableFormatter.column_namess L MMrc [S5e)z#Add a new column to this formatter.z)AddColumn must be implemented by subclassr%)r column_namerQrs rrRTableFormatter.AddColumns I JJrcU=(d 0/[U5-n[X5Hup4UR"U40UD6 M g)z*Add a series of columns to this formatter.N)r ziprR)rr\kwdssrcrs r AddColumnsTableFormatter.AddColumnss;  -bTC --E 5  nn[)D)6r)rr)rO)r r r r __doc__r:rr"r&r,r/r)r>rCrIrTrXr^propertyr\rRrhrr rrrrhsn'"L I6MJ 3H /  A N NK*rrc^\rSrSrSrU4SjrSrSr\SSj5r \S5r \SSj5r SS jr S r S rS rS rSrSSjr\S5rSrU=r$)PrettyFormatterz2Formats output as an ASCII-art table with borders.c >[[U] "S 0UD6 URSS5UlURSS5UlURSS5Ul/Ul/Ul/Ul /Ul /Ul SUl g) aInitialize a new PrettyFormatter. Keyword arguments: junction_char: (default: +) Character to use for table junctions. horizontal_char: (default: -) Character to use for horizontal lines. vertical_char: (default: |) Character to use for vertical lines. junction_char+horizontal_char- vertical_char|Nr ) superrmrrrprrrtrH row_heights _column_names column_widthscolumn_alignments header_heightrrrs rrPrettyFormatter.__init__s /4)1D1/37D88$5s;D/37DDIDDDDDrc,[UR5$r)r rHr!s rr&PrettyFormatter.__len__s tyy>rcU(dUR(dC[R"UR5UR 5UR 55nO/nSR U5$N )r itertoolschain FormatHeader FormatRows FormatHrulejoinrliness rr/PrettyFormatter.__unicode__sR 4..oo    t0$2B2B2DFee 99U rcX:a [S5eUS-US-:HnX- S-nU(aXD4$U(aXDS-4$US-U4$)aJCompute information for centering a string in a fixed space. Given two integers interval and size, with size <= interval, this function computes two integers left_padding and right_padding with left_padding + right_padding + size = interval and |left_padding - right_padding| <= 1. In the case that interval and size have different parity, left_padding will be larger iff left_justify is True. (That is, iff the string should be left justified in the "center" space.) Args: interval: Size of the fixed space. size: Size of the string to center in that space. left_justify: (optional, default: True) Whether the string should be left-justified in the center space. Returns: left_padding, right_padding: The size of the left and right margins for centering the string. Raises: FormatterException: If size > interval. z!Illegal state in table formattingrv)r)intervalsize left_justify same_paritypaddings rCenteredPaddingPrettyFormatter.CenteredPaddings^6  B CCaTRR[U5UTUS9$)N)rrQ)rrstr)rrrQ row_heightrs r+PrettyFormatter.FormatRow..ls(1J1J E Ez2K2@rc3># UH8nTRR[R"S/US/55v M: g7f)r[N)rtrrr).0cellsrs r ,PrettyFormatter.FormatRow..ps= '%    # #IOORD%"$F G G%sAA)r{rzrfmap)rentriesrr{rzcurried_format printed_rowss` ` r FormatRowPrettyFormatter.FormatRowSsU**CT-C-C!7T%7%7M@N ^m GIL '% ''rcx[R"S5nURURURUS9$)z8Return an iterator over the row(s) for the column names.r)r{)rrrr\r|)ralignss r HeaderLinesPrettyFormatter.HeaderLinesss;   c "F >>$++T-?-?,2  44rcSUR5nURR[R"S/US/55/$)z1Return a list containing an hrule for this table.c3t# UH.nSR[R"SUS-55v M0 g7f)r[rsrN)rrr)rrs rr.PrettyFormatter.FormatHrule..{s40.5wwy''UQY788.s68r[)rzrprrr)rrs rrPrettyFormatter.FormatHruleysB0 ..0G    # #IOORD'B4$H I JJrc[R"UR5UR5UR55$)z?Return an iterator over the lines for the header of this table.)rrrrr!s rrPrettyFormatter.FormatHeaders7 ?? D,,.0@0@0B DDrcz[R"[URURUR 56$)z3Return an iterator over all the rows in this table.)rrrrrHrxr!s rrPrettyFormatter.FormatRowss( ??C 4;K;KL MMrc[U5[UR5:wa[S[U5<35eUVs/sH&n[U5R 5=(d S/PM( nnUR R [SU555 SU5n[X@R5VVs/sHupV[XV5PM snnUl URR U5 gs snfs snnf)zAdd a row to this table. Args: row: A list of length equal to the number of columns in this table. Raises: FormatterException: If the row length is invalid. zInvalid row length: r[c38# UHn[U5v M g7fr)r )rrs rr)PrettyFormatter.AddRow..sC uE sc3F# UHn[SU55v M g7f)c3N# UHn[R"U5v M g7frrrrrs rr3PrettyFormatter.AddRow...s 5utG  T " "u#%N)max)rrs rrrs"OCM% 5u 555:s!N) r r\rrrrxrrrfrzrH)rrBr split_rowsrzrcurrents rrCPrettyFormatter.AddRows 3x3t(()) 3s8E FFADE3u:((*2rd2JECC CCDOCMOM"-1C1CDDNE EDD IISFs -C6:C;c U(a [S5eUS;a[SU<35e[U5R5=(d S/nURR [ SU555 UR R U5 URR U5 [ [U5UR5Ul g)aAdd a column to this table. Args: column_name: Name for the new column. align: (optional, default: 'l') Alignment for the new column entries. Raises: FormatterException: If the table already has any rows, or if the provided alignment is invalid. /Cannot add a new column to an initialized table)rNrrOzInvalid column alignment: r[c3N# UHn[R"U5v M g7frrrs rr,PrettyFormatter.AddColumn..s!KUT'"2"24"8"8UrN) rrrrzrrr{r\r r|)rrcrQrrs rrRPrettyFormatter.AddColumns  ; == O# H II   ' ' ) 1bTEc!KU!KKL!!%([)SZ););SSS.nURU5 [[U]"S0UD6 g)z'Initialize a new SparsePrettyFormatter.r)rprtNr )updaterwrr)rr default_kwdsrs rrSparsePrettyFormatter.__init__s1%(%(*L /?,?rcU(dUR(d4[R"UR5UR 55nO/nSR U5$r)rrrrrrrs rr/!SparsePrettyFormatter.__unicode__sA 4..ood//14??3DEee 99U rch[R"UR5UR55$)z8Return an iterator over the header lines for this table.)rrrrr!s rr"SparsePrettyFormatter.FormatHeaders% ??4++-t/?/?/A BBrr ) r r r r rjrr/rrrrs@rrrsC@CCrrc`^\rSrSrSrU4SjrSrSrSrSr \ S5r S r S r S rU=r$) CsvFormatterizFormats output as CSV with header lines. The resulting CSV file includes a header line, uses Unix-style newlines, and only quotes those entries which require it, namely those that contain quotes, newlines, or commas. c >[[U] "S0UD6 [R"5Ul/Ul[R"UR [RSS9Ul g)Nr)quotinglineterminatorr ) rwrrioStringIO_buffer_headercsvwriter QUOTE_MINIMAL_tabler}s rrCsvFormatter.__init__sK ,&..;;=DLDL** c//FDKrcH[URR55$r)rrtellr!s rr"CsvFormatter.__nonzero__s  !!# $$rcH[URR55$r)rrgetvaluer!s r__bool__CsvFormatter.__bool__s  %%' ((rcF[[U5R55$r)r rrr!s rr&CsvFormatter.__len__s s4y##% &&rcU(dUR(d6SRUR5URR 5/nO/nSRU5R 5$)N,r)rrrrr rstriprs rr/CsvFormatter.__unicode__sP 4..xx %t||'<'<'>?ee 99U  " " $$rc URSS$r)rr!s rr\CsvFormatter.column_namess <<?rc ^U(a [S5eURRU5 gNr)rrrrrcrs rrRCsvFormatter.AddColumns'  ; ==LL $rc:URRU5 gr)rwriterowrAs rrCCsvFormatter.AddRowsKKr)rrr)r r r r rjrr"r r&r/rkr\rRrCrrrs@rrrsEF%)'%  % rrcX^\rSrSrSrSrU4SjrSrSr\ S5r Sr S r S r U=r$) JsonFormatteriz)Formats output in maximally compact JSON.Tc J>[[U] "S0UD6 /Ul/UlgNr )rwrr _field_namesrr}s rrJsonFormatter.__init__s$ -'/$/DDKrc,[UR5$r)r rr!s rr&JsonFormatter.__len__s t{{ rcD[R"URSSSS9$)N)r:TF) separators sort_keys ensure_asciijsondumpsrr!s rr/JsonFormatter.__unicode__ s" :: d PPrc URSS$r)r!r!s rr\JsonFormatter.column_names s   Q rc ^U(a [S5eURRU5 gr)rr!rrs rrRJsonFormatter.AddColumns)  ; ==[)rc[U5[UR5:wa[SU<35eURR [ [ URU555 g)Nz Invalid row: )r r!rrrdictrfrAs rrCJsonFormatter.AddRowsK 3x3t(()) C9 ::KKtC 1 13789r)r!r)r r r r rjr:rr&r/rkr\rRrCrrrs@rrrs?1! P    * ::rrc\rSrSrSrSrSrg)PrettyJsonFormatteriz%Formats output in human-legible JSON.cF[R"URSSSSS9$)N)z, z: TrF)r'r(indentr)r*r!s rr/PrettyJsonFormatter.__unicode__ s& ::   rr N)r r r r rjr/rr rrr6r6s -rr6c`^\rSrSrSrU4SjrSrSrSrSr Sr \ S 5r S r S rU=r$) NullFormatteri)z'Formatter that prints no output at all.c J>[[U] "S0UD6 /Ul/Ulgr )rwr;rry_rowsr}s rrNullFormatter.__init__,s$ -'/$/DDJrc,[UR5$r)rr=r!s rr"NullFormatter.__nonzero__1s  rc,[UR5$r)r r=r!s rr&NullFormatter.__len__4s tzz?rcg)Nr[r r!s rr/NullFormatter.__unicode__7s rc:URRU5 gr)r=rrAs rrCNullFormatter.AddRow:sJJcrc8UHnURU5 M grrFrGs rrINullFormatter.AddRows=s kk#rc URSS$rrr!s rr\NullFormatter.column_namesAs   a  rc :URRU5 gr)ryrrs rrRNullFormatter.AddColumnEsk*r)ryr=)r r r r rjrr"r&r/rCrIrkr\rRrrrs@rr;r;)sB/  ! !++rr;cUS:Xa [5nU$US:Xa [5nU$US:Xa [5nU$US:Xa [5nU$US:Xa [ 5nU$US:Xa [ 5nU$[ SU-5e)z-Map a format name to a TableFormatter object.rprettyr+ prettyjsonsparsenonezUnknown format: %s)rrmrr6rr;r) table_formattable_formatters r GetFormatterrTIsU"nO x%'O v#oO |#)+O  x+-O  v#oO  1L@ AAr)rj __future__rrrrrrr+r*r Exceptionrobjectrrmrrrr6r;rTr rrrXsDP'%  R*VR*jxnxvCOC,,>,^:N:@ - +N+@r