1. Tarek Ziadé
  2. distribute


Lennart Regebro  committed d9553f2

Name changes of the parameters.

  • Participants
  • Parent commits 097e168
  • Branches 0.6-maintenance

Comments (0)

Files changed (8)

File distribute.egg-info/entry_points.txt

View file
  • Ignore whitespace
 easy_install = setuptools.command.easy_install:main
-easy_install-2.6 = setuptools.command.easy_install:main
+easy_install-3.1 = setuptools.command.easy_install:main
 svn_cvs = setuptools.command.sdist:_default_revctrl
-additional_2to3_fixers = setuptools.dist:assert_string_list
 dependency_links = setuptools.dist:assert_string_list
 entry_points = setuptools.dist:check_entry_points
 extras_require = setuptools.dist:check_extras
-run_2to3 = setuptools.dist:assert_bool
 package_data = setuptools.dist:check_package_data
 install_requires = setuptools.dist:check_requirements
+use_2to3 = setuptools.dist:assert_bool
+use_2to3_fixers = setuptools.dist:assert_string_list
 include_package_data = setuptools.dist:assert_bool
 exclude_package_data = setuptools.dist:check_package_data
 namespace_packages = setuptools.dist:check_nsp
 eager_resources = setuptools.dist:assert_string_list
 zip_safe = setuptools.dist:assert_bool
 test_loader = setuptools.dist:check_importable
-convert_doctests_2to3 = setuptools.dist:assert_string_list
+convert_2to3_doctests = setuptools.dist:assert_string_list
 tests_require = setuptools.dist:check_requirements

File docs/python3.txt

View file
  • Ignore whitespace
 using distribute for Python 3 code works exactly the same as for Python 2
 code, but Distribute also helps you to support Python 2 and Python 3 from
 the same source code by letting you run 2to3 on the code as a part of the
-build process. by setting the keyword parameter ``run_2to3`` to True.
+build process. by setting the keyword parameter ``use_2to3`` to True.
 Distrubute as help during porting
 See :ref:`test` for more information on this.
-Once you have the tests running under Python 2, you can add the run_2to3
+Once you have the tests running under Python 2, you can add the use_2to3
 keyword parameters to setup(), and start running the tests under Python 3.
 The test command will now first run the build command during which the code
 will be converted with 2to3, and the tests will then be run from the build
 Distribute will convert all Python files, and also all doctests in Python
 files. However, if you have doctests located in separate text files, these
 will not automatically be converted. By adding them to the 
-``convert_doctests_2to3`` keyword parameter Distrubute will convert them as 
+``convert_2to3_doctests`` keyword parameter Distrubute will convert them as 
 By default, the conversion uses all fixers in the ``lib2to3.fixers`` package.
-To use additional fixes, the parameter ``additional_2to3_fixers`` can be set
+To use additional fixes, the parameter ``use_2to3_fixers`` can be set
 to a list of names of packages containing fixers.
 A typical setup.py can look something like this::
             package_dir = {'': 'src'},
             packages = ['your', 'you.module'],
             test_suite = 'your.module.tests',
-            run_2to3 = True,
-            convert_doctests_2to3 = ['src/your/module/README.txt'],
-            additional_2to3_fixers = ['your.fixers']
+            use_2to3 = True,
+            convert_2to3_doctests = ['src/your/module/README.txt'],
+            use_2to3_fixers = ['your.fixers']
 Differential conversion
 that should be converted, it will not be converted the next time you run
 the tests, since it hasn't been modified. You need to remove it from the 
 build directory. Also if you run the build, install or test commands before
-adding the run_2to3 parameter, you will have to remove the build directory
+adding the use_2to3 parameter, you will have to remove the build directory
 before you run the test command, as the files otherwise will seem updated, 
 and no conversion will happen.
 list of all fixer class names.
 If you don't want to run the 2to3 conversion on the doctests in Python files,
-you can turn that off by setting ``setuptools.run_2to3_on_doctests = False``.
+you can turn that off by setting ``setuptools.use_2to3_on_doctests = False``.
 Note on compatibility with setuptools
       extra = {}
       if sys.version_info >= (3,):
-          extra['run_2to3'] = True
-          extra['convert_doctests_2to3'] = ['src/your/module/README.txt']
-          extra['additional_2to3_fixers'] = ['your.fixers']
+          extra['use_2to3'] = True
+          extra['convert_2to3_doctests'] = ['src/your/module/README.txt']
+          extra['use_2to3_fixers'] = ['your.fixers']
             version = '1.0',

File docs/setuptools.txt

View file
  • Ignore whitespace
     mess with it.  For more details on how this argument works, see the section
     below on `Automatic Resource Extraction`_.
     Convert the source code from Python 2 to Python 3 with 2to3 during the 
     build process. See :doc:`python3` for more details.
     List of doctest source files that need to be converted with 2to3. 
     See :doc:`python3` for more details.
-    A list of modules to serach for additional fixers to be used during
+    A list of modules to search for additional fixers to be used during
     the 2to3 conversion. See :doc:`python3` for more details.

File setup.py

View file
  • Ignore whitespace
             "include_package_data   = setuptools.dist:assert_bool",
             "dependency_links       = setuptools.dist:assert_string_list",
             "test_loader            = setuptools.dist:check_importable",
-            "run_2to3               = setuptools.dist:assert_bool",
-            "convert_doctests_2to3  = setuptools.dist:assert_string_list",
-            "additional_2to3_fixers = setuptools.dist:assert_string_list",
+            "use_2to3               = setuptools.dist:assert_bool",
+            "convert_2to3_doctests  = setuptools.dist:assert_string_list",
+            "use_2to3_fixers = setuptools.dist:assert_string_list",
         "egg_info.writers": [

File setuptools/__init__.py

View file
  • Ignore whitespace
 bootstrap_install_from = None
-# Should we run 2to3 on all Python files, in Python 3.x?
-# Default: no; assume that a distribution installed for 3.x is already
-# written in 3.x
-run_2to3 = False # Default value if run_2to3 argument not given.
 # If we run 2to3 on .py files, should we also convert docstrings?
 # Default: yes; assume that we can detect doctests reliably
 run_2to3_on_doctests = True
-# Package names for fixer packages
+# Standard package names for fixer packages
 lib2to3_fixer_packages = ['lib2to3.fixes']
 def find_packages(where='.', exclude=()):

File setuptools/command/build_py.py

View file
  • Ignore whitespace
         def run_2to3(self, files, doctests = False):
             # See of the distribution option has been set, otherwise check the
             # setuptools default.
-            if self.distribution.run_2to3 is not True and setuptools.run_2to3 is False:
+            if self.distribution.use_2to3 is not True:
             if not files:
                 self.fixer_names = []
                 for p in setuptools.lib2to3_fixer_packages:
-                if self.distribution.additional_2to3_fixers is not None:
-                    for p in self.distribution.additional_2to3_fixers:
+                if self.distribution.use_2to3_fixers is not None:
+                    for p in self.distribution.use_2to3_fixers:
             if doctests:
                 if setuptools.run_2to3_on_doctests:
                 srcfile = os.path.join(src_dir, filename)
                 outf, copied = self.copy_file(srcfile, target)
                 srcfile = os.path.abspath(srcfile)
-                if copied and srcfile in self.distribution.convert_doctests_2to3:
+                if copied and srcfile in self.distribution.convert_2to3_doctests:

File setuptools/command/test.py

View file
  • Ignore whitespace
-from setuptools import Command, run_2to3
+from setuptools import Command
 from distutils.errors import DistutilsOptionError
 import sys
 from pkg_resources import *
     def with_project_on_sys_path(self, func):
-        if getattr(self.distribution, 'run_2to3', run_2to3):
+        if getattr(self.distribution, 'use_2to3', False):
             # If we run 2to3 we can not do this inplace:
             # Ensure metadata is up-to-date

File setuptools/dist.py

View file
  • Ignore whitespace
             if value is not None:
                 ep.load()(self, ep.name, value)
-        if getattr(self, 'convert_doctests_2to3', None):
+        if getattr(self, 'convert_2to3_doctests', None):
             # XXX may convert to set here when we can rely on set being builtin
-            self.convert_doctests_2to3 = [os.path.abspath(p) for p in self.convert_doctests_2to3]
+            self.convert_2to3_doctests = [os.path.abspath(p) for p in self.convert_2to3_doctests]
-            self.convert_doctests_2to3 = []
+            self.convert_2to3_doctests = []
     def fetch_build_egg(self, req):
         """Fetch an egg needed for building"""