Skip to content

Commit 1a2297a

Browse files
committed
fix:PRComments
1 parent 7d773b4 commit 1a2297a

File tree

10 files changed

+35
-32
lines changed

10 files changed

+35
-32
lines changed

docs/getting_started.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -338,21 +338,20 @@ default connection. The default connection depends on your environment.
338338

339339
With a :class:`.AssetManagementClient` object, you can:
340340

341-
**Asset Operations:**
342-
343341
* Create, delete, query assets and link files to assets.
344342

345-
Example:
343+
* Track asset utilization with start, heartbeat, end, and query history operations.
344+
345+
Examples
346+
~~~~~~~~
347+
348+
Create, delete, and query assets
346349

347350
.. literalinclude:: ../examples/assetmanagement/assets.py
348351
:language: python
349352
:linenos:
350353

351-
**Asset Utilization Operations:**
352-
353-
* Track asset utilization with start, heartbeat, end, and query history operations.
354-
355-
Example:
354+
Track asset utilization
356355

357356
.. literalinclude:: ../examples/assetmanagement/asset_utilization.py
358357
:language: python

examples/assetmanagement/asset_utilization.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
AssetIdentification,
1010
StartUtilizationRequest,
1111
)
12-
from nisystemlink.clients.core._http_configuration import HttpConfiguration
12+
from nisystemlink.clients.core import HttpConfiguration
1313

1414
# Configure connection to SystemLink server
1515
server_configuration = HttpConfiguration(

nisystemlink/clients/assetmanagement/_asset_management_client.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
from typing import List, Optional
55

66
from nisystemlink.clients import core
7+
from nisystemlink.clients.assetmanagement.models._update_utilization_request import (
8+
_UpdateUtilizationRequest,
9+
)
710
from nisystemlink.clients.core._http_configuration import HttpConfiguration
811
from nisystemlink.clients.core._uplink._base_client import BaseClient
912
from nisystemlink.clients.core._uplink._methods import post
@@ -183,7 +186,7 @@ def start_utilization(
183186

184187
@post("assets/end-utilization")
185188
def __end_utilization(
186-
self, request: models.UpdateUtilizationRequest
189+
self, request: _UpdateUtilizationRequest
187190
) -> models.UpdateUtilizationPartialSuccessResponse:
188191
"""End asset utilization tracking.
189192
@@ -215,15 +218,15 @@ def end_utilization(
215218
Raises:
216219
ApiException: If unable to communicate with the asset management service or if there are invalid arguments.
217220
"""
218-
request = models.UpdateUtilizationRequest(
221+
request = _UpdateUtilizationRequest(
219222
utilization_identifiers=ids,
220223
utilization_timestamp=timestamp,
221224
)
222225
return self.__end_utilization(request)
223226

224227
@post("assets/utilization-heartbeat")
225228
def __utilization_heartbeat(
226-
self, request: models.UpdateUtilizationRequest
229+
self, request: _UpdateUtilizationRequest
227230
) -> models.UpdateUtilizationPartialSuccessResponse:
228231
"""Send utilization heartbeat.
229232
@@ -255,7 +258,7 @@ def utilization_heartbeat(
255258
Raises:
256259
ApiException: If unable to communicate with the asset management service or if there are invalid arguments.
257260
"""
258-
request = models.UpdateUtilizationRequest(
261+
request = _UpdateUtilizationRequest(
259262
utilization_identifiers=ids,
260263
utilization_timestamp=timestamp,
261264
)

nisystemlink/clients/assetmanagement/models/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
from ._start_utilization_partial_success_response import (
3333
StartUtilizationPartialSuccessResponse,
3434
)
35-
from ._update_utilization_request import UpdateUtilizationRequest
3635
from ._update_utilization_partial_success_response import (
3736
UpdateUtilizationPartialSuccessResponse,
3837
)

nisystemlink/clients/assetmanagement/models/_asset_identification.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
"""Model for asset identification."""
22

3-
from typing import Optional
4-
53
from nisystemlink.clients.core._uplink._json_model import JsonModel
64

75
from ._asset_types import AssetBusType
@@ -18,20 +16,20 @@ class AssetIdentification(JsonModel):
1816
* ``serial_number``
1917
"""
2018

21-
model_name: Optional[str] = None
19+
model_name: str | None = None
2220
"""Model name of the asset."""
2321

24-
model_number: Optional[int] = None
22+
model_number: int | None = None
2523
"""Model number of the asset."""
2624

27-
serial_number: Optional[str] = None
25+
serial_number: str | None = None
2826
"""Serial number of the asset."""
2927

30-
vendor_name: Optional[str] = None
28+
vendor_name: str | None = None
3129
"""Vendor name of the asset."""
3230

33-
vendor_number: Optional[int] = None
31+
vendor_number: int | None = None
3432
"""Vendor number of the asset."""
3533

36-
bus_type: Optional[AssetBusType] = None
34+
bus_type: AssetBusType | None = None
3735
"""Bus type for the asset."""

nisystemlink/clients/assetmanagement/models/_start_utilization_partial_success_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Model for start utilization partial success response."""
22

3-
from nisystemlink.clients.core._api_error import ApiError
3+
from nisystemlink.clients.core import ApiError
44
from nisystemlink.clients.core._uplink._json_model import JsonModel
55

66
from ._asset_identification import AssetIdentification

nisystemlink/clients/assetmanagement/models/_update_utilization_partial_success_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Model for update utilization partial success response."""
22

3-
from nisystemlink.clients.core._api_error import ApiError
3+
from nisystemlink.clients.core import ApiError
44
from nisystemlink.clients.core._uplink._json_model import JsonModel
55

66

nisystemlink/clients/assetmanagement/models/_update_utilization_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from nisystemlink.clients.core._uplink._json_model import JsonModel
66

77

8-
class UpdateUtilizationRequest(JsonModel):
8+
class _UpdateUtilizationRequest(JsonModel):
99
"""Request model for updating utilization (heartbeat or end)."""
1010

1111
utilization_identifiers: list[str] | None = None

tests/integration/assetmanagement/test_asset_management.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@
2828
from nisystemlink.clients.core import ApiException
2929
from nisystemlink.clients.core._http_configuration import HttpConfiguration
3030

31+
# Type aliases for fixtures
32+
CreateAssetFixture = Callable[
33+
[List[CreateAssetRequest]], CreateAssetsPartialSuccessResponse
34+
]
35+
StartUtilizationFixture = Callable[[str, List[Asset], str, str, str, str], None]
36+
3137

3238
@pytest.fixture
3339
def create_asset(
3440
client: AssetManagementClient,
35-
) -> Generator[
36-
Callable[[List[CreateAssetRequest]], CreateAssetsPartialSuccessResponse], None, None
37-
]:
41+
) -> Generator[CreateAssetFixture, None, None]:
3842
"""Fixture to return a factory that creates assets."""
3943
responses: List[CreateAssetsPartialSuccessResponse] = []
4044

@@ -71,7 +75,7 @@ def unique_identifier() -> str:
7175
@pytest.fixture
7276
def start_utilization(
7377
client: AssetManagementClient,
74-
) -> Generator[Callable[[str, List[Asset], str, str, str, str], None], None, None]:
78+
) -> Generator[StartUtilizationFixture, None, None]:
7579
"""Fixture to start utilization and automatically clean up."""
7680
started_utilizations: List[str] = []
7781

tests/integration/dataframe/test_dataframe.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ def _wait_for_table_data(
177177
elapsed_time = time.time() - start_time
178178
assert elapsed_time < timeout, (
179179
f"Failed to get expected row count {minimum_row_count} after "
180-
f"{elapsed_time: .2f} seconds (last count: {actual_row_count})"
180+
f"{elapsed_time:.2f} seconds (last count: {actual_row_count})"
181181
)
182182

183183
time.sleep(sleep_duration)
@@ -245,9 +245,9 @@ def _data_value_to_str(column: Column, value: _DataElement) -> str | None:
245245
return str(value)
246246
if isinstance(value, float):
247247
if column.data_type == DataType.Float32:
248-
return f"{value: .9g}"
248+
return f"{value:.9g}"
249249
assert column.data_type == DataType.Float64
250-
return f"{value: .17g}"
250+
return f"{value:.17g}"
251251
if isinstance(value, datetime):
252252
assert column.data_type == DataType.Timestamp
253253
return value.isoformat()

0 commit comments

Comments
 (0)