Module contents¶

Wrapper for the GitLab API.

classgitlab.Gitlab(url:Optional[str]=None,private_token:Optional[str]=None,oauth_token:Optional[str]=None,job_token:Optional[str]=None,ssl_verify:Union[bool,str]=True,http_username:Optional[str]=None,http_password:Optional[str]=None,timeout:Optional[float]=None,api_version:str='4',session:Optional[requests.sessions.Session]=None,per_page:Optional[int]=None,pagination:Optional[str]=None,order_by:Optional[str]=None,user_agent:str='python-gitlab/2.10.1',retry_transient_errors:bool=False)¶

Bases:object

Represents a GitLab server connection.

Parameters

• url (str) – The URL of the GitLab server (defaults tohttps://gitlab.com).

• private_token (str) – The user private token

• oauth_token (str) – An oauth token

• job_token (str) – A CI job token

• ssl_verify (bool|str) – Whether SSL certificates should be validated. Ifthe value is a string, it is the path to a CA file used forcertificate validation.

• timeout (float) – Timeout to use for requests to the GitLab server.

• http_username (str) – Username for HTTP authentication

• http_password (str) – Password for HTTP authentication

• api_version (str) – Gitlab API version to use (support for 4 only)

• pagination (str) – Can be set to ‘keyset’ to use keyset pagination

• order_by (str) – Set order_by globally

• user_agent (str) – A custom user agent to use for making HTTP requests.

• retry_transient_errors (bool) – Whether to retry after 500, 502, 503, or504 responses. Defaults to False.

propertyapi_url:str¶

The computed API base URL.

propertyapi_version:str¶

The API version used (4 only).

appearance¶

SeeApplicationAppearanceManager

applications¶

SeeApplicationManager

audit_events¶

SeeAuditEventManager

auth()→None¶

Performs an authentication using private token.

Theuser attribute will hold agitlab.objects.CurrentUser object onsuccess.

broadcastmessages¶

SeeBroadcastMessageManager

deploykeys¶

SeeDeployKeyManager

deploytokens¶

SeeDeployTokenManager

dockerfiles¶

SeeDockerfileManager

enable_debug()→None¶

events¶

SeeEventManager

features¶

SeeFeatureManager

classmethodfrom_config(gitlab_id:Optional[str]=None,config_files:Optional[List[str]]=None)→gitlab.client.Gitlab¶

Create a Gitlab connection from configuration files.

Parameters

• gitlab_id (str) – ID of the configuration section.

• list[str] (config_files) – List of paths to configuration files.

Returns

A Gitlab connection.

Return type

(gitlab.Gitlab)

Raises

gitlab.config.GitlabDataError – If the configuration is not correct.

geonodes¶

SeeGeoNodeManager

get_license(**kwargs:Any)→Dict[str,Any]¶

Retrieve information about the current license.

Parameters

**kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabGetError – If the server cannot perform the request

Returns

The current license information

Return type

dict

gitignores¶

SeeGitignoreManager

gitlabciymls¶

SeeGitlabciymlManager

groups¶

SeeGroupManager

headers¶

Headers that will be used in request to GitLab

hooks¶

SeeHookManager

http_delete(path:str,**kwargs:Any)→requests.models.Response¶

Make a DELETE request to the Gitlab server.

Parameters

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projecs’)

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

The requests object.

Raises

GitlabHttpError – When the return code is not 2xx

http_get(path:str,query_data:Optional[Dict[str,Any]]=None,streamed:bool=False,raw:bool=False,**kwargs:Any)→Union[Dict[str,Any],requests.models.Response]¶

Make a GET request to the Gitlab server.

Parameters

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projecs’)

• query_data (dict) – Data to send as query parameters

• streamed (bool) – Whether the data should be streamed

• raw (bool) – If True do not try to parse the output as json

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

A requests result object is streamed is True or the content type isnot json.The parsed json data otherwise.

Raises

• GitlabHttpError – When the return code is not 2xx

• GitlabParsingError – If the json data could not be parsed

http_list(path:str,query_data:Optional[Dict[str,Any]]=None,as_list:Optional[bool]=None,**kwargs:Any)→Union[gitlab.client.GitlabList,List[Dict[str,Any]]]¶

Make a GET request to the Gitlab server for list-oriented queries.

Parameters

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projects’)

• query_data (dict) – Data to send as query parameters

• **kwargs – Extra options to send to the server (e.g. sudo, page,per_page)

Returns

A list of the objects returned by the server. Ifas_list isFalse and no pagination-related arguments (page,per_page,all) are defined then a GitlabList object (generator) is returnedinstead. This object will make API calls when needed to fetch thenext items from the server.

Return type

list

Raises

• GitlabHttpError – When the return code is not 2xx

• GitlabParsingError – If the json data could not be parsed

http_post(path:str,query_data:Optional[Dict[str,Any]]=None,post_data:Optional[Dict[str,Any]]=None,raw:bool=False,files:Optional[Dict[str,Any]]=None,**kwargs:Any)→Union[Dict[str,Any],requests.models.Response]¶

Make a POST request to the Gitlab server.

Parameters

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projecs’)

• query_data (dict) – Data to send as query parameters

• post_data (dict) – Data to send in the body (will be converted tojson by default)

• raw (bool) – If True, do not convert post_data to json

• files (dict) – The files to send to the server

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

The parsed json returned by the server if json is return, else theraw content

Raises

• GitlabHttpError – When the return code is not 2xx

• GitlabParsingError – If the json data could not be parsed

http_put(path:str,query_data:Optional[Dict[str,Any]]=None,post_data:Optional[Dict[str,Any]]=None,raw:bool=False,files:Optional[Dict[str,Any]]=None,**kwargs:Any)→Union[Dict[str,Any],requests.models.Response]¶

Make a PUT request to the Gitlab server.

Parameters

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projecs’)

• query_data (dict) – Data to send as query parameters

• post_data (dict) – Data to send in the body (will be converted tojson by default)

• raw (bool) – If True, do not convert post_data to json

• files (dict) – The files to send to the server

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

The parsed json returned by the server.

Raises

• GitlabHttpError – When the return code is not 2xx

• GitlabParsingError – If the json data could not be parsed

http_request(verb:str,path:str,query_data:Optional[Dict[str,Any]]=None,post_data:Optional[Dict[str,Any]]=None,raw:bool=False,streamed:bool=False,files:Optional[Dict[str,Any]]=None,timeout:Optional[float]=None,obey_rate_limit:bool=True,max_retries:int=10,**kwargs:Any)→requests.models.Response¶

Make an HTTP request to the Gitlab server.

Parameters

• verb (str) – The HTTP method to call (‘get’, ‘post’, ‘put’,‘delete’)

• path (str) – Path or full URL to query (‘/projects’ or‘http://whatever/v4/api/projecs’)

• query_data (dict) – Data to send as query parameters

• post_data (dict) – Data to send in the body (will be converted tojson by default)

• raw (bool) – If True, do not convert post_data to json

• streamed (bool) – Whether the data should be streamed

• files (dict) – The files to send to the server

• timeout (float) – The timeout, in seconds, for the request

• obey_rate_limit (bool) – Whether to obey 429 Too Many Requestresponses. Defaults to True.

• max_retries (int) – Max retries after 429 or transient errors,set to -1 to retry forever. Defaults to 10.

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

A requests result object.

Raises

GitlabHttpError – When the return code is not 2xx

issues¶

SeeIssueManager

issues_statistics¶

SeeIssuesStatisticsManager

keys¶

SeeKeyManager

ldapgroups¶

SeeLDAPGroupManager

licenses¶

SeeLicenseManager

lint(content:str,**kwargs:Any)→Tuple[bool,List[str]]¶

Validate a gitlab CI configuration.

Parameters

• content (txt) – The .gitlab-ci.yml content

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabVerifyError – If the validation could not be done

Returns

(True, []) if the file is valid, (False, errors(list))

otherwise

Return type

tuple

markdown(text:str,gfm:bool=False,project:Optional[str]=None,**kwargs:Any)→str¶

Render an arbitrary Markdown document.

Parameters

• text (str) – The markdown text to render

• gfm (bool) – Render text using GitLab Flavored Markdown. Default isFalse

• project (str) – Full path of a project used a context whengfm isTrue

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabMarkdownError – If the server cannot perform the request

Returns

The HTML rendering of the markdown text.

Return type

str

mergerequests¶

SeeMergeRequestManager

namespaces¶

SeeNamespaceManager

notificationsettings¶

SeeNotificationSettingsManager

pagesdomains¶

SeePagesDomainManager

personal_access_tokens¶

SeePersonalAccessTokenManager

projects¶

SeeProjectManager

runners¶

SeeRunnerManager

search(scope:str,search:str,**kwargs:Any)→Union[gitlab.client.GitlabList,List[Dict[str,Any]]]¶

Search GitLab resources matching the provided string.’

Parameters

• scope (str) – Scope of the search

• search (str) – Search string

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabSearchError – If the server failed to perform the request

Returns

A list of dicts describing the resources found.

Return type

GitlabList

session¶

Create a session object for requests

set_license(license:str,**kwargs:Any)→Dict[str,Any]¶

Add a new license.

Parameters

• license (str) – The license string

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabPostError – If the server cannot perform the request

Returns

The new license information

Return type

dict

settings¶

SeeApplicationSettingsManager

sidekiq¶

SeeSidekiqManager

snippets¶

SeeSnippetManager

ssl_verify¶

Whether SSL certificates should be validated

timeout¶

Timeout to use for requests to gitlab server

todos¶

SeeTodoManager

propertyurl:str¶

The user-provided server URL.

user_activities¶

SeeUserActivitiesManager

users¶

SeeUserManager

variables¶

SeeVariableManager

version()→Tuple[str,str]¶

Returns the version and revision of the gitlab server.

Note that self.version and self.revision will be set on the gitlabobject.

Returns

The server version and server revision.

(‘unknown’, ‘unknwown’) if the server doesn’tperform as expected.

Return type

tuple (str, str)

classgitlab.GitlabList(gl:gitlab.client.Gitlab,url:str,query_data:Dict[str,Any],get_next:bool=True,**kwargs:Any)¶

Bases:object

Generator representing a list of remote objects.

The object handles the links returned by a query to the API, and will callthe API again when needed.

propertycurrent_page:int¶

The current page number.

next()→Dict[str,Any]¶

propertynext_page:Optional[int]¶

The next page number.

If None, the current page is the last.

propertyper_page:int¶

The number of items per page.

propertyprev_page:Optional[int]¶

The previous page number.

If None, the current page is the first.

propertytotal:int¶

The total number of items.

propertytotal_pages:int¶

The total number of pages.

Subpackages¶

Submodules¶

gitlab.base module¶

classgitlab.base.RESTManager(gl:gitlab.client.Gitlab,parent:Optional[gitlab.base.RESTObject]=None)¶

Bases:object

Base class for CRUD operations on objects.

Derived class must define_path and_obj_cls.

_path: Base URL path on which requests will be sent (e.g. ‘/projects’)_obj_cls: The class of objects that will be created

gitlab:gitlab.client.Gitlab¶

propertyparent_attrs:Optional[Dict[str,Any]]¶

propertypath:Optional[str]¶

classgitlab.base.RESTObject(manager:gitlab.base.RESTManager,attrs:Dict[str,Any])¶

Bases:object

Represents an object built from server data.

It holds the attributes know from the server, and the updated attributes inanother. This allows smart updates, if the object allows it.

You can redefine_id_attr in child classes to specify which attributemust be used as uniq ID.None means that the object can be updatedwithout ID in the url.

propertyattributes:Dict[str,Any]¶

get_id()→Any¶

Returns the id of the resource.

manager:gitlab.base.RESTManager¶

classgitlab.base.RESTObjectList(manager:gitlab.base.RESTManager,obj_cls:Type[gitlab.base.RESTObject],_list:gitlab.client.GitlabList)¶

Bases:object

Generator object representing a list of RESTObject’s.

This generator uses the Gitlab pagination system to fetch new data whenrequired.

Note: you should not instantiate such objects, they are returned by callsto RESTManager.list()

Parameters

• manager – Manager to attach to the created objects

• obj_cls – Type of objects to create from the json data

• _list – A GitlabList object

propertycurrent_page:int¶

The current page number.

next()→gitlab.base.RESTObject¶

propertynext_page:Optional[int]¶

The next page number.

If None, the current page is the last.

propertyper_page:int¶

The number of items per page.

propertyprev_page:Optional[int]¶

The previous page number.

If None, the current page is the first.

propertytotal:int¶

The total number of items.

propertytotal_pages:int¶

The total number of pages.

classgitlab.base.RequiredOptional(required,optional)¶

Bases:tuple

optional:Tuple[str,...]¶

Alias for field number 1

required:Tuple[str,...]¶

Alias for field number 0

gitlab.cli module¶

gitlab.cli.cls_to_what(cls:gitlab.base.RESTObject)→str¶

gitlab.cli.die(msg:str,e:Optional[Exception]=None)→None¶

gitlab.cli.docs()→argparse.ArgumentParser¶

Provide a statically generated parser for sphinx only, so we don’t needto provide dummy gitlab config for readthedocs.

gitlab.cli.main()→None¶

gitlab.cli.register_custom_action(cls_names:Union[str,Tuple[str,...]],mandatory:Tuple[str,...]=(),optional:Tuple[str,...]=(),custom_action:Optional[str]=None)→Callable[[gitlab.cli.__F],gitlab.cli.__F]¶

gitlab.cli.what_to_cls(what:str,namespace:module)→Type[gitlab.base.RESTObject]¶

gitlab.config module¶

exceptiongitlab.config.ConfigError¶

Bases:Exception

exceptiongitlab.config.GitlabConfigHelperError¶

Bases:gitlab.config.ConfigError

exceptiongitlab.config.GitlabConfigMissingError¶

Bases:gitlab.config.ConfigError

classgitlab.config.GitlabConfigParser(gitlab_id:Optional[str]=None,config_files:Optional[List[str]]=None)¶

Bases:object

exceptiongitlab.config.GitlabDataError¶

Bases:gitlab.config.ConfigError

exceptiongitlab.config.GitlabIDError¶

Bases:gitlab.config.ConfigError

gitlab.const module¶

gitlab.exceptions module¶

exceptiongitlab.exceptions.GitlabActivateError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabAttachFileError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabAuthenticationError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

exceptiongitlab.exceptions.GitlabBlockError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabBuildCancelError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabCancelError

exceptiongitlab.exceptions.GitlabBuildEraseError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabBuildPlayError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabBuildRetryError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabCancelError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabCherryPickError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabConnectionError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

exceptiongitlab.exceptions.GitlabCreateError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabDeactivateError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabDeleteError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:Exception

exceptiongitlab.exceptions.GitlabFollowError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabGetError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabHousekeepingError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabHttpError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

exceptiongitlab.exceptions.GitlabImportError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabJobCancelError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabCancelError

exceptiongitlab.exceptions.GitlabJobEraseError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabJobPlayError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabJobRetryError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabLicenseError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabListError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMRApprovalError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMRClosedError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMRForbiddenError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMROnBuildSuccessError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMRRebaseError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabMarkdownError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabOperationError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

exceptiongitlab.exceptions.GitlabOwnershipError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabParsingError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

exceptiongitlab.exceptions.GitlabPipelineCancelError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabCancelError

exceptiongitlab.exceptions.GitlabPipelinePlayError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabPipelineRetryError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabRetryError

exceptiongitlab.exceptions.GitlabProjectDeployKeyError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabProtectError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabRenderError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabRepairError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabRetryError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabRevertError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabSearchError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabSetError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabStopError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabSubscribeError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabTimeTrackingError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabTodoError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabTransferProjectError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabUnblockError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabUnfollowError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabUnsubscribeError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabUpdateError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabUploadError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.GitlabVerifyError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabOperationError

exceptiongitlab.exceptions.RedirectError(error_message:Union[str,bytes]='',response_code:Optional[int]=None,response_body:Optional[bytes]=None)¶

Bases:gitlab.exceptions.GitlabError

gitlab.exceptions.on_http_error(error:Type[Exception])→Callable[[gitlab.exceptions.__F],gitlab.exceptions.__F]¶

Manage GitlabHttpError exceptions.

This decorator function can be used to catch GitlabHttpError exceptionsraise specialized exceptions instead.

Parameters

error (Exception) – The exception type to raise – must inherit fromGitlabError

gitlab.mixins module¶

classgitlab.mixins.AccessRequestMixin¶

Bases:object

approve(access_level:int=30,**kwargs:Any)→None¶

Approve an access request.

Parameters

• access_level (int) – The access level for the user

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabUpdateError – If the server fails to perform the request

manager:gitlab.base.RESTManager¶

classgitlab.mixins.BadgeRenderMixin¶

Bases:object

render(link_url:str,image_url:str,**kwargs:Any)→Dict[str,Any]¶

Preview link_url and image_url after interpolation.

Parameters

• link_url (str) – URL of the badge link

• image_url (str) – URL of the badge image

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabRenderError – If the rendering failed

Returns

The rendering properties

Return type

dict

classgitlab.mixins.CRUDMixin¶

Bases:gitlab.mixins.GetMixin,gitlab.mixins.ListMixin,gitlab.mixins.CreateMixin,gitlab.mixins.UpdateMixin,gitlab.mixins.DeleteMixin

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.CreateMixin¶

Bases:object

create(data:Optional[Dict[str,Any]]=None,**kwargs:Any)→gitlab.base.RESTObject¶

Create a new object.

Parameters

• data (dict) – parameters to send to the server to create theresource

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

a new instance of the managed object class built with

the data sent by the server

Return type

RESTObject

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabCreateError – If the server cannot perform the request

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.DeleteMixin¶

Bases:object

delete(id:Union[str,int],**kwargs:Any)→None¶

Delete an object on the server.

Parameters

• id – ID of the object to delete

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabDeleteError – If the server cannot perform the request

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.DownloadMixin¶

Bases:object

download(streamed:bool=False,action:Optional[Callable]=None,chunk_size:int=1024,**kwargs:Any)→Optional[bytes]¶

Download the archive of a resource export.

Parameters

• streamed (bool) – If True the data will be processed by chunks ofchunk_size and each chunk is passed toaction fortreatment

• action (callable) – Callable responsible of dealing with chunk ofdata

• chunk_size (int) – Size of each chunk

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabGetError – If the server failed to perform the request

Returns

The blob content if streamed is False, None otherwise

Return type

str

manager:gitlab.base.RESTManager¶

classgitlab.mixins.GetMixin¶

Bases:object

get(id:Union[str,int],lazy:bool=False,**kwargs:Any)→gitlab.base.RESTObject¶

Retrieve a single object.

Parameters

• id (int orstr) – ID of the object to retrieve

• lazy (bool) – If True, don’t request the server, but create ashallow object giving access to the managers. This isuseful if you want to avoid useless calls to the API.

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

The generated RESTObject.

Return type

object

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabGetError – If the server cannot perform the request

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.GetWithoutIdMixin¶

Bases:object

get(id:Optional[Union[int,str]]=None,**kwargs:Any)→Optional[gitlab.base.RESTObject]¶

Retrieve a single object.

Parameters

**kwargs – Extra options to send to the server (e.g. sudo)

Returns

The generated RESTObject

Return type

object

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabGetError – If the server cannot perform the request

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.ListMixin¶

Bases:object

gitlab:gitlab.client.Gitlab¶

list(**kwargs:Any)→Union[gitlab.base.RESTObjectList,List[gitlab.base.RESTObject]]¶

Retrieve a list of objects.

Parameters

• all (bool) – If True, return all the items, without pagination

• per_page (int) – Number of items to retrieve per request

• page (int) – ID of the page to return (starts with page 1)

• as_list (bool) – If set to False and no pagination option isdefined, return a generator instead of a list

• **kwargs – Extra options to send to the server (e.g. sudo)

Returns

The list of objects, or a generator ifas_list is False

Return type

list

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabListError – If the server cannot perform the request

classgitlab.mixins.NoUpdateMixin¶

Bases:gitlab.mixins.GetMixin,gitlab.mixins.ListMixin,gitlab.mixins.CreateMixin,gitlab.mixins.DeleteMixin

gitlab:gitlab.client.Gitlab¶

classgitlab.mixins.ObjectDeleteMixin¶

Bases:object

Mixin for RESTObject’s that can be deleted.

delete(**kwargs:Any)→None¶

Delete the object from the server.

Parameters

**kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabDeleteError – If the server cannot perform the request

manager:gitlab.base.RESTManager¶

classgitlab.mixins.ParticipantsMixin¶

Bases:object

manager:gitlab.base.RESTManager¶

participants(**kwargs:Any)→Dict[str,Any]¶

List the participants.

Parameters

• all (bool) – If True, return all the items, without pagination

• per_page (int) – Number of items to retrieve per request

• page (int) – ID of the page to return (starts with page 1)

• as_list (bool) – If set to False and no pagination option isdefined, return a generator instead of a list

• **kwargs – Extra options to send to the server (e.g. sudo)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabListError – If the list could not be retrieved

Returns

The list of participants

Return type

RESTObjectList

classgitlab.mixins.RefreshMixin¶

Bases:object

manager:gitlab.base.RESTManager¶

refresh(**kwargs:Any)→None¶

Refresh a single object from server.

Parameters

**kwargs – Extra options to send to the server (e.g. sudo)

Returns None (updates the object)

Raises

• GitlabAuthenticationError – If authentication is not correct

• GitlabGetError – If the server cannot perform the request