Structural search and replace

Search for a target structurally

1. In the main menu, go to Edit | Find | Search Structurally to open the Structural Search dialog.

   To quickly switch to the Structural Replace dialog, click .

2. In the Structural Search dialog, do one of the following:

   • Create a template from scratch: select Draft Template from the list of templates and enter the code template (for example, $variable$ to represent your code) in the editor area.

     To save your custom template for future use, click the Save Template icon () on the dialog toolbar. You can also choose to save the template as an inspection.

     

     

     PyCharm adds the created template to the Recent node in the template list.

   • Use one of the existing templates to act as a prototype: select the necessary template from the list of available existing templates.

     Consider the following style definitions added to an HTML file:

     <style> #element1 { display: inline-block; width: 25%; margin-top:90px; } #element2 { display: inline-block; width: 40%; margin-top:10px; } </style>

     Let's find all the references to the style elements included into the <div> tags of your HTML file.

     From the list of existing templates, select html attribute value under XML /HTML.

     

     Click Find to search for these constructions in the entire project.

     PyCharm instantly highlights the found code occurrences in the editor.

3. The Structural Search dialog shows the selected template and the values of its filters. You can edit existing filters or add new conditions, such as regular expressions or script constraints. Place the caret on a code variable and use the filter area to manage its filters.

   

5. In this example, set the following conditions:

   • for $tag$ – text=div

   • for $attribute$ – text=id

   • for $value$ – text=element[1-9]

   

6. Specify the search scope: a project, module, directory, or a custom scope.

7. Click Find.

   PyCharm shows the results in the Find tool window.

   

Replace a target structurally

1. In the main menu, go to Edit | Find | Replace Structurally.

2. In the Replace Structurally dialog, add new or existing templates to the search and replace template areas. You can save the replace template the same way as the search one.

3. If you need to add a filter for the variable in the replace template, place the caret at the variable of interest and use the filter area to manage filters.

   

4. In the filter area, depending on what you chose as a filter, specify the condition.

5. To narrow down your replace results, select the following options:

   • Shorten fully-qualified names - replaces fully qualified class names with short names and imports.

   • Reformat - automatically formats the replaced code.

   • Use static import - uses static import in replacement when possible.

   After specifying the necessary options, click Find. PyCharm displays the results in the Find tool window.

6. In the Find tool window, you can work with the results further, replacing found items one by one, or all of them at once, or previewing your potential changes.

Consider the following example that converts uppercase values of the class attribute in p tags to lowercase. In the Search template field, we create a template that searches for all p tags with uppercase values ([A-Z].* and Match case) in class attributes. We narrow our search only to these to class values (Search target = b). In the Replace template field, we create a new variable $d$ and assign a Groovy script to it (b.getText().toLowerCase()). After the search, we select Replace All to perform the replacing.

Share search templates

You can share a search template with your peers by exporting or importing it.

1. In the Structural Search dialog (Edit | Find | Search Structurally), create a new search template or use the existing one.

2. To export a template, click . PyCharm adds the XML representation of the template to a clipboard (press Ctrl+Shift+V to see the clipboard's content). You can share this representation with other developers in chat, email, or a forum.

   To import a template, copy (Ctrl+C) the shared XML code from anywhere (email, chat, or a forum) and in the Structural Search dialog, click . PyCharm takes the XML code representation and converts it into a template including variables and a scope if it is present.