From b875143b79b2e2ac6d87496d699e82e8123b6e5e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 2 Jan 2016 16:20:14 -0500 Subject: Add some docstrings --HG-- branch : feature/issue-229 --- pkg_resources/extern/__init__.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pkg_resources/extern/__init__.py b/pkg_resources/extern/__init__.py index 9b1599f8..2d338426 100644 --- a/pkg_resources/extern/__init__.py +++ b/pkg_resources/extern/__init__.py @@ -13,10 +13,17 @@ class VendorImporter: @property def search_path(self): + """ + Search first the vendor package then as a natural package. + """ yield self.vendor_pkg + '.' yield '' def find_module(self, fullname, path=None): + """ + Return self when fullname starts with root_name and the + target module is one vendored through this importer. + """ root, base, target = fullname.partition(self.root_name + '.') if root: return @@ -25,6 +32,9 @@ class VendorImporter: return self def load_module(self, fullname): + """ + Iterate over the search path to locate and load fullname. + """ root, base, target = fullname.partition(self.root_name + '.') for prefix in self.search_path: try: @@ -45,6 +55,9 @@ class VendorImporter: ) def install(self): + """ + Install this importer into sys.meta_path if not already present. + """ if self not in sys.meta_path: sys.meta_path.append(self) -- cgit v1.2.3