Semantic Link Functions - Validators

0.14.0 · active · verified Wed Apr 15

Semantic Link Functions - Validators is a Python library that extends Microsoft FabricDataFrames with semantic validation capabilities. It provides built-in functions for validating common data types such as email addresses and credit card numbers, leveraging the underlying 'validators' Python package. This library is part of the broader Microsoft Fabric semantic link ecosystem, enabling enhanced data quality within data science workflows in Fabric notebooks. It is actively maintained, with the current version being 0.14.0.

Warnings

breaking The broader 'semantic-link' meta-package (and 'semantic-link-sempy') has reported breaking compatibility with 'pandas >= 3.0', leading to 'AttributeError: 'types.SimpleNamespace' object has no attribute 'suffixes''. As 'semantic-link-functions-validators' integrates with 'FabricDataFrame' (a pandas subclass), this incompatibility may affect its usage if 'pandas 3.0+' is in the environment with older 'semantic-link' or 'sempy' versions.
Fix: Downgrade pandas to a version below 3.0, or ensure you are using a compatible version of 'semantic-link' (e.g., semantic-link >= 0.13.1 or semantic-link-sempy >= 0.9.4) which includes a fix. Alternatively, install 'semantic-link-sempy' instead of the full 'semantic-link' meta-package if you only need core SemPy functionalities and individual function packages.
gotcha This library is primarily designed for use within Microsoft Fabric notebooks and leverages the `FabricDataFrame` structure and semantic link's environment. While the `FabricDataFrame` can be instantiated locally (as shown in the quickstart for demonstration), some functionalities, especially those involving metadata propagation or interaction with Power BI semantic models, might require a genuine Fabric environment for full operation and discovery of semantic functions.
Fix: For full functionality and integration, run this library within a Microsoft Fabric notebook. Ensure the appropriate Fabric runtime (Spark 3.4+) is used, where 'semantic-link' may be preinstalled or easily updated.
gotcha Authentication issues (403 errors) have been reported when using `sempy.fabric` functions, which `semantic-link-functions-validators` relies upon. This can stem from environment context or token acquisition problems within Fabric notebooks.
Fix: Check Microsoft Fabric documentation for current authentication best practices. Consider downgrading the `semantic-link-sempy` package to a stable version (e.g., 0.9.3 was mentioned as a workaround in some cases) or ensuring the workspace environment is correctly configured to provide valid tokens.

Install

pip install semantic-link-functions-validators Install latest version

Imports

FabricDataFrame
```
from sempy.fabric import FabricDataFrame
```
Validation functions are exposed dynamically on FabricDataFrames. Ensure 'sempy' is installed and available.

Quickstart

This quickstart demonstrates how to use `semantic-link-functions-validators` to validate email addresses and credit card numbers within a `FabricDataFrame`. The validation functions (`is_email`, `is_credit_card`) are called directly as methods on the DataFrame series. This example is designed for use within a Microsoft Fabric notebook environment where `FabricDataFrame` is available and semantic link is active.

import pandas as pd
from sempy.fabric import FabricDataFrame

# NOTE: This code is intended to be run within a Microsoft Fabric notebook
# where semantic link is initialized. Running outside might require additional setup.
# For demonstration, we simulate a FabricDataFrame.

try:
    df = FabricDataFrame({
        'email_column': ['test@example.com', 'invalid-email', 'another@domain.co'],
        'cc_number': ['1234-5678-9012-3456', '1111-2222-3333', '4567-8901-2345-6789']
    })
    
    # Apply semantic validation functions directly to the DataFrame columns
    df['is_valid_email'] = df['email_column'].is_email()
    df['is_valid_cc'] = df['cc_number'].is_credit_card()
    
    print(df)
    
except ImportError:
    print("Please ensure 'semantic-link-functions-validators' and 'sempy' are installed.")
    print("Also, consider running this in a Microsoft Fabric environment for full functionality.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →