API reference (gitlab package)

Module contents

Wrapper for the GitLab API.

class gitlab.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/3.1.1', retry_transient_errors: bool = False)

Bases: object

Represents a GitLab server connection.

Parameters

  • url (Optional[str]) – The URL of the GitLab server (defaults to https://gitlab.com).

  • private_token (Optional[str]) – The user private token

  • oauth_token (Optional[str]) – An oauth token

  • job_token (Optional[str]) – A CI job token

  • ssl_verify (Union[bool, str]) – Whether SSL certificates should be validated. If the value is a string, it is the path to a CA file used for certificate validation.

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

  • http_username (Optional[str]) – Username for HTTP authentication

  • http_password (Optional[str]) – Password for HTTP authentication

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

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

  • order_by (Optional[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, or 504 responses. Defaults to False.

  • session (Optional[requests.sessions.Session]) –

  • per_page (Optional[int]) –

Return type

None

property api_url: str

The computed API base URL.

property api_version: str

The API version used (4 only).

appearance

See ApplicationAppearanceManager

applications

See ApplicationManager

audit_events

See AuditEventManager

auth() → None

Performs an authentication using private token.

The user attribute will hold a gitlab.objects.CurrentUser object on success.

Return type

None

broadcastmessages

See BroadcastMessageManager

deploykeys

See DeployKeyManager

deploytokens

See DeployTokenManager

dockerfiles

See DockerfileManager

enable_debug() → None
Return type

None

events

See EventManager

features

See FeatureManager

classmethod from_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 (Optional[str]) – ID of the configuration section.

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

  • config_files (Optional[List[str]]) –

Returns

A Gitlab connection.

Raises

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

Return type

gitlab.client.Gitlab

geonodes

See GeoNodeManager

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)

  • kwargs (Any) –

Raises
Returns

The current license information

Return type

Dict[str, Any]

gitignores

See GitignoreManager

gitlabciymls

See GitlabciymlManager

groups

See GroupManager

headers

Headers that will be used in request to GitLab

hooks

See HookManager

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)

  • kwargs (Any) –

Returns

The requests object.

Raises

GitlabHttpError – When the return code is not 2xx

Return type

requests.models.Response

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 (Optional[Dict[str, Any]]) – 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)

  • kwargs (Any) –

Returns

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

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

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 (Optional[Dict[str, Any]]) – Data to send as query parameters

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

  • as_list (Optional[bool]) –

  • kwargs (Any) –

Returns

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

Raises
Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

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 (Optional[Dict[str, Any]]) – Data to send as query parameters

  • post_data (Optional[Dict[str, Any]]) – Data to send in the body (will be converted to json by default)

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

  • files (Optional[Dict[str, Any]]) – The files to send to the server

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

  • kwargs (Any) –

Returns

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

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

http_put(path: str, query_data: Optional[Dict[str, Any]] = None, post_data: Optional[Union[Dict[str, Any], bytes]] = 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 (Optional[Dict[str, Any]]) – Data to send as query parameters

  • post_data (Optional[Union[Dict[str, Any], bytes]]) – Data to send in the body (will be converted to json by default)

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

  • files (Optional[Dict[str, Any]]) – The files to send to the server

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

  • kwargs (Any) –

Returns

The parsed json returned by the server.

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

http_request(verb: str, path: str, query_data: Optional[Dict[str, Any]] = None, post_data: Optional[Union[Dict[str, Any], bytes]] = 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 (Optional[Dict[str, Any]]) – Data to send as query parameters

  • post_data (Optional[Union[Dict[str, Any], bytes]]) – Data to send in the body (will be converted to json by default)

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

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

  • files (Optional[Dict[str, Any]]) – The files to send to the server

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

  • obey_rate_limit (bool) – Whether to obey 429 Too Many Request responses. 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)

  • kwargs (Any) –

Returns

A requests result object.

Raises

GitlabHttpError – When the return code is not 2xx

Return type

requests.models.Response

issues

See IssueManager

issues_statistics

See IssuesStatisticsManager

keys

See KeyManager

ldapgroups

See LDAPGroupManager

licenses

See LicenseManager

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

Validate a gitlab CI configuration.

Parameters

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

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

  • kwargs (Any) –

Raises
Returns

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

Return type

Tuple[bool, List[str]]

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 is False

  • project (Optional[str]) – Full path of a project used a context when gfm is True

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

  • kwargs (Any) –

Raises
Returns

The HTML rendering of the markdown text.

Return type

str

classmethod merge_config(options: dict, gitlab_id: Optional[str] = None, config_files: Optional[List[str]] = None) → gitlab.client.Gitlab

Create a Gitlab connection by merging configuration with the 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 the PYTHON_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) – A dictionary of explicitly provided key-value options.

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

  • config_files (Optional[List[str]]) – 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

See MergeRequestManager

namespaces

See NamespaceManager

notificationsettings

See NotificationSettingsManager

pagesdomains

See PagesDomainManager

personal_access_tokens

See PersonalAccessTokenManager

projects

See ProjectManager

runners

See RunnerManager

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)

  • kwargs (Any) –

Raises
Returns

A list of dicts describing the resources found.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

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)

  • kwargs (Any) –

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

See ApplicationSettingsManager

sidekiq

See SidekiqManager

snippets

See SnippetManager

ssl_verify

Whether SSL certificates should be validated

timeout

Timeout to use for requests to gitlab server

todos

See TodoManager

topics

See TopicManager

property url: str

The user-provided server URL.

user_activities

See UserActivitiesManager

users

See UserManager

variables

See VariableManager

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 gitlab object.

Returns

The server version and server revision.

(‘unknown’, ‘unknown’) if the server doesn’t perform as expected.

Return type

Tuple[str, str]

class gitlab.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 call the API again when needed.

Parameters

  • gl (gitlab.client.Gitlab) –

  • url (str) –

  • query_data (Dict[str, Any]) –

  • get_next (bool) –

  • kwargs (Any) –

Return type

None

property current_page: int

The current page number.

next() → Dict[str, Any]
Return type

Dict[str, Any]

property next_page: Optional[int]

The next page number.

If None, the current page is the last.

property per_page: int

The number of items per page.

property prev_page: Optional[int]

The previous page number.

If None, the current page is the first.

property total: Optional[int]

The total number of items.

property total_pages: Optional[int]

The total number of pages.

Subpackages

Submodules

gitlab.base module

class gitlab.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

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
property parent_attrs: Optional[Dict[str, Any]]
property path: Optional[str]
class gitlab.base.RESTObject(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: object

Represents an object built from server data.

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

You can redefine _id_attr in child classes to specify which attribute must be used as uniq ID. None means that the object can be updated without ID in the url.

Parameters
Return type

None

property attributes: Dict[str, Any]
property encoded_id: Optional[Union[int, str]]

Ensure that the ID is url-encoded so that it can be safely used in a URL path

get_id() → Optional[Union[int, str]]

Returns the id of the resource.

Return type

Optional[Union[int, str]]

manager: gitlab.base.RESTManager
pformat() → str
Return type

str

pprint() → None
Return type

None

class gitlab.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 when required.

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

Parameters
Return type

None

property current_page: int

The current page number.

next() → gitlab.base.RESTObject
Return type

gitlab.base.RESTObject

property next_page: Optional[int]

The next page number.

If None, the current page is the last.

property per_page: int

The number of items per page.

property prev_page: Optional[int]

The previous page number.

If None, the current page is the first.

property total: Optional[int]

The total number of items.

property total_pages: Optional[int]

The total number of pages.

class gitlab.base.RequiredOptional(required: Tuple[str, ...] = (), optional: Tuple[str, ...] = ())

Bases: object

Parameters

  • required (Tuple[str, ...]) –

  • optional (Tuple[str, ...]) –

Return type

None

optional: Tuple[str, ...] = ()
required: Tuple[str, ...] = ()

gitlab.cli module

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

cls (gitlab.base.RESTObject) –

Return type

str

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

  • msg (str) –

  • e (Optional[Exception]) –

Return type

None

gitlab.cli.docs() → argparse.ArgumentParser

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

Return type

argparse.ArgumentParser

gitlab.cli.main() → None
Return type

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]
Parameters

  • cls_names (Union[str, Tuple[str, ...]]) –

  • mandatory (Tuple[str, ...]) –

  • optional (Tuple[str, ...]) –

  • custom_action (Optional[str]) –

Return type

Callable[[gitlab.cli.__F], gitlab.cli.__F]

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

  • what (str) –

  • namespace (module) –

Return type

Type[gitlab.base.RESTObject]

gitlab.config module

exception gitlab.config.ConfigError

Bases: Exception

exception gitlab.config.GitlabConfigHelperError

Bases: gitlab.config.ConfigError

exception gitlab.config.GitlabConfigMissingError

Bases: gitlab.config.ConfigError

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

Bases: object

Parameters

  • gitlab_id (Optional[str]) –

  • config_files (Optional[List[str]]) –

Return type

None

exception gitlab.config.GitlabDataError

Bases: gitlab.config.ConfigError

exception gitlab.config.GitlabIDError

Bases: gitlab.config.ConfigError

gitlab.const module

gitlab.exceptions module

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabCancelError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: Exception

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

exception gitlab.exceptions.GitlabGroupTransferError(error_message: Union[str, bytes] = '', response_code: Optional[int] = None, response_body: Optional[bytes] = None)

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabCancelError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabCancelError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabRetryError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

exception gitlab.exceptions.GitlabPromoteError(error_message: Union[str, bytes] = '', response_code: Optional[int] = None, response_body: Optional[bytes] = None)

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabOperationError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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

Bases: gitlab.exceptions.GitlabError

Parameters

  • error_message (Union[str, bytes]) –

  • response_code (Optional[int]) –

  • response_body (Optional[bytes]) –

Return type

None

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 exceptions raise specialized exceptions instead.

Parameters

  • GitlabError (The exception type to raise -- must inherit from) –

  • error (Type[Exception]) –

Return type

Callable[[gitlab.exceptions.__F], gitlab.exceptions.__F]

gitlab.mixins module

class gitlab.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)

  • kwargs (Any) –

Raises
Return type

None

manager: gitlab.base.RESTManager
class gitlab.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)

  • kwargs (Any) –

Raises
Returns

The rendering properties

Return type

Dict[str, Any]

class gitlab.mixins.CRUDMixin

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

gitlab: gitlab.client.Gitlab
class gitlab.mixins.CreateMixin

Bases: object

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

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – parameters to send to the server to create the resource

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

  • kwargs (Any) –

Returns

A new instance of the managed object class built with

the data sent by the server

Raises
Return type

gitlab.base.RESTObject

gitlab: gitlab.client.Gitlab
class gitlab.mixins.DeleteMixin

Bases: object

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

Delete an object on the server.

Parameters

  • id (Union[str, int]) – ID of the object to delete

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

  • kwargs (Any) –

Raises
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.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 of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

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

  • kwargs (Any) –

Raises
Returns

The blob content if streamed is False, None otherwise

Return type

Optional[bytes]

manager: gitlab.base.RESTManager
class gitlab.mixins.GetMixin

Bases: object

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

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

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

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

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.base.RESTObject

gitlab: gitlab.client.Gitlab
class gitlab.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)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.base.RESTObject]

gitlab: gitlab.client.Gitlab
class gitlab.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 – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

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

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

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

  • kwargs (Any) –

Returns

The list of objects, or a generator if as_list is False

Raises
Return type

Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]

class gitlab.mixins.NoUpdateMixin

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

gitlab: gitlab.client.Gitlab
class gitlab.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)

  • kwargs (Any) –

Raises
Return type

None

manager: gitlab.base.RESTManager
class gitlab.mixins.ParticipantsMixin

Bases: object

manager: gitlab.base.RESTManager
participants(**kwargs: Any) → Dict[str, Any]

List the participants.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

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

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

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

  • kwargs (Any) –

Raises
Returns

The list of participants

Return type

Dict[str, Any]

class gitlab.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)

  • kwargs (Any) –

Return type

None

Returns None (updates the object)

Raises
Parameters

kwargs (Any) –

Return type

None

class gitlab.mixins.RetrieveMixin

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

gitlab: gitlab.client.Gitlab
class gitlab.mixins.SaveMixin

Bases: object

Mixin for RESTObject’s that can be updated.

manager: gitlab.base.RESTManager
save(**kwargs: Any) → Optional[Dict[str, Any]]

Save the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

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

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Optional[Dict[str, Any]]

class gitlab.mixins.SetMixin

Bases: object

gitlab: gitlab.client.Gitlab
set(key: str, value: str, **kwargs: Any) → gitlab.base.RESTObject

Create or update the object.

Parameters

  • key (str) – The key of the object to create/update

  • value (str) – The value to set for the object

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

  • kwargs (Any) –

Raises
Returns

The created/updated attribute

Return type

gitlab.base.RESTObject

class gitlab.mixins.SubscribableMixin

Bases: object

manager: gitlab.base.RESTManager
subscribe(**kwargs: Any) → None

Subscribe to the object notifications.

Parameters

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

  • kwargs (Any) –

Raises
Return type

None

unsubscribe(**kwargs: Any) → None

Unsubscribe from the object notifications.

Parameters

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

  • kwargs (Any) –

Raises
Return type

None

class gitlab.mixins.TimeTrackingMixin

Bases: object

add_spent_time(duration: str, **kwargs: Any) → Dict[str, Any]

Add time spent working on the object.

Parameters

  • duration (str) – Duration in human format (e.g. 3h30)

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

manager: gitlab.base.RESTManager
reset_spent_time(**kwargs: Any) → Dict[str, Any]

Resets the time spent working on the object.

Parameters

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

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

Resets estimated time for the object to 0 seconds.

Parameters

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

time_estimate(duration: str, **kwargs: Any) → Dict[str, Any]

Set an estimated time of work for the object.

Parameters

  • duration (str) – Duration in human format (e.g. 3h30)

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

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

Get time stats for the object.

Parameters

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

class gitlab.mixins.TodoMixin

Bases: object

manager: gitlab.base.RESTManager
todo(**kwargs: Any) → None

Create a todo associated to the object.

Parameters

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

  • kwargs (Any) –

Raises
Return type

None

class gitlab.mixins.UpdateMixin

Bases: object

gitlab: gitlab.client.Gitlab
update(id: Optional[Union[int, str]] = None, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any) → Dict[str, Any]

Update an object on the server.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to update (can be None if not required)

  • new_data (Optional[Dict[str, Any]]) – the update data for the object

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

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.mixins.UserAgentDetailMixin

Bases: object

manager: gitlab.base.RESTManager
user_agent_detail(**kwargs: Any) → Dict[str, Any]

Get the user agent detail.

Parameters

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

  • kwargs (Any) –

Raises
Return type

Dict[str, Any]

gitlab.utils module

class gitlab.utils.EncodedId(value: Union[str, int, gitlab.utils.EncodedId])

Bases: str

A custom str class that will return the URL-encoded value of the string.

  • Using it recursively will only url-encode the value once.

  • Can accept either str or int as input value.

  • Can be used in an f-string and output the URL-encoded string.

Reference to documentation on why this is necessary.

See:

https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding
https://docs.gitlab.com/ee/api/index.html#path-parameters
Parameters

value (Union[str, int, EncodedId]) –

Return type

Union[int, EncodedId]

gitlab.utils.copy_dict(dest: Dict[str, Any], src: Dict[str, Any]) → None
Parameters

  • dest (Dict[str, Any]) –

  • src (Dict[str, Any]) –

Return type

None

gitlab.utils.remove_none_from_dict(data: Dict[str, Any]) → Dict[str, Any]
Parameters

data (Dict[str, Any]) –

Return type

Dict[str, Any]

gitlab.utils.response_content(response: requests.models.Response, streamed: bool, action: Optional[Callable], chunk_size: int) → Optional[bytes]
Parameters

  • response (requests.models.Response) –

  • streamed (bool) –

  • action (Optional[Callable]) –

  • chunk_size (int) –

Return type

Optional[bytes]