Skip to content

Commit 30c760c

Browse files
authored
fix: Correct spelling for model class TableMetadataModification (#44)
* Correct spelling for model class * Add alias for name compatibility
1 parent 7881a90 commit 30c760c

File tree

4 files changed

+13
-10
lines changed

4 files changed

+13
-10
lines changed

nisystemlink/clients/dataframe/models/__init__.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from ._delete_tables_partial_success import DeleteTablesPartialSuccess
99
from ._modify_tables_partial_success import ModifyTablesPartialSuccess
1010
from ._modify_table_request import ColumnMetadataPatch, ModifyTableRequest
11-
from ._modify_tables_request import ModifyTablesRequest, TableMetdataModification
11+
from ._modify_tables_request import ModifyTablesRequest, TableMetadataModification
1212
from ._order_by import OrderBy
1313
from ._paged_tables import PagedTables
1414
from ._paged_table_rows import PagedTableRows
@@ -23,4 +23,7 @@
2323
from ._table_metadata import TableMetadata
2424
from ._table_rows import TableRows
2525

26+
# Alias to provide backwards compatibility for misnamed class, fixed in 1.0.2
27+
TableMetdataModification = TableMetadataModification
28+
2629
# flake8: noqa

nisystemlink/clients/dataframe/models/_modify_tables_partial_success.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from nisystemlink.clients.core import ApiError
44
from nisystemlink.clients.core._uplink._json_model import JsonModel
55

6-
from ._modify_tables_request import TableMetdataModification
6+
from ._modify_tables_request import TableMetadataModification
77

88

99
class ModifyTablesPartialSuccess(JsonModel):
@@ -12,7 +12,7 @@ class ModifyTablesPartialSuccess(JsonModel):
1212
modified_table_ids: List[str]
1313
"""The IDs of the tables that were successfully modified."""
1414

15-
failed_modifications: List[TableMetdataModification]
15+
failed_modifications: List[TableMetadataModification]
1616
"""The requested modifications that could not be applied."""
1717

1818
error: ApiError

nisystemlink/clients/dataframe/models/_modify_tables_request.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from nisystemlink.clients.core._uplink._json_model import JsonModel
44

55

6-
class TableMetdataModification(JsonModel):
6+
class TableMetadataModification(JsonModel):
77
"""Contains the metadata properties to modify. Values not included in the
88
request or included with a ``None`` value will remain unchanged.
99
"""
@@ -37,7 +37,7 @@ class TableMetdataModification(JsonModel):
3737
class ModifyTablesRequest(JsonModel):
3838
"""Contains one or more table modifications to apply."""
3939

40-
tables: List[TableMetdataModification]
40+
tables: List[TableMetadataModification]
4141
"""The table modifications to apply. Each table may only appear once in the list."""
4242

4343
replace: Optional[bool] = None

tests/integration/dataframe/test_dataframe.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
QueryDecimatedDataRequest,
2525
QueryTableDataRequest,
2626
QueryTablesRequest,
27-
TableMetdataModification,
27+
TableMetadataModification,
2828
)
2929
from responses import matchers
3030

@@ -90,7 +90,7 @@ def test__api_info__returns(self, client):
9090

9191
assert len(response.dict()) != 0
9292

93-
def test__create_table__metadata_is_corect(
93+
def test__create_table__metadata_is_correct(
9494
self, client: DataFrameClient, test_tables: List[str]
9595
):
9696
table_metadata = client.get_table_metadata(test_tables[0])
@@ -249,7 +249,7 @@ def test__modify_tables__modifies_tables(
249249
ids = [create_table(basic_table_model) for _ in range(3)]
250250

251251
updates = [
252-
TableMetdataModification(
252+
TableMetadataModification(
253253
id=id, name="Modified table", properties={"duck": "quack"}
254254
)
255255
for id in ids
@@ -262,7 +262,7 @@ def test__modify_tables__modifies_tables(
262262
assert table.properties == {"duck": "quack"}
263263

264264
updates = [
265-
TableMetdataModification(id=id, properties={"pig": "oink"}) for id in ids
265+
TableMetadataModification(id=id, properties={"pig": "oink"}) for id in ids
266266
]
267267

268268
assert (
@@ -277,7 +277,7 @@ def test__modify_tables__returns_partial_success(self, client: DataFrameClient):
277277
id = client.create_table(basic_table_model)
278278

279279
updates = [
280-
TableMetdataModification(id=id, name="Modified table")
280+
TableMetadataModification(id=id, name="Modified table")
281281
for id in [id, "invalid_id"]
282282
]
283283

0 commit comments

Comments
 (0)