/brz/remove-bazaar : contents of breezy/propose.py at revision 7447

: (revision 7447)

To get this branch, use:

bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

# Copyright (C) 2018-2019 Breezy Developers
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Helper functions for proposing merges."""

from __future__ import absolute_import

from . import (
    errors,
    hooks,
    registry,
    urlutils,
    )


class NoSuchProject(errors.BzrError):

    _fmt = "Project does not exist: %(project)s."

    def __init__(self, project):
        errors.BzrError.__init__(self)
        self.project = project


class MergeProposalExists(errors.BzrError):

    _fmt = "A merge proposal already exists: %(url)s."

    def __init__(self, url):
        errors.BzrError.__init__(self)
        self.url = url


class UnsupportedHoster(errors.BzrError):

    _fmt = "No supported hoster for %(branch)s."

    def __init__(self, branch):
        errors.BzrError.__init__(self)
        self.branch = branch


class ReopenFailed(errors.BzrError):

    _fmt = "Reopening the merge proposal failed: %(error)s."


class ProposeMergeHooks(hooks.Hooks):
    """Hooks for proposing a merge on Launchpad."""

    def __init__(self):
        hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
        self.add_hook(
            'get_prerequisite',
            "Return the prerequisite branch for proposing as merge.", (3, 0))
        self.add_hook(
            'merge_proposal_body',
            "Return an initial body for the merge proposal message.", (3, 0))


class LabelsUnsupported(errors.BzrError):
    """Labels not supported by this hoster."""

    _fmt = "Labels are not supported by %(hoster)r."

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class PrerequisiteBranchUnsupported(errors.BzrError):
    """Prerequisite branch not supported by this hoster."""

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class HosterLoginRequired(errors.BzrError):
    """Action requires hoster login credentials."""

    _fmt = "Action requires credentials for hosting site %(hoster)r."""

    def __init__(self, hoster):
        errors.BzrError.__init__(self)
        self.hoster = hoster


class MergeProposal(object):
    """A merge proposal.

    :ivar url: URL for the merge proposal
    """

    def __init__(self, url=None):
        self.url = url

    def get_description(self):
        """Get the description of the merge proposal."""
        raise NotImplementedError(self.get_description)

    def set_description(self, description):
        """Set the description of the merge proposal."""
        raise NotImplementedError(self.set_description)

    def get_commit_message(self):
        """Get the proposed commit message."""
        raise NotImplementedError(self.get_commit_message)

    def set_commit_message(self, commit_message):
        """Set the propose commit message."""
        raise NotImplementedError(self.set_commit_message)

    def get_source_branch_url(self):
        """Return the source branch."""
        raise NotImplementedError(self.get_source_branch_url)

    def get_target_branch_url(self):
        """Return the target branch."""
        raise NotImplementedError(self.get_target_branch_url)

    def get_source_project(self):
        raise NotImplementedError(self.get_source_project)

    def get_target_project(self):
        raise NotImplementedError(self.get_target_project)

    def close(self):
        """Close the merge proposal (without merging it)."""
        raise NotImplementedError(self.close)

    def is_merged(self):
        """Check whether this merge proposal has been merged."""
        raise NotImplementedError(self.is_merged)

    def is_closed(self):
        """Check whether this merge proposal is closed

        This can either mean that it is merged or rejected.
        """
        raise NotImplementedError(self.is_closed)

    def merge(self, commit_message=None):
        """Merge this merge proposal."""
        raise NotImplementedError(self.merge)

    def can_be_merged(self):
        """Can this merge proposal be merged?

        The answer to this can be no if e.g. it has conflics.
        """
        raise NotImplementedError(self.can_be_merged)

    def get_merged_by(self):
        """If this proposal was merged, who merged it.
        """
        raise NotImplementedError(self.get_merged_by)

    def get_merged_at(self):
        """If this proposal was merged, when it was merged.
        """
        raise NotImplementedError(self.get_merged_at)


class MergeProposalBuilder(object):
    """Merge proposal creator.

    :param source_branch: Branch to propose for merging
    :param target_branch: Target branch
    """

    hooks = ProposeMergeHooks()

    def __init__(self, source_branch, target_branch):
        self.source_branch = source_branch
        self.target_branch = target_branch

    def get_initial_body(self):
        """Get a body for the proposal for the user to modify.

        :return: a str or None.
        """
        raise NotImplementedError(self.get_initial_body)

    def get_infotext(self):
        """Determine the initial comment for the merge proposal.
        """
        raise NotImplementedError(self.get_infotext)

    def create_proposal(self, description, reviewers=None, labels=None,
                        prerequisite_branch=None, commit_message=None):
        """Create a proposal to merge a branch for merging.

        :param description: Description for the merge proposal
        :param reviewers: Optional list of people to ask reviews from
        :param labels: Labels to attach to the proposal
        :param prerequisite_branch: Optional prerequisite branch
        :param commit_message: Optional commit message
        :return: A `MergeProposal` object
        """
        raise NotImplementedError(self.create_proposal)


class Hoster(object):
    """A hosting site manager.
    """

    # Does this hoster support arbitrary labels being attached to merge
    # proposals?
    supports_merge_proposal_labels = None

    # Does this hoster support suggesting a commit message in the
    # merge proposal?
    supports_merge_proposal_commit_message = None

    # The base_url that would be visible to users. I.e. https://github.com/
    # rather than https://api.github.com/
    base_url = None

    # The syntax to use for formatting merge proposal descriptions.
    # Common values: 'plain', 'markdown'
    merge_proposal_description_format = None

    def publish_derived(self, new_branch, base_branch, name, project=None,
                        owner=None, revision_id=None, overwrite=False,
                        allow_lossy=True):
        """Publish a branch to the site, derived from base_branch.

        :param base_branch: branch to derive the new branch from
        :param new_branch: branch to publish
        :return: resulting branch, public URL
        :raise HosterLoginRequired: Action requires a hoster login, but none is
            known.
        """
        raise NotImplementedError(self.publish)

    def get_derived_branch(self, base_branch, name, project=None, owner=None):
        """Get a derived branch ('a fork').
        """
        raise NotImplementedError(self.get_derived_branch)

    def get_push_url(self, branch):
        """Get the push URL for a branch."""
        raise NotImplementedError(self.get_push_url)

    def get_proposer(self, source_branch, target_branch):
        """Get a merge proposal creator.

        :note: source_branch does not have to be hosted by the hoster.

        :param source_branch: Source branch
        :param target_branch: Target branch
        :return: A MergeProposalBuilder object
        """
        raise NotImplementedError(self.get_proposer)

    def iter_proposals(self, source_branch, target_branch, status='open'):
        """Get the merge proposals for a specified branch tuple.

        :param source_branch: Source branch
        :param target_branch: Target branch
        :param status: Status of proposals to iterate over
        :return: Iterate over MergeProposal object
        """
        raise NotImplementedError(self.iter_proposals)

    def get_proposal_by_url(self, url):
        """Retrieve a branch proposal by URL.

        :param url: Merge proposal URL.
        :return: MergeProposal object
        :raise UnsupportedHoster: Hoster does not support this URL
        """
        raise NotImplementedError(self.get_proposal_by_url)

    def hosts(self, branch):
        """Return true if this hoster hosts given branch."""
        raise NotImplementedError(self.hosts)

    @classmethod
    def probe_from_branch(cls, branch):
        """Create a Hoster object if this hoster knows about a branch."""
        url = urlutils.strip_segment_parameters(branch.user_url)
        return cls.probe_from_url(
            url, possible_transports=[branch.control_transport])

    @classmethod
    def probe_from_url(cls, url, possible_hosters=None):
        """Create a Hoster object if this hoster knows about a URL."""
        raise NotImplementedError(cls.probe_from_url)

    def iter_my_proposals(self, status='open'):
        """Iterate over the proposals created by the currently logged in user.

        :param status: Only yield proposals with this status
            (one of: 'open', 'closed', 'merged', 'all')
        :return: Iterator over MergeProposal objects
        :raise HosterLoginRequired: Action requires a hoster login, but none is
            known.
        """
        raise NotImplementedError(self.iter_my_proposals)

    def iter_my_forks(self):
        """Iterate over the currently logged in users' forks.

        :return: Iterator over project_name
        """
        raise NotImplementedError(self.iter_my_forks)

    def delete_project(self, name):
        """Delete a project.
        """
        raise NotImplementedError(self.delete_project)

    @classmethod
    def iter_instances(cls):
        """Iterate instances.

        :return: Hoster instances
        """
        raise NotImplementedError(cls.iter_instances)


def determine_title(description):
    """Determine the title for a merge proposal based on full description."""
    return description.splitlines()[0].split('.')[0]


def get_hoster(branch, possible_hosters=None):
    """Find the hoster for a branch.

    :param branch: Branch to find hoster for
    :param possible_hosters: Optional list of hosters to reuse
    :raise UnsupportedHoster: if there is no hoster that supports `branch`
    :return: A `Hoster` object
    """
    if possible_hosters:
        for hoster in possible_hosters:
            if hoster.hosts(branch):
                return hoster
    for name, hoster_cls in hosters.items():
        try:
            hoster = hoster_cls.probe_from_branch(branch)
        except UnsupportedHoster:
            pass
        else:
            if possible_hosters is not None:
                possible_hosters.append(hoster)
            return hoster
    raise UnsupportedHoster(branch)


def get_proposal_by_url(url):
    """Get the proposal object associated with a URL.

    :param url: URL of the proposal
    :raise UnsupportedHoster: if there is no hoster that supports the URL
    :return: A `MergeProposal` object
    """
    for name, hoster_cls in hosters.items():
        for instance in hoster_cls.iter_instances():
            try:
                return instance.get_proposal_by_url(url)
            except UnsupportedHoster:
                pass
    raise UnsupportedHoster(url)


hosters = registry.Registry()

7408.3.1 by Jelmer Vernooĳ Move propose module into core.	1	# Copyright (C) 2018-2019 Breezy Developers
0.431.1 by Jelmer Vernooĳ Start work on propose command.	2	#
	3	# This program is free software; you can redistribute it and/or modify
	4	# it under the terms of the GNU General Public License as published by
	5	# the Free Software Foundation; either version 2 of the License, or
	6	# (at your option) any later version.
	7	#
	8	# This program is distributed in the hope that it will be useful,
	9	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	# GNU General Public License for more details.
	12	#
	13	# You should have received a copy of the GNU General Public License
	14	# along with this program; if not, write to the Free Software
	15	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16
	17	"""Helper functions for proposing merges."""
	18
	19	from __future__ import absolute_import
	20
7408.3.1 by Jelmer Vernooĳ Move propose module into core.	21	from . import (
0.431.1 by Jelmer Vernooĳ Start work on propose command.	22	errors,
	23	hooks,
	24	registry,
7268.12.3 by Jelmer Vernooĳ Add missing import.	25	urlutils,
0.431.1 by Jelmer Vernooĳ Start work on propose command.	26	)
	27
	28
0.431.38 by Jelmer Vernooĳ Add NoSuchProject.	29	class NoSuchProject(errors.BzrError):
	30
	31	_fmt = "Project does not exist: %(project)s."
	32
	33	def __init__(self, project):
	34	errors.BzrError.__init__(self)
	35	self.project = project
	36
	37
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	38	class MergeProposalExists(errors.BzrError):
	39
	40	_fmt = "A merge proposal already exists: %(url)s."
	41
	42	def __init__(self, url):
	43	errors.BzrError.__init__(self)
	44	self.url = url
	45
	46
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	47	class UnsupportedHoster(errors.BzrError):
	48
	49	_fmt = "No supported hoster for %(branch)s."
	50
	51	def __init__(self, branch):
	52	errors.BzrError.__init__(self)
	53	self.branch = branch
	54
	55
7381.5.1 by Jelmer Vernooĳ Several more fixes for merge proposals. Add functions for reopening merge proposals.	56	class ReopenFailed(errors.BzrError):
	57
	58	_fmt = "Reopening the merge proposal failed: %(error)s."
	59
	60
0.431.1 by Jelmer Vernooĳ Start work on propose command.	61	class ProposeMergeHooks(hooks.Hooks):
	62	"""Hooks for proposing a merge on Launchpad."""
	63
	64	def __init__(self):
	65	hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
0.431.57 by Jelmer Vernooĳ Cleanups.	66	self.add_hook(
0.431.57 by Jelmer Vernooĳ Cleanups.	67	'get_prerequisite',
0.431.1 by Jelmer Vernooĳ Start work on propose command.	68	"Return the prerequisite branch for proposing as merge.", (3, 0))
0.431.57 by Jelmer Vernooĳ Cleanups.	69	self.add_hook(
0.431.57 by Jelmer Vernooĳ Cleanups.	70	'merge_proposal_body',
0.431.1 by Jelmer Vernooĳ Start work on propose command.	71	"Return an initial body for the merge proposal message.", (3, 0))
	72
	73
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	74	class LabelsUnsupported(errors.BzrError):
	75	"""Labels not supported by this hoster."""
	76
	77	_fmt = "Labels are not supported by %(hoster)r."
	78
	79	def __init__(self, hoster):
	80	errors.BzrError.__init__(self)
	81	self.hoster = hoster
	82
	83
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	84	class PrerequisiteBranchUnsupported(errors.BzrError):
	85	"""Prerequisite branch not supported by this hoster."""
	86
	87	def __init__(self, hoster):
	88	errors.BzrError.__init__(self)
	89	self.hoster = hoster
	90
	91
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	92	class HosterLoginRequired(errors.BzrError):
	93	"""Action requires hoster login credentials."""
	94
7268.8.2 by Jelmer Vernooĳ Handle GitHub errors.	95	_fmt = "Action requires credentials for hosting site %(hoster)r."""
7268.8.2 by Jelmer Vernooĳ Handle GitHub errors.	96
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	97	def __init__(self, hoster):
	98	errors.BzrError.__init__(self)
	99	self.hoster = hoster
	100
	101
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	102	class MergeProposal(object):
	103	"""A merge proposal.
	104
	105	:ivar url: URL for the merge proposal
	106	"""
	107
	108	def __init__(self, url=None):
	109	self.url = url
	110
0.431.39 by Jelmer Vernooĳ Extend the merge proposal abstraction a bit.	111	def get_description(self):
	112	"""Get the description of the merge proposal."""
	113	raise NotImplementedError(self.get_description)
	114
	115	def set_description(self, description):
	116	"""Set the description of the merge proposal."""
	117	raise NotImplementedError(self.set_description)
	118
7296.8.2 by Jelmer Vernooĳ Add feature flag for commit message.	119	def get_commit_message(self):
	120	"""Get the proposed commit message."""
	121	raise NotImplementedError(self.get_commit_message)
	122
	123	def set_commit_message(self, commit_message):
	124	"""Set the propose commit message."""
	125	raise NotImplementedError(self.set_commit_message)
	126
0.431.64 by Jelmer Vernooĳ Add get_source_branch_url/get_target_branch_url methods.	127	def get_source_branch_url(self):
	128	"""Return the source branch."""
	129	raise NotImplementedError(self.get_source_branch_url)
	130
	131	def get_target_branch_url(self):
	132	"""Return the target branch."""
	133	raise NotImplementedError(self.get_target_branch_url)
	134
7414.5.1 by Jelmer Vernooĳ Add functions for managing projects.	135	def get_source_project(self):
	136	raise NotImplementedError(self.get_source_project)
	137
	138	def get_target_project(self):
	139	raise NotImplementedError(self.get_target_project)
	140
0.431.39 by Jelmer Vernooĳ Extend the merge proposal abstraction a bit.	141	def close(self):
	142	"""Close the merge proposal (without merging it)."""
	143	raise NotImplementedError(self.close)
	144
0.431.46 by Jelmer Vernooĳ Add MergeProposal.is_merged.	145	def is_merged(self):
	146	"""Check whether this merge proposal has been merged."""
	147	raise NotImplementedError(self.is_merged)
	148
7381.5.1 by Jelmer Vernooĳ Several more fixes for merge proposals. Add functions for reopening merge proposals.	149	def is_closed(self):
	150	"""Check whether this merge proposal is closed
	151
	152	This can either mean that it is merged or rejected.
	153	"""
	154	raise NotImplementedError(self.is_closed)
	155
7296.9.1 by Jelmer Vernooĳ Add 'brz land' subcommand.	156	def merge(self, commit_message=None):
	157	"""Merge this merge proposal."""
	158	raise NotImplementedError(self.merge)
	159
7380.1.1 by Jelmer Vernooĳ Several more fixes for git merge proposals.	160	def can_be_merged(self):
	161	"""Can this merge proposal be merged?
	162
	163	The answer to this can be no if e.g. it has conflics.
	164	"""
	165	raise NotImplementedError(self.can_be_merged)
	166
7414.4.1 by Jelmer Vernooĳ Add a MergeProposal.get_merged_by method.	167	def get_merged_by(self):
	168	"""If this proposal was merged, who merged it.
	169	"""
	170	raise NotImplementedError(self.get_merged_by)
	171
7414.4.3 by Jelmer Vernooĳ Add MergeProposal.get_merged_at.	172	def get_merged_at(self):
	173	"""If this proposal was merged, when it was merged.
	174	"""
	175	raise NotImplementedError(self.get_merged_at)
	176
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	177
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	178	class MergeProposalBuilder(object):
0.431.1 by Jelmer Vernooĳ Start work on propose command.	179	"""Merge proposal creator.
	180
	181	:param source_branch: Branch to propose for merging
	182	:param target_branch: Target branch
	183	"""
	184
	185	hooks = ProposeMergeHooks()
	186
	187	def __init__(self, source_branch, target_branch):
	188	self.source_branch = source_branch
	189	self.target_branch = target_branch
	190
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	191	def get_initial_body(self):
	192	"""Get a body for the proposal for the user to modify.
	193
	194	:return: a str or None.
	195	"""
	196	raise NotImplementedError(self.get_initial_body)
	197
	198	def get_infotext(self):
	199	"""Determine the initial comment for the merge proposal.
	200	"""
	201	raise NotImplementedError(self.get_infotext)
	202
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	203	def create_proposal(self, description, reviewers=None, labels=None,
7296.8.1 by Jelmer Vernooĳ Add commit-message option to 'brz propose'.	204	prerequisite_branch=None, commit_message=None):
0.431.1 by Jelmer Vernooĳ Start work on propose command.	205	"""Create a proposal to merge a branch for merging.
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	206
0.431.2 by Jelmer Vernooĳ Add launchpad implementation.	207	:param description: Description for the merge proposal
0.431.5 by Jelmer Vernooĳ Initial work on gitlab support.	208	:param reviewers: Optional list of people to ask reviews from
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	209	:param labels: Labels to attach to the proposal
0.431.56 by Jelmer Vernooĳ Add support for prerequisite branches.	210	:param prerequisite_branch: Optional prerequisite branch
7296.8.1 by Jelmer Vernooĳ Add commit-message option to 'brz propose'.	211	:param commit_message: Optional commit message
0.431.3 by Jelmer Vernooĳ Add a MergeProposal object.	212	:return: A `MergeProposal` object
0.431.1 by Jelmer Vernooĳ Start work on propose command.	213	"""
	214	raise NotImplementedError(self.create_proposal)
	215
	216
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	217	class Hoster(object):
	218	"""A hosting site manager.
	219	"""
	220
7260.1.1 by Jelmer Vernooĳ Add .base_url property to Hoster.	221	# Does this hoster support arbitrary labels being attached to merge
	222	# proposals?
0.431.13 by Jelmer Vernooĳ Add support for labels on merge proposals.	223	supports_merge_proposal_labels = None
	224
7296.8.2 by Jelmer Vernooĳ Add feature flag for commit message.	225	# Does this hoster support suggesting a commit message in the
	226	# merge proposal?
	227	supports_merge_proposal_commit_message = None
	228
7260.1.1 by Jelmer Vernooĳ Add .base_url property to Hoster.	229	# The base_url that would be visible to users. I.e. https://github.com/
	230	# rather than https://api.github.com/
	231	base_url = None
	232
7445.1.1 by Jelmer Vernooĳ Add Hoster.merge_proposal_description_format and common function for determining title.	233	# The syntax to use for formatting merge proposal descriptions.
	234	# Common values: 'plain', 'markdown'
	235	merge_proposal_description_format = None
	236
0.431.20 by Jelmer Vernooĳ publish -> publish_derived.	237	def publish_derived(self, new_branch, base_branch, name, project=None,
0.431.51 by Jelmer Vernooĳ Allow fallback to lossy by default.	238	owner=None, revision_id=None, overwrite=False,
	239	allow_lossy=True):
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	240	"""Publish a branch to the site, derived from base_branch.
	241
	242	:param base_branch: branch to derive the new branch from
	243	:param new_branch: branch to publish
0.432.3 by Jelmer Vernooĳ Publish command works for github.	244	:return: resulting branch, public URL
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	245	:raise HosterLoginRequired: Action requires a hoster login, but none is
	246	known.
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	247	"""
	248	raise NotImplementedError(self.publish)
	249
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	250	def get_derived_branch(self, base_branch, name, project=None, owner=None):
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	251	"""Get a derived branch ('a fork').
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	252	"""
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	253	raise NotImplementedError(self.get_derived_branch)
0.431.22 by Jelmer Vernooĳ Add Hoster.get_derived_branch.	254
0.431.28 by Jelmer Vernooĳ Implement Hoster.get_push_url.	255	def get_push_url(self, branch):
	256	"""Get the push URL for a branch."""
	257	raise NotImplementedError(self.get_push_url)
	258
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	259	def get_proposer(self, source_branch, target_branch):
	260	"""Get a merge proposal creator.
	261
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	262	:note: source_branch does not have to be hosted by the hoster.
0.431.31 by Jelmer Vernooĳ Drop autopropose command.	263
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	264	:param source_branch: Source branch
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	265	:param target_branch: Target branch
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	266	:return: A MergeProposalBuilder object
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	267	"""
	268	raise NotImplementedError(self.get_proposer)
	269
0.431.68 by Jelmer Vernooĳ Add status to other Hosters.	270	def iter_proposals(self, source_branch, target_branch, status='open'):
7296.9.1 by Jelmer Vernooĳ Add 'brz land' subcommand.	271	"""Get the merge proposals for a specified branch tuple.
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	272
	273	:param source_branch: Source branch
	274	:param target_branch: Target branch
0.431.68 by Jelmer Vernooĳ Add status to other Hosters.	275	:param status: Status of proposals to iterate over
0.431.67 by Jelmer Vernooĳ Support multiple merge proposals per branch.	276	:return: Iterate over MergeProposal object
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	277	"""
0.431.67 by Jelmer Vernooĳ Support multiple merge proposals per branch.	278	raise NotImplementedError(self.iter_proposals)
0.431.35 by Jelmer Vernooĳ Add Hoster.get_proposal.	279
7296.9.1 by Jelmer Vernooĳ Add 'brz land' subcommand.	280	def get_proposal_by_url(self, url):
	281	"""Retrieve a branch proposal by URL.
	282
	283	:param url: Merge proposal URL.
	284	:return: MergeProposal object
	285	:raise UnsupportedHoster: Hoster does not support this URL
	286	"""
	287	raise NotImplementedError(self.get_proposal_by_url)
	288
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	289	def hosts(self, branch):
	290	"""Return true if this hoster hosts given branch."""
	291	raise NotImplementedError(self.hosts)
	292
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	293	@classmethod
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	294	def probe_from_branch(cls, branch):
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	295	"""Create a Hoster object if this hoster knows about a branch."""
7441.1.1 by Jelmer Vernooĳ Add strip_segment_parameters function.	296	url = urlutils.strip_segment_parameters(branch.user_url)
7296.10.1 by Jelmer Vernooĳ Initial work making gitlab just directly use ReST.	297	return cls.probe_from_url(
7296.10.2 by Jelmer Vernooĳ More fixes.	298	url, possible_transports=[branch.control_transport])
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	299
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	300	@classmethod
7296.10.1 by Jelmer Vernooĳ Initial work making gitlab just directly use ReST.	301	def probe_from_url(cls, url, possible_hosters=None):
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	302	"""Create a Hoster object if this hoster knows about a URL."""
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	303	raise NotImplementedError(cls.probe_from_url)
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	304
0.431.66 by Jelmer Vernooĳ Add support for status argument.	305	def iter_my_proposals(self, status='open'):
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	306	"""Iterate over the proposals created by the currently logged in user.
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	307
0.431.66 by Jelmer Vernooĳ Add support for status argument.	308	:param status: Only yield proposals with this status
0.431.66 by Jelmer Vernooĳ Add support for status argument.	309	(one of: 'open', 'closed', 'merged', 'all')
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	310	:return: Iterator over MergeProposal objects
7268.8.1 by Jelmer Vernooĳ Add HosterLoginRequired exception.	311	:raise HosterLoginRequired: Action requires a hoster login, but none is
	312	known.
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	313	"""
	314	raise NotImplementedError(self.iter_my_proposals)
	315
7414.5.2 by Jelmer Vernooĳ Change iter_my_projects to iter_my_forks.	316	def iter_my_forks(self):
	317	"""Iterate over the currently logged in users' forks.
7414.5.1 by Jelmer Vernooĳ Add functions for managing projects.	318
7414.5.2 by Jelmer Vernooĳ Change iter_my_projects to iter_my_forks.	319	:return: Iterator over project_name
7414.5.1 by Jelmer Vernooĳ Add functions for managing projects.	320	"""
7414.5.2 by Jelmer Vernooĳ Change iter_my_projects to iter_my_forks.	321	raise NotImplementedError(self.iter_my_forks)
7414.5.1 by Jelmer Vernooĳ Add functions for managing projects.	322
	323	def delete_project(self, name):
	324	"""Delete a project.
	325	"""
	326	raise NotImplementedError(self.delete_project)
	327
0.431.63 by Jelmer Vernooĳ Add 'brz my-proposals' command.	328	@classmethod
	329	def iter_instances(cls):
	330	"""Iterate instances.
	331
	332	:return: Hoster instances
	333	"""
	334	raise NotImplementedError(cls.iter_instances)
	335
0.432.1 by Jelmer Vernooĳ Initial work on hoster support.	336
7445.1.1 by Jelmer Vernooĳ Add Hoster.merge_proposal_description_format and common function for determining title.	337	def determine_title(description):
	338	"""Determine the title for a merge proposal based on full description."""
	339	return description.splitlines()[0].split('.')[0]
	340
	341
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	342	def get_hoster(branch, possible_hosters=None):
7408.3.2 by Jelmer Vernooĳ Add some tests.	343	"""Find the hoster for a branch.
	344
	345	:param branch: Branch to find hoster for
	346	:param possible_hosters: Optional list of hosters to reuse
	347	:raise UnsupportedHoster: if there is no hoster that supports `branch`
	348	:return: A `Hoster` object
	349	"""
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	350	if possible_hosters:
	351	for hoster in possible_hosters:
	352	if hoster.hosts(branch):
	353	return hoster
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	354	for name, hoster_cls in hosters.items():
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	355	try:
7268.12.1 by Jelmer Vernooĳ Split out probe_from_url.	356	hoster = hoster_cls.probe_from_branch(branch)
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	357	except UnsupportedHoster:
0.432.9 by Jelmer Vernooĳ Drop is_compatible nonesense.	358	pass
0.433.1 by Jelmer Vernooĳ Add Hoster.hosts.	359	else:
	360	if possible_hosters is not None:
	361	possible_hosters.append(hoster)
	362	return hoster
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	363	raise UnsupportedHoster(branch)
	364
	365
7296.9.1 by Jelmer Vernooĳ Add 'brz land' subcommand.	366	def get_proposal_by_url(url):
7408.3.2 by Jelmer Vernooĳ Add some tests.	367	"""Get the proposal object associated with a URL.
	368
	369	:param url: URL of the proposal
	370	:raise UnsupportedHoster: if there is no hoster that supports the URL
	371	:return: A `MergeProposal` object
	372	"""
7296.9.1 by Jelmer Vernooĳ Add 'brz land' subcommand.	373	for name, hoster_cls in hosters.items():
	374	for instance in hoster_cls.iter_instances():
	375	try:
	376	return instance.get_proposal_by_url(url)
	377	except UnsupportedHoster:
	378	pass
	379	raise UnsupportedHoster(url)
	380
	381
0.432.2 by Jelmer Vernooĳ Publish command sort of works.	382	hosters = registry.Registry()