lamindb.base.utils

Utilities.

@lamindb.base.utils.doc_args

Pass arguments to docstrings.

@lamindb.base.utils.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

@lamindb.base.utils.class_and_instance_method

Decorator to define a method that works both as class and instance method.

@lamindb.base.utils.strict_classmethod

Decorator for a classmethod that raises an error when called on an instance.