Merge pull request #409 from pcattori/move-types

Move all remaining types into _types package

tamr_client/__init__.py

@@ -21,11 +21,15 @@
     Attribute,
     AttributeType,
     Dataset,
+    Instance,
     MasteringProject,
+    Operation,
     Project,
+    Session,
     SubAttribute,
     UnifiedDataset,
     URL,
+    UsernamePasswordAuth,
 )
 
 # functions
@@ -35,14 +39,9 @@
 from tamr_client import response
 
 # instance
-from tamr_client.instance import Instance
 from tamr_client import instance
 
-# auth
-from tamr_client.auth import UsernamePasswordAuth
-
 # session
-from tamr_client.session import Session
 from tamr_client import session
 
 # datasets
@@ -63,5 +62,4 @@
 from tamr_client import project
 
 # operations
-from tamr_client.operation import Operation
 from tamr_client import operation

tamr_client/_types/__init__.py

@@ -15,7 +15,11 @@
     STRING,
     SubAttribute,
 )
+from tamr_client._types.auth import UsernamePasswordAuth
 from tamr_client._types.dataset import AnyDataset, Dataset, UnifiedDataset
+from tamr_client._types.instance import Instance
 from tamr_client._types.json import JsonDict
+from tamr_client._types.operation import Operation
 from tamr_client._types.project import MasteringProject, Project
+from tamr_client._types.session import Session
 from tamr_client._types.url import URL

tamr_client/_types/instance.py

@@ -0,0 +1,17 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass(frozen=True)
+class Instance:
+    """Connection parameters for a running Tamr instance
+
+    Args:
+        protocol
+        host
+        port
+    """
+
+    protocol: str = "http"
+    host: str = "localhost"
+    port: Optional[int] = None

tamr_client/_types/operation.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+from typing import Dict, Optional
+
+from tamr_client._types.url import URL
+
+
+@dataclass(frozen=True)
+class Operation:
+    """A Tamr operation
+
+    See https://docs.tamr.com/new/reference/the-operation-object
+
+    Args:
+        url
+        type
+        status
+        description
+    """
+
+    url: URL
+    type: str
+    status: Optional[Dict[str, str]] = None
+    description: Optional[str] = None

tamr_client/_types/session.py

@@ -0,0 +1,3 @@
+import requests
+
+Session = requests.Session

tamr_client/_types/url.py

@@ -1,7 +1,6 @@
 from dataclasses import dataclass
 
-from tamr_client import instance
-from tamr_client.instance import Instance
+from tamr_client._types.instance import Instance
 
 
 @dataclass(frozen=True)
@@ -11,5 +10,7 @@ class URL:
     base_path: str = "api/versioned/v1"
 
     def __str__(self):
+        from tamr_client import instance
+
         origin = instance.origin(self.instance)
         return f"{origin}/{self.base_path}/{self.path}"

tamr_client/attribute/_attribute.py

@@ -6,9 +6,8 @@
 from typing import Optional, Tuple
 
 from tamr_client import response
-from tamr_client._types import Attribute, AttributeType, Dataset, JsonDict, URL
+from tamr_client._types import Attribute, AttributeType, Dataset, JsonDict, Session, URL
 from tamr_client.attribute import type as attribute_type
-from tamr_client.session import Session
 
 
 _RESERVED_NAMES = frozenset(

tamr_client/dataset/_dataset.py

@@ -4,9 +4,7 @@
 from copy import deepcopy
 
 from tamr_client import response
-from tamr_client._types import Dataset, JsonDict, URL
-from tamr_client.instance import Instance
-from tamr_client.session import Session
+from tamr_client._types import Dataset, Instance, JsonDict, Session, URL
 
 
 class NotFound(Exception):

tamr_client/dataset/dataframe.py

@@ -6,9 +6,8 @@
 import os
 from typing import Optional, TYPE_CHECKING
 
-from tamr_client._types import Dataset, JsonDict
+from tamr_client._types import Dataset, JsonDict, Session
 from tamr_client.dataset import record
-from tamr_client.session import Session
 
 BUILDING_DOCS = os.environ.get("TAMR_CLIENT_DOCS") == "1"
 if TYPE_CHECKING or BUILDING_DOCS:

tamr_client/dataset/record.py

@@ -8,8 +8,7 @@
 from typing import cast, Dict, IO, Iterable, Iterator, Optional
 
 from tamr_client import response
-from tamr_client._types import AnyDataset, Dataset, JsonDict
-from tamr_client.session import Session
+from tamr_client._types import AnyDataset, Dataset, JsonDict, Session
 
 
 class PrimaryKeyNotFound(Exception):

tamr_client/dataset/unified.py

@@ -4,11 +4,15 @@
 from copy import deepcopy
 
 from tamr_client import operation, response
-from tamr_client._types import JsonDict, UnifiedDataset, URL
-from tamr_client.instance import Instance
-from tamr_client.operation import Operation
-from tamr_client.project import Project
-from tamr_client.session import Session
+from tamr_client._types import (
+    Instance,
+    JsonDict,
+    Operation,
+    Project,
+    Session,
+    UnifiedDataset,
+    URL,
+)
 
 
 class NotFound(Exception):

tamr_client/instance.py

@@ -1,12 +1,4 @@
-from dataclasses import dataclass
-from typing import Optional
-
-
-@dataclass(frozen=True)
-class Instance:
-    protocol: str = "http"
-    host: str = "localhost"
-    port: Optional[int] = None
+from tamr_client._types import Instance
 
 
 def origin(instance: Instance) -> str:

tamr_client/operation.py

@@ -2,16 +2,13 @@
 See https://docs.tamr.com/new/reference/the-operation-object
 """
 from copy import deepcopy
-from dataclasses import dataclass
 from time import sleep, time as now
-from typing import Dict, Optional
+from typing import Optional
 
 import requests
 
 from tamr_client import response
-from tamr_client._types import JsonDict, URL
-from tamr_client.instance import Instance
-from tamr_client.session import Session
+from tamr_client._types import Instance, JsonDict, Operation, Session, URL
 
 
 class NotFound(Exception):
@@ -21,25 +18,6 @@ class NotFound(Exception):
     pass
 
 
-@dataclass(frozen=True)
-class Operation:
-    """A Tamr operation
-
-    See https://docs.tamr.com/new/reference/the-operation-object
-
-    Args:
-        url
-        type
-        status
-        description
-    """
-
-    url: URL
-    type: str
-    status: Optional[Dict[str, str]] = None
-    description: Optional[str] = None
-
-
 def poll(session: Session, operation: Operation) -> Operation:
     """Poll this operation for server-side updates.
 

tamr_client/project.py

@@ -1,8 +1,6 @@
 from tamr_client import response
-from tamr_client._types import JsonDict, Project, URL
-from tamr_client.instance import Instance
+from tamr_client._types import Instance, JsonDict, Project, Session, URL
 from tamr_client.mastering import project as mastering_project
-from tamr_client.session import Session
 
 
 class NotFound(Exception):

tamr_client/session.py

@@ -1,6 +1,6 @@
 import requests
 
-Session = requests.Session
+from tamr_client._types import Session
 
 
 def from_auth(auth: requests.auth.HTTPBasicAuth) -> Session: