graphviz-0.20.2/ 0000777 0000000 0000000 00000000000 14575736336 012152 5 ustar root root graphviz-0.20.2/docs/ 0000777 0000000 0000000 00000000000 14575736336 013102 5 ustar root root graphviz-0.20.2/docs/_static/ 0000777 0000000 0000000 00000000000 14575736336 014530 5 ustar root root graphviz-0.20.2/docs/_static/angles.svg 0000666 0000000 0000000 00000025176 14144623610 016513 0 ustar root root
graphviz-0.20.2/docs/_static/btree.svg 0000666 0000000 0000000 00000021020 14144623610 016323 0 ustar root root
graphviz-0.20.2/docs/_static/cluster.svg 0000666 0000000 0000000 00000017715 14144623610 016723 0 ustar root root
graphviz-0.20.2/docs/_static/cluster_edge.svg 0000666 0000000 0000000 00000013573 14144623610 017705 0 ustar root root
graphviz-0.20.2/docs/_static/colors.svg 0000666 0000000 0000000 00000003424 14144623610 016533 0 ustar root root
graphviz-0.20.2/docs/_static/diamond.svg 0000666 0000000 0000000 00000001476 14144623610 016652 0 ustar root root
graphviz-0.20.2/docs/_static/er.svg 0000666 0000000 0000000 00000016675 14144623610 015654 0 ustar root root
graphviz-0.20.2/docs/_static/escapes.svg 0000666 0000000 0000000 00000002512 14144623610 016652 0 ustar root root
graphviz-0.20.2/docs/_static/fdpclust.svg 0000666 0000000 0000000 00000010130 14144623610 017046 0 ustar root root
graphviz-0.20.2/docs/_static/fsm.svg 0000666 0000000 0000000 00000022705 14144623610 016022 0 ustar root root
graphviz-0.20.2/docs/_static/g_c_n.svg 0000666 0000000 0000000 00000003764 14144623610 016306 0 ustar root root
graphviz-0.20.2/docs/_static/hello.svg 0000666 0000000 0000000 00000002621 14144623610 016333 0 ustar root root
graphviz-0.20.2/docs/_static/holy-grenade.svg 0000666 0000000 0000000 00000004575 14144623610 017620 0 ustar root root
graphviz-0.20.2/docs/_static/html_table.svg 0000666 0000000 0000000 00000002501 14144623610 017340 0 ustar root root
graphviz-0.20.2/docs/_static/literal_backslash.svg 0000666 0000000 0000000 00000001550 14151056254 020701 0 ustar root root
graphviz-0.20.2/docs/_static/ni.svg 0000666 0000000 0000000 00000011000 14144623610 015625 0 ustar root root
graphviz-0.20.2/docs/_static/pet-shop.svg 0000666 0000000 0000000 00000002446 14144623610 016774 0 ustar root root
graphviz-0.20.2/docs/_static/process.svg 0000666 0000000 0000000 00000013714 14144367036 016722 0 ustar root root
graphviz-0.20.2/docs/_static/qtconsole-source.png 0000666 0000000 0000000 00000033504 14075133014 020523 0 ustar root root PNG
IHDR K罬 sRGB gAMA a pHYs od 6IDATx^yx zE@P6D up|vE@ 0OaEYdsCT r:M%lA%>>Pu;mqH^{ĩlA%]qzٮ{mvKm7w~jr^ ju=ԋ_zkvS[lWUSm ]pR{Y7Hp& HݣCnh{쐱f^v[NJ[EJӷP{̚u*p~uW_[9\ qq?xx5{e ]X՝V/~Oc:fg8i0wW6.*MjMW
AԵWJY3]
R ~:]qgNS
'7:Am^myzGy6 8fݽpm)lfc& Z)f"άi*=C}R K-^Ny =SlK'm'xd֝U9 .N3Yw)̀gpw#읇g$G?0m ] zP]Ѥx
PRօ є4 FW+,FWfl8v{qꀷ ^}3۠6j;nCMCm8C쟶z۶h84{f"S@Ftyxb |"Z7kbF0Dt9sZe2A (nY)%:\=Au9 i9dǾo6Ƃ ROrwOV[E;'mz3; Xxw+>&xo1xR$_pA`'$`R> J3+9A\il8}V}+
F1 G)n fm{; &fhL, FW+,LGx雎`Dj
A(HD8ԽwJ˷ߥF pG'IMOZw);&t_q낾p1Wc ﮤUԫ FW+Nߪ3] džNԆ iLdeA1)#\=L9?rwƄ+!MKo+[s-[ZwW DpRsj '}X/m?JA] AAcߏ|KɴdS P fd1{I~w hn@ E AA AAP sp@AԹ`8 \0 Aup[_ %& c 0p,0 % ñp w2 H
VVԊRkCeQǽj ].̓hV(l8Fj 11[?txR 9z-&9-W 7EuP{gc*B6\,L3~ P 1-fV Ծ=9?7pgéEAy^ *w\ 4!kj:qc2~ @A /wG mM5Soz2E]/c|! ^G~|wzshy0H*pe J,+pr|\"I]=&&hr5_gM Ѥ @th84ZU^LV{Y}i2TM6晾IG-ۖL OcK$Jr
F.98f4ǔǬ8nGʘ0( 1a d04V H c 20 c 20 c 0p,4a/ ,7뮻 :Qi8V F ~7`8 g"r F8# 4 p D p&"Ga8i?{aVeq]wO D8~lM]M Oq\~}:ӣҧ!=7c @#Gt 3$2Nz; dM֣}8wf&3Zj4jqb Rz&َ $6pwv
&#hO{' Ld O/` S/2~yV!헙+pjqz"Bkxsf Q R8zBw8|r2Gnە?4 x~uaY˛dž m'OσN\7|<`Pm ,#Q"Chw g"rԛpwf7w\4D LD7 X:8# 4rWL, $Tug8q~t_-3n+Pޯ&mF*e*S{=a~GLx
> !1b/ 0 7JI8w`&.b78vuh;8~. և_ 뉍 ;.'نkLrVx sP?!T/12^L/dvjm[wT_z(Z)#]xh]1?\ʏΟ$>㈗
3țG2m? ?\/ 'asO*zvuh[wi9iop! 2 E֣:8TInn]FU76 R~mG/-{; 7!ob}eag6sד}Se<5S EBoU:qc궙0Epws y"%Q:prRmCq<}B>*rAro_qmk*r%'"nyy ؠ~5c¸GتufLR݆1D f_ Ump|q7n`bC-jco).Qӯ
Nwxv}-G* .7uUp rn;S:y)ȃ4pS^NG܁ܶ eBęPW\:Y=l2Gc.n^|_ M(oxcKNMrܛ0mڤI\*O >6~y)^?䯺_
>Yؙ'I>Xl&ŪCXgbbE>jڱalc|TO !1-fۓo -C/rD&`;0QB'`N}d]Y @ee~<ᅵ:P GT'2f 7fp~38~))^?9 &}H|Oʼ 썿8:Xvơw6&8E+KeT,WCٶCǥ> vkdq_e 8hFtձ^ݛ$qSr TMo8(y9XؼvpR$K; v 8*85^ 1Qm~uc ]O`k!7Ka wxsLN,l;xbInQg5,lqy5Ŵ=Gꐮxqo|}͛z=ah8^ S5)\O_Ն:}Xܵ@:k7E q2>9# GQSzpYew 4[7HP h% C֯?8N1Ԏtpm;ZESv6ax~F|$~gJ<
[hbod ů /0D \y8~F(?k4'ʃ7vѧD G- Ƿ >DAx
39l[hJ.aԍù6 h$Aj]߸;0ye9?u
S][DØ3 H D`8 g$R|47_ᾭ-PmumS Y ~w*dR~_`2<+ H*p =0j♚If]['otalQm.fuҷ` 存[ 3HdL^Fm!}jRCOyn+bK>"x~HՔ;iл#:h;Nv'I&IW.Khf"xF
.B :Eܧ_xyf.p܅Vw.o xܥ~M
/vt sER_|F X O6 oY?Oy/8~ hHjzA'_Ӟ 7
ؿ-R<&~S&B.01}T( 7!oR,Lc}^=8
.9HǽqTʅ.y>bi Om hHA|yT;~M1AuS>'~SMż}L\ GS3뙗u n
}X)b~9=x g$Rf8^^
쁞;=5 "`Oj_4_qL"pH㹎Ym.,8笺Ds2%p|'IsgpF"UYw8Nh)>vW!L5N!giwTµI*{`/,:V73k屗ڡr8zx|s國GKg& ql<>Lȃ_y^;^qe!o,8bU|ʛ%o@[~ef /CUZ'Xx8#
G1^
t3ez`z'TPȚ:Rⓣ\f|62%zoܼQ}/Wy;^ԧܣ.`pg)` ) 3NǚPKpupz.b>f].ИAq~!/~._]~ zLn r퀥3p_`5܅+s+0Ql;2 n͟;f4LUnBWtYj]pCD'cRe,{
UWnf @HCw#.tp2
|DDkVJ#rׅ)>)59w8&4~5fⷦ>X# ж_/Umߘ px XJ8#
wW#c
G. c`ʝ(
3E=*7â_vEQs7Bs Dy#*,_:h8 ,7H G_6q9MIprAݱh2 ΔsAu=$Á DpJ0 S̃o2 .FP3 T^W ^&#b5ATO'K2! H*pI(B[~'S;_ެ7 14.Gphm%@M MY.-wm+en̊ߖ W `yDpB H%; }5=L < 6Dfc8 1NpWfd8;
8#
H
IpF"U0 H3 @H 0p/ Lg"r F85 D p&"G=;ph= } p Dg E39 @# LD`8 g"r F8#iYaW4Zn<>k{5_.F,jOwoI},N]S7Z /LDp z0̙9R=QunuX.n+,uw: O!LtD q`UIy rڷ-O{gE}vs⧲`Xܵh7_)p/LD,*י2{/ywU\QO-(=&x. +Lz1 Qj''HE8_DzQZspV'>D_/R>~7-X?p&"Go8&P7@bPM(Ԏ_E~ z엙* o[ j+ v$IޯE>.o3'-.'h 3~'m&)KPzҺlμ?Iѐ+&(@1_V@]r6RR 4 L g"r#`
G4 Y*I SLhf'd>,℩JL 8&m'r?N!\]&ܷ cJzo(kbI&Xzi<Be${~bI`RW;S엟*Fum%^ģ L@4a=
\t%ΑS)LDz6 3x8)$LAr;5܄ ƯXؑ~A5SnOd\NqM
RCfѱ%B蝴XI؟Ͷ900 M3ƛP O`ބM+ˣv8 r=.`8Jfj
#ɘ71~BACOHx}87 fboML$6ϸrN&7 [ kK*'&F]oʏ~y} hph3 [chwꞁ'f;IQ]m& fg"rd8VW h` kl5 `p&"G͆@i %+< p5&L}3 殇6t Dp^M0DJ8 D(p80c LD 39j4 !3,`C 5@ڐ\/p 39J2 Qw| D!? D_ 39 @# LD`8 g"r F8# 4 p D p&"G0 h39 @# LD`8 g"r F8# 4 p D p&"G0 h39 q.L}[Rg}ԧ>?x#zMe/W7p
<3 n8nVu#N?^y~{߫^ۥ<Qgl&v}? /g=Y; :? gGԷm}kW#8˞gp~]*
ǟ'sk> \e jAG w\//fmRC'hIgM4v\Lesl8﨧? =L{ on, }H9> enA=OKҗ Iqz] /=W7n4 #g-[} 5Si?eγo8 =a3ՠ;t73A d֓ z$ O~Ҭ eo|Uz]>
}>w?ؼw7}}>jM73gD=7_ %˜gp| 61u_}ߵ%ݱL$Hk5srӁBqI|~33fLB!&W_};0 !g\uUf??L+Oyg #LB-O~b~_F'; xkzCt@]:S-!B_3J3'ĘW Q`^כv{:+4;faw]^cWU/yyw7~F-!ZʊE[vƻ̛ιI'yG7g\qf뮛,{6ov4ŦSpjn0 - ̫ƥѷ!T%hbLZb*t U6oXϸ/~(>n:K+_=ؑc?jg~Ѽl} ^Uono0uOkG?h l~ v1ۿ|"3! Ԃpm<2 ' >n{Kznc}ݑf'nm9O`6MGFy_ @y13meʖޗ0 2SzF^_4x,딶A5@TF)+mi)&G"FC$Tg&^ZpvW?o6((́ݕ ]{+36vxd1OqTjmbnV?SVvBJ]䙴8LP1X[LDm,o̩
虬9.4LMvWم>zD~]qscqݾ
WZ2/BTŢ-;MM`Il>~IاO4ei1_V=&Bh+t3>v8ji`:>1Bi(tL_!Q_Bh&MB!0 !0 !0 !0 !0 !0 !0 ! ` `: `"`: `"`: `"`: `"`: `" a:Mon9_Xm3?7oOT3' *Ɩ/l
0V4 p d {}L\ H^e&EҲ,k%yיK b~ENAsQ+mVna3SWcAqm3N]K:u֔cLj^SM bg:_V|qH}_BˏBU?? *HղF 'Zrwrnm3M9ɩL$Y,?A,n τLG
8]Q 6S Υj53
N 2`qe:)d13ՠ)iow w^g5cqˑX1 0Yo:~G`7R O 7< XhFB$6pg:{$n*g@i{E>GU6Hn٠ջX
|U)37PR~|vBPgqۮ[4ӡCѨ0y(j rE3d[{/G ꉝ7Kh?&%{L^ְedDzqW*MwLGrG`70g GʺkP\C:=1
,Gn, 3ls0 ڷC S}43tttVN2- f^IU2]>6uxVh
ӑe(J; (6ğLlx3- -F
? kV ghjz~me:S nh+K+mT%+8#f%W6zF#egSv
LXjd\Y~~~mq= ?CV 1 [fi< OeKi
6͐vgr6j4!oj{%Tٶ)f롞JJRNїC=kWӁm/[O#~q,f%g(/~d5B?u1Hg:j6Q!;aJ~g !+9hqV6U͍ik29KoN^k[u;g>v>/w+pigQoևw2"
d=yK%O +$9_ UYM\/qEGu}-?FVjj{-3T??B $
c43Lt\SNFltQL7;DVB}J4}7rpP7\ ezNgfme?RύD?&_^7 |8Qfii eQ˩S'5>[ZNIs{b
I'8a^LBcY%Oٯ6YHCv?>[Fx0`}Y 3.x"j?qf ے8 L
hf"V F3ZR^oG%6Nޛ djē=L~[ ^b+ L*tX3iZȴ
-jdM7 Y"{^ } linKYcfJ0~0-43t5/;*wOwqqoc*z㗲bUVY~-Vo9 Pz
˸yrۛ^ofWNZC-~va:ۃgPۧ;'^~4]q7%,BWr-mX/mA?/ەOk C3t;_";Jq;9; wJo˯S _ҳn+;.3)jdW-v]?^FO1]B#=m> Hm rӖ/Hm^U?[]2ůh@hf"V ~x;,ggNT۹ %WMP`,[;X0VuX_~Vr6Pwkodp5,Z!П~~w;Q'TP4_WY-[~J.Us6s~Wp ^xZ Ugj |vY;8* 5vC`Wm@J^[_~ tHY
>h=KCm
9hx*g(pGSWc4 Ro߫m3pLĪ;!;N ;hvQ";iUs(<-q z0PG͵z [(rY xs hw0N!֙ڮFzCٺ8
3JwԟA8a믗~ umqiS?P<LĪC!yX/|*獰snUL-I/O;\4C |]~ %"- ߮P4[ϯm[뽥]iވsv#wr? ?ROko`CcΠ gq+43LPS5 %DM?S } &f&bՉ( zc \"#*R~êF3G âXux ; D0 f&b5=ӡ_1kpzԟBi-XoqϬ7
$@|kqX7'^3]DL*~zm{"h>bE?6NIFI ǽ 0 imSd!L~,i# r(v}9BF3L H ߉ʧE\l[VLC(pf.2\-;ƃJkVYa1lպ#zt~s-v
u{V nO4?\Kzr2Ԧbc], j:yBk˶ h; вZAy4LG}{.;+;M6|Yg6O( 2 Sb?HVmf3$Wi[_ˏ/mԶ& VGA( >DW-Z? չ$kfo3O jmOCSfڷCaAr`ɣXug: azNNZ__5 ? Ckȗ]5 cfRM&n{3&i)kx@~/"O} ůcj_)?v;iL?h ݶ ˺̵u饕^MKcf{rvVj"f2 ϖP%C K Lj,g:jdH-C[&w1?xp;;heC:94ȇ(aP9m/00fʩS륤>BZL #F*Q<ۿiCmV#7wuYl^)DTg2t24 ^y |D0 qa:2vb:2M@.r #,3LGiL!Y f&b,LGWk
CaKA#0'0tC3 \0 ٴQ+Seu} j=^\!# L*tQ\+(8H:MG?ouF=Ho1 2# ƠTi 3 U~1 _tFe1~Y*)+K [ Lj3 v..D1)S%d @Whf"V5 rIvveLthg XMt C3t @4 D0 f&b h43ea:R_ áXa: LĊ+ f&b h43)ufa3|%'5+ B3t @4W L
hf"V F3t @4 DVXm͂(,z/4iG9g撗e+Dy3\ C3t,qh(1:2`eƢPo1-bO1A9z K LjYtM?@QnApRl,A-$gjo?MeeÿkmOYUN|YP2 )+^ f&bLGmiV 堚후 ' )'˟m_!U65~;kib HB3ZQWꃜ28\uAW4Z[lbn U9yv 7 ;y,Aӑ2@hV^g? D0 idP-0YC`[M;s0 j6[sYAbt Ljc
^dxOGꙎ2ؖ xV,_6FB3 Y>?xl6쿜p,˟f?x|} hf"V+tdK7%v? 75֍'(x/ {$xʲBn:y:c˟d?8gJ| f&b. :%>8N ̋' d43+LGx̵/|3 543+L DXa: L
hf"V+tW,DG,.7 KkLXO D0 m}˩;Xtd:Z
Y.H HhlCޡfg,J'?ٜ|E
hF"Ec1 {b-o"ep'\c G3)t\~f62W.R fSi r4#NMM7d⋋A6 =|,u]G ]LqgK!ľ_v -& !!7>IO2{oN;d2 rnhn:},7^veE
E3)tMo2'pB1k:BSGocLG[1tIm + H!g7wqGuE/z5
}C'>bo/K0|## {9kLL?Y2yCl0bZ G' XnhF"Ey سb*
1 yc 䩑c9<jw} wf뭷BC |^뮻qy睭yI
&f$R (4#"L Da:
H QhF"E B3)t @H ЌD0 f$R (4#"L Da:
H QhF"E B3)t @H ЌD0 f$R (4#"L Da:
H QhF"E B3)t @H ЌD;.b77~{]wլ[
@3)Zk - ! s1摏|dlH?" Hhɘkךh˿4V*r ЌDrˆxSZ q-)ӱ`ļ?b. HhI[o<Lq-s `hF"EKt+>H q-9qYg6뭷93T 7Hђ3 wuWu;,R `hF"E3k:e_7tE]d͜}O6C <#y0 1̈́鐳\r9S;ۛ_lf3/x +^
84ﾻ_d䑼̣ h3??o2 : `x4#np /|`
;l: }\z6 BȲR%eJRN;d딺
@ y>?ۗs }ի
G }yԣ ez[a fN=Tk:sOqOݏb:R JB3)t?6m]1~3;|;47c|m;Ϧ r6d
74 |e:?S[oο 9Qg= JB3)t|[߲yc Xk&/W&My:DِJ#AE//*MRcS҅u] ,w4#a=DǗ%͓<1K/5}C k֬;h=h!u`: C3)tzyE{+g3 噈}> "
QOӂS!igq@qM7嗟#. JD3)tz#pY=H1__m\:)>f8묳%fM7Ed:/7ͩ wy ?FR XhF"ECaGfwC.˿Kn\>pLYy<>+^i\"e\~ˈQ{A d: <2 +Djh1闃
V*HЦc_>.x
: d4#M0 |7yk* | f$R4= @3)tȍG yyK^b ܐ6;I? ,W4#M hYNg f$Rԉ{V[m,^uWmƞő t4#LGh曛|+R:vᢋ.*R @3)twujnko,3xol f$R4Q"g=ve=~+eo4/-# :HQt\{J_zFNKӼ1Sꖶ {fM6_ :w}im1 %k5 e l.{ Ÿ:.Bs!ؗ|I M `hiJ pE`_ocvK,+eHYR]!up
EN 7(M?kjEnڼKͩj8 ;_~^HrDޙ!IyG2ooKb@1 `44#6! ӡ!]k͝dɗ%~ wqV<#yo&^ 04#!1 t X>hF !t @HQi:.23wua: @E3)*M_n殿>t f$RT+t f$RTܪU0 ?[fMe:B! y܍7h'B!ƥ_zFe IENDB` graphviz-0.20.2/docs/_static/rank_same.svg 0000666 0000000 0000000 00000006137 14144623610 017176 0 ustar root root
graphviz-0.20.2/docs/_static/round-table.svg 0000666 0000000 0000000 00000004277 14144623610 017455 0 ustar root root
graphviz-0.20.2/docs/_static/splines.svg 0000666 0000000 0000000 00000002273 14226660050 016710 0 ustar root root
graphviz-0.20.2/docs/_static/structs.svg 0000666 0000000 0000000 00000010423 14144623610 016736 0 ustar root root
graphviz-0.20.2/docs/_static/structs_revisited.svg 0000666 0000000 0000000 00000007625 14144623610 021026 0 ustar root root
graphviz-0.20.2/docs/_static/traffic_lights.svg 0000666 0000000 0000000 00000023177 14144623610 020231 0 ustar root root
graphviz-0.20.2/docs/_static/unix.svg 0000666 0000000 0000000 00000070037 14144623610 016221 0 ustar root root
graphviz-0.20.2/docs/_static/wide-unflatten-stagger-2.svg 0000666 0000000 0000000 00000013335 14144623610 021753 0 ustar root root
graphviz-0.20.2/docs/_static/wide-unflatten-stagger-3.svg 0000666 0000000 0000000 00000013327 14144623610 021755 0 ustar root root
graphviz-0.20.2/docs/_static/wide.svg 0000666 0000000 0000000 00000013125 14144623610 016161 0 ustar root root
graphviz-0.20.2/docs/api.rst 0000666 0000000 0000000 00000211560 14575730462 014404 0 ustar root root API Reference
=============
.. autosummary::
:nosignatures:
graphviz.Graph
graphviz.Digraph
graphviz.Source
graphviz.escape
graphviz.nohtml
graphviz.ExecutableNotFound
graphviz.CalledProcessError
graphviz.RequiredArgumentError
graphviz.render
graphviz.pipe
graphviz.pipe_string
graphviz.unflatten
graphviz.view
graphviz.version
.. hint::
The two main classes :class:`.Graph` and :class:`.Digraph`
(creating **undirected** vs. **directed** graphs) have exactly the same API.
Their division reflects the fact that both graph syntaxes cannot be mixed.
Graph
-----
.. autoclass:: graphviz.Graph
:members:
directed,
name, comment,
filename, directory,
format, engine, encoding, renderer, formatter,
graph_attr, node_attr, edge_attr,
body,
strict,
__iter__,
source,
node, edge, edges, attr, subgraph,
filepath, save, render, view, pipe, unflatten,
_repr_mimebundle_,
clear, copy
Digraph
-------
.. autoclass:: graphviz.Digraph
:members:
directed,
name, comment,
filename, directory,
format, engine, encoding, renderer, formatter,
graph_attr, node_attr, edge_attr,
body,
strict,
__iter__,
source,
node, edge, edges, attr, subgraph,
filepath, save, render, view, pipe, unflatten,
_repr_mimebundle_,
clear, copy
Source
------
.. autoclass:: graphviz.Source
:members:
from_file,
filename, directory,
format, engine, encoding, renderer, formatter,
__iter__,
source,
filepath, save, render, view, pipe, unflatten,
_repr_mimebundle_,
copy
Quoting/escaping
----------------
.. autofunction:: graphviz.escape
.. autofunction:: graphviz.nohtml
Exceptions
----------
.. autoexception:: graphviz.ExecutableNotFound
.. autoexception:: graphviz.CalledProcessError
.. autoexception:: graphviz.RequiredArgumentError
.. autoexception:: graphviz.FileExistsError
Warnings
--------
.. autoexception:: graphviz.UnknownSuffixWarning
.. autoexception:: graphviz.FormatSuffixMismatchWarning
.. autoexception:: graphviz.DotSyntaxWarning
Low-level functions
-------------------
The functions in this section are provided to work directly
with existing files and strings instead of using the object-oriented
DOT_ creation methods documented above.
.. autofunction:: graphviz.render
.. autofunction:: graphviz.pipe
.. autofunction:: graphviz.pipe_string
.. autofunction:: graphviz.pipe_lines
.. autofunction:: graphviz.pipe_lines_string
.. autofunction:: graphviz.unflatten
.. autofunction:: graphviz.view
Constants
---------
Manually maintained allowlists for Graphviz_ **parameters**
(cf. `man dot `_, `outputs `_, and ``dot -T:`` output):
.. autodata:: graphviz.ENGINES
:annotation:
.. autodata:: graphviz.FORMATS
:annotation:
.. autodata:: graphviz.RENDERERS
:annotation:
.. autodata:: graphviz.FORMATTERS
:annotation:
Supported **IPython/Jupyter display formats**:
.. autodata:: graphviz.SUPPORTED_JUPYTER_FORMATS
:annotation:
Names of **upstream binaries**:
.. autodata:: graphviz.DOT_BINARY
:annotation:
.. autodata:: graphviz.UNFLATTEN_BINARY
:annotation:
Defaults
--------
Functions for setting **package-wide defaults** for ``engine`` and ``format``:
.. attention::
These functions are provided mainly to simplify testing
but may also be used by end-users for convenience in scripts.
They **should be avoided in library code**.
Prefer passing or setting ``engine`` and ``format`` explicitly
if you create a library that depends on this package.
.. autofunction:: graphviz.set_default_engine
.. autofunction:: graphviz.set_default_format
Function for setting the **package-wide default for IPython/Jupyter display format**:
.. attention::
This function is provided for end-users.
Prefer `IPython.display`_ functions in library code.
.. autofunction:: graphviz.set_jupyter_format
Other
-----
.. autofunction:: graphviz.version
.. include:: _links.rst
Online ``help()`` (internal)
----------------------------
Results of :func:`help` for :class:`graphviz.Graph`, :class:`graphviz.Digraph`,
and :class:`graphviz.Source` for reference.
.. attention::
The outputs in this section may contain (some) **internals** (implementation details).
They serve to record some current implementation details and their changes.
They mainly serve the development process (e.g. checking the MRO).
They might be outdated.
They **may change at any point** in time.
See above for the full (public) API.
First shalt thou take out the Holy Pin.
Then shalt thou count to three, no more, no less.
To **update** :func:`help` outputs below:
.. code:: bash
$ ./update-help.py
To **debug**: remove ``+SKIP`` flags below and check output(s):
.. code:: bash
$ ./run-tests.py docs --doctest-report none
Graph
"""""
Partially syntax-highlighted:
https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
.. doctest::
>>> import graphviz
>>> help(graphviz.Graph) # doctest: +NORMALIZE_WHITESPACE +SKIP
Help on class Graph in module graphviz.graphs:
class Graph(graphviz.dot.GraphSyntax, BaseGraph)
| Graph(name: Optional[str] = None,
comment: Optional[str] = None,
filename=None,
directory=None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8',
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None,
strict: bool = False, *,
renderer: Optional[str] = None,
formatter: Optional[str] = None) -> None
|
| Graph source code in the DOT language.
|
| Args:
| name: Graph name used in the source code.
| comment: Comment added to the first line of the source.
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).
| directory: (Sub)directory for source saving and rendering.
| format: Rendering output format (``'pdf'``, ``'png'``, ...).
| engine: Layout command used (``'dot'``, ``'neato'``, ...).
| renderer: Output renderer used (``'cairo'``, ``'gd'``, ...).
| formatter: Output formatter used (``'cairo'``, ``'gd'``, ...).
| encoding: Encoding for saving the source.
| graph_attr: Mapping of ``(attribute, value)`` pairs for the graph.
| node_attr: Mapping of ``(attribute, value)`` pairs set for all nodes.
| edge_attr: Mapping of ``(attribute, value)`` pairs set for all edges.
| body: Iterable of verbatim lines (including their final newline)
| to add to the graph ``body``.
| strict (bool): Rendering should merge multi-edges.
|
| Note:
| All parameters are `optional` and can be changed under their
| corresponding attribute name after instance creation.
|
| Method resolution order:
| Graph
| graphviz.dot.GraphSyntax
| BaseGraph
| graphviz.dot.Dot
| graphviz.quoting.Quote
| graphviz.rendering.Render
| graphviz.saving.Save
| graphviz.jupyter_integration.JupyterIntegration
| graphviz.piping.Pipe
| graphviz.unflattening.Unflatten
| graphviz.encoding.Encoding
| graphviz.base.Base
| graphviz.base.LineIterable
| graphviz.backend.mixins.Render
| graphviz.backend.mixins.Pipe
| graphviz.parameters.mixins.Parameters
| graphviz.parameters.engines.Engine
| graphviz.parameters.formats.Format
| graphviz.parameters.renderers.Renderer
| graphviz.parameters.formatters.Formatter
| graphviz.parameters.base.ParameterBase
| graphviz.copying.CopyBase
| graphviz.backend.mixins.View
| graphviz.backend.mixins.Unflatten
| builtins.object
|
| Readonly properties defined here:
|
| directed
| ``False``
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.dot.GraphSyntax:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from BaseGraph:
|
| __init__(self,
name: Optional[str] = None,
comment: Optional[str] = None,
filename=None,
directory=None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8',
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None,
strict: bool = False, *,
renderer: Optional[str] = None,
formatter: Optional[str] = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseGraph:
|
| source
| The generated DOT source code as string.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.dot.Dot:
|
| __iter__(self, subgraph: bool = False) -> Iterator[str]
| Yield the DOT source code line by line (as graph or subgraph).
|
| Yields: Line ending with a newline (``'\n'``).
|
| attr(self, kw: Optional[str] = None, _attributes=None, **attrs) -> None
| Add a general or graph/node/edge attribute statement.
|
| Args:
| kw: Attributes target
| (``None`` or ``'graph'``, ``'node'``, ``'edge'``).
| attrs: Attributes to be set (must be strings, may be empty).
|
| See the :ref:`usage examples in the User Guide `.
|
| clear(self, keep_attrs: bool = False) -> None
| Reset content to an empty body, clear graph/node/egde_attr mappings.
|
| Args:
| keep_attrs (bool): preserve graph/node/egde_attr mappings
|
| edge(self,
tail_name: str,
head_name: str,
label: Optional[str] = None,
_attributes=None, **attrs) -> None
| Create an edge between two nodes.
|
| Args:
| tail_name: Start node identifier
| (format: ``node[:port[:compass]]``).
| head_name: End node identifier
| (format: ``node[:port[:compass]]``).
| label: Caption to be displayed near the edge.
| attrs: Any additional edge attributes (must be strings).
|
| Note:
| The ``tail_name`` and ``head_name`` strings are separated
| by (optional) colon(s) into ``node`` name, ``port`` name,
| and ``compass`` (e.g. ``sw``).
| See :ref:`details in the User Guide `.
|
| Attention:
| When rendering ``label``, backslash-escapes
| and strings of the form ``<...>`` have a special meaning.
| See the sections :ref:`backslash-escapes` and
| :ref:`quoting-and-html-like-labels` in the user guide for details.
|
| edges(self, tail_head_iter) -> None
| Create a bunch of edges.
|
| Args:
| tail_head_iter: Iterable of ``(tail_name, head_name)`` pairs
| (format:``node[:port[:compass]]``).
|
|
| Note:
| The ``tail_name`` and ``head_name`` strings are separated
| by (optional) colon(s) into ``node`` name, ``port`` name,
| and ``compass`` (e.g. ``sw``).
| See :ref:`details in the User Guide `.
|
| node(self,
name: str,
label: Optional[str] = None,
_attributes=None, **attrs) -> None
| Create a node.
|
| Args:
| name: Unique identifier for the node inside the source.
| label: Caption to be displayed (defaults to the node ``name``).
| attrs: Any additional node attributes (must be strings).
|
| Attention:
| When rendering ``label``, backslash-escapes
| and strings of the form ``<...>`` have a special meaning.
| See the sections :ref:`backslash-escapes` and
| :ref:`quoting-and-html-like-labels` in the user guide for details.
|
| subgraph(self,
graph=None,
name: Optional[str] = None,
comment: Optional[str] = None,
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None)
| Add the current content of the given sole ``graph`` argument
| as subgraph or return a context manager
| returning a new graph instance
| created with the given (``name``, ``comment``, etc.) arguments
| whose content is added as subgraph
| when leaving the context manager's ``with``-block.
|
| Args:
| graph: An instance of the same kind
| (:class:`.Graph`, :class:`.Digraph`) as the current graph
| (sole argument in non-with-block use).
| name: Subgraph name (``with``-block use).
| comment: Subgraph comment (``with``-block use).
| graph_attr: Subgraph-level attribute-value mapping
| (``with``-block use).
| node_attr: Node-level attribute-value mapping
| (``with``-block use).
| edge_attr: Edge-level attribute-value mapping
| (``with``-block use).
| body: Verbatim lines to add to the subgraph ``body``
| (``with``-block use).
|
| See the :ref:`usage examples in the User Guide `.
|
| When used as a context manager, the returned new graph instance
| uses ``strict=None`` and the parent graph's values
| for ``directory``, ``format``, ``engine``, and ``encoding`` by default.
|
| Note:
| If the ``name`` of the subgraph begins with
| ``'cluster'`` (all lowercase)
| the layout engine will treat it as a special cluster subgraph.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.rendering.Render:
|
| render(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
view: bool = False,
cleanup: bool = False,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
engine: Optional[str] = None,
raise_if_result_exists: bool = False,
overwrite_source: bool = False) -> str
| Save the source to file and render with the Graphviz engine.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).s
| directory: (Sub)directory for source saving and rendering.
| view (bool): Open the rendered result
| with the default application.
| cleanup (bool): Delete the source file
| after successful rendering.
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process
| (implies ``view=True``, ineffective on Windows platform).
| outfile: Path for the rendered output file.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| raise_if_result_exists: Raise :exc:`graphviz.FileExistsError`
| if the result file exists.
| overwrite_source: Allow ``dot`` to write to the file it reads from.
| Incompatible with ``raise_if_result_exists``.
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| ValueError: If ``outfile`` is the same file as the source file
| unless ``overwite_source=True``.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
| RuntimeError: If viewer opening is requested but not supported.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> dot = graphviz.Graph(name='spam', directory='doctest-output')
| >>> dot.render(format='png').replace('\', '/')
| 'doctest-output/spam.gv.png'
| >>> dot.render(outfile='spam.svg').replace('\', '/')
| 'doctest-output/spam.svg'
|
| Note:
| The layout command is started from the directory of ``filepath``,
| so that references to external files
| (e.g. ``[image=images/camelot.png]``)
| can be given as paths relative to the DOT source file.
|
| view(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
cleanup: bool = False,
quiet: bool = False,
quiet_view: bool = False) -> str
| Save the source to file, open the rendered result in a viewer.
|
| Convenience short-cut for running ``.render(view=True)``.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).
| directory: (Sub)directory for source saving and rendering.
| cleanup (bool): Delete the source file after successful rendering.
| quiet (bool): Suppress ``stderr`` output from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process (ineffective on Windows).
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| graphviz.ExecutableNotFound: If the Graphviz executable
| is not found.
| graphviz.CalledProcessError: If the exit status is non-zero.
| RuntimeError: If opening the viewer is not supported.
|
| Short-cut method for calling :meth:`.render` with ``view=True``.
|
| Note:
| There is no option to wait for the application to close,
| and no way to retrieve the application's exit status.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.saving.Save:
|
| save(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None, *,
skip_existing: Optional[bool] = False) -> str
| Save the DOT source to file. Ensure the file ends with a newline.
|
| Args:
| filename: Filename for saving the source (defaults to ``name`` + ``'.gv'``)
| directory: (Sub)directory for source saving and rendering.
| skip_existing: Skip write if file exists (default: ``False``).
|
| Returns:
| The (possibly relative) path of the saved source file.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from graphviz.saving.Save:
|
| filepath
| The target path for saving the DOT source file.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from graphviz.saving.Save:
|
| directory = ''
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.piping.Pipe:
|
| pipe(self,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
| Return the source piped through the Graphviz layout command.
|
| Args:
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| encoding: Encoding for decoding the stdout.
|
| Returns:
| Bytes or if encoding is given decoded string
| (stdout of the layout command).
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> source = 'graph { spam }'
| >>> graphviz.Source(source, format='svg').pipe()[:14]
| b'>> graphviz.Source(source, format='svg').pipe(encoding='ascii')[:14]
| '>> graphviz.Source(source, format='svg').pipe(encoding='utf-8')[:14]
| ' 'graphviz.Source'
| Return a new :class:`.Source` instance with the source
| piped through the Graphviz *unflatten* preprocessor.
|
| Args:
| stagger: Stagger the minimum length
| of leaf edges between 1 and this small integer.
| fanout: Fanout nodes with indegree = outdegree = 1
| when staggering (requires ``stagger``).
| chain: Form disconnected nodes into chains
| of up to this many nodes.
|
| Returns:
| Prepocessed DOT source code (improved layout aspect ratio).
|
| Raises:
| graphviz.RequiredArgumentError: If ``fanout`` is given
| but ``stagger`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``unflatten`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the unflattening 'unflatten' subprocess is non-zero.
|
| See also:
| Upstream documentation:
| https://www.graphviz.org/pdf/unflatten.1.pdf
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.encoding.Encoding:
|
| encoding
| The encoding for the saved source file.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.base.Base:
|
| __str__(self) -> str
| The DOT source code as string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.engines.Engine:
|
| engine
| The layout engine used for rendering
| (``'dot'``, ``'neato'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formats.Format:
|
| format
| The output format used for rendering
| (``'pdf'``, ``'png'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.renderers.Renderer:
|
| renderer
| The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formatters.Formatter:
|
| formatter
| The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.copying.CopyBase:
|
| copy(self)
| Return a copied instance of the object.
|
| Returns:
| An independent copy of the current object.
Digraph
"""""""
Partially symntax-highlighed:
https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
.. doctest::
>>> import graphviz
>>> help(graphviz.Digraph) # doctest: +NORMALIZE_WHITESPACE +SKIP
Help on class Digraph in module graphviz.graphs:
class Digraph(graphviz.dot.DigraphSyntax, BaseGraph)
| Digraph(name: Optional[str] = None,
comment: Optional[str] = None,
filename=None,
directory=None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8',
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None,
strict: bool = False, *,
renderer: Optional[str] = None,
formatter: Optional[str] = None) -> None
|
| Directed graph source code in the DOT language.
|
| Args:
| name: Graph name used in the source code.
| comment: Comment added to the first line of the source.
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).
| directory: (Sub)directory for source saving and rendering.
| format: Rendering output format (``'pdf'``, ``'png'``, ...).
| engine: Layout command used (``'dot'``, ``'neato'``, ...).
| renderer: Output renderer used (``'cairo'``, ``'gd'``, ...).
| formatter: Output formatter used (``'cairo'``, ``'gd'``, ...).
| encoding: Encoding for saving the source.
| graph_attr: Mapping of ``(attribute, value)`` pairs for the graph.
| node_attr: Mapping of ``(attribute, value)`` pairs set for all nodes.
| edge_attr: Mapping of ``(attribute, value)`` pairs set for all edges.
| body: Iterable of verbatim lines (including their final newline)
| to add to the graph ``body``.
| strict (bool): Rendering should merge multi-edges.
|
| Note:
| All parameters are `optional` and can be changed under their
| corresponding attribute name after instance creation.
|
| Method resolution order:
| Digraph
| graphviz.dot.DigraphSyntax
| BaseGraph
| graphviz.dot.Dot
| graphviz.quoting.Quote
| graphviz.rendering.Render
| graphviz.saving.Save
| graphviz.jupyter_integration.JupyterIntegration
| graphviz.piping.Pipe
| graphviz.unflattening.Unflatten
| graphviz.encoding.Encoding
| graphviz.base.Base
| graphviz.base.LineIterable
| graphviz.backend.mixins.Render
| graphviz.backend.mixins.Pipe
| graphviz.parameters.mixins.Parameters
| graphviz.parameters.engines.Engine
| graphviz.parameters.formats.Format
| graphviz.parameters.renderers.Renderer
| graphviz.parameters.formatters.Formatter
| graphviz.parameters.base.ParameterBase
| graphviz.copying.CopyBase
| graphviz.backend.mixins.View
| graphviz.backend.mixins.Unflatten
| builtins.object
|
| Readonly properties defined here:
|
| directed
| ``True``
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.dot.DigraphSyntax:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from BaseGraph:
|
| __init__(self,
name: Optional[str] = None,
comment: Optional[str] = None,
filename=None,
directory=None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8',
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None,
strict: bool = False, *,
renderer: Optional[str] = None,
formatter: Optional[str] = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseGraph:
|
| source
| The generated DOT source code as string.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.dot.Dot:
|
| __iter__(self, subgraph: bool = False) -> Iterator[str]
| Yield the DOT source code line by line (as graph or subgraph).
|
| Yields: Line ending with a newline (``'\n'``).
|
| attr(self, kw: Optional[str] = None, _attributes=None, **attrs) -> None
| Add a general or graph/node/edge attribute statement.
|
| Args:
| kw: Attributes target
| (``None`` or ``'graph'``, ``'node'``, ``'edge'``).
| attrs: Attributes to be set (must be strings, may be empty).
|
| See the :ref:`usage examples in the User Guide `.
|
| clear(self, keep_attrs: bool = False) -> None
| Reset content to an empty body, clear graph/node/egde_attr mappings.
|
| Args:
| keep_attrs (bool): preserve graph/node/egde_attr mappings
|
| edge(self,
tail_name: str,
head_name: str,
label: Optional[str] = None,
_attributes=None, **attrs) -> None
| Create an edge between two nodes.
|
| Args:
| tail_name: Start node identifier
| (format: ``node[:port[:compass]]``).
| head_name: End node identifier
| (format: ``node[:port[:compass]]``).
| label: Caption to be displayed near the edge.
| attrs: Any additional edge attributes (must be strings).
|
| Note:
| The ``tail_name`` and ``head_name`` strings are separated
| by (optional) colon(s) into ``node`` name, ``port`` name,
| and ``compass`` (e.g. ``sw``).
| See :ref:`details in the User Guide `.
|
| Attention:
| When rendering ``label``, backslash-escapes
| and strings of the form ``<...>`` have a special meaning.
| See the sections :ref:`backslash-escapes` and
| :ref:`quoting-and-html-like-labels` in the user guide for details.
|
| edges(self, tail_head_iter) -> None
| Create a bunch of edges.
|
| Args:
| tail_head_iter: Iterable of ``(tail_name, head_name)`` pairs
| (format:``node[:port[:compass]]``).
|
|
| Note:
| The ``tail_name`` and ``head_name`` strings are separated
| by (optional) colon(s) into ``node`` name, ``port`` name,
| and ``compass`` (e.g. ``sw``).
| See :ref:`details in the User Guide `.
|
| node(self,
name: str,
label: Optional[str] = None,
_attributes=None, **attrs) -> None
| Create a node.
|
| Args:
| name: Unique identifier for the node inside the source.
| label: Caption to be displayed (defaults to the node ``name``).
| attrs: Any additional node attributes (must be strings).
|
| Attention:
| When rendering ``label``, backslash-escapes
| and strings of the form ``<...>`` have a special meaning.
| See the sections :ref:`backslash-escapes` and
| :ref:`quoting-and-html-like-labels` in the user guide for details.
|
| subgraph(self,
graph=None,
name: Optional[str] = None,
comment: Optional[str] = None,
graph_attr=None,
node_attr=None,
edge_attr=None,
body=None)
| Add the current content of the given sole ``graph`` argument
| as subgraph or return a context manager
| returning a new graph instance
| created with the given (``name``, ``comment``, etc.) arguments
| whose content is added as subgraph
| when leaving the context manager's ``with``-block.
|
| Args:
| graph: An instance of the same kind
| (:class:`.Graph`, :class:`.Digraph`) as the current graph
| (sole argument in non-with-block use).
| name: Subgraph name (``with``-block use).
| comment: Subgraph comment (``with``-block use).
| graph_attr: Subgraph-level attribute-value mapping
| (``with``-block use).
| node_attr: Node-level attribute-value mapping
| (``with``-block use).
| edge_attr: Edge-level attribute-value mapping
| (``with``-block use).
| body: Verbatim lines to add to the subgraph ``body``
| (``with``-block use).
|
| See the :ref:`usage examples in the User Guide `.
|
| When used as a context manager, the returned new graph instance
| uses ``strict=None`` and the parent graph's values
| for ``directory``, ``format``, ``engine``, and ``encoding`` by default.
|
| Note:
| If the ``name`` of the subgraph begins with
| ``'cluster'`` (all lowercase)
| the layout engine will treat it as a special cluster subgraph.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.rendering.Render:
|
| render(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
view: bool = False,
cleanup: bool = False,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
engine: Optional[str] = None,
raise_if_result_exists: bool = False,
overwrite_source: bool = False) -> str
| Save the source to file and render with the Graphviz engine.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).s
| directory: (Sub)directory for source saving and rendering.
| view (bool): Open the rendered result
| with the default application.
| cleanup (bool): Delete the source file
| after successful rendering.
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process
| (implies ``view=True``, ineffective on Windows platform).
| outfile: Path for the rendered output file.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| raise_if_result_exists: Raise :exc:`graphviz.FileExistsError`
| if the result file exists.
| overwrite_source: Allow ``dot`` to write to the file it reads from.
| Incompatible with ``raise_if_result_exists``.
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| ValueError: If ``outfile`` is the same file as the source file
| unless ``overwite_source=True``.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
| RuntimeError: If viewer opening is requested but not supported.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> dot = graphviz.Graph(name='spam', directory='doctest-output')
| >>> dot.render(format='png').replace('\', '/')
| 'doctest-output/spam.gv.png'
| >>> dot.render(outfile='spam.svg').replace('\', '/')
| 'doctest-output/spam.svg'
|
| Note:
| The layout command is started from the directory of ``filepath``,
| so that references to external files
| (e.g. ``[image=images/camelot.png]``)
| can be given as paths relative to the DOT source file.
|
| view(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
cleanup: bool = False,
quiet: bool = False,
quiet_view: bool = False) -> str
| Save the source to file, open the rendered result in a viewer.
|
| Convenience short-cut for running ``.render(view=True)``.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).
| directory: (Sub)directory for source saving and rendering.
| cleanup (bool): Delete the source file after successful rendering.
| quiet (bool): Suppress ``stderr`` output from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process (ineffective on Windows).
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| graphviz.ExecutableNotFound: If the Graphviz executable
| is not found.
| graphviz.CalledProcessError: If the exit status is non-zero.
| RuntimeError: If opening the viewer is not supported.
|
| Short-cut method for calling :meth:`.render` with ``view=True``.
|
| Note:
| There is no option to wait for the application to close,
| and no way to retrieve the application's exit status.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.saving.Save:
|
| save(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None, *,
skip_existing: Optional[bool] = False) -> str
| Save the DOT source to file. Ensure the file ends with a newline.
|
| Args:
| filename: Filename for saving the source (defaults to ``name`` + ``'.gv'``)
| directory: (Sub)directory for source saving and rendering.
| skip_existing: Skip write if file exists (default: ``False``).
|
| Returns:
| The (possibly relative) path of the saved source file.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from graphviz.saving.Save:
|
| filepath
| The target path for saving the DOT source file.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from graphviz.saving.Save:
|
| directory = ''
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.piping.Pipe:
|
| pipe(self,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
| Return the source piped through the Graphviz layout command.
|
| Args:
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| encoding: Encoding for decoding the stdout.
|
| Returns:
| Bytes or if encoding is given decoded string
| (stdout of the layout command).
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> source = 'graph { spam }'
| >>> graphviz.Source(source, format='svg').pipe()[:14]
| b'>> graphviz.Source(source, format='svg').pipe(encoding='ascii')[:14]
| '>> graphviz.Source(source, format='svg').pipe(encoding='utf-8')[:14]
| ' 'graphviz.Source'
| Return a new :class:`.Source` instance with the source
| piped through the Graphviz *unflatten* preprocessor.
|
| Args:
| stagger: Stagger the minimum length
| of leaf edges between 1 and this small integer.
| fanout: Fanout nodes with indegree = outdegree = 1
| when staggering (requires ``stagger``).
| chain: Form disconnected nodes into chains
| of up to this many nodes.
|
| Returns:
| Prepocessed DOT source code (improved layout aspect ratio).
|
| Raises:
| graphviz.RequiredArgumentError: If ``fanout`` is given
| but ``stagger`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``unflatten`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the unflattening 'unflatten' subprocess is non-zero.
|
| See also:
| Upstream documentation:
| https://www.graphviz.org/pdf/unflatten.1.pdf
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.encoding.Encoding:
|
| encoding
| The encoding for the saved source file.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.base.Base:
|
| __str__(self) -> str
| The DOT source code as string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.engines.Engine:
|
| engine
| The layout engine used for rendering
| (``'dot'``, ``'neato'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formats.Format:
|
| format
| The output format used for rendering
| (``'pdf'``, ``'png'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.renderers.Renderer:
|
| renderer
| The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formatters.Formatter:
|
| formatter
| The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.copying.CopyBase:
|
| copy(self)
| Return a copied instance of the object.
|
| Returns:
| An independent copy of the current object.
Source
""""""
Partially syntax-highlighted:
https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
.. doctest::
>>> import graphviz
>>> help(graphviz.Source) # doctest: +NORMALIZE_WHITESPACE +SKIP
Help on class Source in module graphviz.sources:
class Source(graphviz.rendering.Render,
graphviz.saving.Save,
graphviz.jupyter_integration.JupyterIntegration,
graphviz.piping.Pipe,
graphviz.unflattening.Unflatten)
| Source(source: str,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8', *,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
loaded_from_path: Optional[os.PathLike] = None) -> None
|
| Verbatim DOT source code string to be rendered by Graphviz.
|
| Args:
| source: The verbatim DOT source code string.
| filename: Filename for saving the source (defaults to ``'Source.gv'``).
| directory: (Sub)directory for source saving and rendering.
| format: Rendering output format (``'pdf'``, ``'png'``, ...).
| engine: Layout engine used (``'dot'``, ``'neato'``, ...).
| encoding: Encoding for saving the source.
|
| Note:
| All parameters except ``source`` are optional. All of them
| can be changed under their corresponding attribute name
| after instance creation.
|
| Method resolution order:
| Source
| graphviz.rendering.Render
| graphviz.saving.Save
| graphviz.jupyter_integration.JupyterIntegration
| graphviz.piping.Pipe
| graphviz.unflattening.Unflatten
| graphviz.encoding.Encoding
| graphviz.base.Base
| graphviz.base.LineIterable
| graphviz.backend.mixins.Render
| graphviz.backend.mixins.Pipe
| graphviz.parameters.mixins.Parameters
| graphviz.parameters.engines.Engine
| graphviz.parameters.formats.Format
| graphviz.parameters.renderers.Renderer
| graphviz.parameters.formatters.Formatter
| graphviz.parameters.base.ParameterBase
| graphviz.copying.CopyBase
| graphviz.backend.mixins.View
| graphviz.backend.mixins.Unflatten
| builtins.object
|
| Methods defined here:
|
| __init__(self,
source: str,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8', *,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
loaded_from_path: Optional[os.PathLike] = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> Iterator[str]
| Yield the DOT source code read from file line by line.
|
| Yields: Line ending with a newline (``'\n'``).
|
| save(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None, *,
skip_existing: Optional[bool] = None) -> str
| Save the DOT source to file. Ensure the file ends with a newline.
|
| Args:
| filename: Filename for saving the source (defaults to ``name`` + ``'.gv'``)
| directory: (Sub)directory for source saving and rendering.
| skip_existing: Skip write if file exists (default: ``None``).
| By default skips if instance was loaded from the target path:
| ``.from_file(self.filepath)``.
|
| Returns:
| The (possibly relative) path of the saved source file.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_file(filename: Union[os.PathLike, str],
directory: Union[os.PathLike, str, NoneType] = None,
format: Optional[str] = None,
engine: Optional[str] = None,
encoding: Optional[str] = 'utf-8',
renderer: Optional[str] = None,
formatter: Optional[str] = None) -> 'Source' from builtins.type
| Return an instance with the source string read from the given file.
|
| Args:
| filename: Filename for loading/saving the source.
| directory: (Sub)directory for source loading/saving and rendering.
| format: Rendering output format (``'pdf'``, ``'png'``, ...).
| engine: Layout command used (``'dot'``, ``'neato'``, ...).
| encoding: Encoding for loading/saving the source.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| source
| The DOT source code as string.
|
| Normalizes so that the string always ends in a final newline.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'_loaded_from_path': typing.Optional[os.PathLike], ...
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.rendering.Render:
|
| render(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
view: bool = False,
cleanup: bool = False,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
engine: Optional[str] = None,
raise_if_result_exists: bool = False,
overwrite_source: bool = False) -> str
| Save the source to file and render with the Graphviz engine.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).s
| directory: (Sub)directory for source saving and rendering.
| view (bool): Open the rendered result
| with the default application.
| cleanup (bool): Delete the source file
| after successful rendering.
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process
| (implies ``view=True``, ineffective on Windows platform).
| outfile: Path for the rendered output file.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| raise_if_result_exists: Raise :exc:`graphviz.FileExistsError`
| if the result file exists.
| overwrite_source: Allow ``dot`` to write to the file it reads from.
| Incompatible with ``raise_if_result_exists``.
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| ValueError: If ``outfile`` is the same file as the source file
| unless ``overwite_source=True``.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
| RuntimeError: If viewer opening is requested but not supported.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> dot = graphviz.Graph(name='spam', directory='doctest-output')
| >>> dot.render(format='png').replace('\', '/')
| 'doctest-output/spam.gv.png'
| >>> dot.render(outfile='spam.svg').replace('\', '/')
| 'doctest-output/spam.svg'
|
| Note:
| The layout command is started from the directory of ``filepath``,
| so that references to external files
| (e.g. ``[image=images/camelot.png]``)
| can be given as paths relative to the DOT source file.
|
| view(self,
filename: Union[os.PathLike, str, NoneType] = None,
directory: Union[os.PathLike, str, NoneType] = None,
cleanup: bool = False,
quiet: bool = False,
quiet_view: bool = False) -> str
| Save the source to file, open the rendered result in a viewer.
|
| Convenience short-cut for running ``.render(view=True)``.
|
| Args:
| filename: Filename for saving the source
| (defaults to ``name`` + ``'.gv'``).
| directory: (Sub)directory for source saving and rendering.
| cleanup (bool): Delete the source file after successful rendering.
| quiet (bool): Suppress ``stderr`` output from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
| from the viewer process (ineffective on Windows).
|
| Returns:
| The (possibly relative) path of the rendered file.
|
| Raises:
| graphviz.ExecutableNotFound: If the Graphviz executable
| is not found.
| graphviz.CalledProcessError: If the exit status is non-zero.
| RuntimeError: If opening the viewer is not supported.
|
| Short-cut method for calling :meth:`.render` with ``view=True``.
|
| Note:
| There is no option to wait for the application to close,
| and no way to retrieve the application's exit status.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from graphviz.saving.Save:
|
| filepath
| The target path for saving the DOT source file.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from graphviz.saving.Save:
|
| directory = ''
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.piping.Pipe:
|
| pipe(self,
format: Optional[str] = None,
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
| Return the source piped through the Graphviz layout command.
|
| Args:
| format: The output format used for rendering
| (``'pdf'``, ``'png'``, etc.).
| renderer: The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
| (``'dot'``, ``'neato'``, ...).
| encoding: Encoding for decoding the stdout.
|
| Returns:
| Bytes or if encoding is given decoded string
| (stdout of the layout command).
|
| Raises:
| ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
| are unknown.
| graphviz.RequiredArgumentError: If ``formatter`` is given
| but ``renderer`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the rendering ``dot`` subprocess is non-zero.
|
| Example:
| >>> doctest_mark_exe()
| >>> import graphviz
| >>> source = 'graph { spam }'
| >>> graphviz.Source(source, format='svg').pipe()[:14]
| b'>> graphviz.Source(source, format='svg').pipe(encoding='ascii')[:14]
| '>> graphviz.Source(source, format='svg').pipe(encoding='utf-8')[:14]
| ' 'graphviz.Source'
| Return a new :class:`.Source` instance with the source
| piped through the Graphviz *unflatten* preprocessor.
|
| Args:
| stagger: Stagger the minimum length
| of leaf edges between 1 and this small integer.
| fanout: Fanout nodes with indegree = outdegree = 1
| when staggering (requires ``stagger``).
| chain: Form disconnected nodes into chains
| of up to this many nodes.
|
| Returns:
| Prepocessed DOT source code (improved layout aspect ratio).
|
| Raises:
| graphviz.RequiredArgumentError: If ``fanout`` is given
| but ``stagger`` is None.
| graphviz.ExecutableNotFound: If the Graphviz ``unflatten`` executable
| is not found.
| graphviz.CalledProcessError: If the returncode (exit status)
| of the unflattening 'unflatten' subprocess is non-zero.
|
| See also:
| Upstream documentation:
| https://www.graphviz.org/pdf/unflatten.1.pdf
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.encoding.Encoding:
|
| encoding
| The encoding for the saved source file.
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.base.Base:
|
| __str__(self) -> str
| The DOT source code as string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.base.LineIterable:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.engines.Engine:
|
| engine
| The layout engine used for rendering
| (``'dot'``, ``'neato'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formats.Format:
|
| format
| The output format used for rendering
| (``'pdf'``, ``'png'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.renderers.Renderer:
|
| renderer
| The output renderer used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from graphviz.parameters.formatters.Formatter:
|
| formatter
| The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
|
| ----------------------------------------------------------------------
| Methods inherited from graphviz.copying.CopyBase:
|
| copy(self)
| Return a copied instance of the object.
|
| Returns:
| An independent copy of the current object.
graphviz-0.20.2/docs/attributes.rst 0000666 0000000 0000000 00000003023 14550602024 015773 0 ustar root root Attributes
----------
To directly add DOT_ ``att_stmt`` attribute statements,
call the :meth:`~.Graph.attr` method
of the :class:`.Graph` or :class:`.Digraph` instance
with the wanted target as first argument and the attributes as keyword args.
.. hint::
Attribute statements affect all **later** graphs, nodes, or edges
within the same (sub-)graph.
.. doctest::
>>> import graphviz
>>> ni = graphviz.Graph('ni') # doctest: +NO_EXE
>>> ni.attr('node', shape='rarrow')
>>> ni.node('1', 'Ni!')
>>> ni.node('2', 'Ni!')
>>> ni.node('3', 'Ni!', shape='egg')
>>> ni.attr('node', shape='star')
>>> ni.node('4', 'Ni!')
>>> ni.node('5', 'Ni!')
If you omit the first :meth:`~.Graph.attr` argument, the method can be used
to set arbitrary attributes as key-value pairs targeting
the current (sub-)graph
(e.g. for ``rankdir``, ``label``,
or setting ``rank='same'`` within a subgraph context,
:ref:`example `):
.. doctest::
>>> ni.attr(rankdir='LR') # doctest: +NO_EXE
>>> ni.edges(['12', '23', '34', '45'])
>>> print(ni.source) # doctest: +NORMALIZE_WHITESPACE
graph ni {
node [shape=rarrow]
1 [label="Ni!"]
2 [label="Ni!"]
3 [label="Ni!" shape=egg]
node [shape=star]
4 [label="Ni!"]
5 [label="Ni!"]
rankdir=LR
1 -- 2
2 -- 3
3 -- 4
4 -- 5
}
.. image:: _static/ni.svg
:align: center
.. include:: _links.rst
graphviz-0.20.2/docs/basic_usage.rst 0000666 0000000 0000000 00000006634 14550602024 016065 0 ustar root root Basic usage
-----------
The :doc:`graphviz ` package provides two main classes: :class:`graphviz.Graph`
and :class:`graphviz.Digraph`. They create graph descriptions in the DOT_ language for
undirected and directed graphs respectively.
They have the same :doc:`API `.
.. hint::
:class:`.Graph` and :class:`.Digraph` produce different DOT syntax
and have different values for :attr:`~.Graph.directed`.
Create a graph by instantiating a new :class:`.Graph` or
:class:`.Digraph` object:
.. doctest::
>>> import graphviz
>>> dot = graphviz.Digraph('round-table', comment='The Round Table') # doctest: +NO_EXE
>>> dot # doctest: +ELLIPSIS
Their constructors allow to set the graph's :attr:`~.Graph.name` identifier,
the :attr:`~.Graph.filename` for the DOT source and the rendered graph,
an optional :attr:`~.Graph.comment` for the first source code line, etc.
Add nodes and edges to the graph object using its :meth:`~.Graph.node`
and :meth:`~.Graph.edge` or :meth:`~.Graph.edges` methods:
.. doctest::
>>> dot.node('A', 'King Arthur') # doctest: +NO_EXE
>>> dot.node('B', 'Sir Bedevere the Wise')
>>> dot.node('L', 'Sir Lancelot the Brave')
>>> dot.edges(['AB', 'AL'])
>>> dot.edge('B', 'L', constraint='false')
The :meth:`~.Graph.node` method takes a ``name`` identifier as first argument
and an optional ``label``.
The :meth:`~.Graph.edge` method takes the names of start node and end node,
while :meth:`~.Graph.edges` takes an iterable of name pairs.
Keyword arguments are turned into (node and edge) attributes
(see extensive `Graphviz docs on available attributes `_).
Check the generated DOT source code:
.. doctest::
>>> print(dot.source) # doctest: +NORMALIZE_WHITESPACE +NO_EXE
// The Round Table
digraph "round-table" {
A [label="King Arthur"]
B [label="Sir Bedevere the Wise"]
L [label="Sir Lancelot the Brave"]
A -> B
A -> L
B -> L [constraint=false]
}
Use the :meth:`~.Graph.render` method to save the DOT source code
and render it with the default ``dot`` `layout engine `_
(see :ref:`below ` for using other layout engines).
.. attention::
Skip/ignore any ``doctest_mark_exe()`` lines in documentation code examples.
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> dot.render(directory='doctest-output').replace('\\', '/')
'doctest-output/round-table.gv.pdf'
Passing ``view=True`` will automatically open the resulting (PDF, SVG, PNG,
etc.) file with your system's default viewer application
for the rendered file type.
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> dot.render(directory='doctest-output', view=True) # doctest: +SKIP
'doctest-output/round-table.gv.pdf'
.. image:: _static/round-table.svg
:align: center
.. include:: _links.rst
.. attention::
Backslash-escapes and strings of the form ``<...>``
have a special meaning in the DOT_ language
and are currently passed on as is by this library.
If you need to render arbitrary strings literally (e.g. from user input),
consider wrapping them with the :func:`graphviz.escape` function first.
See the sections on :ref:`backslash-escapes`
and :ref:`quoting-and-html-like-labels` below for details.
graphviz-0.20.2/docs/changelog.rst 0000666 0000000 0000000 00000000057 14135133776 015554 0 ustar root root .. _changelog:
.. include:: ../CHANGES.rst
graphviz-0.20.2/docs/conf.py 0000666 0000000 0000000 00000005722 14575735742 014407 0 ustar root root # Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath(os.pardir))
import graphviz
# -- Project information -----------------------------------------------------
project = 'graphviz'
copyright = '2013-2024, Sebastian Bank'
author = 'Sebastian Bank'
# The full version, including alpha/beta/rc tags
release = '0.20.2'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints', # https://github.com/agronholm/sphinx-autodoc-typehints/issues/15
'sphinx.ext.viewcode',
]
doctest_global_setup = '''\
import doctest as _doctest
_doctest.register_optionflag('NO_EXE')
def doctest_mark_exe(**kwargs):
pass
'''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'py': ('https://docs.python.org/3', None),
}
graphviz-0.20.2/docs/custom_dot.rst 0000666 0000000 0000000 00000002147 14151056254 016000 0 ustar root root Custom DOT statements
---------------------
To add arbitrary statements to the created DOT_ source, you can use the
:attr:`~.Graph.body` attribute of :class:`.Graph` and :class:`.Digraph` objects.
It holds the verbatim :class:`list` of (:class:`str`) lines to be written to the source file
(including their final newline).
Use its ``append()`` or ``extend()`` method:
.. doctest::
>>> import graphviz
>>> rt = graphviz.Digraph(comment='The Round Table') # doctest: +NO_EXE
>>> rt.body.append('\t"King Arthur" -> {\n\t\t"Sir Bedevere", "Sir Lancelot"\n\t}\n')
>>> rt.edge('Sir Bedevere', 'Sir Lancelot', constraint='false')
>>> print(rt.source) # doctest: +NORMALIZE_WHITESPACE
// The Round Table
digraph {
"King Arthur" -> {
"Sir Bedevere", "Sir Lancelot"
}
"Sir Bedevere" -> "Sir Lancelot" [constraint=false]
}
.. attention::
Note that you might need to correctly quote/escape identifiers
and strings containing whitespace or other special characters
when using this method.
.. include:: _links.rst
graphviz-0.20.2/docs/development.rst 0000666 0000000 0000000 00000016174 14550602024 016142 0 ustar root root .. _development:
Development
===========
|PyPI version| |License| |Supported Python| |Wheel| |Downloads|
- GitHub: https://github.com/xflr6/graphviz
- Changelog: https://graphviz.readthedocs.io/en/latest/changelog.html
- Issue Tracker: https://github.com/xflr6/graphviz/issues
Installation
------------
|Binder-HEAD|
Development environment **binder** : https://mybinder.org/v2/gh/xflr6/graphviz/HEAD
Local installation
^^^^^^^^^^^^^^^^^^
Install in a venv_ in development mode (includes all ``extras_require``):
.. code:: bash
$ git clone https://github.com/xflr6/graphviz.git
$ cd graphviz
$ python -m venv .venv
$ source .venv/bin/activate
$ python -m pip install -r requirements.txt
.. admonition:: Platform: Windows
``.venv\Script\activate.bat``
to replace ``source .venv/bin/activate``
.. hint::
alternatively: ``pip install -e .[dev,test,docs]``
(same as ``pip install -r requirements.txt``)
Tests
-----
|Build| |Codecov|
- GitHub Actions
`Build workflow `_
(Python 3.8 to 3.11, experimental: PyPy 3.8 to 3.9)
- Codecov
`test coverage `_
(`main branch `_)
**Run the tests** (in the current environment):
.. code:: bash
$ python run-tests.py
Run **only tests** that are expected to ``PASS`` or ``XFAIL``
**without Graphviz** executables:
.. code:: bash
$ python run-tests.py --skip-exe
**Run the tests** with tox_ (**installing** into a virtualenv_ or many of them):
.. code:: bash
$ python -m tox
**Run the static type checker**
(pytype_,
supported `platforms `_
and `Python versions `_):
.. code:: bash
$ pip install pytype
$ pytype
**Run the code linter** (flake8_):
.. code:: bash
$ python lint-code.py
Documentation
-------------
|Readthedocs-stable| |Readthedocs-latest|
- Read the Docs Project Home: https://readthedocs.org/projects/graphviz/
- stable: https://graphviz.readthedocs.io
- latest: https://graphviz.readthedocs.io/en/latest/
**Build the documentation** with sphinx_ and sphinx-rtd-theme_ (in the current environment):
.. code:: bash
$ python build-docs.py
Overview
--------
Use ``help()`` in the REPL to shows/structure methods and attributes in dependency order:
- Introduction: https://graphviz.readthedocs.io/en/latest/api.html#online-help-internal
- ``Graph``: https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
- ``Digraph``: https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
- ``Source``: https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
.. tip::
In the above, cooperative multiple inheritance classes reveal their
(diamond) MRO structure and methods are shown in **method resolution order** (MRO),
which should be an extension of their dependency relation...
TLDR; you might find this presentation helps to follow the implementation.
.. include:: _links.rst
.. |PyPI version| image:: https://img.shields.io/pypi/v/graphviz.svg
:target: https://pypi.org/project/graphviz/
:alt: Latest PyPI Version
.. |License| image:: https://img.shields.io/pypi/l/graphviz.svg
:target: https://github.com/xflr6/graphviz/blob/master/LICENSE.txt
:alt: License
.. |Supported Python| image:: https://img.shields.io/pypi/pyversions/graphviz.svg
:target: https://pypi.org/project/graphviz/
:alt: Supported Python Versions
.. |Wheel| image:: https://img.shields.io/pypi/wheel/graphviz.svg
:target: https://pypi.org/project/graphviz/
:alt: Wheel format
.. |Downloads| image:: https://img.shields.io/pypi/dm/graphviz.svg
:target: https://pypi.org/project/graphviz/#files
:alt: Monthly downloads
.. |Build| image:: https://github.com/xflr6/graphviz/actions/workflows/build.yaml/badge.svg?branch=master
:target: https://github.com/xflr6/graphviz/actions/workflows/build.yaml?query=branch%3Amaster
:alt: Build
.. |Codecov| image:: https://codecov.io/gh/xflr6/graphviz/branch/master/graph/badge.svg
:target: https://codecov.io/gh/xflr6/graphviz
:alt: Codecov
.. |Readthedocs-stable| image:: https://readthedocs.org/projects/graphviz/badge/?version=stable
:target: https://graphviz.readthedocs.io/en/stable/
:alt: Readthedocs (stable)
.. |Readthedocs-latest| image:: https://readthedocs.org/projects/graphviz/badge/?version=latest
:target: https://graphviz.readthedocs.io/en/latest/
:alt: Readthedocs (latest)
.. |Binder-HEAD| image:: https://img.shields.io/badge/launch-binder%20(HEAD)-E66581.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
:target: https://mybinder.org/v2/gh/xflr6/graphviz/HEAD
:alt: Binder (HEAD)
graphviz-0.20.2/docs/engines.rst 0000666 0000000 0000000 00000001000 14151056254 015233 0 ustar root root Engines
-------
To use a different `layout engine `_ than the default ``dot``
when rendering your graph, you can use the ``engine`` argument
on the constructor of :class:`.Graph` or :class:`.Digraph`.
.. doctest::
>>> import graphviz # doctest: +NO_EXE
>>> g = graphviz.Graph(engine='neato')
You can also change the :attr:`~.Graph.engine` attribute
on an existing instance:
.. doctest::
>>> g.engine = 'circo' # doctest: +NO_EXE
.. include:: _links.rst
graphviz-0.20.2/docs/escapes.rst 0000666 0000000 0000000 00000005356 14550602024 015243 0 ustar root root Backslash escapes
-----------------
The Graphviz_ layout `engines `_ support a number of
`escape sequences `_ such as ``\n``, ``\l``, ``\r``
(for placement of multi-line labels:
*centered*, *left*-justified, *right*-justified)
and ``\N``, ``\G``, ``\L``
(expanded to the current *node* name, *graph* name, object *label*).
To be able to use them from this library (e.g., for labels),
backslashes in strings are (mostly) passed on **as is**.
.. attention::
This means that **literal** backslashes need to be **escaped** (doubled) by the user.
As the backslash is also special in Python :class:`string ` literals
a **second** level of doubling is needed.
E.g. ``label='\\\\'`` for a label that is rendered as single literal backlash: ``\``.
.. tip::
Doubling of backslashes can be avoided by using `raw string literals`_
(``r'...'``) instead.
This is similar to the solution proposed for the stdlib :mod:`re` module.
See also https://en.wikipedia.org/wiki/Leaning_toothpick_syndrome.
.. doctest::
>>> import graphviz # doctest: +NO_EXE
>>> e = graphviz.Digraph('escapes')
>>> e.node('backslash', label=r'\\')
>>> e.node('multi_line', label=r'centered\nleft\lright\r')
>>> print(e.source) # doctest: +NORMALIZE_WHITESPACE
digraph escapes {
backslash [label="\\"]
multi_line [label="centered\nleft\lright\r"]
}
.. image:: _static/escapes.svg
:align: center
To disable any special character meaning in a string
(e.g. from user input to be rendered literally),
use the :func:`graphviz.escape` function
(similar to the :func:`re.escape` function):
.. doctest::
>>> bs = graphviz.Digraph('literal_backslash') # doctest: +NO_EXE
>>> bs.node(graphviz.escape('\\'))
>>> print(bs.source) # doctest: +NORMALIZE_WHITESPACE
digraph literal_backslash {
"\\"
}
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> bs.render(format='svg', directory='doctest-output').replace('\\', '/')
'doctest-output/literal_backslash.gv.svg'
.. image:: _static/literal_backslash.svg
:align: center
.. admonition:: Historical note
To prevent breaking the internal quoting mechanism, the special meaning
of ``\"`` as a backslash-escaped quote has been disabled
since version ``0.14`` of this library.
E.g. both ``label='"'`` and ``label='\\"'``
now produce the same DOT source ``[label="\""]``
(a label that renders as a literal quote).
See also `examples/graphviz-escapes.ipynb `_
(`nbviewer `_).
.. include:: _links.rst
graphviz-0.20.2/docs/examples.rst 0000666 0000000 0000000 00000005236 14550602024 015433 0 ustar root root .. _examples:
Examples
========
.. tip::
The following code examples are included in the ``examples/`` directory of the
`source repository/distribution `_.
.. note::
Most of them recreate examples from the
`graphviz.org gallery`_ or the `graphviz.org documentation`_.
.. include:: _links.rst
hello.py
--------
.. literalinclude:: ../examples/hello.py
:lines: 3-
.. image:: _static/hello.svg
:align: center
process.py
----------
.. literalinclude:: ../examples/process.py
:lines: 3-
.. image:: _static/process.svg
:align: center
fsm.py
------
.. literalinclude:: ../examples/fsm.py
:lines: 3-
.. image:: _static/fsm.svg
:align: center
.. _cluster.py:
cluster.py
----------
.. literalinclude:: ../examples/cluster.py
:lines: 3-
.. image:: _static/cluster.svg
:align: center
er.py
-----
.. literalinclude:: ../examples/er.py
:lines: 3-
.. image:: _static/er.svg
:align: center
unix.py
-------
.. literalinclude:: ../examples/unix.py
:lines: 3-
.. image:: _static/unix.svg
:align: center
structs.py
----------
.. literalinclude:: ../examples/structs.py
:lines: 3-
.. image:: _static/structs.svg
:align: center
structs_revisited.py
--------------------
.. literalinclude:: ../examples/structs_revisited.py
:lines: 3-
.. image:: _static/structs_revisited.svg
:align: center
.. _btree.py:
btree.py
--------
.. literalinclude:: ../examples/btree.py
:lines: 3-
.. image:: _static/btree.svg
:align: center
traffic_lights.py
-----------------
.. literalinclude:: ../examples/traffic_lights.py
:lines: 3-
.. image:: _static/traffic_lights.svg
:align: center
fdpclust.py
-----------
.. literalinclude:: ../examples/fdpclust.py
:lines: 3-
.. image:: _static/fdpclust.svg
:align: center
cluster_edge.py
---------------
.. literalinclude:: ../examples/cluster_edge.py
:lines: 3-
.. image:: _static/cluster_edge.svg
:align: center
g_c_n.py
--------
.. literalinclude:: ../examples/g_c_n.py
:lines: 3-
.. image:: _static/g_c_n.svg
:align: center
angles.py
---------
.. literalinclude:: ../examples/angles.py
:lines: 3-
.. image:: _static/angles.svg
:align: center
.. _rank_same.py:
rank_same.py
------------
.. literalinclude:: ../examples/rank_same.py
:lines: 3-
.. image:: _static/rank_same.svg
:align: center
colors.py
---------
.. literalinclude:: ../examples/colors.py
:lines: 3-
.. image:: _static/colors.svg
:align: center
graphviz-0.20.2/docs/existing_files.rst 0000666 0000000 0000000 00000003514 14550602024 016626 0 ustar root root Existing files
--------------
To directly render an existing DOT_ source file (e.g. created with other tools),
you can use the :func:`graphviz.render` function.
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> import pathlib
>>> import graphviz
>>> src = 'digraph "the holy hand grenade" { rankdir=LR; 1 -> 2 -> 3 -> lob }'
>>> filepath = pathlib.Path('doctest-output/the-holy-hand-grenade.gv')
>>> filepath.write_text(src, encoding='ascii')
66
>>> graphviz.render('dot', 'png', filepath).replace('\\', '/')
'doctest-output/the-holy-hand-grenade.gv.png'
To directly display the rendered visualization of an existing DOT_ source file
inside a Jupyter `notebook `_
or `Qt Console `_,
you can use :meth:`graphviz.Source.from_file` (alternative constructor):
.. image:: _static/qtconsole-source.png
:align: center
Note that :meth:`~.Source.render` and :meth:`~.Source.view`
on :class:`.Source` instances returned by :meth:`graphviz.Source.from_file`
skip writing the loaded file back.
The same holds for :meth:`~.Source.save`.
The instances resolve default ``.save(skip_existing=None)``
to ``.save(skip_existing_run=True)``
to skip writing the read :attr:`~.Source.source` back into the same file
(specifically the same path that it was loaded from).
Call ``.save(skip_existing=False)`` if you want to re-write the loaded source.
.. admonition:: Historical note
Before version ``0.18`` of this library,
:meth:`.Source.save`, :meth:`.Source.render`, and :meth:`.Source.view`,
wrote the content read into source back into the file.
It was advised to use :func:`graphviz.render` and :func:`graphviz.view`
to directly work on files if the superfluous saving needed to be avoided.
.. include:: _links.rst
graphviz-0.20.2/docs/formats.rst 0000666 0000000 0000000 00000001300 14550602024 015254 0 ustar root root Formats
-------
To use a different `output file format `_ than the default PDF,
you can use the ``format`` argument when creating your :class:`.Graph`
or :class:`.Digraph` object:
.. doctest::
>>> import graphviz
>>> g = graphviz.Graph(format='png') # doctest: +NO_EXE
You can also change the :attr:`~.Graph.format` attribute on an existing graph
object:
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> dot = graphviz.Digraph('hello')
>>> dot.edge('hello', 'world')
>>> dot.format = 'svg'
>>> dot.render(directory='doctest-output').replace('\\', '/')
'doctest-output/hello.gv.svg'
.. include:: _links.rst
graphviz-0.20.2/docs/index.rst 0000666 0000000 0000000 00000001077 14251463736 014740 0 ustar root root .. graphviz documentation master file
.. include:: ../README.rst
User Guide
==========
.. toctree::
:maxdepth: 2
manual
Examples
========
.. toctree::
:maxdepth: 2
examples
Notebooks
=========
.. toctree::
:maxdepth: 2
notebooks
API Reference
=============
.. toctree::
:maxdepth: 2
api
Project Info
============
.. toctree::
:maxdepth: 2
changelog
license
Development
===========
.. toctree::
:maxdepth: 2
development
release_process
graphviz-0.20.2/docs/installation.rst 0000666 0000000 0000000 00000003642 14455103174 016323 0 ustar root root Installation
------------
:doc:`graphviz ` provides a simple pure-Python interface for the Graphviz_
graph-drawing software. It runs under Python 3.8+. To install it with pip_, run
the following:
.. code:: bash
$ pip install graphviz
For a system-wide install, this typically requires administrator access. For an
isolated install, you can run the same inside a :mod:`venv` or a virtualenv_.
The only dependency is a working installation of Graphviz_
(`download page `_,
`archived versions `_,
`installation procedure for Windows `_).
After installing Graphviz, make sure that its ``bin/`` subdirectory containing
the ``dot`` `layout command `_ for rendering graph descriptions
is on your systems' ``PATH``
(sometimes done by the installer;
setting ``PATH``
on `Linux `_,
`Mac `_,
and `Windows `_):
On the command-line, ``dot -V`` should print the version of your Graphiz installation.
.. admonition:: Platform: Windows
Windows users might want to check the status of known issues
(gvedit.exe__, sfdp__, commands__) and consider trying an older archived
version as a workaround (e.g. graphviz-2.38.msi__).
__ https://gitlab.com/graphviz/graphviz/-/issues/1816
__ https://gitlab.com/graphviz/graphviz/-/issues/1269
__ https://gitlab.com/graphviz/graphviz/-/issues/1753
__ https://www2.graphviz.org/Archive/stable/windows/graphviz-2.38.msi
.. admonition:: Platform: Anaconda
See the downstream conda-forge_ distribution
`conda-forge/python-graphviz `_
(`feedstock `_),
which should automatically ``conda install``
`conda-forge/graphviz `_
(`feedstock `_) as dependency.
.. include:: _links.rst
graphviz-0.20.2/docs/integration_with_viewers.rst 0000666 0000000 0000000 00000002622 14550602024 020733 0 ustar root root Integration with viewers
------------------------
On platforms such as Windows, viewer programs opened by :meth:`~.Graph.render`
with ``view=True`` (or equivalently with the :meth:`~.Graph.view` shortcut-method)
might **lock** the (PDF, PNG, etc.) file for as long as the viewer is open
(blocking re-rendering it with a ``Permission denied`` error).
.. tip::
You can use the :func:`tempfile.mktemp` function
from the stdlib :mod:`tempfile` module to render to a different file
for each invocation. This avoids needing to close the viewer window
each time within such an incremental workflow
(and also serves to preserves the intermediate steps).
.. doctest::
>>> import tempfile # doctest: +NO_EXE
>>> import graphviz
>>> g = graphviz.Graph()
>>> g.node('spam')
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> g.view(tempfile.mktemp('.gv')) # doctest: +SKIP
'C:\\Users\\User\\AppData\\Local\\Temp\\tmp3aoie8d0.gv.pdf'
>>> g.view(tempfile.mktemp('.gv')) # doctest: +SKIP
'C:\\Users\\User\\AppData\\Local\\Temp\\tmphh4ig7a_.gv.pdf'
Other options:
- use a viewer that `support live updates `_
- use the `Jupyter notebook`_ or `Qt Console `_
(display the current version of the rendered graph
in repeated add/render/view cycles)
.. include:: _links.rst
graphviz-0.20.2/docs/jupyter_notebooks.rst 0000666 0000000 0000000 00000002272 14432726140 017404 0 ustar root root Jupyter notebooks
-----------------
:class:`.Graph` and :class:`.Digraph` objects have a
:meth:`~.Graph._repr_mimebundle_` method so they can be rendered and displayed
directly inside a `Jupyter notebook`_.
For an example, check the ``examples/graphviz-notebook.ipynb`` file
in the `source repository/distribution `_
(or the same notebook in `nbviewer `_).
This also allows direct displaying within the `Jupyter Qt Console`_
(also `the one `_ inside `Spyder IDE`_):
.. image:: _static/qtconsole.png
:align: center
By default :meth:`~.Graph._repr_mimebundle_` uses ``'svg'`` format.
You can use the :func:`graphviz.set_jupyter_format` to override the default format
that is used for displaying in IPython/Jupyter.
(`example `_,
`nbviewer `_).
.. hint::
You can also use ``display_svg()``, ``display_png()``, or ``.display_jpeg()``
from `IPython.display`_ to display the rendered
:class:`.Graph` or :class:`.Digraph` as SVG, PNG or JPEG
in IPython/Jupyter.
.. include:: _links.rst
graphviz-0.20.2/docs/license.rst 0000666 0000000 0000000 00000000101 14073203716 015226 0 ustar root root .. _license:
License
=======
.. include:: ../LICENSE.txt
graphviz-0.20.2/docs/manual.rst 0000666 0000000 0000000 00000001417 14267055466 015110 0 ustar root root .. _manual:
User Guide
==========
.. include:: installation.rst
.. include:: basic_usage.rst
.. include:: formats.rst
.. include:: piped_output.rst
.. include:: jupyter_notebooks.rst
.. include:: styling.rst
.. _attributes:
.. include:: attributes.rst
.. _node-ports-compass:
.. include:: node_ports.rst
.. _backslash-escapes:
.. include:: escapes.rst
.. _quoting-and-html-like-labels:
.. include:: quoting.rst
.. _subgraphs-clusters:
.. include:: subgraphs_and_clusters.rst
.. _engines:
.. include:: engines.rst
.. include:: neato_no_op.rst
.. include:: unflatten.rst
.. include:: custom_dot.rst
.. _using-raw-dot:
.. include:: raw_dot.rst
.. include:: existing_files.rst
.. include:: integration_with_viewers.rst
graphviz-0.20.2/docs/neato_no_op.rst 0000666 0000000 0000000 00000002142 14550602024 016106 0 ustar root root ``neato`` no-op flag
--------------------
The `neato `_ layout engine
supports an additional `rendering flag `_
that allows more control over the node positioning and the edge layout
via the `pos `_,
`overlap `_,
and `splines `_ attributes.
Use the ``neato_no_op`` keyword argument of
:meth:`~.Graph.render` or :meth:`~.Graph.pipe`
to pass it to the layout command:
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> import graphviz
>>> n = graphviz.Digraph(name='splines', engine='neato',
... graph_attr={'splines': 'true'},
... node_attr={'shape': 'point'})
>>> n.node('a', pos='0,0!', color='blue')
>>> n.node('b', pos='100,0!', color='green')
>>> n.node('c', pos='50,50!', color='red')
>>> n.edge('a', 'b', pos='0,0 30,66 70,60 100,0')
>>> n.render(neato_no_op=2, directory='doctest-output').replace('\\', '/')
'doctest-output/splines.gv.pdf'
.. image:: _static/splines.svg
:align: center
.. include:: _links.rst
graphviz-0.20.2/docs/node_ports.rst 0000666 0000000 0000000 00000002247 14151056254 015775 0 ustar root root Node ports & compass
--------------------
The :meth:`~.Graph.edge` and :meth:`~.Graph.edges` methods use the
colon-separated ``node[:port[:compass]]`` format
for ``tail`` and ``head`` nodes.
This allows to specify an optional node ``port``
plus an optional ``compass`` point the edge should aim at
for the given tail or head node (:ref:`example `).
.. caution::
As colons are used to indicate ``port`` and ``compass`` for edges,
node names containing one or more literal colons ``:``
are currently not supported.
`GH #54 `_
.. tip::
There is no such restriction for the ``label`` argument,
so you can work around by choosing a colon-free ``name``
together with the wanted ``label`` as demonstrated below
.. doctest::
>>> import graphviz # doctest: +NO_EXE
>>> cpp = graphviz.Digraph('C++')
>>> cpp.node('A', 'std::string')
>>> cpp.node('B', '"spam"')
>>> cpp.edge('A', 'B')
>>> print(cpp.source) # doctest: +NORMALIZE_WHITESPACE
digraph "C++" {
A [label="std::string"]
B [label="\"spam\""]
A -> B
}
graphviz-0.20.2/docs/notebooks.rst 0000666 0000000 0000000 00000001423 14224214124 015610 0 ustar root root .. _notebooks:
Notebooks
=========
- Render `graphviz.org gallery`_ examples with logging:
`examples/graphviz-notebook.ipynb `_
(`source `_)
- `Layout engine `_ comparison:
`examples/graphviz-engines.ipynb `_
(`source `_)
- Example for :meth:`graphviz.set_jupyter_format`:
`examples/graphviz-jupyter-format.ipynb `_
(`source `_)
- Verify `escaping `_ and quoting:
`examples/graphviz-escapes.ipynb `_
(`source `_)
.. include:: _links.rst
graphviz-0.20.2/docs/piped_output.rst 0000666 0000000 0000000 00000002255 14550602024 016334 0 ustar root root Piped output
------------
To directly access the raw results from the Graphviz_ ``dot``
`layout command `_ as binary :class:`bytes`
or as decoded :class:`str` (for plain-text formats like SVG)
instead of writing to a file, use the :meth:`~.Graph.pipe` method
of your :class:`.Graph` or :class:`.Digraph` object:
.. doctest::
>>> import graphviz
>>> h = graphviz.Graph('hello', format='svg') # doctest: +NO_EXE
>>> h.edge('Hello', 'World')
.. doctest::
>>> doctest_mark_exe() # skip this line
>>> h.pipe(format='pdf')[:4]
b'%PDF'
>>> print(h.pipe(encoding='utf-8')) # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
.. tip::
Because :meth:`~.Graph.pipe` returns the raw ``stdout``
from the layout subprocess by default (:class:`bytes`),
you usually want to decode the return value
when piping into formats like ``'svg'`` or ``'plain'``,
.. caution::
The output for :meth:`~.Graph.pipe` is buffered in memory,
so avoid this method if the data size is large.
.. include:: _links.rst
graphviz-0.20.2/docs/quoting.rst 0000666 0000000 0000000 00000004037 14550602024 015301 0 ustar root root Quoting and HTML-like labels
----------------------------
The graph-building methods of :class:`.Graph` and :class:`.Digraph` objects
automatically take care of quoting (and escaping quotes) `where needed `_
(whitespace, keywords, double quotes, etc.):
.. doctest::
>>> import graphviz # doctest: +NO_EXE
>>> q = graphviz.Digraph()
>>> q.edge('spam', 'eggs eggs')
>>> q.edge('node', '"here\'s a quote"')
>>> print(q.source) # doctest: +NORMALIZE_WHITESPACE
digraph {
spam -> "eggs eggs"
"node" -> "\"here's a quote\""
}
If a string starts with ``'<'`` and ends with ``'>'``,
it is passed on **as is**, i.e. without quoting/escaping:
The content between the angle brackets is treated by
the Graphviz_ layout `engine `_ as special **HTML string**
that can be used for `HTML-like labels `_:
.. doctest::
>>> h = graphviz.Graph('html_table') # doctest: +NO_EXE
>>> h.node('tab', label='''<
>]
\tstruct1:f1 -> struct2:f0
\tstruct1:f2 -> struct3:here
}
'''
graphviz-0.20.2/tests/test_init.py 0000666 0000000 0000000 00000007760 14151056254 015662 0 ustar root root import pytest
import graphviz
DEFAULT_ENGINE = 'dot'
DEFAULT_FORMAT = 'pdf'
DEFAULT_JUPYTER_FORMAT = 'svg'
DEFAULT_JUPYTER_MIMETYPE = 'image/svg+xml'
def test_set_default_engine_invalid():
with pytest.raises(ValueError, match=r'unknown engine'):
graphviz.set_default_engine('nonengine')
def test_set_default_format_invalid():
with pytest.raises(ValueError, match=r'unknown format'):
graphviz.set_default_format('nonformat')
def test_set_default_engine(monkeypatch, *, engine='neato', explicit_engine='sfdp'):
assert len({DEFAULT_ENGINE, engine, explicit_engine}) == 3
from graphviz.parameters import Parameters
assert Parameters._engine == DEFAULT_ENGINE
# isolate the test
monkeypatch.setattr('graphviz.parameters.Parameters._engine', DEFAULT_ENGINE)
assert Parameters._engine == DEFAULT_ENGINE
g1 = graphviz.Graph()
assert g1.engine == DEFAULT_ENGINE
g2 = graphviz.Graph(engine=explicit_engine)
assert g2.engine == explicit_engine
old = graphviz.set_default_engine(engine)
assert old == DEFAULT_ENGINE
assert g1.engine == engine
assert g2.engine == explicit_engine
g3 = graphviz.Graph()
assert g3.engine == engine
g4 = graphviz.Graph(engine=explicit_engine)
assert g4.engine == explicit_engine
old = graphviz.set_default_engine(DEFAULT_ENGINE)
assert old == engine
assert g1.engine == DEFAULT_ENGINE
assert g2.engine == explicit_engine
assert g3.engine == DEFAULT_ENGINE
assert g4.engine == explicit_engine
def test_set_default_format(monkeypatch, *, format='png', explicit_format='jpeg'):
assert len({DEFAULT_FORMAT, format, explicit_format}) == 3
from graphviz.parameters import Parameters
assert Parameters._format == DEFAULT_FORMAT
# isolate the test
monkeypatch.setattr('graphviz.parameters.Parameters._format', DEFAULT_FORMAT)
assert Parameters._format == DEFAULT_FORMAT
g1 = graphviz.Graph()
assert g1.format == DEFAULT_FORMAT
g2 = graphviz.Graph(format=explicit_format)
assert g2.format == explicit_format
old = graphviz.set_default_format(format)
assert old == DEFAULT_FORMAT
assert g1.format == format
assert g2.format == explicit_format
g3 = graphviz.Graph()
assert g3.format == format
g4 = graphviz.Graph(format=explicit_format)
assert g4.format == explicit_format
old = graphviz.set_default_format(DEFAULT_FORMAT)
assert old == format
assert g1.format == DEFAULT_FORMAT
assert g2.format == explicit_format
assert g3.format == DEFAULT_FORMAT
assert g4.format == explicit_format
def test_set_jupyter_format(monkeypatch, *, jupyter_format='jpg',
expected_old_format='svg',
expected_normalized_format='jpeg',
expected_mimetype='image/jpeg'):
assert len({DEFAULT_JUPYTER_MIMETYPE, jupyter_format}) == 2
from graphviz import jupyter_integration
assert (jupyter_integration.JupyterIntegration._jupyter_mimetype
== DEFAULT_JUPYTER_MIMETYPE)
# isolate the test
monkeypatch.setattr('graphviz.jupyter_integration.JupyterIntegration._jupyter_mimetype',
DEFAULT_JUPYTER_MIMETYPE)
assert (jupyter_integration.JupyterIntegration._jupyter_mimetype
== DEFAULT_JUPYTER_MIMETYPE)
g1 = graphviz.Graph()
assert g1._jupyter_mimetype == DEFAULT_JUPYTER_MIMETYPE
old = graphviz.set_jupyter_format(jupyter_format)
assert old == jupyter_integration.DEFAULT_JUPYTER_FORMAT
assert g1._jupyter_mimetype == expected_mimetype
g2 = graphviz.Graph()
assert g2._jupyter_mimetype == expected_mimetype
old = graphviz.set_jupyter_format(DEFAULT_JUPYTER_FORMAT)
assert old == expected_normalized_format
assert g1._jupyter_mimetype == DEFAULT_JUPYTER_MIMETYPE
assert g2._jupyter_mimetype == DEFAULT_JUPYTER_MIMETYPE
graphviz-0.20.2/tests/test_jupyter_integration.py 0000666 0000000 0000000 00000004173 14432726140 021017 0 ustar root root import pytest
import graphviz
from graphviz import jupyter_integration
EXPECTED_SVG_ENCODING = 'utf-8'
def test_get_jupyter_format_mimetype_invalid_raises_unknown():
with pytest.raises(ValueError, match=r'unknown'):
jupyter_integration.get_jupyter_format_mimetype('Brian!')
def test_get_jupyter_mimetype_format_normalizes():
assert jupyter_integration.get_jupyter_mimetype_format(
jupyter_integration.get_jupyter_format_mimetype('jpg')) == 'jpeg'
def test_get_jupyter_mimetype_format_raises_unsupported():
with pytest.raises(ValueError,
match=r"unsupported .*\(must be one of .+'image/svg\+xml'"):
jupyter_integration.get_jupyter_mimetype_format('A boy called Brian!')
@pytest.mark.exe
def test_repr_image_svg_xml_encoding(input_encoding='latin1'):
assert input_encoding != EXPECTED_SVG_ENCODING
dot = graphviz.Graph(comment='Mønti Pythøn ik den Hølie Grailen',
encoding=input_encoding)
result = dot._repr_image_svg_xml()
assert result.startswith('')
@pytest.mark.exe
@pytest.mark.parametrize('input_encoding', ['utf-8', 'ascii', 'latin1'])
def test_repr_image_svg_xml_encoding_mocked(mocker, mock_pipe_lines_string,
mock_pipe_lines, input_encoding):
dot = graphviz.Graph(encoding=input_encoding)
result = dot._repr_image_svg_xml()
if input_encoding == 'utf-8':
assert result is mock_pipe_lines_string.return_value
mock_pipe_lines_string.assert_called_once()
mock_pipe_lines.assert_not_called()
assert (mock_pipe_lines_string.call_args.kwargs['encoding']
== EXPECTED_SVG_ENCODING)
else:
assert result is mock_pipe_lines.return_value.decode.return_value
mock_pipe_lines.assert_called_once()
mock_pipe_lines_string.assert_not_called()
assert 'encoding' not in mock_pipe_lines.call_args.kwargs
(mock_pipe_lines.return_value.decode
.assert_called_once_with(EXPECTED_SVG_ENCODING))
graphviz-0.20.2/tests/test_parameters.py 0000666 0000000 0000000 00000003360 14151056254 017052 0 ustar root root import pytest
import graphviz
from graphviz import parameters
VERIFY_FUNCS = [parameters.verify_engine,
parameters.verify_format,
parameters.verify_renderer,
parameters.verify_formatter]
@pytest.mark.parametrize(
'cls', [graphviz.Graph, graphviz.Digraph, graphviz.Source])
def test_parameters(cls, engine='patchwork', format='tiff',
renderer='map', formatter='core'):
args = [''] if cls is graphviz.Source else []
dot = cls(*args,
engine=engine, format=format,
renderer=renderer, formatter=formatter)
assert isinstance(dot, cls)
assert type(dot) is cls
assert dot.engine == engine
assert dot.format == format
assert dot.renderer == renderer
assert dot.formatter == formatter
dot_copy = dot.copy()
assert dot_copy is not dot
assert isinstance(dot_copy, cls)
assert type(dot_copy) is cls
assert dot.engine == engine
assert dot.format == format
assert dot_copy.renderer == renderer
assert dot_copy.formatter == formatter
@pytest.mark.parametrize(
'verify_func', VERIFY_FUNCS)
def test_verify_parameter_raises_unknown(verify_func):
with pytest.raises(ValueError, match=r'unknown .*\(must be .*one of'):
verify_func('Brian!')
@pytest.mark.parametrize(
'verify_func', VERIFY_FUNCS)
def test_verify_parameter_none_required_false_passes(verify_func):
assert verify_func(None, required=False) is None
@pytest.mark.parametrize(
'verify_func', VERIFY_FUNCS)
def test_verify_parameter_none_required_raises_missing(verify_func):
with pytest.raises(ValueError, match=r'missing'):
verify_func(None, required=True)
graphviz-0.20.2/tests/test_quoting.py 0000666 0000000 0000000 00000003574 14550602024 016377 0 ustar root root import sys
import warnings
import pytest
import graphviz
from graphviz import quoting
@pytest.mark.parametrize(
'char', ['G', 'E', 'T', 'H', 'L', 'l'])
def test_deprecated_escape(recwarn, char):
warnings.simplefilter('always')
escape = eval(rf'"\{char}"')
assert len(recwarn) == 1
w = recwarn.pop(DeprecationWarning if sys.version_info < (3, 12)
else SyntaxWarning)
assert str(w.message).startswith('invalid escape sequence')
assert escape == f'\\{char}'
assert quoting.quote(escape) == f'"\\{char}"'
@pytest.mark.parametrize(
'identifier, expected',
[('"spam"', r'"\"spam\""'),
('node', '"node"'),
('EDGE', '"EDGE"'),
('Graph', '"Graph"'),
('\\G \\N \\E \\T \\H \\L', '"\\G \\N \\E \\T \\H \\L"'),
('\\n \\l \\r', '"\\n \\l \\r"'),
('\r\n', '"\r\n"'),
('\\\\n', r'"\\n"'),
('\u0665.\u0660', '"\u0665.\u0660"'),
('\\"spam', r'"\"spam"'),
('\\\\"spam', r'"\\\"spam"'),
('\\\\\\"spam', r'"\\\"spam"'),
('\\\\\\\\"spam', r'"\\\\\"spam"')])
def test_quote(identifier, expected):
assert quoting.quote(identifier) == expected
@pytest.mark.parametrize(
'attributes, expected',
[([('spam', 'eggs')], ' [spam=eggs]'),
({'spam': 'eggs'}, ' [spam=eggs]')])
def test_attr_list(attributes, expected):
assert quoting.attr_list(attributes=attributes) == expected
@pytest.mark.parametrize(
'string, expected, expected_quoted',
[('spam', 'spam', 'spam'),
('<>-*-<>', '<>-*-<>', '"<>-*-<>"')])
def test_nohtml(string, expected, expected_quoted):
result = graphviz.nohtml(string)
assert isinstance(result, str)
assert isinstance(result, quoting.NoHtml)
assert result == expected
quoted = quoting.quote(result)
assert isinstance(quoted, str)
assert quoted == expected_quoted
graphviz-0.20.2/tests/test_saving.py 0000666 0000000 0000000 00000000717 14141625140 016174 0 ustar root root import graphviz
def test_saves_source_from_file(tmp_path, src='graph spam { spam }'):
path = tmp_path / 'spam.gv'
path.write_text(src)
stat_before = path.stat()
source = graphviz.Source.from_file(path)
source.save()
assert path.stat().st_mtime == stat_before.st_mtime, 'file not overwritten'
assert path.read_text() == src, 'file contents unchanged'
assert ''.join(source) == f'{src}\n', 'src with final newline'
graphviz-0.20.2/tests/test_sources.py 0000666 0000000 0000000 00000005204 14567756406 016412 0 ustar root root import locale
import pytest
import graphviz
SOURCE = {'source': 'digraph { hello -> world }\n',
'filename': 'hello.gv', 'directory': 'test-output',
'format': 'PNG', 'engine': 'NEATO', 'encoding': 'utf-8'}
@pytest.fixture(scope='module')
def source():
return graphviz.Source(**SOURCE)
@pytest.mark.parametrize(
'parameter', ['engine', 'format', 'encoding'])
def test_source_parameter(source, parameter):
if parameter != 'encoding':
assert not SOURCE[parameter].islower()
assert getattr(source, parameter) == SOURCE[parameter].lower()
def test_init(source):
assert source.source == SOURCE['source']
assert source.filename == SOURCE['filename']
assert source.directory == SOURCE['directory']
def test_init_filename():
assert graphviz.Source('').filename == 'Source.gv'
assert type('Subcls', (graphviz.Source,),
{'name': 'name'})('').filename == 'Subcls.gv'
def test_filepath(platform, source):
if platform == 'windows':
assert source.filepath == 'test-output\\hello.gv'
else:
assert source.filepath == 'test-output/hello.gv'
def test_from_file(tmp_path, filename='hello.gv', directory='source_hello',
data='digraph { hello -> world }', encoding='utf-8',
deprecation_match=r'1 positional arg\b'):
lpath = tmp_path / directory
lpath.mkdir()
(lpath / filename).write_text(data, encoding=encoding)
with pytest.deprecated_call(match=deprecation_match):
source = graphviz.Source.from_file(filename, str(lpath))
assert source.encoding == 'utf-8'
with pytest.deprecated_call(match=deprecation_match):
source = graphviz.Source.from_file(filename, str(lpath), encoding=None)
assert source.encoding == locale.getpreferredencoding()
renderer = 'xdot'
formatter = 'core'
with pytest.deprecated_call(match=deprecation_match):
source = graphviz.Source.from_file(filename, str(lpath),
encoding=encoding,
renderer=renderer,
formatter=formatter)
assert source.source == data + '\n'
assert source.filename == filename
assert source.directory == str(lpath)
assert source.encoding == encoding
assert source.renderer == renderer
assert source.formatter == formatter
def test_source_iter(source):
source_without_newline = graphviz.Source(source.source + source.source.rstrip())
lines = list(source_without_newline)
assert lines == list(source) * 2
graphviz-0.20.2/tests/test_tools.py 0000666 0000000 0000000 00000003712 14224214124 016041 0 ustar root root import functools
import os
import warnings
import pytest
from graphviz import _tools
import _common
def itertree(root):
for path, dirs, files in os.walk(root):
base = os.path.relpath(path, root)
rel_path = functools.partial(os.path.join, base if base != '.' else '')
for is_file, names in enumerate((dirs, files)):
for n in names:
yield bool(is_file), rel_path(n).replace('\\', '/')
def test_mkdirs_invalid(tmp_path):
with _common.as_cwd(tmp_path):
(tmp_path / 'spam.eggs').write_bytes(b'')
with pytest.raises(OSError):
_tools.mkdirs('spam.eggs/spam')
def test_mkdirs(tmp_path):
with _common.as_cwd(tmp_path):
_tools.mkdirs('spam.eggs')
assert list(itertree(str(tmp_path))) == []
for _ in range(2):
_tools.mkdirs('spam/eggs/spam.eggs')
assert list(itertree(str(tmp_path))) == [(False, 'spam'),
(False, 'spam/eggs')]
@pytest.mark.parametrize('category, match',
[(FutureWarning, r" third='third' "),
(DeprecationWarning, r" third='third' "),
(PendingDeprecationWarning, r" third='third' "),
(None, None)])
def test_deprecate_positional_args(category, match):
@_tools.deprecate_positional_args(supported_number=2, category=category)
def func(first, second, third=None, **kwargs):
pass
with warnings.catch_warnings():
warnings.simplefilter('error')
func('first', 'second', third='third', extra='extra')
if category is not None:
with pytest.warns(category, match=match):
func('first', 'second', 'third', extra='extra')
else:
with warnings.catch_warnings():
warnings.simplefilter('error')
func('first', 'second', 'third', extra='extra')
graphviz-0.20.2/tests/_common.py 0000666 0000000 0000000 00000002674 14455106354 015312 0 ustar root root """Test helpers and test globals."""
import contextlib
import os
import pathlib
import platform
import subprocess
__all__ = ['EXPECTED_DOT_BINARY',
'EXPECTED_UNFLATTEN_BINARY',
'EXPECTED_DEFAULT_ENGINE',
'EXPECTED_DEFAULT_ENCODING',
'INVALID_CMD',
'as_cwd',
'check_startupinfo', 'StartupinfoMatcher']
EXPECTED_DOT_BINARY = pathlib.Path('dot')
EXPECTED_UNFLATTEN_BINARY = pathlib.Path('unflatten')
EXPECTED_DEFAULT_ENGINE = 'dot'
EXPECTED_DEFAULT_ENCODING = 'utf-8'
INVALID_CMD = ['']
@contextlib.contextmanager
def as_cwd(path):
"""Return a context manager, which changes to the path's directory
during the managed ``with`` context."""
cwd = pathlib.Path().resolve()
os.chdir(path)
yield
os.chdir(cwd)
def check_startupinfo(startupinfo) -> bool: # noqa: N803
return startupinfo is None
if platform.system().lower() == 'windows':
def check_startupinfo(startupinfo) -> bool: # noqa: N803,F811
return (isinstance(startupinfo, subprocess.STARTUPINFO)
and startupinfo.dwFlags & subprocess.STARTF_USESHOWWINDOW
and startupinfo.wShowWindow == subprocess.SW_HIDE)
class StartupinfoMatcher:
"""Verify the given startupinfo argument is as expected for the plaform."""
def __eq__(self, startupinfo) -> bool:
return check_startupinfo(startupinfo)
graphviz-0.20.2/build-docs.py 0000666 0000000 0000000 00000004201 14155453170 014530 0 ustar root root #!/usr/bin/env python3
# flake8: noqa
"""Build the docs with https://www.sphinx-doc.org."""
import functools
import pathlib
import sys
import webbrowser
from sphinx.cmd import build
SELF = pathlib.Path(__file__)
SOURCE = pathlib.Path('docs')
TARGET = SOURCE / '_build'
RESULT = TARGET / 'index.html'
BROWSER_OPEN = '--open'
SKIP_OPEN_RESULT = '--no-open'
DEFAULT_ARGS = [BROWSER_OPEN, '-W', '-n', '-v', str(SOURCE), str(TARGET)]
OPEN_RESULT = BROWSER_OPEN in DEFAULT_ARGS
print = functools.partial(print, sep='\n')
args = sys.argv[1:]
print(f'run {[SELF.name] + args}')
if not args:
args = DEFAULT_ARGS
if SKIP_OPEN_RESULT in args:
open_result = None
args = [a for a in args
for name, value in [a.partition('=')[::2]]
if name not in (SKIP_OPEN_RESULT, BROWSER_OPEN)]
elif any(a.partition('=')[0] == BROWSER_OPEN for a in args):
open_result = RESULT
values = {value for a in args
for name, value in [a.partition('=')[::2]]
if name == BROWSER_OPEN and value}
if values:
if len(values) != 1:
raise ValueError(f'conflicting {BROWSER_OPEN}: {values}')
value, = values
if value:
open_result = open_result.parent / value
args = [a for a in args if a.partition('=')[0] != BROWSER_OPEN]
if not args: # no pytest args given
args = [a for a in DEFAULT_ARGS
if a != SKIP_OPEN_RESULT and a.partition('=')[0] != BROWSER_OPEN]
if args == ['-b', 'doctest']:
args += ['-W', str(SOURCE), str(SOURCE / '_doctest')]
print('', f'sphinx.cmd.build.main({args})',)
returncode = build.main(args)
status = 'FAILED' if returncode else 'PASSED'
print('', f'{status} (returncode {returncode!r})', end='')
try:
if 'doctest' not in args:
print('', f'index: {RESULT}', f'assert {RESULT!r}.stat().st_size', end='')
assert open_result.stat().st_size, f'non-empty {open_result}'
if open_result:
print('', f'webbrowser.open({open_result!r})', end='')
webbrowser.open(open_result)
finally:
sys.exit(returncode)
graphviz-0.20.2/CHANGES.rst 0000666 0000000 0000000 00000053756 14575735742 013774 0 ustar root root Changelog
=========
Version 0.20.2
--------------
Drop Python 3.7 support (end of life 27 Jun 2023).
Tag Python 3.11 and 3.12 support.
Add caveat about ``labe`` escaping/quoting to ``.node()`` and ``.render()``
API docs.
Document that ``doctest_skip_exe()`` lines in doctest should be ignored.
Improve internal ``tools.deprecate_positional_args()`` decorator
and fix incorect test assertion.
Update GitHub actions.
Version 0.20.1
--------------
Fix documentation building: upgrade to Sphinx 5.0.
Fix broken user guide links in API documentation.
Version 0.20
------------
Add keyword-only ``neato_no_op`` argument to ``.render()``, ``.pipe()``,
and stand-alone ``graphviz.render()`` and ``graphviz.pipe()``.
When building a ``Graph`` or ``Digraph``,
warn about an expected DOT syntax error in rendering
when passing a string that ends with an odd number of backslashes
(e.g. invalid ``dot.node('spam', label='\\')``
instead of correct ``..., label=r'\\'``
for a node labled as a backslash).
Increase visibility of ``graphviz.escape()`` in the documentation.
Version 0.19.2
--------------
Drop Python 3.6 support (end of life 23 Dec 2021).
Fix ``ExecutableNotFound`` and ``CalledProcessError`` in ``graphviz.__all__``.
Better document ``0.18`` change of behaviour for the ``body`` argument/attribute
(lines need to include their final newline).
Version 0.19.1
--------------
Fix undecoded ``CalledProcessError.stdout`` and ``.stderr`` when ``.pipe()`` call
with an ``encoding`` different from ``self.encoding`` fails.
Fix missing project root ``conftest.py`` in source distribution.
Extend ``examples/graphviz-escapes.ipynb``.
Improve test coverage.
Increase build scripts verbosity.
Version 0.19
------------
Add ``PendingDeprecationWarning`` to calls using positional arguments
that will be **deprecated in a later version**.
The future API will allow from one to three positional arguments
depending on the method or function.
Keyword-only arguments where not around when this library was created.
This signals dependents and in general users to start updating
or pinning to the wanted version (or range).
Crucially, this helps new users with a safer API
that allows to avoid some common mistakes.
Warnings reported in tests.
Add keyword-only ``outfile`` argument to ``.render()``
and stand-alone ``graphviz.render()``.
Allows to override the rendered output file name:
``.render(filename='spam.gv', outfile='spam.pdf')``
Allows to derive the ``format`` and the ``filename``
from the rendered ``outfile`` name:
``.render(outfile='spam.svg')``
Tries to infer default ``format`` from the ``outfile`` suffix.
You can override by setting ``format`` explicitly.
Warns with a ``graphviz.FormatSuffixMismatchWarning``
if there is a mismatch between given ``format``
and the inferred format from ``outfile`` suffix.
Warns with a ``graphviz.UnknownSuffixWarning``
if ``format`` is given and ``outfile`` uses a suffix
that cannot be mapped to a supported format.
Add ``graphviz.set_jupyter_format()`` to set the output ``format``
used by the Jupyter visualization of ``graphviz.Graph``, ``graphviz.Digraph``,
and ``graphviz.Source`` (supported formats: ``'svg'``, ``'png'``, ``'jpeg'``).
Replace ``_repr_svg_()`` internally with ``_repr_mimebundle_(include, exclude)``
returning a mimebundle ``{'image/svg+xml', '`_ Christoph Boeddeker.
Add keyword-only ``raise_if_result_exists`` argument to ``.render()``
and stand-alone ``graphviz.render()``.
Raises ``graphviz.FileExistsError`` if the rendered file already exists.
Add support to for ``.render()`` and stand-alone ``.render()``
to overwrite the input source file with the rendered output
when using the ``outfile`` keyword-only argument.
This probably only makes sense for text-based Graphviz formats
such as ``dot`` or ``plain``.
You need to specify ``overwrite_filepath=True`` to enable this.
Add ``graphviz.CalledProcessError`` derived from ``subprocess.CalledProcessError``
so users can choose either one in their excepts.
Add ``graphviz.FileExistsError`` derived from ``FileExistsError``
so users can choose either one in their excepts.
Add ``--only-exe`` flag to ``run-tests.py`` (overrides ``--skip-exe``).
Add ``--no-open`` and ``--open`` flags to ``build-docs.py``.
Add ``lint-code.py`` and use in build job.
Increase doctest coverage.
Extend type annotations.
Accept path-like objects for ``filename``, ``directory``, and ``filepath``.
Extend and improve documentation.
Improve build tests.
Version 0.18.2
--------------
Fix ``filepath`` fallback to ``name`` of ``Graph/Digraph`` for
when filepath is not present (restore
``graphviz.Graph('spam').filename == 'spam.gv'`` broken in 0.18).
Fix unintended API docs reference to internal ``backend`` name for
``DOT_BINARY`` and ``UNFLATTEN_BINARY``. Moved to public API
as ``graphviz.DOT_BINARY`` and ``graphviz.UNFLATTEN_BINARY``.
Fix broken documentation links.
Docs: re-render most SVGs and notebooks with upstream Graphviz 2.49.3.
Version 0.18.1
--------------
Fix ``TypeError: argument of type 'WindowsPath' is not iterable``
on Windows platform under Python 3.6 and 3.7
(work around https://bugs.python.org/issue41649).
Update outdated examples source links.
Improve mode structure and separation of concerns.
Improve test structure and coverage.
Improve output of ``try-examples.py``.
Add exit status for CI. Disable `view()`.
Add ``build-docs.py`` script for development.
Add ``update-help.py`` script for development.
Version 0.18
------------
Change of beaviour:
File endings are now normalized so that all DOT source outputs
end with a final newline (Unix convention, simplifies concatenation).
This includes DOT source files written by ``.render()``, ``.view()``,
or ``.save()`` as well was ``.source`` generated or loaded from ``Source``
(or ``Source.from_file()``).
Change of behaviour:
``Source`` instances created by ``Source.from_file()``
no nonger write the content read into ``.source`` back into the file.
Use ``.save(skip_existing=False)`` before calling ``.render()`` or ``.view()``
if you want to overwrite the file to produce the previous (less safe) behaviour.
Change of undocumented behaviour:
When iterating over a ``Graph``, ``Digraph``, or ``Source`` instance,
the yielded lines now include a final newline (``'\n'``).
This mimics iteration over ``file`` object lines in text mode.
Change of behaviour:
When adding custom DOT statements using the ``body`` argument
of ``Graph`` or ``Digraph`` or appending to the ``body`` attribute
of an instance, the lines now need to include their final newline (``'\n'``).
When passing invalid parameters such as unknown ``engine``, ``format``, etc.,
``.render()`` now raises early before writing the file.
Call ``.save()`` explicitly to produce the previous (less safe) behaviour.
Add optional keyword-only ``encoding`` argument to ``pipe()``.
Returns the decoded stdout from the rendering process
(e.g. ``format='svg'``).
Delegates encoding/decoding to ``subprocess`` in the common case
(input and output encoding are the same, e.g. default ``encoding='utf-8'``).
Used by the Jupyter notebook integration.
Add optional keyword-only ``engine`` argument to ``.pipe()`` and ``.render()``.
Add optional keyword-only ``renderer`` and ``formatter`` arguments to ``Graph()``,
``Digraph()``, ``Source()`` and ``Source.from_file()``
to set default renderers and formatters (similar to ``format``).
Used by ``.pipe()``, ``.render()``, and ``.view()`` if not given as method-argument.
Add ``pipe_string()``, ``pipe_lines()``, and ``pipe_lines_string()``.
Pipe ``input_string``, return ``string``.
Pipe ``input_lines`` incrementally, return ``bytes``.
Pipe ``input_lines`` incrementally, return ``string``.
Add ``set_default_engine()`` and ``set_default_format()``
Add ``DOT_BINARY`` and ``UNFLATTEN_BINARY``.
Restructure the internal class hierarchy using multiple-inheritance
with cooperative ``super()`` calling:
``Graph`` now inherits both from ``Dot`` and from ``Render``,
and both of them inherit from ``Base`` which defines their common interface:
Lines of DOT source code that ``Dot`` generates (also ``Source``)
and rendering iterates over.
This might break some undocumented use of subclassing and require adatation
(e.g. if the methods don't use cooperative ``super()`` calling convention
or if the MRO has conflicts, supposedly rare).
Improve test separation. Improve test coverage of running the tests with ``--skip-exe``.
Add ``pytype`` checking and ``flake8`` to build workflow.
Extend type annotations.
Add https://mybinder.org config with head development environment.
Add launch badge to code repository.
Improve documentation and examples.
Add development docs.
Document release process.
Version 0.17
------------
Drop Python 2 support. Tag Python 3.10 support.
Migrate CI to GitHub actions. Add ``pypy3`` to matrix.
Tests: implement ``--skip-exe`` via custom ``pytest`` marker.
Documentation: point Anaconda users to ``conda-forge/python-graphviz``.
Move type hints from docstrings to type annotations. Improve doctests.
Examples: standardize import convention and modernize.
Re-render example notebooks with Graphviz 2.46.1.
Version 0.16
------------
Add ``.unflatten()`` method to ``Graph``, ``Digraph``, and ``Source``. Add
standalone ``unflatten()``.
Make ``Source.__str__()`` return the ``.source`` instead of the ``repr()``
(like ``Graph`` and ``Digraph``).
Render with ``dot -K ...`` instead of `` ...`` internally
(work around `upstream issue
`_).
Add documentation hint to archived upstream version for Windows.
Re-render most documentation graphs with Graphviz 2.44.1.
Version 0.15
------------
``Graph`` and ``Digraph`` instances created via the context-manager
returned by ``subgraph()`` now (re)use
``directory``, ``format``, ``engine``, and ``encoding`` from the parent
instead of using defaults (behavioral change).
Note that these attributes are only relevant
when rendering the subgraph independently (i.e. as a stand-alone graph)
from within the ``with``-block, which was previously underdocumented.
PR `#116 `_ BMaxV.
To reflect that the DOT language does not allow subgraph statements
to specify ``strict``
(i.e. no way to override the setting of the containing graph),
instances created via the context-manager are now ``strict=None`` instead of ``False``
(so they continue to render stand-alone as non-strict by default).
Drop Python 3.5 support and tag Python 3.9 support.
Add documentation link to new upstream installation procedure for Windows.
Version 0.14.2
--------------
Adapt ``graphviz.version()`` to support the Graphviz Release version entry
format introduced with ``2.44.2`` (``version()`` is needed to run the tests).
Version 0.14.1
--------------
Document the colon-separated ``node[:port[:compass]]`` format used for
``tail`` and ``head`` points in the ``edge()``- and ``edges()``-methods.
PR `#101 `_ Michał Góral.
Version 0.14
------------
Improve handling of escaped quotes (``\"``). Different from other layout engine
escapes sequences such as ``\l`` and ``\N`` (which are passed on as is by
default), there is no use case for backslash-escaping a literal quote character
because escaping of quotes is done by this library. Therefore, a
backslash-escaped quote (e.g. in ``label='\\"'``) is now treated the same as a
plain unescaped quote, i.e. both ``label='"'`` and ``label='\\"'`` produce
the same DOT source ``[label="\""]`` (a label that renders as a literal quote).
Before this change, use of ``'\\"'`` could break the quoting mechanism creating
invalid or unintended DOT, possibly leading to syntax errors from the rendering
process.
Add notebook section to documentation.
Add ``sphinx.ext.viewcode`` to docs (note that this currently lacks links for
methods, so that not all of the code is linked; use the source repo for reading
on).
Improve test and doc building config.
Version 0.13.2
--------------
Fix missing support for four-part versions in ``graphviz.version()``.
Version 0.13.1
--------------
Tag Python 3.8 support.
Fix quoting for non-ASCII numerals.
Version 0.13
------------
Add explicit support for layout engine escape sequences such as ``\l`` and
``\N``. These already worked implicitly before but where broken by backslash
escaping in ``0.12``, which is reverted by this release. Escaping now resembles
the stdlib ``re`` module: literal backslashes need to be escaped (doubled),
which is most conveniently done by using raw string literals for strings that
use escape sequences (including escaped backslashes), e.g. ``label=r'\\'``.
Add ``escape()`` function (resembling ``re.escape()``) for disabling all
meta-characters in a string for rendering.
Use ``logging`` in example notebook, add notebooks demonstrating layout engines
and escape sequence usage, improve tests with parametrization.
Version 0.12
------------
Fix missing escaping of backslashes, e.g. in labels (pull request DNGros).
Add ``quiet`` argument to standalone ``view()`` function, and ``quiet_view``
argument on ``.render()`` and ``.view()`` methods. Suppresses the ``stderr``
output of started viewer processes (unavailable on Windows).
Add basic debug logging via the stdlib ``logging`` module.
Reformatted some examples, improved tests by using autospec for mocks.
Version 0.11.1
--------------
Include ``stderr`` in ``str()`` of raised ``subprocess.CalledProcessError``.
Version 0.11
------------
Add ``quiet`` argument to ``.render()`` and ``.pipe()`` methods of ``Graph``,
``Digraph``, and ``Source`` objects, allowing to suppress ``stderr`` of the
layout subprocess (parity with stand-alone ``render()`` and ``pipe()``
functions).
The rendering process for ``render()`` methods and stand-alone function is now
started from the directory of the rendered dot source file. This allows to
render graph descriptions that use relative paths inline (e.g. for referring to
image files to be included) by using paths relative to the source file
location. Previously, such relative paths would need to be given relative to
the directory from which ``render()`` was started, so this change is backwards
incompatible for code that relied on the previous behaviour.
Drop Python 3.4 support.
Version 0.10.1
--------------
Fix broken renderer argument in ``pipe()`` method and function.
Version 0.10
------------
Add ``format`` argument to ``Graph/Digraph.render()``. This follows stand-alone
``render()`` function and mirrors the ``Graph/Digraph.pipe()`` method (usually,
``format`` is set on the instance).
Add ``renderer`` and ``formatter`` arguments to ``Graph/Digraph.render()`` and
``pipe()`` methods, as well as stand-alone ``render()`` and ``pipe()`` functions.
Version 0.9
-----------
Use ``sys.stderr`` to write stderr output from rendering process to stderr
(instead of file descriptor inheritance). Ensures stderr is passed in special
environments such as IDLE.
Suppress rendering process ``stdout`` in ``render()``.
Make ``quiet=True`` also suppress ``stderr`` on success of ``render()`` and
``pipe()`` (exit-status ``0``).
Include ``stderr`` from rendering process in ``CalledProcessError`` exception.
Version 0.8.4
-------------
Tag Python 3.7 support (work around subprocess ``close_fds`` issue on Windows).
Version 0.8.3
-------------
Fix compatibility with ``python -OO``.
Version 0.8.2
-------------
Add ``nohtml()`` to support labels of the form ``'<...>'`` (disabling their default
treatment as HTML strings).
Make default ``'utf-8'`` ``encoding`` more visible.
Set ``encoding = locale.getpreferredencoding()`` when ``encoding`` argument/property is
set to ``None`` explicitly (follow stdlib ``io.open()`` behaviour).
Version 0.8.1
-------------
Add ``Source.from_file()``-classmethod (simpler in-line SVG display of ready-made
.gv files within Jupyter).
Drop Python 3.3 support.
Version 0.8
-----------
Add ``clear()``-method for ``Graph`` and ``Digraph``.
Add ``grapviz.version()`` function.
Drop dot source extra indent for edge statements following dotguide examples.
Include LICENSE file in wheel.
Version 0.7.1
-------------
Fix ``TypeError`` in ``graphviz.pipe()`` with invalid dot code under Python 3.
Add ``copy()``-method for ``Graph``, ``Digraph``, and ``Source``.
Add ``graphviz.render(..., quiet=True)``.
Fix ``graphivz.view()`` exception on unsupported platform.
Raise a dedicated ``RuntimeError`` subclass ``graphviz.ExecutableNotFound`` when the
Graphviz executables are not found.
Port tests from ``nose/unittest`` to ``pytest``, extend, use mocks.
Version 0.7
-----------
Support setting top-level attrs with ``g.attr(key=value)``.
Add context manager usage of ``subgraph()`` for adding a subgraph in a with-block.
Add json-based output formats to known ``FORMATS`` (Graphviz 2.40+).
Drop extra indent level for DOT source with nonempty ``graph/node/edge_attr``.
Add a final newline to a saved DOT source file if it does not end with one.
Raise ``subprocess.CalledProcessError`` on non-zero exit status from rendering.
Raise early when adding a ``subgraph()`` with ``strict=True`` (avoid DOT syntax error).
Make undocumented ``quote()``, ``quote_edge()``, and ``attributes()`` methods private.
Version 0.6
-----------
Drop Python 2.6 support (use ``graphviz<0.6`` there).
Improve tests for ``mkdirs()``.
Better document adding custom DOT using the ``body`` attribute.
Add ``view()``-support for FreeBSD (pull request Julien Gamba).
Version 0.5.2
-------------
Add ``ENGINES`` and ``FORMATS`` to the documented public API.
Version 0.5.1
-------------
Fixed PY3 compatibility.
Version 0.5
-----------
Add low-level functions ``render()``, ``pipe()``, and ``view()`` for directly working with
existing files and strings.
Support all ``render()``-arguments in the ``view()``-short-cut-method.
Version 0.4.10
--------------
Added ``'patchwork'`` engine.
Version 0.4.9
-------------
Add support for ``strict`` graphs and digraphs.
Hide ``render/pipe()`` subprocess console window on Windows when invoked from
non-console process (e.g. from IDLE).
Improve documentation markup/wording.
Make ``TestNoent`` more robust.
Version 0.4.8
-------------
Make ``_repr_svg_()`` available on ``Source`` (pull request RafalSkolasinski).
Version 0.4.7
-------------
Fixed ``view()``-method on Linux under Python 3 (pull request Antony Lee).
Version 0.4.6
-------------
Fixed ``view()``-method on Linux and Darwin (pull request Eric L. Frederich).
Version 0.4.5
-------------
Added example for HTML-like labels (``structs.py``).
Added ``Source`` class for rendering verbatim DOT source code.
Added Python 2.6 support (pull request Jim Crist).
Version 0.4.4
-------------
Added the ``pipe()``-method directly returning the ``stdout`` of rendering.
Added ``_repr_svg_()`` for inline rendering in IPython notebooks.
Version 0.4.3
-------------
Added examples generating some of the graphs from the Graphviz Gallery.
Added sphinx-based API documentation.
Version 0.4.2
-------------
Added support for HTML-like labels.
Version 0.4.1
-------------
Added support for less common output formats. Removed dropped formats (``'dia'``, ``'pcl'``).
Added ``'osage'`` layout engine.
Documented ``format`` and ``engine`` options in the README.
The ``view()`` convenience method now returns the result file name (like render()).
Version 0.4
-----------
Added ``attr()`` method for inline switching of node/edge attributes.
Added ``subgraph()`` method (obsoletes separate ``Subgraph`` class).
Add ``cleanup`` option to ``render()``.
Replaced ``dry`` option on ``render()`` with separate ``save()`` method.
Removed undocumented ``append()`` and ``extend()`` methods (if needed, the ``body``
attribute can be edited directly).
Version 0.3.5
-------------
Skip empty ``comment`` when creating DOT source.
Document ``graph_attr``, ``node_attr``, and ``edge_attr`` in the README.
More informative exception when Graphviz executables cannot be called.
Version 0.3.4
-------------
Fixed missing identifier quoting for DOT keywords (thanks to Paulo Urio).
Version 0.3.3
-------------
Made ``format`` and ``engine`` case-insensitive.
Version 0.3.2
-------------
Indent ``graph_attr``, ``node_attr``, and ``edge_attr`` lines, adapt nodes and edges.
Version 0.3.1
-------------
Fixed ``view()`` failing on paths with forward slashes on Windows.
Version 0.3
-----------
Added Python 3.3+ support.
Made attributes order stable (sorting plain dicts).
Fixed edgeop in undirected graphs.
Version 0.2.2
-------------
Support pdf opening on Linux.
Fixed rendering filenames w/spaces.
Version 0.2.1
-------------
Fixed rendering on Mac OS X.
Version 0.2
-----------
Added format selection, use ``'PDF``' as default.
Added engines selection, use ``'dot'`` as default.
Added source encoding, use ``'UTF-8'`` as default.
Changed constructor arguments order, removed ``compile()`` and ``save()``-method,
reimplemented compilation in ``render()`` method, make interface more similar to
gv.3python (backwards incompatible change).
Double-quote-sign escaping, attribute list quoting.
``mkdirs()`` now correctly supports current directory filenames.
Version 0.1.1
-------------
Removed automatic ``'-'`` to ``'−'`` replacement from labels.
Fixed documentation typos.
Version 0.1
-----------
First public release.
graphviz-0.20.2/conftest.py 0000666 0000000 0000000 00000003400 14224214124 014317 0 ustar root root """pytest command line options and doctest flag definition/setup."""
import doctest
import unittest.mock
NO_EXE = doctest.register_optionflag('NO_EXE')
class NoExeChecker(doctest.OutputChecker): # noqa: E302
def check_output(self, want, got, optionflags, *args, **kwargs) -> bool:
if optionflags & NO_EXE:
return True
return super().check_output(want, got, optionflags, *args, **kwargs)
unittest.mock.patch.object(doctest, 'OutputChecker', new=NoExeChecker).start() # noqa: E305
import pytest # noqa: E402
SKIP_EXE = '--skip-exe'
ONLY_EXE = '--only-exe'
def pytest_addoption(parser):
parser.addoption(SKIP_EXE, action='store_true',
help='Skip tests with pytest.mark.exe.'
' Xfail tests with pytest.mark.exe(xfail=True).'
' Skip doctests with doctest_mark_exe().'
' Xfail doctests with doctest_mark_exe(xfail=True).'
' exe marks tests requiring backend.DOT_BINARY.')
parser.addoption(ONLY_EXE, action='store_true',
help='Skip tests without pytest.mark.exe.'
' Overrides --skip-exe.'
' exe marks tests requiring backend.DOT_BINARY.')
@pytest.fixture(autouse=True)
def doctests(pytestconfig, doctest_namespace):
def doctest_mark_exe(**kwargs):
return None
if pytestconfig.getoption(SKIP_EXE):
def doctest_mark_exe(*, reason=SKIP_EXE, xfail: bool = False, **kwargs): # noqa: F811
return (pytest.xfail(reason=reason, **kwargs) if xfail
else pytest.skip(reason, **kwargs))
doctest_namespace.update(doctest_mark_exe=doctest_mark_exe)
graphviz-0.20.2/LICENSE.txt 0000666 0000000 0000000 00000002123 14575735742 013773 0 ustar root root The MIT License (MIT)
Copyright (c) 2013-2024 Sebastian Bank
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
graphviz-0.20.2/lint-code.py 0000666 0000000 0000000 00000001310 14155453170 014357 0 ustar root root #!/usr/bin/env python3
"""Run code linting with https://flake8.pycqa.org."""
import pathlib
import platform
import subprocess
import sys
SELF = pathlib.Path(__file__)
PYTHON = 'py' if platform.system() == 'Windows' else 'python'
CMD = [PYTHON, '-m', 'flake8']
print('run', [SELF.name] + sys.argv[1:])
cmd = CMD + sys.argv[1:]
print(f'subprocess.run({cmd!r})')
try:
proc = subprocess.run(cmd, check=True)
except subprocess.CalledProcessError as e:
assert e.returncode != 0, f'non-zero returncode: {e}'
print('FAILED:', e)
sys.exit(e.returncode)
else:
assert proc.returncode == 0, f'passed: {proc}'
print('PASSED:', proc)
sys.exit(proc.returncode)
graphviz-0.20.2/MANIFEST.in 0000666 0000000 0000000 00000000511 14155453170 013667 0 ustar root root include README.rst LICENSE.txt CHANGES.rst
include requirements.txt
include conftest.py build-docs.py lint-code.py run-tests.py try-examples.py update-help.py
include tox.ini
recursive-include tests *.py *.png
recursive-include examples *.py *.ipynb
recursive-include docs *.rst *.txt *.py *.png *.svg
prune docs/_build
graphviz-0.20.2/PKG-INFO 0000666 0000000 0000000 00000030174 14575736336 013254 0 ustar root root Metadata-Version: 2.1
Name: graphviz
Version: 0.20.2
Summary: Simple Python interface for Graphviz
Home-page: https://github.com/xflr6/graphviz
Author: Sebastian Bank
Author-email: sebastian.bank@uni-leipzig.de
License: MIT
Project-URL: Documentation, https://graphviz.readthedocs.io
Project-URL: Changelog, https://graphviz.readthedocs.io/en/latest/changelog.html
Project-URL: Issue Tracker, https://github.com/xflr6/graphviz/issues
Project-URL: CI, https://github.com/xflr6/graphviz/actions
Project-URL: Coverage, https://codecov.io/gh/xflr6/graphviz
Keywords: graph visualization dot render
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Provides-Extra: dev
Requires-Dist: tox>=3; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pep8-naming; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest<8.1,>=7; extra == "test"
Requires-Dist: pytest-mock>=3; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: coverage; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx<7,>=5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Graphviz
========
|PyPI version| |License| |Supported Python| |Wheel| |Downloads|
|Build| |Codecov| |Readthedocs-stable| |Readthedocs-latest|
|Binder-stable|
This package facilitates the creation and rendering of graph descriptions in
the DOT_ language of the Graphviz_ graph drawing software (`upstream repo`_)
from Python.
Create a graph object, assemble the graph by adding nodes and edges, and
retrieve its DOT source code string. Save the source code to a file and render
it with the Graphviz installation of your system.
Use the ``view`` option/method to directly inspect the resulting (PDF, PNG,
SVG, etc.) file with its default application. Graphs can also be rendered
and displayed within `Jupyter notebooks`_ (formerly known as
`IPython notebooks`_,
`example `_, `nbviewer `_)
as well as the `Jupyter QtConsole`_.
Links
-----
- GitHub: https://github.com/xflr6/graphviz
- PyPI: https://pypi.org/project/graphviz/
- Documentation: https://graphviz.readthedocs.io
- Changelog: https://graphviz.readthedocs.io/en/latest/changelog.html
- Issue Tracker: https://github.com/xflr6/graphviz/issues
- Download: https://pypi.org/project/graphviz/#files
Installation
------------
This package runs under Python 3.8+, use pip_ to install:
.. code:: bash
$ pip install graphviz
To render the generated DOT source code, you also need to install Graphviz_
(`download page `_,
`archived versions `_,
`installation procedure for Windows `_).
Make sure that the directory containing the ``dot`` executable is on your
systems' ``PATH``
(sometimes done by the installer;
setting ``PATH``
on `Linux `_,
`Mac `_,
and `Windows `_).
Anaconda_: see the conda-forge_ package
`conda-forge/python-graphviz `_
(`feedstock `_),
which should automatically ``conda install``
`conda-forge/graphviz `_
(`feedstock `_) as dependency.
Quickstart
----------
Create a graph object:
.. code:: python
>>> import graphviz # doctest: +NO_EXE
>>> dot = graphviz.Digraph(comment='The Round Table')
>>> dot #doctest: +ELLIPSIS
Add nodes and edges:
.. code:: python
>>> dot.node('A', 'King Arthur') # doctest: +NO_EXE
>>> dot.node('B', 'Sir Bedevere the Wise')
>>> dot.node('L', 'Sir Lancelot the Brave')
>>> dot.edges(['AB', 'AL'])
>>> dot.edge('B', 'L', constraint='false')
Check the generated source code:
.. code:: python
>>> print(dot.source) # doctest: +NORMALIZE_WHITESPACE +NO_EXE
// The Round Table
digraph {
A [label="King Arthur"]
B [label="Sir Bedevere the Wise"]
L [label="Sir Lancelot the Brave"]
A -> B
A -> L
B -> L [constraint=false]
}
Save and render the source code (skip/ignore any ``doctest_mark_exe()`` lines):
.. code:: python
>>> doctest_mark_exe() # skip this line
>>> dot.render('doctest-output/round-table.gv').replace('\\', '/')
'doctest-output/round-table.gv.pdf'
Save and render and view the result:
.. code:: python
>>> doctest_mark_exe() # skip this line
>>> dot.render('doctest-output/round-table.gv', view=True) # doctest: +SKIP
'doctest-output/round-table.gv.pdf'
.. image:: https://raw.github.com/xflr6/graphviz/master/docs/_static/round-table.svg
:align: center
:alt: round-table.svg
**Caveat:**
Backslash-escapes and strings of the form ``<...>``
have a special meaning in the DOT language.
If you need to render arbitrary strings (e.g. from user input),
check the details in the `user guide`_.
See also
--------
- pygraphviz_ |--| full-blown interface wrapping the Graphviz C library with SWIG
- graphviz-python_ |--| official Python bindings
(`documentation `_)
- pydot_ |--| stable pure-Python approach, requires pyparsing
License
-------
This package is distributed under the `MIT license`_.
Development
-----------
- Development documentation: https://graphviz.readthedocs.io/en/latest/development.html
- Release process: https://graphviz.readthedocs.io/en/latest/release_process.html
.. _Graphviz: https://www.graphviz.org
.. _DOT: https://www.graphviz.org/doc/info/lang.html
.. _upstream repo: https://gitlab.com/graphviz/graphviz/
.. _upstream-download: https://www.graphviz.org/download/
.. _upstream-archived: https://www2.graphviz.org/Archive/stable/
.. _upstream-windows: https://forum.graphviz.org/t/new-simplified-installation-procedure-on-windows/224
.. _set-path-windows: https://www.computerhope.com/issues/ch000549.htm
.. _set-path-linux: https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix
.. _set-path-darwin: https://stackoverflow.com/questions/22465332/setting-path-environment-variable-in-osx-permanently
.. _pip: https://pip.pypa.io
.. _Jupyter notebooks: https://jupyter.org
.. _IPython notebooks: https://ipython.org/notebook.html
.. _Jupyter QtConsole: https://qtconsole.readthedocs.io
.. _notebook: https://github.com/xflr6/graphviz/blob/master/examples/graphviz-notebook.ipynb
.. _notebook-nbviewer: https://nbviewer.org/github/xflr6/graphviz/blob/master/examples/graphviz-notebook.ipynb
.. _Anaconda: https://docs.anaconda.com/anaconda/install/
.. _conda-forge: https://conda-forge.org
.. _conda-forge-python-graphviz: https://anaconda.org/conda-forge/python-graphviz
.. _conda-forge-python-graphviz-feedstock: https://github.com/conda-forge/python-graphviz-feedstock
.. _conda-forge-graphviz: https://anaconda.org/conda-forge/graphviz
.. _conda-forge-graphviz-feedstock: https://github.com/conda-forge/graphviz-feedstock
.. _user guide: https://graphviz.readthedocs.io/en/stable/manual.html
.. _pygraphviz: https://pypi.org/project/pygraphviz/
.. _graphviz-python: https://pypi.org/project/graphviz-python/
.. _graphviz-python-docs: https://www.graphviz.org/pdf/gv.3python.pdf
.. _pydot: https://pypi.org/project/pydot/
.. _MIT license: https://opensource.org/licenses/MIT
.. |--| unicode:: U+2013
.. |PyPI version| image:: https://img.shields.io/pypi/v/graphviz.svg
:target: https://pypi.org/project/graphviz/
:alt: Latest PyPI Version
.. |License| image:: https://img.shields.io/pypi/l/graphviz.svg
:target: https://github.com/xflr6/graphviz/blob/master/LICENSE.txt
:alt: License
.. |Supported Python| image:: https://img.shields.io/pypi/pyversions/graphviz.svg
:target: https://pypi.org/project/graphviz/
:alt: Supported Python Versions
.. |Wheel| image:: https://img.shields.io/pypi/wheel/graphviz.svg
:target: https://pypi.org/project/graphviz/#files
:alt: Wheel format
.. |Downloads| image:: https://img.shields.io/pypi/dm/graphviz.svg
:target: https://pypistats.org/packages/graphviz
:alt: Monthly downloads
.. |Build| image:: https://github.com/xflr6/graphviz/actions/workflows/build.yaml/badge.svg?branch=master
:target: https://github.com/xflr6/graphviz/actions/workflows/build.yaml?query=branch%3Amaster
:alt: Build
.. |Codecov| image:: https://codecov.io/gh/xflr6/graphviz/branch/master/graph/badge.svg
:target: https://codecov.io/gh/xflr6/graphviz
:alt: Codecov
.. |Readthedocs-stable| image:: https://readthedocs.org/projects/graphviz/badge/?version=stable
:target: https://graphviz.readthedocs.io/en/stable/
:alt: Readthedocs (stable)
.. |Readthedocs-latest| image:: https://readthedocs.org/projects/graphviz/badge/?version=latest
:target: https://graphviz.readthedocs.io/en/latest/
:alt: Readthedocs (latest)
.. |Binder-stable| image:: https://img.shields.io/badge/launch-binder%20(stable)-579ACA.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
:target: https://mybinder.org/v2/gh/xflr6/graphviz/stable
:alt: Binder (stable)
graphviz-0.20.2/README.rst 0000666 0000000 0000000 00000024372 14550602024 013624 0 ustar root root Graphviz
========
|PyPI version| |License| |Supported Python| |Wheel| |Downloads|
|Build| |Codecov| |Readthedocs-stable| |Readthedocs-latest|
|Binder-stable|
This package facilitates the creation and rendering of graph descriptions in
the DOT_ language of the Graphviz_ graph drawing software (`upstream repo`_)
from Python.
Create a graph object, assemble the graph by adding nodes and edges, and
retrieve its DOT source code string. Save the source code to a file and render
it with the Graphviz installation of your system.
Use the ``view`` option/method to directly inspect the resulting (PDF, PNG,
SVG, etc.) file with its default application. Graphs can also be rendered
and displayed within `Jupyter notebooks`_ (formerly known as
`IPython notebooks`_,
`example `_, `nbviewer `_)
as well as the `Jupyter QtConsole`_.
Links
-----
- GitHub: https://github.com/xflr6/graphviz
- PyPI: https://pypi.org/project/graphviz/
- Documentation: https://graphviz.readthedocs.io
- Changelog: https://graphviz.readthedocs.io/en/latest/changelog.html
- Issue Tracker: https://github.com/xflr6/graphviz/issues
- Download: https://pypi.org/project/graphviz/#files
Installation
------------
This package runs under Python 3.8+, use pip_ to install:
.. code:: bash
$ pip install graphviz
To render the generated DOT source code, you also need to install Graphviz_
(`download page `_,
`archived versions `_,
`installation procedure for Windows `_).
Make sure that the directory containing the ``dot`` executable is on your
systems' ``PATH``
(sometimes done by the installer;
setting ``PATH``
on `Linux