2025-02-13 15:23:26 +01:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2025-02-13 15:52:09 +01:00
< meta name = "generator" content = "pdoc 13.1.1" / >
2025-02-13 15:23:26 +01:00
< title > sqlglot.helper API documentation< / title >
< style > / * ! * B o o t s t r a p R e b o o t v 5 . 0 . 0 ( h t t p s : / / g e t b o o t s t r a p . c o m / ) * C o p y r i g h t 2 0 1 1 - 2 0 2 1 T h e B o o t s t r a p A u t h o r s * C o p y r i g h t 2 0 1 1 - 2 0 2 1 T w i t t e r , I n c . * L i c e n s e d u n d e r M I T ( h t t p s : / / g i t h u b . c o m / t w b s / b o o t s t r a p / b l o b / m a i n / L I C E N S E ) * F o r k e d f r o m N o r m a l i z e . c s s , l i c e n s e d M I T ( h t t p s : / / g i t h u b . c o m / n e c o l a s / n o r m a l i z e . c s s / b l o b / m a s t e r / L I C E N S E . m d ) * / * , : : a f t e r , : : b e f o r e { b o x - s i z i n g : b o r d e r - b o x } @ m e d i a ( p r e f e r s - r e d u c e d - m o t i o n : n o - p r e f e r e n c e ) { : r o o t { s c r o l l - b e h a v i o r : s m o o t h } } b o d y { m a r g i n : 0 ; f o n t - f a m i l y : s y s t e m - u i , - a p p l e - s y s t e m , " S e g o e U I " , R o b o t o , " H e l v e t i c a N e u e " , A r i a l , " N o t o S a n s " , " L i b e r a t i o n S a n s " , s a n s - s e r i f , " A p p l e C o l o r E m o j i " , " S e g o e U I E m o j i " , " S e g o e U I S y m b o l " , " N o t o C o l o r E m o j i " ; f o n t - s i z e : 1 r e m ; f o n t - w e i g h t : 4 0 0 ; l i n e - h e i g h t : 1 . 5 ; c o l o r : # 2 1 2 5 2 9 ; b a c k g r o u n d - c o l o r : # f f f ; - w e b k i t - t e x t - s i z e - a d j u s t : 1 0 0 % ; - w e b k i t - t a p - h i g h l i g h t - c o l o r : t r a n s p a r e n t } h r { m a r g i n : 1 r e m 0 ; c o l o r : i n h e r i t ; b a c k g r o u n d - c o l o r : c u r r e n t C o l o r ; b o r d e r : 0 ; o p a c i t y : . 2 5 } h r : n o t ( [ s i z e ] ) { h e i g h t : 1 p x } h 1 , h 2 , h 3 , h 4 , h 5 , h 6 { m a r g i n - t o p : 0 ; m a r g i n - b o t t o m : . 5 r e m ; f o n t - w e i g h t : 5 0 0 ; l i n e - h e i g h t : 1 . 2 } h 1 { f o n t - s i z e : c a l c ( 1 . 3 7 5 r e m + 1 . 5 v w ) } @ m e d i a ( m i n - w i d t h : 1 2 0 0 p x ) { h 1 { f o n t - s i z e : 2 . 5 r e m } } h 2 { f o n t - s i z e : c a l c ( 1 . 3 2 5 r e m + . 9 v w ) } @ m e d i a ( m i n - w i d t h : 1 2 0 0 p x ) { h 2 { f o n t - s i z e : 2 r e m } } h 3 { f o n t - s i z e : c a l c ( 1 . 3 r e m + . 6 v w ) } @ m e d i a ( m i n - w i d t h : 1 2 0 0 p x ) { h 3 { f o n t - s i z e : 1 . 7 5 r e m } } h 4 { f o n t - s i z e : c a l c ( 1 . 2 7 5 r e m + . 3 v w ) } @ m e d i a ( m i n - w i d t h : 1 2 0 0 p x ) { h 4 { f o n t - s i z e : 1 . 5 r e m } } h 5 { f o n t - s i z e : 1 . 2 5 r e m } h 6 { f o n t - s i z e : 1 r e m } p { m a r g i n - t o p : 0 ; m a r g i n - b o t t o m : 1 r e m } a b b r [ d a t a - b s - o r i g i n a l - t i t l e ] , a b b r [ t i t l e ] { - w e b k i t - t e x t - d e c o r a t i o n : u n d e r l i n e d o t t e d ; t e x t - d e c o r a t i o n : u n d e r l i n e d o t t e d ; c u r s o r : h e l p ; - w e b k i t - t e x t - d e c o r a t i o n - s k i p - i n k : n o n e ; t e x t - d e c o r a t i o n - s k i p - i n k : n o n e } a d d r e s s { m a r g i n - b o t t o m : 1 r e m ; f o n t - s t y l e : n o r m a l ; l i n e - h e i g h t : i n h e r i t } o l , u l { p a d d i n g - l e f t : 2 r e m } d l , o l , u l { m a r g i n - t o p : 0 ; m a r g i n - b o t t o m : 1 r e m } o l o l , o l u l , u l o l , u l u l { m a r g i n - b o t t o m : 0 } d t { f o n t - w e i g h t : 7 0 0 } d d { m a r g i n - b o t t o m : . 5 r e m ; m a r g i n - l e f t : 0 } b l o c k q u o t e { m a r g i n : 0 0 1 r e m } b , s t r o n g { f o n t - w e i g h t : b o l d e r } s m a l l { f o n t - s i z e : . 8 7 5 e m } m a r k { p a d d i n g : . 2 e m ; b a c k g r o u n d - c o l o r : # f c f 8 e 3 } s u b , s u p { p o s i t i o n : r e l a t i v e ; f o n t - s i z e : . 7 5 e m ; l i n e - h e i g h t : 0 ; v e r t i c a l - a l i g n : b a s e l i n e } s u b { b o t t o m : - . 2 5 e m } s u p { t o p : - . 5 e m } a { c o l o r : # 0 d 6 e f d ; t e x t - d e c o r a t i o n : u n d e r l i n e } a : h o v e r { c o l o r : # 0 a 5 8 c a } a : n o t ( [ h r e f ] ) : n o t ( [ c l a s s ] ) , a : n o t ( [ h r e f ] ) : n o t ( [ c l a s s ] ) : h o v e r { c o l o r : i n h e r i t ; t e x t - d e c o r a t i o n : n o n e } c o d e , k b d , p r e , s a m p { f o n t - f a m i l y : S F M o n o - R e g u l a r , M e n l o , M o n a c o , C o n s o l a s , " L i b e r a t i o n M o n o " , " C o u r i e r N e w " , m o n o s p a c e ; f o n t - s i z e : 1 e m ; d i r e c t i o n : l t r ; u n i c o d e - b i d i : b i d i - o v e r r i d e } p r e { d i s p l a y : b l o c k ; m a r g i n - t o p : 0 ; m a r g i n - b o t t o m : 1 r e m ; o v e r f l o w : a u t o ; f o n t - s i z e : . 8 7 5 e m } p r e c o d e { f o n t - s i z e : i n h e r i t ; c o l o r : i n h e r i t ; w o r d - b r e a k : n o r m a l } c o d e { f o n t - s i z e : . 8 7 5 e m ; c o l o r : # d 6 3 3 8 4 ; w o r d - w r a p : b r e a k - w o r d } a > c o d e { c o l o r : i n h e r i t } k b d { p a d d i n g : . 2 r e m . 4 r e m ; f o n t - s i z e : . 8 7 5 e m ; c o l o r : # f f f ; b a c k g r o u n d - c o l o r : # 2 1 2 5 2 9 ; b o r d e r - r a d i u s : . 2 r e m } k b d k b d { p a d d i n g : 0 ; f o n t - s i z e : 1 e m ; f o n t - w e i g h t : 7 0 0 } f i g u r e { m a r g i n : 0 0 1 r e m } i m g , s v g { v e r t i c a l - a l i g n : m i d d l e } t a b l e { c a p t i o n - s i d e : b o t t o m ; b o r d e r - c o l l a p s e : c o l l a p s e } c a p t i o n { p a d d i n g - t o p : . 5 r e m ; p a d d i n g - b o t t o m : . 5 r e m ; c o l o r : # 6 c 7 5 7 d ; t e x t - a l i g n : l e f t } t h { t e x t - a l i g n : i n h e r i t ; t e x t - a l i g n : - w e b k i t - m a t c h - p a r e n t } t b o d y , t d , t f o o t , t h , t h e a d , t r { b o r d e r - c o l o r : i n h e r i t ; b o r d e r - s t y l e : s o l i d ; b o r d e r - w i d t h : 0 } l a b e l { d i s p l a y : i n l i n e - b l o c k } b u t t o n { b o r d e r - r a d i u s : 0 } b u t t o n : f o c u s : n o t ( : f o c u s - v i s i b l e ) { o u t l i n e : 0 } b u t t o n , i n p u t , o p t g r o u p , s e l e c t , t e x t a r e a { m a r g i n : 0 ; f o n t - f a m i l y : i n h e r i t ; f o n t - s i z e : i n h e r i t ; l i n e - h e i g h t : i n h e r i t } b u t t o n , s e l e c t { t e x t - t r a n s f o r m : n o n e } [ r o l e = b u t t o n ] { c u r s o r : p o i n t e r } s e l e c t { w o r d - w r a p : n o r m a l } s e l e c t : d i s a b l e d { o p a c i t y : 1 } [ l i s t ] : : - w e b k i t - c a l e n d a r - p i c k e r - i n d i c a t o r { d i s p l a y : n o n e } [ t y p e = b u t t o n ] , [ t y p e = r e s e t ] , [ t y p e = s u b m i t ] , b u t t o n { - w e b k i t - a p p e a r a n c e : b u t t o n } [ t y p e = b u t t o n ] : n o t ( : d i s a b l e d ) , [ t y p e = r e s e t ] : n o t ( : d i s a b l e d ) , [ t y p e = s u b m i t ] : n o t ( : d i s a b l e d ) , b u t t o n : n o t ( : d i s a b l e d ) { c u r s o r : p o i n t e r } : : - m o z - f o c u s - i n n e r { p a d d i n g : 0 ; b o r d e r - s t y l e : n o n e } t e x t a r e a { r e s i z e : v e r t i c a l } f i e l d s e t { m i n - w i d t h : 0 ; p a d d i n g : 0 ; m a r g i n : 0 ; b o r d e r : 0 } l e g e n d { f l o a t : l e f t ; w i d t h : 1 0 0 % ; p a d d i n g : 0 ; m a r g i n - b o t t o m : . 5 r e m ; f o n t - s i z e : c a l c ( 1 . 2 7 5 r e m + . 3 v w ) ; l i n e - h e i g h t : i n h e r i t } @ m e d i a ( m i n - w i d t h : 1 2 0 0 p x ) { l e g e n d { f o n t - s i z e : 1 . 5 r e m } } l e g e n d + * { c l e a r : l e f t } : : - w e b k i t - d a t e t i m e - e d i t - d a y - f i e l d , : : - w e b k i t - d a t e t i m e - e d i t - f i e l d s - w r a p p e r , : : - w e b k i t - d a t e t i m e - e d i t - h o u r - f i e l d , : : - w e b k i t - d a t e t i m e - e d i t - m i n u t e , : : - w e b k i t - d a t e t i m e - e d i t - m o n t h - f i e
< style > /*! syntax-highlighting.css */ pre { line-height : 125 % ; } span . linenos { color : inherit ; background-color : transparent ; padding-left : 5 px ; padding-right : 20 px ; } . pdoc-code . hll { background-color : #ffffcc } . pdoc-code { background : #f8f8f8 ; } . pdoc-code . c { color : #3D7B7B ; font-style : italic } . pdoc-code . err { border : 1 px solid #FF0000 } . pdoc-code . k { color : #008000 ; font-weight : bold } . pdoc-code . o { color : #666666 } . pdoc-code . ch { color : #3D7B7B ; font-style : italic } . pdoc-code . cm { color : #3D7B7B ; font-style : italic } . pdoc-code . cp { color : #9C6500 } . pdoc-code . cpf { color : #3D7B7B ; font-style : italic } . pdoc-code . c1 { color : #3D7B7B ; font-style : italic } . pdoc-code . cs { color : #3D7B7B ; font-style : italic } . pdoc-code . gd { color : #A00000 } . pdoc-code . ge { font-style : italic } . pdoc-code . gr { color : #E40000 } . pdoc-code . gh { color : #000080 ; font-weight : bold } . pdoc-code . gi { color : #008400 } . pdoc-code . go { color : #717171 } . pdoc-code . gp { color : #000080 ; font-weight : bold } . pdoc-code . gs { font-weight : bold } . pdoc-code . gu { color : #800080 ; font-weight : bold } . pdoc-code . gt { color : #0044DD } . pdoc-code . kc { color : #008000 ; font-weight : bold } . pdoc-code . kd { color : #008000 ; font-weight : bold } . pdoc-code . kn { color : #008000 ; font-weight : bold } . pdoc-code . kp { color : #008000 } . pdoc-code . kr { color : #008000 ; font-weight : bold } . pdoc-code . kt { color : #B00040 } . pdoc-code . m { color : #666666 } . pdoc-code . s { color : #BA2121 } . pdoc-code . na { color : #687822 } . pdoc-code . nb { color : #008000 } . pdoc-code . nc { color : #0000FF ; font-weight : bold } . pdoc-code . no { color : #880000 } . pdoc-code . nd { color : #AA22FF } . pdoc-code . ni { color : #717171 ; font-weight : bold } . pdoc-code . ne { color : #CB3F38 ; font-weight : bold } . pdoc-code . nf { color : #0000FF } . pdoc-code . nl { color : #767600 } . pdoc-code . nn { color : #0000FF ; font-weight : bold } . pdoc-code . nt { color : #008000 ; font-weight : bold } . pdoc-code . nv { color : #19177C } . pdoc-code . ow { color : #AA22FF ; font-weight : bold } . pdoc-code . w { color : #bbbbbb } . pdoc-code . mb { color : #666666 } . pdoc-code . mf { color : #666666 } . pdoc-code . mh { color : #666666 } . pdoc-code . mi { color : #666666 } . pdoc-code . mo { color : #666666 } . pdoc-code . sa { color : #BA2121 } . pdoc-code . sb { color : #BA2121 } . pdoc-code . sc { color : #BA2121 } . pdoc-code . dl { color : #BA2121 } . pdoc-code . sd { color : #BA2121 ; font-style : italic } . pdoc-code . s2 { color : #BA2121 } . pdoc-code . se { color : #AA5D1F ; font-weight : bold } . pdoc-code . sh { color : #BA2121 } . pdoc-code . si { color : #A45A77 ; font-weight : bold } . pdoc-code . sx { color : #008000 } . pdoc-code . sr { color : #A45A77 } . pdoc-code . s1 { color : #BA2121 } . pdoc-code . ss { color : #19177C } . pdoc-code . bp { color : #008000 } . pdoc-code . fm { color : #0000FF } . pdoc-code . vc { color : #19177C } . pdoc-code . vg { color : #19177C } . pdoc-code . vi { color : #19177C } . pdoc-code . vm { color : #19177C } . pdoc-code . il { color : #666666 } < / style >
< style > /*! theme.css */ : root { --pdoc-background : #fff ; } . pdoc { --text : #212529 ; --muted : #6c757d ; --link : #3660a5 ; --link-hover : #1659c5 ; --code : #f8f8f8 ; --active : #fff598 ; --accent : #eee ; --accent2 : #c1c1c1 ; --nav-hover : rgba ( 255 , 255 , 255 , 0.5 ) ; --name : #0066BB ; --def : #008800 ; --annotation : #007020 ; } < / style >
2025-02-13 15:40:23 +01:00
< style > /*! layout.css */ html , body { width : 100 % ; height : 100 % ; } html , main { scroll-behavior : smooth ; } body { background-color : var ( - - pdoc - background ) ; } @ media ( max-width : 769px ) { # navtoggle { cursor : pointer ; position : absolute ; width : 50 px ; height : 40 px ; top : 1 rem ; right : 1 rem ; border-color : var ( - - text ) ; color : var ( - - text ) ; display : flex ; opacity : 0.8 ; z-index : 999 ; } # navtoggle : hover { opacity : 1 ; } # togglestate + div { display : none ; } # togglestate : checked + div { display : inherit ; } main , header { padding : 2 rem 3 vw ; } header + main { margin-top : -3 rem ; } . git-button { display : none !important ; } nav input [ type = "search" ] { max-width : 77 % ; } nav input [ type = "search" ] : first-child { margin-top : -6 px ; } nav input [ type = "search" ] : valid ~ * { display : none !important ; } } @ media ( min-width : 770px ) { : root { --sidebar-width : clamp ( 12.5 rem , 28 vw , 22 rem ) ; } nav { position : fixed ; overflow : auto ; height : 100 vh ; width : var ( - - sidebar - width ) ; } main , header { padding : 3 rem 2 rem 3 rem calc ( var ( - - sidebar - width ) + 3 rem ) ; width : calc ( 54 rem + var ( - - sidebar - width ) ) ; max-width : 100 % ; } header + main { margin-top : -4 rem ; } # navtoggle { display : none ; } } # togglestate { position : absolute ; height : 0 ; opacity : 0 ; } nav . pdoc { --pad : clamp ( 0.5 rem , 2 vw , 1.75 rem ) ; --indent : 1.5 rem ; background-color : var ( - - accent ) ; border-right : 1 px solid var ( - - accent2 ) ; box-shadow : 0 0 20 px rgba ( 50 , 50 , 50 , .2 ) inset ; padding : 0 0 0 var ( - - pad ) ; overflow-wrap : anywhere ; scrollbar-width : thin ; scrollbar-color : var ( - - accent2 ) transparent } nav . pdoc :: -webkit-scrollbar { width : .4 rem ; } nav . pdoc :: -webkit-scrollbar-thumb { background-color : var ( - - accent2 ) ; } nav . pdoc > div { padding : var ( - - pad ) 0 ; } nav . pdoc . module-list-button { display : inline-flex ; align-items : center ; color : var ( - - text ) ; border-color : var ( - - muted ) ; margin-bottom : 1 rem ; } nav . pdoc . module-list-button : hover { border-color : var ( - - text ) ; } nav . pdoc input [ type = search ] { display : block ; outline-offset : 0 ; width : calc ( 100 % - var ( - - pad ) ) ; } nav . pdoc . logo { max-width : calc ( 100 % - var ( - - pad ) ) ; max-height : 35 vh ; display : block ; margin : 0 auto 1 rem ; transform : translate ( calc ( -.5 * var ( - - pad ) ) , 0 ) ; } nav . pdoc ul { list-style : none ; padding-left : 0 ; } nav . pdoc > div > ul { margin-left : calc ( 0 px - var ( - - pad ) ) ; } nav . pdoc li a { padding : .2 rem 0 .2 rem calc ( var ( - - pad ) + var ( - - indent ) ) ; } nav . pdoc > div > ul > li > a { padding-left : var ( - - pad ) ; } nav . pdoc li { transition : all 100 ms ; } nav . pdoc li : hover { background-color : var ( - - nav - hover ) ; } nav . pdoc a , nav . pdoc a : hover { color : var ( - - text ) ; } nav . pdoc a { display : block ; } nav . pdoc > h2 : first-of-type { margin-top : 1.5 rem ; } nav . pdoc . class : before { content : "class " ; color : var ( - - muted ) ; } nav . pdoc . function : after { content : "()" ; color : var ( - - muted ) ; } nav . pdoc footer : before { content : "" ; display : block ; width : calc ( 100 % - var ( - - pad ) ) ; border-top : solid var ( - - accent2 ) 1 px ; margin-top : 1.5 rem ; padding-top : .5 rem ; } nav . pdoc footer { font-size : small ; } < / style >
< style > / * ! c o n t e n t . c s s * / . p d o c { c o l o r : v a r ( - - t e x t ) ; b o x - s i z i n g : b o r d e r - b o x ; l i n e - h e i g h t : 1 . 5 ; b a c k g r o u n d : n o n e ; } . p d o c . p d o c - b u t t o n { c u r s o r : p o i n t e r ; d i s p l a y : i n l i n e - b l o c k ; b o r d e r : s o l i d b l a c k 1 p x ; b o r d e r - r a d i u s : 2 p x ; f o n t - s i z e : . 7 5 r e m ; p a d d i n g : c a l c ( 0 . 5 e m - 1 p x ) 1 e m ; t r a n s i t i o n : 1 0 0 m s a l l ; } . p d o c . p d o c - a l e r t { p a d d i n g : 1 r e m 1 r e m 1 r e m c a l c ( 1 . 5 r e m + 2 4 p x ) ; b o r d e r : 1 p x s o l i d t r a n s p a r e n t ; b o r d e r - r a d i u s : . 2 5 r e m ; b a c k g r o u n d - r e p e a t : n o - r e p e a t ; b a c k g r o u n d - p o s i t i o n : 1 r e m c e n t e r ; m a r g i n - b o t t o m : 1 r e m ; } . p d o c . p d o c - a l e r t > * : l a s t - c h i l d { m a r g i n - b o t t o m : 0 ; } . p d o c . p d o c - a l e r t - n o t e { c o l o r : # 0 8 4 2 9 8 ; b a c k g r o u n d - c o l o r : # c f e 2 f f ; b o r d e r - c o l o r : # b 6 d 4 f e ; b a c k g r o u n d - i m a g e : u r l ( " d a t a : i m a g e / s v g + x m l , % 3 C s v g % 2 0 x m l n s % 3 D % 2 2 h t t p % 3 A / / w w w . w 3 . o r g / 2 0 0 0 / s v g % 2 2 % 2 0 w i d t h % 3 D % 2 2 2 4 % 2 2 % 2 0 h e i g h t % 3 D % 2 2 2 4 % 2 2 % 2 0 f i l l % 3 D % 2 2 % 2 3 0 8 4 2 9 8 % 2 2 % 2 0 v i e w B o x % 3 D % 2 2 0 % 2 0 0 % 2 0 1 6 % 2 0 1 6 % 2 2 % 3 E % 3 C p a t h % 2 0 d % 3 D % 2 2 M 8 % 2 0 1 6 A 8 % 2 0 8 % 2 0 0 % 2 0 1 % 2 0 0 % 2 0 8 % 2 0 0 a 8 % 2 0 8 % 2 0 0 % 2 0 0 % 2 0 0 % 2 0 0 % 2 0 1 6 z m . 9 3 - 9 . 4 1 2 - 1 % 2 0 4 . 7 0 5 c - . 0 7 . 3 4 . 0 2 9 . 5 3 3 . 3 0 4 . 5 3 3 . 1 9 4 % 2 0 0 % 2 0 . 4 8 7 - . 0 7 . 6 8 6 - . 2 4 6 l - . 0 8 8 . 4 1 6 c - . 2 8 7 . 3 4 6 - . 9 2 . 5 9 8 - 1 . 4 6 5 . 5 9 8 - . 7 0 3 % 2 0 0 - 1 . 0 0 2 - . 4 2 2 - . 8 0 8 - 1 . 3 1 9 l . 7 3 8 - 3 . 4 6 8 c . 0 6 4 - . 2 9 3 . 0 0 6 - . 3 9 9 - . 2 8 7 - . 4 7 l - . 4 5 1 - . 0 8 1 . 0 8 2 - . 3 8 1 % 2 0 2 . 2 9 - . 2 8 7 z M 8 % 2 0 5 . 5 a 1 % 2 0 1 % 2 0 0 % 2 0 1 % 2 0 1 % 2 0 0 - 2 % 2 0 1 % 2 0 1 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 0 % 2 0 2 z % 2 2 / % 3 E % 3 C / s v g % 3 E " ) ; } . p d o c . p d o c - a l e r t - w a r n i n g { c o l o r : # 6 6 4 d 0 3 ; b a c k g r o u n d - c o l o r : # f f f 3 c d ; b o r d e r - c o l o r : # f f e c b 5 ; b a c k g r o u n d - i m a g e : u r l ( " d a t a : i m a g e / s v g + x m l , % 3 C s v g % 2 0 x m l n s % 3 D % 2 2 h t t p % 3 A / / w w w . w 3 . o r g / 2 0 0 0 / s v g % 2 2 % 2 0 w i d t h % 3 D % 2 2 2 4 % 2 2 % 2 0 h e i g h t % 3 D % 2 2 2 4 % 2 2 % 2 0 f i l l % 3 D % 2 2 % 2 3 6 6 4 d 0 3 % 2 2 % 2 0 v i e w B o x % 3 D % 2 2 0 % 2 0 0 % 2 0 1 6 % 2 0 1 6 % 2 2 % 3 E % 3 C p a t h % 2 0 d % 3 D % 2 2 M 8 . 9 8 2 % 2 0 1 . 5 6 6 a 1 . 1 3 % 2 0 1 . 1 3 % 2 0 0 % 2 0 0 % 2 0 0 - 1 . 9 6 % 2 0 0 L . 1 6 5 % 2 0 1 3 . 2 3 3 c - . 4 5 7 . 7 7 8 . 0 9 1 % 2 0 1 . 7 6 7 . 9 8 % 2 0 1 . 7 6 7 h 1 3 . 7 1 3 c . 8 8 9 % 2 0 0 % 2 0 1 . 4 3 8 - . 9 9 . 9 8 - 1 . 7 6 7 L 8 . 9 8 2 % 2 0 1 . 5 6 6 z M 8 % 2 0 5 c . 5 3 5 % 2 0 0 % 2 0 . 9 5 4 . 4 6 2 . 9 . 9 9 5 l - . 3 5 % 2 0 3 . 5 0 7 a . 5 5 2 . 5 5 2 % 2 0 0 % 2 0 0 % 2 0 1 - 1 . 1 % 2 0 0 L 7 . 1 % 2 0 5 . 9 9 5 A . 9 0 5 . 9 0 5 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 8 % 2 0 5 z m . 0 0 2 % 2 0 6 a 1 % 2 0 1 % 2 0 0 % 2 0 1 % 2 0 1 % 2 0 0 % 2 0 2 % 2 0 1 % 2 0 1 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 0 - 2 z % 2 2 / % 3 E % 3 C / s v g % 3 E " ) ; } . p d o c . p d o c - a l e r t - d a n g e r { c o l o r : # 8 4 2 0 2 9 ; b a c k g r o u n d - c o l o r : # f 8 d 7 d a ; b o r d e r - c o l o r : # f 5 c 2 c 7 ; b a c k g r o u n d - i m a g e : u r l ( " d a t a : i m a g e / s v g + x m l , % 3 C s v g % 2 0 x m l n s % 3 D % 2 2 h t t p % 3 A / / w w w . w 3 . o r g / 2 0 0 0 / s v g % 2 2 % 2 0 w i d t h % 3 D % 2 2 2 4 % 2 2 % 2 0 h e i g h t % 3 D % 2 2 2 4 % 2 2 % 2 0 f i l l % 3 D % 2 2 % 2 3 8 4 2 0 2 9 % 2 2 % 2 0 v i e w B o x % 3 D % 2 2 0 % 2 0 0 % 2 0 1 6 % 2 0 1 6 % 2 2 % 3 E % 3 C p a t h % 2 0 d % 3 D % 2 2 M 5 . 5 2 . 3 5 9 A . 5 . 5 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 6 % 2 0 0 h 4 a . 5 . 5 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 . 4 7 4 . 6 5 8 L 8 . 6 9 4 % 2 0 6 H 1 2 . 5 a . 5 . 5 % 2 0 0 % 2 0 0 % 2 0 1 % 2 0 . 3 9 5 . 8 0 7 l - 7 % 2 0 9 a . 5 . 5 % 2 0 0 % 2 0 0 % 2 0 1 - . 8 7 3 - . 4 5 4 L 6 . 8 2 3 % 2 0 9 . 5 H 3 . 5 a . 5 . 5 % 2 0 0 % 2 0 0 % 2 0 1 - . 4 8 - . 6 4 1 l 2 . 5 - 8 . 5 z % 2 2 / % 3 E % 3 C / s v g % 3 E " ) ; } . p d o c . v i s u a l l y - h i d d e n { p o s i t i o n : a b s o l u t e ! i m p o r t a n t ; w i d t h : 1 p x ! i m p o r t a n t ; h e i g h t : 1 p x ! i m p o r t a n t ; p a d d i n g : 0 ! i m p o r t a n t ; m a r g i n : - 1 p x ! i m p o r t a n t ; o v e r f l o w : h i d d e n ! i m p o r t a n t ; c l i p : r e c t ( 0 , 0 , 0 , 0 ) ! i m p o r t a n t ; w h i t e - s p a c e : n o w r a p ! i m p o r t a n t ; b o r d e r : 0 ! i m p o r t a n t ; } . p d o c h 1 , . p d o c h 2 , . p d o c h 3 { f o n t - w e i g h t : 3 0 0 ; m a r g i n : . 3 e m 0 ; p a d d i n g : . 2 e m 0 ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) h 1 { f o n t - s i z e : 1 . 5 r e m ; f o n t - w e i g h t : 5 0 0 ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) h 2 { f o n t - s i z e : 1 . 4 r e m ; f o n t - w e i g h t : 5 0 0 ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) h 3 { f o n t - s i z e : 1 . 3 r e m ; f o n t - w e i g h t : 5 0 0 ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) h 4 { f o n t - s i z e : 1 . 2 r e m ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) h 5 { f o n t - s i z e : 1 . 1 r e m ; } . p d o c a { t e x t - d e c o r a t i o n : n o n e ; c o l o r : v a r ( - - l i n k ) ; } . p d o c a : h o v e r { c o l o r : v a r ( - - l i n k - h o v e r ) ; } . p d o c b l o c k q u o t e { m a r g i n - l e f t : 2 r e m ; } . p d o c p r e { b o r d e r - t o p : 1 p x s o l i d v a r ( - - a c c e n t 2 ) ; b o r d e r - b o t t o m : 1 p x s o l i d v a r ( - - a c c e n t 2 ) ; m a r g i n - t o p : 0 ; m a r g i n - b o t t o m : 1 e m ; p a d d i n g : . 5 r e m 0 . 5 r e m . 5 r e m ; o v e r f l o w - x : a u t o ; b a c k g r o u n d - c o l o r : v a r ( - - c o d e ) ; } . p d o c c o d e { c o l o r : v a r ( - - t e x t ) ; p a d d i n g : . 2 e m . 4 e m ; m a r g i n : 0 ; f o n t - s i z e : 8 5 % ; b a c k g r o u n d - c o l o r : v a r ( - - c o d e ) ; b o r d e r - r a d i u s : 6 p x ; } . p d o c a > c o d e { c o l o r : i n h e r i t ; } . p d o c p r e > c o d e { d i s p l a y : i n l i n e - b l o c k ; f o n t - s i z e : i n h e r i t ; b a c k g r o u n d : n o n e ; b o r d e r : n o n e ; p a d d i n g : 0 ; } . p d o c > s e c t i o n : n o t ( . m o d u l e - i n f o ) { m a r g i n - b o t t o m : 1 . 5 r e m ; } . p d o c . m o d u l e n a m e { m a r g i n - t o p : 0 ; f o n t - w e i g h t : b o l d ; } . p d o c . m o d u l e n a m e a { c o l o r : v a r ( - - l i n k ) ; t r a n s i t i o n : 1 0 0 m s a l l ; } . p d o c . g i t - b u t t o n { f l o a t : r i g h t ; b o r d e r : s o l i d v a r ( - - l i n k ) 1 p x ; } . p d o c . g i t - b u t t o n : h o v e r { b a c k g r o u n d - c o l o r : v a r ( - - l i n k ) ; c o l o r : v a r ( - - p d o c - b a c k g r o u n d ) ; } . v i e w - s o u r c e - t o g g l e - s t a t e , . v i e w - s o u r c e - t o g g l e - s t a t e ~ . p d o c - c o d e { d i s p l a y : n o n e ; } . v i e w - s o u r c e - t o g g l e - s t a t e : c h e c k e d ~ . p d o c - c o d e { d i s p l a y : b l o c k ; } . v i e w - s o u r c e - b u t t o n { d i s p l a y : i n l i n e - b l o c k ; f l o a t : r i g h t ; f o n t - s i z e : . 7 5 r e m ; l i n e - h e i g h t : 1 . 5 r e m ; c o l o r : v a r ( - - m u t e d ) ; p a d d i n g : 0 . 4 r e m 0 1 . 3 r
2025-02-13 15:23:26 +01:00
< style > /*! custom.css */ < / style > < / head >
< body >
< nav class = "pdoc" >
< label id = "navtoggle" for = "togglestate" class = "pdoc-button" > < svg xmlns = 'http://www.w3.org/2000/svg' viewBox = '0 0 30 30' > < path stroke-linecap = 'round' stroke = "currentColor" stroke-miterlimit = '10' stroke-width = '2' d = 'M4 7h22M4 15h22M4 23h22' / > < / svg > < / label >
< input id = "togglestate" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div > < a class = "pdoc-button module-list-button" href = "../sqlglot.html" >
< svg xmlns = "http://www.w3.org/2000/svg" width = "16" height = "16" fill = "currentColor" class = "bi bi-box-arrow-in-left" viewBox = "0 0 16 16" >
< path fill-rule = "evenodd" d = "M10 3.5a.5.5 0 0 0-.5-.5h-8a.5.5 0 0 0-.5.5v9a.5.5 0 0 0 .5.5h8a.5.5 0 0 0 .5-.5v-2a.5.5 0 0 1 1 0v2A1.5 1.5 0 0 1 9.5 14h-8A1.5 1.5 0 0 1 0 12.5v-9A1.5 1.5 0 0 1 1.5 2h8A1.5 1.5 0 0 1 11 3.5v2a.5.5 0 0 1-1 0v-2z" / >
< path fill-rule = "evenodd" d = "M4.146 8.354a.5.5 0 0 1 0-.708l3-3a.5.5 0 1 1 .708.708L5.707 7.5H14.5a.5.5 0 0 1 0 1H5.707l2.147 2.146a.5.5 0 0 1-.708.708l-3-3z" / >
< / svg > sqlglot< / a >
< input type = "search" placeholder = "Search..." role = "searchbox" aria-label = "search"
pattern=".+" required>
2025-02-13 15:48:10 +01:00
< h2 > API Documentation< / h2 >
< ul class = "memberlist" >
2025-02-13 15:23:26 +01:00
< li >
< a class = "class" href = "#AutoName" > AutoName< / a >
< ul class = "memberlist" >
< / ul >
< / li >
< li >
< a class = "function" href = "#seq_get" > seq_get< / a >
< / li >
< li >
< a class = "function" href = "#ensure_list" > ensure_list< / a >
< / li >
< li >
< a class = "function" href = "#ensure_collection" > ensure_collection< / a >
< / li >
< li >
< a class = "function" href = "#csv" > csv< / a >
< / li >
< li >
< a class = "function" href = "#subclasses" > subclasses< / a >
< / li >
< li >
< a class = "function" href = "#apply_index_offset" > apply_index_offset< / a >
< / li >
< li >
< a class = "function" href = "#camel_to_snake_case" > camel_to_snake_case< / a >
< / li >
< li >
< a class = "function" href = "#while_changing" > while_changing< / a >
< / li >
< li >
< a class = "function" href = "#tsort" > tsort< / a >
< / li >
< li >
< a class = "function" href = "#open_file" > open_file< / a >
< / li >
< li >
< a class = "function" href = "#csv_reader" > csv_reader< / a >
< / li >
< li >
< a class = "function" href = "#find_new_name" > find_new_name< / a >
< / li >
< li >
< a class = "function" href = "#object_to_dict" > object_to_dict< / a >
< / li >
< li >
< a class = "function" href = "#split_num_words" > split_num_words< / a >
< / li >
< li >
< a class = "function" href = "#is_iterable" > is_iterable< / a >
< / li >
< li >
< a class = "function" href = "#flatten" > flatten< / a >
< / li >
< li >
< a class = "function" href = "#dict_depth" > dict_depth< / a >
< / li >
< li >
< a class = "function" href = "#first" > first< / a >
< / li >
2025-02-13 15:46:19 +01:00
< li >
< a class = "function" href = "#should_identify" > should_identify< / a >
< / li >
2025-02-13 15:23:26 +01:00
< / ul >
< footer > Copyright (c) 2023 Toby Mao< / footer >
< a class = "attribution" title = "pdoc: Python API documentation generator" href = "https://pdoc.dev" target = "_blank" >
built with < span class = "visually-hidden" > pdoc< / span > < img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612
< / a >
< / div >
< / nav >
< main class = "pdoc" >
< section class = "module-info" >
< a class = "pdoc-button git-button" href = "https://github.com/tobymao/sqlglot/tree/main/sqlglot/helper.py" > Edit on GitHub< / a >
< h1 class = "modulename" >
< a href = "./../sqlglot.html" > sqlglot< / a > < wbr > .helper < / h1 >
< input id = "mod-helper-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< label class = "view-source-button" for = "mod-helper-view-source" > < span > View Source< / span > < / label >
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "L-1" > < a href = "#L-1" > < span class = "linenos" > 1< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > __future__< / span > < span class = "kn" > import< / span > < span class = "n" > annotations< / span >
< / span > < span id = "L-2" > < a href = "#L-2" > < span class = "linenos" > 2< / span > < / a >
< / span > < span id = "L-3" > < a href = "#L-3" > < span class = "linenos" > 3< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > inspect< / span >
< / span > < span id = "L-4" > < a href = "#L-4" > < span class = "linenos" > 4< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > logging< / span >
< / span > < span id = "L-5" > < a href = "#L-5" > < span class = "linenos" > 5< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > re< / span >
< / span > < span id = "L-6" > < a href = "#L-6" > < span class = "linenos" > 6< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > sys< / span >
< / span > < span id = "L-7" > < a href = "#L-7" > < span class = "linenos" > 7< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > typing< / span > < span class = "k" > as< / span > < span class = "nn" > t< / span >
< / span > < span id = "L-8" > < a href = "#L-8" > < span class = "linenos" > 8< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > collections.abc< / span > < span class = "kn" > import< / span > < span class = "n" > Collection< / span >
< / span > < span id = "L-9" > < a href = "#L-9" > < span class = "linenos" > 9< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > contextlib< / span > < span class = "kn" > import< / span > < span class = "n" > contextmanager< / span >
< / span > < span id = "L-10" > < a href = "#L-10" > < span class = "linenos" > 10< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > copy< / span > < span class = "kn" > import< / span > < span class = "n" > copy< / span >
< / span > < span id = "L-11" > < a href = "#L-11" > < span class = "linenos" > 11< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > enum< / span > < span class = "kn" > import< / span > < span class = "n" > Enum< / span >
< / span > < span id = "L-12" > < a href = "#L-12" > < span class = "linenos" > 12< / span > < / a >
< / span > < span id = "L-13" > < a href = "#L-13" > < span class = "linenos" > 13< / span > < / a > < span class = "k" > if< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > TYPE_CHECKING< / span > < span class = "p" > :< / span >
< / span > < span id = "L-14" > < a href = "#L-14" > < span class = "linenos" > 14< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot< / span > < span class = "kn" > import< / span > < span class = "n" > exp< / span >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-15" > < a href = "#L-15" > < span class = "linenos" > 15< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot._typing< / span > < span class = "kn" > import< / span > < span class = "n" > E< / span > < span class = "p" > ,< / span > < span class = "n" > T< / span >
< / span > < span id = "L-16" > < a href = "#L-16" > < span class = "linenos" > 16< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot.expressions< / span > < span class = "kn" > import< / span > < span class = "n" > Expression< / span >
< / span > < span id = "L-17" > < a href = "#L-17" > < span class = "linenos" > 17< / span > < / a >
< / span > < span id = "L-18" > < a href = "#L-18" > < span class = "linenos" > 18< / span > < / a > < span class = "n" > CAMEL_CASE_PATTERN< / span > < span class = "o" > =< / span > < span class = "n" > re< / span > < span class = "o" > .< / span > < span class = "n" > compile< / span > < span class = "p" > (< / span > < span class = "s2" > " (?< !^)(?=[A-Z])" < / span > < span class = "p" > )< / span >
< / span > < span id = "L-19" > < a href = "#L-19" > < span class = "linenos" > 19< / span > < / a > < span class = "n" > PYTHON_VERSION< / span > < span class = "o" > =< / span > < span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > version_info< / span > < span class = "p" > [:< / span > < span class = "mi" > 2< / span > < span class = "p" > ]< / span >
< / span > < span id = "L-20" > < a href = "#L-20" > < span class = "linenos" > 20< / span > < / a > < span class = "n" > logger< / span > < span class = "o" > =< / span > < span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > getLogger< / span > < span class = "p" > (< / span > < span class = "s2" > " sqlglot" < / span > < span class = "p" > )< / span >
< / span > < span id = "L-21" > < a href = "#L-21" > < span class = "linenos" > 21< / span > < / a >
< / span > < span id = "L-22" > < a href = "#L-22" > < span class = "linenos" > 22< / span > < / a >
< / span > < span id = "L-23" > < a href = "#L-23" > < span class = "linenos" > 23< / span > < / a > < span class = "k" > class< / span > < span class = "nc" > AutoName< / span > < span class = "p" > (< / span > < span class = "n" > Enum< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-24" > < a href = "#L-24" > < span class = "linenos" > 24< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " This is used for creating enum classes where `auto()` is the string form of the corresponding value' s name." " " < / span >
< / span > < span id = "L-25" > < a href = "#L-25" > < span class = "linenos" > 25< / span > < / a >
< / span > < span id = "L-26" > < a href = "#L-26" > < span class = "linenos" > 26< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > _generate_next_value_< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > _start< / span > < span class = "p" > ,< / span > < span class = "n" > _count< / span > < span class = "p" > ,< / span > < span class = "n" > _last_values< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-27" > < a href = "#L-27" > < span class = "linenos" > 27< / span > < / a > < span class = "k" > return< / span > < span class = "n" > name< / span >
< / span > < span id = "L-28" > < a href = "#L-28" > < span class = "linenos" > 28< / span > < / a >
< / span > < span id = "L-29" > < a href = "#L-29" > < span class = "linenos" > 29< / span > < / a >
< / span > < span id = "L-30" > < a href = "#L-30" > < span class = "linenos" > 30< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > seq_get< / span > < span class = "p" > (< / span > < span class = "n" > seq< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Sequence< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ],< / span > < span class = "n" > index< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-31" > < a href = "#L-31" > < span class = "linenos" > 31< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds." " " < / span >
< / span > < span id = "L-32" > < a href = "#L-32" > < span class = "linenos" > 32< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "L-33" > < a href = "#L-33" > < span class = "linenos" > 33< / span > < / a > < span class = "k" > return< / span > < span class = "n" > seq< / span > < span class = "p" > [< / span > < span class = "n" > index< / span > < span class = "p" > ]< / span >
< / span > < span id = "L-34" > < a href = "#L-34" > < span class = "linenos" > 34< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > IndexError< / span > < span class = "p" > :< / span >
< / span > < span id = "L-35" > < a href = "#L-35" > < span class = "linenos" > 35< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > None< / span >
< / span > < span id = "L-36" > < a href = "#L-36" > < span class = "linenos" > 36< / span > < / a >
< / span > < span id = "L-37" > < a href = "#L-37" > < span class = "linenos" > 37< / span > < / a >
< / span > < span id = "L-38" > < a href = "#L-38" > < span class = "linenos" > 38< / span > < / a > < span class = "nd" > @t< / span > < span class = "o" > .< / span > < span class = "n" > overload< / span >
< / span > < span id = "L-39" > < a href = "#L-39" > < span class = "linenos" > 39< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-40" > < a href = "#L-40" > < span class = "linenos" > 40< / span > < / a > < span class = "o" > ...< / span >
< / span > < span id = "L-41" > < a href = "#L-41" > < span class = "linenos" > 41< / span > < / a >
< / span > < span id = "L-42" > < a href = "#L-42" > < span class = "linenos" > 42< / span > < / a >
< / span > < span id = "L-43" > < a href = "#L-43" > < span class = "linenos" > 43< / span > < / a > < span class = "nd" > @t< / span > < span class = "o" > .< / span > < span class = "n" > overload< / span >
< / span > < span id = "L-44" > < a href = "#L-44" > < span class = "linenos" > 44< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > T< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-45" > < a href = "#L-45" > < span class = "linenos" > 45< / span > < / a > < span class = "o" > ...< / span >
< / span > < span id = "L-46" > < a href = "#L-46" > < span class = "linenos" > 46< / span > < / a >
< / span > < span id = "L-47" > < a href = "#L-47" > < span class = "linenos" > 47< / span > < / a >
< / span > < span id = "L-48" > < a href = "#L-48" > < span class = "linenos" > 48< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-49" > < a href = "#L-49" > < span class = "linenos" > 49< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-50" > < a href = "#L-50" > < span class = "linenos" > 50< / span > < / a > < span class = "sd" > Ensures that a value is a list, otherwise casts or wraps it into one.< / span >
< / span > < span id = "L-51" > < a href = "#L-51" > < span class = "linenos" > 51< / span > < / a >
< / span > < span id = "L-52" > < a href = "#L-52" > < span class = "linenos" > 52< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-53" > < a href = "#L-53" > < span class = "linenos" > 53< / span > < / a > < span class = "sd" > value: the value of interest.< / span >
< / span > < span id = "L-54" > < a href = "#L-54" > < span class = "linenos" > 54< / span > < / a >
< / span > < span id = "L-55" > < a href = "#L-55" > < span class = "linenos" > 55< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-56" > < a href = "#L-56" > < span class = "linenos" > 56< / span > < / a > < span class = "sd" > The value cast as a list if it' s a list or a tuple, or else the value wrapped in a list.< / span >
< / span > < span id = "L-57" > < a href = "#L-57" > < span class = "linenos" > 57< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-58" > < a href = "#L-58" > < span class = "linenos" > 58< / span > < / a > < span class = "k" > if< / span > < span class = "n" > value< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "L-59" > < a href = "#L-59" > < span class = "linenos" > 59< / span > < / a > < span class = "k" > return< / span > < span class = "p" > []< / span >
< / span > < span id = "L-60" > < a href = "#L-60" > < span class = "linenos" > 60< / span > < / a > < span class = "k" > if< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > list< / span > < span class = "p" > ,< / span > < span class = "nb" > tuple< / span > < span class = "p" > )):< / span >
< / span > < span id = "L-61" > < a href = "#L-61" > < span class = "linenos" > 61< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< / span > < span id = "L-62" > < a href = "#L-62" > < span class = "linenos" > 62< / span > < / a >
< / span > < span id = "L-63" > < a href = "#L-63" > < span class = "linenos" > 63< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > value< / span > < span class = "p" > ]< / span >
2025-02-13 15:23:26 +01:00
< / span > < span id = "L-64" > < a href = "#L-64" > < span class = "linenos" > 64< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-65" > < a href = "#L-65" > < span class = "linenos" > 65< / span > < / a >
< / span > < span id = "L-66" > < a href = "#L-66" > < span class = "linenos" > 66< / span > < / a > < span class = "nd" > @t< / span > < span class = "o" > .< / span > < span class = "n" > overload< / span >
< / span > < span id = "L-67" > < a href = "#L-67" > < span class = "linenos" > 67< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_collection< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-68" > < a href = "#L-68" > < span class = "linenos" > 68< / span > < / a > < span class = "o" > ...< / span >
< / span > < span id = "L-69" > < a href = "#L-69" > < span class = "linenos" > 69< / span > < / a >
< / span > < span id = "L-70" > < a href = "#L-70" > < span class = "linenos" > 70< / span > < / a >
< / span > < span id = "L-71" > < a href = "#L-71" > < span class = "linenos" > 71< / span > < / a > < span class = "nd" > @t< / span > < span class = "o" > .< / span > < span class = "n" > overload< / span >
< / span > < span id = "L-72" > < a href = "#L-72" > < span class = "linenos" > 72< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_collection< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > T< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-73" > < a href = "#L-73" > < span class = "linenos" > 73< / span > < / a > < span class = "o" > ...< / span >
< / span > < span id = "L-74" > < a href = "#L-74" > < span class = "linenos" > 74< / span > < / a >
< / span > < span id = "L-75" > < a href = "#L-75" > < span class = "linenos" > 75< / span > < / a >
< / span > < span id = "L-76" > < a href = "#L-76" > < span class = "linenos" > 76< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_collection< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-77" > < a href = "#L-77" > < span class = "linenos" > 77< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-78" > < a href = "#L-78" > < span class = "linenos" > 78< / span > < / a > < span class = "sd" > Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.< / span >
< / span > < span id = "L-79" > < a href = "#L-79" > < span class = "linenos" > 79< / span > < / a >
< / span > < span id = "L-80" > < a href = "#L-80" > < span class = "linenos" > 80< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-81" > < a href = "#L-81" > < span class = "linenos" > 81< / span > < / a > < span class = "sd" > value: the value of interest.< / span >
< / span > < span id = "L-82" > < a href = "#L-82" > < span class = "linenos" > 82< / span > < / a >
< / span > < span id = "L-83" > < a href = "#L-83" > < span class = "linenos" > 83< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-84" > < a href = "#L-84" > < span class = "linenos" > 84< / span > < / a > < span class = "sd" > The value if it' s a collection, or else the value wrapped in a list.< / span >
< / span > < span id = "L-85" > < a href = "#L-85" > < span class = "linenos" > 85< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-86" > < a href = "#L-86" > < span class = "linenos" > 86< / span > < / a > < span class = "k" > if< / span > < span class = "n" > value< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "L-87" > < a href = "#L-87" > < span class = "linenos" > 87< / span > < / a > < span class = "k" > return< / span > < span class = "p" > []< / span >
< / span > < span id = "L-88" > < a href = "#L-88" > < span class = "linenos" > 88< / span > < / a > < span class = "k" > return< / span > < span class = "p" > (< / span >
< / span > < span id = "L-89" > < a href = "#L-89" > < span class = "linenos" > 89< / span > < / a > < span class = "n" > value< / span > < span class = "k" > if< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "n" > Collection< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ))< / span > < span class = "k" > else< / span > < span class = "p" > [< / span > < span class = "n" > value< / span > < span class = "p" > ]< / span >
< / span > < span id = "L-90" > < a href = "#L-90" > < span class = "linenos" > 90< / span > < / a > < span class = "p" > )< / span >
< / span > < span id = "L-91" > < a href = "#L-91" > < span class = "linenos" > 91< / span > < / a >
< / span > < span id = "L-92" > < a href = "#L-92" > < span class = "linenos" > 92< / span > < / a >
< / span > < span id = "L-93" > < a href = "#L-93" > < span class = "linenos" > 93< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > csv< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s2" > " , " < / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "L-94" > < a href = "#L-94" > < span class = "linenos" > 94< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-95" > < a href = "#L-95" > < span class = "linenos" > 95< / span > < / a > < span class = "sd" > Formats any number of string arguments as CSV.< / span >
< / span > < span id = "L-96" > < a href = "#L-96" > < span class = "linenos" > 96< / span > < / a >
< / span > < span id = "L-97" > < a href = "#L-97" > < span class = "linenos" > 97< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-98" > < a href = "#L-98" > < span class = "linenos" > 98< / span > < / a > < span class = "sd" > args: the string arguments to format.< / span >
< / span > < span id = "L-99" > < a href = "#L-99" > < span class = "linenos" > 99< / span > < / a > < span class = "sd" > sep: the argument separator.< / span >
< / span > < span id = "L-100" > < a href = "#L-100" > < span class = "linenos" > 100< / span > < / a >
< / span > < span id = "L-101" > < a href = "#L-101" > < span class = "linenos" > 101< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-102" > < a href = "#L-102" > < span class = "linenos" > 102< / span > < / a > < span class = "sd" > The arguments formatted as a CSV string.< / span >
< / span > < span id = "L-103" > < a href = "#L-103" > < span class = "linenos" > 103< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-104" > < a href = "#L-104" > < span class = "linenos" > 104< / span > < / a > < span class = "k" > return< / span > < span class = "n" > sep< / span > < span class = "o" > .< / span > < span class = "n" > join< / span > < span class = "p" > (< / span > < span class = "n" > arg< / span > < span class = "k" > for< / span > < span class = "n" > arg< / span > < span class = "ow" > in< / span > < span class = "n" > args< / span > < span class = "k" > if< / span > < span class = "n" > arg< / span > < span class = "p" > )< / span >
< / span > < span id = "L-105" > < a href = "#L-105" > < span class = "linenos" > 105< / span > < / a >
< / span > < span id = "L-106" > < a href = "#L-106" > < span class = "linenos" > 106< / span > < / a >
< / span > < span id = "L-107" > < a href = "#L-107" > < span class = "linenos" > 107< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > subclasses< / span > < span class = "p" > (< / span >
< / span > < span id = "L-108" > < a href = "#L-108" > < span class = "linenos" > 108< / span > < / a > < span class = "n" > module_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-109" > < a href = "#L-109" > < span class = "linenos" > 109< / span > < / a > < span class = "n" > classes< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ],< / span >
< / span > < span id = "L-110" > < a href = "#L-110" > < span class = "linenos" > 110< / span > < / a > < span class = "n" > exclude< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > (),< / span >
< / span > < span id = "L-111" > < a href = "#L-111" > < span class = "linenos" > 111< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-112" > < a href = "#L-112" > < span class = "linenos" > 112< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-113" > < a href = "#L-113" > < span class = "linenos" > 113< / span > < / a > < span class = "sd" > Returns all subclasses for a collection of classes, possibly excluding some of them.< / span >
< / span > < span id = "L-114" > < a href = "#L-114" > < span class = "linenos" > 114< / span > < / a >
< / span > < span id = "L-115" > < a href = "#L-115" > < span class = "linenos" > 115< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-116" > < a href = "#L-116" > < span class = "linenos" > 116< / span > < / a > < span class = "sd" > module_name: the name of the module to search for subclasses in.< / span >
< / span > < span id = "L-117" > < a href = "#L-117" > < span class = "linenos" > 117< / span > < / a > < span class = "sd" > classes: class(es) we want to find the subclasses of.< / span >
< / span > < span id = "L-118" > < a href = "#L-118" > < span class = "linenos" > 118< / span > < / a > < span class = "sd" > exclude: class(es) we want to exclude from the returned list.< / span >
< / span > < span id = "L-119" > < a href = "#L-119" > < span class = "linenos" > 119< / span > < / a >
< / span > < span id = "L-120" > < a href = "#L-120" > < span class = "linenos" > 120< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-121" > < a href = "#L-121" > < span class = "linenos" > 121< / span > < / a > < span class = "sd" > The target subclasses.< / span >
< / span > < span id = "L-122" > < a href = "#L-122" > < span class = "linenos" > 122< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-123" > < a href = "#L-123" > < span class = "linenos" > 123< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span >
< / span > < span id = "L-124" > < a href = "#L-124" > < span class = "linenos" > 124< / span > < / a > < span class = "n" > obj< / span >
< / span > < span id = "L-125" > < a href = "#L-125" > < span class = "linenos" > 125< / span > < / a > < span class = "k" > for< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > obj< / span > < span class = "ow" > in< / span > < span class = "n" > inspect< / span > < span class = "o" > .< / span > < span class = "n" > getmembers< / span > < span class = "p" > (< / span >
< / span > < span id = "L-126" > < a href = "#L-126" > < span class = "linenos" > 126< / span > < / a > < span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > modules< / span > < span class = "p" > [< / span > < span class = "n" > module_name< / span > < span class = "p" > ],< / span >
< / span > < span id = "L-127" > < a href = "#L-127" > < span class = "linenos" > 127< / span > < / a > < span class = "k" > lambda< / span > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > inspect< / span > < span class = "o" > .< / span > < span class = "n" > isclass< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "nb" > issubclass< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > classes< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "n" > obj< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > exclude< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-128" > < a href = "#L-128" > < span class = "linenos" > 128< / span > < / a > < span class = "p" > )< / span >
< / span > < span id = "L-129" > < a href = "#L-129" > < span class = "linenos" > 129< / span > < / a > < span class = "p" > ]< / span >
< / span > < span id = "L-130" > < a href = "#L-130" > < span class = "linenos" > 130< / span > < / a >
< / span > < span id = "L-131" > < a href = "#L-131" > < span class = "linenos" > 131< / span > < / a >
< / span > < span id = "L-132" > < a href = "#L-132" > < span class = "linenos" > 132< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > apply_index_offset< / span > < span class = "p" > (< / span >
< / span > < span id = "L-133" > < a href = "#L-133" > < span class = "linenos" > 133< / span > < / a > < span class = "n" > this< / span > < span class = "p" > :< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Expression< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-134" > < a href = "#L-134" > < span class = "linenos" > 134< / span > < / a > < span class = "n" > expressions< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > E< / span > < span class = "p" > ]],< / span >
< / span > < span id = "L-135" > < a href = "#L-135" > < span class = "linenos" > 135< / span > < / a > < span class = "n" > offset< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-136" > < a href = "#L-136" > < span class = "linenos" > 136< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > E< / span > < span class = "p" > ]]:< / span >
< / span > < span id = "L-137" > < a href = "#L-137" > < span class = "linenos" > 137< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-138" > < a href = "#L-138" > < span class = "linenos" > 138< / span > < / a > < span class = "sd" > Applies an offset to a given integer literal expression.< / span >
< / span > < span id = "L-139" > < a href = "#L-139" > < span class = "linenos" > 139< / span > < / a >
< / span > < span id = "L-140" > < a href = "#L-140" > < span class = "linenos" > 140< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-141" > < a href = "#L-141" > < span class = "linenos" > 141< / span > < / a > < span class = "sd" > this: the target of the index< / span >
< / span > < span id = "L-142" > < a href = "#L-142" > < span class = "linenos" > 142< / span > < / a > < span class = "sd" > expressions: the expression the offset will be applied to, wrapped in a list.< / span >
< / span > < span id = "L-143" > < a href = "#L-143" > < span class = "linenos" > 143< / span > < / a > < span class = "sd" > offset: the offset that will be applied.< / span >
< / span > < span id = "L-144" > < a href = "#L-144" > < span class = "linenos" > 144< / span > < / a >
< / span > < span id = "L-145" > < a href = "#L-145" > < span class = "linenos" > 145< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-146" > < a href = "#L-146" > < span class = "linenos" > 146< / span > < / a > < span class = "sd" > The original expression with the offset applied to it, wrapped in a list. If the provided< / span >
< / span > < span id = "L-147" > < a href = "#L-147" > < span class = "linenos" > 147< / span > < / a > < span class = "sd" > `expressions` argument contains more than one expressions, it' s returned unaffected.< / span >
< / span > < span id = "L-148" > < a href = "#L-148" > < span class = "linenos" > 148< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-149" > < a href = "#L-149" > < span class = "linenos" > 149< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > offset< / span > < span class = "ow" > or< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > expressions< / span > < span class = "p" > )< / span > < span class = "o" > !=< / span > < span class = "mi" > 1< / span > < span class = "p" > :< / span >
< / span > < span id = "L-150" > < a href = "#L-150" > < span class = "linenos" > 150< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
< / span > < span id = "L-151" > < a href = "#L-151" > < span class = "linenos" > 151< / span > < / a >
< / span > < span id = "L-152" > < a href = "#L-152" > < span class = "linenos" > 152< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > expressions< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-153" > < a href = "#L-153" > < span class = "linenos" > 153< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-154" > < a href = "#L-154" > < span class = "linenos" > 154< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot< / span > < span class = "kn" > import< / span > < span class = "n" > exp< / span >
< / span > < span id = "L-155" > < a href = "#L-155" > < span class = "linenos" > 155< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot.optimizer.annotate_types< / span > < span class = "kn" > import< / span > < span class = "n" > annotate_types< / span >
< / span > < span id = "L-156" > < a href = "#L-156" > < span class = "linenos" > 156< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot.optimizer.simplify< / span > < span class = "kn" > import< / span > < span class = "n" > simplify< / span >
< / span > < span id = "L-157" > < a href = "#L-157" > < span class = "linenos" > 157< / span > < / a >
< / span > < span id = "L-158" > < a href = "#L-158" > < span class = "linenos" > 158< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > this< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > :< / span >
< / span > < span id = "L-159" > < a href = "#L-159" > < span class = "linenos" > 159< / span > < / a > < span class = "n" > annotate_types< / span > < span class = "p" > (< / span > < span class = "n" > this< / span > < span class = "p" > )< / span >
< / span > < span id = "L-160" > < a href = "#L-160" > < span class = "linenos" > 160< / span > < / a >
< / span > < span id = "L-161" > < a href = "#L-161" > < span class = "linenos" > 161< / span > < / a > < span class = "k" > if< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > cast< / span > < span class = "p" > (< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "p" > ,< / span > < span class = "n" > this< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > this< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "p" > (< / span >
< / span > < span id = "L-162" > < a href = "#L-162" > < span class = "linenos" > 162< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > .< / span > < span class = "n" > UNKNOWN< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-163" > < a href = "#L-163" > < span class = "linenos" > 163< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > .< / span > < span class = "n" > ARRAY< / span > < span class = "p" > ,< / span >
< / span > < span id = "L-164" > < a href = "#L-164" > < span class = "linenos" > 164< / span > < / a > < span class = "p" > ):< / span >
< / span > < span id = "L-165" > < a href = "#L-165" > < span class = "linenos" > 165< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
< / span > < span id = "L-166" > < a href = "#L-166" > < span class = "linenos" > 166< / span > < / a >
< / span > < span id = "L-167" > < a href = "#L-167" > < span class = "linenos" > 167< / span > < / a > < span class = "k" > if< / span > < span class = "n" > expression< / span > < span class = "p" > :< / span >
< / span > < span id = "L-168" > < a href = "#L-168" > < span class = "linenos" > 168< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > :< / span >
< / span > < span id = "L-169" > < a href = "#L-169" > < span class = "linenos" > 169< / span > < / a > < span class = "n" > annotate_types< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "L-170" > < a href = "#L-170" > < span class = "linenos" > 170< / span > < / a > < span class = "k" > if< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > cast< / span > < span class = "p" > (< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "p" > ,< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > this< / span > < span class = "ow" > in< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > INTEGER_TYPES< / span > < span class = "p" > :< / span >
< / span > < span id = "L-171" > < a href = "#L-171" > < span class = "linenos" > 171< / span > < / a > < span class = "n" > logger< / span > < span class = "o" > .< / span > < span class = "n" > warning< / span > < span class = "p" > (< / span > < span class = "s2" > " Applying array index offset (< / span > < span class = "si" > %s< / span > < span class = "s2" > )" < / span > < span class = "p" > ,< / span > < span class = "n" > offset< / span > < span class = "p" > )< / span >
< / span > < span id = "L-172" > < a href = "#L-172" > < span class = "linenos" > 172< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > simplify< / span > < span class = "p" > (< / span >
< / span > < span id = "L-173" > < a href = "#L-173" > < span class = "linenos" > 173< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Add< / span > < span class = "p" > (< / span > < span class = "n" > this< / span > < span class = "o" > =< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > copy< / span > < span class = "p" > (),< / span > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Literal< / span > < span class = "o" > .< / span > < span class = "n" > number< / span > < span class = "p" > (< / span > < span class = "n" > offset< / span > < span class = "p" > ))< / span >
< / span > < span id = "L-174" > < a href = "#L-174" > < span class = "linenos" > 174< / span > < / a > < span class = "p" > )< / span >
< / span > < span id = "L-175" > < a href = "#L-175" > < span class = "linenos" > 175< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > expression< / span > < span class = "p" > ]< / span >
< / span > < span id = "L-176" > < a href = "#L-176" > < span class = "linenos" > 176< / span > < / a >
< / span > < span id = "L-177" > < a href = "#L-177" > < span class = "linenos" > 177< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-178" > < a href = "#L-178" > < span class = "linenos" > 178< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-179" > < a href = "#L-179" > < span class = "linenos" > 179< / span > < / a >
< / span > < span id = "L-180" > < a href = "#L-180" > < span class = "linenos" > 180< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > camel_to_snake_case< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "L-181" > < a href = "#L-181" > < span class = "linenos" > 181< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Converts `name` from camelCase to snake_case and returns the result." " " < / span >
< / span > < span id = "L-182" > < a href = "#L-182" > < span class = "linenos" > 182< / span > < / a > < span class = "k" > return< / span > < span class = "n" > CAMEL_CASE_PATTERN< / span > < span class = "o" > .< / span > < span class = "n" > sub< / span > < span class = "p" > (< / span > < span class = "s2" > " _" < / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > upper< / span > < span class = "p" > ()< / span >
< / span > < span id = "L-183" > < a href = "#L-183" > < span class = "linenos" > 183< / span > < / a >
< / span > < span id = "L-184" > < a href = "#L-184" > < span class = "linenos" > 184< / span > < / a >
< / span > < span id = "L-185" > < a href = "#L-185" > < span class = "linenos" > 185< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > while_changing< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > :< / span > < span class = "n" > Expression< / span > < span class = "p" > ,< / span > < span class = "n" > func< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Callable< / span > < span class = "p" > [[< / span > < span class = "n" > Expression< / span > < span class = "p" > ],< / span > < span class = "n" > E< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > E< / span > < span class = "p" > :< / span >
< / span > < span id = "L-186" > < a href = "#L-186" > < span class = "linenos" > 186< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-187" > < a href = "#L-187" > < span class = "linenos" > 187< / span > < / a > < span class = "sd" > Applies a transformation to a given expression until a fix point is reached.< / span >
< / span > < span id = "L-188" > < a href = "#L-188" > < span class = "linenos" > 188< / span > < / a >
< / span > < span id = "L-189" > < a href = "#L-189" > < span class = "linenos" > 189< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-190" > < a href = "#L-190" > < span class = "linenos" > 190< / span > < / a > < span class = "sd" > expression: the expression to be transformed.< / span >
< / span > < span id = "L-191" > < a href = "#L-191" > < span class = "linenos" > 191< / span > < / a > < span class = "sd" > func: the transformation to be applied.< / span >
< / span > < span id = "L-192" > < a href = "#L-192" > < span class = "linenos" > 192< / span > < / a >
< / span > < span id = "L-193" > < a href = "#L-193" > < span class = "linenos" > 193< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-194" > < a href = "#L-194" > < span class = "linenos" > 194< / span > < / a > < span class = "sd" > The transformed expression.< / span >
< / span > < span id = "L-195" > < a href = "#L-195" > < span class = "linenos" > 195< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-196" > < a href = "#L-196" > < span class = "linenos" > 196< / span > < / a > < span class = "k" > while< / span > < span class = "kc" > True< / span > < span class = "p" > :< / span >
< / span > < span id = "L-197" > < a href = "#L-197" > < span class = "linenos" > 197< / span > < / a > < span class = "k" > for< / span > < span class = "n" > n< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > _< / span > < span class = "ow" > in< / span > < span class = "nb" > reversed< / span > < span class = "p" > (< / span > < span class = "nb" > tuple< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > walk< / span > < span class = "p" > ())):< / span >
< / span > < span id = "L-198" > < a href = "#L-198" > < span class = "linenos" > 198< / span > < / a > < span class = "n" > n< / span > < span class = "o" > .< / span > < span class = "n" > _hash< / span > < span class = "o" > =< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > n< / span > < span class = "p" > )< / span >
< / span > < span id = "L-199" > < a href = "#L-199" > < span class = "linenos" > 199< / span > < / a > < span class = "n" > start< / span > < span class = "o" > =< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "L-200" > < a href = "#L-200" > < span class = "linenos" > 200< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > func< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "L-201" > < a href = "#L-201" > < span class = "linenos" > 201< / span > < / a >
< / span > < span id = "L-202" > < a href = "#L-202" > < span class = "linenos" > 202< / span > < / a > < span class = "k" > for< / span > < span class = "n" > n< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > _< / span > < span class = "ow" > in< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > walk< / span > < span class = "p" > ():< / span >
< / span > < span id = "L-203" > < a href = "#L-203" > < span class = "linenos" > 203< / span > < / a > < span class = "n" > n< / span > < span class = "o" > .< / span > < span class = "n" > _hash< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< / span > < span id = "L-204" > < a href = "#L-204" > < span class = "linenos" > 204< / span > < / a > < span class = "k" > if< / span > < span class = "n" > start< / span > < span class = "o" > ==< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-205" > < a href = "#L-205" > < span class = "linenos" > 205< / span > < / a > < span class = "k" > break< / span >
< / span > < span id = "L-206" > < a href = "#L-206" > < span class = "linenos" > 206< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expression< / span >
< / span > < span id = "L-207" > < a href = "#L-207" > < span class = "linenos" > 207< / span > < / a >
< / span > < span id = "L-208" > < a href = "#L-208" > < span class = "linenos" > 208< / span > < / a >
< / span > < span id = "L-209" > < a href = "#L-209" > < span class = "linenos" > 209< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > tsort< / span > < span class = "p" > (< / span > < span class = "n" > dag< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-210" > < a href = "#L-210" > < span class = "linenos" > 210< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-211" > < a href = "#L-211" > < span class = "linenos" > 211< / span > < / a > < span class = "sd" > Sorts a given directed acyclic graph in topological order.< / span >
< / span > < span id = "L-212" > < a href = "#L-212" > < span class = "linenos" > 212< / span > < / a >
< / span > < span id = "L-213" > < a href = "#L-213" > < span class = "linenos" > 213< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-214" > < a href = "#L-214" > < span class = "linenos" > 214< / span > < / a > < span class = "sd" > dag: the graph to be sorted.< / span >
< / span > < span id = "L-215" > < a href = "#L-215" > < span class = "linenos" > 215< / span > < / a >
< / span > < span id = "L-216" > < a href = "#L-216" > < span class = "linenos" > 216< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-217" > < a href = "#L-217" > < span class = "linenos" > 217< / span > < / a > < span class = "sd" > A list that contains all of the graph' s nodes in topological order.< / span >
< / span > < span id = "L-218" > < a href = "#L-218" > < span class = "linenos" > 218< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-219" > < a href = "#L-219" > < span class = "linenos" > 219< / span > < / a > < span class = "n" > result< / span > < span class = "o" > =< / span > < span class = "p" > []< / span >
< / span > < span id = "L-220" > < a href = "#L-220" > < span class = "linenos" > 220< / span > < / a >
< / span > < span id = "L-221" > < a href = "#L-221" > < span class = "linenos" > 221< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > visit< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > :< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "n" > visited< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Set< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "L-222" > < a href = "#L-222" > < span class = "linenos" > 222< / span > < / a > < span class = "k" > if< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > result< / span > < span class = "p" > :< / span >
< / span > < span id = "L-223" > < a href = "#L-223" > < span class = "linenos" > 223< / span > < / a > < span class = "k" > return< / span >
< / span > < span id = "L-224" > < a href = "#L-224" > < span class = "linenos" > 224< / span > < / a > < span class = "k" > if< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > visited< / span > < span class = "p" > :< / span >
< / span > < span id = "L-225" > < a href = "#L-225" > < span class = "linenos" > 225< / span > < / a > < span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Cycle error" < / span > < span class = "p" > )< / span >
< / span > < span id = "L-226" > < a href = "#L-226" > < span class = "linenos" > 226< / span > < / a >
< / span > < span id = "L-227" > < a href = "#L-227" > < span class = "linenos" > 227< / span > < / a > < span class = "n" > visited< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
2025-02-13 15:48:10 +01:00
< / span > < span id = "L-228" > < a href = "#L-228" > < span class = "linenos" > 228< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-229" > < a href = "#L-229" > < span class = "linenos" > 229< / span > < / a > < span class = "k" > for< / span > < span class = "n" > dep< / span > < span class = "ow" > in< / span > < span class = "n" > dag< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > ,< / span > < span class = "p" > []):< / span >
< / span > < span id = "L-230" > < a href = "#L-230" > < span class = "linenos" > 230< / span > < / a > < span class = "n" > visit< / span > < span class = "p" > (< / span > < span class = "n" > dep< / span > < span class = "p" > ,< / span > < span class = "n" > visited< / span > < span class = "p" > )< / span >
< / span > < span id = "L-231" > < a href = "#L-231" > < span class = "linenos" > 231< / span > < / a >
< / span > < span id = "L-232" > < a href = "#L-232" > < span class = "linenos" > 232< / span > < / a > < span class = "n" > visited< / span > < span class = "o" > .< / span > < span class = "n" > remove< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
< / span > < span id = "L-233" > < a href = "#L-233" > < span class = "linenos" > 233< / span > < / a > < span class = "n" > result< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
< / span > < span id = "L-234" > < a href = "#L-234" > < span class = "linenos" > 234< / span > < / a >
< / span > < span id = "L-235" > < a href = "#L-235" > < span class = "linenos" > 235< / span > < / a > < span class = "k" > for< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > dag< / span > < span class = "p" > :< / span >
< / span > < span id = "L-236" > < a href = "#L-236" > < span class = "linenos" > 236< / span > < / a > < span class = "n" > visit< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > ,< / span > < span class = "nb" > set< / span > < span class = "p" > ())< / span >
< / span > < span id = "L-237" > < a href = "#L-237" > < span class = "linenos" > 237< / span > < / a >
< / span > < span id = "L-238" > < a href = "#L-238" > < span class = "linenos" > 238< / span > < / a > < span class = "k" > return< / span > < span class = "n" > result< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-239" > < a href = "#L-239" > < span class = "linenos" > 239< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-240" > < a href = "#L-240" > < span class = "linenos" > 240< / span > < / a >
< / span > < span id = "L-241" > < a href = "#L-241" > < span class = "linenos" > 241< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > open_file< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > TextIO< / span > < span class = "p" > :< / span >
< / span > < span id = "L-242" > < a href = "#L-242" > < span class = "linenos" > 242< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Open a file that may be compressed as gzip and return it in universal newline mode." " " < / span >
< / span > < span id = "L-243" > < a href = "#L-243" > < span class = "linenos" > 243< / span > < / a > < span class = "k" > with< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "s2" > " rb" < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > f< / span > < span class = "p" > :< / span >
< / span > < span id = "L-244" > < a href = "#L-244" > < span class = "linenos" > 244< / span > < / a > < span class = "n" > gzipped< / span > < span class = "o" > =< / span > < span class = "n" > f< / span > < span class = "o" > .< / span > < span class = "n" > read< / span > < span class = "p" > (< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > ==< / span > < span class = "sa" > b< / span > < span class = "s2" > " < / span > < span class = "se" > \x1f\x8b< / span > < span class = "s2" > " < / span >
< / span > < span id = "L-245" > < a href = "#L-245" > < span class = "linenos" > 245< / span > < / a >
< / span > < span id = "L-246" > < a href = "#L-246" > < span class = "linenos" > 246< / span > < / a > < span class = "k" > if< / span > < span class = "n" > gzipped< / span > < span class = "p" > :< / span >
< / span > < span id = "L-247" > < a href = "#L-247" > < span class = "linenos" > 247< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > gzip< / span >
< / span > < span id = "L-248" > < a href = "#L-248" > < span class = "linenos" > 248< / span > < / a >
< / span > < span id = "L-249" > < a href = "#L-249" > < span class = "linenos" > 249< / span > < / a > < span class = "k" > return< / span > < span class = "n" > gzip< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "s2" > " rt" < / span > < span class = "p" > ,< / span > < span class = "n" > newline< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-250" > < a href = "#L-250" > < span class = "linenos" > 250< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-251" > < a href = "#L-251" > < span class = "linenos" > 251< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ,< / span > < span class = "n" > newline< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-252" > < a href = "#L-252" > < span class = "linenos" > 252< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-253" > < a href = "#L-253" > < span class = "linenos" > 253< / span > < / a >
< / span > < span id = "L-254" > < a href = "#L-254" > < span class = "linenos" > 254< / span > < / a > < span class = "nd" > @contextmanager< / span >
< / span > < span id = "L-255" > < a href = "#L-255" > < span class = "linenos" > 255< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > csv_reader< / span > < span class = "p" > (< / span > < span class = "n" > read_csv< / span > < span class = "p" > :< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > ReadCSV< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > :< / span >
< / span > < span id = "L-256" > < a href = "#L-256" > < span class = "linenos" > 256< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-257" > < a href = "#L-257" > < span class = "linenos" > 257< / span > < / a > < span class = "sd" > Returns a csv reader given the expression `READ_CSV(name, [' delimiter' , ' |' , ...])`.< / span >
< / span > < span id = "L-258" > < a href = "#L-258" > < span class = "linenos" > 258< / span > < / a >
< / span > < span id = "L-259" > < a href = "#L-259" > < span class = "linenos" > 259< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-260" > < a href = "#L-260" > < span class = "linenos" > 260< / span > < / a > < span class = "sd" > read_csv: a `ReadCSV` function call< / span >
< / span > < span id = "L-261" > < a href = "#L-261" > < span class = "linenos" > 261< / span > < / a >
< / span > < span id = "L-262" > < a href = "#L-262" > < span class = "linenos" > 262< / span > < / a > < span class = "sd" > Yields:< / span >
< / span > < span id = "L-263" > < a href = "#L-263" > < span class = "linenos" > 263< / span > < / a > < span class = "sd" > A python csv reader.< / span >
< / span > < span id = "L-264" > < a href = "#L-264" > < span class = "linenos" > 264< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-265" > < a href = "#L-265" > < span class = "linenos" > 265< / span > < / a > < span class = "n" > args< / span > < span class = "o" > =< / span > < span class = "n" > read_csv< / span > < span class = "o" > .< / span > < span class = "n" > expressions< / span >
< / span > < span id = "L-266" > < a href = "#L-266" > < span class = "linenos" > 266< / span > < / a > < span class = "n" > file< / span > < span class = "o" > =< / span > < span class = "n" > open_file< / span > < span class = "p" > (< / span > < span class = "n" > read_csv< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< / span > < span id = "L-267" > < a href = "#L-267" > < span class = "linenos" > 267< / span > < / a >
< / span > < span id = "L-268" > < a href = "#L-268" > < span class = "linenos" > 268< / span > < / a > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "s2" > " ," < / span >
< / span > < span id = "L-269" > < a href = "#L-269" > < span class = "linenos" > 269< / span > < / a > < span class = "n" > args< / span > < span class = "o" > =< / span > < span class = "nb" > iter< / span > < span class = "p" > (< / span > < span class = "n" > arg< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "k" > for< / span > < span class = "n" > arg< / span > < span class = "ow" > in< / span > < span class = "n" > args< / span > < span class = "p" > )< / span >
< / span > < span id = "L-270" > < a href = "#L-270" > < span class = "linenos" > 270< / span > < / a > < span class = "k" > for< / span > < span class = "n" > k< / span > < span class = "p" > ,< / span > < span class = "n" > v< / span > < span class = "ow" > in< / span > < span class = "nb" > zip< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "n" > args< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-271" > < a href = "#L-271" > < span class = "linenos" > 271< / span > < / a > < span class = "k" > if< / span > < span class = "n" > k< / span > < span class = "o" > ==< / span > < span class = "s2" > " delimiter" < / span > < span class = "p" > :< / span >
< / span > < span id = "L-272" > < a href = "#L-272" > < span class = "linenos" > 272< / span > < / a > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "n" > v< / span >
< / span > < span id = "L-273" > < a href = "#L-273" > < span class = "linenos" > 273< / span > < / a >
< / span > < span id = "L-274" > < a href = "#L-274" > < span class = "linenos" > 274< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "L-275" > < a href = "#L-275" > < span class = "linenos" > 275< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > csv< / span > < span class = "k" > as< / span > < span class = "nn" > csv_< / span >
< / span > < span id = "L-276" > < a href = "#L-276" > < span class = "linenos" > 276< / span > < / a >
< / span > < span id = "L-277" > < a href = "#L-277" > < span class = "linenos" > 277< / span > < / a > < span class = "k" > yield< / span > < span class = "n" > csv_< / span > < span class = "o" > .< / span > < span class = "n" > reader< / span > < span class = "p" > (< / span > < span class = "n" > file< / span > < span class = "p" > ,< / span > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "n" > delimiter< / span > < span class = "p" > )< / span >
< / span > < span id = "L-278" > < a href = "#L-278" > < span class = "linenos" > 278< / span > < / a > < span class = "k" > finally< / span > < span class = "p" > :< / span >
< / span > < span id = "L-279" > < a href = "#L-279" > < span class = "linenos" > 279< / span > < / a > < span class = "n" > file< / span > < span class = "o" > .< / span > < span class = "n" > close< / span > < span class = "p" > ()< / span >
< / span > < span id = "L-280" > < a href = "#L-280" > < span class = "linenos" > 280< / span > < / a >
< / span > < span id = "L-281" > < a href = "#L-281" > < span class = "linenos" > 281< / span > < / a >
< / span > < span id = "L-282" > < a href = "#L-282" > < span class = "linenos" > 282< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > find_new_name< / span > < span class = "p" > (< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ],< / span > < span class = "n" > base< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "L-283" > < a href = "#L-283" > < span class = "linenos" > 283< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-284" > < a href = "#L-284" > < span class = "linenos" > 284< / span > < / a > < span class = "sd" > Searches for a new name.< / span >
< / span > < span id = "L-285" > < a href = "#L-285" > < span class = "linenos" > 285< / span > < / a >
< / span > < span id = "L-286" > < a href = "#L-286" > < span class = "linenos" > 286< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-287" > < a href = "#L-287" > < span class = "linenos" > 287< / span > < / a > < span class = "sd" > taken: a collection of taken names.< / span >
< / span > < span id = "L-288" > < a href = "#L-288" > < span class = "linenos" > 288< / span > < / a > < span class = "sd" > base: base name to alter.< / span >
< / span > < span id = "L-289" > < a href = "#L-289" > < span class = "linenos" > 289< / span > < / a >
< / span > < span id = "L-290" > < a href = "#L-290" > < span class = "linenos" > 290< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-291" > < a href = "#L-291" > < span class = "linenos" > 291< / span > < / a > < span class = "sd" > The new, available name.< / span >
< / span > < span id = "L-292" > < a href = "#L-292" > < span class = "linenos" > 292< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-293" > < a href = "#L-293" > < span class = "linenos" > 293< / span > < / a > < span class = "k" > if< / span > < span class = "n" > base< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span >
< / span > < span id = "L-294" > < a href = "#L-294" > < span class = "linenos" > 294< / span > < / a > < span class = "k" > return< / span > < span class = "n" > base< / span >
< / span > < span id = "L-295" > < a href = "#L-295" > < span class = "linenos" > 295< / span > < / a >
< / span > < span id = "L-296" > < a href = "#L-296" > < span class = "linenos" > 296< / span > < / a > < span class = "n" > i< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span >
< / span > < span id = "L-297" > < a href = "#L-297" > < span class = "linenos" > 297< / span > < / a > < span class = "n" > new< / span > < span class = "o" > =< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "n" > base< / span > < span class = "si" > }< / span > < span class = "s2" > _< / span > < span class = "si" > {< / span > < span class = "n" > i< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span >
< / span > < span id = "L-298" > < a href = "#L-298" > < span class = "linenos" > 298< / span > < / a > < span class = "k" > while< / span > < span class = "n" > new< / span > < span class = "ow" > in< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span >
< / span > < span id = "L-299" > < a href = "#L-299" > < span class = "linenos" > 299< / span > < / a > < span class = "n" > i< / span > < span class = "o" > +=< / span > < span class = "mi" > 1< / span >
< / span > < span id = "L-300" > < a href = "#L-300" > < span class = "linenos" > 300< / span > < / a > < span class = "n" > new< / span > < span class = "o" > =< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "n" > base< / span > < span class = "si" > }< / span > < span class = "s2" > _< / span > < span class = "si" > {< / span > < span class = "n" > i< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span >
< / span > < span id = "L-301" > < a href = "#L-301" > < span class = "linenos" > 301< / span > < / a >
< / span > < span id = "L-302" > < a href = "#L-302" > < span class = "linenos" > 302< / span > < / a > < span class = "k" > return< / span > < span class = "n" > new< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-303" > < a href = "#L-303" > < span class = "linenos" > 303< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-304" > < a href = "#L-304" > < span class = "linenos" > 304< / span > < / a >
< / span > < span id = "L-305" > < a href = "#L-305" > < span class = "linenos" > 305< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > object_to_dict< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > :< / span >
< / span > < span id = "L-306" > < a href = "#L-306" > < span class = "linenos" > 306< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns a dictionary created from an object' s attributes." " " < / span >
< / span > < span id = "L-307" > < a href = "#L-307" > < span class = "linenos" > 307< / span > < / a > < span class = "k" > return< / span > < span class = "p" > {< / span > < span class = "o" > **< / span > < span class = "p" > {< / span > < span class = "n" > k< / span > < span class = "p" > :< / span > < span class = "n" > copy< / span > < span class = "p" > (< / span > < span class = "n" > v< / span > < span class = "p" > )< / span > < span class = "k" > for< / span > < span class = "n" > k< / span > < span class = "p" > ,< / span > < span class = "n" > v< / span > < span class = "ow" > in< / span > < span class = "nb" > vars< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > copy< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > items< / span > < span class = "p" > ()},< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > }< / span >
< / span > < span id = "L-308" > < a href = "#L-308" > < span class = "linenos" > 308< / span > < / a >
< / span > < span id = "L-309" > < a href = "#L-309" > < span class = "linenos" > 309< / span > < / a >
< / span > < span id = "L-310" > < a href = "#L-310" > < span class = "linenos" > 310< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > split_num_words< / span > < span class = "p" > (< / span >
< / span > < span id = "L-311" > < a href = "#L-311" > < span class = "linenos" > 311< / span > < / a > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > min_num_words< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > ,< / span > < span class = "n" > fill_from_start< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< / span > < span id = "L-312" > < a href = "#L-312" > < span class = "linenos" > 312< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]]:< / span >
< / span > < span id = "L-313" > < a href = "#L-313" > < span class = "linenos" > 313< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-314" > < a href = "#L-314" > < span class = "linenos" > 314< / span > < / a > < span class = "sd" > Perform a split on a value and return N words as a result with `None` used for words that don' t exist.< / span >
< / span > < span id = "L-315" > < a href = "#L-315" > < span class = "linenos" > 315< / span > < / a >
< / span > < span id = "L-316" > < a href = "#L-316" > < span class = "linenos" > 316< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-317" > < a href = "#L-317" > < span class = "linenos" > 317< / span > < / a > < span class = "sd" > value: the value to be split.< / span >
< / span > < span id = "L-318" > < a href = "#L-318" > < span class = "linenos" > 318< / span > < / a > < span class = "sd" > sep: the value to use to split on.< / span >
< / span > < span id = "L-319" > < a href = "#L-319" > < span class = "linenos" > 319< / span > < / a > < span class = "sd" > min_num_words: the minimum number of words that are going to be in the result.< / span >
< / span > < span id = "L-320" > < a href = "#L-320" > < span class = "linenos" > 320< / span > < / a > < span class = "sd" > fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.< / span >
< / span > < span id = "L-321" > < a href = "#L-321" > < span class = "linenos" > 321< / span > < / a >
< / span > < span id = "L-322" > < a href = "#L-322" > < span class = "linenos" > 322< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "L-323" > < a href = "#L-323" > < span class = "linenos" > 323< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 3)< / span >
< / span > < span id = "L-324" > < a href = "#L-324" > < span class = "linenos" > 324< / span > < / a > < span class = "sd" > [None, ' db' , ' table' ]< / span >
< / span > < span id = "L-325" > < a href = "#L-325" > < span class = "linenos" > 325< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 3, fill_from_start=False)< / span >
< / span > < span id = "L-326" > < a href = "#L-326" > < span class = "linenos" > 326< / span > < / a > < span class = "sd" > [' db' , ' table' , None]< / span >
< / span > < span id = "L-327" > < a href = "#L-327" > < span class = "linenos" > 327< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 1)< / span >
< / span > < span id = "L-328" > < a href = "#L-328" > < span class = "linenos" > 328< / span > < / a > < span class = "sd" > [' db' , ' table' ]< / span >
< / span > < span id = "L-329" > < a href = "#L-329" > < span class = "linenos" > 329< / span > < / a >
< / span > < span id = "L-330" > < a href = "#L-330" > < span class = "linenos" > 330< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-331" > < a href = "#L-331" > < span class = "linenos" > 331< / span > < / a > < span class = "sd" > The list of words returned by `split`, possibly augmented by a number of `None` values.< / span >
< / span > < span id = "L-332" > < a href = "#L-332" > < span class = "linenos" > 332< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-333" > < a href = "#L-333" > < span class = "linenos" > 333< / span > < / a > < span class = "n" > words< / span > < span class = "o" > =< / span > < span class = "n" > value< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "n" > sep< / span > < span class = "p" > )< / span >
< / span > < span id = "L-334" > < a href = "#L-334" > < span class = "linenos" > 334< / span > < / a > < span class = "k" > if< / span > < span class = "n" > fill_from_start< / span > < span class = "p" > :< / span >
< / span > < span id = "L-335" > < a href = "#L-335" > < span class = "linenos" > 335< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "kc" > None< / span > < span class = "p" > ]< / span > < span class = "o" > *< / span > < span class = "p" > (< / span > < span class = "n" > min_num_words< / span > < span class = "o" > -< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > words< / span > < span class = "p" > ))< / span > < span class = "o" > +< / span > < span class = "n" > words< / span >
< / span > < span id = "L-336" > < a href = "#L-336" > < span class = "linenos" > 336< / span > < / a > < span class = "k" > return< / span > < span class = "n" > words< / span > < span class = "o" > +< / span > < span class = "p" > [< / span > < span class = "kc" > None< / span > < span class = "p" > ]< / span > < span class = "o" > *< / span > < span class = "p" > (< / span > < span class = "n" > min_num_words< / span > < span class = "o" > -< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > words< / span > < span class = "p" > ))< / span >
< / span > < span id = "L-337" > < a href = "#L-337" > < span class = "linenos" > 337< / span > < / a >
< / span > < span id = "L-338" > < a href = "#L-338" > < span class = "linenos" > 338< / span > < / a >
< / span > < span id = "L-339" > < a href = "#L-339" > < span class = "linenos" > 339< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > is_iterable< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > bool< / span > < span class = "p" > :< / span >
< / span > < span id = "L-340" > < a href = "#L-340" > < span class = "linenos" > 340< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-341" > < a href = "#L-341" > < span class = "linenos" > 341< / span > < / a > < span class = "sd" > Checks if the value is an iterable, excluding the types `str` and `bytes`.< / span >
< / span > < span id = "L-342" > < a href = "#L-342" > < span class = "linenos" > 342< / span > < / a >
< / span > < span id = "L-343" > < a href = "#L-343" > < span class = "linenos" > 343< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "L-344" > < a href = "#L-344" > < span class = "linenos" > 344< / span > < / a > < span class = "sd" > > > > is_iterable([1,2])< / span >
< / span > < span id = "L-345" > < a href = "#L-345" > < span class = "linenos" > 345< / span > < / a > < span class = "sd" > True< / span >
< / span > < span id = "L-346" > < a href = "#L-346" > < span class = "linenos" > 346< / span > < / a > < span class = "sd" > > > > is_iterable(" test" )< / span >
< / span > < span id = "L-347" > < a href = "#L-347" > < span class = "linenos" > 347< / span > < / a > < span class = "sd" > False< / span >
< / span > < span id = "L-348" > < a href = "#L-348" > < span class = "linenos" > 348< / span > < / a >
< / span > < span id = "L-349" > < a href = "#L-349" > < span class = "linenos" > 349< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-350" > < a href = "#L-350" > < span class = "linenos" > 350< / span > < / a > < span class = "sd" > value: the value to check if it is an iterable.< / span >
< / span > < span id = "L-351" > < a href = "#L-351" > < span class = "linenos" > 351< / span > < / a >
< / span > < span id = "L-352" > < a href = "#L-352" > < span class = "linenos" > 352< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-353" > < a href = "#L-353" > < span class = "linenos" > 353< / span > < / a > < span class = "sd" > A `bool` value indicating if it is an iterable.< / span >
< / span > < span id = "L-354" > < a href = "#L-354" > < span class = "linenos" > 354< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-355" > < a href = "#L-355" > < span class = "linenos" > 355< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > hasattr< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "s2" > " __iter__" < / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ))< / span >
< / span > < span id = "L-356" > < a href = "#L-356" > < span class = "linenos" > 356< / span > < / a >
< / span > < span id = "L-357" > < a href = "#L-357" > < span class = "linenos" > 357< / span > < / a >
< / span > < span id = "L-358" > < a href = "#L-358" > < span class = "linenos" > 358< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > flatten< / span > < span class = "p" > (< / span > < span class = "n" > values< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ]< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterator< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ]:< / span >
< / span > < span id = "L-359" > < a href = "#L-359" > < span class = "linenos" > 359< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-360" > < a href = "#L-360" > < span class = "linenos" > 360< / span > < / a > < span class = "sd" > Flattens an iterable that can contain both iterable and non-iterable elements. Objects of< / span >
< / span > < span id = "L-361" > < a href = "#L-361" > < span class = "linenos" > 361< / span > < / a > < span class = "sd" > type `str` and `bytes` are not regarded as iterables.< / span >
< / span > < span id = "L-362" > < a href = "#L-362" > < span class = "linenos" > 362< / span > < / a >
< / span > < span id = "L-363" > < a href = "#L-363" > < span class = "linenos" > 363< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "L-364" > < a href = "#L-364" > < span class = "linenos" > 364< / span > < / a > < span class = "sd" > > > > list(flatten([[1, 2], 3, {4}, (5, " bla" )]))< / span >
< / span > < span id = "L-365" > < a href = "#L-365" > < span class = "linenos" > 365< / span > < / a > < span class = "sd" > [1, 2, 3, 4, 5, ' bla' ]< / span >
< / span > < span id = "L-366" > < a href = "#L-366" > < span class = "linenos" > 366< / span > < / a > < span class = "sd" > > > > list(flatten([1, 2, 3]))< / span >
< / span > < span id = "L-367" > < a href = "#L-367" > < span class = "linenos" > 367< / span > < / a > < span class = "sd" > [1, 2, 3]< / span >
< / span > < span id = "L-368" > < a href = "#L-368" > < span class = "linenos" > 368< / span > < / a >
< / span > < span id = "L-369" > < a href = "#L-369" > < span class = "linenos" > 369< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-370" > < a href = "#L-370" > < span class = "linenos" > 370< / span > < / a > < span class = "sd" > values: the value to be flattened.< / span >
< / span > < span id = "L-371" > < a href = "#L-371" > < span class = "linenos" > 371< / span > < / a >
< / span > < span id = "L-372" > < a href = "#L-372" > < span class = "linenos" > 372< / span > < / a > < span class = "sd" > Yields:< / span >
< / span > < span id = "L-373" > < a href = "#L-373" > < span class = "linenos" > 373< / span > < / a > < span class = "sd" > Non-iterable elements in `values`.< / span >
< / span > < span id = "L-374" > < a href = "#L-374" > < span class = "linenos" > 374< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-375" > < a href = "#L-375" > < span class = "linenos" > 375< / span > < / a > < span class = "k" > for< / span > < span class = "n" > value< / span > < span class = "ow" > in< / span > < span class = "n" > values< / span > < span class = "p" > :< / span >
< / span > < span id = "L-376" > < a href = "#L-376" > < span class = "linenos" > 376< / span > < / a > < span class = "k" > if< / span > < span class = "n" > is_iterable< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "L-377" > < a href = "#L-377" > < span class = "linenos" > 377< / span > < / a > < span class = "k" > yield from< / span > < span class = "n" > flatten< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< / span > < span id = "L-378" > < a href = "#L-378" > < span class = "linenos" > 378< / span > < / a > < span class = "k" > else< / span > < span class = "p" > :< / span >
< / span > < span id = "L-379" > < a href = "#L-379" > < span class = "linenos" > 379< / span > < / a > < span class = "k" > yield< / span > < span class = "n" > value< / span >
< / span > < span id = "L-380" > < a href = "#L-380" > < span class = "linenos" > 380< / span > < / a >
< / span > < span id = "L-381" > < a href = "#L-381" > < span class = "linenos" > 381< / span > < / a >
< / span > < span id = "L-382" > < a href = "#L-382" > < span class = "linenos" > 382< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > dict_depth< / span > < span class = "p" > (< / span > < span class = "n" > d< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > int< / span > < span class = "p" > :< / span >
< / span > < span id = "L-383" > < a href = "#L-383" > < span class = "linenos" > 383< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "L-384" > < a href = "#L-384" > < span class = "linenos" > 384< / span > < / a > < span class = "sd" > Get the nesting depth of a dictionary.< / span >
< / span > < span id = "L-385" > < a href = "#L-385" > < span class = "linenos" > 385< / span > < / a >
< / span > < span id = "L-386" > < a href = "#L-386" > < span class = "linenos" > 386< / span > < / a > < span class = "sd" > For example:< / span >
< / span > < span id = "L-387" > < a href = "#L-387" > < span class = "linenos" > 387< / span > < / a > < span class = "sd" > > > > dict_depth(None)< / span >
< / span > < span id = "L-388" > < a href = "#L-388" > < span class = "linenos" > 388< / span > < / a > < span class = "sd" > 0< / span >
< / span > < span id = "L-389" > < a href = "#L-389" > < span class = "linenos" > 389< / span > < / a > < span class = "sd" > > > > dict_depth({})< / span >
< / span > < span id = "L-390" > < a href = "#L-390" > < span class = "linenos" > 390< / span > < / a > < span class = "sd" > 1< / span >
< / span > < span id = "L-391" > < a href = "#L-391" > < span class = "linenos" > 391< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : " b" })< / span >
< / span > < span id = "L-392" > < a href = "#L-392" > < span class = "linenos" > 392< / span > < / a > < span class = "sd" > 1< / span >
< / span > < span id = "L-393" > < a href = "#L-393" > < span class = "linenos" > 393< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : {}})< / span >
< / span > < span id = "L-394" > < a href = "#L-394" > < span class = "linenos" > 394< / span > < / a > < span class = "sd" > 2< / span >
< / span > < span id = "L-395" > < a href = "#L-395" > < span class = "linenos" > 395< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : {" b" : {}}})< / span >
< / span > < span id = "L-396" > < a href = "#L-396" > < span class = "linenos" > 396< / span > < / a > < span class = "sd" > 3< / span >
< / span > < span id = "L-397" > < a href = "#L-397" > < span class = "linenos" > 397< / span > < / a >
< / span > < span id = "L-398" > < a href = "#L-398" > < span class = "linenos" > 398< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-399" > < a href = "#L-399" > < span class = "linenos" > 399< / span > < / a > < span class = "sd" > d (dict): dictionary< / span >
< / span > < span id = "L-400" > < a href = "#L-400" > < span class = "linenos" > 400< / span > < / a >
< / span > < span id = "L-401" > < a href = "#L-401" > < span class = "linenos" > 401< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-402" > < a href = "#L-402" > < span class = "linenos" > 402< / span > < / a > < span class = "sd" > int: depth< / span >
< / span > < span id = "L-403" > < a href = "#L-403" > < span class = "linenos" > 403< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-404" > < a href = "#L-404" > < span class = "linenos" > 404< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "L-405" > < a href = "#L-405" > < span class = "linenos" > 405< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 1< / span > < span class = "o" > +< / span > < span class = "n" > dict_depth< / span > < span class = "p" > (< / span > < span class = "nb" > next< / span > < span class = "p" > (< / span > < span class = "nb" > iter< / span > < span class = "p" > (< / span > < span class = "n" > d< / span > < span class = "o" > .< / span > < span class = "n" > values< / span > < span class = "p" > ())))< / span >
< / span > < span id = "L-406" > < a href = "#L-406" > < span class = "linenos" > 406< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > AttributeError< / span > < span class = "p" > :< / span >
< / span > < span id = "L-407" > < a href = "#L-407" > < span class = "linenos" > 407< / span > < / a > < span class = "c1" > # d doesn' t have attribute " values" < / span >
< / span > < span id = "L-408" > < a href = "#L-408" > < span class = "linenos" > 408< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 0< / span >
< / span > < span id = "L-409" > < a href = "#L-409" > < span class = "linenos" > 409< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > StopIteration< / span > < span class = "p" > :< / span >
< / span > < span id = "L-410" > < a href = "#L-410" > < span class = "linenos" > 410< / span > < / a > < span class = "c1" > # d.values() returns an empty sequence< / span >
< / span > < span id = "L-411" > < a href = "#L-411" > < span class = "linenos" > 411< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 1< / span >
< / span > < span id = "L-412" > < a href = "#L-412" > < span class = "linenos" > 412< / span > < / a >
< / span > < span id = "L-413" > < a href = "#L-413" > < span class = "linenos" > 413< / span > < / a >
< / span > < span id = "L-414" > < a href = "#L-414" > < span class = "linenos" > 414< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > first< / span > < span class = "p" > (< / span > < span class = "n" > it< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > T< / span > < span class = "p" > :< / span >
< / span > < span id = "L-415" > < a href = "#L-415" > < span class = "linenos" > 415< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns the first element from an iterable.< / span >
< / span > < span id = "L-416" > < a href = "#L-416" > < span class = "linenos" > 416< / span > < / a >
< / span > < span id = "L-417" > < a href = "#L-417" > < span class = "linenos" > 417< / span > < / a > < span class = "sd" > Useful for sets.< / span >
< / span > < span id = "L-418" > < a href = "#L-418" > < span class = "linenos" > 418< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-419" > < a href = "#L-419" > < span class = "linenos" > 419< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > next< / span > < span class = "p" > (< / span > < span class = "n" > i< / span > < span class = "k" > for< / span > < span class = "n" > i< / span > < span class = "ow" > in< / span > < span class = "n" > it< / span > < span class = "p" > )< / span >
< / span > < span id = "L-420" > < a href = "#L-420" > < span class = "linenos" > 420< / span > < / a >
< / span > < span id = "L-421" > < a href = "#L-421" > < span class = "linenos" > 421< / span > < / a >
< / span > < span id = "L-422" > < a href = "#L-422" > < span class = "linenos" > 422< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > should_identify< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > identify< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > |< / span > < span class = "nb" > bool< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > bool< / span > < span class = "p" > :< / span >
< / span > < span id = "L-423" > < a href = "#L-423" > < span class = "linenos" > 423< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Checks if text should be identified given an identify option.< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "L-424" > < a href = "#L-424" > < span class = "linenos" > 424< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "L-425" > < a href = "#L-425" > < span class = "linenos" > 425< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "L-426" > < a href = "#L-426" > < span class = "linenos" > 426< / span > < / a > < span class = "sd" > text: the text to check.< / span >
< / span > < span id = "L-427" > < a href = "#L-427" > < span class = "linenos" > 427< / span > < / a > < span class = "sd" > identify: " always" | True - always returns true, " safe" - true if no upper case< / span >
< / span > < span id = "L-428" > < a href = "#L-428" > < span class = "linenos" > 428< / span > < / a >
< / span > < span id = "L-429" > < a href = "#L-429" > < span class = "linenos" > 429< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "L-430" > < a href = "#L-430" > < span class = "linenos" > 430< / span > < / a > < span class = "sd" > Whether or not a string should be identified.< / span >
< / span > < span id = "L-431" > < a href = "#L-431" > < span class = "linenos" > 431< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "L-432" > < a href = "#L-432" > < span class = "linenos" > 432< / span > < / a > < span class = "k" > if< / span > < span class = "n" > identify< / span > < span class = "ow" > is< / span > < span class = "kc" > True< / span > < span class = "ow" > or< / span > < span class = "n" > identify< / span > < span class = "o" > ==< / span > < span class = "s2" > " always" < / span > < span class = "p" > :< / span >
< / span > < span id = "L-433" > < a href = "#L-433" > < span class = "linenos" > 433< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > True< / span >
< / span > < span id = "L-434" > < a href = "#L-434" > < span class = "linenos" > 434< / span > < / a > < span class = "k" > if< / span > < span class = "n" > identify< / span > < span class = "o" > ==< / span > < span class = "s2" > " safe" < / span > < span class = "p" > :< / span >
< / span > < span id = "L-435" > < a href = "#L-435" > < span class = "linenos" > 435< / span > < / a > < span class = "k" > return< / span > < span class = "ow" > not< / span > < span class = "nb" > any< / span > < span class = "p" > (< / span > < span class = "n" > char< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ()< / span > < span class = "k" > for< / span > < span class = "n" > char< / span > < span class = "ow" > in< / span > < span class = "n" > text< / span > < span class = "p" > )< / span >
< / span > < span id = "L-436" > < a href = "#L-436" > < span class = "linenos" > 436< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > False< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< / section >
< section id = "AutoName" >
< input id = "AutoName-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr class" >
< span class = "def" > class< / span >
< span class = "name" > AutoName< / span > < wbr > (< span class = "base" > enum.Enum< / span > ):
< label class = "view-source-button" for = "AutoName-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#AutoName" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "AutoName-24" > < a href = "#AutoName-24" > < span class = "linenos" > 24< / span > < / a > < span class = "k" > class< / span > < span class = "nc" > AutoName< / span > < span class = "p" > (< / span > < span class = "n" > Enum< / span > < span class = "p" > ):< / span >
< / span > < span id = "AutoName-25" > < a href = "#AutoName-25" > < span class = "linenos" > 25< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " This is used for creating enum classes where `auto()` is the string form of the corresponding value' s name." " " < / span >
< / span > < span id = "AutoName-26" > < a href = "#AutoName-26" > < span class = "linenos" > 26< / span > < / a >
< / span > < span id = "AutoName-27" > < a href = "#AutoName-27" > < span class = "linenos" > 27< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > _generate_next_value_< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > _start< / span > < span class = "p" > ,< / span > < span class = "n" > _count< / span > < span class = "p" > ,< / span > < span class = "n" > _last_values< / span > < span class = "p" > ):< / span >
< / span > < span id = "AutoName-28" > < a href = "#AutoName-28" > < span class = "linenos" > 28< / span > < / a > < span class = "k" > return< / span > < span class = "n" > name< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > This is used for creating enum classes where < code > auto()< / code > is the string form of the corresponding value's name.< / p >
< / div >
< div class = "inherited" >
< h5 > Inherited Members< / h5 >
< dl >
< div > < dt > enum.Enum< / dt >
< dd id = "AutoName.name" class = "variable" > name< / dd >
< dd id = "AutoName.value" class = "variable" > value< / dd >
< / div >
< / dl >
< / div >
< / section >
< section id = "seq_get" >
< input id = "seq_get-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > seq_get< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > seq< / span > < span class = "p" > :< / span > < span class = "n" > Sequence< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ]< / span > , < / span > < span class = "param" > < span class = "n" > index< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ]< / span > :< / span > < / span >
< label class = "view-source-button" for = "seq_get-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#seq_get" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "seq_get-31" > < a href = "#seq_get-31" > < span class = "linenos" > 31< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > seq_get< / span > < span class = "p" > (< / span > < span class = "n" > seq< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Sequence< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ],< / span > < span class = "n" > index< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "seq_get-32" > < a href = "#seq_get-32" > < span class = "linenos" > 32< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns the value in `seq` at position `index`, or `None` if `index` is out of bounds." " " < / span >
< / span > < span id = "seq_get-33" > < a href = "#seq_get-33" > < span class = "linenos" > 33< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "seq_get-34" > < a href = "#seq_get-34" > < span class = "linenos" > 34< / span > < / a > < span class = "k" > return< / span > < span class = "n" > seq< / span > < span class = "p" > [< / span > < span class = "n" > index< / span > < span class = "p" > ]< / span >
< / span > < span id = "seq_get-35" > < a href = "#seq_get-35" > < span class = "linenos" > 35< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > IndexError< / span > < span class = "p" > :< / span >
< / span > < span id = "seq_get-36" > < a href = "#seq_get-36" > < span class = "linenos" > 36< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > None< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Returns the value in < code > seq< / code > at position < code > index< / code > , or < code > None< / code > if < code > index< / code > is out of bounds.< / p >
< / div >
< / section >
< section id = "ensure_list" >
< input id = "ensure_list-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > ensure_list< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > value< / span > < / span > < span class = "return-annotation" > ):< / span > < / span >
< label class = "view-source-button" for = "ensure_list-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#ensure_list" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "ensure_list-49" > < a href = "#ensure_list-49" > < span class = "linenos" > 49< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "ensure_list-50" > < a href = "#ensure_list-50" > < span class = "linenos" > 50< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "ensure_list-51" > < a href = "#ensure_list-51" > < span class = "linenos" > 51< / span > < / a > < span class = "sd" > Ensures that a value is a list, otherwise casts or wraps it into one.< / span >
< / span > < span id = "ensure_list-52" > < a href = "#ensure_list-52" > < span class = "linenos" > 52< / span > < / a >
< / span > < span id = "ensure_list-53" > < a href = "#ensure_list-53" > < span class = "linenos" > 53< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "ensure_list-54" > < a href = "#ensure_list-54" > < span class = "linenos" > 54< / span > < / a > < span class = "sd" > value: the value of interest.< / span >
< / span > < span id = "ensure_list-55" > < a href = "#ensure_list-55" > < span class = "linenos" > 55< / span > < / a >
< / span > < span id = "ensure_list-56" > < a href = "#ensure_list-56" > < span class = "linenos" > 56< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "ensure_list-57" > < a href = "#ensure_list-57" > < span class = "linenos" > 57< / span > < / a > < span class = "sd" > The value cast as a list if it' s a list or a tuple, or else the value wrapped in a list.< / span >
< / span > < span id = "ensure_list-58" > < a href = "#ensure_list-58" > < span class = "linenos" > 58< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "ensure_list-59" > < a href = "#ensure_list-59" > < span class = "linenos" > 59< / span > < / a > < span class = "k" > if< / span > < span class = "n" > value< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "ensure_list-60" > < a href = "#ensure_list-60" > < span class = "linenos" > 60< / span > < / a > < span class = "k" > return< / span > < span class = "p" > []< / span >
< / span > < span id = "ensure_list-61" > < a href = "#ensure_list-61" > < span class = "linenos" > 61< / span > < / a > < span class = "k" > if< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > list< / span > < span class = "p" > ,< / span > < span class = "nb" > tuple< / span > < span class = "p" > )):< / span >
< / span > < span id = "ensure_list-62" > < a href = "#ensure_list-62" > < span class = "linenos" > 62< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< / span > < span id = "ensure_list-63" > < a href = "#ensure_list-63" > < span class = "linenos" > 63< / span > < / a >
< / span > < span id = "ensure_list-64" > < a href = "#ensure_list-64" > < span class = "linenos" > 64< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > value< / span > < span class = "p" > ]< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Ensures that a value is a list, otherwise casts or wraps it into one.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > value:< / strong > the value of interest.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The value cast as a list if it's a list or a tuple, or else the value wrapped in a list.< / p >
< / blockquote >
< / div >
< / section >
< section id = "ensure_collection" >
< input id = "ensure_collection-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > ensure_collection< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > value< / span > < / span > < span class = "return-annotation" > ):< / span > < / span >
< label class = "view-source-button" for = "ensure_collection-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#ensure_collection" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "ensure_collection-77" > < a href = "#ensure_collection-77" > < span class = "linenos" > 77< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > ensure_collection< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "ensure_collection-78" > < a href = "#ensure_collection-78" > < span class = "linenos" > 78< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "ensure_collection-79" > < a href = "#ensure_collection-79" > < span class = "linenos" > 79< / span > < / a > < span class = "sd" > Ensures that a value is a collection (excluding `str` and `bytes`), otherwise wraps it into a list.< / span >
< / span > < span id = "ensure_collection-80" > < a href = "#ensure_collection-80" > < span class = "linenos" > 80< / span > < / a >
< / span > < span id = "ensure_collection-81" > < a href = "#ensure_collection-81" > < span class = "linenos" > 81< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "ensure_collection-82" > < a href = "#ensure_collection-82" > < span class = "linenos" > 82< / span > < / a > < span class = "sd" > value: the value of interest.< / span >
< / span > < span id = "ensure_collection-83" > < a href = "#ensure_collection-83" > < span class = "linenos" > 83< / span > < / a >
< / span > < span id = "ensure_collection-84" > < a href = "#ensure_collection-84" > < span class = "linenos" > 84< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "ensure_collection-85" > < a href = "#ensure_collection-85" > < span class = "linenos" > 85< / span > < / a > < span class = "sd" > The value if it' s a collection, or else the value wrapped in a list.< / span >
< / span > < span id = "ensure_collection-86" > < a href = "#ensure_collection-86" > < span class = "linenos" > 86< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "ensure_collection-87" > < a href = "#ensure_collection-87" > < span class = "linenos" > 87< / span > < / a > < span class = "k" > if< / span > < span class = "n" > value< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "ensure_collection-88" > < a href = "#ensure_collection-88" > < span class = "linenos" > 88< / span > < / a > < span class = "k" > return< / span > < span class = "p" > []< / span >
< / span > < span id = "ensure_collection-89" > < a href = "#ensure_collection-89" > < span class = "linenos" > 89< / span > < / a > < span class = "k" > return< / span > < span class = "p" > (< / span >
< / span > < span id = "ensure_collection-90" > < a href = "#ensure_collection-90" > < span class = "linenos" > 90< / span > < / a > < span class = "n" > value< / span > < span class = "k" > if< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "n" > Collection< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ))< / span > < span class = "k" > else< / span > < span class = "p" > [< / span > < span class = "n" > value< / span > < span class = "p" > ]< / span >
< / span > < span id = "ensure_collection-91" > < a href = "#ensure_collection-91" > < span class = "linenos" > 91< / span > < / a > < span class = "p" > )< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Ensures that a value is a collection (excluding < code > str< / code > and < code > bytes< / code > ), otherwise wraps it into a list.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > value:< / strong > the value of interest.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The value if it's a collection, or else the value wrapped in a list.< / p >
< / blockquote >
< / div >
< / section >
< section id = "csv" >
< input id = "csv-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
2025-02-13 15:57:23 +01:00
< span class = "name" > csv< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > , < / span > < span class = "param" > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s1" > ' , ' < / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > str< / span > :< / span > < / span >
2025-02-13 15:23:26 +01:00
< label class = "view-source-button" for = "csv-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#csv" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "csv-94" > < a href = "#csv-94" > < span class = "linenos" > 94< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > csv< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "s2" > " , " < / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "csv-95" > < a href = "#csv-95" > < span class = "linenos" > 95< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "csv-96" > < a href = "#csv-96" > < span class = "linenos" > 96< / span > < / a > < span class = "sd" > Formats any number of string arguments as CSV.< / span >
< / span > < span id = "csv-97" > < a href = "#csv-97" > < span class = "linenos" > 97< / span > < / a >
< / span > < span id = "csv-98" > < a href = "#csv-98" > < span class = "linenos" > 98< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "csv-99" > < a href = "#csv-99" > < span class = "linenos" > 99< / span > < / a > < span class = "sd" > args: the string arguments to format.< / span >
< / span > < span id = "csv-100" > < a href = "#csv-100" > < span class = "linenos" > 100< / span > < / a > < span class = "sd" > sep: the argument separator.< / span >
< / span > < span id = "csv-101" > < a href = "#csv-101" > < span class = "linenos" > 101< / span > < / a >
< / span > < span id = "csv-102" > < a href = "#csv-102" > < span class = "linenos" > 102< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "csv-103" > < a href = "#csv-103" > < span class = "linenos" > 103< / span > < / a > < span class = "sd" > The arguments formatted as a CSV string.< / span >
< / span > < span id = "csv-104" > < a href = "#csv-104" > < span class = "linenos" > 104< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "csv-105" > < a href = "#csv-105" > < span class = "linenos" > 105< / span > < / a > < span class = "k" > return< / span > < span class = "n" > sep< / span > < span class = "o" > .< / span > < span class = "n" > join< / span > < span class = "p" > (< / span > < span class = "n" > arg< / span > < span class = "k" > for< / span > < span class = "n" > arg< / span > < span class = "ow" > in< / span > < span class = "n" > args< / span > < span class = "k" > if< / span > < span class = "n" > arg< / span > < span class = "p" > )< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Formats any number of string arguments as CSV.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > args:< / strong > the string arguments to format.< / li >
< li > < strong > sep:< / strong > the argument separator.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The arguments formatted as a CSV string.< / p >
< / blockquote >
< / div >
< / section >
< section id = "subclasses" >
< input id = "subclasses-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > subclasses< / span > < span class = "signature pdoc-code multiline" > (< span class = "param" > < span class = "n" > module_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > ,< / span > < span class = "param" > < span class = "n" > classes< / span > < span class = "p" > :< / span > < span class = "n" > Union< / span > < span class = "p" > [< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ]]< / span > ,< / span > < span class = "param" > < span class = "n" > exclude< / span > < span class = "p" > :< / span > < span class = "n" > Union< / span > < span class = "p" > [< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ]]< / span > < span class = "o" > =< / span > < span class = "p" > ()< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Type< / span > < span class = "p" > ]< / span > :< / span > < / span >
< label class = "view-source-button" for = "subclasses-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#subclasses" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "subclasses-108" > < a href = "#subclasses-108" > < span class = "linenos" > 108< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > subclasses< / span > < span class = "p" > (< / span >
< / span > < span id = "subclasses-109" > < a href = "#subclasses-109" > < span class = "linenos" > 109< / span > < / a > < span class = "n" > module_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span >
< / span > < span id = "subclasses-110" > < a href = "#subclasses-110" > < span class = "linenos" > 110< / span > < / a > < span class = "n" > classes< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ],< / span >
< / span > < span id = "subclasses-111" > < a href = "#subclasses-111" > < span class = "linenos" > 111< / span > < / a > < span class = "n" > exclude< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ,< / span > < span class = "o" > ...< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > (),< / span >
< / span > < span id = "subclasses-112" > < a href = "#subclasses-112" > < span class = "linenos" > 112< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "p" > ]:< / span >
< / span > < span id = "subclasses-113" > < a href = "#subclasses-113" > < span class = "linenos" > 113< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "subclasses-114" > < a href = "#subclasses-114" > < span class = "linenos" > 114< / span > < / a > < span class = "sd" > Returns all subclasses for a collection of classes, possibly excluding some of them.< / span >
< / span > < span id = "subclasses-115" > < a href = "#subclasses-115" > < span class = "linenos" > 115< / span > < / a >
< / span > < span id = "subclasses-116" > < a href = "#subclasses-116" > < span class = "linenos" > 116< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "subclasses-117" > < a href = "#subclasses-117" > < span class = "linenos" > 117< / span > < / a > < span class = "sd" > module_name: the name of the module to search for subclasses in.< / span >
< / span > < span id = "subclasses-118" > < a href = "#subclasses-118" > < span class = "linenos" > 118< / span > < / a > < span class = "sd" > classes: class(es) we want to find the subclasses of.< / span >
< / span > < span id = "subclasses-119" > < a href = "#subclasses-119" > < span class = "linenos" > 119< / span > < / a > < span class = "sd" > exclude: class(es) we want to exclude from the returned list.< / span >
< / span > < span id = "subclasses-120" > < a href = "#subclasses-120" > < span class = "linenos" > 120< / span > < / a >
< / span > < span id = "subclasses-121" > < a href = "#subclasses-121" > < span class = "linenos" > 121< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "subclasses-122" > < a href = "#subclasses-122" > < span class = "linenos" > 122< / span > < / a > < span class = "sd" > The target subclasses.< / span >
< / span > < span id = "subclasses-123" > < a href = "#subclasses-123" > < span class = "linenos" > 123< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "subclasses-124" > < a href = "#subclasses-124" > < span class = "linenos" > 124< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span >
< / span > < span id = "subclasses-125" > < a href = "#subclasses-125" > < span class = "linenos" > 125< / span > < / a > < span class = "n" > obj< / span >
< / span > < span id = "subclasses-126" > < a href = "#subclasses-126" > < span class = "linenos" > 126< / span > < / a > < span class = "k" > for< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > obj< / span > < span class = "ow" > in< / span > < span class = "n" > inspect< / span > < span class = "o" > .< / span > < span class = "n" > getmembers< / span > < span class = "p" > (< / span >
< / span > < span id = "subclasses-127" > < a href = "#subclasses-127" > < span class = "linenos" > 127< / span > < / a > < span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > modules< / span > < span class = "p" > [< / span > < span class = "n" > module_name< / span > < span class = "p" > ],< / span >
< / span > < span id = "subclasses-128" > < a href = "#subclasses-128" > < span class = "linenos" > 128< / span > < / a > < span class = "k" > lambda< / span > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > inspect< / span > < span class = "o" > .< / span > < span class = "n" > isclass< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "nb" > issubclass< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > ,< / span > < span class = "n" > classes< / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "n" > obj< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > exclude< / span > < span class = "p" > ,< / span >
< / span > < span id = "subclasses-129" > < a href = "#subclasses-129" > < span class = "linenos" > 129< / span > < / a > < span class = "p" > )< / span >
< / span > < span id = "subclasses-130" > < a href = "#subclasses-130" > < span class = "linenos" > 130< / span > < / a > < span class = "p" > ]< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Returns all subclasses for a collection of classes, possibly excluding some of them.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > module_name:< / strong > the name of the module to search for subclasses in.< / li >
< li > < strong > classes:< / strong > class(es) we want to find the subclasses of.< / li >
< li > < strong > exclude:< / strong > class(es) we want to exclude from the returned list.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The target subclasses.< / p >
< / blockquote >
< / div >
< / section >
< section id = "apply_index_offset" >
< input id = "apply_index_offset-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
2025-02-13 15:52:09 +01:00
< span class = "name" > apply_index_offset< / span > < span class = "signature pdoc-code multiline" > (< span class = "param" > < span class = "n" > this< / span > < span class = "p" > :< / span > < span class = "n" > < a href = "expressions.html#Expression" > sqlglot.expressions.Expression< / a > < / span > ,< / span > < span class = "param" > < span class = "n" > expressions< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > E< / span > < span class = "p" > ]]< / span > ,< / span > < span class = "param" > < span class = "n" > offset< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > E< / span > < span class = "p" > ]]< / span > :< / span > < / span >
2025-02-13 15:23:26 +01:00
< label class = "view-source-button" for = "apply_index_offset-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#apply_index_offset" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "apply_index_offset-133" > < a href = "#apply_index_offset-133" > < span class = "linenos" > 133< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > apply_index_offset< / span > < span class = "p" > (< / span >
< / span > < span id = "apply_index_offset-134" > < a href = "#apply_index_offset-134" > < span class = "linenos" > 134< / span > < / a > < span class = "n" > this< / span > < span class = "p" > :< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Expression< / span > < span class = "p" > ,< / span >
< / span > < span id = "apply_index_offset-135" > < a href = "#apply_index_offset-135" > < span class = "linenos" > 135< / span > < / a > < span class = "n" > expressions< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > E< / span > < span class = "p" > ]],< / span >
< / span > < span id = "apply_index_offset-136" > < a href = "#apply_index_offset-136" > < span class = "linenos" > 136< / span > < / a > < span class = "n" > offset< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > ,< / span >
< / span > < span id = "apply_index_offset-137" > < a href = "#apply_index_offset-137" > < span class = "linenos" > 137< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > E< / span > < span class = "p" > ]]:< / span >
< / span > < span id = "apply_index_offset-138" > < a href = "#apply_index_offset-138" > < span class = "linenos" > 138< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "apply_index_offset-139" > < a href = "#apply_index_offset-139" > < span class = "linenos" > 139< / span > < / a > < span class = "sd" > Applies an offset to a given integer literal expression.< / span >
< / span > < span id = "apply_index_offset-140" > < a href = "#apply_index_offset-140" > < span class = "linenos" > 140< / span > < / a >
< / span > < span id = "apply_index_offset-141" > < a href = "#apply_index_offset-141" > < span class = "linenos" > 141< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "apply_index_offset-142" > < a href = "#apply_index_offset-142" > < span class = "linenos" > 142< / span > < / a > < span class = "sd" > this: the target of the index< / span >
< / span > < span id = "apply_index_offset-143" > < a href = "#apply_index_offset-143" > < span class = "linenos" > 143< / span > < / a > < span class = "sd" > expressions: the expression the offset will be applied to, wrapped in a list.< / span >
< / span > < span id = "apply_index_offset-144" > < a href = "#apply_index_offset-144" > < span class = "linenos" > 144< / span > < / a > < span class = "sd" > offset: the offset that will be applied.< / span >
< / span > < span id = "apply_index_offset-145" > < a href = "#apply_index_offset-145" > < span class = "linenos" > 145< / span > < / a >
< / span > < span id = "apply_index_offset-146" > < a href = "#apply_index_offset-146" > < span class = "linenos" > 146< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "apply_index_offset-147" > < a href = "#apply_index_offset-147" > < span class = "linenos" > 147< / span > < / a > < span class = "sd" > The original expression with the offset applied to it, wrapped in a list. If the provided< / span >
< / span > < span id = "apply_index_offset-148" > < a href = "#apply_index_offset-148" > < span class = "linenos" > 148< / span > < / a > < span class = "sd" > `expressions` argument contains more than one expressions, it' s returned unaffected.< / span >
< / span > < span id = "apply_index_offset-149" > < a href = "#apply_index_offset-149" > < span class = "linenos" > 149< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "apply_index_offset-150" > < a href = "#apply_index_offset-150" > < span class = "linenos" > 150< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > offset< / span > < span class = "ow" > or< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > expressions< / span > < span class = "p" > )< / span > < span class = "o" > !=< / span > < span class = "mi" > 1< / span > < span class = "p" > :< / span >
< / span > < span id = "apply_index_offset-151" > < a href = "#apply_index_offset-151" > < span class = "linenos" > 151< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
< / span > < span id = "apply_index_offset-152" > < a href = "#apply_index_offset-152" > < span class = "linenos" > 152< / span > < / a >
< / span > < span id = "apply_index_offset-153" > < a href = "#apply_index_offset-153" > < span class = "linenos" > 153< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > expressions< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "apply_index_offset-154" > < a href = "#apply_index_offset-154" > < span class = "linenos" > 154< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "apply_index_offset-155" > < a href = "#apply_index_offset-155" > < span class = "linenos" > 155< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot< / span > < span class = "kn" > import< / span > < span class = "n" > exp< / span >
< / span > < span id = "apply_index_offset-156" > < a href = "#apply_index_offset-156" > < span class = "linenos" > 156< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot.optimizer.annotate_types< / span > < span class = "kn" > import< / span > < span class = "n" > annotate_types< / span >
< / span > < span id = "apply_index_offset-157" > < a href = "#apply_index_offset-157" > < span class = "linenos" > 157< / span > < / a > < span class = "kn" > from< / span > < span class = "nn" > sqlglot.optimizer.simplify< / span > < span class = "kn" > import< / span > < span class = "n" > simplify< / span >
< / span > < span id = "apply_index_offset-158" > < a href = "#apply_index_offset-158" > < span class = "linenos" > 158< / span > < / a >
< / span > < span id = "apply_index_offset-159" > < a href = "#apply_index_offset-159" > < span class = "linenos" > 159< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > this< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > :< / span >
< / span > < span id = "apply_index_offset-160" > < a href = "#apply_index_offset-160" > < span class = "linenos" > 160< / span > < / a > < span class = "n" > annotate_types< / span > < span class = "p" > (< / span > < span class = "n" > this< / span > < span class = "p" > )< / span >
< / span > < span id = "apply_index_offset-161" > < a href = "#apply_index_offset-161" > < span class = "linenos" > 161< / span > < / a >
< / span > < span id = "apply_index_offset-162" > < a href = "#apply_index_offset-162" > < span class = "linenos" > 162< / span > < / a > < span class = "k" > if< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > cast< / span > < span class = "p" > (< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "p" > ,< / span > < span class = "n" > this< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > this< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "p" > (< / span >
< / span > < span id = "apply_index_offset-163" > < a href = "#apply_index_offset-163" > < span class = "linenos" > 163< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > .< / span > < span class = "n" > UNKNOWN< / span > < span class = "p" > ,< / span >
< / span > < span id = "apply_index_offset-164" > < a href = "#apply_index_offset-164" > < span class = "linenos" > 164< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > Type< / span > < span class = "o" > .< / span > < span class = "n" > ARRAY< / span > < span class = "p" > ,< / span >
< / span > < span id = "apply_index_offset-165" > < a href = "#apply_index_offset-165" > < span class = "linenos" > 165< / span > < / a > < span class = "p" > ):< / span >
< / span > < span id = "apply_index_offset-166" > < a href = "#apply_index_offset-166" > < span class = "linenos" > 166< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
< / span > < span id = "apply_index_offset-167" > < a href = "#apply_index_offset-167" > < span class = "linenos" > 167< / span > < / a >
< / span > < span id = "apply_index_offset-168" > < a href = "#apply_index_offset-168" > < span class = "linenos" > 168< / span > < / a > < span class = "k" > if< / span > < span class = "n" > expression< / span > < span class = "p" > :< / span >
< / span > < span id = "apply_index_offset-169" > < a href = "#apply_index_offset-169" > < span class = "linenos" > 169< / span > < / a > < span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > :< / span >
< / span > < span id = "apply_index_offset-170" > < a href = "#apply_index_offset-170" > < span class = "linenos" > 170< / span > < / a > < span class = "n" > annotate_types< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "apply_index_offset-171" > < a href = "#apply_index_offset-171" > < span class = "linenos" > 171< / span > < / a > < span class = "k" > if< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > cast< / span > < span class = "p" > (< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "p" > ,< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > type< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > this< / span > < span class = "ow" > in< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > DataType< / span > < span class = "o" > .< / span > < span class = "n" > INTEGER_TYPES< / span > < span class = "p" > :< / span >
< / span > < span id = "apply_index_offset-172" > < a href = "#apply_index_offset-172" > < span class = "linenos" > 172< / span > < / a > < span class = "n" > logger< / span > < span class = "o" > .< / span > < span class = "n" > warning< / span > < span class = "p" > (< / span > < span class = "s2" > " Applying array index offset (< / span > < span class = "si" > %s< / span > < span class = "s2" > )" < / span > < span class = "p" > ,< / span > < span class = "n" > offset< / span > < span class = "p" > )< / span >
< / span > < span id = "apply_index_offset-173" > < a href = "#apply_index_offset-173" > < span class = "linenos" > 173< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > simplify< / span > < span class = "p" > (< / span >
< / span > < span id = "apply_index_offset-174" > < a href = "#apply_index_offset-174" > < span class = "linenos" > 174< / span > < / a > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Add< / span > < span class = "p" > (< / span > < span class = "n" > this< / span > < span class = "o" > =< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > copy< / span > < span class = "p" > (),< / span > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > Literal< / span > < span class = "o" > .< / span > < span class = "n" > number< / span > < span class = "p" > (< / span > < span class = "n" > offset< / span > < span class = "p" > ))< / span >
< / span > < span id = "apply_index_offset-175" > < a href = "#apply_index_offset-175" > < span class = "linenos" > 175< / span > < / a > < span class = "p" > )< / span >
< / span > < span id = "apply_index_offset-176" > < a href = "#apply_index_offset-176" > < span class = "linenos" > 176< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > expression< / span > < span class = "p" > ]< / span >
< / span > < span id = "apply_index_offset-177" > < a href = "#apply_index_offset-177" > < span class = "linenos" > 177< / span > < / a >
< / span > < span id = "apply_index_offset-178" > < a href = "#apply_index_offset-178" > < span class = "linenos" > 178< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expressions< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Applies an offset to a given integer literal expression.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
2025-02-13 15:52:09 +01:00
< li > < strong > this:< / strong > the target of the index< / li >
2025-02-13 15:23:26 +01:00
< li > < strong > expressions:< / strong > the expression the offset will be applied to, wrapped in a list.< / li >
< li > < strong > offset:< / strong > the offset that will be applied.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The original expression with the offset applied to it, wrapped in a list. If the provided
< code > expressions< / code > argument contains more than one expressions, it's returned unaffected.< / p >
< / blockquote >
< / div >
< / section >
< section id = "camel_to_snake_case" >
< input id = "camel_to_snake_case-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > camel_to_snake_case< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > str< / span > :< / span > < / span >
< label class = "view-source-button" for = "camel_to_snake_case-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#camel_to_snake_case" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "camel_to_snake_case-181" > < a href = "#camel_to_snake_case-181" > < span class = "linenos" > 181< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > camel_to_snake_case< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "camel_to_snake_case-182" > < a href = "#camel_to_snake_case-182" > < span class = "linenos" > 182< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Converts `name` from camelCase to snake_case and returns the result." " " < / span >
< / span > < span id = "camel_to_snake_case-183" > < a href = "#camel_to_snake_case-183" > < span class = "linenos" > 183< / span > < / a > < span class = "k" > return< / span > < span class = "n" > CAMEL_CASE_PATTERN< / span > < span class = "o" > .< / span > < span class = "n" > sub< / span > < span class = "p" > (< / span > < span class = "s2" > " _" < / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > upper< / span > < span class = "p" > ()< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Converts < code > name< / code > from camelCase to snake_case and returns the result.< / p >
< / div >
< / section >
< section id = "while_changing" >
< input id = "while_changing-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
2025-02-13 15:48:10 +01:00
< span class = "name" > while_changing< / span > < span class = "signature pdoc-code multiline" > (< span class = "param" > < span class = "n" > expression< / span > < span class = "p" > :< / span > < span class = "n" > < a href = "expressions.html#Expression" > sqlglot.expressions.Expression< / a > < / span > ,< / span > < span class = "param" > < span class = "n" > func< / span > < span class = "p" > :< / span > < span class = "n" > Callable< / span > < span class = "p" > [[< / span > < span class = "n" > < a href = "expressions.html#Expression" > sqlglot.expressions.Expression< / a > < / span > < span class = "p" > ],< / span > < span class = "o" > ~< / span > < span class = "n" > E< / span > < span class = "p" > ]< / span > < / span > < span class = "return-annotation" > ) -> < span class = "o" > ~< / span > < span class = "n" > E< / span > :< / span > < / span >
2025-02-13 15:23:26 +01:00
< label class = "view-source-button" for = "while_changing-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#while_changing" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "while_changing-186" > < a href = "#while_changing-186" > < span class = "linenos" > 186< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > while_changing< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > :< / span > < span class = "n" > Expression< / span > < span class = "p" > ,< / span > < span class = "n" > func< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Callable< / span > < span class = "p" > [[< / span > < span class = "n" > Expression< / span > < span class = "p" > ],< / span > < span class = "n" > E< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > E< / span > < span class = "p" > :< / span >
< / span > < span id = "while_changing-187" > < a href = "#while_changing-187" > < span class = "linenos" > 187< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "while_changing-188" > < a href = "#while_changing-188" > < span class = "linenos" > 188< / span > < / a > < span class = "sd" > Applies a transformation to a given expression until a fix point is reached.< / span >
< / span > < span id = "while_changing-189" > < a href = "#while_changing-189" > < span class = "linenos" > 189< / span > < / a >
< / span > < span id = "while_changing-190" > < a href = "#while_changing-190" > < span class = "linenos" > 190< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "while_changing-191" > < a href = "#while_changing-191" > < span class = "linenos" > 191< / span > < / a > < span class = "sd" > expression: the expression to be transformed.< / span >
< / span > < span id = "while_changing-192" > < a href = "#while_changing-192" > < span class = "linenos" > 192< / span > < / a > < span class = "sd" > func: the transformation to be applied.< / span >
< / span > < span id = "while_changing-193" > < a href = "#while_changing-193" > < span class = "linenos" > 193< / span > < / a >
< / span > < span id = "while_changing-194" > < a href = "#while_changing-194" > < span class = "linenos" > 194< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "while_changing-195" > < a href = "#while_changing-195" > < span class = "linenos" > 195< / span > < / a > < span class = "sd" > The transformed expression.< / span >
< / span > < span id = "while_changing-196" > < a href = "#while_changing-196" > < span class = "linenos" > 196< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "while_changing-197" > < a href = "#while_changing-197" > < span class = "linenos" > 197< / span > < / a > < span class = "k" > while< / span > < span class = "kc" > True< / span > < span class = "p" > :< / span >
< / span > < span id = "while_changing-198" > < a href = "#while_changing-198" > < span class = "linenos" > 198< / span > < / a > < span class = "k" > for< / span > < span class = "n" > n< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > _< / span > < span class = "ow" > in< / span > < span class = "nb" > reversed< / span > < span class = "p" > (< / span > < span class = "nb" > tuple< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > walk< / span > < span class = "p" > ())):< / span >
< / span > < span id = "while_changing-199" > < a href = "#while_changing-199" > < span class = "linenos" > 199< / span > < / a > < span class = "n" > n< / span > < span class = "o" > .< / span > < span class = "n" > _hash< / span > < span class = "o" > =< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > n< / span > < span class = "p" > )< / span >
< / span > < span id = "while_changing-200" > < a href = "#while_changing-200" > < span class = "linenos" > 200< / span > < / a > < span class = "n" > start< / span > < span class = "o" > =< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "while_changing-201" > < a href = "#while_changing-201" > < span class = "linenos" > 201< / span > < / a > < span class = "n" > expression< / span > < span class = "o" > =< / span > < span class = "n" > func< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > )< / span >
< / span > < span id = "while_changing-202" > < a href = "#while_changing-202" > < span class = "linenos" > 202< / span > < / a >
< / span > < span id = "while_changing-203" > < a href = "#while_changing-203" > < span class = "linenos" > 203< / span > < / a > < span class = "k" > for< / span > < span class = "n" > n< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > _< / span > < span class = "ow" > in< / span > < span class = "n" > expression< / span > < span class = "o" > .< / span > < span class = "n" > walk< / span > < span class = "p" > ():< / span >
< / span > < span id = "while_changing-204" > < a href = "#while_changing-204" > < span class = "linenos" > 204< / span > < / a > < span class = "n" > n< / span > < span class = "o" > .< / span > < span class = "n" > _hash< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< / span > < span id = "while_changing-205" > < a href = "#while_changing-205" > < span class = "linenos" > 205< / span > < / a > < span class = "k" > if< / span > < span class = "n" > start< / span > < span class = "o" > ==< / span > < span class = "nb" > hash< / span > < span class = "p" > (< / span > < span class = "n" > expression< / span > < span class = "p" > ):< / span >
< / span > < span id = "while_changing-206" > < a href = "#while_changing-206" > < span class = "linenos" > 206< / span > < / a > < span class = "k" > break< / span >
< / span > < span id = "while_changing-207" > < a href = "#while_changing-207" > < span class = "linenos" > 207< / span > < / a > < span class = "k" > return< / span > < span class = "n" > expression< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Applies a transformation to a given expression until a fix point is reached.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > expression:< / strong > the expression to be transformed.< / li >
< li > < strong > func:< / strong > the transformation to be applied.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The transformed expression.< / p >
< / blockquote >
< / div >
< / section >
< section id = "tsort" >
< input id = "tsort-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > tsort< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > dag< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ]]< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ]< / span > :< / span > < / span >
< label class = "view-source-button" for = "tsort-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#tsort" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "tsort-210" > < a href = "#tsort-210" > < span class = "linenos" > 210< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > tsort< / span > < span class = "p" > (< / span > < span class = "n" > dag< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ]:< / span >
< / span > < span id = "tsort-211" > < a href = "#tsort-211" > < span class = "linenos" > 211< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "tsort-212" > < a href = "#tsort-212" > < span class = "linenos" > 212< / span > < / a > < span class = "sd" > Sorts a given directed acyclic graph in topological order.< / span >
< / span > < span id = "tsort-213" > < a href = "#tsort-213" > < span class = "linenos" > 213< / span > < / a >
< / span > < span id = "tsort-214" > < a href = "#tsort-214" > < span class = "linenos" > 214< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "tsort-215" > < a href = "#tsort-215" > < span class = "linenos" > 215< / span > < / a > < span class = "sd" > dag: the graph to be sorted.< / span >
< / span > < span id = "tsort-216" > < a href = "#tsort-216" > < span class = "linenos" > 216< / span > < / a >
< / span > < span id = "tsort-217" > < a href = "#tsort-217" > < span class = "linenos" > 217< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "tsort-218" > < a href = "#tsort-218" > < span class = "linenos" > 218< / span > < / a > < span class = "sd" > A list that contains all of the graph' s nodes in topological order.< / span >
< / span > < span id = "tsort-219" > < a href = "#tsort-219" > < span class = "linenos" > 219< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "tsort-220" > < a href = "#tsort-220" > < span class = "linenos" > 220< / span > < / a > < span class = "n" > result< / span > < span class = "o" > =< / span > < span class = "p" > []< / span >
< / span > < span id = "tsort-221" > < a href = "#tsort-221" > < span class = "linenos" > 221< / span > < / a >
< / span > < span id = "tsort-222" > < a href = "#tsort-222" > < span class = "linenos" > 222< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > visit< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > :< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "n" > visited< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Set< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< / span > < span id = "tsort-223" > < a href = "#tsort-223" > < span class = "linenos" > 223< / span > < / a > < span class = "k" > if< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > result< / span > < span class = "p" > :< / span >
< / span > < span id = "tsort-224" > < a href = "#tsort-224" > < span class = "linenos" > 224< / span > < / a > < span class = "k" > return< / span >
< / span > < span id = "tsort-225" > < a href = "#tsort-225" > < span class = "linenos" > 225< / span > < / a > < span class = "k" > if< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > visited< / span > < span class = "p" > :< / span >
< / span > < span id = "tsort-226" > < a href = "#tsort-226" > < span class = "linenos" > 226< / span > < / a > < span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Cycle error" < / span > < span class = "p" > )< / span >
< / span > < span id = "tsort-227" > < a href = "#tsort-227" > < span class = "linenos" > 227< / span > < / a >
< / span > < span id = "tsort-228" > < a href = "#tsort-228" > < span class = "linenos" > 228< / span > < / a > < span class = "n" > visited< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "tsort-229" > < a href = "#tsort-229" > < span class = "linenos" > 229< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "tsort-230" > < a href = "#tsort-230" > < span class = "linenos" > 230< / span > < / a > < span class = "k" > for< / span > < span class = "n" > dep< / span > < span class = "ow" > in< / span > < span class = "n" > dag< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > ,< / span > < span class = "p" > []):< / span >
< / span > < span id = "tsort-231" > < a href = "#tsort-231" > < span class = "linenos" > 231< / span > < / a > < span class = "n" > visit< / span > < span class = "p" > (< / span > < span class = "n" > dep< / span > < span class = "p" > ,< / span > < span class = "n" > visited< / span > < span class = "p" > )< / span >
< / span > < span id = "tsort-232" > < a href = "#tsort-232" > < span class = "linenos" > 232< / span > < / a >
< / span > < span id = "tsort-233" > < a href = "#tsort-233" > < span class = "linenos" > 233< / span > < / a > < span class = "n" > visited< / span > < span class = "o" > .< / span > < span class = "n" > remove< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
< / span > < span id = "tsort-234" > < a href = "#tsort-234" > < span class = "linenos" > 234< / span > < / a > < span class = "n" > result< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > )< / span >
< / span > < span id = "tsort-235" > < a href = "#tsort-235" > < span class = "linenos" > 235< / span > < / a >
< / span > < span id = "tsort-236" > < a href = "#tsort-236" > < span class = "linenos" > 236< / span > < / a > < span class = "k" > for< / span > < span class = "n" > node< / span > < span class = "ow" > in< / span > < span class = "n" > dag< / span > < span class = "p" > :< / span >
< / span > < span id = "tsort-237" > < a href = "#tsort-237" > < span class = "linenos" > 237< / span > < / a > < span class = "n" > visit< / span > < span class = "p" > (< / span > < span class = "n" > node< / span > < span class = "p" > ,< / span > < span class = "nb" > set< / span > < span class = "p" > ())< / span >
< / span > < span id = "tsort-238" > < a href = "#tsort-238" > < span class = "linenos" > 238< / span > < / a >
< / span > < span id = "tsort-239" > < a href = "#tsort-239" > < span class = "linenos" > 239< / span > < / a > < span class = "k" > return< / span > < span class = "n" > result< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Sorts a given directed acyclic graph in topological order.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > dag:< / strong > the graph to be sorted.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > A list that contains all of the graph's nodes in topological order.< / p >
< / blockquote >
< / div >
< / section >
< section id = "open_file" >
< input id = "open_file-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > open_file< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > file_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < / span > < span class = "return-annotation" > ) -> < class ' TextIO' > :< / span > < / span >
< label class = "view-source-button" for = "open_file-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#open_file" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "open_file-242" > < a href = "#open_file-242" > < span class = "linenos" > 242< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > open_file< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > TextIO< / span > < span class = "p" > :< / span >
< / span > < span id = "open_file-243" > < a href = "#open_file-243" > < span class = "linenos" > 243< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Open a file that may be compressed as gzip and return it in universal newline mode." " " < / span >
< / span > < span id = "open_file-244" > < a href = "#open_file-244" > < span class = "linenos" > 244< / span > < / a > < span class = "k" > with< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "s2" > " rb" < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > f< / span > < span class = "p" > :< / span >
< / span > < span id = "open_file-245" > < a href = "#open_file-245" > < span class = "linenos" > 245< / span > < / a > < span class = "n" > gzipped< / span > < span class = "o" > =< / span > < span class = "n" > f< / span > < span class = "o" > .< / span > < span class = "n" > read< / span > < span class = "p" > (< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > ==< / span > < span class = "sa" > b< / span > < span class = "s2" > " < / span > < span class = "se" > \x1f\x8b< / span > < span class = "s2" > " < / span >
< / span > < span id = "open_file-246" > < a href = "#open_file-246" > < span class = "linenos" > 246< / span > < / a >
< / span > < span id = "open_file-247" > < a href = "#open_file-247" > < span class = "linenos" > 247< / span > < / a > < span class = "k" > if< / span > < span class = "n" > gzipped< / span > < span class = "p" > :< / span >
< / span > < span id = "open_file-248" > < a href = "#open_file-248" > < span class = "linenos" > 248< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > gzip< / span >
< / span > < span id = "open_file-249" > < a href = "#open_file-249" > < span class = "linenos" > 249< / span > < / a >
< / span > < span id = "open_file-250" > < a href = "#open_file-250" > < span class = "linenos" > 250< / span > < / a > < span class = "k" > return< / span > < span class = "n" > gzip< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "s2" > " rt" < / span > < span class = "p" > ,< / span > < span class = "n" > newline< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
2025-02-13 15:52:09 +01:00
< / span > < span id = "open_file-251" > < a href = "#open_file-251" > < span class = "linenos" > 251< / span > < / a >
2025-02-13 15:57:23 +01:00
< / span > < span id = "open_file-252" > < a href = "#open_file-252" > < span class = "linenos" > 252< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > file_name< / span > < span class = "p" > ,< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ,< / span > < span class = "n" > newline< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Open a file that may be compressed as gzip and return it in universal newline mode.< / p >
< / div >
< / section >
< section id = "csv_reader" >
< input id = "csv_reader-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< div class = "decorator" > @contextmanager< / div >
< span class = "def" > def< / span >
< span class = "name" > csv_reader< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > read_csv< / span > < span class = "p" > :< / span > < span class = "n" > < a href = "expressions.html#ReadCSV" > sqlglot.expressions.ReadCSV< / a > < / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > Any< / span > :< / span > < / span >
< label class = "view-source-button" for = "csv_reader-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#csv_reader" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "csv_reader-255" > < a href = "#csv_reader-255" > < span class = "linenos" > 255< / span > < / a > < span class = "nd" > @contextmanager< / span >
< / span > < span id = "csv_reader-256" > < a href = "#csv_reader-256" > < span class = "linenos" > 256< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > csv_reader< / span > < span class = "p" > (< / span > < span class = "n" > read_csv< / span > < span class = "p" > :< / span > < span class = "n" > exp< / span > < span class = "o" > .< / span > < span class = "n" > ReadCSV< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > :< / span >
< / span > < span id = "csv_reader-257" > < a href = "#csv_reader-257" > < span class = "linenos" > 257< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "csv_reader-258" > < a href = "#csv_reader-258" > < span class = "linenos" > 258< / span > < / a > < span class = "sd" > Returns a csv reader given the expression `READ_CSV(name, [' delimiter' , ' |' , ...])`.< / span >
< / span > < span id = "csv_reader-259" > < a href = "#csv_reader-259" > < span class = "linenos" > 259< / span > < / a >
< / span > < span id = "csv_reader-260" > < a href = "#csv_reader-260" > < span class = "linenos" > 260< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "csv_reader-261" > < a href = "#csv_reader-261" > < span class = "linenos" > 261< / span > < / a > < span class = "sd" > read_csv: a `ReadCSV` function call< / span >
< / span > < span id = "csv_reader-262" > < a href = "#csv_reader-262" > < span class = "linenos" > 262< / span > < / a >
< / span > < span id = "csv_reader-263" > < a href = "#csv_reader-263" > < span class = "linenos" > 263< / span > < / a > < span class = "sd" > Yields:< / span >
< / span > < span id = "csv_reader-264" > < a href = "#csv_reader-264" > < span class = "linenos" > 264< / span > < / a > < span class = "sd" > A python csv reader.< / span >
< / span > < span id = "csv_reader-265" > < a href = "#csv_reader-265" > < span class = "linenos" > 265< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "csv_reader-266" > < a href = "#csv_reader-266" > < span class = "linenos" > 266< / span > < / a > < span class = "n" > args< / span > < span class = "o" > =< / span > < span class = "n" > read_csv< / span > < span class = "o" > .< / span > < span class = "n" > expressions< / span >
< / span > < span id = "csv_reader-267" > < a href = "#csv_reader-267" > < span class = "linenos" > 267< / span > < / a > < span class = "n" > file< / span > < span class = "o" > =< / span > < span class = "n" > open_file< / span > < span class = "p" > (< / span > < span class = "n" > read_csv< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< / span > < span id = "csv_reader-268" > < a href = "#csv_reader-268" > < span class = "linenos" > 268< / span > < / a >
< / span > < span id = "csv_reader-269" > < a href = "#csv_reader-269" > < span class = "linenos" > 269< / span > < / a > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "s2" > " ," < / span >
< / span > < span id = "csv_reader-270" > < a href = "#csv_reader-270" > < span class = "linenos" > 270< / span > < / a > < span class = "n" > args< / span > < span class = "o" > =< / span > < span class = "nb" > iter< / span > < span class = "p" > (< / span > < span class = "n" > arg< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "k" > for< / span > < span class = "n" > arg< / span > < span class = "ow" > in< / span > < span class = "n" > args< / span > < span class = "p" > )< / span >
< / span > < span id = "csv_reader-271" > < a href = "#csv_reader-271" > < span class = "linenos" > 271< / span > < / a > < span class = "k" > for< / span > < span class = "n" > k< / span > < span class = "p" > ,< / span > < span class = "n" > v< / span > < span class = "ow" > in< / span > < span class = "nb" > zip< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "n" > args< / span > < span class = "p" > ):< / span >
< / span > < span id = "csv_reader-272" > < a href = "#csv_reader-272" > < span class = "linenos" > 272< / span > < / a > < span class = "k" > if< / span > < span class = "n" > k< / span > < span class = "o" > ==< / span > < span class = "s2" > " delimiter" < / span > < span class = "p" > :< / span >
< / span > < span id = "csv_reader-273" > < a href = "#csv_reader-273" > < span class = "linenos" > 273< / span > < / a > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "n" > v< / span >
< / span > < span id = "csv_reader-274" > < a href = "#csv_reader-274" > < span class = "linenos" > 274< / span > < / a >
< / span > < span id = "csv_reader-275" > < a href = "#csv_reader-275" > < span class = "linenos" > 275< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "csv_reader-276" > < a href = "#csv_reader-276" > < span class = "linenos" > 276< / span > < / a > < span class = "kn" > import< / span > < span class = "nn" > csv< / span > < span class = "k" > as< / span > < span class = "nn" > csv_< / span >
< / span > < span id = "csv_reader-277" > < a href = "#csv_reader-277" > < span class = "linenos" > 277< / span > < / a >
< / span > < span id = "csv_reader-278" > < a href = "#csv_reader-278" > < span class = "linenos" > 278< / span > < / a > < span class = "k" > yield< / span > < span class = "n" > csv_< / span > < span class = "o" > .< / span > < span class = "n" > reader< / span > < span class = "p" > (< / span > < span class = "n" > file< / span > < span class = "p" > ,< / span > < span class = "n" > delimiter< / span > < span class = "o" > =< / span > < span class = "n" > delimiter< / span > < span class = "p" > )< / span >
< / span > < span id = "csv_reader-279" > < a href = "#csv_reader-279" > < span class = "linenos" > 279< / span > < / a > < span class = "k" > finally< / span > < span class = "p" > :< / span >
< / span > < span id = "csv_reader-280" > < a href = "#csv_reader-280" > < span class = "linenos" > 280< / span > < / a > < span class = "n" > file< / span > < span class = "o" > .< / span > < span class = "n" > close< / span > < span class = "p" > ()< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Returns a csv reader given the expression < code > READ_CSV(name, ['delimiter', '|', ...])< / code > .< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > read_csv:< / strong > a < code > ReadCSV< / code > function call< / li >
< / ul >
< h6 id = "yields" > Yields:< / h6 >
< blockquote >
< p > A python csv reader.< / p >
< / blockquote >
< / div >
< / section >
< section id = "find_new_name" >
< input id = "find_new_name-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > find_new_name< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > taken< / span > < span class = "p" > :< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span > , < / span > < span class = "param" > < span class = "n" > base< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > str< / span > :< / span > < / span >
< label class = "view-source-button" for = "find_new_name-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#find_new_name" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "find_new_name-283" > < a href = "#find_new_name-283" > < span class = "linenos" > 283< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > find_new_name< / span > < span class = "p" > (< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Collection< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ],< / span > < span class = "n" > base< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
< / span > < span id = "find_new_name-284" > < a href = "#find_new_name-284" > < span class = "linenos" > 284< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "find_new_name-285" > < a href = "#find_new_name-285" > < span class = "linenos" > 285< / span > < / a > < span class = "sd" > Searches for a new name.< / span >
< / span > < span id = "find_new_name-286" > < a href = "#find_new_name-286" > < span class = "linenos" > 286< / span > < / a >
< / span > < span id = "find_new_name-287" > < a href = "#find_new_name-287" > < span class = "linenos" > 287< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "find_new_name-288" > < a href = "#find_new_name-288" > < span class = "linenos" > 288< / span > < / a > < span class = "sd" > taken: a collection of taken names.< / span >
< / span > < span id = "find_new_name-289" > < a href = "#find_new_name-289" > < span class = "linenos" > 289< / span > < / a > < span class = "sd" > base: base name to alter.< / span >
< / span > < span id = "find_new_name-290" > < a href = "#find_new_name-290" > < span class = "linenos" > 290< / span > < / a >
< / span > < span id = "find_new_name-291" > < a href = "#find_new_name-291" > < span class = "linenos" > 291< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "find_new_name-292" > < a href = "#find_new_name-292" > < span class = "linenos" > 292< / span > < / a > < span class = "sd" > The new, available name.< / span >
< / span > < span id = "find_new_name-293" > < a href = "#find_new_name-293" > < span class = "linenos" > 293< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "find_new_name-294" > < a href = "#find_new_name-294" > < span class = "linenos" > 294< / span > < / a > < span class = "k" > if< / span > < span class = "n" > base< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span >
< / span > < span id = "find_new_name-295" > < a href = "#find_new_name-295" > < span class = "linenos" > 295< / span > < / a > < span class = "k" > return< / span > < span class = "n" > base< / span >
< / span > < span id = "find_new_name-296" > < a href = "#find_new_name-296" > < span class = "linenos" > 296< / span > < / a >
< / span > < span id = "find_new_name-297" > < a href = "#find_new_name-297" > < span class = "linenos" > 297< / span > < / a > < span class = "n" > i< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span >
< / span > < span id = "find_new_name-298" > < a href = "#find_new_name-298" > < span class = "linenos" > 298< / span > < / a > < span class = "n" > new< / span > < span class = "o" > =< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "n" > base< / span > < span class = "si" > }< / span > < span class = "s2" > _< / span > < span class = "si" > {< / span > < span class = "n" > i< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span >
< / span > < span id = "find_new_name-299" > < a href = "#find_new_name-299" > < span class = "linenos" > 299< / span > < / a > < span class = "k" > while< / span > < span class = "n" > new< / span > < span class = "ow" > in< / span > < span class = "n" > taken< / span > < span class = "p" > :< / span >
< / span > < span id = "find_new_name-300" > < a href = "#find_new_name-300" > < span class = "linenos" > 300< / span > < / a > < span class = "n" > i< / span > < span class = "o" > +=< / span > < span class = "mi" > 1< / span >
< / span > < span id = "find_new_name-301" > < a href = "#find_new_name-301" > < span class = "linenos" > 301< / span > < / a > < span class = "n" > new< / span > < span class = "o" > =< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "n" > base< / span > < span class = "si" > }< / span > < span class = "s2" > _< / span > < span class = "si" > {< / span > < span class = "n" > i< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span >
< / span > < span id = "find_new_name-302" > < a href = "#find_new_name-302" > < span class = "linenos" > 302< / span > < / a >
< / span > < span id = "find_new_name-303" > < a href = "#find_new_name-303" > < span class = "linenos" > 303< / span > < / a > < span class = "k" > return< / span > < span class = "n" > new< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Searches for a new name.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > taken:< / strong > a collection of taken names.< / li >
< li > < strong > base:< / strong > base name to alter.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The new, available name.< / p >
< / blockquote >
< / div >
< / section >
< section id = "object_to_dict" >
< input id = "object_to_dict-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > object_to_dict< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > Any< / span > , < / span > < span class = "param" > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > Dict< / span > :< / span > < / span >
< label class = "view-source-button" for = "object_to_dict-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#object_to_dict" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "object_to_dict-306" > < a href = "#object_to_dict-306" > < span class = "linenos" > 306< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > object_to_dict< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > :< / span >
< / span > < span id = "object_to_dict-307" > < a href = "#object_to_dict-307" > < span class = "linenos" > 307< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns a dictionary created from an object' s attributes." " " < / span >
< / span > < span id = "object_to_dict-308" > < a href = "#object_to_dict-308" > < span class = "linenos" > 308< / span > < / a > < span class = "k" > return< / span > < span class = "p" > {< / span > < span class = "o" > **< / span > < span class = "p" > {< / span > < span class = "n" > k< / span > < span class = "p" > :< / span > < span class = "n" > copy< / span > < span class = "p" > (< / span > < span class = "n" > v< / span > < span class = "p" > )< / span > < span class = "k" > for< / span > < span class = "n" > k< / span > < span class = "p" > ,< / span > < span class = "n" > v< / span > < span class = "ow" > in< / span > < span class = "nb" > vars< / span > < span class = "p" > (< / span > < span class = "n" > obj< / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > copy< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > items< / span > < span class = "p" > ()},< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > }< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Returns a dictionary created from an object's attributes.< / p >
< / div >
< / section >
< section id = "split_num_words" >
< input id = "split_num_words-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > split_num_words< / span > < span class = "signature pdoc-code multiline" > (< span class = "param" > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > ,< / span > < span class = "param" > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > ,< / span > < span class = "param" > < span class = "n" > min_num_words< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > ,< / span > < span class = "param" > < span class = "n" > fill_from_start< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]]< / span > :< / span > < / span >
< label class = "view-source-button" for = "split_num_words-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#split_num_words" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "split_num_words-311" > < a href = "#split_num_words-311" > < span class = "linenos" > 311< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > split_num_words< / span > < span class = "p" > (< / span >
< / span > < span id = "split_num_words-312" > < a href = "#split_num_words-312" > < span class = "linenos" > 312< / span > < / a > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > sep< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > min_num_words< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span > < span class = "p" > ,< / span > < span class = "n" > fill_from_start< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< / span > < span id = "split_num_words-313" > < a href = "#split_num_words-313" > < span class = "linenos" > 313< / span > < / a > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]]:< / span >
< / span > < span id = "split_num_words-314" > < a href = "#split_num_words-314" > < span class = "linenos" > 314< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "split_num_words-315" > < a href = "#split_num_words-315" > < span class = "linenos" > 315< / span > < / a > < span class = "sd" > Perform a split on a value and return N words as a result with `None` used for words that don' t exist.< / span >
< / span > < span id = "split_num_words-316" > < a href = "#split_num_words-316" > < span class = "linenos" > 316< / span > < / a >
< / span > < span id = "split_num_words-317" > < a href = "#split_num_words-317" > < span class = "linenos" > 317< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "split_num_words-318" > < a href = "#split_num_words-318" > < span class = "linenos" > 318< / span > < / a > < span class = "sd" > value: the value to be split.< / span >
< / span > < span id = "split_num_words-319" > < a href = "#split_num_words-319" > < span class = "linenos" > 319< / span > < / a > < span class = "sd" > sep: the value to use to split on.< / span >
< / span > < span id = "split_num_words-320" > < a href = "#split_num_words-320" > < span class = "linenos" > 320< / span > < / a > < span class = "sd" > min_num_words: the minimum number of words that are going to be in the result.< / span >
< / span > < span id = "split_num_words-321" > < a href = "#split_num_words-321" > < span class = "linenos" > 321< / span > < / a > < span class = "sd" > fill_from_start: indicates that if `None` values should be inserted at the start or end of the list.< / span >
< / span > < span id = "split_num_words-322" > < a href = "#split_num_words-322" > < span class = "linenos" > 322< / span > < / a >
< / span > < span id = "split_num_words-323" > < a href = "#split_num_words-323" > < span class = "linenos" > 323< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "split_num_words-324" > < a href = "#split_num_words-324" > < span class = "linenos" > 324< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 3)< / span >
< / span > < span id = "split_num_words-325" > < a href = "#split_num_words-325" > < span class = "linenos" > 325< / span > < / a > < span class = "sd" > [None, ' db' , ' table' ]< / span >
< / span > < span id = "split_num_words-326" > < a href = "#split_num_words-326" > < span class = "linenos" > 326< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 3, fill_from_start=False)< / span >
< / span > < span id = "split_num_words-327" > < a href = "#split_num_words-327" > < span class = "linenos" > 327< / span > < / a > < span class = "sd" > [' db' , ' table' , None]< / span >
< / span > < span id = "split_num_words-328" > < a href = "#split_num_words-328" > < span class = "linenos" > 328< / span > < / a > < span class = "sd" > > > > split_num_words(" db.table" , " ." , 1)< / span >
< / span > < span id = "split_num_words-329" > < a href = "#split_num_words-329" > < span class = "linenos" > 329< / span > < / a > < span class = "sd" > [' db' , ' table' ]< / span >
< / span > < span id = "split_num_words-330" > < a href = "#split_num_words-330" > < span class = "linenos" > 330< / span > < / a >
< / span > < span id = "split_num_words-331" > < a href = "#split_num_words-331" > < span class = "linenos" > 331< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "split_num_words-332" > < a href = "#split_num_words-332" > < span class = "linenos" > 332< / span > < / a > < span class = "sd" > The list of words returned by `split`, possibly augmented by a number of `None` values.< / span >
< / span > < span id = "split_num_words-333" > < a href = "#split_num_words-333" > < span class = "linenos" > 333< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "split_num_words-334" > < a href = "#split_num_words-334" > < span class = "linenos" > 334< / span > < / a > < span class = "n" > words< / span > < span class = "o" > =< / span > < span class = "n" > value< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "n" > sep< / span > < span class = "p" > )< / span >
< / span > < span id = "split_num_words-335" > < a href = "#split_num_words-335" > < span class = "linenos" > 335< / span > < / a > < span class = "k" > if< / span > < span class = "n" > fill_from_start< / span > < span class = "p" > :< / span >
< / span > < span id = "split_num_words-336" > < a href = "#split_num_words-336" > < span class = "linenos" > 336< / span > < / a > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "kc" > None< / span > < span class = "p" > ]< / span > < span class = "o" > *< / span > < span class = "p" > (< / span > < span class = "n" > min_num_words< / span > < span class = "o" > -< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > words< / span > < span class = "p" > ))< / span > < span class = "o" > +< / span > < span class = "n" > words< / span >
< / span > < span id = "split_num_words-337" > < a href = "#split_num_words-337" > < span class = "linenos" > 337< / span > < / a > < span class = "k" > return< / span > < span class = "n" > words< / span > < span class = "o" > +< / span > < span class = "p" > [< / span > < span class = "kc" > None< / span > < span class = "p" > ]< / span > < span class = "o" > *< / span > < span class = "p" > (< / span > < span class = "n" > min_num_words< / span > < span class = "o" > -< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > words< / span > < span class = "p" > ))< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Perform a split on a value and return N words as a result with < code > None< / code > used for words that don't exist.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > value:< / strong > the value to be split.< / li >
< li > < strong > sep:< / strong > the value to use to split on.< / li >
< li > < strong > min_num_words:< / strong > the minimum number of words that are going to be in the result.< / li >
< li > < strong > fill_from_start:< / strong > indicates that if < code > None< / code > values should be inserted at the start or end of the list.< / li >
< / ul >
< h6 id = "examples" > Examples:< / h6 >
< blockquote >
< div class = "pdoc-code codehilite" >
< pre > < span > < / span > < code > < span class = "gp" > > > > < / span > < span class = "n" > split_num_words< / span > < span class = "p" > (< / span > < span class = "s2" > " db.table" < / span > < span class = "p" > ,< / span > < span class = "s2" > " ." < / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "go" > [None, ' db' , ' table' ]< / span >
< span class = "gp" > > > > < / span > < span class = "n" > split_num_words< / span > < span class = "p" > (< / span > < span class = "s2" > " db.table" < / span > < span class = "p" > ,< / span > < span class = "s2" > " ." < / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span > < span class = "n" > fill_from_start< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > )< / span >
< span class = "go" > [' db' , ' table' , None]< / span >
< span class = "gp" > > > > < / span > < span class = "n" > split_num_words< / span > < span class = "p" > (< / span > < span class = "s2" > " db.table" < / span > < span class = "p" > ,< / span > < span class = "s2" > " ." < / span > < span class = "p" > ,< / span > < span class = "mi" > 1< / span > < span class = "p" > )< / span >
< span class = "go" > [' db' , ' table' ]< / span >
< / code > < / pre >
< / div >
< / blockquote >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > The list of words returned by < code > split< / code > , possibly augmented by a number of < code > None< / code > values.< / p >
< / blockquote >
< / div >
< / section >
< section id = "is_iterable" >
< input id = "is_iterable-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > is_iterable< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > Any< / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > bool< / span > :< / span > < / span >
< label class = "view-source-button" for = "is_iterable-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#is_iterable" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "is_iterable-340" > < a href = "#is_iterable-340" > < span class = "linenos" > 340< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > is_iterable< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > bool< / span > < span class = "p" > :< / span >
< / span > < span id = "is_iterable-341" > < a href = "#is_iterable-341" > < span class = "linenos" > 341< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "is_iterable-342" > < a href = "#is_iterable-342" > < span class = "linenos" > 342< / span > < / a > < span class = "sd" > Checks if the value is an iterable, excluding the types `str` and `bytes`.< / span >
< / span > < span id = "is_iterable-343" > < a href = "#is_iterable-343" > < span class = "linenos" > 343< / span > < / a >
< / span > < span id = "is_iterable-344" > < a href = "#is_iterable-344" > < span class = "linenos" > 344< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "is_iterable-345" > < a href = "#is_iterable-345" > < span class = "linenos" > 345< / span > < / a > < span class = "sd" > > > > is_iterable([1,2])< / span >
< / span > < span id = "is_iterable-346" > < a href = "#is_iterable-346" > < span class = "linenos" > 346< / span > < / a > < span class = "sd" > True< / span >
< / span > < span id = "is_iterable-347" > < a href = "#is_iterable-347" > < span class = "linenos" > 347< / span > < / a > < span class = "sd" > > > > is_iterable(" test" )< / span >
< / span > < span id = "is_iterable-348" > < a href = "#is_iterable-348" > < span class = "linenos" > 348< / span > < / a > < span class = "sd" > False< / span >
< / span > < span id = "is_iterable-349" > < a href = "#is_iterable-349" > < span class = "linenos" > 349< / span > < / a >
< / span > < span id = "is_iterable-350" > < a href = "#is_iterable-350" > < span class = "linenos" > 350< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "is_iterable-351" > < a href = "#is_iterable-351" > < span class = "linenos" > 351< / span > < / a > < span class = "sd" > value: the value to check if it is an iterable.< / span >
< / span > < span id = "is_iterable-352" > < a href = "#is_iterable-352" > < span class = "linenos" > 352< / span > < / a >
< / span > < span id = "is_iterable-353" > < a href = "#is_iterable-353" > < span class = "linenos" > 353< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "is_iterable-354" > < a href = "#is_iterable-354" > < span class = "linenos" > 354< / span > < / a > < span class = "sd" > A `bool` value indicating if it is an iterable.< / span >
< / span > < span id = "is_iterable-355" > < a href = "#is_iterable-355" > < span class = "linenos" > 355< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "is_iterable-356" > < a href = "#is_iterable-356" > < span class = "linenos" > 356< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > hasattr< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "s2" > " __iter__" < / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ))< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Checks if the value is an iterable, excluding the types < code > str< / code > and < code > bytes< / code > .< / p >
< h6 id = "examples" > Examples:< / h6 >
< blockquote >
< div class = "pdoc-code codehilite" >
< pre > < span > < / span > < code > < span class = "gp" > > > > < / span > < span class = "n" > is_iterable< / span > < span class = "p" > ([< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2< / span > < span class = "p" > ])< / span >
< span class = "go" > True< / span >
< span class = "gp" > > > > < / span > < span class = "n" > is_iterable< / span > < span class = "p" > (< / span > < span class = "s2" > " test" < / span > < span class = "p" > )< / span >
< span class = "go" > False< / span >
< / code > < / pre >
< / div >
< / blockquote >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > value:< / strong > the value to check if it is an iterable.< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > A < code > bool< / code > value indicating if it is an iterable.< / p >
< / blockquote >
< / div >
< / section >
< section id = "flatten" >
< input id = "flatten-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > flatten< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > values< / span > < span class = "p" > :< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > Union< / span > < span class = "p" > [< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > Any< / span > < span class = "p" > ],< / span > < span class = "n" > Any< / span > < span class = "p" > ]]< / span > < / span > < span class = "return-annotation" > ) -> < span class = "n" > Iterator< / span > < span class = "p" > [< / span > < span class = "n" > Any< / span > < span class = "p" > ]< / span > :< / span > < / span >
< label class = "view-source-button" for = "flatten-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#flatten" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "flatten-359" > < a href = "#flatten-359" > < span class = "linenos" > 359< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > flatten< / span > < span class = "p" > (< / span > < span class = "n" > values< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ]< / span > < span class = "o" > |< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterator< / span > < span class = "p" > [< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Any< / span > < span class = "p" > ]:< / span >
< / span > < span id = "flatten-360" > < a href = "#flatten-360" > < span class = "linenos" > 360< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "flatten-361" > < a href = "#flatten-361" > < span class = "linenos" > 361< / span > < / a > < span class = "sd" > Flattens an iterable that can contain both iterable and non-iterable elements. Objects of< / span >
< / span > < span id = "flatten-362" > < a href = "#flatten-362" > < span class = "linenos" > 362< / span > < / a > < span class = "sd" > type `str` and `bytes` are not regarded as iterables.< / span >
< / span > < span id = "flatten-363" > < a href = "#flatten-363" > < span class = "linenos" > 363< / span > < / a >
< / span > < span id = "flatten-364" > < a href = "#flatten-364" > < span class = "linenos" > 364< / span > < / a > < span class = "sd" > Examples:< / span >
< / span > < span id = "flatten-365" > < a href = "#flatten-365" > < span class = "linenos" > 365< / span > < / a > < span class = "sd" > > > > list(flatten([[1, 2], 3, {4}, (5, " bla" )]))< / span >
< / span > < span id = "flatten-366" > < a href = "#flatten-366" > < span class = "linenos" > 366< / span > < / a > < span class = "sd" > [1, 2, 3, 4, 5, ' bla' ]< / span >
< / span > < span id = "flatten-367" > < a href = "#flatten-367" > < span class = "linenos" > 367< / span > < / a > < span class = "sd" > > > > list(flatten([1, 2, 3]))< / span >
< / span > < span id = "flatten-368" > < a href = "#flatten-368" > < span class = "linenos" > 368< / span > < / a > < span class = "sd" > [1, 2, 3]< / span >
< / span > < span id = "flatten-369" > < a href = "#flatten-369" > < span class = "linenos" > 369< / span > < / a >
< / span > < span id = "flatten-370" > < a href = "#flatten-370" > < span class = "linenos" > 370< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "flatten-371" > < a href = "#flatten-371" > < span class = "linenos" > 371< / span > < / a > < span class = "sd" > values: the value to be flattened.< / span >
< / span > < span id = "flatten-372" > < a href = "#flatten-372" > < span class = "linenos" > 372< / span > < / a >
< / span > < span id = "flatten-373" > < a href = "#flatten-373" > < span class = "linenos" > 373< / span > < / a > < span class = "sd" > Yields:< / span >
< / span > < span id = "flatten-374" > < a href = "#flatten-374" > < span class = "linenos" > 374< / span > < / a > < span class = "sd" > Non-iterable elements in `values`.< / span >
< / span > < span id = "flatten-375" > < a href = "#flatten-375" > < span class = "linenos" > 375< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "flatten-376" > < a href = "#flatten-376" > < span class = "linenos" > 376< / span > < / a > < span class = "k" > for< / span > < span class = "n" > value< / span > < span class = "ow" > in< / span > < span class = "n" > values< / span > < span class = "p" > :< / span >
< / span > < span id = "flatten-377" > < a href = "#flatten-377" > < span class = "linenos" > 377< / span > < / a > < span class = "k" > if< / span > < span class = "n" > is_iterable< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< / span > < span id = "flatten-378" > < a href = "#flatten-378" > < span class = "linenos" > 378< / span > < / a > < span class = "k" > yield from< / span > < span class = "n" > flatten< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< / span > < span id = "flatten-379" > < a href = "#flatten-379" > < span class = "linenos" > 379< / span > < / a > < span class = "k" > else< / span > < span class = "p" > :< / span >
< / span > < span id = "flatten-380" > < a href = "#flatten-380" > < span class = "linenos" > 380< / span > < / a > < span class = "k" > yield< / span > < span class = "n" > value< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Flattens an iterable that can contain both iterable and non-iterable elements. Objects of
type < code > str< / code > and < code > bytes< / code > are not regarded as iterables.< / p >
< h6 id = "examples" > Examples:< / h6 >
< blockquote >
< div class = "pdoc-code codehilite" >
< pre > < span > < / span > < code > < span class = "gp" > > > > < / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > flatten< / span > < span class = "p" > ([[< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2< / span > < span class = "p" > ],< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span > < span class = "p" > {< / span > < span class = "mi" > 4< / span > < span class = "p" > },< / span > < span class = "p" > (< / span > < span class = "mi" > 5< / span > < span class = "p" > ,< / span > < span class = "s2" > " bla" < / span > < span class = "p" > )]))< / span >
< span class = "go" > [1, 2, 3, 4, 5, ' bla' ]< / span >
< span class = "gp" > > > > < / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > flatten< / span > < span class = "p" > ([< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "p" > ]))< / span >
< span class = "go" > [1, 2, 3]< / span >
< / code > < / pre >
< / div >
< / blockquote >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > values:< / strong > the value to be flattened.< / li >
< / ul >
< h6 id = "yields" > Yields:< / h6 >
< blockquote >
< p > Non-iterable elements in < code > values< / code > .< / p >
< / blockquote >
< / div >
< / section >
< section id = "dict_depth" >
< input id = "dict_depth-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > dict_depth< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > d< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > int< / span > :< / span > < / span >
< label class = "view-source-button" for = "dict_depth-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#dict_depth" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "dict_depth-383" > < a href = "#dict_depth-383" > < span class = "linenos" > 383< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > dict_depth< / span > < span class = "p" > (< / span > < span class = "n" > d< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Dict< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > int< / span > < span class = "p" > :< / span >
< / span > < span id = "dict_depth-384" > < a href = "#dict_depth-384" > < span class = "linenos" > 384< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " < / span >
< / span > < span id = "dict_depth-385" > < a href = "#dict_depth-385" > < span class = "linenos" > 385< / span > < / a > < span class = "sd" > Get the nesting depth of a dictionary.< / span >
< / span > < span id = "dict_depth-386" > < a href = "#dict_depth-386" > < span class = "linenos" > 386< / span > < / a >
< / span > < span id = "dict_depth-387" > < a href = "#dict_depth-387" > < span class = "linenos" > 387< / span > < / a > < span class = "sd" > For example:< / span >
< / span > < span id = "dict_depth-388" > < a href = "#dict_depth-388" > < span class = "linenos" > 388< / span > < / a > < span class = "sd" > > > > dict_depth(None)< / span >
< / span > < span id = "dict_depth-389" > < a href = "#dict_depth-389" > < span class = "linenos" > 389< / span > < / a > < span class = "sd" > 0< / span >
< / span > < span id = "dict_depth-390" > < a href = "#dict_depth-390" > < span class = "linenos" > 390< / span > < / a > < span class = "sd" > > > > dict_depth({})< / span >
< / span > < span id = "dict_depth-391" > < a href = "#dict_depth-391" > < span class = "linenos" > 391< / span > < / a > < span class = "sd" > 1< / span >
< / span > < span id = "dict_depth-392" > < a href = "#dict_depth-392" > < span class = "linenos" > 392< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : " b" })< / span >
< / span > < span id = "dict_depth-393" > < a href = "#dict_depth-393" > < span class = "linenos" > 393< / span > < / a > < span class = "sd" > 1< / span >
< / span > < span id = "dict_depth-394" > < a href = "#dict_depth-394" > < span class = "linenos" > 394< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : {}})< / span >
< / span > < span id = "dict_depth-395" > < a href = "#dict_depth-395" > < span class = "linenos" > 395< / span > < / a > < span class = "sd" > 2< / span >
< / span > < span id = "dict_depth-396" > < a href = "#dict_depth-396" > < span class = "linenos" > 396< / span > < / a > < span class = "sd" > > > > dict_depth({" a" : {" b" : {}}})< / span >
< / span > < span id = "dict_depth-397" > < a href = "#dict_depth-397" > < span class = "linenos" > 397< / span > < / a > < span class = "sd" > 3< / span >
< / span > < span id = "dict_depth-398" > < a href = "#dict_depth-398" > < span class = "linenos" > 398< / span > < / a >
< / span > < span id = "dict_depth-399" > < a href = "#dict_depth-399" > < span class = "linenos" > 399< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "dict_depth-400" > < a href = "#dict_depth-400" > < span class = "linenos" > 400< / span > < / a > < span class = "sd" > d (dict): dictionary< / span >
< / span > < span id = "dict_depth-401" > < a href = "#dict_depth-401" > < span class = "linenos" > 401< / span > < / a >
< / span > < span id = "dict_depth-402" > < a href = "#dict_depth-402" > < span class = "linenos" > 402< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "dict_depth-403" > < a href = "#dict_depth-403" > < span class = "linenos" > 403< / span > < / a > < span class = "sd" > int: depth< / span >
< / span > < span id = "dict_depth-404" > < a href = "#dict_depth-404" > < span class = "linenos" > 404< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "dict_depth-405" > < a href = "#dict_depth-405" > < span class = "linenos" > 405< / span > < / a > < span class = "k" > try< / span > < span class = "p" > :< / span >
< / span > < span id = "dict_depth-406" > < a href = "#dict_depth-406" > < span class = "linenos" > 406< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 1< / span > < span class = "o" > +< / span > < span class = "n" > dict_depth< / span > < span class = "p" > (< / span > < span class = "nb" > next< / span > < span class = "p" > (< / span > < span class = "nb" > iter< / span > < span class = "p" > (< / span > < span class = "n" > d< / span > < span class = "o" > .< / span > < span class = "n" > values< / span > < span class = "p" > ())))< / span >
< / span > < span id = "dict_depth-407" > < a href = "#dict_depth-407" > < span class = "linenos" > 407< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > AttributeError< / span > < span class = "p" > :< / span >
< / span > < span id = "dict_depth-408" > < a href = "#dict_depth-408" > < span class = "linenos" > 408< / span > < / a > < span class = "c1" > # d doesn' t have attribute " values" < / span >
< / span > < span id = "dict_depth-409" > < a href = "#dict_depth-409" > < span class = "linenos" > 409< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 0< / span >
< / span > < span id = "dict_depth-410" > < a href = "#dict_depth-410" > < span class = "linenos" > 410< / span > < / a > < span class = "k" > except< / span > < span class = "ne" > StopIteration< / span > < span class = "p" > :< / span >
< / span > < span id = "dict_depth-411" > < a href = "#dict_depth-411" > < span class = "linenos" > 411< / span > < / a > < span class = "c1" > # d.values() returns an empty sequence< / span >
< / span > < span id = "dict_depth-412" > < a href = "#dict_depth-412" > < span class = "linenos" > 412< / span > < / a > < span class = "k" > return< / span > < span class = "mi" > 1< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Get the nesting depth of a dictionary.< / p >
< h6 id = "for-example" > For example:< / h6 >
< blockquote >
< div class = "pdoc-code codehilite" >
< pre > < span > < / span > < code > < span class = "gp" > > > > < / span > < span class = "n" > dict_depth< / span > < span class = "p" > (< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "go" > 0< / span >
< span class = "gp" > > > > < / span > < span class = "n" > dict_depth< / span > < span class = "p" > ({})< / span >
< span class = "go" > 1< / span >
< span class = "gp" > > > > < / span > < span class = "n" > dict_depth< / span > < span class = "p" > ({< / span > < span class = "s2" > " a" < / span > < span class = "p" > :< / span > < span class = "s2" > " b" < / span > < span class = "p" > })< / span >
< span class = "go" > 1< / span >
< span class = "gp" > > > > < / span > < span class = "n" > dict_depth< / span > < span class = "p" > ({< / span > < span class = "s2" > " a" < / span > < span class = "p" > :< / span > < span class = "p" > {}})< / span >
< span class = "go" > 2< / span >
< span class = "gp" > > > > < / span > < span class = "n" > dict_depth< / span > < span class = "p" > ({< / span > < span class = "s2" > " a" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span > < span class = "s2" > " b" < / span > < span class = "p" > :< / span > < span class = "p" > {}}})< / span >
< span class = "go" > 3< / span >
< / code > < / pre >
< / div >
< / blockquote >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > d (dict):< / strong > dictionary< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > int: depth< / p >
< / blockquote >
< / div >
< / section >
< section id = "first" >
< input id = "first-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > first< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > it< / span > < span class = "p" > :< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "o" > ~< / span > < span class = "n" > T< / span > < span class = "p" > ]< / span > < / span > < span class = "return-annotation" > ) -> < span class = "o" > ~< / span > < span class = "n" > T< / span > :< / span > < / span >
< label class = "view-source-button" for = "first-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#first" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "first-415" > < a href = "#first-415" > < span class = "linenos" > 415< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > first< / span > < span class = "p" > (< / span > < span class = "n" > it< / span > < span class = "p" > :< / span > < span class = "n" > t< / span > < span class = "o" > .< / span > < span class = "n" > Iterable< / span > < span class = "p" > [< / span > < span class = "n" > T< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "n" > T< / span > < span class = "p" > :< / span >
< / span > < span id = "first-416" > < a href = "#first-416" > < span class = "linenos" > 416< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Returns the first element from an iterable.< / span >
< / span > < span id = "first-417" > < a href = "#first-417" > < span class = "linenos" > 417< / span > < / a >
< / span > < span id = "first-418" > < a href = "#first-418" > < span class = "linenos" > 418< / span > < / a > < span class = "sd" > Useful for sets.< / span >
< / span > < span id = "first-419" > < a href = "#first-419" > < span class = "linenos" > 419< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "first-420" > < a href = "#first-420" > < span class = "linenos" > 420< / span > < / a > < span class = "k" > return< / span > < span class = "nb" > next< / span > < span class = "p" > (< / span > < span class = "n" > i< / span > < span class = "k" > for< / span > < span class = "n" > i< / span > < span class = "ow" > in< / span > < span class = "n" > it< / span > < span class = "p" > )< / span >
2025-02-13 15:23:26 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Returns the first element from an iterable.< / p >
< p > Useful for sets.< / p >
< / div >
2025-02-13 15:46:19 +01:00
< / section >
< section id = "should_identify" >
< input id = "should_identify-view-source" class = "view-source-toggle-state" type = "checkbox" aria-hidden = "true" tabindex = "-1" >
< div class = "attr function" >
< span class = "def" > def< / span >
< span class = "name" > should_identify< / span > < span class = "signature pdoc-code condensed" > (< span class = "param" > < span class = "n" > text< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > , < / span > < span class = "param" > < span class = "n" > identify< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > |< / span > < span class = "nb" > bool< / span > < / span > < span class = "return-annotation" > ) -> < span class = "nb" > bool< / span > :< / span > < / span >
< label class = "view-source-button" for = "should_identify-view-source" > < span > View Source< / span > < / label >
< / div >
< a class = "headerlink" href = "#should_identify" > < / a >
2025-02-13 15:57:23 +01:00
< div class = "pdoc-code codehilite" > < pre > < span > < / span > < span id = "should_identify-423" > < a href = "#should_identify-423" > < span class = "linenos" > 423< / span > < / a > < span class = "k" > def< / span > < span class = "nf" > should_identify< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > identify< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > |< / span > < span class = "nb" > bool< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > bool< / span > < span class = "p" > :< / span >
< / span > < span id = "should_identify-424" > < a href = "#should_identify-424" > < span class = "linenos" > 424< / span > < / a > < span class = "w" > < / span > < span class = "sd" > " " " Checks if text should be identified given an identify option.< / span >
< / span > < span id = "should_identify-425" > < a href = "#should_identify-425" > < span class = "linenos" > 425< / span > < / a >
< / span > < span id = "should_identify-426" > < a href = "#should_identify-426" > < span class = "linenos" > 426< / span > < / a > < span class = "sd" > Args:< / span >
< / span > < span id = "should_identify-427" > < a href = "#should_identify-427" > < span class = "linenos" > 427< / span > < / a > < span class = "sd" > text: the text to check.< / span >
< / span > < span id = "should_identify-428" > < a href = "#should_identify-428" > < span class = "linenos" > 428< / span > < / a > < span class = "sd" > identify: " always" | True - always returns true, " safe" - true if no upper case< / span >
< / span > < span id = "should_identify-429" > < a href = "#should_identify-429" > < span class = "linenos" > 429< / span > < / a >
< / span > < span id = "should_identify-430" > < a href = "#should_identify-430" > < span class = "linenos" > 430< / span > < / a > < span class = "sd" > Returns:< / span >
< / span > < span id = "should_identify-431" > < a href = "#should_identify-431" > < span class = "linenos" > 431< / span > < / a > < span class = "sd" > Whether or not a string should be identified.< / span >
< / span > < span id = "should_identify-432" > < a href = "#should_identify-432" > < span class = "linenos" > 432< / span > < / a > < span class = "sd" > " " " < / span >
< / span > < span id = "should_identify-433" > < a href = "#should_identify-433" > < span class = "linenos" > 433< / span > < / a > < span class = "k" > if< / span > < span class = "n" > identify< / span > < span class = "ow" > is< / span > < span class = "kc" > True< / span > < span class = "ow" > or< / span > < span class = "n" > identify< / span > < span class = "o" > ==< / span > < span class = "s2" > " always" < / span > < span class = "p" > :< / span >
< / span > < span id = "should_identify-434" > < a href = "#should_identify-434" > < span class = "linenos" > 434< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > True< / span >
< / span > < span id = "should_identify-435" > < a href = "#should_identify-435" > < span class = "linenos" > 435< / span > < / a > < span class = "k" > if< / span > < span class = "n" > identify< / span > < span class = "o" > ==< / span > < span class = "s2" > " safe" < / span > < span class = "p" > :< / span >
< / span > < span id = "should_identify-436" > < a href = "#should_identify-436" > < span class = "linenos" > 436< / span > < / a > < span class = "k" > return< / span > < span class = "ow" > not< / span > < span class = "nb" > any< / span > < span class = "p" > (< / span > < span class = "n" > char< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ()< / span > < span class = "k" > for< / span > < span class = "n" > char< / span > < span class = "ow" > in< / span > < span class = "n" > text< / span > < span class = "p" > )< / span >
< / span > < span id = "should_identify-437" > < a href = "#should_identify-437" > < span class = "linenos" > 437< / span > < / a > < span class = "k" > return< / span > < span class = "kc" > False< / span >
2025-02-13 15:46:19 +01:00
< / span > < / pre > < / div >
< div class = "docstring" > < p > Checks if text should be identified given an identify option.< / p >
< h6 id = "arguments" > Arguments:< / h6 >
< ul >
< li > < strong > text:< / strong > the text to check.< / li >
< li > < strong > identify:< / strong > "always" | True - always returns true, "safe" - true if no upper case< / li >
< / ul >
< h6 id = "returns" > Returns:< / h6 >
< blockquote >
< p > Whether or not a string should be identified.< / p >
< / blockquote >
< / div >
2025-02-13 15:23:26 +01:00
< / section >
< / main >
< script >
function escapeHTML(html) {
return document.createElement('div').appendChild(document.createTextNode(html)).parentNode.innerHTML;
}
const originalContent = document.querySelector("main.pdoc");
let currentContent = originalContent;
function setContent(innerHTML) {
let elem;
if (innerHTML) {
elem = document.createElement("main");
elem.classList.add("pdoc");
elem.innerHTML = innerHTML;
} else {
elem = originalContent;
}
if (currentContent !== elem) {
currentContent.replaceWith(elem);
currentContent = elem;
}
}
function getSearchTerm() {
return (new URL(window.location)).searchParams.get("search");
}
const searchBox = document.querySelector(".pdoc input[type=search]");
searchBox.addEventListener("input", function () {
let url = new URL(window.location);
if (searchBox.value.trim()) {
url.hash = "";
url.searchParams.set("search", searchBox.value);
} else {
url.searchParams.delete("search");
}
history.replaceState("", "", url.toString());
onInput();
});
window.addEventListener("popstate", onInput);
let search, searchErr;
async function initialize() {
try {
search = await new Promise((resolve, reject) => {
const script = document.createElement("script");
script.type = "text/javascript";
script.async = true;
script.onload = () => resolve(window.pdocSearch);
script.onerror = (e) => reject(e);
script.src = "../search.js";
document.getElementsByTagName("head")[0].appendChild(script);
});
} catch (e) {
console.error("Cannot fetch pdoc search index");
searchErr = "Cannot fetch search index.";
}
onInput();
document.querySelector("nav.pdoc").addEventListener("click", e => {
if (e.target.hash) {
searchBox.value = "";
searchBox.dispatchEvent(new Event("input"));
}
});
}
function onInput() {
setContent((() => {
const term = getSearchTerm();
if (!term) {
return null
}
if (searchErr) {
return `< h3 > Error: ${searchErr}< / h3 > `
}
if (!search) {
return "< h3 > Searching...< / h3 > "
}
window.scrollTo({top: 0, left: 0, behavior: 'auto'});
const results = search(term);
let html;
if (results.length === 0) {
html = `No search results for '${escapeHTML(term)}'.`
} else {
html = `< h4 > ${results.length} search result${results.length > 1 ? "s" : ""} for '${escapeHTML(term)}'.< / h4 > `;
}
for (let result of results.slice(0, 10)) {
let doc = result.doc;
let url = `../${doc.modulename.replaceAll(".", "/")}.html`;
if (doc.qualname) {
url += `#${doc.qualname}`;
}
let heading;
switch (result.doc.kind) {
case "function":
if (doc.fullname.endsWith(".__init__")) {
heading = `< span class = "name" > ${doc.fullname.replace(/\.__init__$/, "")}< / span > ${doc.signature}`;
} else {
heading = `< span class = "def" > ${doc.funcdef}< / span > < span class = "name" > ${doc.fullname}< / span > ${doc.signature}`;
}
break;
case "class":
heading = `< span class = "def" > class< / span > < span class = "name" > ${doc.fullname}< / span > `;
if (doc.bases)
heading += `< wbr > (< span class = "base" > ${doc.bases}< / span > )`;
heading += `:`;
break;
case "variable":
heading = `< span class = "name" > ${doc.fullname}< / span > `;
if (doc.annotation)
heading += `< span class = "annotation" > ${doc.annotation}< / span > `;
if (doc.default_value)
2025-02-13 15:40:23 +01:00
heading += `< span class = "default_value" > = ${doc.default_value}< / span > `;
2025-02-13 15:23:26 +01:00
break;
default:
heading = `< span class = "name" > ${doc.fullname}< / span > `;
break;
}
html += `
< section class = "search-result" >
< a href = "${url}" class = "attr ${doc.kind}" > ${heading}< / a >
< div class = "docstring" > ${doc.doc}< / div >
< / section >
`;
}
return html;
})());
}
if (getSearchTerm()) {
initialize();
searchBox.value = getSearchTerm();
onInput();
} else {
searchBox.addEventListener("focus", initialize, {once: true});
}
searchBox.addEventListener("keydown", e => {
if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
let focused = currentContent.querySelector(".search-result.focused");
if (!focused) {
currentContent.querySelector(".search-result").classList.add("focused");
} else if (
e.key === "ArrowDown"
& & focused.nextElementSibling
& & focused.nextElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.nextElementSibling.classList.add("focused");
focused.nextElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "ArrowUp"
& & focused.previousElementSibling
& & focused.previousElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.previousElementSibling.classList.add("focused");
focused.previousElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "Enter"
) {
focused.querySelector("a").click();
}
}
});
< / script > < / body >
< / html >
