Merge branch 'trunk' into 7530-altendky-do_not_require_trailing_newli…

…ne_for_cert
kwahome · Aug 4, 2017 · 6a8b32d · 6a8b32d
2 parents ddfa34c + 760d56e
commit 6a8b32d
Show file tree

Hide file tree

Showing 24 changed files with 453 additions and 347 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -39,7 +39,7 @@ matrix:
     # For now all non-trial tests are in a single job to reduce the time spent
     # on starting separate jobs.
     - python: 2.7
-      env: TOXENV=narrativedocs,apidocs,pyflakes,topfile,manifest-checker
+      env: TOXENV=narrativedocs,apidocs,pyflakes,newsfragment,manifest-checker
     - python: 3.5
       env: TOXENV=pyflakes3
     # Twistedchecker is running as a separate job so that we can ignore if it

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -5,7 +5,7 @@
 #  - All of the test files, so that the tests can be run on an installed copy.
 # We do not want to include:
 #  - Release management files (e.g. topfiles)
-#  - Things only useful when running from a source checkout (_preamble.py)
+#  - Things only useful when running from a source checkout
 
 # Do not include the old topfiles, or news fragments
 recursive-exclude src/twisted *.misc *.bugfix *.doc *.feature *.removal

diff --git a/bin/_preamble.py b/bin/_preamble.py
diff --git a/bin/admin/build-apidocs b/bin/admin/build-apidocs
@@ -6,15 +6,7 @@
 # This script is not meant to be distributed to users of Twisted.
 # It is only for use in making upstream Twisted releases.
 
-import sys, os
-extra = os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), "src")
-sys.path.insert(0, extra)
-try:
-    import _preamble
-except ImportError:
-    pass
-sys.path.remove(extra)
-
+import sys
 from twisted.python._release import BuildAPIDocsScript
 
 BuildAPIDocsScript().main(sys.argv[1:])
diff --git a/bin/admin/build-docs b/bin/admin/build-docs
@@ -6,15 +6,7 @@
 # This script is not meant to be distributed to users of Twisted.
 # It is only for use in making upstream Twisted releases.
 
-import sys, os
-extra = os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), "src")
-sys.path.insert(0, extra)
-try:
-    import _preamble
-except ImportError:
-    pass
-sys.path.remove(extra)
-
+import sys
 from twisted.python._release import SphinxBuilder
 
 SphinxBuilder().main(sys.argv[1:])
diff --git a/bin/admin/check-newsfragment b/bin/admin/check-newsfragment
@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+# Copyright (c) Twisted Matrix Laboratories.
+# See LICENSE for details.
+
+"""
+Check that the current commits since branching have a topfile.
+"""
+
+from __future__ import absolute_import, division, print_function
+
+import sys
+from twisted.python._release import CheckNewsfragmentScript
+
+CheckNewsfragmentScript(print).main(sys.argv[1:])
diff --git a/bin/admin/check-topfile b/bin/admin/check-topfile
diff --git a/docs/core/development/policy/coding-standard.rst b/docs/core/development/policy/coding-standard.rst
@@ -371,30 +371,15 @@ This makes the script more portable but note that it is not a foolproof method.
 Always make sure that ``/usr/bin/env`` exists or use a softlink/symbolic link to point it to the correct path.
 Python's distutils will rewrite the shebang line upon installation so this policy only covers the source files in version control.
 
-#. For core scripts, add this Twisted running-from-Git header:
+#. For core scripts, add an entry to ``_CONSOLE_SCRIPTS`` in ``src/twisted/python/_setup.py``:
 
    .. code-block:: python
 
-       import sys
-       try:
-           import _preamble
-       except ImportError:
-           sys.clear_exc()
-
-
-   Or for sub-project scripts, add a modified version which also adjusts ``sys.path``:
-
-   .. code-block:: python
-
-       import sys, os
-       extra = os.path.dirname(os.path.dirname(sys.argv[0]))
-       sys.path.insert(0, extra)
-       try:
-           import _preamble
-       except ImportError:
-           sys.clear_exc()
-       sys.path.remove(extra)
-
+       _CONSOLE_SCRIPTS = [
+           ...
+           "twistd = twisted.scripts.twistd:run",
+           "yourmodule" = "twisted.scripts.yourmodule:run",
+       ]
 
 #. And end with:
 
@@ -407,7 +392,10 @@ Python's distutils will rewrite the shebang line upon installation so this polic
 #. Write a manpage and add it to the ``man`` folder of a subproject's ``doc`` folder.
    On Debian systems you can find a skeleton example of a manpage in ``/usr/share/doc/man-db/examples/manpage.example``.
 
-This will ensure your program will work correctly for users of Git, Windows releases and Debian packages.
+
+This will ensure that your program will have a proper ``console_scripts`` entry point, which
+``setup.py`` will use to generate a console script which will work correctly for users of
+Git, Windows releases and Debian packages.
 
 
 Examples

diff --git a/docs/core/development/policy/release-process.rst b/docs/core/development/policy/release-process.rst
@@ -111,7 +111,7 @@ How to do a release candidate
 4. Run ``python -m incremental.update Twisted --rc``
 5. Commit the changes made by Incremental.
 6. Run ``towncrier``.
-7. Commit the changes made by towncrier - this automatically removes the NEWS topfiles.
+7. Commit the changes made by towncrier - this automatically removes the NEWS newsfragments.
 8. Bump copyright dates in ``LICENSE``, ``twisted/copyright.py``, and ``README.rst`` if required
 9. Push the changes up to GitHub.
 10. Run ``python setup.py sdist --formats=bztar -d /tmp/twisted-release`` to build the tarballs.

diff --git a/src/twisted/newsfragments/9247.misc b/src/twisted/newsfragments/9247.misc
diff --git a/src/twisted/newsfragments/9248.misc b/src/twisted/newsfragments/9248.misc
diff --git a/src/twisted/newsfragments/9249.misc b/src/twisted/newsfragments/9249.misc
diff --git a/src/twisted/python/_release.py b/src/twisted/python/_release.py
@@ -23,8 +23,8 @@
 from twisted.python.filepath import FilePath
 from twisted.python.monkey import MonkeyPatcher
 
-# Types of topfiles.
-TOPFILE_TYPES = ["doc", "bugfix", "misc", "feature", "removal"]
+# Types of newsfragments.
+NEWSFRAGMENT_TYPES = ["doc", "bugfix", "misc", "feature", "removal"]
 intersphinxURLs = [
     u"https://docs.python.org/2/objects.inv",
     u"https://docs.python.org/3/objects.inv",
@@ -201,7 +201,7 @@ class Project(object):
 
     @ivar directory: A L{twisted.python.filepath.FilePath} pointing to the base
         directory of a Twisted-style Python package. The package should contain
-        a C{_version.py} file and a C{topfiles} directory that contains a
+        a C{_version.py} file and a C{newsfragments} directory that contains a
         C{README} file.
     """
 
@@ -241,7 +241,7 @@ def findTwistedProjects(baseDirectory):
     """
     projects = []
     for filePath in baseDirectory.walk():
-        if filePath.basename() == 'topfiles':
+        if filePath.basename() == 'newsfragments':
             projectDirectory = filePath.parent()
             projects.append(Project(projectDirectory))
     return projects
@@ -497,7 +497,7 @@ def main(self, args):
 
 
 
-class CheckTopfileScript(object):
+class CheckNewsfragmentScript(object):
     """
     A thing for checking whether a checkout has a newsfragment.
     """
@@ -541,22 +541,22 @@ def main(self, args):
                 self._print("Quotes change only; no newsfragment needed.")
                 sys.exit(0)
 
-        topfiles = []
+        newsfragments = []
 
         for change in files:
             if os.sep + "newsfragments" + os.sep in change:
-                if "." in change and change.rsplit(".", 1)[1] in TOPFILE_TYPES:
-                    topfiles.append(change)
+                if "." in change and change.rsplit(".", 1)[1] in NEWSFRAGMENT_TYPES:
+                    newsfragments.append(change)
 
         if branch.startswith("release-"):
-            if topfiles:
+            if newsfragments:
                 self._print("No newsfragments should be on the release branch.")
                 sys.exit(1)
             else:
                 self._print("Release branch with no newsfragments, all good.")
                 sys.exit(0)
 
-        for change in topfiles:
+        for change in newsfragments:
             self._print("Found " + change)
             sys.exit(0)
 

diff --git a/src/twisted/python/_setup.py b/src/twisted/python/_setup.py
@@ -415,12 +415,6 @@ def _checkCPython(sys=sys, platform=platform):
     "twisted.test.test_hook",
     "twisted.test.test_rebuild",
     "twisted.test.test_shortcut",
-    "twisted.web.domhelpers",
-    "twisted.web.microdom",
-    "twisted.web.rewrite",
     "twisted.web.soap",
-    "twisted.web.sux",
-    "twisted.web.test.test_domhelpers",
     "twisted.web.test.test_soap",
-    "twisted.web.test.test_xml",
 ]