stash

Max Wang · Max Wang · commit 8ec6e2e1b227 · 2025-11-14T11:48:23.000-08:00
diff --git a/README.md b/README.md
@@ -288,7 +288,7 @@ The client raises structured exceptions for different error scenarios:
 
 ```python
 from PowerPlatform.Dataverse import DataverseClient
-from PowerPlatform.Dataverse.core.errors import HttpError, ValidationError
+from PowerPlatform.Dataverse._core.errors import HttpError, ValidationError
 
 try:
     client.get("account", "invalid-id")
diff --git a/examples/advanced/pandas_integration.py b/examples/advanced/pandas_integration.py
@@ -23,7 +23,7 @@
 # sys.path.append(str(Path(__file__).resolve().parents[2] / "src"))
 
 from PowerPlatform.Dataverse import DataverseClient
-from PowerPlatform.Dataverse.utils.pandas_adapter import PandasODataClient
+from PowerPlatform.Dataverse._utils.pandas_adapter import PandasODataClient
 from azure.identity import InteractiveBrowserCredential
 import traceback
 import requests
diff --git a/examples/basic/functional_testing.py b/examples/basic/functional_testing.py
@@ -31,7 +31,7 @@
 
 # Import SDK components (assumes installation is already validated)
 from PowerPlatform.Dataverse import DataverseClient
-from PowerPlatform.Dataverse.core.errors import HttpError, MetadataError
+from PowerPlatform.Dataverse._core.errors import HttpError, MetadataError
 from azure.identity import InteractiveBrowserCredential
 
 
diff --git a/examples/basic/installation_example.py b/examples/basic/installation_example.py
@@ -73,16 +73,16 @@ def validate_imports():
         print(f"  ✅ DataverseClient class: {DataverseClient}")
         
         # Test submodule imports
-        from PowerPlatform.Dataverse.core.errors import HttpError, MetadataError
+        from PowerPlatform.Dataverse._core.errors import HttpError, MetadataError
         print(f"  ✅ Core errors: HttpError, MetadataError")
         
-        from PowerPlatform.Dataverse.core.config import DataverseConfig
+        from PowerPlatform.Dataverse._core.config import DataverseConfig
         print(f"  ✅ Core config: DataverseConfig")
         
-        from PowerPlatform.Dataverse.utils.pandas_adapter import PandasODataClient
+        from PowerPlatform.Dataverse._utils.pandas_adapter import PandasODataClient
         print(f"  ✅ Utils: PandasODataClient")
         
-        from PowerPlatform.Dataverse.data.odata import ODataClient
+        from PowerPlatform.Dataverse._data.odata import ODataClient
         print(f"  ✅ Data layer: ODataClient")
         
         # Test Azure Identity import
diff --git a/src/PowerPlatform/Dataverse/_core/__init__.py b/src/PowerPlatform/Dataverse/_core/__init__.py
diff --git a/src/PowerPlatform/Dataverse/_core/auth.py b/src/PowerPlatform/Dataverse/_core/auth.py
@@ -1,16 +1,16 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT license.
 
-from __future__ import annotations
-
 """
 Authentication helpers for Dataverse.
 
-This module provides :class:`~PowerPlatform.Dataverse.core.auth.AuthManager`, a thin wrapper over any Azure Identity
-``TokenCredential`` for acquiring OAuth2 access tokens, and :class:`~PowerPlatform.Dataverse.core.auth.TokenPair` for
+This module provides :class:`~PowerPlatform.Dataverse._core.auth.AuthManager`, a thin wrapper over any Azure Identity
+``TokenCredential`` for acquiring OAuth2 access tokens, and :class:`~PowerPlatform.Dataverse._core.auth.TokenPair` for
 storing the acquired token alongside its scope.
 """
 
+from __future__ import annotations
+
 from dataclasses import dataclass
 
 from azure.core.credentials import TokenCredential
@@ -22,9 +22,9 @@ class TokenPair:
     Container for an OAuth2 access token and its associated resource scope.
 
     :param resource: The OAuth2 scope/resource for which the token was acquired.
-    :type resource: ``str``
+    :type resource: :class:`str`
     :param access_token: The access token string.
-    :type access_token: ``str``
+    :type access_token: :class:`str`
     """
     resource: str
     access_token: str
@@ -53,7 +53,7 @@ def acquire_token(self, scope: str) -> TokenPair:
         :param scope: OAuth2 scope string, typically ``"https://<org>.crm.dynamics.com/.default"``.
         :type scope: ``str``
         :return: Token pair containing the scope and access token.
-        :rtype: ~PowerPlatform.Dataverse.core.auth.TokenPair
+        :rtype: ~PowerPlatform.Dataverse._core.auth.TokenPair
         :raises ~azure.core.exceptions.ClientAuthenticationError: If token acquisition fails.
         """
         token = self.credential.get_token(scope)
diff --git a/src/PowerPlatform/Dataverse/_core/config.py b/src/PowerPlatform/Dataverse/_core/config.py
@@ -1,16 +1,16 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT license.
 
-from __future__ import annotations
-
 """
 Dataverse client configuration.
 
-Provides :class:`~PowerPlatform.Dataverse.core.config.DataverseConfig`, a lightweight
+Provides :class:`~PowerPlatform.Dataverse._core.config.DataverseConfig`, a lightweight
 immutable container for locale and (reserved) HTTP tuning options plus the
-convenience constructor :meth:`~PowerPlatform.Dataverse.core.config.DataverseConfig.from_env`.
+convenience constructor :meth:`~PowerPlatform.Dataverse._core.config.DataverseConfig.from_env`.
 """
 
+from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Optional
 
@@ -42,7 +42,7 @@ def from_env(cls) -> "DataverseConfig":
         Create a configuration instance with default settings.
 
         :return: Configuration instance with default values.
-        :rtype: ~PowerPlatform.Dataverse.core.config.DataverseConfig
+        :rtype: ~PowerPlatform.Dataverse._core.config.DataverseConfig
         """
         # Environment-free defaults
         return cls(
diff --git a/src/PowerPlatform/Dataverse/_core/error_codes.py b/src/PowerPlatform/Dataverse/_core/error_codes.py
diff --git a/src/PowerPlatform/Dataverse/_core/errors.py b/src/PowerPlatform/Dataverse/_core/errors.py
@@ -4,11 +4,11 @@
 """
 Structured Dataverse exception hierarchy.
 
-This module provides :class:`~PowerPlatform.Dataverse.core.errors.DataverseError` and
-specialized :class:`~PowerPlatform.Dataverse.core.errors.ValidationError`,
-:class:`~PowerPlatform.Dataverse.core.errors.MetadataError`,
-:class:`~PowerPlatform.Dataverse.core.errors.SQLParseError`, and
-:class:`~PowerPlatform.Dataverse.core.errors.HttpError` for validation, metadata,
+This module provides :class:`~PowerPlatform.Dataverse._core.errors.DataverseError` and
+specialized :class:`~PowerPlatform.Dataverse._core.errors.ValidationError`,
+:class:`~PowerPlatform.Dataverse._core.errors.MetadataError`,
+:class:`~PowerPlatform.Dataverse._core.errors.SQLParseError`, and
+:class:`~PowerPlatform.Dataverse._core.errors.HttpError` for validation, metadata,
 SQL parsing, and Web API HTTP failures.
 """
 
diff --git a/src/PowerPlatform/Dataverse/_core/http.py b/src/PowerPlatform/Dataverse/_core/http.py
@@ -4,7 +4,7 @@
 """
 HTTP client with automatic retry logic and timeout handling.
 
-This module provides :class:`~PowerPlatform.Dataverse.core.http.HttpClient`, a wrapper
+This module provides :class:`~PowerPlatform.Dataverse._core.http.HttpClient`, a wrapper
 around the requests library that adds configurable retry behavior for transient
 network errors and intelligent timeout management based on HTTP method types.
 """
diff --git a/src/PowerPlatform/Dataverse/_data/__init__.py b/src/PowerPlatform/Dataverse/_data/__init__.py
diff --git a/src/PowerPlatform/Dataverse/_data/odata.py b/src/PowerPlatform/Dataverse/_data/odata.py
@@ -14,10 +14,10 @@
 from datetime import datetime, timezone
 import importlib.resources as ir
 
-from ..core.http import HttpClient
+from .._core.http import HttpClient
 from .upload import ODataFileUpload
-from ..core.errors import *
-from ..core.error_codes import (
+from .._core.errors import *
+from .._core.error_codes import (
     http_subcode, 
     is_transient_status,
     VALIDATION_SQL_NOT_STRING,
@@ -82,19 +82,19 @@ def __init__(
         Sets up authentication, base URL, configuration, and internal caches.
 
         :param auth: Authentication manager providing ``acquire_token(scope)`` that returns an object with ``access_token``.
-        :type auth: ~PowerPlatform.Dataverse.core.auth.AuthManager
+        :type auth: ~PowerPlatform.Dataverse._core.auth.AuthManager
         :param base_url: Organization base URL (e.g. ``"https://<org>.crm.dynamics.com"``).
         :type base_url: ``str``
         :param config: Optional Dataverse configuration (HTTP retry, backoff, timeout, language code). If omitted ``DataverseConfig.from_env()`` is used.
-        :type config: ~PowerPlatform.Dataverse.core.config.DataverseConfig | ``None``
+        :type config: ~PowerPlatform.Dataverse._core.config.DataverseConfig | ``None``
         :raises ValueError: If ``base_url`` is empty after stripping.
         """
         self.auth = auth
         self.base_url = (base_url or "").rstrip("/")
         if not self.base_url:
             raise ValueError("base_url is required.")
         self.api = f"{self.base_url}/api/data/v9.2"
-        self.config = config or __import__("PowerPlatform.Dataverse.core.config", fromlist=["DataverseConfig"]).DataverseConfig.from_env()
+        self.config = config or __import__("PowerPlatform.Dataverse._core.config", fromlist=["DataverseConfig"]).DataverseConfig.from_env()
         self._http = HttpClient(
             retries=self.config.http_retries,
             backoff=self.config.http_backoff,
diff --git a/src/PowerPlatform/Dataverse/_data/upload.py b/src/PowerPlatform/Dataverse/_data/upload.py
diff --git a/src/PowerPlatform/Dataverse/_extensions/__init__.py b/src/PowerPlatform/Dataverse/_extensions/__init__.py
diff --git a/src/PowerPlatform/Dataverse/_models/__init__.py b/src/PowerPlatform/Dataverse/_models/__init__.py
diff --git a/src/PowerPlatform/Dataverse/_utils/__init__.py b/src/PowerPlatform/Dataverse/_utils/__init__.py
diff --git a/src/PowerPlatform/Dataverse/_utils/pandas_adapter.py b/src/PowerPlatform/Dataverse/_utils/pandas_adapter.py
@@ -4,7 +4,7 @@
 """
 Pandas-friendly wrappers for Dataverse OData operations.
 
-This module provides :class:`PowerPlatform.Dataverse.utils.pandas_adapter.PandasODataClient`,
+This module provides :class:`PowerPlatform.Dataverse._utils.pandas_adapter.PandasODataClient`,
 a high-level wrapper that enables DataFrame-based CRUD and query operations.
 """
 
@@ -17,7 +17,7 @@
 
 import pandas as pd
 
-from ..data.odata import ODataClient
+from .._data.odata import ODataClient
 
 
 @dataclass
@@ -39,7 +39,7 @@ class PandasODataClient:
     High-level pandas-friendly wrapper for Dataverse OData operations.
 
     :param odata_client: Initialized low-level OData client with authentication configured.
-    :type odata_client: ~PowerPlatform.Dataverse.data.odata.ODataClient
+    :type odata_client: ~PowerPlatform.Dataverse._data.odata.ODataClient
     """
 
     def __init__(self, odata_client: ODataClient) -> None:
diff --git a/src/PowerPlatform/Dataverse/client.py b/src/PowerPlatform/Dataverse/client.py
@@ -7,9 +7,9 @@
 
 from azure.core.credentials import TokenCredential
 
-from .core.auth import AuthManager
-from .core.config import DataverseConfig
-from .data.odata import ODataClient
+from ._core.auth import AuthManager
+from ._core.config import DataverseConfig
+from ._data.odata import ODataClient
 
 
 class DataverseClient:
@@ -18,7 +18,7 @@ class DataverseClient:
 
     This client provides a simple, stable interface for interacting with Dataverse environments
     through the Web API. It handles authentication via Azure Identity and delegates HTTP operations
-    to an internal :class:`~PowerPlatform.Dataverse.data.odata.ODataClient`.
+    to an internal :class:`~PowerPlatform.Dataverse._data.odata.ODataClient`.
 
     Key capabilities:
         - OData CRUD operations: create, read, update, delete records
@@ -32,8 +32,8 @@ class DataverseClient:
     :param credential: Azure Identity credential for authentication.
     :type credential: ~azure.core.credentials.TokenCredential
     :param config: Optional configuration for language, timeouts, and retries.
-        If not provided, defaults are loaded from :meth:`~PowerPlatform.Dataverse.core.config.DataverseConfig.from_env`.
-    :type config: ~PowerPlatform.Dataverse.core.config.DataverseConfig or None
+        If not provided, defaults are loaded from :meth:`~PowerPlatform.Dataverse._core.config.DataverseConfig.from_env`.
+    :type config: ~PowerPlatform.Dataverse._core.config.DataverseConfig or None
 
     :raises ValueError: If ``base_url`` is missing or empty after trimming.
 
@@ -89,7 +89,7 @@ def _get_odata(self) -> ODataClient:
         deferring construction until the first API call.
 
         :return: The lazily-initialized low-level client used to perform HTTP requests.
-        :rtype: ~PowerPlatform.Dataverse.data.odata.ODataClient
+        :rtype: ~PowerPlatform.Dataverse._data.odata.ODataClient
         """
         if self._odata is None:
             self._odata = ODataClient(
@@ -360,8 +360,8 @@ def query_sql(self, sql: str):
         :return: List of result row dictionaries. Returns an empty list if no rows match.
         :rtype: ``list[dict]``
 
-        :raises ~PowerPlatform.Dataverse.core.errors.SQLParseError: If the SQL query uses unsupported syntax.
-        :raises ~PowerPlatform.Dataverse.core.errors.HttpError: If the Web API returns an error.
+        :raises ~PowerPlatform.Dataverse._core.errors.SQLParseError: If the SQL query uses unsupported syntax.
+        :raises ~PowerPlatform.Dataverse._core.errors.HttpError: If the Web API returns an error.
 
         .. note::
             The SQL support is limited to read-only queries. Complex joins, subqueries, and certain SQL functions may not be supported. Consult the Dataverse documentation for the current feature set.
@@ -441,7 +441,7 @@ class ItemStatus(IntEnum):
             ``entity_set_name``, ``table_logical_name``, ``metadata_id``, and ``columns_created``.
         :rtype: ``dict``
 
-        :raises ~PowerPlatform.Dataverse.core.errors.MetadataError: If table creation fails or the schema is invalid.
+        :raises ~PowerPlatform.Dataverse._core.errors.MetadataError: If table creation fails or the schema is invalid.
 
         Example:
             Create a table with simple columns::
@@ -486,7 +486,7 @@ def delete_table(self, table_schema_name: str) -> None:
         :param table_schema_name: Schema name of the table (e.g. ``"new_MyTestTable"`` or ``"account"``).
         :type table_schema_name: ``str``
 
-        :raises ~PowerPlatform.Dataverse.core.errors.MetadataError: If the table does not exist or deletion fails.
+        :raises ~PowerPlatform.Dataverse._core.errors.MetadataError: If the table does not exist or deletion fails.
 
         .. warning::
             This operation is irreversible and will delete all records in the table along
@@ -610,7 +610,7 @@ def upload_file(
             ``If-Match: *``. Used for small and chunk modes only.
         :type if_none_match: ``bool``
 
-        :raises ~PowerPlatform.Dataverse.core.errors.HttpError: If the upload fails or the file column is not empty
+        :raises ~PowerPlatform.Dataverse._core.errors.HttpError: If the upload fails or the file column is not empty
             when ``if_none_match=True``.
         :raises FileNotFoundError: If the specified file path does not exist.
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -10,7 +10,7 @@
 
 import pytest
 from unittest.mock import Mock
-from PowerPlatform.Dataverse.core.config import DataverseConfig
+from PowerPlatform.Dataverse._core.config import DataverseConfig
 
 
 @pytest.fixture
diff --git a/tests/unit/core/test_http_errors.py b/tests/unit/core/test_http_errors.py
@@ -2,9 +2,9 @@
 # Licensed under the MIT license.
 
 import pytest
-from PowerPlatform.Dataverse.core.errors import HttpError
-from PowerPlatform.Dataverse.core.error_codes import HTTP_404, HTTP_429, HTTP_500
-from PowerPlatform.Dataverse.data.odata import ODataClient
+from PowerPlatform.Dataverse._core.errors import HttpError
+from PowerPlatform.Dataverse._core.error_codes import HTTP_404, HTTP_429, HTTP_500
+from PowerPlatform.Dataverse._data.odata import ODataClient
 
 class DummyAuth:
     def acquire_token(self, scope):
diff --git a/tests/unit/data/test_enum_optionset_payload.py b/tests/unit/data/test_enum_optionset_payload.py
@@ -4,7 +4,7 @@
 import pytest
 from enum import Enum, IntEnum
 
-from PowerPlatform.Dataverse.data.odata import ODataClient
+from PowerPlatform.Dataverse._data.odata import ODataClient
 
 class DummyAuth:
     def acquire_token(self, scope):  # pragma: no cover - simple stub
diff --git a/tests/unit/data/test_logical_crud.py b/tests/unit/data/test_logical_crud.py
@@ -3,8 +3,8 @@
 
 import types
 import pytest
-from PowerPlatform.Dataverse.data.odata import ODataClient
-from PowerPlatform.Dataverse.core.errors import MetadataError
+from PowerPlatform.Dataverse._data.odata import ODataClient
+from PowerPlatform.Dataverse._core.errors import MetadataError
 
 class DummyAuth:
     def acquire_token(self, scope):
diff --git a/tests/unit/data/test_sql_parse.py b/tests/unit/data/test_sql_parse.py
@@ -2,7 +2,7 @@
 # Licensed under the MIT license.
 
 import pytest
-from PowerPlatform.Dataverse.data.odata import ODataClient
+from PowerPlatform.Dataverse._data.odata import ODataClient
 
 class DummyAuth:
     def acquire_token(self, scope):
