Skip to content

Commit

Permalink
fix: Correct spelling for model class TableMetadataModification (#44)
Browse files Browse the repository at this point in the history
* Correct spelling for model class
* Add alias for name compatibility
  • Loading branch information
kjohn1922 committed Mar 8, 2023
1 parent 7881a90 commit 30c760c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
5 changes: 4 additions & 1 deletion nisystemlink/clients/dataframe/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from ._delete_tables_partial_success import DeleteTablesPartialSuccess
from ._modify_tables_partial_success import ModifyTablesPartialSuccess
from ._modify_table_request import ColumnMetadataPatch, ModifyTableRequest
from ._modify_tables_request import ModifyTablesRequest, TableMetdataModification
from ._modify_tables_request import ModifyTablesRequest, TableMetadataModification
from ._order_by import OrderBy
from ._paged_tables import PagedTables
from ._paged_table_rows import PagedTableRows
Expand All @@ -23,4 +23,7 @@
from ._table_metadata import TableMetadata
from ._table_rows import TableRows

# Alias to provide backwards compatibility for misnamed class, fixed in 1.0.2
TableMetdataModification = TableMetadataModification

# flake8: noqa
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from nisystemlink.clients.core import ApiError
from nisystemlink.clients.core._uplink._json_model import JsonModel

from ._modify_tables_request import TableMetdataModification
from ._modify_tables_request import TableMetadataModification


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

failed_modifications: List[TableMetdataModification]
failed_modifications: List[TableMetadataModification]
"""The requested modifications that could not be applied."""

error: ApiError
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from nisystemlink.clients.core._uplink._json_model import JsonModel


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

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

replace: Optional[bool] = None
Expand Down
10 changes: 5 additions & 5 deletions tests/integration/dataframe/test_dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
QueryDecimatedDataRequest,
QueryTableDataRequest,
QueryTablesRequest,
TableMetdataModification,
TableMetadataModification,
)
from responses import matchers

Expand Down Expand Up @@ -90,7 +90,7 @@ def test__api_info__returns(self, client):

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

def test__create_table__metadata_is_corect(
def test__create_table__metadata_is_correct(
self, client: DataFrameClient, test_tables: List[str]
):
table_metadata = client.get_table_metadata(test_tables[0])
Expand Down Expand Up @@ -249,7 +249,7 @@ def test__modify_tables__modifies_tables(
ids = [create_table(basic_table_model) for _ in range(3)]

updates = [
TableMetdataModification(
TableMetadataModification(
id=id, name="Modified table", properties={"duck": "quack"}
)
for id in ids
Expand All @@ -262,7 +262,7 @@ def test__modify_tables__modifies_tables(
assert table.properties == {"duck": "quack"}

updates = [
TableMetdataModification(id=id, properties={"pig": "oink"}) for id in ids
TableMetadataModification(id=id, properties={"pig": "oink"}) for id in ids
]

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

updates = [
TableMetdataModification(id=id, name="Modified table")
TableMetadataModification(id=id, name="Modified table")
for id in [id, "invalid_id"]
]

Expand Down

0 comments on commit 30c760c

Please sign in to comment.