Skip to content

Commit

Permalink
update interactive reload limitation
Browse files Browse the repository at this point in the history
  • Loading branch information
zhenyu-ms committed Aug 23, 2024
1 parent a09b135 commit 59b0897
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/en/interactive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ circumstances.
* ``__main__`` module (i.e. test_plan.py) cannot be reloaded. Because of this,
it is recommended that test suites are defined in seperate modules. It is a
good idea to keep the main script simple.
* Testplan is not able to reload module that is under *Namespace Package*, the
workaround is to add dummy __init__.py file.
* Testplan is not able to reload module that is under **Namespace Package**, the
workaround is to add dummy ``__init__.py`` file.
* Unlike testcases that can be added/removed/modified, adding/removing/renaming
testsuite class will not take effect after reloading.
* Modules or objects imported using ``from some_module import *`` syntax are
Expand All @@ -73,6 +73,12 @@ circumstances.
* In interactive mode, all modules containing test targets will be loaded at
the same time, if the modules from which tasks are scheduled have the same
name, they won't be reloaded properly.
* `modulefinder.ModuleFinder <https://docs.python.org/3/library/modulefinder.html#modulefinder.ModuleFinder>`_
works purely on static analysis, which means it is completely ignorant of any
programmatic imports as well as imports requiring ``sys.path`` manipulation.
As a result, such dependencies may not be reloaded. In these cases, user may
need to use the ``extra_deps`` parameter of the ``@test_plan`` decorator to
specify these dependencies.


.. _Interactive_UI:
Expand Down

0 comments on commit 59b0897

Please sign in to comment.