Decorator that marks specific class method that is only available during tests

I need some marker, which will allow me to access member in pytest but not in normal code:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>class A:
def __init__(self) -> None:
self.__pv_memeber = 0
@some_magic_marker
def get_pv_member(self) -> int:
return self.__pv_memeber
</code>
<code>class A: def __init__(self) -> None: self.__pv_memeber = 0 @some_magic_marker def get_pv_member(self) -> int: return self.__pv_memeber </code>
class A:
    def __init__(self) -> None:
        self.__pv_memeber = 0

    @some_magic_marker
    def get_pv_member(self) -> int:
        return self.__pv_memeber

So that:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code># normal code
> A().get_pv_member() # raises some exception
</code>
<code># normal code > A().get_pv_member() # raises some exception </code>
# normal code
> A().get_pv_member() # raises some exception

but in tests:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>def test_pv_member_init_value(a: A) -> None:
assert a.get_pv_member() == 0
</code>
<code>def test_pv_member_init_value(a: A) -> None: assert a.get_pv_member() == 0 </code>
def test_pv_member_init_value(a: A) -> None:
    assert a.get_pv_member() == 0

I can write it myself using this library:

  • https://pypi.org/project/pytest-is-running/

or using pytest environment variables, but i’m curious is there dedicated library or solution for this?

I don’t want to go with:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>def test_pv_member_init_value(a: A) -> None:
assert a._A__pv_member == 0
</code>
<code>def test_pv_member_init_value(a: A) -> None: assert a._A__pv_member == 0 </code>
def test_pv_member_init_value(a: A) -> None:
    assert a._A__pv_member == 0

as mypy and ruff is screaming and in my opinion it does not look good

I am willing to use such decorator, but i would rather go with dedicated solution (if exists):

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>ArgumentsT = TypeVar('ArgumentsT')
ReturnT = TypeVar('ReturnT')
class PytestUseOnlyMethodError(BaseException):
"""Raised if function is called outside pytest context."""
def __init__(self, func_name: str) -> None: # noqa: D107
super().__init__(f"Function: `{func_name}` can only be called from pytest")
def pytest_only(function: Callable[[ArgumentsT], ReturnT]) -> Callable[[ArgumentsT], ReturnT]:
"""Marked methods/functions can be only called inside pytest context."""
import pytest_is_running
@wraps(function)
def _wrapper(*args: Any, **kwargs: Any) -> Any:
if pytest_is_running.is_running():
return function(*args, **kwargs)
raise PytestUseOnlyMethodError(function.__name__)
return _wrapper
</code>
<code>ArgumentsT = TypeVar('ArgumentsT') ReturnT = TypeVar('ReturnT') class PytestUseOnlyMethodError(BaseException): """Raised if function is called outside pytest context.""" def __init__(self, func_name: str) -> None: # noqa: D107 super().__init__(f"Function: `{func_name}` can only be called from pytest") def pytest_only(function: Callable[[ArgumentsT], ReturnT]) -> Callable[[ArgumentsT], ReturnT]: """Marked methods/functions can be only called inside pytest context.""" import pytest_is_running @wraps(function) def _wrapper(*args: Any, **kwargs: Any) -> Any: if pytest_is_running.is_running(): return function(*args, **kwargs) raise PytestUseOnlyMethodError(function.__name__) return _wrapper </code>
ArgumentsT = TypeVar('ArgumentsT')
ReturnT = TypeVar('ReturnT')

class PytestUseOnlyMethodError(BaseException):
    """Raised if function is called outside pytest context."""

    def __init__(self, func_name: str) -> None:  # noqa: D107
        super().__init__(f"Function: `{func_name}` can only be called from pytest")

def pytest_only(function: Callable[[ArgumentsT], ReturnT]) -> Callable[[ArgumentsT], ReturnT]:
    """Marked methods/functions can be only called inside pytest context."""
    import pytest_is_running
    @wraps(function)
    def _wrapper(*args: Any, **kwargs: Any) -> Any:
        if pytest_is_running.is_running():
            return function(*args, **kwargs)
        raise PytestUseOnlyMethodError(function.__name__)
    return _wrapper

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật