summaryrefslogtreecommitdiffstats
path: root/Lib/importlib/abc.py
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2011-01-13 19:08:04 (GMT)
committerRaymond Hettinger <python@rcn.com>2011-01-13 19:08:04 (GMT)
commitd958ea70bc20a609c8d6a885998bfa8ffeff955b (patch)
tree2b7ab88e4abc9922472ab78af37cf74949696f34 /Lib/importlib/abc.py
parentcbb80896ae8202842cb83cf6ccc53b023270b550 (diff)
downloadcpython-d958ea70bc20a609c8d6a885998bfa8ffeff955b.zip
cpython-d958ea70bc20a609c8d6a885998bfa8ffeff955b.tar.gz
cpython-d958ea70bc20a609c8d6a885998bfa8ffeff955b.tar.bz2
Issue 10899: Remove function type annotations from the stdlib
Diffstat (limited to 'Lib/importlib/abc.py')
-rw-r--r--Lib/importlib/abc.py36
1 files changed, 21 insertions, 15 deletions
diff --git a/Lib/importlib/abc.py b/Lib/importlib/abc.py
index 2f6cfa4..fa343f8 100644
--- a/Lib/importlib/abc.py
+++ b/Lib/importlib/abc.py
@@ -19,7 +19,8 @@ class Loader(metaclass=abc.ABCMeta):
@abc.abstractmethod
def load_module(self, fullname):
- """Abstract method which when implemented should load a module."""
+ """Abstract method which when implemented should load a module.
+ The fullname is a str."""
raise NotImplementedError
@@ -29,7 +30,10 @@ class Finder(metaclass=abc.ABCMeta):
@abc.abstractmethod
def find_module(self, fullname, path=None):
- """Abstract method which when implemented should find a module."""
+ """Abstract method which when implemented should find a module.
+ The fullname is a str and the optional path is a str or None.
+ Returns a Loader object.
+ """
raise NotImplementedError
Finder.register(machinery.BuiltinImporter)
@@ -49,7 +53,7 @@ class ResourceLoader(Loader):
@abc.abstractmethod
def get_data(self, path):
"""Abstract method which when implemented should return the bytes for
- the specified path."""
+ the specified path. The path must be a str."""
raise NotImplementedError
@@ -65,19 +69,19 @@ class InspectLoader(Loader):
@abc.abstractmethod
def is_package(self, fullname):
"""Abstract method which when implemented should return whether the
- module is a package."""
+ module is a package. The fullname is a str. Returns a bool."""
raise NotImplementedError
@abc.abstractmethod
def get_code(self, fullname):
"""Abstract method which when implemented should return the code object
- for the module"""
+ for the module. The fullname is a str. Returns a types.CodeType."""
raise NotImplementedError
@abc.abstractmethod
def get_source(self, fullname):
"""Abstract method which should return the source code for the
- module."""
+ module. The fullname is a str. Returns a str."""
raise NotImplementedError
InspectLoader.register(machinery.BuiltinImporter)
@@ -118,12 +122,14 @@ class SourceLoader(_bootstrap.SourceLoader, ResourceLoader, ExecutionLoader):
"""
def path_mtime(self, path):
- """Return the modification time for the path."""
+ """Return the (int) modification time for the path (str)."""
raise NotImplementedError
def set_data(self, path, data):
"""Write the bytes to the path (if possible).
+ Accepts a str path and data as bytes.
+
Any needed intermediary directories are to be created. If for some
reason the file cannot be written because of permissions, fail
silently.
@@ -171,8 +177,8 @@ class PyLoader(SourceLoader):
@abc.abstractmethod
def source_path(self, fullname):
- """Abstract method which when implemented should return the path to the
- source code for the module."""
+ """Abstract method. Accepts a str module name and returns the path to
+ the source code for the module."""
raise NotImplementedError
def get_filename(self, fullname):
@@ -280,19 +286,19 @@ class PyPycLoader(PyLoader):
@abc.abstractmethod
def source_mtime(self, fullname):
- """Abstract method which when implemented should return the
+ """Abstract method. Accepts a str filename and returns an int
modification time for the source of the module."""
raise NotImplementedError
@abc.abstractmethod
def bytecode_path(self, fullname):
- """Abstract method which when implemented should return the path to the
- bytecode for the module."""
+ """Abstract method. Accepts a str filename and returns the str pathname
+ to the bytecode for the module."""
raise NotImplementedError
@abc.abstractmethod
def write_bytecode(self, fullname, bytecode):
- """Abstract method which when implemented should attempt to write the
- bytecode for the module, returning a boolean representing whether the
- bytecode was written or not."""
+ """Abstract method. Accepts a str filename and bytes object
+ representing the bytecode for the module. Returns a boolean
+ representing whether the bytecode was written or not."""
raise NotImplementedError