You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To perform the update with Conda (strongly recommended), from your terminal (or Anaconda Prompt on Windows) run:
26
+
Recent versions of Spyder using our recommended :ref:`install-standalone` will offer to automatically update themselves for you.
27
+
If using an older version of Spyder or a non-standalone build (e.g. installed with Pip or Conda), we recommend downloading and running our latest :ref:`install-standalone`.
27
28
28
-
.. code-block:: bash
29
-
30
-
conda update anaconda
31
-
conda update spyder
29
+
To perform the update with Conda, see the FAQ :ref:`update-conda`; to update with Pip use ``pip install --ugprade spyder``.
30
+
If that still doesn't work, we recommend updating Spyder's dependencies and environment, either by installing the latest version of Anaconda/Miniconda/Miniforge, or with the relevant "update all" command in your terminal (or Anaconda Prompt on Windows).
32
31
33
-
#. **Update Spyder's dependencies and environment**, either by installing the latest version of your distribution (e.g. the recommended Anaconda), or with the relevant "update all" command in your terminal (or Anaconda Prompt on Windows).
34
32
To get the latest stable version of everything using Conda, you can run:
This will reset your preferences, as well as any custom keyboard shortcuts or syntax highlighting schemes.
52
56
If you particularly care about any of those, you should make a copy of the :file:`.spyder-py3` folder in your user home directory (:file:`C:/Users/YOUR_USERNAME` on Windows, :file:`/Users/YOUR_USERNAME` on macOS, or :file:`/home/YOUR_USERNAME` on Linux), and restore it afterwards if this doesn't solve the problem.
53
57
54
-
#. **Try installing Spyder into a new Conda environment** (recommended) or ``virtualenv``/``venv``, and see if the issue reoccurs.
58
+
#. **Try reinstalling Spyder** via our :ref:`install-standalone` (recommended), or in a fresh Conda/virtual environment, and see if the issue reoccurs.
55
59
56
-
In your system terminal (or Anaconda Prompt on Windows), run the following commands to create an a fresh, clean environment and start Spyder in it:
60
+
If using Conda to install Spyder (only recommended for advanced users needing plugin support), in your system terminal (or Anaconda Prompt on Windows), run the following commands to create a clean environment and start Spyder in it:
If none of the previous steps solve your issue, you should do a full uninstall of Spyder by whatever means you originally installed it.
83
87
84
-
For Anaconda, follow all the steps under Option B in the `Anaconda uninstall guide`_, delete the Anaconda directory wherever it was originally installed, and (on Windows) remove the :file:`%appdata%/python` directory if it exists.
88
+
For Spyder's standalone installers, the uninstall mechanism varies depending on your operating system.
89
+
On Windows, it can be removed via the entry under :guilabel:`Add or remove programs`.
90
+
91
+
For Anaconda/Miniconda, follow all the steps under `Anaconda uninstall guide`_/`Miniconda uninstall guide`_.
92
+
For Miniforge, follow the `Miniforge uninstall instructions`_ on macOS/Linux or remove it from :guilabel:`Add or remove programs` on Windows.
93
+
Then, delete the Anaconda/Miniconda/Miniforge directory wherever it was originally installed, and (on Windows) remove the :file:`%appdata%/python` directory if it exists.
Then, do a clean install of the latest version of the `Anaconda distribution`_ which is how we recommend you install Spyder and keep it up to date.
98
+
Finally, do a clean install of the latest version of our :ref:`install-standalone`, which is how we recommend you install Spyder and keep it up to date.
90
99
91
100
.. important::
92
101
93
-
While you are welcome to get Spyder working on your own by one of the many other means we offer, we are only able to provide individual support for install-related issues for users of the Anaconda distribution.
94
-
In particular, pip installation, while doable, is only really for experts, as there are many pitfalls involved and different issues specific to your setup, which is why we recommend using Conda whenever possible.
102
+
While you are welcome to get Spyder working on your own by one of the many other means we offer, we are only normally able to provide individual support for user-specific install issues related to our :ref:`install-standalone`.
103
+
In particular, managing your own installation via Conda or Pip can be easy to break, as there are many pitfalls involved and different issues specific to your setup, which is why we recommend using our standalone installers whenever possible.
95
104
For further information, please visit our :ref:`install-guide`.
@@ -112,21 +123,21 @@ If you manage to isolate the bug, report it to the last one it *doesn't* work in
112
123
#. **Spyder** itself, of course!
113
124
Make sure you can reproduce the error after closing and reopening it, if possible.
114
125
115
-
#. **A bare QtConsole instance**, e.g. launched from Anaconda navigator or from the Anaconda Prompt/Terminal/command line (Windows/Mac/Linux) with ``jupyter qtconsole``.
126
+
#. **A bare QtConsole instance**, e.g. launched from the system terminal (Anaconda Prompt, on Windows) with ``jupyter qtconsole``.
QtConsole is the GUI console backend Spyder depends on to run its code, so most issues involving Spyder's :ref:`panes-console` are actually something with QtConsole instead, and can be reported to their `issue tracker`_.
131
+
QtConsole is the GUI console backend Spyder depends on to run its code, so most issues involving Spyder's :ref:`panes-console` usually have something to do with QtConsole instead, and can be reported to the `QtConsole issue tracker`_.
121
132
122
-
#. **An IPython command line shell**, launched with e.g. ``ipython`` from the Anaconda Prompt/Terminal/command line (Windows/Mac/Linux).
123
-
Reproducible bugs can be reported to their `Github page`_, though make sure to read their guidelines and docs first.
133
+
#. **An IPython command line shell**, launched with e.g. ``ipython`` from system terminal (Anaconda Prompt, on Windows).
134
+
Reproducible bugs can be reported to the `IPython issue tracker`_, though make sure to read their guidelines and docs first.
124
135
125
-
#. **A standard Python interpreter**, either run as a script file with ``python path/to/your/file.py`` or launched interactively with ``python`` from your Anaconda Prompt/Terminal/command line (Windows/Mac/Linux).
126
-
While it is not impossible that you've found Python bug, it is much more likely to be an issue with the code itself or a package you are using, so your best sources are the `Python docs`_ and the other resources listed above.
136
+
#. **A standard Python interpreter**, either run as a script file with ``python path/to/your/file.py`` or launched interactively with ``python`` from your system terminal (Anaconda Prompt, on Windows).
137
+
While it is not impossible that you've found a Python bug, it is much more likely to be an issue with the code itself or a package you are using, so your best sources are the `Python docs`_ and the other resources listed above.
Copy file name to clipboardExpand all lines: doc/troubleshooting/call-for-help.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,9 +58,9 @@ Our `Google Group`_ is great for help-related questions, particularly those you
58
58
Spyder website
59
59
~~~~~~~~~~~~~~
60
60
61
-
The `Spyder site`_ contains basic information about the IDE and links to many other helpful resources.
61
+
The `Spyder website`_ contains basic information about the IDE and links to other helpful resources.
62
62
63
-
.. _Spyder site: https://www.spyder-ide.org/
63
+
.. _Spyder website: https://www.spyder-ide.org/
64
64
65
65
66
66
.. rst-class:: fabb fa-stack-overflow
@@ -141,7 +141,7 @@ Anaconda help
141
141
142
142
The `Anaconda docs`_ site offers free community help and documentation for the Anaconda applications, installing the Anaconda distribution, and using the Conda package and environment manager; along with paid support options.
It is included by default with Anaconda, but if you want to run your code in another Python environment or installation, you'll need to make sure it's installed and updated to the latest version.
34
-
35
-
Check the required version of spyder-kernels for your version of Spyder in the following table:
36
-
37
-
.. table:: Spyder and Spyder-Kernels version compatibility
38
-
39
-
============== ==============
40
-
Spyder Spyder-Kernels
41
-
============== ==============
42
-
4.0.0-4.0.1 1.8.1
43
-
4.1.0-4.1.2 1.9.0
44
-
4.1.3 1.9.1
45
-
4.1.4 1.9.3
46
-
4.1.5-4.1.6 1.9.4
47
-
4.2.0 1.10.0
48
-
5.0.0-5.0.5 2.0.5
49
-
5.1.0-5.1.5 2.1.3
50
-
5.2.0-5.2.1 2.2.0
51
-
5.2.2 2.2.1
52
-
5.3.0-5.3.3 2.3.3
53
-
5.4.0-5.4.3 2.4.3
54
-
============== ==============
55
-
56
-
To do so, activate the environment, then install ``spyder-kernels``.
57
-
If using Anaconda, open a terminal (Anaconda Prompt on Windows) and run:
33
+
It is included by default in Spyder's own runtime environment, but if you want to run your code in your own Python environment or installation, you'll need to make sure it's installed and updated to the latest version.
58
34
59
-
.. code-block:: bash
60
-
61
-
conda activate ENVIRONEMENT-NAME
62
-
conda install spyder-kernels=<VERSION>
63
-
64
-
Otherwise, activate your environment by whatever means you created it, and execute:
65
-
66
-
.. code-block:: bash
35
+
To do so, open a system terminal, activate the Conda or virtual environment you want to use Spyder with, and then copy and paste the command Spyder generates for you (the ``conda`` command if in a Conda environment, or ``pip`` otherwise).
67
36
68
-
pip install spyder-kernels==<VERSION>
69
-
70
-
For both of the previous commands, replace ``<VERSION>`` with the corresponding version in the table.
37
+
Spyder 6.2+ will offer to update your Spyder-Kernels version automatically, if using Spyder through our recommended :ref:`install-standalone`.
71
38
72
39
73
40
.. _troubleshooting-common-kernel-dependency:
@@ -78,26 +45,26 @@ Issue with another dependency
78
45
If the kernel displays a long error traceback that mentions other packages like ``ipython``, ``ipykernel``, ``jupyter_client``, ``traitlets`` or ``pyzmq``, the problem may be an out of date or incompatible version of a dependency package.
79
46
To fix this, activate the environment and update the key dependencies.
80
47
81
-
In an Anaconda environment:
48
+
In a Conda environment:
82
49
83
50
.. code-block:: bash
84
51
85
-
conda activate ENVIRONMENT-NAME
52
+
conda activate ENVIRONMENT-NAME# Replace with the name of your desired environment
Check the last few lines of the error message, and see if its an ``AttributeError`` or ``ImportError``, or refers to a file you created in your current working directory or your home folder (:file:`C:/Users/YOUR_USERNAME` on Windows, :file:`/Users/YOUR_USERNAME` on macOS, or :file:`/home/YOUR_USERNAME` on Linux).
67
+
Check the last few lines of the error message, and see if it's an ``AttributeError`` or ``ImportError``, or refers to a file you created in your current working directory or your home folder (:file:`C:/Users/YOUR_USERNAME` on Windows, :file:`/Users/YOUR_USERNAME` on macOS, or :file:`/home/YOUR_USERNAME` on Linux).
@@ -117,8 +84,8 @@ To check the names of these modules, see the list in the `Python standard librar
117
84
Completion/help not working
118
85
===========================
119
86
120
-
To provide code completions, help and real-time analysis in the Editor, Spyder uses the Python Language Server (PyLS), an implementation of the Language Server Protocol specification used by VSCode, Atom and other popular editors/IDEs.
121
-
Most help and completion issues lie outside of Spyder's control, and are either limitations with PyLS or the code that is being introspected, but some can be worked around.
87
+
To provide code completions, help and real-time analysis in the Editor, Spyder uses the Python LSP Server (PyLSP), an implementation of the same Language Server Protocol specification supported by VSCode, Neovim and other popular editors/IDEs.
88
+
Most help and completion issues lie outside of Spyder's control, and are either limitations with PyLSP or the code that is being introspected, but some can be worked around.
122
89
123
90
124
91
.. _troubleshooting-common-completion-docstring:
@@ -155,7 +122,7 @@ LSP has stopped working
155
122
~~~~~~~~~~~~~~~~~~~~~~~
156
123
157
124
Occasionally, especially after using Spyder for a while, code completion, help and analysis may stop working.
158
-
If this is the case, you can check LSP status with the :guilabel:`LSP Python` item in Spyder's status bar at the bottom of the screen, and restart it by right-clicking it and selecting the :guilabel:`Restart Python Language Server` item.
125
+
If this is the case, you can check LSP status with the :guilabel:`LSP: Python` item in Spyder's status bar at the bottom of the screen, and restart it by right-clicking it and selecting the :guilabel:`Restart Python Language Server` item.
Given the variety of dependencies involved in making LSP work, an incompatible or out of date version in your environment can result in error messages, incomplete results, or help/analysis not working at all.
170
137
171
-
To address this, first try updating Anaconda and Spyder as described in :ref:`troubleshooting-basic`.
172
-
If the issue still isn't resolved, update the various relevant dependencies with:
173
-
174
-
.. code-block:: bash
175
-
176
-
conda update python-language-server
138
+
To address this, try updating Spyder as described in :ref:`troubleshooting-basic`.
177
139
178
140
179
141
@@ -188,15 +150,15 @@ Plugin Problems
188
150
Plugin does not work at all
189
151
~~~~~~~~~~~~~~~~~~~~~~~~~~~
190
152
191
-
If you have installed a Spyder plugin, but you can't see it, go to the :guilabel:`Panes` submenu of the :guilabel:`View` menu and select the plugin's name, which should make its pane visible.
192
-
If you don't see the plugin there, select the :guilabel:`Dependencies` item under the:guilabel:`Help` menu and see if the plugin appears at the bottom.
153
+
If you have installed a Spyder plugin, but you can't see it, go to the :guilabel:`Panes` submenu of the :guilabel:`Window` menu and select the plugin's name, which should make it visible if it contains a standalone pane.
154
+
If you don't see the plugin there, select the :guilabel:`Plugins` section under Spyder's:guilabel:`Preferences` and see if it is listed there.
If the plugin with the problem is not listed in the dependencies dialog, check that you installed it in the same environment as Spyder.
159
+
If the plugin with the problem is not listed in the :guilabel:`Plugins` Preferences section, check that you installed it in the same environment as Spyder.
198
160
If you have, then the problem may well be caused by a dependency issue.
199
-
Test whether you can import the plug-in manually by opening a Python console in the same environment as Spyder and typing, for instance, ``import spyder_unittest`` to test the Spyder-Unittest` plug-in; this command should run without errors.
161
+
Test whether you can import the plug-in manually by opening a Python console in the same environment as Spyder and typing, for instance, ``import spyder_unittest`` to test the Spyder-Unittest plug-in; this command should run without errors.
200
162
201
163
If none of this helps you to resolve the problem, then continue to the next section.
0 commit comments