gerrit package
Subpackages
- gerrit.accounts package
- Submodules
- gerrit.accounts.account module
GerritAccountGerritAccount.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.emailsGerritAccount.get_active()GerritAccount.get_avatar()GerritAccount.get_avatar_change_url()GerritAccount.get_default_starred_changes()GerritAccount.get_detail()GerritAccount.get_diff_preferences()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_watched_projects()GerritAccount.gpg_keysGerritAccount.groupsGerritAccount.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_keysGerritAccount.update_star_labels_on_change()
- gerrit.accounts.accounts module
- gerrit.accounts.emails module
- gerrit.accounts.gpg_keys module
- gerrit.accounts.ssh_keys module
- Module contents
- gerrit.changes package
- Submodules
- gerrit.changes.change module
GerritChangeGerritChange.abandon()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_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.messagesGerritChange.move()GerritChange.rebase()GerritChange.remove_from_attention_set()GerritChange.restore()GerritChange.revert()GerritChange.revert_submission()GerritChange.reviewersGerritChange.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
- gerrit.changes.comments module
- gerrit.changes.drafts module
- gerrit.changes.edit module
GerritChangeEditGerritChangeEdit.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
- gerrit.changes.messages module
- gerrit.changes.reviewers module
- gerrit.changes.revision module
GerritChangeRevisionGerritChangeRevision.cherry_pick()GerritChangeRevision.commentsGerritChangeRevision.delete_vote()GerritChangeRevision.draftsGerritChangeRevision.filesGerritChangeRevision.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
- gerrit.config.config module
GerritConfigGerritConfig.cachesGerritConfig.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
- Module contents
- gerrit.groups package
- Submodules
- gerrit.groups.group module
GerritGroupGerritGroup.delete_description()GerritGroup.get_audit_log()GerritGroup.get_description()GerritGroup.get_detail()GerritGroup.get_name()GerritGroup.get_options()GerritGroup.get_owner()GerritGroup.index()GerritGroup.membersGerritGroup.set_description()GerritGroup.set_name()GerritGroup.set_options()GerritGroup.set_owner()GerritGroup.subgroup
- gerrit.groups.groups module
- gerrit.groups.members module
- gerrit.groups.subgroups module
- Module contents
- gerrit.plugins package
- gerrit.projects package
- Submodules
- gerrit.projects.branches module
- gerrit.projects.commit module
- gerrit.projects.dashboards module
- gerrit.projects.labels module
- gerrit.projects.project module
GerritProjectGerritProject.ban_commits()GerritProject.branchesGerritProject.check_access()GerritProject.check_consistency()GerritProject.child_projectsGerritProject.create_access_rights_change()GerritProject.create_change()GerritProject.dashboardsGerritProject.delete()GerritProject.delete_description()GerritProject.get_access_rights()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.labelsGerritProject.run_garbage_collection()GerritProject.set_access_rights()GerritProject.set_config()GerritProject.set_description()GerritProject.set_head()GerritProject.set_parent()GerritProject.tagsGerritProject.webhooks
- gerrit.projects.projects module
- gerrit.projects.tags module
- gerrit.projects.webhooks module
- Module contents
- gerrit.utils package
- Submodules
- gerrit.utils.common module
- gerrit.utils.exceptions module
AccountAlreadyExistsErrorAccountEmailAlreadyExistsErrorAccountEmailNotFoundErrorAccountNotFoundErrorAuthErrorBranchAlreadyExistsErrorBranchNotFoundErrorChangeEditNotFoundErrorChangeNotFoundErrorClientErrorCommitNotFoundErrorConflictErrorFileContentNotFoundErrorGPGKeyNotFoundErrorGerritAPIExceptionGroupAlreadyExistsErrorGroupMemberAlreadyExistsErrorGroupMemberNotFoundErrorGroupNotFoundErrorNotAllowedErrorNotFoundErrorProjectAlreadyExistsErrorProjectNotFoundErrorReviewerAlreadyExistsErrorReviewerNotFoundErrorSSHKeyNotFoundErrorServerErrorTagAlreadyExistsErrorTagNotFoundErrorUnauthorizedErrorUnknownBranchUnknownFileUnknownTagValidationError
- gerrit.utils.gerritbase module
- gerrit.utils.requester module
- Module contents
Submodules
gerrit.base module
- class gerrit.base.GerritClient(base_url, username=None, password=None, use_netrc=False, ssl_verify=True, cert=None, cookies=None, cookie_jar=None, timeout=60, max_retries=None, session=None, auth_suffix='/a')[source]
Bases:
objectPython wrapper for the Gerrit V3.x REST API.
- property accounts
Account related REST APIs
- Returns:
- property changes
Change related REST APIs
- Returns:
- property config
Config related REST APIs
- Returns:
- default_headers = {'Content-Type': 'application/json; charset=UTF-8'}
- delete(endpoint)[source]
Send HTTP DELETE to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- get(endpoint, **kwargs)[source]
Send HTTP GET to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- get_endpoint_url(endpoint)[source]
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()[source]
Providing the password form .netrc file for getting Host name. :return: The related password from .netrc file as a string.
- property groups
Group related REST APIs
- Returns:
- property plugins
Plugin related REST APIs
- Returns:
- post(endpoint, **kwargs)[source]
Send HTTP POST to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- property projects
Project related REST APIs :return:
- put(endpoint, **kwargs)[source]
Send HTTP PUT to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- property server
get the information about the Gerrit server configuration.
- Returns:
- property version
get the version of the Gerrit server.
- Returns:
Module contents
- class gerrit.GerritClient(base_url, username=None, password=None, use_netrc=False, ssl_verify=True, cert=None, cookies=None, cookie_jar=None, timeout=60, max_retries=None, session=None, auth_suffix='/a')[source]
Bases:
objectPython wrapper for the Gerrit V3.x REST API.
- property accounts
Account related REST APIs
- Returns:
- property changes
Change related REST APIs
- Returns:
- property config
Config related REST APIs
- Returns:
- default_headers = {'Content-Type': 'application/json; charset=UTF-8'}
- delete(endpoint)[source]
Send HTTP DELETE to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- get(endpoint, **kwargs)[source]
Send HTTP GET to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- get_endpoint_url(endpoint)[source]
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()[source]
Providing the password form .netrc file for getting Host name. :return: The related password from .netrc file as a string.
- property groups
Group related REST APIs
- Returns:
- property plugins
Plugin related REST APIs
- Returns:
- post(endpoint, **kwargs)[source]
Send HTTP POST to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- property projects
Project related REST APIs :return:
- put(endpoint, **kwargs)[source]
Send HTTP PUT to the endpoint.
- Parameters:
endpoint – The endpoint to send to.
- Returns:
- property server
get the information about the Gerrit server configuration.
- Returns:
- property version
get the version of the Gerrit server.
- Returns: