Skip to content

Commit 4740089

Browse files
committed
Merge branch 'rr-45-mocktest-data' of https://github.com/CDCgov/cfa-dataops into rr-45-mocktest-data
2 parents b58561b + 5357867 commit 4740089

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

cfa/dataops/catalog.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -712,15 +712,20 @@ def _attach_schema_mock_functions(
712712
a schema module co-located with the dataset.
713713
714714
The schema module is expected to live at:
715-
{catalog_namespace}.{catalog_name}.datasets.{team}.{dataset}.schemas.{dataset}
715+
{catalog_namespace}.{catalog_name}.datasets.{team_path}.schemas.{dataset_name}
716716
717-
and define one or both of:
717+
where ``team_path`` is the namespace path segment(s) between the catalog
718+
name and the dataset name (for example, ``stf`` in
719+
``public.stf.nhsn_hrd_prelim``), and ``dataset_name`` is the dataset's
720+
namespace name (for example, ``nhsn_hrd_prelim``).
721+
722+
The schema module should define one or both of:
718723
- extract_mock_data() -> pd.DataFrame
719724
- load_mock_data() -> pd.DataFrame
720725
721726
These are then accessible as:
722-
datacat.<catalog>.<team>.<dataset>.extract.mock_data()
723-
datacat.<catalog>.<team>.<dataset>.load.mock_data()
727+
datacat.<catalog>.<team_path_segments>.<dataset>.extract.mock_data()
728+
datacat.<catalog>.<team_path_segments>.<dataset>.load.mock_data()
724729
725730
Args:
726731
datacat (SimpleNamespace): the top-level datacat namespace

docs/data_developer_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ load_schema = pa.DataFrameSchema({
170170

171171
# Add mock data generation for testing
172172
# prefix with 'extract' or 'load'
173-
def extract_mock_data(output = "pandas", size = 10) -> pd.DataFrame|pl.DataFrame:
173+
def extract_mock_data(output="pandas", size=10) -> pd.DataFrame|pl.DataFrame:
174174
data = {
175175
"date": pd.date_range(
176176
start="2023-01-01",

0 commit comments

Comments
 (0)