lamindb.base.deprecated

lamindb.base.deprecated(new_name)

Deprecated.

This is a decorator which can be used to mark functions, methods and properties as deprecated. It will result in a warning being emitted when the function is used.

It will also hide the function from the docs.

Example:

@property
@deprecated("n_files")
def n_objects(self) -> int:
    return self.n_files