twisted.python._release

module documentation
(source)

Twisted's automated release system.

This module is only for use within Twisted's release system. If you are anyone else, do not use it. The interface and behaviour will change without notice.

Only Linux is supported by this code. It should not be used by any tools which must run on multiple platforms (eg the setup.py script).

Interface ​IVCSCommand An interface for VCS commands.
Class ​APIBuilder Generate API documentation from source files using pydoctor. This requires pydoctor to be installed and usable.
Class ​Build​APIDocs​Script A thing for building API documentation. See main.
Class ​Check​Newsfragment​Script A thing for checking whether a checkout has a newsfragment.
Class ​Git​Command Subset of Git commands to release Twisted from a Git repository.
Class ​No​Documents​Found Raised when no input documents are found.
Class ​Not​Working​Directory Raised when a directory does not appear to be a repository directory of a supported VCS.
Class ​Project A representation of a project that has a version.
Class ​Sphinx​Builder Generate HTML documentation using Sphinx.
Function file​Path​Delta Return a list of strings that represent destination as a path relative to origin.
Function find​Twisted​Projects Find all Twisted-style projects beneath a base directory.
Function get​Repository​Command Detect the VCS used in the specified directory and return a GitCommand if the directory is a Git repository. If the directory is not git, it raises a NotWorkingDirectory exception.
Function replace​In​File I replace the text `oldstr' with `newstr' in `filename' using science.
Function run​Command Execute a vector of arguments.
Constant NEWSFRAGMENT​_TYPES Undocumented
Variable intersphinx​URLs Undocumented
def filePathDelta(origin, destination): (source)

Return a list of strings that represent destination as a path relative to origin.

It is assumed that both paths represent directories, not files. That is to say, the delta of twisted.python.filepath.FilePath /foo/bar to twisted.python.filepath.FilePath /foo/baz will be ../baz, not baz.

Parameters
origin:twisted.python.filepath.FilePathThe origin of the relative path.
destination:twisted.python.filepath.FilePathThe destination of the relative path.
def findTwistedProjects(baseDirectory): (source)
Find all Twisted-style projects beneath a base directory.
Parameters
base​DirectoryA twisted.python.filepath.FilePath to look inside.
Returns
A list of Project.
def getRepositoryCommand(directory): (source)
Detect the VCS used in the specified directory and return a GitCommand if the directory is a Git repository. If the directory is not git, it raises a NotWorkingDirectory exception.
Parameters
directory:FilePathThe directory to detect the VCS used from.
Returns
GitCommandUndocumented
Raises
NotWorkingDirectoryif no supported VCS can be found from the specified directory.
def replaceInFile(filename, oldToNew): (source)
I replace the text `oldstr' with `newstr' in `filename' using science.
def runCommand(args, **kwargs): (source)

Execute a vector of arguments.

This is a wrapper around subprocess.check_output, so it takes the same arguments as subprocess.Popen with one difference: all arguments after the vector must be keyword arguments.

Parameters
argsarguments passed to subprocess.check_output
**kwargskeyword arguments passed to subprocess.check_output
Returns
bytescommand output
NEWSFRAGMENT_TYPES: list[str] = (source)

Undocumented

Value
['doc', 'bugfix', 'misc', 'feature', 'removal']
intersphinxURLs: list[str] = (source)

Undocumented