Skip to main content
Version: 0.16.10

How to initialize a Filesystem Data Context in Python

Introduction​

A Data ContextThe primary entry point for a Great Expectations deployment, with configurations and methods for all supporting components. will be required in almost all Python scripts utilizing GX, and will be implemented behind the scenes when using GX's CLICommand Line Interface.

This guide will demonstrate how to initialize, instantiate, and verify the contents of a Filesystem Data Context from through Python code.

Prerequisites​

This guide assumes you have:

Steps​

1. Import Great Expectations​

We will import the Great Expectations module with the command:

Python code
import great_expectations as gx

2. Determine the folder to initialize the Data Context in​

For purposes of this example, we will assume that we have an empty folder to initialize our Filesystem Data Context in:

Python code
path_to_empty_folder = '/my_gx_project/'

3. Run GX's get_context(...) method​

We will provide our empty folder's path to the GX library's get_context(...) method as the context_root_dir parameter. Because we are providing a path to an empty folder get_context(...) will initialize a Filesystem Data Context at that location.

For convenience, the get_context(...) method will then instantiate and return the newly initialized Data Context, which we can keep in a Python variable.

Python code
context = gx.get_context(context_root_dir=path_to_empty_folder)
What if the folder is not empty?

If the context_root_dir provided to the get_context(...) method points to a folder that does not already have a Data Context present, the get_context(...) method will initialize a Filesystem Data Context at that location even if other files and folders are present. This allows you to easily initialize a Filesystem Data Context in a folder that contains your source data or other project related contents.

If a Data Context already exists at the provided path, the get_context(...) method will not re-initialize it. Instead, get_context(...) will simply instantiate and return the existing Data Context as is.

4. Verify the content of the returned Data Context​

We can ensure that the Data Context was instantiated correctly by printing its contents.

Python code
print(context)

This will output the full configuration of the Data Context in the format of a Python dictionary.

Next steps​

For guidance on further customizing your Data Context's configurations for Metadata StoresA connector to store and retrieve information about metadata in Great Expectations. and Data DocsHuman readable documentation generated from Great Expectations metadata detailing Expectations, Validation Results, etc., please see:

If you are content with the default configuration of your Data Context, you can move on to connecting GX to your source data:

Additional information​

To initialize a Filesystem Data Context from the terminal, please see: How to initialize a new Data Context with the CLI.

To initialize and instantiate a temporary Data Context, see: How to instantiate an Ephemeral Data Context.