spyder使用指南

下图粗略整理spyder使用指南，只是一个大纲，适合初学者学习。

python

• 1. First steps with Spyder
  • 1. Execute a given program
  • 2. Call existing functions in the Console
    • 就是在控制台调用hello（）函数
  • 3. Inspecting（检查） objects defined in the Console
    • dir () 显示现在namepace中所有已知的对象
    • help() 显示某个函数的详细信息，比如它的功能
      • eg: help (hello) 显示hello函数的一些相关信息，Python从哪里得到这些信息？其中一些（比如输入参数的数量和这些变量的名称）Python可以通过检查其对象来找到。其他信息来自document字符串或docstring，就是def hello（）行下面的第一个字符串。按照惯例，由于它们通常延伸到多行，所以它们用三个双引号 ””” “”” 括起来。
  • 4. Updating objects
    • 一是在编译器中更改后执行整个程序，然后控制台里程序也被更改
    • 二是在编译器中选中更改的区域，右键Run‣Run selection or current line或按F9。
      • 不会运行整个程序，只会运行选中的区域，（更新控制台中的hello对象，而不必执行整个你好.py文件）
• 2. Recommended first steps for Python beginners
  • 1. Reset the namespace
    • 清除命名空间（即控制台中在任何给定时间定义的对象集合）removeallvariables
      • %reset或者控制台的右上角
      • %reset-f
  • 2. Strive for PEP8 Compliance
• 3. Selected preferences
  • 1. where
    • Tools-prefences
  • 2. Warn if PEP 8 code style guidelines are violated
  • 3. Automatic Symbolic Python自动符号Python
• 4. Shortcuts for useful functions有用功能的快捷方式
  • 以下是默认快捷键；但是，带*标记的快捷键可以通过“首选项”中的“键盘快捷键”选项卡进行自定义。
    • 1. F5*执行当前文件
    • 2. F9*执行当前突出显示的代码块；如果不选择任何内容，F9*执行当前行
      • 这对于（例如）在控制台会话中更新函数定义非常有用，而不必再次运行整个文件。
    • 3. Tab*自动补全控制台和编辑器中的命令、函数名、变量名和方法
      • 唯一时，自动补全
      • 不唯一时，显示列表字段，可用上下键回车键进行选择；或者键入更多字母直至唯一
    • 4. Ctrl Enter*执行当前单元格（菜单项Run‣Run cell）
      • 单元格定义为两行之间的代码，以字符#%%、#%%或#<codecell>开头
    • 5. Shift Enter*执行当前单元格并将光标移到下一个单元格（菜单项Run‣Run cell and advance）
      • 单元格对于将大文件或长代码块拆分为更易于管理的块非常有用。每个单元都可以独立运行
    • 6. Alt-Up*当前行向上移动
      • 如果多行高亮显示，它们将一起上移。Alt Down*相应地工作，向下移动行
    • 7. Ctrl-LeftMouseButton or Alt-G*
      • 打开一个新的编辑器选项卡，显示该函数的定义
    • 8. Shift-Ctrl-Alt-M*最大化当前窗口（或在最大化窗口中按此按钮将大小更改回正常）。
    • 9. Ctrl-Shift-F*激活“在文件中查找”窗格，允许在指定范围内的所有文件中进行类似grep的搜索
    • 10. Ctrl-=将增加编辑器或控制台中的字体大小，而Ctrl--将减小字体大小
      • 用户界面其他部分的字体大小可以在“首选项”‣常规‣外观‣字体下设置
    • 11. Ctrl-S* in the Editor保存当前正在编辑的文件
      • 这也会强制更新编辑器左栏中的各种警告三角形（否则，它们默认每2.5秒更新一次，这也是可配置的）
    • 12. Ctrl-S* in the Console将当前IPython会话保存为一个HTML文件，包括任何可能以内联方式显示的图形
      • 一种快速记录会话中所做操作的方法
        • 目前无法将保存的记录重新加载到会话中——如果您需要这样的功能，请查找IPython笔记本
    • 13. Ctrl-I*
      • 当光标在某个对象上时按下Ctrl-I*，将在“帮助”窗格中打开该对象的文档
• 5. Run configuration运行配置
  • 1. Execute in current console（default option, and generally a good choice）
    • Persistence of objects（对象的持久性） after code execution
      • 代码执行后，我们可以与程序运行所在的控制台进行交互，直接在控制台操作调用一些函数，无须再次执行整个程序
    • Persistence of objects from before code execution
      • 更改了编译器中的程序，比如删去了某个变量，但是在控制台中，该变量仍然存在且可调用。
  • 2. Execute in a dedicated console（专用控制台）
    • Run ‣ Configure‣dedicated console
      • 每次执行全部程序都是启动一个新的IPython控制台
        • 优势在于，我们可以确定此控制台中没有定义源自调试和重复执行代码的全局对象
        • 这是一个安全的选项，但是在交互执行中提供了较少的灵活性。
  • 3. How to double check your code executes correctly "on its own"（独立运行，不依赖其他全局变量）
    • 假设选择的是current console有两种方法可以检查代码是否可以独立运行（即，它不依赖于未定义的变量，未导入的模块和命令等）
      • 从当前控制台中的执行切换到专用控制台中的执行，然后从编辑器中运行代码
      • 如果想保留当前的控制台，则可以重置名称空间（reset all variables)清除所有对象，然后从编辑器中执行代码。
  • 4. Recommendation
    • beginners execute in current console.
      • double check using one of the options explained above.
• 6. Other observations其他观察结果
  • 1. Multiple files(多个文件）
    • 在编辑器中打开多个文件时，窗口区域顶部的相应选项卡按打开顺序排列，但如果需要，可以轻松移动
    • as图标，当鼠标悬停在浏览选项卡上时，它将显示浏览选项卡。如果有许多文件处于打开状态，则直接跳转到特定文件非常有用
    • Ctrl-Tab或Ctrl-P来调用文件切换器，它将以最近使用的顺序导航选项卡
  • 2. Environment variables（环境变量）
    • 控制台窗口，单击“选项”菜单，选择“显示环境变量”
  • 3. Reset all customization（重置所有自定义项）
    • 保存在磁盘上的所有自定义项都可以通过在命令行中使用开关--reset调用Spyder来重置，即运行Spyder--reset。
  • 4. Objects in the Variable Explorer（变量资源管理器中的对象）
    • 右键单击变量资源管理器中的对象将显示用于进一步绘制和分析这些对象的选项。
    • 双击简单变量可以直接编辑它们，双击对象会打开一个新窗口，显示它们的内容，并且通常允许对它们进行编辑
  • 5. Python集合（列表、字典、元组…）、Numpy数组、Pandas索引、Series和DataFrame、Pillow图像等等都可以在专门的GUI查看器中显示和编辑，并且大多数任意Python对象都可以像dict（）表示一样被查看、浏览和编辑。
• 7. Documentation string formatting文档字符串格式
  • 如果你想记录你正在开发的代码，我们建议您为其编写文档字符串（documentation strings）或docstrings，使用名为recostructedText（reST）的特殊格式。在科学的Python世界中，通常会遵循另一组称为Numpydoc标准的约定（尽管存在其他系统）。如果您遵循这些准则，您可以在Spyder中获得格式优美的docstring
• 8. Debugging调试
  • 1. Line by line step execution of code（逐行执行代码）
    • 1. Debug ‣ Debug or Ctrl-F5
      • 启动调试执行，激活IPython调试器ipdb。编辑器窗格将突出显示即将执行的行，变量资源管理器将在程序执行点的当前上下文中显示变量
    • 2. Step button or the shortcut Ctrl-F10
      • 逐行执行代码
    • 3. Step Into button or the shortcut Ctrl-F11
      • 检查特定函数的工作方式
    • 4. Step Return button or the shortcut Ctrl-Shift-F12
      • 退出函数并继续下一行
    • 5. breakpoint
      • 如果希望在特定点检查程序，则需要在要停止的行上按F12键，或双击行号的左侧，插入断点。此位置的红点表示断点；可以通过重复相同的过程将其删除
    • 6. Continue button
      • stop the execution at the first breakpoint.
    • 7. 也可以通过在控制台提示符下发出以下命令来控制调试过程
      • n转到下一个语句
      • s进入当前语句。如果这是一个函数调用，请单步执行该函数
      • r完成当前函数中的所有语句，并在返回控制之前从该函数返回
    • 8. 在调试器中，您还可以交互地执行许多通常可以执行的语句，包括分配和修改变量、定义和调用函数、设置新断点等等。
    • 9. Stop button终止调试,或快捷键Ctrl-Shift-F17退出调试器
  • 2. Debugging once an exception has occurred in the Console（在发生异常后直接在控制台进行调试 ）
    • 控制台键入%debug
      • 这将启动IPython调试模式，该模式允许在发生异常的地方检查局部变量。这比在代码中添加print语句并再次运行它要高效得多
    • 如果您使用此命令，您可能还需要使用命令up（即在调试器中按u）和down（即按d），它们在堆栈中上下导航检查点。（向上堆栈意味着调用了当前函数的函数；向下是相反的方向）。您还可以通过随时键入pdb来启用（或禁用）在发生异常时自动触发此调试器。
• 9. Plotting绘制图表
  • 您可以决定是否显示用Matplotlib创建的图；两种显示选项
    • 1. Inline，inside the IPython Console
      • 内联，即在IPython控制台内(Ctrl-S in the console)
        • 此选项方便保存交互式会话的记录
          • 使图形显示在IPython控制台中的命令是：In [ ]: %matplotlib inline
    • 2. Inside a new window, with an options toolbar
      • 在一个新窗口中，有一个选项工具栏
        • 此选项允许您以交互方式放大图形，对其进行操作，设置各种打印和显示选项，并通过菜单将其保存为不同的文件格式
          • 获取图形出现在自己的窗口（由Qt后端渲染）中的命令是：In [ ]: %matplotlib qt
            • The Spyder preferences can be used to customize the default behavior, under Preferences ‣ IPython Console ‣ Graphics ‣ Graphics Backend.
• 10. Historical note历史
  • 本教程最初是基于Hans Fangohr的笔记编写的，这些笔记在南安普顿大学用于为下一代计算建模博士培训中心的本科生和博士生教授Python计算建模。
• editor编辑器 console控制台
• Spyder help Here you can get help of any object by pressing Ctrl +I in front of it, either on the Editor or the Console. Help can also be shown automatically after writing a left parenthesis next to an object. You can activate this behavior in Preferences > Help.