pscfpp.text.Grep Class Reference
Class to search for text in a file. More...
Public Member Functions | |
| __init__ (self) | |
| Constructor. | |
| addFilter (self, filter) | |
| Add a regular expression string to the list. | |
| clearResults (self) | |
| Clear results list (but not filters) | |
| grep (self, filename) | |
| Search for lines in the file that match any filter. | |
Detailed Description
Class to search for text in a file.
Attributes:
- filters : list of regular expression description strings
- results : lines that match any of the filter strings
- nFilter : number of filter strings
Constructor & Destructor Documentation
◆ __init__()
| pscfpp.text.Grep.__init__ | ( | self | ) |
Constructor.
Definition at line 288 of file text.py.
References pscfpp.text.Grep.filters, pscfpp.text.Grep.nFilter, and pscfpp.text.Grep.results.
Member Function Documentation
◆ addFilter()
| pscfpp.text.Grep.addFilter | ( | self, | |
| filter ) |
Add a regular expression string to the list.
- Parameters
-
filter regular expression string
Definition at line 298 of file text.py.
References pscfpp.text.Grep.filters, pscfpp.text.Grep.nFilter, and pscfpp.text.Grep.results.
◆ clearResults()
| pscfpp.text.Grep.clearResults | ( | self | ) |
Clear results list (but not filters)
Definition at line 306 of file text.py.
References pscfpp.text.Grep.nFilter, and pscfpp.text.Grep.results.
◆ grep()
| pscfpp.text.Grep.grep | ( | self, | |
| filename ) |
Search for lines in the file that match any filter.
- Parameters
-
filename name of file to search
Definition at line 315 of file text.py.
References pscfpp.text.Grep.filters, pscfpp.text.Grep.nFilter, and pscfpp.text.Grep.results.
The documentation for this class was generated from the following file:
Generated on Mon Apr 14 2025 16:29:28 for PSCF by
1.12.0