Skip to content

Implement isPrimaryKey check, fix and refactor check tests #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sudsali merged 9 commits into from
May 7, 2026
Merged

Implement isPrimaryKey check, fix and refactor check tests #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fb90d9f
Implement isPrimaryKey check.
nikie Jun 5, 2025
4d2cdd3
Fix and refactor checks tests.
nikie Jun 5, 2025
2a0d657
Check isPrimaryKey: use optional hint argument.
nikie May 4, 2026
3d56a90
Check tests: use List[str] instead of list[str].
nikie May 4, 2026
116fe50
Check tests: fix isUnique check tests.
nikie May 4, 2026
952410f
Check tests: fix test_fail_hasMax test to use self.hasMax.
nikie May 4, 2026
2ea7723
Check tests: add case with hint into test_fail_isUnique.
nikie May 4, 2026
d6075a3
Check tests: update run_check return type to List[Row].
nikie May 4, 2026
167f3e2
Check isPrimaryKey: add comment abound columns Scala type conversion.
nikie May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Here are the current supported functionalities of Checks.
| | areAnyComplete(columns) | Done |
| | haveAnyCompleteness(columns, assertion) | Done |
| | isUnique(column) | Done |
| | isPrimaryKey(column, *columns) | Not Implemented |
| | isPrimaryKey(column, *columns) | Done |
| | hasUniqueness(columns, assertion) | Done |
| | hasDistinctness(columns, assertion) | Done |
| | hasUniqueValueRatio(columns, assertion) | Done |
Expand Down
13 changes: 8 additions & 5 deletions pydeequ/checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,15 +243,18 @@ def isPrimaryKey(self, column, *columns, hint=None):
Currently only checks uniqueness, but reserved for primary key checks if there is another
assertion to run on primary key columns.

# how does column and columns differ
:param str column: Column in Data Frame to run the assertion on.
Uniqueness is checked for the list of all columns: [column] + columns.

:param str column: The 1st column in Data Frame to run the assertion on.
:param list[str] columns: Additional columns to run the assertion on.
:param str hint: A hint that states why a constraint could have failed.
:param list[str] columns: Columns to run the assertion on.
:return: isPrimaryKey self: A Check.scala object that asserts completion in the columns.
"""
# This relies on Py4J's implicit conversion from Seq to varargs:
columns_seq = to_scala_seq(self._jvm, columns)
Comment thread
nikie marked this conversation as resolved.
hint = self._jvm.scala.Option.apply(hint)
print(f"Unsolved integration: {hint}")
raise NotImplementedError("Unsolved integration of Python tuple => varArgs")
self._Check = self._Check.isPrimaryKey(column, hint, columns_seq)
Comment thread
nikie marked this conversation as resolved.
Comment thread
nikie marked this conversation as resolved.
return self

Comment thread
nikie marked this conversation as resolved.
def hasUniqueness(self, columns, assertion, hint=None):
"""
Expand Down
Loading
Loading