summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-26 15:16:42 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-26 15:16:42 +0100
commitbab21fe861169cc1cdc395c9fc45aedddc66348c (patch)
tree46314f9cb7b1064f5ab49e1e410b51dce3d80dc8 /docs/userguide
parent62f9a0bde39aec0b4a13be441e5f12f568fc58b4 (diff)
downloadpython-setuptools-git-bab21fe861169cc1cdc395c9fc45aedddc66348c.tar.gz
Document CWD limitations in editable docs
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/development_mode.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst
index a421999b..2dc6dfbd 100644
--- a/docs/userguide/development_mode.rst
+++ b/docs/userguide/development_mode.rst
@@ -155,6 +155,10 @@ Limitations
projects structured using :ref:`flat-layout` is still **experimental**.
If you experience problems, you can try converting your package structure
to the :ref:`src-layout`.
+- File system entries in the current working directory
+ whose names coincidentally match installed packages
+ may take precedence in :doc:`Python's import system <python:reference/import>`.
+ Users are encouraged to avoid such scenarios [#cwd]_.
.. attention::
Editable installs are **not a perfect replacement for regular installs**
@@ -240,6 +244,13 @@ More information is available on the text of :pep:`PEP 660 <660#what-to-put-in-t
packages created with ``pkgutil`` or ``pkg_namespaces``, however this is not
officially supported.
+.. [#cwd]
+ Techniques like the :ref:`src-layout` or tooling-specific options like
+ `tox's changedir <https://tox.wiki/en/stable/config.html#conf-changedir>`_
+ can be used to prevent such kinds of situations (chekout `this blog post
+ <https://blog.ganssle.io/articles/2019/08/test-as-installed.html>`_ for more
+ insights).
+
.. [#installer]
For this workaround to work, the installer tool needs to support legacy
editable installations. (Future versions of ``pip``, for example, may drop