PyCharm 4.0.0 Web Help

2.0+

View | Tool Windows | Project

The Project tool window lets you look at your project from various viewpoints and perform the tasks such as creating new items (directories, packages, files, classes, etc.), opening files in the editor, navigating to the code fragment of interest, and more.

Views

The tool window provides a number of views.

Different views emphasize different project aspects and, generally, define which items are shown and how:

  • Project view. In this view, all the project items along with their dependencies (SDKs and libraries) are shown. The emphasis is on the directory structure (though the packages are also shown).
  • Scope views (Project Files, Problems, etc.). What is shown in the content pane is limited to the corresponding predefined or user-defined scope. In other respects, depending on the currently selected view options, a scope view may resemble the Project view.

The necessary view is selected from the list in the left-hand part of the title bar or, if the views are represented by tabs, by clicking the corresponding tab.

To configure a view, use the corresponding options in the title bar context menu. The necessary options can also be accessed by clicking viewMode on the title bar.

Title bar context menu

The title bar context menu provides the options that let you control every aspect of the tool window appearance and behavior.

There are the options for configuring the project views. There are also the ones for controlling the tool window viewing modes.

The options that are on, have a check mark to the left of their names.

The menu also includes commands for switching between the views, resizing the tool window, and more.

To access the menu, right-click the list of views in the left-hand part of the title bar, or, if the views are represented by tabs, right-click the tab of interest.

The following table lists and briefly explains the available commands and options.

Item Shortcut Description
Select Next View or Select Next Tab Alt+RightAlt+RightAlt+RightAlt+RightAlt+Right, Ctrl+X, N or Ctrl+X, OAlt+RightCtrl+Page DownCtrl+F6, Ctrl+Alt+Left or Ctrl+Page DownShift Command Close Bracket or Control RightControl RightCommand F6 or Alt Command Right Use this command to select the view which is next in the list of available views.

If the views are currently shown as tabs, the tab to the right of the current one will be selected.

Select Previous View or Select Previous Tab Alt+LeftAlt+LeftAlt+LeftAlt+LeftAlt+Left or Ctrl+X, PAlt+LeftCtrl+Page UpCtrl+Shift+F6, Ctrl+Alt+Right or Ctrl+Page UpShift Command Open Bracket or Control LeftControl LeftShift Command F6 or Alt Command Left Use this command to select the view which is previous in the list of available views. Note that previous in this case doesn't mean previously selected.

If the views are currently shown as tabs, the tab to the left of the current one will be selected.

Show List of Views or Show List of Tabs Alt+DownAlt+DownAlt+DownAlt+DownAlt+DownAlt+DownAlt+DownAlt+DownControl DownControl DownControl Down Use this command to show the list of available views (e.g. to select a different view).
Edit Scopes Use this command to open the Scopes dialog in which you can create and edit used-defined scopes.

Note that this command is available only if the current view is a scope view.

Show Members If this option is on, the class members (fields, methods, etc.) are shown.
Autoscroll to Source If this option is on, PyCharm automatically navigates from a file (or a class member) selected in the Project tool window to the corresponding source file (or its fragment) in the editor. If the corresponding file is not currently open, it will open automatically.
Autoscroll from Source If this option is on, PyCharm automatically navigates from a file in the editor to the corresponding node (file, class, field, method, etc.) in the Project tool window.

Note that selecting this option makes the Scroll to Source button icon_scroll_from_source_on_title_bar unavailable.

Sort by Type If the option is off, the items (files, classes, etc.) are sorted alphabetically. If the option is on, the files are sorted by their extensions.
Folders Always on Top If the option is on, all the folders are shown before the files. Otherwise, all the items are sorted alphabetically, and the files and folders appear intermixed.
Show Excluded Files This option is available only in the Project view. (In other views, excluded files are never shown.)

Turn this option on or off to show or hide excluded folders and files.

show_excluded_files

Pinned, Docked, Floating, Split Mode These options let you control general appearance and behavior of the tool window. See Viewing Modes.
Show Views as Tabs If this option is off, there is a list in the left-hand part of the title bar from which you can select the necessary view. If this option is on, the views are represented by tabs which appear in the left-hand part of the title bar.

show_views_as_tabs

Move to To associate the tool window with a different tool window bar, select this command, and then select the destination tool window bar (Top, Left, Bottom or Right).
Resize To resize the tool window by moving one of its borders, select this command, and then select the necessary Stretch to option.

Note that this command is not available for the floating mode.

Hide Shift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift EscapeShift EscapeShift Escape Use this command to hide the tool window.

Title bar icons

Item Shortcut Description
icon_left_right_on_title_bar Alt+RightAlt+RightAlt+RightAlt+RightAlt+Right, Ctrl+X, N or Ctrl+X, OAlt+RightCtrl+Page DownCtrl+F6, Ctrl+Alt+Left or Ctrl+Page DownShift Command Close Bracket or Control RightControl RightCommand F6 or Alt Command Right
Alt+LeftAlt+LeftAlt+LeftAlt+LeftAlt+Left or Ctrl+X, PAlt+LeftCtrl+Page UpCtrl+Shift+F6, Ctrl+Alt+Right or Ctrl+Page UpShift Command Open Bracket or Control LeftControl LeftShift Command F6 or Alt Command Left
If the views are currently shown as tabs (the Show Views as Tabs option is on), this button appears to the right of the last visible tab.

If the first or the last of the available views is currently selected, this button is shown as icon_right_on_title_bar or icon_left_on_title_bar.

Click this button to open the list of views, for example, to select a different view.

icon_scroll_from_source_on_title_bar Click this button to navigate from a file in the editor to the corresponding node (file, class, field, method, etc.) in the Project tool window.

Note that this button is not available, if the Autoscroll from Source option is currently on.

icon_collapse_all_on_title_bar Ctrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCommand NumPad - or Command MinusCommand NumPad - or Command MinusCommand NumPad - or Command Minus Use this icon or shortcut to collapse all the nodes.
viewMode Click this button to open the menu for configuring the current view and changing the tool window viewing modes.

Note that most of the menu items are options that you can turn on or off. An option which is on has a check mark to the left of its name.

The available options are a subset of the title bar context menu items. Depending on the current view, the menu may include the following options:

hideSide Shift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift EscapeShift EscapeShift Escape Use this icon or shortcut to hide the tool window.

When used in combination with the Alt key, clicking this icon hides all the tool windows attached to the same tool window bar.

Content pane: main items

The content pane shows the project items such as modules, packages, directories, files, classes, libraries, etc.

The icons for the main categories (node types) are shown and briefly explained in the following table. The icons used for the main file types are listed in File Types Recognized by PyCharm; the icons for the main symbols (classes, fields, methods, etc.) are shown in Symbols.

Item Description
moduleFolder A module.
iconPackage A package.
folder A folder (directory). Different folder types have different colors:
  • An "ordinary" folder folder.
  • A source folder rootSource.

For more information on folder types, see Content Root.

library External Libraries, a category for grouping third party software associated with the project. The node is only shown when the Project view is selected.

Content pane: context menu commands

When you right-click an item in the content pane, the context menu for this item is shown. This menu provides access to all the functions available for the selected item.

The following table lists and briefly explains the most frequently used context menu commands.

Item Shortcut Description
New Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Use this command to create a new item (directory, file, or class). within the selected one (project or directory). Select the new item type from the submenu.
Cut Ctrl+X or Shift+DeleteCtrl+X or Shift+DeleteCtrl+X or Shift+DeleteCtrl+X or Shift+DeleteShift+Delete or Alt+XCtrl+X or Shift+DeleteCtrl+X or Shift+DeleteCtrl+X or Shift+DeleteCommand X or Shift DeleteCommand X or Shift DeleteCommand X or Shift Delete Use this command to move the selected item or items from the current location to the clipboard.
Copy Ctrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+Insert, Alt+C or Escape, WCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCommand C or Command InsertCommand C or Command InsertCommand C or Command Insert Use this command to copy the selected item or items to the clipboard.
Copy Path(s) Ctrl+Shift+CCtrl+Shift+CCtrl+Shift+CCtrl+Shift+CCtrl+Shift+CCtrl+Shift+CCtrl+Shift+CCtrl+Shift+CShift Command CShift Command CShift Command C Use this command to copy the full path(s) of the selected item or items to the clipboard.
Copy Reference Ctrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CCtrl+Shift+Alt+CShift Alt Command CShift Alt Command CShift Alt Command C Use this command to copy a reference to the selected item to the clipboard.
Paste Ctrl+V or Shift+InsertCtrl+V or Shift+InsertCtrl+V or Shift+InsertCtrl+V or Shift+InsertAlt+P, Shift+Insert or Ctrl+YCtrl+V or Shift+InsertCtrl+V or Shift+InsertCtrl+V or Shift+InsertCommand V or Shift InsertCommand V or Shift InsertCommand V or Shift Insert Use this command to insert the contents of the clipboard into the selected location.
Jump to Source F4F4F4F4F4F4F4F12 or Ctrl+Shift+ECommand Down or F4F4F3 Use this command to open the selected file in the editor and make this file active. If the file is already open, it will just become active.
Open Module Settings F4F4F4F4F4F4F4F12 or Ctrl+Shift+ECommand Down or F4F4F3 Use this command to see the settings for the selected module. These will be shown on the Modules page in the Project Structure dialog.
Find Usages Alt+F7Shift+Alt+7Shift+Alt+7Alt+F7Alt+F7 or Shift+Alt+SShift+Alt+F7Alt+F7Ctrl+GAlt F7Alt F7Shift Command G Use this command to find the usages of the selected item. (The Find Usages dialog will open.)
Find in Path Ctrl+Shift+FCtrl+Shift+FCtrl+Shift+FCtrl+Shift+FCtrl+Shift+FCtrl+Shift+FCtrl+Shift+FCtrl+HShift Command FControl Shift FControl H Use this command to perform a text search. (The Find in Path dialog will open.)
Replace in Path Ctrl+Shift+RCtrl+Shift+RCtrl+Shift+RCtrl+Shift+RCtrl+Shift+RCtrl+Shift+RCtrl+Shift+HCtrl+Shift+RShift Command RControl Shift RShift Command R Use this command to perform text search-and-replace. (The Replace in Path dialog will open.)
Refactor Use this command to perform one of the refactorings available for the selected item.
Add to Favorites Use this command to add the selected item to an existing or new list of favorite items. See Managing Your Project Favorites.
Show Thumbnails Ctrl+Shift+TCtrl+Shift+TCtrl+Shift+TCtrl+Shift+TCtrl+Shift+TCtrl+Shift+TCtrl+Shift+TCtrl+Shift+TShift Command TShift Command TShift Command T Use this command to view thumbnails for image files located in the selected directory. (The Thumbnails tool window will open.)
Reformat Code Ctrl+Alt+LCtrl+Alt+LShift+Alt+LCtrl+Alt+LCtrl+Alt+LAlt+F8 or Ctrl+Alt+FShift+Alt+FCtrl+Alt+L or Ctrl+Shift+FAlt Command LAlt Command LShift Command F Use this command to reformat the source code in the selected file or in all files in the current directory. (The Reformat Code dialog will open.)

See also, Reformatting Source Code.

Delete DeleteDeleteDeleteDeleteDelete or Ctrl+DDeleteDeleteDeleteDelete, Backspace or Command BackspaceDelete, Backspace or Command BackspaceDelete, Backspace or Command Backspace Use this command to delete the selected item. Use with care!
Remove Module DeleteDeleteDeleteDeleteDelete or Ctrl+DDeleteDeleteDeleteDelete, Backspace or Command BackspaceDelete, Backspace or Command BackspaceDelete, Backspace or Command Backspace Use this command to remove a module from your project. Note that the files that make up the module are not physically removed from the disk.
Local History Use this command to view local history for the selected file or directory, or to create a label for the current version of your project. See Local History and Using Local History.
Synchronize '<name>' Use this command to synchronize the selected item with its version saved in the file system.

(If you change a file or directory contents externally, PyCharm, under certain circumstances, may not be aware of the corresponding changes unless you use this command.)

Show in Explorer Use this command to open a file browser (e.g. Windows Explorer or Finder) and show the selected item there.
File Path Ctrl+Alt+F12Ctrl+Shift+Alt+2Ctrl+Shift+Alt+2Ctrl+Shift+Alt+2Ctrl+Alt+F12Ctrl+Alt+F12Ctrl+Alt+F12Ctrl+Alt+F12Alt Command F12Alt Command F12Alt Command F12 Use this command to open the File Path menu. This menu shows the path from the file system root to the selected element with individual directories as the menu items.

When you select an item in this menu (e.g. a directory), a file browser (e.g. Windows Explorer or Finder) opens, and the selected item is shown there.

Compare Directory with Ctrl+DCtrl+DCtrl+DCtrl+DCtrl+DCtrl+DCtrl+DCtrl+DCommand DCommand DCommand D Use this command to compare the contents of the selected directory with the contents of some other local directory. The other directory is selected in the corresponding dialog. See Comparing Folders and Differences Viewer for Folders and DB Objects.
Compare File with Editor Use this command to compare the contents of the selected file with the contents of the file active in the editor. See Comparing Files and Differences Viewer.
Mark Directory As Use this command to make the selected directory a source root or a test source root, to make the directory excluded, etc.

The necessary category for the directory is selected from the submenu.

For more information on the categories for directories, see Content Root.

Diagrams Ctrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UShift Alt Command UShift Alt Command UShift Alt Command U or Ctrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UAlt Command UAlt Command UAlt Command U Use this command to open a diagram (e.g. a UML diagram) for the selected item. For more information, see Diagram Reference.

Content pane: file status highlights

PyCharm uses colors to denote VCS file status in the Project tool window. The following table presents information about the meaning of the colors.

Color File Status Description
Black Up to date File is unchanged.
highlightBlackTxt
Gray Deleted File is scheduled for deletion from the repository.
highlightGrey
Blue Modified File has changed since the last synchronization.
highlightBlueTxt
Green Added File is scheduled for addition to the repository.
highlightGreenTxt
Violet Merged File is merged by your VCS as a result of an update.
highlightVioletTxt
Brown Unknown File exists locally, but is not in the repository, and is not scheduled for adding.
highlightBrown
Olive Ignored File will be ignored in any VCS operation.
highlightOlive
Light brown Hijacked File is modified without checkout. This status is valid for the files under Perforce, ClearCase and VSS.
hijacked
Red Merged with conflicts During the last update, file was merged with conflicts.
highlightRedTxt
Lilac Externally deleted File is deleted locally, but was not scheduled for deletion, and still exists in the CVS repository.
highlightLilac
Dark cyan Switched The file is taken from a different branch than the whole project. This status is valid for CVS and SVN.
highlightCyanTxt

See Also

Concepts:

Procedures:

Reference:

Getting Started:

Web Resources: