Struct SearchPath 

pub struct SearchPath(/* private fields */);

Unification of the various kinds of search paths that can be used to locate Python modules.

The different kinds of search paths are:

• “Extra” search paths: these go at the start of the module resolution order
• First-party search paths: the user code that we are directly invoked on.
• Standard-library search paths: these come in three different forms:
  • Custom standard-library search paths: paths provided by the user pointing to a custom typeshed directory on disk
  • Vendored standard-library search paths: paths pointing to a directory in the vendored zip archive.
  • Real standard-library search paths: path pointing to a directory of the real python stdlib for the environment.
• Site-packages search paths: search paths that point to the site-packages directory, in which packages are installed from PyPI.
• Editable search paths: Additional search paths added to the end of the module resolution order. We discover these by iterating through .pth files in the site-packages directory and searching for lines in those .pth files that point to existing directories on disk. Such lines indicate editable installations, which will be appended to sys.path at runtime, and thus should also be considered valid search paths for our purposes.

For some of the above categories, there may be an arbitrary number in any given list of search paths: for example, the “Extra” category or the “Editable” category. For the “First-party”, “Site-packages” and “Standard-library” categories, however, there will always be exactly one search path from that category in any given list of search paths.

Implementations

impl SearchPath

pub fn is_standard_library(&self) -> bool

Does this search path point to the standard library?

pub fn is_first_party(&self) -> bool

Is this search path in “first party” code? i.e., The end user’s project code.

pub fn is_site_packages(&self) -> bool

Is the module in a site-packages directory?

pub fn describe_kind(&self) -> &'static str

Returns a string suitable for describing what kind of search path this is in user-facing diagnostics.

Trait Implementations

impl Clone for SearchPath

fn clone(&self) -> SearchPath

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SearchPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for SearchPath

impl GetSize for SearchPath

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for SearchPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SearchPath

fn eq(&self, other: &SearchPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SearchPath> for SystemPath

fn eq(&self, other: &SearchPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SearchPath> for SystemPathBuf

fn eq(&self, other: &SearchPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SearchPath> for VendoredPath

fn eq(&self, other: &SearchPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SearchPath> for VendoredPathBuf

fn eq(&self, other: &SearchPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SystemPath> for SearchPath

fn eq(&self, other: &SystemPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SystemPathBuf> for SearchPath

fn eq(&self, other: &SystemPathBuf) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<VendoredPath> for SearchPath

fn eq(&self, other: &VendoredPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<VendoredPathBuf> for SearchPath

fn eq(&self, other: &VendoredPathBuf) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SearchPath