great_expectations の API リファレンス
great_expectations (great-expectations/great_expectations) の公開 API 85 件 —— クラス 57、関数 8、メソッド 20。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: great-expectations/great_expectations
| 種別 | 件数 |
|---|---|
| クラス | 57 |
| 関数 | 8 |
| メソッド | 20 |
API 一覧
func
ci.checks.validate_docs_snippets.parse_grep(lines:list[str]) -> list[str]Parse the grep output and exclude known issues.
func
contrib.cli.great_expectations_contrib.cli.cli(ctx:click.Context) -> NoneWelcome to the great_expectations_contrib CLI!
class
great_expectations.checkpoint.actions.OpsgenieAlertActionSends an Opsgenie alert.
class
great_expectations.checkpoint.actions.PagerdutyAlertActionSends a PagerDuty event.
method
great_expectations.checkpoint.checkpoint.Checkpoint.save() -> NoneSave the current state of this Checkpoint.
class
great_expectations.checkpoint.checkpoint.CheckpointResultThe result of running a Checkpoint.
class
great_expectations.compatibility.aws.REDSHIFT_TYPESNamespace for Redshift dialect types.
class
great_expectations.compatibility.bigquery.BIGQUERY_TYPESNamespace for Bigquery dialect types
class
great_expectations.compatibility.databricks.DATABRICKS_TYPESNamespace for Databricks dialect types
class
great_expectations.compatibility.postgresql.POSTGRESQL_TYPESNamespace for PostgreSQL dialect types.
class
great_expectations.compatibility.snowflake.SNOWFLAKE_TYPESNamespace for Snowflake dialect types.
class
great_expectations.core.batch.BatchA Batch is a selection of records from a Data Asset.
method
great_expectations.core.batch.Batch.data() -> BatchDataType | NoneGetter for Batch data
method
great_expectations.core.batch.Batch.head(n_rows:int=5, fetch_all:bool=False) -> pd.DataFrameReturn the first n rows from the Batch.
class
great_expectations.core.batch_definition.BatchDefinitionConfiguration for a batch of data.
method
great_expectations.core.batch_definition.BatchDefinition.get_batch(batch_parameters:Optional[BatchParameters]=None) -> BatchRetrieves a batch from the underlying asset.
class
great_expectations.core.configuration.AbstractConfigAbstract base class for Config objects.
class
great_expectations.core.expectation_suite.ExpectationSuiteSet-like collection of Expectations.
method
great_expectations.core.expectation_suite.ExpectationSuite.add_expectation(expectation:_TExpectation) -> _TExpectationAdd an Expectation to the collection.
method
great_expectations.core.expectation_suite.ExpectationSuite.delete_expectation(expectation:Expectation) -> ExpectationDelete an Expectation from the collection.
method
great_expectations.core.expectation_suite.ExpectationSuite.save() -> NoneSave this ExpectationSuite.
class
great_expectations.core.expectation_validation_result.ExpectationValidationResultAn Expectation validation result.
class
great_expectations.core.serializer.AbstractConfigSerializerSerializer interface.
method
great_expectations.core.serializer.AbstractConfigSerializer.serialize(obj:AbstractConfig) -> dictSerialize to serializer specific data type.
func
great_expectations.core.suite_parameters.get_suite_parameter_key(suite_parameter:SuiteParameterDict) -> strGet the key of a suite parameter.
func
great_expectations.core.util.sniff_s3_compression(s3_url:S3Url) -> Union[str, None]Attempts to get read_csv compression from s3_url
func
great_expectations.data_context.store.gx_cloud_store_backend.close_session(session:requests.Session)Close the session.
class
great_expectations.data_context.store.tuple_store_backend.TupleFilesystemStoreBackendUses a local filepath as a store.
class
great_expectations.data_context.types.base.DataContextConfigConfig class for DataContext.
class
great_expectations.data_context.types.resource_identifiers.BatchIdentifierA BatchIdentifier tracks
class
great_expectations.data_context.util.PasswordMaskerUsed to mask passwords in Datasources.
method
great_expectations.data_context.util.PasswordMasker.sanitize_config(config:dict) -> dictMask sensitive fields in a Dict.
class
great_expectations.datasource.fluent.config.GxConfigRepresents the full fluent configuration file.
class
great_expectations.datasource.fluent.fabric.FabricPowerBIDatasourceMicrosoft Fabric Datasource.
class
great_expectations.datasource.fluent.fabric.PowerBIDaxMicrosoft PowerBI DAX.
class
great_expectations.datasource.fluent.fabric.PowerBIMeasureMicrosoft PowerBI Measure.
class
great_expectations.datasource.fluent.fabric.PowerBITableMicrosoft PowerBI Table.
class
great_expectations.datasource.fluent.interfaces.BatchThis represents a batch of data.
method
great_expectations.datasource.fluent.interfaces.Batch.columns() -> List[str]Return column names of this Batch.
method
great_expectations.datasource.fluent.interfaces.Batch.head(n_rows:StrictInt=5, fetch_all:StrictBool=False) -> HeadDataReturn the first n rows of this Batch.
method
great_expectations.datasource.fluent.interfaces.Datasource.get_batch(batch_request:BatchRequest) -> BatchA Batch that corresponds to the BatchRequest.
class
great_expectations.datasource.fluent.invalid_datasource.InvalidAssetA DataAsset that is invalid.
class
great_expectations.datasource.fluent.invalid_datasource.InvalidDatasourceA Datasource that is invalid.
method
great_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn.account() -> AccountIdentifierAlias for account_identifier.
method
great_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn.account_identifier() -> AccountIdentifierAlias for host.
class
great_expectations.exceptions.exceptions.PluginClassNotFoundErrorA module import failed.
class
great_expectations.exceptions.exceptions.PluginModuleNotFoundErrorA module import failed.
method
great_expectations.execution_engine.execution_engine.ExecutionEngine.batch_manager() -> BatchManagerGetter for batch_manager
class
great_expectations.expectations.expectation.BatchExpectationBase class for BatchExpectations.
class
great_expectations.expectations.expectation.ColumnMapExpectationBase class for ColumnMapExpectations.
class
great_expectations.expectations.expectation.ColumnPairMapExpectationBase class for ColumnPairMapExpectations.
class
great_expectations.expectations.expectation.ExpectationBase class for all Expectations.
class
great_expectations.expectations.expectation.QueryExpectationBase class for QueryExpectations.
class
great_expectations.expectations.metadata_types.FailureSeveritySeverity levels for Expectation failures.
class
great_expectations.expectations.metrics.metric_provider.MetricProviderBase class for all metric providers.
class
great_expectations.expectations.row_conditions.ColumnSpecify the column in a condition statement.
class
great_expectations.expectations.row_conditions.ConditionBase class for conditions.
method
great_expectations.experimental.metric_repository.cloud_data_store.CloudDataStore.add(value:T) -> uuid.UUIDAdd a value to the DataStore.
func
great_expectations.experimental.metric_repository.cloud_data_store.close_session(session:requests.Session)Close the session.
method
great_expectations.experimental.metric_repository.data_store.DataStore.add(value:T) -> uuid.UUIDAdd a value to the DataStore.
class
great_expectations.experimental.metric_repository.metrics.MetricAbstract computed metric.
class
great_expectations.metrics.batch.batch_column_types.BatchColumnTypesTable schema
class
great_expectations.metrics.batch.row_count.BatchRowCountCount of rows in a table
class
great_expectations.metrics.batch.sample_values.SampleValuesSample rows from a table
class
great_expectations.metrics.column.distinct_values.ColumnDistinctValuesList of distinct values in a column
class
great_expectations.metrics.column.distinct_values_count.ColumnDistinctValuesCountCount of distinct values in a column
class
great_expectations.metrics.column.mean.ColumnMeanMean of values in a column
class
great_expectations.metrics.column.null_count.ColumnNullCountCount of null values in a column
class
great_expectations.metrics.column.values_non_null.ColumnValuesNonNullCountCount of non-null values in a column
class
great_expectations.metrics.metric.MetricThe abstract base class for defining all metrics.
class
great_expectations.render.components.AtomicDiagnosticRendererTypeAvailable atomic diagnostic renderer names
class
great_expectations.render.components.AtomicRendererTypeAvailable atomic renderer types
class
great_expectations.render.components.LegacyDiagnosticRendererTypeAvailable legacy diagnostic renderer names
class
great_expectations.render.components.LegacyRendererTypeAvailable legacy renderer types
class
great_expectations.render.components.RendererPrefixAvailable renderer prefixes
method
great_expectations.render.renderer.renderer.Renderer.render(checkpoint_result:CheckpointResult) -> AnyRender interface method.
class
great_expectations.render.renderer_configuration.RendererSchemaJson schema for values found in renderers.
func
great_expectations.render.util.ordinal(num)Convert a number to ordinal
class
great_expectations.render.view.view.DefaultMarkdownPageViewConvert a document to markdown format.
method
great_expectations.render.view.view.DefaultMarkdownPageView.render(document:list, template=None, **kwargs) -> list[str] | strHandle list as well as single document
class
great_expectations.types.connect_args.ConnectArgsType definition for connection arguments.
func
great_expectations.util.is_sane_slack_webhook(url:str) -> boolReally basic sanity checking.
class
great_expectations.validator.metric_configuration.MetricConfigurationAn interface for configuring Metrics.
class
great_expectations.validator.v1_validator.ValidatorValidator.
method
great_expectations.validator.validator.Validator.columns(domain_kwargs:Optional[Dict[str, Any]]=None) -> List[str]Convenience method to obtain Batch columns.
この情報について
掲載しているシグネチャは great-expectations/great_expectations の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。