Module contents¶

Wrapper for the GitLab API.

classgitlab.AsyncGraphQL(url:str|None=None,*,token:str|None=None,ssl_verify:bool|str=True,client:AsyncClient|None=None,timeout:float|None=None,user_agent:str='python-gitlab/6.1.0',fetch_schema_from_transport:bool=False,max_retries:int=10,obey_rate_limit:bool=True,retry_transient_errors:bool=False)

Bases:_BaseGraphQL

Parameters:

• url (str |None)

• token (str |None)

• ssl_verify (bool |str)

• client (httpx.AsyncClient |None)

• timeout (float |None)

• user_agent (str)

• fetch_schema_from_transport (bool)

• max_retries (int)

• obey_rate_limit (bool)

• retry_transient_errors (bool)

asyncexecute(request:str|Source,*args:Any,**kwargs:Any)→Any

Parameters:

• request (str |Source)

• args (Any)

• kwargs (Any)

Return type:

Any

classgitlab.Gitlab(url:str|None=None,private_token:str|None=None,oauth_token:str|None=None,job_token:str|None=None,ssl_verify:bool|str=True,http_username:str|None=None,http_password:str|None=None,timeout:float|None=None,api_version:str='4',per_page:int|None=None,pagination:str|None=None,order_by:str|None=None,user_agent:str='python-gitlab/6.1.0',retry_transient_errors:bool=False,keep_base_url:bool=False,**kwargs:Any)

Bases:object

Represents a GitLab server connection.

Parameters:

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

• private_token (str |None) – The user private token

• oauth_token (str |None) – An oauth token

• job_token (str |None) – 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 |None) – Timeout to use for requests to the GitLab server.

• http_username (str |None) – Username for HTTP authentication

• http_password (str |None) – Password for HTTP authentication

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

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

• order_by (str |None) – 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, 504or 52x responses. Defaults to False.

• keep_base_url (bool) – keep user-provided base URL for pagination if itdiffers from response headers

• session (requests.Session) – HTTP Requests Session

• backend (RequestsBackend) – Backend that will be used to make http requests

• per_page (int |None)

• kwargs (Any)

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. Warns the user if apotentially misconfigured URL is detected on the client or server side.

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

Return type:

None

broadcastmessages

SeeBroadcastMessageManager

bulk_import_entities

SeeBulkImportAllEntityManager

bulk_imports

SeeBulkImportManager

ci_lint

SeeCiLintManager

deploykeys

SeeDeployKeyManager

deploytokens

SeeDeployTokenManager

dockerfiles

SeeDockerfileManager

enable_debug(mask_credentials:bool=True)→None

Parameters:

mask_credentials (bool)

Return type:

None

events

SeeEventManager

features

SeeFeatureManager

classmethodfrom_config(gitlab_id:str|None=None,config_files:list[str]|None=None,**kwargs:Any)→Gitlab

Create a Gitlab connection from configuration files.

Parameters:

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

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

• config_files (list[str]|None)

• kwargs (Any)

Return type:

Gitlab

kwargs:

session requests.Session: Custom requests Session

Returns:

A Gitlab connection.

Raises:

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

Parameters:

• gitlab_id (str |None)

• config_files (list[str]|None)

• kwargs (Any)

Return type:

Gitlab

geonodes

SeeGeoNodeManager

get_license(**kwargs:Any)→dict[str,str|dict[str,str]]

Retrieve information about the current license.

Parameters:

**kwargs (Any) – 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[str, str | dict[str, str]]

gitignores

SeeGitignoreManager

gitlabciymls

SeeGitlabciymlManager

groups

SeeGroupManager

headers

Headers that will be used in request to GitLab

hooks

SeeHookManager

http_delete(path:str,**kwargs:Any)→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 (Any) – Extra options to send to the server (e.g. sudo)

Returns:

The requests object.

Raises:

GitlabHttpError – When the return code is not 2xx

Return type:

Response

http_get(path:str,query_data:dict[str,Any]|None=None,streamed:bool=False,raw:bool=False,**kwargs:Any)→dict[str,Any]|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[str,Any]|None) – 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 (Any) – 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

Return type:

dict[str,Any] |Response

http_head(path:str,query_data:dict[str,Any]|None=None,**kwargs:Any)→CaseInsensitiveDict[Any]

Make a HEAD request to the Gitlab server.

Parameters:

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

• query_data (dict[str,Any]|None) – Data to send as query parameters

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

Returns:

A requests.header object

Raises:

GitlabHttpError – When the return code is not 2xx

Return type:

CaseInsensitiveDict[Any]

http_list(path:str,query_data:dict[str,Any]|None=None,*,iterator:bool|None=None,message_details:WarnMessageData|None=None,**kwargs:Any)→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[str,Any]|None) – Data to send as query parameters

• iterator (bool |None) – Indicate if should return a generator (True)

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

• message_details (WarnMessageData |None)

• **kwargs

Returns:

A list of the objects returned by the server. Ifiterator isTrue and no pagination-related arguments (page,per_page,get_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.

Raises:

• GitlabHttpError – When the return code is not 2xx

• GitlabParsingError – If the json data could not be parsed

Return type:

GitlabList | list[dict[str,Any]]

http_patch(path:str,*,query_data:dict[str,Any]|None=None,post_data:dict[str,Any]|bytes|None=None,raw:bool=False,**kwargs:Any)→dict[str,Any]|Response

Make a PATCH request to the Gitlab server.

Parameters:

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

• query_data (dict[str,Any]|None) – Data to send as query parameters

• post_data (dict[str,Any]|bytes |None) – Data to send in the body (will be converted tojson by default)

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

• **kwargs (Any) – 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

Return type:

dict[str,Any] |Response

http_post(path:str,query_data:dict[str,Any]|None=None,post_data:dict[str,Any]|None=None,raw:bool=False,files:dict[str,Any]|None=None,**kwargs:Any)→dict[str,Any]|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[str,Any]|None) – Data to send as query parameters

• post_data (dict[str,Any]|None) – 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[str,Any]|None) – The files to send to the server

• **kwargs (Any) – 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

Return type:

dict[str,Any] |Response

http_put(path:str,query_data:dict[str,Any]|None=None,post_data:dict[str,Any]|bytes|BinaryIO|None=None,raw:bool=False,files:dict[str,Any]|None=None,**kwargs:Any)→dict[str,Any]|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[str,Any]|None) – Data to send as query parameters

• post_data (dict[str,Any]|bytes |BinaryIO |None) – 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[str,Any]|None) – The files to send to the server

• **kwargs (Any) – 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

Return type:

dict[str,Any] |Response

http_request(verb:str,path:str,query_data:dict[str,Any]|None=None,post_data:dict[str,Any]|bytes|BinaryIO|None=None,raw:bool=False,streamed:bool=False,files:dict[str,Any]|None=None,timeout:float|None=None,obey_rate_limit:bool=True,retry_transient_errors:bool|None=None,max_retries:int=10,extra_headers:dict[str,Any]|None=None,**kwargs:Any)→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[str,Any]|None) – Data to send as query parameters

• post_data (dict[str,Any]|bytes |BinaryIO |None) – 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[str,Any]|None) – The files to send to the server

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

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

• retry_transient_errors (bool |None) – Whether to retry after 500, 502, 503, 504or 52x responses. Defaults to False.

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

• extra_headers (dict[str,Any]|None) – Add and override HTTP headers for the request.

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

Returns:

A requests result object.

Raises:

GitlabHttpError – When the return code is not 2xx

Return type:

Response

issues

SeeIssueManager

issues_statistics

SeeIssuesStatisticsManager

keys

SeeKeyManager

ldapgroups

SeeLDAPGroupManager

licenses

SeeLicenseManager

markdown(text:str,gfm:bool=False,project:str|None=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 is False

• project (str |None) – Full path of a project used a context whengfm is True

• **kwargs (Any) – 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

member_roles

SeeMergeRequestManager

classmethodmerge_config(options:dict[str,Any],gitlab_id:str|None=None,config_files:list[str]|None=None)→Gitlab

Create a Gitlab connection by merging configuration withthe following precedence:

1. Explicitly provided CLI arguments,

2. Environment variables,

3. Configuration files:

   1. explicitly defined config files:

      1. via the–config-file CLI argument,

      2. via thePYTHON_GITLAB_CFG environment variable,

   2. user-specific config file,

   3. system-level config file,

4. Environment variables always present in CI (CI_SERVER_URL, CI_JOB_TOKEN).

Parameters:

• options (dict[str,Any]) – A dictionary of explicitly provided key-value options.

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

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

Returns:

A Gitlab connection.

Return type:

(gitlab.Gitlab)

Raises:

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

mergerequests

SeeMergeRequestManager

namespaces

SeeNamespaceManager

notificationsettings

SeeNotificationSettingsManager

pagesdomains

SeePagesDomainManager

personal_access_tokens

SeePersonalAccessTokenManager

projects

SeeProjectManager

registry_repositories

SeeRegistryRepositoryManager

runners

SeeRunnerManager

runners_all

SeeRunnerManager

search(scope:str,search:str,**kwargs:Any)→GitlabList|list[dict[str,Any]]

Search GitLab resources matching the provided string.’

Parameters:

• scope (str) – Scope of the search

• search (str) – Search string

• **kwargs (Any) – 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 | list[dict[str,Any]]

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

Add a new license.

Parameters:

• license (str) – The license string

• **kwargs (Any) – 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[str,Any]

settings

SeeApplicationSettingsManager

sidekiq

SeeSidekiqManager

snippets

SeeSnippetManager

ssl_verify

Whether SSL certificates should be validated

statistics

SeeApplicationStatisticsManager

timeout

Timeout to use for requests to gitlab server

todos

SeeTodoManager

topics

SeeTopicManager

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’, ‘unknown’) if the server doesn’t perform as expected.

Return type:

tuple[str, str]

exceptiongitlab.GitlabActivateError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabAttachFileError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabAuthenticationError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBanError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBlockError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBuildCancelError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabCancelError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBuildEraseError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBuildPlayError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabBuildRetryError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabCancelError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabCherryPickError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabCiLintError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabConnectionError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabCreateError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabDeactivateError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabDeleteError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabDeploymentApprovalError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:Exception

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabFollowError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabGetError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabGroupTransferError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabHeadError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabHookTestError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabHousekeepingError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabHttpError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabImportError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabInvitationError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabJobCancelError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabCancelError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabJobEraseError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabJobPlayError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabJobRetryError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabRetryError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabLicenseError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

classgitlab.GitlabList(gl: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.

Parameters:

• gl (Gitlab)

• url (str)

• query_data (dict[str,Any])

• get_next (bool)

• kwargs (Any)

propertycurrent_page:int

The current page number.

next()→dict[str,Any]

Return type:

dict[str,Any]

propertynext_page:int|None

The next page number.

If None, the current page is the last.

propertyper_page:int|None

The number of items per page.

propertyprev_page:int|None

The previous page number.

If None, the current page is the first.

propertytotal:int|None

The total number of items.

propertytotal_pages:int|None

The total number of pages.

exceptiongitlab.GitlabListError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMRApprovalError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMRClosedError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMRForbiddenError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMROnBuildSuccessError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMRRebaseError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None

exceptiongitlab.GitlabMRResetApprovalError(error_message:str|bytes='',response_code:int|None=None,response_body:bytes|None=None)

Bases:GitlabOperationError

Parameters:

• error_message (str |bytes)

• response_code (int |None)

• response_body (bytes |None)

Return type:

None