Skip to content

Add best practice documentation for existence checks before property access #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ arguments of your test function to make it available within it.
# [...]


It is considered best practice to first check for the existence of a resource before accessing its properties. This ensures that the resource is available and prevents unexpected runtime errors, such as `RuntimeError` or `ValueError`, which can occur if it does not exist. By validating existence first, you make your code more robust and errors easier to understand.

.. code-block:: python

svc = host.service('non-existing')
assert svc.exists
assert svc.is_running


host
~~~~

Expand Down