Merge pull request #679 from atlanhq/APP-5243

APP-5243: Migrate to `httpx` (goodbye `requests` 👋 )


- Completely removed support for requests and replaced it with httpx (which supports both sync and async clients)
- Implemented AsyncAtlanClient for all async operations (extends AtlanClient for reusability)
- Refactored all existing clients, caches, and several creators (connection, badge, etc.) to support async variants, and added new models (mainly search result models that require async iteration). Following aio directory convention for all async components.
- Used a "sandwich approach" for refactoring: extracted common functionality (request preparation and response processing) into a separate common sub-package. This enables reuse across both sync and async operations - only the middle layer (API calling with respective clients) differs.

Author: Aryamanz29

.conda-envs/meta.yaml

@@ -16,7 +16,7 @@ requirements:
     - setuptools
     - python
   run:
-    - python >=3.9,<3.13
+    - python >=3.9,<4
     - jinja2 ~=3.1.6
     - lazy_loader ~=0.4
     - pydantic ~=2.11.7

.github/workflows/pyatlan-pr.yaml

@@ -1,5 +1,12 @@
 name: Pyatlan Pull Request Build
 
+# This workflow runs both sync and async integration tests intelligently:
+# - Sync integration tests: Always run on every PR
+# - Async integration tests: Only run when:
+#   1. Changes detected in pyatlan/*/aio/ or tests/*/aio/ paths
+#   2. PR has the "run-async-tests" label (manual trigger)
+# This prevents adding 12+ minutes to every PR while ensuring async tests run when needed.
+
 on:
   pull_request:
   workflow_dispatch:
@@ -39,11 +46,45 @@ jobs:
             vulnerability-service: osv
             inputs: .
 
+  check-aio-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      run-async-tests: ${{ steps.check-conditions.outputs.run-async-tests }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check for AIO changes or manual trigger
+        id: check-conditions
+        run: |
+          # Check if PR has the run-async-tests label
+          if echo '${{ toJson(github.event.pull_request.labels.*.name) }}' | grep -q "run-async-tests"; then
+            echo "run-async-tests=true" >> $GITHUB_OUTPUT
+            echo "🏷️ Manual trigger: Found 'run-async-tests' label"
+            exit 0
+          fi
+          
+          # Check for changes in AIO-related paths
+          if git diff --name-only origin/${{ github.event.pull_request.base.ref }}...HEAD | grep -E "(pyatlan/.*aio/|tests/.*aio/)"; then
+            echo "run-async-tests=true" >> $GITHUB_OUTPUT
+            echo "🔍 Change detection: Found AIO-related changes:"
+            aio_files=$(git diff --name-only origin/${{ github.event.pull_request.base.ref }}...HEAD | grep -E "(pyatlan/.*aio/|tests/.*aio/)")
+            echo "$aio_files" | head -20
+            total_count=$(echo "$aio_files" | wc -l)
+            echo "📊 Total AIO files changed: $total_count"
+          else
+            echo "run-async-tests=false" >> $GITHUB_OUTPUT
+            echo "⏭️ No AIO changes detected and no manual trigger label found"
+          fi
+
   qa-checks-and-unit-tests:
     needs: [vulnerability-scan]
     runs-on: ubuntu-latest
     outputs:
       files: ${{ steps.distribute-integration-test-files.outputs.files }}
+      aio-files: ${{ steps.distribute-aio-test-files.outputs.aio-files }}
     strategy:
       matrix:
         # Specify version as a string
@@ -73,7 +114,7 @@ jobs:
           ATLAN_API_KEY: ${{ secrets.ATLAN_API_KEY }}
           ATLAN_BASE_URL: ${{ secrets.ATLAN_BASE_URL }}
         # Run with `pytest-sugar` for enhancing the overall test report output
-        run: uv run pytest tests/unit --force-sugar
+        run: uv run pytest tests/unit --force-sugar -vv
 
       - name: Prepare integration tests distribution
         id: distribute-integration-test-files
@@ -83,6 +124,22 @@ jobs:
           json_files=$(echo "${files[@]}" | jq -R -c 'split(" ")[:-1]')
           echo "files=$json_files" >> $GITHUB_OUTPUT
 
+      - name: Prepare async integration tests distribution
+        id: distribute-aio-test-files
+        run: |
+          # Check if AIO test directory exists and has test files
+          if [ -d "tests/integration/aio" ]; then
+            aio_files=$(find tests/integration/aio -name "test_*.py" -o -name "*_test.py" | tr '\n' ' ')
+            if [ -n "$aio_files" ]; then
+              json_aio_files=$(echo "${aio_files[@]}" | jq -R -c 'split(" ")[:-1]')
+              echo "aio-files=$json_aio_files" >> $GITHUB_OUTPUT
+            else
+              echo "aio-files=[]" >> $GITHUB_OUTPUT
+            fi
+          else
+            echo "aio-files=[]" >> $GITHUB_OUTPUT
+          fi
+
   integration-tests:
     needs: [vulnerability-scan, qa-checks-and-unit-tests]
     runs-on: ubuntu-latest
@@ -120,4 +177,46 @@ jobs:
           timeout_minutes: 10 # Maximum time per test job; otherwise, the job will fail
           # Run the integration test file using `pytest-timer` plugin
           # to display only the durations of the 10 slowest tests with `pytest-sugar`
-          command: uv run pytest ${{ matrix.test_file }} -p name_of_plugin --timer-top-n 10 --force-sugar
+          command: uv run pytest ${{ matrix.test_file }} -p name_of_plugin --timer-top-n 10 --force-sugar -vv
+
+
+  async-integration-tests:
+    needs: [vulnerability-scan, qa-checks-and-unit-tests, check-aio-changes]
+    runs-on: ubuntu-latest
+    # Only run if AIO changes detected or manual trigger
+    if: needs.check-aio-changes.outputs.run-async-tests == 'true'
+    strategy:
+      fail-fast: false
+      matrix:
+        test_file: ${{fromJson(needs.qa-checks-and-unit-tests.outputs.aio-files)}}
+    concurrency:
+      group: async-${{ matrix.test_file }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          # Specify version as a string
+          # https://github.com/actions/setup-python/issues/160"
+          python-version: "3.9"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run async integration tests
+        env: # Test tenant environment variables
+          ATLAN_API_KEY: ${{ secrets.ATLAN_API_KEY }}
+          ATLAN_BASE_URL: ${{ secrets.ATLAN_BASE_URL }}
+        uses: nick-fields/retry@v3
+        with:
+          max_attempts: 3
+          timeout_minutes: 15 # Async tests may take longer, increased timeout
+          # Run the async integration test file using `pytest-timer` plugin
+          # to display only the durations of the 10 slowest tests with `pytest-sugar`
+          command: uv run pytest ${{ matrix.test_file }} -p name_of_plugin --timer-top-n 10 --force-sugar -vv

.github/workflows/pyatlan-test-cron.yaml

@@ -37,4 +37,4 @@ jobs:
         # to display only the durations of the 25 slowest tests with `pytest-sugar`
         run: |
           uv run pytest tests/unit
-          uv run pytest tests/integration  -p name_of_plugin --timer-top-n 25
+          uv run pytest tests/integration  -p name_of_plugin --timer-top-n 25 -vv

docs/asset/appworkflowrun.rst

@@ -0,0 +1,10 @@
+.. _appworkflowrun:
+
+AppWorkflowRun
+==============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AppWorkflowRun
+    :members:

docs/asset/databricksnotebook.rst

@@ -0,0 +1,10 @@
+.. _databricksnotebook:
+
+DatabricksNotebook
+==================
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: DatabricksNotebook
+    :members:

docs/asset/microstrategycolumn.rst

@@ -0,0 +1,10 @@
+.. _microstrategycolumn:
+
+MicroStrategyColumn
+===================
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: MicroStrategyColumn
+    :members:

docs/asset/notebook.rst

@@ -0,0 +1,10 @@
+.. _notebook:
+
+Notebook
+========
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Notebook
+    :members:

docs/asset/qlikcolumn.rst

@@ -0,0 +1,10 @@
+.. _qlikcolumn:
+
+QlikColumn
+==========
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: QlikColumn
+    :members:

docs/assets.rst

@@ -47,6 +47,7 @@ You can interact with all of the following different kinds of assets:
     asset/anomalo
     asset/anomalocheck
     asset/app
+    asset/appworkflowrun
     asset/application
     asset/applicationfield
     asset/asset
@@ -124,6 +125,7 @@ You can interact with all of the following different kinds of assets:
     asset/databricks
     asset/databricksaimodelcontext
     asset/databricksaimodelversion
+    asset/databricksnotebook
     asset/databricksunitycatalogtag
     asset/dataverse
     asset/dataverseattribute
@@ -204,6 +206,7 @@ You can interact with all of the following different kinds of assets:
     asset/metric
     asset/microstrategy
     asset/microstrategyattribute
+    asset/microstrategycolumn
     asset/microstrategycube
     asset/microstrategydocument
     asset/microstrategydossier
@@ -232,6 +235,7 @@ You can interact with all of the following different kinds of assets:
     asset/multidimensionaldataset
     asset/namespace
     asset/nosql
+    asset/notebook
     asset/objectstore
     asset/persona
     asset/powerbi
@@ -260,6 +264,7 @@ You can interact with all of the following different kinds of assets:
     asset/qlik
     asset/qlikapp
     asset/qlikchart
+    asset/qlikcolumn
     asset/qlikdataset
     asset/qliksheet
     asset/qlikspace
@@ -366,5 +371,3 @@ You can interact with all of the following different kinds of assets:
     asset/view
     asset/workflow
     asset/workflowrun
-    asset/alpha_dqrule
-    asset/alpha_dqruletemplate

pyatlan/cache/__init__.py

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: Apache-2.0
-# Copyright 2022 Atlan Pte. Ltd.
+# Copyright 2025 Atlan Pte. Ltd.
 # Based on original code from https://github.com/apache/atlas (under Apache-2.0 license)