o i9@sddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZddlmZerfddlZdd lmZdd lmZdd lmZdd lmZmZejd kr`ddlm Z nddlm Z GdddZ dS)) annotations) TYPE_CHECKINGLiteraloverloadN) deprecated)serialize_polars_object)display_dot_graph wrap_expr) ComputeError)IOBase)Path)Expr) SchemaDictSerializationFormat) c@seZdZdZdZdmddZdnd d Zdnd d ZdoddZdpddZ dpddZ dpddZ dpddZ dqddZ dqddZdqd d!Zd"d#drd%d&Zd"d#drd'd(Zed)d*dsd-d.Zedtd1d.Zd)d*dud2d.Zd3d4dvd8d9Zdwd;d<Zdxd=d>Zdxd?d@ZdydBdCZe DdzdDdEd{dJdKZedzd|dMdKZedDdEd}dPdKZ 3d~dQdEddTdKZedzddUdVZeddWdVZedXd~ddYdVZedDd3dZdd]d^Zed3d4dd_d^Zd"d3dZdd`d^Zd)d3d"dad3dbddidjZddkdlZd3S)ExprMetaNameSpacez*Namespace for expressions on a meta level.metaexprrreturnNonecCs |j|_dSN)_pyexprselfrrG/home/app/Keep/.python/lib/python3.10/site-packages/polars/expr/meta.py__init__s zExprMetaNameSpace.__init__strcCt|jdSNz.meta)r r__str__rrrrr""zExprMetaNameSpace.__str__cCr r!)r r__repr__r#rrrr%%r$zExprMetaNameSpace.__repr__intcC |jSr)r__hash__r#rrrr(( zExprMetaNameSpace.__hash__otherExprMetaNameSpace | ExprboolcC|j|jSrrZmeta_eqrr*rrr__eq__+szExprMetaNameSpace.__eq__cCs ||k Srrr/rrr__ne__.r)zExprMetaNameSpace.__ne__cCr-)aX Indicate if this expression is the same as another expression. Examples -------- >>> foo_bar = pl.col("foo").alias("bar") >>> foo = pl.col("foo") >>> foo_bar.meta.eq(foo) False >>> foo_bar2 = pl.col("foo").alias("bar") >>> foo_bar.meta.eq(foo_bar2) True r.r/rrreq1szExprMetaNameSpace.eqcCs || S)a\ Indicate if this expression is NOT the same as another expression. Examples -------- >>> foo_bar = pl.col("foo").alias("bar") >>> foo = pl.col("foo") >>> foo_bar.meta.ne(foo) True >>> foo_bar2 = pl.col("foo").alias("bar") >>> foo_bar.meta.ne(foo_bar2) False )r2r/rrrneAs zExprMetaNameSpace.necCr')z Indicate if this expression expands into multiple expressions. Examples -------- >>> e = pl.col(["a", "b"]).name.suffix("_foo") >>> e.meta.has_multiple_outputs() True )rZmeta_has_multiple_outputsr#rrrhas_multiple_outputsQ z&ExprMetaNameSpace.has_multiple_outputscCr')aq Indicate if this expression is a basic (non-regex) unaliased column. Examples -------- >>> e = pl.col("foo") >>> e.meta.is_column() True >>> e = pl.col("foo") * pl.col("bar") >>> e.meta.is_column() False >>> e = pl.col(r"^col.*\d+$") >>> e.meta.is_column() False )rZmeta_is_columnr#rrr is_column]s zExprMetaNameSpace.is_columncCr')z Indicate if this expression expands to columns that match a regex pattern. Examples -------- >>> e = pl.col("^.*$").name.prefix("foo_") >>> e.meta.is_regex_projection() True )rZmeta_is_regex_projectionr#rrris_regex_projectionor5z%ExprMetaNameSpace.is_regex_projectionF)allow_aliasingr8cC |j|S)az Indicate if this expression only selects columns (optionally with aliasing). This can include bare columns, columns matched by regex or dtype, selectors and exclude ops, and (optionally) column/expression aliasing. .. versionadded:: 0.20.30 Parameters ---------- allow_aliasing If False (default), any aliasing is not considered to be column selection. Set True to allow for column selection that also includes aliasing. Examples -------- >>> import polars.selectors as cs >>> e = pl.col("foo") >>> e.meta.is_column_selection() True >>> e = pl.col("foo").alias("bar") >>> e.meta.is_column_selection() False >>> e.meta.is_column_selection(allow_aliasing=True) True >>> e = pl.col("foo") * pl.col("bar") >>> e.meta.is_column_selection() False >>> e = cs.starts_with("foo") >>> e.meta.is_column_selection() True >>> e = cs.starts_with("foo").exclude("foo!") >>> e.meta.is_column_selection() True )rZmeta_is_column_selectionrr8rrris_column_selection{s $z%ExprMetaNameSpace.is_column_selectioncCr9)a Indicate if this expression is a literal value (optionally aliased). .. versionadded:: 1.14 Parameters ---------- allow_aliasing If False (default), only a bare literal will match. Set True to also allow for aliased literals. Examples -------- >>> from datetime import datetime >>> e = pl.lit(123) >>> e.meta.is_literal() True >>> e = pl.lit(987.654321).alias("foo") >>> e.meta.is_literal() False >>> e = pl.lit(datetime.now()).alias("bar") >>> e.meta.is_literal(allow_aliasing=True) True )rZmeta_is_literalr:rrr is_literals zExprMetaNameSpace.is_literalT)raise_if_undeterminedr= Literal[True]cCdSrrrr=rrr output_namezExprMetaNameSpace.output_nameLiteral[False] str | NonecCr?rrr@rrrrArBcCs(z|jWSty|sYdSw)aa Get the column name that this expression would produce. It may not always be possible to determine the output name as that can depend on the schema of the context; in that case this will raise `ComputeError` if `raise_if_undetermined` is True (the default), or `None` otherwise. Examples -------- >>> e = pl.col("foo") * pl.col("bar") >>> e.meta.output_name() 'foo' >>> e_filter = pl.col("foo").filter(pl.col("bar") == 13) >>> e_filter.meta.output_name() 'foo' >>> e_sum_over = pl.sum("foo").over("groups") >>> e_sum_over.meta.output_name() 'foo' >>> e_sum_slice = pl.sum("foo").slice(pl.len() - 10, pl.col("bar")) >>> e_sum_slice.meta.output_name() 'foo' >>> pl.len().meta.output_name() 'len' N)rZmeta_output_namer r@rrrrAs  N)schemarESchemaDict | None list[Expr]cCsdd|j|DS)a< Pop the latest expression and return the input(s) of the popped expression. Returns ------- list of Expr A list of expressions which in most cases will have a unit length. This is not the case when an expression has multiple inputs. For instance in a `fold` expression. Examples -------- >>> e = pl.col("foo") + pl.col("bar") >>> first = e.meta.pop()[0] >>> first.meta == pl.col("bar") True >>> first.meta == pl.col("foo") False cSsg|]}t|qSrr ).0errr sz)ExprMetaNameSpace.pop..)rZmeta_pop)rrErrrpopszExprMetaNameSpace.pop list[str]cCr')aD Get a list with the root column name. Examples -------- >>> e = pl.col("foo") * pl.col("bar") >>> e.meta.root_names() ['foo', 'bar'] >>> e_filter = pl.col("foo").filter(pl.col("bar") == 13) >>> e_filter.meta.root_names() ['foo', 'bar'] >>> e_sum_over = pl.sum("foo").over("groups") >>> e_sum_over.meta.root_names() ['foo', 'groups'] >>> e_sum_slice = pl.sum("foo").slice(pl.len() - 10, pl.col("bar")) >>> e_sum_slice.meta.root_names() ['foo', 'bar'] )rZmeta_root_namesr#rrr root_namess zExprMetaNameSpace.root_namescCst|jS)aR Undo any renaming operation like `alias` or `name.keep`. Examples -------- >>> e = pl.col("foo").alias("bar") >>> e.meta.undo_aliases().meta == pl.col("foo") True >>> e = pl.col("foo").sum().over("bar") >>> e.name.keep().meta.undo_aliases().meta == e True )r rZmeta_undo_aliasesr#rrr undo_aliases s zExprMetaNameSpace.undo_aliasescCs t|jS)zReturn the original expression.)r rr#rrr as_expressions zExprMetaNameSpace.as_expression pl.SelectorcCstj|jS)a2 Try to turn this expression in a selector. Raises if the underlying expressions is not a column or selector. .. warning:: This functionality is considered **unstable**. It may be changed at any point without it being considered a breaking change. )plZSelectorZ_from_pyselectorrZ into_selectorr#rrr as_selector s zExprMetaNameSpace.as_selector.formatfilerTLiteral['binary']bytescCr?rrrrUrTrrr serialize,zExprMetaNameSpace.serializeLiteral['json']cCr?rrrXrrrrY1rBIOBase | str | PathrcCr?rrrXrrrrY4rZbinaryIOBase | str | Path | Nonebytes | str | NonecCsB|dkr |jj}n|dkr|jj}n d|}t|t|||S)u Serialize this expression to a file or string in JSON format. Parameters ---------- file File path to which the result should be written. If set to `None` (default), the output is returned as a string instead. format The format in which to serialize. Options: - `"binary"`: Serialize to binary format (bytes). This is the default. - `"json"`: Serialize to JSON format (string). See Also -------- Expr.deserialize Notes ----- Serialization is not stable across Polars versions: a LazyFrame serialized in one Polars version may not be deserializable in another Polars version. Examples -------- Serialize the expression into a binary representation. >>> expr = pl.col("foo").sum().over("bar") >>> bytes = expr.meta.serialize() >>> type(bytes) The bytes can later be deserialized back into an `Expr` object. >>> import io >>> pl.Expr.deserialize(io.BytesIO(bytes)) r]jsonz0`format` must be one of {'binary', 'json'}, got )rZserialize_binaryZserialize_json ValueErrorr)rrUrT serializermsgrrrrY9s,    cCr?rrrrUrrr write_jsonorBzExprMetaNameSpace.write_jsoncCr?rrrdrrrrerrBz;`meta.write_json` was renamed; use `meta.serialize` insteadcCs|j|ddS)z Write expression to json. .. deprecated:: 0.20.11 This method has been renamed to :meth:`serialize`. r`rS)rYrdrrrreus)return_as_stringrErfNone | SchemaDictcCr?rrrrfrErrr tree_formatszExprMetaNameSpace.tree_formatcCr?rrrhrrrrirZcCs |j|}|r |St|dS)am Format the expression as a tree. Parameters ---------- return_as_string: If True, return as string rather than printing to stdout. schema Optionally provide a schema for the expression tree formatter. This is a mapping of column names to their data types. If provided, it may be used to enhance the tree formatting with type information. Examples -------- >>> e = (pl.col("foo") * pl.col("bar")).sum().over(pl.col("ham")) / 2 >>> e.meta.tree_format(return_as_string=True) # doctest: +SKIP N)rZmeta_tree_formatprint)rrfrEsrrrris )g0@g(@)show output_path raw_outputfigsizerErlrmstr | Path | Nonernrotuple[float, float]cCs|j|}t|||||dS)a Format the expression as a Graphviz graph. Note that Graphviz must be installed to render the visualization (if not already present, you can download it here: ``_). Parameters ---------- show Show the figure. output_path Write the figure to disk. raw_output Return dot syntax. This cannot be combined with `show` and/or `output_path`. figsize Passed to matplotlib if `show == True`. schema Optionally provide a schema for the expression tree formatter. This is a mapping of column names to their data types. If provided, it may be used to enhance the tree formatting with type information. Examples -------- >>> e = (pl.col("foo") * pl.col("bar")).sum().over(pl.col("ham")) / 2 >>> e.meta.show_graph() # doctest: +SKIP )dotrlrmrnro)rZmeta_show_graphr)rrlrmrnrorErrrrr show_graphs #zExprMetaNameSpace.show_graphcCst|j|jSr)r rZmeta_replace_elementrrrr_replace_elementsz"ExprMetaNameSpace._replace_element)rrrr)rr)rr&)r*r+rr,)rr,)r8r,rr,)r=r>rr)r=rCrrD)r=r,rrD)rErFrrG)rrL)rr)rrP).)rUrrTrVrrW)rUrrTr[rr)rUr\rTrrrr)rUr^rTrrr_)rUrrr)rUr\rr)rUr^rrD)rfrCrErgrr)rfr>rErgrr)rfr,rErgrrD) rlr,rmrprnr,rorqrErgrrD)rrrr)__name__ __module__ __qualname____doc__ _accessorrr"r%r(r0r1r2r3r4r6r7r;r<rrArKrMrNrOrRrYrerrirsrtrrrrrs|           &      6  ,r)! __future__rtypingrrrZpolars._reexportZ _reexportrQZpolars._utils.deprecationrZpolars._utils.serderZpolars._utils.variousrZpolars._utils.wrapr Zpolars.exceptionsr sysior pathlibr ZpolarsrZpolars._typingrr version_infowarningsZtyping_extensionsrrrrrs$