gerrit package

Subpackages

• gerrit.accounts package
  • Submodules
  • gerrit.accounts.account module
    • GerritAccount
      • GerritAccount.check_capability()
      • GerritAccount.delete_active()
      • GerritAccount.delete_draft_comments()
      • GerritAccount.delete_external_ids()
      • GerritAccount.delete_http_password()
      • GerritAccount.delete_name()
      • GerritAccount.delete_watched_projects()
      • GerritAccount.emails
      • GerritAccount.get_active()
      • GerritAccount.get_avatar()
      • GerritAccount.get_avatar_change_url()
      • GerritAccount.get_default_starred_changes()
      • GerritAccount.get_detail()
      • GerritAccount.get_diff_preferences()
      • GerritAccount.get_displayname()
      • GerritAccount.get_edit_preferences()
      • GerritAccount.get_external_ids()
      • GerritAccount.get_name()
      • GerritAccount.get_oauth_token()
      • GerritAccount.get_star_labels_from_change()
      • GerritAccount.get_starred_changes()
      • GerritAccount.get_status()
      • GerritAccount.get_user_preferences()
      • GerritAccount.get_username()
      • GerritAccount.get_watched_projects()
      • GerritAccount.gpg_keys
      • GerritAccount.groups
      • GerritAccount.index()
      • GerritAccount.list_capabilities()
      • GerritAccount.list_contributor_agreements()
      • GerritAccount.modify_watched_projects()
      • GerritAccount.put_default_star_on_change()
      • GerritAccount.remove_default_star_from_change()
      • GerritAccount.set_active()
      • GerritAccount.set_diff_preferences()
      • GerritAccount.set_displayname()
      • GerritAccount.set_edit_preferences()
      • GerritAccount.set_http_password()
      • GerritAccount.set_name()
      • GerritAccount.set_status()
      • GerritAccount.set_user_preferences()
      • GerritAccount.set_username()
      • GerritAccount.sign_contributor_agreement()
      • GerritAccount.ssh_keys
      • GerritAccount.update_star_labels_on_change()
  • gerrit.accounts.accounts module
    • GerritAccounts
      • GerritAccounts.create()
      • GerritAccounts.get()
      • GerritAccounts.search()
  • gerrit.accounts.emails module
    • GerritAccountEmail
      • GerritAccountEmail.delete()
      • GerritAccountEmail.set_preferred()
    • GerritAccountEmails
      • GerritAccountEmails.create()
      • GerritAccountEmails.delete()
      • GerritAccountEmails.get()
      • GerritAccountEmails.list()
      • GerritAccountEmails.set_preferred()
  • gerrit.accounts.gpg_keys module
    • GerritAccountGPGKey
      • GerritAccountGPGKey.delete()
    • GerritAccountGPGKeys
      • GerritAccountGPGKeys.delete()
      • GerritAccountGPGKeys.get()
      • GerritAccountGPGKeys.list()
      • GerritAccountGPGKeys.modify()
  • gerrit.accounts.ssh_keys module
    • GerritAccountSSHKey
      • GerritAccountSSHKey.delete()
    • GerritAccountSSHKeys
      • GerritAccountSSHKeys.add()
      • GerritAccountSSHKeys.delete()
      • GerritAccountSSHKeys.get()
      • GerritAccountSSHKeys.list()
  • Module contents
• gerrit.changes package
  • Submodules
  • gerrit.changes.change module
    • GerritChange
      • GerritChange.abandon()
      • GerritChange.add_message()
      • GerritChange.add_to_attention_set()
      • GerritChange.check_submit_requirement()
      • GerritChange.consistency_check()
      • GerritChange.create_empty_edit()
      • GerritChange.create_merge_patch_set()
      • GerritChange.delete()
      • GerritChange.delete_assignee()
      • GerritChange.delete_topic()
      • GerritChange.delete_vote()
      • GerritChange.fix()
      • GerritChange.get_assignee()
      • GerritChange.get_attention_set()
      • GerritChange.get_detail()
      • GerritChange.get_edit()
      • GerritChange.get_hashtags()
      • GerritChange.get_include_in()
      • GerritChange.get_meta_diff()
      • GerritChange.get_past_assignees()
      • GerritChange.get_pure_revert()
      • GerritChange.get_revision()
      • GerritChange.get_topic()
      • GerritChange.ignore()
      • GerritChange.index()
      • GerritChange.list_actions()
      • GerritChange.list_comments()
      • GerritChange.list_drafts()
      • GerritChange.list_robot_comments()
      • GerritChange.list_submitted_together_changes()
      • GerritChange.list_votes()
      • GerritChange.mark_as_reviewed()
      • GerritChange.mark_as_unreviewed()
      • GerritChange.mark_private()
      • GerritChange.messages
      • GerritChange.move()
      • GerritChange.rebase()
      • GerritChange.remove_from_attention_set()
      • GerritChange.restore()
      • GerritChange.revert()
      • GerritChange.revert_submission()
      • GerritChange.reviewers
      • GerritChange.set_assignee()
      • GerritChange.set_commit_message()
      • GerritChange.set_hashtags()
      • GerritChange.set_ready_for_review()
      • GerritChange.set_topic()
      • GerritChange.set_work_in_progress()
      • GerritChange.submit()
      • GerritChange.unignore()
      • GerritChange.unmark_private()
  • gerrit.changes.changes module
    • GerritChanges
      • GerritChanges.create()
      • GerritChanges.delete()
      • GerritChanges.get()
      • GerritChanges.search()
  • gerrit.changes.comments module
    • GerritChangeRevisionComment
      • GerritChangeRevisionComment.delete()
    • GerritChangeRevisionComments
      • GerritChangeRevisionComments.get()
      • GerritChangeRevisionComments.list()
  • gerrit.changes.drafts module
    • GerritChangeRevisionDraft
      • GerritChangeRevisionDraft.delete()
      • GerritChangeRevisionDraft.update()
    • GerritChangeRevisionDrafts
      • GerritChangeRevisionDrafts.create()
      • GerritChangeRevisionDrafts.delete()
      • GerritChangeRevisionDrafts.get()
      • GerritChangeRevisionDrafts.list()
  • gerrit.changes.edit module
    • GerritChangeEdit
      • GerritChangeEdit.change_commit_message()
      • GerritChangeEdit.delete()
      • GerritChangeEdit.delete_file()
      • GerritChangeEdit.get_change_file_content()
      • GerritChangeEdit.get_commit_message()
      • GerritChangeEdit.get_file_meta_data()
      • GerritChangeEdit.publish()
      • GerritChangeEdit.put_change_file_content()
      • GerritChangeEdit.rebase()
      • GerritChangeEdit.rename_file()
      • GerritChangeEdit.restore_file_content()
  • gerrit.changes.files module
    • GerritChangeRevisionFile
      • GerritChangeRevisionFile.delete_reviewed()
      • GerritChangeRevisionFile.download_content()
      • GerritChangeRevisionFile.get_blame()
      • GerritChangeRevisionFile.get_content()
      • GerritChangeRevisionFile.get_diff()
      • GerritChangeRevisionFile.set_reviewed()
      • GerritChangeRevisionFile.to_dict()
    • GerritChangeRevisionFiles
      • GerritChangeRevisionFiles.get()
      • GerritChangeRevisionFiles.iterkeys()
      • GerritChangeRevisionFiles.keys()
      • GerritChangeRevisionFiles.poll()
      • GerritChangeRevisionFiles.search()
  • gerrit.changes.messages module
    • GerritChangeMessage
      • GerritChangeMessage.delete()
    • GerritChangeMessages
      • GerritChangeMessages.get()
      • GerritChangeMessages.list()
  • gerrit.changes.reviewers module
    • GerritChangeReviewer
      • GerritChangeReviewer.delete()
      • GerritChangeReviewer.delete_vote()
      • GerritChangeReviewer.list_votes()
    • GerritChangeReviewers
      • GerritChangeReviewers.add()
      • GerritChangeReviewers.get()
      • GerritChangeReviewers.list()
  • gerrit.changes.revision module
    • GerritChangeRevision
      • GerritChangeRevision.cherry_pick()
      • GerritChangeRevision.comments
      • GerritChangeRevision.delete_vote()
      • GerritChangeRevision.drafts
      • GerritChangeRevision.files
      • GerritChangeRevision.get_commit()
      • GerritChangeRevision.get_description()
      • GerritChangeRevision.get_merge_list()
      • GerritChangeRevision.get_patch()
      • GerritChangeRevision.get_related_changes()
      • GerritChangeRevision.get_review()
      • GerritChangeRevision.get_revision_actions()
      • GerritChangeRevision.get_robot_comment()
      • GerritChangeRevision.get_submit_type()
      • GerritChangeRevision.is_mergeable()
      • GerritChangeRevision.list_reviewers()
      • GerritChangeRevision.list_robot_comments()
      • GerritChangeRevision.list_votes()
      • GerritChangeRevision.rebase()
      • GerritChangeRevision.set_description()
      • GerritChangeRevision.set_review()
      • GerritChangeRevision.submit()
      • GerritChangeRevision.submit_preview()
      • GerritChangeRevision.test_submit_rule()
      • GerritChangeRevision.test_submit_type()
  • Module contents
• gerrit.config package
  • Submodules
  • gerrit.config.caches module
    • Cache
      • Cache.flush()
    • Caches
      • Caches.flush()
      • Caches.get()
      • Caches.list()
      • Caches.operation()
  • gerrit.config.config module
    • GerritConfig
      • GerritConfig.caches
      • GerritConfig.check_consistency()
      • GerritConfig.confirm_email()
      • GerritConfig.get_default_diff_preferences()
      • GerritConfig.get_default_edit_preferences()
      • GerritConfig.get_default_user_preferences()
      • GerritConfig.get_server_info()
      • GerritConfig.get_summary()
      • GerritConfig.get_top_menus()
      • GerritConfig.get_version()
      • GerritConfig.index_changes()
      • GerritConfig.list_capabilities()
      • GerritConfig.reload_config()
      • GerritConfig.set_default_diff_preferences()
      • GerritConfig.set_default_edit_preferences()
      • GerritConfig.set_default_user_preferences()
      • GerritConfig.tasks
  • gerrit.config.tasks module
    • Task
      • Task.delete()
    • Tasks
      • Tasks.delete()
      • Tasks.get()
      • Tasks.list()
  • Module contents
• gerrit.groups package
  • Submodules
  • gerrit.groups.group module
    • GerritGroup
      • GerritGroup.delete_description()
      • GerritGroup.get_audit_log()
      • GerritGroup.get_description()
      • GerritGroup.get_detail()
      • GerritGroup.get_name()
      • GerritGroup.get_options()
      • GerritGroup.get_owner()
      • GerritGroup.index()
      • GerritGroup.members
      • GerritGroup.set_description()
      • GerritGroup.set_name()
      • GerritGroup.set_options()
      • GerritGroup.set_owner()
      • GerritGroup.subgroup
  • gerrit.groups.groups module
    • GerritGroups
      • GerritGroups.create()
      • GerritGroups.get()
      • GerritGroups.list()
      • GerritGroups.search()
  • gerrit.groups.members module
    • GerritGroupMembers
      • GerritGroupMembers.add()
      • GerritGroupMembers.add_members()
      • GerritGroupMembers.get()
      • GerritGroupMembers.list()
      • GerritGroupMembers.remove()
      • GerritGroupMembers.remove_members()
  • gerrit.groups.subgroups module
    • GerritGroupSubGroups
      • GerritGroupSubGroups.add()
      • GerritGroupSubGroups.add_subgroups()
      • GerritGroupSubGroups.get()
      • GerritGroupSubGroups.list()
      • GerritGroupSubGroups.remove()
      • GerritGroupSubGroups.remove_subgroups()
  • Module contents
• gerrit.plugins package
  • Submodules
  • gerrit.plugins.plugins module
    • GerritPlugin
      • GerritPlugin.disable()
      • GerritPlugin.enable()
      • GerritPlugin.reload()
    • GerritPlugins
      • GerritPlugins.get()
      • GerritPlugins.install()
      • GerritPlugins.list()
  • Module contents
• gerrit.projects package
  • Submodules
  • gerrit.projects.branches module
    • GerritProjectBranch
      • GerritProjectBranch.delete()
      • GerritProjectBranch.get_file_content()
      • GerritProjectBranch.get_reflog()
      • GerritProjectBranch.is_mergeable()
    • GerritProjectBranches
      • GerritProjectBranches.branch_prefix
      • GerritProjectBranches.create()
      • GerritProjectBranches.delete()
      • GerritProjectBranches.delete_branches()
      • GerritProjectBranches.get()
      • GerritProjectBranches.list()
  • gerrit.projects.commit module
    • GerritProjectCommit
      • GerritProjectCommit.cherry_pick()
      • GerritProjectCommit.get_file_content()
      • GerritProjectCommit.get_include_in()
      • GerritProjectCommit.list_change_files()
  • gerrit.projects.dashboards module
    • GerritProjectDashboard
      • GerritProjectDashboard.delete()
      • GerritProjectDashboard.set()
    • GerritProjectDashboards
      • GerritProjectDashboards.create()
      • GerritProjectDashboards.delete()
      • GerritProjectDashboards.get()
      • GerritProjectDashboards.list()
  • gerrit.projects.labels module
    • GerritProjectLabel
      • GerritProjectLabel.delete()
      • GerritProjectLabel.set()
    • GerritProjectLabels
      • GerritProjectLabels.create()
      • GerritProjectLabels.delete()
      • GerritProjectLabels.get()
      • GerritProjectLabels.list()
  • gerrit.projects.project module
    • GerritProject
      • GerritProject.ban_commits()
      • GerritProject.branches
      • GerritProject.check_access()
      • GerritProject.check_consistency()
      • GerritProject.child_projects
      • GerritProject.create_access_rights_change()
      • GerritProject.create_change()
      • GerritProject.dashboards
      • GerritProject.delete()
      • GerritProject.delete_description()
      • GerritProject.get_access_rights()
      • GerritProject.get_child_project()
      • GerritProject.get_commit()
      • GerritProject.get_config()
      • GerritProject.get_description()
      • GerritProject.get_head()
      • GerritProject.get_parent()
      • GerritProject.get_statistics()
      • GerritProject.index()
      • GerritProject.index_all_changes()
      • GerritProject.labels
      • GerritProject.run_garbage_collection()
      • GerritProject.set_access_rights()
      • GerritProject.set_config()
      • GerritProject.set_description()
      • GerritProject.set_head()
      • GerritProject.set_parent()
      • GerritProject.submit_requirements
      • GerritProject.tags
      • GerritProject.webhooks
  • gerrit.projects.projects module
    • GerritProjects
      • GerritProjects.create()
      • GerritProjects.delete()
      • GerritProjects.get()
      • GerritProjects.list()
      • GerritProjects.search()
  • gerrit.projects.tags module
    • GerritProjectTag
      • GerritProjectTag.delete()
    • GerritProjectTags
      • GerritProjectTags.create()
      • GerritProjectTags.delete()
      • GerritProjectTags.delete_tags()
      • GerritProjectTags.get()
      • GerritProjectTags.list()
      • GerritProjectTags.tag_prefix
  • gerrit.projects.webhooks module
    • GerritProjectWebHook
      • GerritProjectWebHook.delete()
    • GerritProjectWebHooks
      • GerritProjectWebHooks.create()
      • GerritProjectWebHooks.delete()
      • GerritProjectWebHooks.get()
      • GerritProjectWebHooks.list()
  • Module contents
• gerrit.utils package
  • Submodules
  • gerrit.utils.common module
    • decode_response()
    • params_creator()
    • strip_trailing_slash()
  • gerrit.utils.exceptions module
    • AccountAlreadyExistsError
    • AccountEmailAlreadyExistsError
    • AccountEmailNotFoundError
    • AccountNotFoundError
    • AuthError
    • BranchAlreadyExistsError
    • BranchNotFoundError
    • ChangeEditNotFoundError
    • ChangeNotFoundError
    • ClientError
    • CommitNotFoundError
    • ConflictError
    • FileContentNotFoundError
    • GPGKeyNotFoundError
    • GerritAPIException
    • GroupAlreadyExistsError
    • GroupMemberAlreadyExistsError
    • GroupMemberNotFoundError
    • GroupNotFoundError
    • NotAllowedError
    • NotFoundError
    • ProjectAlreadyExistsError
    • ProjectNotFoundError
    • ReviewerAlreadyExistsError
    • ReviewerNotFoundError
    • SSHKeyNotFoundError
    • ServerError
    • TagAlreadyExistsError
    • TagNotFoundError
    • UnauthorizedError
    • UnknownBranch
    • UnknownFile
    • UnknownTag
    • ValidationError
  • gerrit.utils.gerritbase module
    • GerritBase
      • GerritBase.poll()
      • GerritBase.to_dict()
  • gerrit.utils.requester module
    • Requester
      • Requester.AUTH_COOKIE
      • Requester.VALID_STATUS_CODES
      • Requester.confirm_status()
      • Requester.delete()
      • Requester.get()
      • Requester.get_request_dict()
      • Requester.post()
      • Requester.put()
  • Module contents

Submodules

gerrit.base module

class gerrit.base.GerritClient(base_url: str, username: str | None = None, password: str | None = None, use_netrc: bool = False, ssl_verify: bool | str = True, cert: str | Tuple[str, str] | None = None, cookies: Dict[str, str] | None = None, cookie_jar: Any | None = None, timeout: int = 60, max_retries: int | None = None, session: Session | None = None, auth_suffix: str = '/a')

Bases: object

Python wrapper for the Gerrit V3.x REST API.

property access: Any

Access related REST APIs

Returns:

property accounts: Any

Account related REST APIs

Returns:

property changes: Any

Change related REST APIs

Returns:

property config: Any

Config related REST APIs

Returns:

default_headers: Dict[str, str] = {'Content-Type': 'application/json; charset=UTF-8'}

delete(endpoint: str) → Any

Send HTTP DELETE to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

get(endpoint: str, **kwargs: Any) → Any

Send HTTP GET to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

get_endpoint_url(endpoint: str) → str

Return the complete url including host and port for a given endpoint. :param endpoint: service endpoint as str :return: complete url (including host and port) as str

get_password_from_netrc_file() → str

Providing the password form .netrc file for getting Host name. :return: The related password from .netrc file as a string.

property groups: Any

Group related REST APIs

Returns:

property plugins: Any

Plugin related REST APIs

Returns:

post(endpoint: str, **kwargs: Any) → Any

Send HTTP POST to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

property projects: Any

Project related REST APIs :return:

put(endpoint: str, **kwargs: Any) → Any

Send HTTP PUT to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

property server: Any

get the information about the Gerrit server configuration.

Returns:

property version: str

get the version of the Gerrit server.

Returns:

Module contents

class gerrit.GerritClient(base_url: str, username: str | None = None, password: str | None = None, use_netrc: bool = False, ssl_verify: bool | str = True, cert: str | Tuple[str, str] | None = None, cookies: Dict[str, str] | None = None, cookie_jar: Any | None = None, timeout: int = 60, max_retries: int | None = None, session: Session | None = None, auth_suffix: str = '/a')

Bases: object

Python wrapper for the Gerrit V3.x REST API.

property access: Any

Access related REST APIs

Returns:

property accounts: Any

Account related REST APIs

Returns:

property changes: Any

Change related REST APIs

Returns:

property config: Any

Config related REST APIs

Returns:

default_headers: Dict[str, str] = {'Content-Type': 'application/json; charset=UTF-8'}

delete(endpoint: str) → Any

Send HTTP DELETE to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

get(endpoint: str, **kwargs: Any) → Any

Send HTTP GET to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

get_endpoint_url(endpoint: str) → str

Return the complete url including host and port for a given endpoint. :param endpoint: service endpoint as str :return: complete url (including host and port) as str

get_password_from_netrc_file() → str

Providing the password form .netrc file for getting Host name. :return: The related password from .netrc file as a string.

property groups: Any

Group related REST APIs

Returns:

property plugins: Any

Plugin related REST APIs

Returns:

post(endpoint: str, **kwargs: Any) → Any

Send HTTP POST to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

property projects: Any

Project related REST APIs :return:

put(endpoint: str, **kwargs: Any) → Any

Send HTTP PUT to the endpoint.

Parameters:

endpoint – The endpoint to send to.

Returns:

property server: Any

get the information about the Gerrit server configuration.

Returns:

property version: str

get the version of the Gerrit server.

Returns: