Merge pull request #385 from skalish/update-imports

TC: Migrate imports to new style

docs/contributor-guide.md

@@ -7,4 +7,5 @@
   * [Navigating Inheritance](contributor-guide/navigating-inheritance)
   * [Pull Requests](contributor-guide/pull-request)
   * [Run and Build](contributor-guide/run-and-build)
+  * [Style Guide](contributor-guide/style-guide)
   * [Toolchain](contributor-guide/toolchain)

docs/contributor-guide/style-guide.md

@@ -0,0 +1,19 @@
+# Style Guide
+
+### Formatting
+Code should generally conform to the [PEP8 style guidelines](https://www.python.org/dev/peps/pep-0008/). 
+  * [Flake8](https://flake8.pycqa.org/en/latest/) is a linter to help check that code is aligned with these formatting requirements
+  * [Black](https://black.readthedocs.io/en/stable/) is a formatter that can be used to automatically reformat code to resolve many (but not all) formatting issues
+  * For details on using these tools [see here](run-and-build)
+
+### Structure
+* Classes with methods should be avoided in favor of simple [dataclasses](https://docs.python.org/3/library/dataclasses.html) and functions
+
+### Google-style docstrings
+All functions and class definitions should use [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) and be annotated with [type hints](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#type-annotations).
+
+### Internal Imports
+When importing from within `tamr-client`:
+* Use import statements for modules, classes, and exceptions
+* Never import functions directly. Instead import the containing module and use `module.function`
+* Use `from foo import bar` instead of `import foo.bar as bar`

tamr_client/__init__.py

@@ -19,26 +19,26 @@
 ##################
 
 # utilities
-import tamr_client.response as response
+from tamr_client import response
 
 # instance
 from tamr_client.instance import Instance
-import tamr_client.instance as instance
+from tamr_client import instance
 
 # url
 from tamr_client.url import URL
-import tamr_client.url as url
+from tamr_client import url
 
 # auth
 from tamr_client.auth import UsernamePasswordAuth
 
 # session
 from tamr_client.session import Session
-import tamr_client.session as session
+from tamr_client import session
 
 # datasets
 from tamr_client.dataset import Dataset, DatasetNotFound
-import tamr_client.dataset as dataset
+from tamr_client import dataset
 
 # records
 from tamr_client.dataset.record import PrimaryKeyNotFound
@@ -50,10 +50,10 @@
 
 # attributes
 from tamr_client.attributes.subattribute import SubAttribute
-import tamr_client.attributes.subattribute as subattribute
+from tamr_client.attributes import subattribute
 
 from tamr_client.attributes.attribute_type import AttributeType
-import tamr_client.attributes.attribute_type as attribute_type
+from tamr_client.attributes import attribute_type
 
 import tamr_client.attributes.type_alias
 
@@ -63,7 +63,7 @@
     AttributeExists,
     AttributeNotFound,
 )
-import tamr_client.attributes.attribute as attribute
+from tamr_client.attributes import attribute
 
-import tamr_client.mastering as mastering
-import tamr_client.project as project
+from tamr_client import mastering
+from tamr_client import project

tamr_client/attributes/attribute.py

@@ -5,11 +5,10 @@
 from dataclasses import dataclass, field, replace
 from typing import Optional, Tuple
 
-import tamr_client.attributes.attribute_type as attribute_type
+from tamr_client import response
+from tamr_client.attributes import attribute_type, type_alias
 from tamr_client.attributes.attribute_type import AttributeType
-import tamr_client.attributes.type_alias as type_alias
 from tamr_client.dataset.dataset import Dataset
-import tamr_client.response as response
 from tamr_client.session import Session
 from tamr_client.types import JsonDict
 from tamr_client.url import URL

tamr_client/dataset/dataset.py

@@ -5,8 +5,8 @@
 from dataclasses import dataclass
 from typing import Optional, Tuple
 
+from tamr_client import response
 from tamr_client.instance import Instance
-import tamr_client.response as response
 from tamr_client.session import Session
 from tamr_client.types import JsonDict
 from tamr_client.url import URL

tamr_client/dataset/record.py

@@ -7,8 +7,8 @@
 import json
 from typing import cast, Dict, IO, Iterable, Optional
 
+from tamr_client import response
 from tamr_client.dataset.dataset import Dataset
-import tamr_client.response as response
 from tamr_client.session import Session
 from tamr_client.types import JsonDict
 

tamr_client/project.py

@@ -1,9 +1,9 @@
 from typing import Union
 
+from tamr_client import response
 from tamr_client.instance import Instance
-import tamr_client.mastering.project as mastering_project
+from tamr_client.mastering import project as mastering_project
 from tamr_client.mastering.project import Project as MasteringProject
-import tamr_client.response as response
 from tamr_client.session import Session
 from tamr_client.types import JsonDict
 from tamr_client.url import URL

tamr_client/url.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 
-import tamr_client.instance as instance
+from tamr_client import instance
 from tamr_client.instance import Instance
 
 

tests/tamr_client/attributes/test_attribute.py

@@ -4,7 +4,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 def test_from_json():

tests/tamr_client/attributes/test_attribute_type.py

@@ -1,5 +1,5 @@
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 def test_from_json():

tests/tamr_client/datasets/test_dataframe.py

@@ -6,7 +6,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 @responses.activate

tests/tamr_client/datasets/test_dataset.py

@@ -2,7 +2,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 @responses.activate

tests/tamr_client/datasets/test_record.py

@@ -5,7 +5,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 @responses.activate

tests/tamr_client/test_project.py

@@ -2,7 +2,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 @responses.activate

tests/tamr_client/test_response.py

@@ -3,7 +3,7 @@
 import responses
 
 import tamr_client as tc
-import tests.tamr_client.utils as utils
+from tests.tamr_client import utils
 
 
 @responses.activate