util.py - Great Expectations

import CodeBlock from '@theme/CodeBlock';

<section class="sphinx-api-doc" id="util"> Rendering utility <dl class="py function"> <dt class="sig sig-object py"> great_expectations.render.util.handle_strict_min_max(params: dict) → tuple[str, str] </dt> <dd> Utility function for the at least and at most conditions based on strictness. <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"> params – Dictionary containing "strict_min" and "strict_max" booleans. </dd> <dt class="field-even">Returns</dt> <dd class="field-even"> Tuple of strings to use for the at least condition and the at most condition. </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py"> great_expectations.render.util.num_to_str(f: float, precision: int = 15, use_locale: bool = False, no_scientific: bool = False) → str </dt> <dd> Convert the given float to a string, centralizing standards for precision and decisions about scientific notation. Adds an approximately equal sign in the event precision loss (e.g. rounding) has occurred. <dl class="simple"> <dt>For more context, please review the following:</dt> <dd> <a class="reference external" href="https://stackoverflow.com/questions/38847690/convert-float-to-string-in-positional-format-without-scientific-notation-and-fa">Convert-Float-To-String-In-Positional-Format-Without-Scientific-Notation-And-Fa</a> </dd> </dl> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li>f – The number to format.</li> <li>precision – The number of digits of precision to display (defaults to 4).</li> <li>use_locale – If True, use locale-specific formatting (e.g. adding thousands separators).</li> <li>no_scientific – If True, print all available digits of precision without scientific notation. This may insert leading zeros before very small numbers, causing the resulting string to be longer than <cite>precision</cite> characters.</li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"> A string representation of the input float <cite>f</cite>, according to the desired parameters. </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py"> great_expectations.render.util.parse_row_condition_string_pandas_engine(condition_string: str, with_schema: bool = False) → tuple[str, dict] </dt> <dd> Parses the row condition string into a pandas engine compatible format. <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li>condition_string – A pandas row condition string.</li> <li>with_schema – Return results in json schema format. Defaults to False.</li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"> A tuple containing the template string and a <cite>dict</cite> of parameters. </dd> </dl> <CodeBlock language="python">{`>>> template_str, params = parse_row_condition_string_pandas_engine("Age in [0, 42]") >>> print(template_str) "if $row_condition__0" >>> params {"row_condition__0": "Age in [0, 42]"}`}</CodeBlock> </dd></dl> <dl class="py function"> <dt class="sig sig-object py"> great_expectations.render.util.substitute_none_for_missing(kwargs: dict[str, Any], kwarg_list: Sequence[str]) → dict[str, Any] </dt> <dd> Utility function to plug Nones in when optional parameters are not specified in expectation kwargs. <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li>kwargs – A dictionary of keyword arguments.</li> <li>kwargs_list – A list or sequence of strings representing all possible keyword parameters to a function.</li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"> A copy of the original <cite>kwargs</cite> with missing keys from <cite>kwarg_list</cite> defaulted to <cite>None</cite>. </dd> </dl> <CodeBlock language="python">{`>>> result = substitute_none_for_missing( … kwargs={"a":1, "b":2}, … kwarg_list=["c", "d"] … ) … print(result) {"a":1, "b":2, "c": None, "d": None}`}</CodeBlock> This is helpful for standardizing the input objects for rendering functions. The alternative is lots of awkward <cite>if "some_param" not in kwargs or kwargs["some_param"] == None:</cite> clauses in renderers. </dd></dl> </section>