Fixing model constructions for pydantic + formatting/import organizin…

…g + flake8 config + bump for next release

.flake8

@@ -0,0 +1,9 @@
+[flake8]
+max-line-length = 99
+exclude =
+  .git,
+  .tox,
+  build,
+  dist,
+  .mypy_cache,
+  .pytest_cache,

onboard/client/client.py

@@ -1,14 +1,16 @@
 import urllib.parse
-from urllib3.util.retry import Retry
 from datetime import datetime
+from typing import List, Dict, Any, Optional, Tuple, Union, Iterator
+
 import deprecation
 from orjson import loads
-from typing import List, Dict, Any, Optional, Tuple, Union, Iterator
-from .util import divide_chunks, json
+from urllib3.util.retry import Retry
+
+from .exceptions import OnboardApiException
+from .helpers import ClientBase
 from .models import PointSelector, PointDataUpdate, IngestStats, \
     TimeseriesQuery, PointData
-from .helpers import ClientBase
-from .exceptions import OnboardApiException
+from .util import divide_chunks, json
 
 
 class APIClient(ClientBase):
@@ -82,6 +84,7 @@ def check_data_availability(self,
                                 selector: PointSelector
                                 ) -> Tuple[Optional[datetime], Optional[datetime]]:
         """Returns a tuple of data timestamps (most stale, most recent) for selected points"""
+
         @json
         def get_as_json():
             return self.post('/points/data-availability', json=selector.json())
@@ -130,8 +133,7 @@ def get_points(url):
         return points
 
     # Deprecated
-    def get_points_by_datasource(self, datasource_hashes: List[str]) \
-            -> List[Dict[str, str]]:
+    def get_points_by_datasource(self, datasource_hashes: List[str]) -> List[Dict[str, str]]:
         datasource_hashes_chunked = list(divide_chunks(datasource_hashes, 125))
 
         @json
@@ -193,6 +195,7 @@ def stream_point_timeseries(self, query: TimeseriesQuery) -> Iterator[PointData]
         def query_call():
             return self.post('/query-v2', json=query.json(), stream=True,
                              headers={'Accept': 'application/x-ndjson'})
+
         query_call.raw_response = True  # type: ignore[attr-defined]
 
         try:

onboard/client/dataframes.py

@@ -1,5 +1,7 @@
-import pandas as pd
 from typing import Iterable, Dict, List, Union
+
+import pandas as pd
+
 from onboard.client.models import PointData
 
 

onboard/client/helpers.py

@@ -1,8 +1,10 @@
 import datetime
+from typing import Optional, Union, Any
+
 import requests
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
-from typing import Optional, Union, Any
+
 from .exceptions import OnboardApiException
 from .util import json
 

onboard/client/models.py

@@ -3,8 +3,7 @@
 from datetime import datetime, timezone
 from typing import List, Optional, Union, Dict
 
-from pydantic import field_validator, BaseModel, ConfigDict
-from pydantic.dataclasses import dataclass
+from pydantic import field_validator, ConfigDict, BaseModel
 
 
 class PointDataUpdate(object):
@@ -62,8 +61,7 @@ def json(self):
         }
 
 
-@dataclass
-class PointSelector:
+class PointSelector(BaseModel):
     """A flexible interface to allow users to select sets of points"""
     # id, name, short_name or name_abbr
     orgs: List[Union[int, str]] = field(default_factory=list)
@@ -106,7 +104,6 @@ def from_json(dict):
         return ps
 
 
-@dataclass
 class TimeseriesQuery(BaseModel):
     """Parameters needed to fetch timeseries data.
 
@@ -132,7 +129,7 @@ class TimeseriesQuery(BaseModel):
     @field_validator('point_ids')
     def points_or_selector_required(cls, point_ids, values):
         has_points = len(point_ids) > 0
-        has_selector = values.get('selector') is not None
+        has_selector = values.data.get('selector') is not None
         if has_points == has_selector:
             raise ValueError("Exactly one of 'point_ids' or 'selector' is required")
         return point_ids
@@ -153,11 +150,11 @@ def json(self):
         }
 
 
-@dataclass
 class PointData(BaseModel):
+    model_config = ConfigDict(extra='allow')
+
     point_id: int
     raw: str
     unit: str
     columns: List[str]
     values: List[List[Union[str, float, int, None]]]
-    model_config = ConfigDict(extra='allow', )

onboard/client/staging.py

@@ -1,5 +1,7 @@
-from urllib3.util.retry import Retry
 from typing import List, Dict, Any, Optional
+
+from urllib3.util.retry import Retry
+
 from .helpers import ClientBase
 from .util import json
 
@@ -39,6 +41,7 @@ def get_equipment_and_points(self, building_id: int) -> Dict:
 
     def get_staged_equipment_csv(self, building_id: int) -> str:
         """Fetch staged equipment and points together in tabular form"""
+
         @json
         def get_csv():
             return self.get(f'/staging/{building_id}',

onboard/client/util.py

@@ -1,6 +1,8 @@
+from typing import List, Iterable, TypeVar, Callable
+
 import requests
+
 from .exceptions import OnboardApiException, OnboardTemporaryException
-from typing import List, Iterable, TypeVar, Callable
 
 T = TypeVar('T')
 
@@ -13,6 +15,7 @@ def divide_chunks(input_list: List[T], n: int) -> Iterable[List[T]]:
 
 def json(func: Callable[..., T]) -> Callable[..., T]:
     """Decorator for making sure requests responses are handled consistently"""
+
     # the type annotations on json are a lie to let us type the methods in client
     # with approximate descriptions of the JSON they return, even though the methods
     # as implemented return requests.Response objects
@@ -40,4 +43,5 @@ def wrapper(*args, **kwargs):
             raise e
         except Exception as e:
             raise OnboardApiException(e)
+
     return wrapper

setup.py

@@ -7,7 +7,7 @@
     long_description = f.read()
 
 setup(name='onboard.client',
-      version='1.10.1',
+      version='1.10.2',
       author='Nathan Merritt, John Vines',
       author_email='[email protected]',
       description='Onboard API SDK',

tests/test_models.py

@@ -1,63 +1,51 @@
-# type: ignore
-
 from datetime import datetime, timezone
-from typing import Dict, Any
 
 from onboard.client.models import TimeseriesQuery, PointData
 
 
 def test_timeseries_query():
-    dict = {
-        'point_ids': [1],
-        'start': datetime.utcnow().replace(tzinfo=timezone.utc),
-        'end': datetime.utcnow().replace(tzinfo=timezone.utc),
-    }
-    TimeseriesQuery.model_construct(**dict)
-
-
-def construct(dict: Dict[str, Any]) -> PointData:
-    # Pydantic v2
-    return PointData.model_construct(**dict)  # type: ignore[attr-defined]
+    return TimeseriesQuery(
+        point_ids=[1],
+        start=datetime.utcnow().replace(tzinfo=timezone.utc),
+        end=datetime.utcnow().replace(tzinfo=timezone.utc),
+    )
 
 
 def test_point_data():
-    dict = {
-        'point_id': 1,
-        'raw': 'F',
-        'unit': 'C',
-        'columns': ['timestamp', 'raw', 'C'],
-        'values': [
+    PointData(
+        point_id=1,
+        raw='F',
+        unit='C',
+        columns=['timestamp', 'raw', 'C'],
+        values=[
             ['2020-12-16', 32.0, 0.0],
         ]
-    }
-    construct(dict)
+    )
 
 
 def test_point_data_none_value():
-    dict = {
-        'point_id': 1,
-        'raw': 'F',
-        'unit': 'C',
-        'columns': ['timestamp', 'raw', 'C'],
-        'values': [
+    PointData(
+        point_id=1,
+        raw='F',
+        unit='C',
+        columns=['timestamp', 'raw', 'C'],
+        values=[
             ['2020-12-16', None, 0.0],
         ]
-    }
-    construct(dict)
+    )
 
 
 def test_point_data_extra_keys():
-    dict = {
-        'point_id': 1,
-        'raw': 'F',
-        'unit': 'C',
-        'columns': ['timestamp', 'raw', 'C'],
-        'values': [
+    constructed = PointData(
+        point_id=1,
+        raw='F',
+        unit='C',
+        columns=['timestamp', 'raw', 'C'],
+        values=[
             ['2020-12-16', 32.0, 0.0],
         ],
-        'foo': 'bar',
-        'zip': {'zap': 1},
-    }
-    constructed = construct(dict)
-    assert constructed.foo == 'bar'
+        foo='bar',
+        zip={'zap': 1},
+    )
+    assert constructed.foo == 'bar'  # type: ignore[attr-defined]
     assert constructed.point_id == 1