Go to the latest version of this document.
search in docstrings

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”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +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”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`python`.`modules`.`PathEntry``

class documentation

`class PathEntry(_ModuleIteratorHelper): (source)`

View In Hierarchy

I am a proxy for a single entry on sys.path.

Method | `__init__` | Create a PathEntry. This is a private constructor.
Method | `__repr__` | Undocumented
Instance Variable | `filePath` | a FilePath-like object pointing at the filesystem location or archive file where this path entry is stored.
Instance Variable | `pythonPath` | a PythonPath instance.
Method | `_getEntry` | Implement in subclasses to specify what path entry submodules will come from.
Method | `_packagePaths` | Implement in subclasses to specify where to look for modules.

Inherited from `_ModuleIteratorHelper`:

Method | `__getitem__` | Retrieve a module from below this path or package.
Method | `__iter__` | Implemented to raise NotImplementedError for clarity, so that attempting to loop over this object won't call __getitem__.
Method | `iterModules` | Loop over the modules present below this entry or package on PYTHONPATH.
Method | `walkModules` | Similar to `iterModules`, this yields self, and then every module in my package or entry, and every submodule in each package or entry.
Method | `_subModuleName` | This is a hook to provide packages with the ability to specify their names as a prefix to submodules here.

def __init__(self, filePath, pythonPath): (source)

Create a PathEntry. This is a private constructor.

def __repr__(self): (source)

Undocumented

Returns
`str` | Undocumented

filePath = (source)

a FilePath-like object pointing at the filesystem location or archive file where this path entry is stored.

pythonPath = (source)

a PythonPath instance.

def _getEntry(self): (source)
overrides `twisted.python.modules._ModuleIteratorHelper._getEntry`

Implement in subclasses to specify what path entry submodules will come from.

Returns
a PathEntry instance.

def _packagePaths(self): (source)
overrides `twisted.python.modules._ModuleIteratorHelper._packagePaths`

Implement in subclasses to specify where to look for modules.

Returns
iterable of FilePath-like objects.