APP-6839: Migrate to uv

Author: Aryamanz29

.pre-commit-config.yaml

@@ -7,6 +7,7 @@ repos:
       - id: trailing-whitespace
       - id: debug-statements
 
+  # Use uv to run formatting and QA tools
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.9.7
     hooks:
@@ -15,3 +16,12 @@ repos:
         name: ruff-check-autofix
         args: ["check", "--select", "I", "--fix", "--silent"]
       - id: ruff-format
+  - repo: local
+    hooks:
+      - id: qa-checks
+        name: qa-checks
+        entry: uv run ./qa-checks
+        language: system
+        types: [python]
+        pass_filenames: false
+        stages: [manual]

README.md

@@ -49,7 +49,7 @@ To get started developing the SDK:
 Before committing code, ensure it adheres to the repository's formatting guidelines. You can apply the required formatting using the below command:
 
 ```bash
-./pyatlan-formatter
+uv run ./formatter
 ```
 
 ### Environment Setup
@@ -115,23 +115,22 @@ If you've pushed new typedefs to Atlan and want to generate SDK asset models to
 > [!NOTE]
 > Before running any generator scripts, make sure you have [configured your environment variables](https://developer.atlan.com/sdks/python/#configure-the-sdk) specifically `ATLAN_BASE_URL` and `ATLAN_API_KEY`.
 
-1. Retrieve the typedefs from your Atlan instance and save them to a JSON file by running:
+1. Run the combined generator script that handles all steps automatically:
 
    ```shell
-   python3 pyatlan/generator/create_typedefs_file.py
-   ```
-
-2. Generate the asset `models`, `enums`, and `struct` modules in the SDK based on the typedefs by running:
+   # Use default location (/tmp/typedefs.json)
+   uv run ./generator
 
-   ```shell
-   python3 pyatlan/generator/class_generator.py
+   # Or specify a custom typedefs file location
+   uv run ./generator ./my-typedefs.json
    ```
 
-3. The generated files will be unformatted. To format them properly, run the formatter:
-
-   ```shell
-   ./pyatlan-formatter
-   ```
+   This script will:
+   - Check if typedefs file exists and is current (skip if already created today)
+   - Retrieve typedefs from your Atlan instance if needed
+   - Generate the asset `models`, `enums`, and `struct` modules
+   - Format the generated code automatically
+   - Support custom typedefs file paths for flexibility
 
 ## Attribution
 

pyatlan-formatter renamed to formatter

@@ -8,5 +8,10 @@ untracked_files=$(git ls-files --others --exclude-standard)
 all_files="${changed_files}
 ${untracked_files}"
 
-# Pass the filenames to pre-commit run --files
-echo "$all_files" | tr '\n' '\0' | xargs -0 pre-commit run --files
+# Pass the filenames to pre-commit run --files (qa-checks excluded via manual stage)
+if [ -n "$all_files" ]; then
+    file_args=$(echo "$all_files" | tr '\n' ' ')
+    uv run pre-commit run --files $file_args
+else
+    echo "No files to format."
+fi

generator

@@ -0,0 +1,76 @@
+#!/bin/bash
+
+# Combined generator script for Atlan Python SDK
+# This script runs both create_typedefs_file.py and class_generator.py
+# It intelligently skips creating typedefs if they already exist and are current
+
+# Usage: ./generator [typedefs_file_path]
+# If typedefs_file_path is not provided, defaults to /tmp/typedefs.json
+
+echo "🚀 Starting Atlan Python SDK code generation..."
+
+# Check if ATLAN_BASE_URL and ATLAN_API_KEY are set
+if [ -z "$ATLAN_BASE_URL" ] || [ -z "$ATLAN_API_KEY" ]; then
+    echo "❌ Error: ATLAN_BASE_URL and ATLAN_API_KEY environment variables must be set."
+    echo "Please set these variables before running the generator:"
+    echo "  export ATLAN_BASE_URL='https://your-atlan-instance.com'"
+    echo "  export ATLAN_API_KEY='your-api-key'"
+    exit 1
+fi
+
+# Get the typedefs file path from command line argument or use default
+if [ -n "$1" ]; then
+    TYPE_DEF_FILE="$1"
+    echo "📁 Using custom typedefs file: $TYPE_DEF_FILE"
+else
+    TMPDIR=${TMPDIR:-/tmp}
+    TYPE_DEF_FILE="$TMPDIR/typedefs.json"
+    echo "📁 Using default typedefs file: $TYPE_DEF_FILE"
+fi
+
+# Check if typedefs file exists and is current (created today)
+SHOULD_CREATE_TYPEDEFS=true
+if [ -f "$TYPE_DEF_FILE" ]; then
+    # Check if file was created today
+    if [ "$(date -r "$TYPE_DEF_FILE" +%Y-%m-%d)" = "$(date +%Y-%m-%d)" ]; then
+        echo "✅ Typedefs file already exists and is current: $TYPE_DEF_FILE"
+        SHOULD_CREATE_TYPEDEFS=false
+    else
+        echo "⏰ Typedefs file exists but is not current, will recreate it"
+    fi
+else
+    echo "📄 Typedefs file does not exist, will create it"
+fi
+
+# Step 1: Create typedefs file if needed
+if [ "$SHOULD_CREATE_TYPEDEFS" = true ]; then
+    echo "🔄 Running create_typedefs_file.py..."
+    if uv run python pyatlan/generator/create_typedefs_file.py --typedefs-file "$TYPE_DEF_FILE"; then
+        echo "✅ Typedefs file created successfully"
+    else
+        echo "❌ Failed to create typedefs file"
+        exit 1
+    fi
+else
+    echo "⏭️  Skipping typedefs creation (file is current)"
+fi
+
+# Step 2: Run class generator
+echo "🔄 Running class_generator.py..."
+if uv run python pyatlan/generator/class_generator.py --typedefs-file "$TYPE_DEF_FILE"; then
+    echo "✅ Class generation completed successfully"
+else
+    echo "❌ Class generation failed"
+    exit 1
+fi
+
+# Step 3: Format the generated code
+echo "🎨 Formatting generated code..."
+if uv run ./formatter; then
+    echo "✅ Code formatting completed"
+else
+    echo "⚠️  Code formatting had issues, but generation completed"
+fi
+
+echo "🎉 SDK code generation completed successfully!"
+echo "📁 Generated files are in: pyatlan/model/assets/"

mypy.ini

@@ -95,17 +95,23 @@ def get_type(type_: str):
     return ret_value
 
 
-def get_type_defs() -> TypeDefResponse:
+def get_type_defs(typedefs_file_path=None) -> TypeDefResponse:
+    # Use provided path or default to tmp directory
+    if typedefs_file_path:
+        typedef_file = Path(typedefs_file_path)
+    else:
+        typedef_file = TYPE_DEF_FILE
+
     if (
-        not TYPE_DEF_FILE.exists()
-        or datetime.date.fromtimestamp(os.path.getmtime(TYPE_DEF_FILE))
+        not typedef_file.exists()
+        or datetime.date.fromtimestamp(os.path.getmtime(typedef_file))
         < datetime.date.today()
     ):
         raise ClassGenerationError(
             "File containing typedefs does not exist or is not current."
-            f" Please run create_typedefs_file to create {TYPE_DEF_FILE}."
+            f" Please run create_typedefs_file to create {typedef_file}."
         )
-    with TYPE_DEF_FILE.open() as input_file:
+    with typedef_file.open() as input_file:
         return TypeDefResponse(**json.load(input_file))
 
 
@@ -982,7 +988,19 @@ def filter_attributes_of_custom_entity_type():
 
 
 if __name__ == "__main__":
-    type_defs = get_type_defs()
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        description="Generate Atlan SDK classes from typedefs"
+    )
+    parser.add_argument(
+        "--typedefs-file",
+        type=str,
+        help="Path to the typedefs file (default: /tmp/typedefs.json or $TMPDIR/typedefs.json)",
+    )
+    args = parser.parse_args()
+
+    type_defs = get_type_defs(args.typedefs_file)
     filter_attributes_of_custom_entity_type()
     AssetInfo.sub_type_names_to_ignore = type_defs.custom_entity_def_names
     AssetInfo.set_entity_defs(type_defs.reserved_entity_defs)

pyatlan/generator/class_generator.py

@@ -6,23 +6,46 @@
 environment variables should be set before running this script.
 """
 
+import argparse
+import os
+from pathlib import Path
+
 from pyatlan.client.atlan import AtlanClient
-from pyatlan.generator.class_generator import TYPE_DEF_FILE
 
 
 class ServerError(Exception):
     pass
 
 
-def create_typedef_file():
+def create_typedef_file(typedefs_file_path=None):
+    # Use provided path or default to tmp directory
+    if typedefs_file_path:
+        typedef_file = Path(typedefs_file_path)
+    else:
+        typedef_file = Path(os.getenv("TMPDIR", "/tmp")) / "typedefs.json"
+
     client = AtlanClient()
     type_defs = client.typedef.get_all()
     if len(type_defs.entity_defs) == 0:
         raise ServerError("No entity definitions were returned from the server.")
-    with TYPE_DEF_FILE.open("w") as output_file:
+
+    # Create directory if it doesn't exist
+    typedef_file.parent.mkdir(parents=True, exist_ok=True)
+
+    with typedef_file.open("w") as output_file:
         output_file.write(type_defs.json())
-    print(f"{TYPE_DEF_FILE} has been created.")
+    print(f"{typedef_file} has been created.")
 
 
 if __name__ == "__main__":
-    create_typedef_file()
+    parser = argparse.ArgumentParser(
+        description="Create typedefs file from Atlan instance"
+    )
+    parser.add_argument(
+        "--typedefs-file",
+        type=str,
+        help="Path to the typedefs file (default: /tmp/typedefs.json or $TMPDIR/typedefs.json)",
+    )
+    args = parser.parse_args()
+
+    create_typedef_file(args.typedefs_file)

pyatlan/generator/create_typedefs_file.py

@@ -1,26 +1,26 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright 2025 Atlan Pte. Ltd.
 
-import pkg_resources  # type: ignore[import-untyped]
+import importlib.metadata
 
 from pyatlan.errors import DependencyNotFoundError
 
 # Check if pytest-vcr plugin is installed
 try:
-    pkg_resources.get_distribution("pytest-vcr")
-except pkg_resources.DistributionNotFound:
+    importlib.metadata.distribution("pytest-vcr")
+except importlib.metadata.PackageNotFoundError:
     raise DependencyNotFoundError(
         "pytest-vcr plugin is not installed. Please install pytest-vcr."
     )
 
 # Check if vcrpy is installed and ensure the version is 6.0.x
 try:
-    vcr_version = pkg_resources.get_distribution("vcrpy").version
+    vcr_version = importlib.metadata.distribution("vcrpy").version
     if not vcr_version.startswith("6.0"):
         raise DependencyNotFoundError(
             f"vcrpy version 6.0.x is required, but found {vcr_version}. Please install the correct version."
         )
-except pkg_resources.DistributionNotFound:
+except importlib.metadata.PackageNotFoundError:
     raise DependencyNotFoundError(
         "vcrpy version 6.0.x is not installed. Please install vcrpy version 6.0.x."
     )

pyatlan/test_utils/base_vcr.py

@@ -0,0 +1,104 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyatlan"
+dynamic = ["version"]
+description = "Atlan Python Client"
+readme = "README.md"
+license = {text = "Apache LICENSE 2.0"}
+authors = [
+    {name = "Atlan Technologies Pvt Ltd", email = "[email protected]"}
+]
+maintainers = [
+    {name = "Atlan Technologies Pvt Ltd", email = "[email protected]"}
+]
+keywords = ["atlan", "client"]
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "requests~=2.32.3",
+    "pydantic~=2.10.6",
+    "jinja2~=3.1.6",
+    "tenacity~=9.0.0",
+    "urllib3>=1.26.0,<3",
+    "lazy_loader~=0.4",
+    "nanoid~=2.0.0",
+    "pytz~=2025.1",
+    "python-dateutil~=2.9.0.post0",
+    "PyYAML~=6.0.2",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy~=1.9.0",
+    "ruff~=0.9.9",
+    "types-requests~=2.31.0.6",
+    "types-setuptools~=75.8.0.20250110",
+    "pytest~=8.3.4",
+    "pytest-vcr~=1.0.2",
+    "vcrpy~=6.0.2",
+    "pytest-order~=1.3.0",
+    "pytest-timer[termcolor]~=1.0.0",
+    "pytest-sugar~=1.0.0",
+    "retry~=0.9.2",
+    "pre-commit~=3.5.0",
+    "deepdiff~=7.0.1",
+    "pytest-cov~=5.0.0",
+    "twine~=6.1.0",
+    "types-retry~=0.9.9.20241221",
+    "networkx~=3.1.0",
+    "networkx-stubs~=0.0.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/atlanhq/atlan-python"
+Repository = "https://github.com/atlanhq/atlan-python"
+Documentation = "https://github.com/atlanhq/atlan-python"
+Issues = "https://github.com/atlanhq/atlan-python/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pyatlan*"]
+
+[tool.setuptools.package-data]
+pyatlan = ["py.typed", "logging.conf"]
+"*" = ["*.jinja2"]
+
+[tool.setuptools.dynamic]
+version = {file = "pyatlan/version.txt"}
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+fix = true
+line-length = 88
+exclude = ["env", "venv", "__pycache__"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101"]
+"pyatlan/model/assets.py" = ["S307"]
+"pyatlan/model/assets/**.py" = ["E402", "F811"]
+"pyatlan/model/assets/core/**.py" = ["E402", "F811"]
+
+[tool.pytest.ini_options]
+addopts = "-p no:name_of_plugin"
+filterwarnings = [
+    "ignore::DeprecationWarning",
+    "ignore:urllib3 v2 only supports OpenSSL 1.1.1+",
+]