Avoid circular importing references for html

[ddennerline3]

While trying to get a development environment up and running, I encountered an circular import error that is tied to locust/html.py importing html. I suspect that the PYTHONPATH is set up to somehow avoid this confusion in production.

locust/html.py

import os
from html import escape << conflict
from itertools import chain

Would it be possible to rename the locust version of html.py to report.py (or another suitable name) to avoid potential conflicts with python library’s html module please?

[cyberw]

Can you show a complete example of when this problem happens?

In general I dont think python has any issues importing something from html just because you're in a file called html.py, no PYTHONPATH magic necessary.

[ddennerline3]

Traceback (most recent call last):
  File "/Applications/PyCharm Professional Edition.app/Contents/plugins/python-ce/helpers/pydev/pydevd.py", line 16, in <module>
    from _pydevd_bundle.pydevd_collect_try_except_info import collect_return_info
  File "/Applications/PyCharm Professional Edition.app/Contents/plugins/python-ce/helpers/pydev/_pydevd_bundle/pydevd_collect_try_except_info.py", line 12, in <module>
    from _pydevd_bundle.pydevd_constants import IS_PY38_OR_GREATER, IS_PY312_OR_GREATER
  File "/Applications/PyCharm Professional Edition.app/Contents/plugins/python-ce/helpers/pydev/_pydevd_bundle/pydevd_constants.py", line 244, in <module>
    protect_libraries_from_patching()
  File "/Applications/PyCharm Professional Edition.app/Contents/plugins/python-ce/helpers/pydev/_pydevd_bundle/pydevd_constants.py", line 237, in protect_libraries_from_patching
    import _pydev_imps._pydev_saved_modules
  File "/Applications/PyCharm Professional Edition.app/Contents/plugins/python-ce/helpers/pydev/_pydev_imps/_pydev_saved_modules.py", line 22, in <module>
    import xmlrpc.server as _pydev_SimpleXMLRPCServer
  File "/opt/homebrew/Cellar/[email protected]/3.11.10/Frameworks/Python.framework/Versions/3.11/lib/python3.11/xmlrpc/server.py", line 108, in <module>
    from http.server import BaseHTTPRequestHandler
  File "/opt/homebrew/Cellar/[email protected]/3.11.10/Frameworks/Python.framework/Versions/3.11/lib/python3.11/http/server.py", line 93, in <module>
    import html
  File "/projects/locust/locust/html.py", line 2, in <module>
    from html import escape
ImportError: cannot import name 'escape' from partially initialized module 'html' (most likely due to a circular import) (/Users/daviddennerline/projects/locust/locust/html.py)