rosdistro_reviewer.submitter package

Submodules

rosdistro_reviewer.submitter.github module

class rosdistro_reviewer.submitter.github.GitHubSubmitter

Bases: ReviewSubmitterExtensionPoint

Submit reviews to GitHub pull requests.

add_arguments(*, parser) → None

Add command line arguments specific to the review submission.

The method is intended to be overridden in a subclass.

Parameters:

parser – The argument parser

submit(args, review) → None

Submit a code review.

The method is intended to be overridden in a subclass.

Parameters:

  • args – The parsed command line arguments

  • review – The code review to submit

Module contents

class rosdistro_reviewer.submitter.ReviewSubmitterExtensionPoint

Bases: object

The interface for submitting code reviews.

EXTENSION_POINT_VERSION = '1.0'
add_arguments(*, parser) → None

Add command line arguments specific to the review submission.

The method is intended to be overridden in a subclass.

Parameters:

parser – The argument parser

submit(args, review) → None

Submit a code review.

The method is intended to be overridden in a subclass.

Parameters:

  • args – The parsed command line arguments

  • review – The code review to submit

rosdistro_reviewer.submitter.add_review_submitter_arguments(parser, *, extensions=None) → None

Add the command line arguments for the review submitter extensions.

Parameters:

  • parser – The argument parser

  • extensions – The review submitter extensions to use, if None is passed use the extensions provided by get_review_submitter_extensions()

rosdistro_reviewer.submitter.get_review_submitter_extensions(*, group_name: str | None = None) → Dict[str, ReviewSubmitterExtensionPoint]

Get the available review submitter extensions.

Parameters:

group_name – Optional extension point group name override

Return type:

Dict

rosdistro_reviewer.submitter.submit_review(args, review, *, extensions=None) → None

Submit a code review to all enabled submitter extensions.

Parameters:

  • args – The parsed command line arguments

  • review – The code review to submit

  • extensions – The review submitter extensions to use, if None is passed use the extensions provided by get_review_submitter_extensions()