Source code for ui_tests.third_party.step

"""
--------------
Step decorator
--------------
"""

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import allure

from ui_tests.third_party import logger

__all__ = [
    'step',
]


def step(obj):
    """Decorator over ``allure.step`` and ``logger.log``."""

    def wrapper(func):
        return allure_step(logger.log(func))

    if callable(obj):
        allure_step = allure.step
        return wrapper(obj)
    else:
        allure_step = allure.step(obj)
        return wrapper