Search bar offers the following options:
Term presence. The below example searches for documents that
must contain “foo”, might contain “bar” and must not contain “baz”:
+foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”:
Search in specific fields. The following search matches all objects
in "twisted.mail" that matches “search”:
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents
that have a word within 1 edit distance of “foo”:
Results provided by Lunr.js
class AbstractFilePath: (source)
||Hash the same as another
||List the children of this path object.|
||Retrieve a child or child's child of this path.|
||Deprecated. Use getAccessTime instead.|
||Retrieve the contents of the file at this path.|
||Deprecated. Use getStatusChangeTime instead.|
||Deprecated. Use getModificationTime instead.|
||Retrieve an iterator of all the ancestors of this path.|
||Return a list of segments between a child and its ancestor.|
||Yield myself, then each of my children, and each of those children's children in turn.|
List the children of this path object.
|an iterable of all currently-existing children of this object.|
|If an error occurs while listing the directory. If the error is 'serious', meaning that the operation failed due to an access violation, exhaustion of some kind of resource (file descriptors or memory), OSError or a platform-specific variant will be raised.|
|If the inability to list the directory is due to this path not existing or not being a directory, the more specific OSError subclass |
Retrieve the contents of the file at this path.
|the contents of the file|
Retrieve an iterator of all the ancestors of this path.
|an iterator of all the ancestors of this path, from the most recent (its immediate parent) to the root of its filesystem.|
Return a list of segments between a child and its ancestor.
For example, in the case of a path X representing /a/b/c/d and a path Y representing /a/b, Y.segmentsFrom(X) will return ['c', 'd'].
|ancestor||an instance of the same class as self, ostensibly an ancestor of self.|
|a list of strs|
|If the ancestor parameter is not actually an ancestor, i.e. a path for /x/y/z is passed as an ancestor for /a/b/c/d.|
Yield myself, then each of my children, and each of those children's children in turn.
The optional argument descend is a predicate that takes a FilePath, and determines whether or not that FilePath is traversed/descended into. It will be called with each path for which isdir returns True. If descend is not specified, all directories will be traversed (including symbolic links which refer to directories).
|descend||A one-argument callable that will return True for FilePaths that should be traversed, False otherwise.|
|a generator yielding FilePath-like objects.|