Field settings unique=True and allow_duplicates=False functionally the same?

[thorben-flapo]

Hi!

I am uncertain on how to understand documentation of the model component Field:

Are the two parameters unique and allow_duplicates overlapping in their functionality?
In other words: are unique=True and allow_duplicates=False functionally the same?

Just as a reference, I am thinking of the following example:

from pandera import Field, SchemaModel

class Order(SchemaModel):
    order_id: Series[int] = Field(allow_duplicates=False)

Would the validation behave the same with the following change?

from pandera import Field, SchemaModel

class Order(SchemaModel):
    order_id: Series[int] = Field(unique=True)

[cosmicBboy]

Hi @thorben-flapo, yes they are redundant... the docs need to be updated to include the deprecation warning, e.g. in the equivalent Column class.

Would you be open to making a PR to update the Field docstring?

[thorben-flapo]

@cosmicBboy , thanks for the quick answer!

I have opened PR #671 for updating the docstring.