tests__skip_by_name#

tests__skip_by_name()[source]#

A list of test names that should be skipped for this object.

Part of packaging metadata for the object, used only in sktime CI.

String name: "tests:skip_by_name
Private tag, developer and framework facing
Values: list of str, or None
Example: [“test_fit_idempotent”, “test_persistence_via_pickle”]
Default: None

sktime’s CI framework regularly tests estimators in pull requests, usually only estimators that have changed, via run_test_for_class.

The tests:skip_by_name tag of an object is list of strings, with strings being names of tests that should be skipped for the object. The names should be the same as names of test functions in the “test all” suite, and will be the same as test names in check_estimator returns. If set to None (default), no tests are skipped.

WARNING: this tag should be used with caution. When it is set, developers should leave a comment next to the tag, explaining why the tests are skipped, and optimally link from the comment to an open issue with the purpose to resolving the skipped test(s).

The tests:skip_by_name tag is not used in user facing checks, error messages, or recommended build processes otherwise.