Change 'requires' to 'include'.

1 files changed, 29 insertions, 29 deletions

diff --git a/coverage/control.py b/coverage/control.py
index 2c774ae6..9ac7fea9 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -31,7 +31,7 @@ class coverage(object):
     """
 
     def __init__(self, data_file=None, data_suffix=None, cover_pylib=None,
-                auto_data=False, timid=None, branch=None, config_file=True, omit_prefixes=None, require_prefixes=None):
+                auto_data=False, timid=None, branch=None, config_file=True, omit_prefixes=None, include_prefixes=None):
         """
         `data_file` is the base name of the data file to use, defaulting to
         ".coverage".  `data_suffix` is appended (with a dot) to `data_file` to
@@ -61,10 +61,10 @@ class coverage(object):
         `omit_prefixes` is a list of prefixes.  CodeUnits that match those prefixes
         will be omitted from the list.
 
-        `require_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
+        `include_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
         will be included in the list.
 
-        You are required to pass at most one of `omit_prefixes` and `require_prefixes`.
+        You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
         """
         from coverage import __version__
 
@@ -89,7 +89,7 @@ class coverage(object):
             data_file=data_file, cover_pylib=cover_pylib, timid=timid,
             branch=branch, parallel=bool_or_none(data_suffix),
             omit_prefixes=omit_prefixes,
-            require_prefixes=require_prefixes
+            include_prefixes=include_prefixes
             )
 
         self.auto_data = auto_data
@@ -104,10 +104,10 @@ class coverage(object):
             self.omit_prefixes = [self.file_locator.abs_file(p) for p in self.config.omit_prefixes]
         else:
             self.omit_prefixes = []
-        if self.config.require_prefixes:
-            self.require_prefixes = [self.file_locator.abs_file(p) for p in self.config.require_prefixes]
+        if self.config.include_prefixes:
+            self.include_prefixes = [self.file_locator.abs_file(p) for p in self.config.include_prefixes]
         else:
-            self.require_prefixes = []
+            self.include_prefixes = []
 
         self.collector = Collector(
             self._should_trace, timid=self.config.timid,
@@ -190,8 +190,8 @@ class coverage(object):
         if canonical.startswith(self.cover_prefix):
             return False
 
-        if self.require_prefixes:
-            for prefix in self.require_prefixes:
+        if self.include_prefixes:
+            for prefix in self.include_prefixes:
                 if canonical.startswith(prefix):
                     return canonical
             else:
@@ -350,7 +350,7 @@ class coverage(object):
         return Analysis(self, it)
 
     def report(self, morfs=None, show_missing=True, ignore_errors=None,
-                file=None, omit_prefixes=None, require_prefixes=None):     # pylint: disable-msg=W0622
+                file=None, omit_prefixes=None, include_prefixes=None):     # pylint: disable-msg=W0622
         """Write a summary report to `file`.
 
         Each module in `morfs` is listed, with counts of statements, executed
@@ -358,24 +358,24 @@ class coverage(object):
 
         `omit_prefixes` is a list of prefixes.  CodeUnits that match those prefixes
         will be omitted from the list.
-        `require_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
+        `include_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
         will be included in the list.
-        You are required to pass at most one of `omit_prefixes` and `require_prefixes`.
+        You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
         """
         self.config.from_args(
             ignore_errors=ignore_errors,
             omit_prefixes=omit_prefixes,
-            require_prefixes=require_prefixes
+            include_prefixes=include_prefixes
             )
         reporter = SummaryReporter(
             self, show_missing, self.config.ignore_errors
             )
         reporter.report(
-            morfs, outfile=file, omit_prefixes=self.config.omit_prefixes, require_prefixes=self.config.require_prefixes
+            morfs, outfile=file, omit_prefixes=self.config.omit_prefixes, include_prefixes=self.config.include_prefixes
             )
 
     def annotate(self, morfs=None, directory=None, ignore_errors=None,
-                    omit_prefixes=None, require_prefixes=None):
+                    omit_prefixes=None, include_prefixes=None):
         """Annotate a list of modules.
 
         Each module in `morfs` is annotated.  The source is written to a new
@@ -385,45 +385,45 @@ class coverage(object):
 
         `omit_prefixes` is a list of prefixes.  CodeUnits that match those prefixes
         will be omitted from the list.
-        `require_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
+        `include_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
         will be included in the list.
-        You are required to pass at most one of `omit_prefixes` and `require_prefixes`.
+        You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
         """
         self.config.from_args(
             ignore_errors=ignore_errors,
             omit_prefixes=omit_prefixes,
-            require_prefixes=require_prefixes
+            include_prefixes=include_prefixes
             )
         reporter = AnnotateReporter(self, self.config.ignore_errors)
         reporter.report(
-            morfs, directory=directory, omit_prefixes=self.config.omit_prefixes, require_prefixes=self.config.require_prefixes
+            morfs, directory=directory, omit_prefixes=self.config.omit_prefixes, include_prefixes=self.config.include_prefixes
             )
 
     def html_report(self, morfs=None, directory=None, ignore_errors=None,
-                    omit_prefixes=None, require_prefixes=None):
+                    omit_prefixes=None, include_prefixes=None):
         """Generate an HTML report.
 
         `omit_prefixes` is a list of prefixes.  CodeUnits that match those prefixes
         will be omitted from the list.
-        `require_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
+        `include_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
         will be included in the list.
-        You are required to pass at most one of `omit_prefixes` and `require_prefixes`.
+        You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
         """
         self.config.from_args(
             ignore_errors=ignore_errors,
             omit_prefixes=omit_prefixes,
-            require_prefixes=require_prefixes,
+            include_prefixes=include_prefixes,
             html_dir=directory,
             )
         reporter = HtmlReporter(self, self.config.ignore_errors)
         reporter.report(
             morfs, directory=self.config.html_dir,
             omit_prefixes=self.config.omit_prefixes,
-            require_prefixes=self.config.require_prefixes
+            include_prefixes=self.config.include_prefixes
             )
 
     def xml_report(self, morfs=None, outfile=None, ignore_errors=None,
-                    omit_prefixes=None, require_prefixes=None):
+                    omit_prefixes=None, include_prefixes=None):
         """Generate an XML report of coverage results.
 
         The report is compatible with Cobertura reports.
@@ -433,14 +433,14 @@ class coverage(object):
 
         `omit_prefixes` is a list of prefixes.  CodeUnits that match those prefixes
         will be omitted from the list.
-        `require_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
+        `include_prefixes` is a list of prefixes.  Only CodeUnits that match those prefixes
         will be included in the list.
-        You are required to pass at most one of `omit_prefixes` and `require_prefixes`.
+        You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
         """
         self.config.from_args(
             ignore_errors=ignore_errors,
             omit_prefixes=omit_prefixes,
-            require_prefixes=require_prefixes,
+            include_prefixes=include_prefixes,
             xml_output=outfile,
             )
         file_to_close = None
@@ -453,7 +453,7 @@ class coverage(object):
         try:
             reporter = XmlReporter(self, self.config.ignore_errors)
             reporter.report(
-                morfs, omit_prefixes=self.config.omit_prefixes, require_prefixes=self.config.require_prefixes, outfile=outfile
+                morfs, omit_prefixes=self.config.omit_prefixes, include_prefixes=self.config.include_prefixes, outfile=outfile
                 )
         finally:
             if file_to_close: