test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #18115 - added warning about overlaid install. 

Setup.py now warns if it detects that Django is being installed over top
of a previous installation that was never removed. This should only
happen when installing with ``python setup.py install``, as pip
automatically uninstalls before installing a new version and
easy_install installs as an egg directory.

Also generally updated the installation doc.
This commit is contained in:
Carl Meyer 2012-05-21 17:28:58 -06:00
parent 23b9418458
commit 6ed7d40727
2 changed files with 122 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
docs/topics/install.txt
View File

@ -154,34 +154,19 @@ If you are upgrading your installation of Django from a previous version,
you will need to uninstall the old Django version before installing the you will need to uninstall the old Django version before installing the
new version. new version.
If you installed Django using ``setup.py install``, uninstalling If you installed Django using pip_ or ``easy_install`` previously, installing
is as simple as deleting the ``django`` directory from your Python with pip_ or ``easy_install`` again will automatically take care of the old
``site-packages``. version, so you don't need to do it yourself.
If you installed Django from a Python egg, remove the Django ``.egg`` file, If you previously installed Django using ``python setup.py install``,
and remove the reference to the egg in the file named ``easy-install.pth``. uninstalling is as simple as deleting the ``django`` directory from your Python
This file should also be located in your ``site-packages`` directory. ``site-packages``. To find the directory you need to remove, you can run the
following at your shell prompt (not the interactive Python prompt):
.. _finding-site-packages: .. code-block:: bash
.. admonition:: Where are my ``site-packages`` stored? python -c "import sys; sys.path = sys.path[1:]; import django; print django.__path__"
The location of the ``site-packages`` directory depends on the operating
system, and the location in which Python was installed. To find out your
system's ``site-packages`` location, execute the following:
.. code-block:: bash
python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"
(Note that this should be run from a shell prompt, not a Python interactive
prompt.)
Some Debian-based Linux distributions have separate ``site-packages``
directories for user-installed packages, such as when installing Django
from a downloaded tarball. The command listed above will give you the
system's ``site-packages``, the user's directory can be found in
``/usr/local/lib/`` instead of ``/usr/lib/``.
.. _install-django-code: .. _install-django-code:
@ -253,6 +238,15 @@ Installing an official release manually
run the command ``python setup.py install``. This will install Django in run the command ``python setup.py install``. This will install Django in
your Python installation's ``site-packages`` directory. your Python installation's ``site-packages`` directory.
.. admonition:: Removing an old version
If you use this installation technique, it is particularly important
that you :ref:`remove any existing
installations<removing-old-versions-of-django>` of Django
first. Otherwise, you can end up with a broken installation that
includes files from previous versions that have since been removed from
Django.
.. _download page: https://www.djangoproject.com/download/ .. _download page: https://www.djangoproject.com/download/
.. _bsdtar: http://gnuwin32.sourceforge.net/packages/bsdtar.htm .. _bsdtar: http://gnuwin32.sourceforge.net/packages/bsdtar.htm
.. _7-zip: http://www.7-zip.org/ .. _7-zip: http://www.7-zip.org/
@ -291,44 +285,26 @@ latest bug fixes and improvements, follow these instructions:
This will create a directory ``django-trunk`` in your current directory. This will create a directory ``django-trunk`` in your current directory.
3. Next, make sure that the Python interpreter can load Django's code. The most 3. Make sure that the Python interpreter can load Django's code. The most
convenient way to do this is to `modify Python's search path`_. Add a ``.pth`` convenient way to do this is via pip_. Run the following command:
file containing the full path to the ``django-trunk`` directory to your
system's ``site-packages`` directory. For example, on a Unix-like system:
.. code-block:: bash .. code-block:: bash
echo WORKING-DIR/django-trunk > SITE-PACKAGES-DIR/django.pth sudo pip install -e django-trunk/
(In the above line, change ``SITE-PACKAGES-DIR`` to match the location of (If using a virtualenv_ you can omit ``sudo``.)
your system's ``site-packages`` directory, as explained in the
:ref:`Where are my site-packages stored? <finding-site-packages>` section
above. Change ``WORKING-DIR/django-trunk`` to match the full path to your
new ``django-trunk`` directory.)
4. On Unix-like systems, create a symbolic link to the file This will make Django's code importable, and will also make the
``django-trunk/django/bin/django-admin.py`` in a directory on your system ``django-admin.py`` utility command available. In other words, you're all
path, such as ``/usr/local/bin``. For example: set!
.. code-block:: bash If you don't have pip_ available, see the alternative instructions for
`installing the development version without pip`_.
ln -s WORKING-DIR/django-trunk/django/bin/django-admin.py /usr/local/bin/
(In the above line, change WORKING-DIR to match the full path to your new
``django-trunk`` directory.)
This simply lets you type ``django-admin.py`` from within any directory,
rather than having to qualify the command with the full path to the file.
On Windows systems, the same result can be achieved by copying the file
``django-trunk/django/bin/django-admin.py`` to somewhere on your system
path, for example ``C:\Python27\Scripts``.
.. warning:: .. warning::
Don't run ``sudo python setup.py install``, because you've already Don't run ``sudo python setup.py install``, because you've already
carried out the equivalent actions in steps 3 and 4. Furthermore, this is carried out the equivalent actions in step 3.
known to cause problems when updating to a more recent version of Django.
When you want to update your copy of the Django source code, just run the When you want to update your copy of the Django source code, just run the
command ``git pull`` from within the ``django-trunk`` directory. When you do command ``git pull`` from within the ``django-trunk`` directory. When you do
@ -336,3 +312,61 @@ this, Git will automatically download any changes.
.. _Git: http://git-scm.com/ .. _Git: http://git-scm.com/
.. _`modify Python's search path`: http://docs.python.org/install/index.html#modifying-python-s-search-path .. _`modify Python's search path`: http://docs.python.org/install/index.html#modifying-python-s-search-path
.. _installing-the-development-version-without-pip:
Installing the development version without pip
----------------------------------------------
If you don't have pip_, you can instead manually `modify Python's search
path`_.
First follow steps 1 and 2 above, so that you have a ``django-trunk`` directory
with a checkout of Django's latest code in it. Then add a ``.pth`` file
containing the full path to the ``django-trunk`` directory to your system's
``site-packages`` directory. For example, on a Unix-like system:
.. code-block:: bash
echo WORKING-DIR/django-trunk > SITE-PACKAGES-DIR/django.pth
In the above line, change ``WORKING-DIR/django-trunk`` to match the full path
to your new ``django-trunk`` directory, and change ``SITE-PACKAGES-DIR`` to
match the location of your system's ``site-packages`` directory.
The location of the ``site-packages`` directory depends on the operating
system, and the location in which Python was installed. To find your system's
``site-packages`` location, execute the following:
.. code-block:: bash
python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"
(Note that this should be run from a shell prompt, not a Python interactive
prompt.)
Some Debian-based Linux distributions have separate ``site-packages``
directories for user-installed packages, such as when installing Django from
a downloaded tarball. The command listed above will give you the system's
``site-packages``, the user's directory can be found in ``/usr/local/lib/``
instead of ``/usr/lib/``.
Next you need to make the ``django-admin.py`` utility available in your
shell PATH.
On Unix-like systems, create a symbolic link to the file
``django-trunk/django/bin/django-admin.py`` in a directory on your system
path, such as ``/usr/local/bin``. For example:
.. code-block:: bash
ln -s WORKING-DIR/django-trunk/django/bin/django-admin.py /usr/local/bin/
(In the above line, change WORKING-DIR to match the full path to your new
``django-trunk`` directory.)
This simply lets you type ``django-admin.py`` from within any directory,
rather than having to qualify the command with the full path to the file.
On Windows systems, the same result can be achieved by copying the file
``django-trunk/django/bin/django-admin.py`` to somewhere on your system
path, for example ``C:\Python27\Scripts``.

36
setup.py
View File

@ -1,9 +1,25 @@
from distutils.core import setup from distutils.core import setup
from distutils.command.install_data import install_data from distutils.command.install_data import install_data
from distutils.command.install import INSTALL_SCHEMES from distutils.command.install import INSTALL_SCHEMES
from distutils.sysconfig import get_python_lib
import os import os
import sys import sys
# Warn if we are installing over top of an existing installation. This can
# cause issues where files that were deleted from a more recent Django are
# still present in site-packages. See #18115.
overlay_warning = False
if "install" in sys.argv:
# We have to try also with an explicit prefix of /usr/local in order to
# catch Debian's custom user site-packages directory.
for lib_path in get_python_lib(), get_python_lib(prefix="/usr/local"):
existing_path = os.path.abspath(os.path.join(lib_path, "django"))
if os.path.exists(existing_path):
# We note the need for the warning here, but present it after the
# command is run, so it's more likely to be seen.
overlay_warning = True
break
class osx_install_data(install_data): class osx_install_data(install_data):
# On MacOS, the platform-specific lib dir is /System/Library/Framework/Python/.../ # On MacOS, the platform-specific lib dir is /System/Library/Framework/Python/.../
# which is wrong. Python 2.5 supplied with MacOS 10.5 has an Apple-specific fix # which is wrong. Python 2.5 supplied with MacOS 10.5 has an Apple-specific fix
@ -97,3 +113,23 @@ setup(
'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Libraries :: Python Modules',
], ],
) )
if overlay_warning:
sys.stderr.write("""
========
WARNING!
========
You have just installed Django over top of an existing
installation, without removing it first. Because of this,
your install may now include extraneous files from a
previous version that have since been removed from
Django. This is known to cause a variety of problems. You
should manually remove the
%(existing_path)s
directory and re-install Django.
""" % { "existing_path": existing_path })