././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.326791 python-gitlab-3.13.0/0000755000000000000000000000000014366036463013130 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/AUTHORS0000644000000000000000000000101614366036457014201 0ustar00rootrootAuthors / Maintainers --------------------- Original creator, no longer active ================================== Gauvain Pocentek Current Maintainers =================== John L. Villalovos Max Wittig Nejc Habjan Roger Meier Contributors ------------ Significant contributor, 2014 ============================= Mika Mäenpää See ``git log`` for a full list of contributors. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/CHANGELOG.md0000644000000000000000000023657614366036457014767 0ustar00rootroot# Changelog ## v3.13.0 (2023-01-30) ### Feature * **group:** Add support for group restore API ([`9322db6`](https://github.com/python-gitlab/python-gitlab/commit/9322db663ecdaecf399e3192810d973c6a9a4020)) * **client:** Automatically retry on HTTP 409 Resource lock ([`dced76a`](https://github.com/python-gitlab/python-gitlab/commit/dced76a9900c626c9f0b90b85a5e371101a24fb4)) * **api:** Add support for bulk imports API ([`043de2d`](https://github.com/python-gitlab/python-gitlab/commit/043de2d265e0e5114d1cd901f82869c003413d9b)) * **api:** Add support for resource groups ([`5f8b8f5`](https://github.com/python-gitlab/python-gitlab/commit/5f8b8f5be901e944dfab2257f9e0cc4b2b1d2cd5)) * **api:** Support listing pipelines triggered by pipeline schedules ([`865fa41`](https://github.com/python-gitlab/python-gitlab/commit/865fa417a20163b526596549b9afbce679fc2817)) * Allow filtering pipelines by source ([`b6c0872`](https://github.com/python-gitlab/python-gitlab/commit/b6c08725042380d20ef5f09979bc29f2f6c1ab6f)) * **client:** Bootstrap the http backends concept ([#2391](https://github.com/python-gitlab/python-gitlab/issues/2391)) ([`91a665f`](https://github.com/python-gitlab/python-gitlab/commit/91a665f331c3ffc260db3470ad71fde0d3b56aa2)) * Add resource iteration events (see https://docs.gitlab.com/ee/api/resource_iteration_events.html) ([`ef5feb4`](https://github.com/python-gitlab/python-gitlab/commit/ef5feb4d07951230452a2974da729a958bdb9d6a)) * Allow passing kwargs to Gitlab class when instantiating with `from_config` ([#2392](https://github.com/python-gitlab/python-gitlab/issues/2392)) ([`e88d34e`](https://github.com/python-gitlab/python-gitlab/commit/e88d34e38dd930b00d7bb48f0e1c39420e09fa0f)) * Add keep_base_url when getting configuration from file ([`50a0301`](https://github.com/python-gitlab/python-gitlab/commit/50a03017f2ba8ec3252911dd1cf0ed7df42cfe50)) ### Fix * **client:** Regression - do not automatically get_next if page=# and ([`585e3a8`](https://github.com/python-gitlab/python-gitlab/commit/585e3a86c4cafa9ee73ed38676a78f3c34dbe6b2)) * Change return value to "None" in case getattr returns None to prevent error ([`3f86d36`](https://github.com/python-gitlab/python-gitlab/commit/3f86d36218d80b293b346b37f8be5efa6455d10c)) * **deps:** Bump requests-toolbelt to fix deprecation warning ([`faf842e`](https://github.com/python-gitlab/python-gitlab/commit/faf842e97d4858ff5ebd8ae6996e0cb3ca29881c)) * Use the ProjectIterationManager within the Project object ([`44f05dc`](https://github.com/python-gitlab/python-gitlab/commit/44f05dc017c5496e14db82d9650c6a0110b95cf9)) * **api:** Make description optional for releases ([`5579750`](https://github.com/python-gitlab/python-gitlab/commit/5579750335245011a3acb9456cb488f0fa1cda61)) ### Documentation * **faq:** Describe and group common errors ([`4c9a072`](https://github.com/python-gitlab/python-gitlab/commit/4c9a072b053f12f8098e4ea6fc47e3f6ab4f8b07)) ## v3.12.0 (2022-11-28) ### Feature * Add support for SAML group links ([#2367](https://github.com/python-gitlab/python-gitlab/issues/2367)) ([`1020ce9`](https://github.com/python-gitlab/python-gitlab/commit/1020ce965ff0cd3bfc283d4f0ad40e41e4d1bcee)) * **groups:** Add LDAP link manager and deprecate old API endpoints ([`3a61f60`](https://github.com/python-gitlab/python-gitlab/commit/3a61f601adaec7751cdcfbbcb88aa544326b1730)) * **groups:** Add support for listing ldap_group_links ([#2371](https://github.com/python-gitlab/python-gitlab/issues/2371)) ([`ad7c8fa`](https://github.com/python-gitlab/python-gitlab/commit/ad7c8fafd56866002aa6723ceeba4c4bc071ca0d)) * Implement secure files API ([`d0a0348`](https://github.com/python-gitlab/python-gitlab/commit/d0a034878fabfd8409134aa8b7ffeeb40219683c)) * **ci:** Re-Run Tests on PR Comment workflow ([`034cde3`](https://github.com/python-gitlab/python-gitlab/commit/034cde31c7017923923be29c3f34783937febc0f)) * **api:** Add support for getting a project's pull mirror details ([`060cfe1`](https://github.com/python-gitlab/python-gitlab/commit/060cfe1465a99657c5f832796ab3aa03aad934c7)) * **api:** Add support for remote project import from AWS S3 ([#2357](https://github.com/python-gitlab/python-gitlab/issues/2357)) ([`892281e`](https://github.com/python-gitlab/python-gitlab/commit/892281e35e3d81c9e43ff6a974f920daa83ea8b2)) * **api:** Add support for remote project import ([#2348](https://github.com/python-gitlab/python-gitlab/issues/2348)) ([`e5dc72d`](https://github.com/python-gitlab/python-gitlab/commit/e5dc72de9b3cdf0a7944ee0961fbdc6784c7f315)) * **api:** Add application statistics ([`6fcf3b6`](https://github.com/python-gitlab/python-gitlab/commit/6fcf3b68be095e614b969f5922ad8a67978cd4db)) ### Fix * **cli:** Enable debug before doing auth ([`65abb85`](https://github.com/python-gitlab/python-gitlab/commit/65abb85be7fc8ef57b295296111dac0a97ed1c49)) * **cli:** Expose missing mr_default_target_self project attribute ([`12aea32`](https://github.com/python-gitlab/python-gitlab/commit/12aea32d1c0f7e6eac0d19da580bf6efde79d3e2)) * Use POST method and return dict in `cancel_merge_when_pipeline_succeeds()` ([#2350](https://github.com/python-gitlab/python-gitlab/issues/2350)) ([`bd82d74`](https://github.com/python-gitlab/python-gitlab/commit/bd82d745c8ea9ff6ff078a4c961a2d6e64a2f63c)) ### Documentation * Use the term "log file" for getting a job log file ([`9d2b1ad`](https://github.com/python-gitlab/python-gitlab/commit/9d2b1ad10aaa78a5c28ece334293641c606291b5)) * **groups:** Describe GitLab.com group creation limitation ([`9bd433a`](https://github.com/python-gitlab/python-gitlab/commit/9bd433a3eb508b53fbca59f3f445da193522646a)) * **api:** Pushrules remove saying `None` is returned when not found ([`c3600b4`](https://github.com/python-gitlab/python-gitlab/commit/c3600b49e4d41b1c4f2748dd6f2a331c331d8706)) ## v3.11.0 (2022-10-28) ### Feature * **build:** Officially support Python 3.11 ([`74f66c7`](https://github.com/python-gitlab/python-gitlab/commit/74f66c71f3974cf68f5038f4fc3995e53d44aebe)) * **api:** Add support for topics merge API ([`9a6d197`](https://github.com/python-gitlab/python-gitlab/commit/9a6d197f9d2a88bdba8dab1f9abaa4e081a14792)) ### Fix * Remove `project.approvals.set_approvals()` method ([`91f08f0`](https://github.com/python-gitlab/python-gitlab/commit/91f08f01356ca5e38d967700a5da053f05b6fab0)) * Use epic id instead of iid for epic notes ([`97cae38`](https://github.com/python-gitlab/python-gitlab/commit/97cae38a315910972279f2d334e91fa54d9ede0c)) * **cli:** Handle list response for json/yaml output ([`9b88132`](https://github.com/python-gitlab/python-gitlab/commit/9b88132078ed37417c2a45369b4976c9c67f7882)) * Intermittent failure in test_merge_request_reset_approvals ([`3dde36e`](https://github.com/python-gitlab/python-gitlab/commit/3dde36eab40406948adca633f7197beb32b29552)) ### Documentation * **advanced:** Add hint on type narrowing ([`a404152`](https://github.com/python-gitlab/python-gitlab/commit/a40415290923d69d087dd292af902efbdfb5c258)) * Add minimal docs about the `enable_debug()` method ([`b4e9ab7`](https://github.com/python-gitlab/python-gitlab/commit/b4e9ab7ee395e575f17450c2dc0d519f7192e58e)) * **commits:** Fix commit create example for binary content ([`bcc1eb4`](https://github.com/python-gitlab/python-gitlab/commit/bcc1eb4571f76b3ca0954adb5525b26f05958e3f)) * **readme:** Add a basic feature list ([`b4d53f1`](https://github.com/python-gitlab/python-gitlab/commit/b4d53f1abb264cd9df8e4ac6560ab0895080d867)) * **api:** Describe use of lower-level methods ([`b7a6874`](https://github.com/python-gitlab/python-gitlab/commit/b7a687490d2690e6bd4706391199135e658e1dc6)) * **api:** Describe the list() and all() runners' functions ([`b6cc3f2`](https://github.com/python-gitlab/python-gitlab/commit/b6cc3f255532521eb259b42780354e03ce51458e)) * **api:** Update `merge_requests.rst`: `mr_id` to `mr_iid` ([`b32234d`](https://github.com/python-gitlab/python-gitlab/commit/b32234d1f8c4492b6b2474f91be9479ad23115bb)) ## v3.10.0 (2022-09-28) ### Feature * Add reset_approvals api ([`88693ff`](https://github.com/python-gitlab/python-gitlab/commit/88693ff2d6f4eecf3c79d017df52738886e2d636)) * Add support for deployment approval endpoint ([`9c9eeb9`](https://github.com/python-gitlab/python-gitlab/commit/9c9eeb901b1f3acd3fb0c4f24014ae2ed7c975ec)) ### Fix * **cli:** Add missing attributes for creating MRs ([`1714d0a`](https://github.com/python-gitlab/python-gitlab/commit/1714d0a980afdb648d203751dedf95ee95ac326e)) * **cli:** Add missing attribute for MR changes ([`20c46a0`](https://github.com/python-gitlab/python-gitlab/commit/20c46a0572d962f405041983e38274aeb79a12e4)) ## v3.9.0 (2022-08-28) ### Feature * Add support for merge_base API ([`dd4fbd5`](https://github.com/python-gitlab/python-gitlab/commit/dd4fbd5e43adbbc502624a8de0d30925d798dec0)) ## v3.8.1 (2022-08-10) ### Fix * **client:** Do not assume user attrs returned for auth() ([`a07547c`](https://github.com/python-gitlab/python-gitlab/commit/a07547cba981380935966dff2c87c2c27d6b18d9)) ## v3.8.0 (2022-08-04) ### Feature * **client:** Warn user on misconfigured URL in `auth()` ([`0040b43`](https://github.com/python-gitlab/python-gitlab/commit/0040b4337bae815cfe1a06f8371a7a720146f271)) * Support downloading archive subpaths ([`cadb0e5`](https://github.com/python-gitlab/python-gitlab/commit/cadb0e55347cdac149e49f611c99b9d53a105520)) ### Fix * **client:** Ensure encoded query params are never duplicated ([`1398426`](https://github.com/python-gitlab/python-gitlab/commit/1398426cd748fdf492fe6184b03ac2fcb7e4fd6e)) * Optionally keep user-provided base URL for pagination ([#2149](https://github.com/python-gitlab/python-gitlab/issues/2149)) ([`e2ea8b8`](https://github.com/python-gitlab/python-gitlab/commit/e2ea8b89a7b0aebdb1eb3b99196d7c0034076df8)) ### Documentation * Describe self-revoking personal access tokens ([`5ea48fc`](https://github.com/python-gitlab/python-gitlab/commit/5ea48fc3c28f872dd1184957a6f2385da075281c)) ## v3.7.0 (2022-07-28) ### Feature * Allow sort/ordering for project releases ([`b1dd284`](https://github.com/python-gitlab/python-gitlab/commit/b1dd284066b4b94482b9d41310ac48b75bcddfee)) * **cli:** Add a custom help formatter ([`005ba93`](https://github.com/python-gitlab/python-gitlab/commit/005ba93074d391f818c39e46390723a0d0d16098)) * Add support for iterations API ([`194ee01`](https://github.com/python-gitlab/python-gitlab/commit/194ee0100c2868c1a9afb161c15f3145efb01c7c)) * **groups:** Add support for shared projects API ([`66461ba`](https://github.com/python-gitlab/python-gitlab/commit/66461ba519a85bfbd3cba284a0c8de11a3ac7cde)) * **issues:** Add support for issue reorder API ([`8703324`](https://github.com/python-gitlab/python-gitlab/commit/8703324dc21a30757e15e504b7d20472f25d2ab9)) * **namespaces:** Add support for namespace existence API ([`4882cb2`](https://github.com/python-gitlab/python-gitlab/commit/4882cb22f55c41d8495840110be2d338b5545a04)) * Add support for group and project invitations API ([`7afd340`](https://github.com/python-gitlab/python-gitlab/commit/7afd34027a26b5238a979e3303d8e5d8a0320a07)) * **projects:** Add support for project restore API ([`4794ecc`](https://github.com/python-gitlab/python-gitlab/commit/4794ecc45d7aa08785c622918d08bb046e7359ae)) * Add support for filtering jobs by scope ([`0e1c0dd`](https://github.com/python-gitlab/python-gitlab/commit/0e1c0dd795886ae4741136e64c33850b164084a1)) * Add `asdict()` and `to_json()` methods to Gitlab Objects ([`08ac071`](https://github.com/python-gitlab/python-gitlab/commit/08ac071abcbc28af04c0fa655576e25edbdaa4e2)) * **api:** Add support for instance-level registry repositories ([`284d739`](https://github.com/python-gitlab/python-gitlab/commit/284d73950ad5cf5dfbdec2f91152ed13931bd0ee)) * **groups:** Add support for group-level registry repositories ([`70148c6`](https://github.com/python-gitlab/python-gitlab/commit/70148c62a3aba16dd8a9c29f15ed16e77c01a247)) * Add 'merge_pipelines_enabled' project attribute ([`fc33c93`](https://github.com/python-gitlab/python-gitlab/commit/fc33c934d54fb94451bd9b9ad65645c9c3d6fe2e)) * Support validating CI lint results ([`3b1ede4`](https://github.com/python-gitlab/python-gitlab/commit/3b1ede4a27cd730982d4c579437c5c689a8799e5)) * **cli:** Add support for global CI lint ([`3f67c4b`](https://github.com/python-gitlab/python-gitlab/commit/3f67c4b0fb0b9a39c8b93529a05b1541fcebcabe)) * **objects:** Add Project CI Lint support ([`b213dd3`](https://github.com/python-gitlab/python-gitlab/commit/b213dd379a4108ab32181b9d3700d2526d950916)) * Add support for group push rules ([`b5cdc09`](https://github.com/python-gitlab/python-gitlab/commit/b5cdc097005c8a48a16e793a69c343198b14e035)) * **api:** Add support for `get` for a MR approval rule ([`89c18c6`](https://github.com/python-gitlab/python-gitlab/commit/89c18c6255ec912db319f73f141b47ace87a713b)) ### Fix * Support array types for most resources ([`d9126cd`](https://github.com/python-gitlab/python-gitlab/commit/d9126cd802dd3cfe529fa940300113c4ead3054b)) * Use the [] after key names for array variables in `params` ([`1af44ce`](https://github.com/python-gitlab/python-gitlab/commit/1af44ce8761e6ee8a9467a3e192f6c4d19e5cefe)) * **runners:** Fix listing for /runners/all ([`c6dd57c`](https://github.com/python-gitlab/python-gitlab/commit/c6dd57c56e92abb6184badf4708f5f5e65c6d582)) * **config:** Raise error when gitlab id provided but no config section found ([`1ef7018`](https://github.com/python-gitlab/python-gitlab/commit/1ef70188da1e29cd8ba95bf58c994ba7dd3010c5)) * **config:** Raise error when gitlab id provided but no config file found ([`ac46c1c`](https://github.com/python-gitlab/python-gitlab/commit/ac46c1cb291c03ad14bc76f5f16c9f98f2a5a82d)) * Add `get_all` param (and `--get-all`) to allow passing `all` to API ([`7c71d5d`](https://github.com/python-gitlab/python-gitlab/commit/7c71d5db1199164b3fa9958e3c3bc6ec96efc78d)) * Results returned by `attributes` property to show updates ([`e5affc8`](https://github.com/python-gitlab/python-gitlab/commit/e5affc8749797293c1373c6af96334f194875038)) * Enable epic notes ([`5fc3216`](https://github.com/python-gitlab/python-gitlab/commit/5fc3216788342a2325662644b42e8c249b655ded)) * **cli:** Remove irrelevant MR approval rule list filters ([`0daec5f`](https://github.com/python-gitlab/python-gitlab/commit/0daec5fa1428a56a6a927b133613e8b296248167)) * Ensure path elements are escaped ([`5d9c198`](https://github.com/python-gitlab/python-gitlab/commit/5d9c198769b00c8e7661e62aaf5f930ed32ef829)) ### Documentation * **cli:** Showcase use of token scopes ([`4a6f8d6`](https://github.com/python-gitlab/python-gitlab/commit/4a6f8d67a94a3d104a24081ad1dbad5b2e3d9c3e)) * **projects:** Document export with upload to URL ([`03f5484`](https://github.com/python-gitlab/python-gitlab/commit/03f548453d84d99354aae7b638f5267e5d751c59)) * Describe fetching existing export status ([`9c5b8d5`](https://github.com/python-gitlab/python-gitlab/commit/9c5b8d54745a58b9fe72ba535b7868d1510379c0)) * **authors:** Add John ([`e2afb84`](https://github.com/python-gitlab/python-gitlab/commit/e2afb84dc4a259e8f40b7cc83e56289983c7db47)) * Document CI Lint usage ([`d5de4b1`](https://github.com/python-gitlab/python-gitlab/commit/d5de4b1fe38bedc07862bd9446dfd48b92cb078d)) * **users:** Add docs about listing a user's projects ([`065a1a5`](https://github.com/python-gitlab/python-gitlab/commit/065a1a5a32d34286df44800084285b30b934f911)) * Update return type of pushrules ([`53cbecc`](https://github.com/python-gitlab/python-gitlab/commit/53cbeccd581318ce4ff6bec0acf3caf935bda0cf)) * Describe ROPC flow in place of password authentication ([`91c17b7`](https://github.com/python-gitlab/python-gitlab/commit/91c17b704f51e9a06b241d549f9a07a19c286118)) * **readme:** Remove redundant `-v` that breaks the command ([`c523e18`](https://github.com/python-gitlab/python-gitlab/commit/c523e186cc48f6bcac5245e3109b50a3852d16ef)) ## v3.6.0 (2022-06-28) ### Feature * **downloads:** Allow streaming downloads access to response iterator ([#1956](https://github.com/python-gitlab/python-gitlab/issues/1956)) ([`b644721`](https://github.com/python-gitlab/python-gitlab/commit/b6447211754e126f64e12fc735ad74fe557b7fb4)) * **api:** Support head() method for get and list endpoints ([`ce9216c`](https://github.com/python-gitlab/python-gitlab/commit/ce9216ccc542d834be7f29647c7ee98c2ca5bb01)) * **api:** Implement HEAD method ([`90635a7`](https://github.com/python-gitlab/python-gitlab/commit/90635a7db3c9748745471d2282260418e31c7797)) * **users:** Add approve and reject methods to User ([`f57139d`](https://github.com/python-gitlab/python-gitlab/commit/f57139d8f1dafa6eb19d0d954b3634c19de6413c)) * **api:** Convert gitlab.const to Enums ([`c3c6086`](https://github.com/python-gitlab/python-gitlab/commit/c3c6086c548c03090ccf3f59410ca3e6b7999791)) * Add support for Protected Environments ([`1dc9d0f`](https://github.com/python-gitlab/python-gitlab/commit/1dc9d0f91757eed9f28f0c7172654b9b2a730216)) * **users:** Add ban and unban methods ([`0d44b11`](https://github.com/python-gitlab/python-gitlab/commit/0d44b118f85f92e7beb1a05a12bdc6e070dce367)) * **docker:** Provide a Debian-based slim image ([`384031c`](https://github.com/python-gitlab/python-gitlab/commit/384031c530e813f55da52f2b2c5635ea935f9d91)) * Support mutually exclusive attributes and consolidate validation to fix board lists ([#2037](https://github.com/python-gitlab/python-gitlab/issues/2037)) ([`3fa330c`](https://github.com/python-gitlab/python-gitlab/commit/3fa330cc341bbedb163ba757c7f6578d735c6efb)) * **client:** Introduce `iterator=True` and deprecate `as_list=False` in `list()` ([`cdc6605`](https://github.com/python-gitlab/python-gitlab/commit/cdc6605767316ea59e1e1b849683be7b3b99e0ae)) ### Fix * **base:** Do not fail repr() on lazy objects ([`1efb123`](https://github.com/python-gitlab/python-gitlab/commit/1efb123f63eab57600228b75a1744f8787c16671)) * **cli:** Project-merge-request-approval-rule ([`15a242c`](https://github.com/python-gitlab/python-gitlab/commit/15a242c3303759b77b380c5b3ff9d1e0bf2d800c)) * **cli:** Fix project export download for CLI ([`5d14867`](https://github.com/python-gitlab/python-gitlab/commit/5d1486785793b02038ac6f527219801744ee888b)) ### Documentation * **api:** Add separate section for advanced usage ([`22ae101`](https://github.com/python-gitlab/python-gitlab/commit/22ae1016f39256b8e2ca02daae8b3c7130aeb8e6)) * **api:** Document usage of head() methods ([`f555bfb`](https://github.com/python-gitlab/python-gitlab/commit/f555bfb363779cc6c8f8036f6d6cfa302e15d4fe)) * **projects:** Provide more detailed import examples ([`8f8611a`](https://github.com/python-gitlab/python-gitlab/commit/8f8611a1263b8c19fd19ce4a904a310b0173b6bf)) * **projects:** Document 404 gotcha with unactivated integrations ([`522ecff`](https://github.com/python-gitlab/python-gitlab/commit/522ecffdb6f07e6c017139df4eb5d3fc42a585b7)) * **variables:** Instruct users to follow GitLab rules for values ([`194b6be`](https://github.com/python-gitlab/python-gitlab/commit/194b6be7ccec019fefc04754f98b9ec920c29568)) * **api:** Stop linking to python-requests.org ([`49c7e83`](https://github.com/python-gitlab/python-gitlab/commit/49c7e83f768ee7a3fec19085a0fa0a67eadb12df)) * **api:** Fix incorrect docs for merge_request_approvals ([#2094](https://github.com/python-gitlab/python-gitlab/issues/2094)) ([`5583eaa`](https://github.com/python-gitlab/python-gitlab/commit/5583eaa108949386c66290fecef4d064f44b9e83)) * **api-usage:** Add import os in example ([`2194a44`](https://github.com/python-gitlab/python-gitlab/commit/2194a44be541e9d2c15d3118ba584a4a173927a2)) * Drop deprecated setuptools build_sphinx ([`048d66a`](https://github.com/python-gitlab/python-gitlab/commit/048d66af51cef385b22d223ed2a5cd30e2256417)) * **usage:** Refer to upsteam docs instead of custom attributes ([`ae7d3b0`](https://github.com/python-gitlab/python-gitlab/commit/ae7d3b09352b2a1bd287f95d4587b04136c7a4ed)) * **ext:** Fix rendering for RequiredOptional dataclass ([`4d431e5`](https://github.com/python-gitlab/python-gitlab/commit/4d431e5a6426d0fd60945c2d1ff00a00a0a95b6c)) * Documentation updates to reflect addition of mutually exclusive attributes ([`24b720e`](https://github.com/python-gitlab/python-gitlab/commit/24b720e49636044f4be7e4d6e6ce3da341f2aeb8)) * Use `as_list=False` or `all=True` in Getting started ([`de8c6e8`](https://github.com/python-gitlab/python-gitlab/commit/de8c6e80af218d93ca167f8b5ff30319a2781d91)) ## v3.5.0 (2022-05-28) ### Feature * **objects:** Support get project storage endpoint ([`8867ee5`](https://github.com/python-gitlab/python-gitlab/commit/8867ee59884ae81d6457ad6e561a0573017cf6b2)) * Display human-readable attribute in `repr()` if present ([`6b47c26`](https://github.com/python-gitlab/python-gitlab/commit/6b47c26d053fe352d68eb22a1eaf4b9a3c1c93e7)) * **ux:** Display project.name_with_namespace on project repr ([`e598762`](https://github.com/python-gitlab/python-gitlab/commit/e5987626ca1643521b16658555f088412be2a339)) ### Fix * **cli:** Changed default `allow_abbrev` value to fix arguments collision problem ([#2013](https://github.com/python-gitlab/python-gitlab/issues/2013)) ([`d68cacf`](https://github.com/python-gitlab/python-gitlab/commit/d68cacfeda5599c62a593ecb9da2505c22326644)) * Duplicate subparsers being added to argparse ([`f553fd3`](https://github.com/python-gitlab/python-gitlab/commit/f553fd3c79579ab596230edea5899dc5189b0ac6)) ### Documentation * Update issue example and extend API usage docs ([`aad71d2`](https://github.com/python-gitlab/python-gitlab/commit/aad71d282d60dc328b364bcc951d0c9b44ab13fa)) * **CONTRIBUTING.rst:** Fix link to conventional-changelog commit format documentation ([`2373a4f`](https://github.com/python-gitlab/python-gitlab/commit/2373a4f13ee4e5279a424416cdf46782a5627067)) * Add missing Admin access const value ([`3e0d4d9`](https://github.com/python-gitlab/python-gitlab/commit/3e0d4d9006e2ca6effae2b01cef3926dd0850e52)) * **merge_requests:** Add new possible merge request state and link to the upstream docs ([`e660fa8`](https://github.com/python-gitlab/python-gitlab/commit/e660fa8386ed7783da5c076bc0fef83e6a66f9a8)) ## v3.4.0 (2022-04-28) ### Feature * Emit a warning when using a `list()` method returns max ([`1339d64`](https://github.com/python-gitlab/python-gitlab/commit/1339d645ce58a2e1198b898b9549ba5917b1ff12)) * **objects:** Support getting project/group deploy tokens by id ([`fcd37fe`](https://github.com/python-gitlab/python-gitlab/commit/fcd37feff132bd5b225cde9d5f9c88e62b3f1fd6)) * **user:** Support getting user SSH key by id ([`6f93c05`](https://github.com/python-gitlab/python-gitlab/commit/6f93c0520f738950a7c67dbeca8d1ac8257e2661)) * **api:** Re-add topic delete endpoint ([`d1d96bd`](https://github.com/python-gitlab/python-gitlab/commit/d1d96bda5f1c6991c8ea61dca8f261e5b74b5ab6)) ### Fix * Add ChunkedEncodingError to list of retryable exceptions ([`7beb20f`](https://github.com/python-gitlab/python-gitlab/commit/7beb20ff7b7b85fb92fc6b647d9c1bdb7568f27c)) * Avoid passing redundant arguments to API ([`3431887`](https://github.com/python-gitlab/python-gitlab/commit/34318871347b9c563d01a13796431c83b3b1d58c)) * **cli:** Add missing filters for project commit list ([`149d244`](https://github.com/python-gitlab/python-gitlab/commit/149d2446fcc79b31d3acde6e6d51adaf37cbb5d3)) * Add 52x range to retry transient failures and tests ([`c3ef1b5`](https://github.com/python-gitlab/python-gitlab/commit/c3ef1b5c1eaf1348a18d753dbf7bda3c129e3262)) * Also retry HTTP-based transient errors ([`3b49e4d`](https://github.com/python-gitlab/python-gitlab/commit/3b49e4d61e6f360f1c787aa048edf584aec55278)) ### Documentation * **api-docs:** Docs fix for application scopes ([`e1ad93d`](https://github.com/python-gitlab/python-gitlab/commit/e1ad93df90e80643866611fe52bd5c59428e7a88)) ## v3.3.0 (2022-03-28) ### Feature * **object:** Add pipeline test report summary support ([`a97e0cf`](https://github.com/python-gitlab/python-gitlab/commit/a97e0cf81b5394b3a2b73d927b4efe675bc85208)) ### Fix * Support RateLimit-Reset header ([`4060146`](https://github.com/python-gitlab/python-gitlab/commit/40601463c78a6f5d45081700164899b2559b7e55)) ### Documentation * Fix typo and incorrect style ([`2828b10`](https://github.com/python-gitlab/python-gitlab/commit/2828b10505611194bebda59a0e9eb41faf24b77b)) * Add pipeline test report summary support ([`d78afb3`](https://github.com/python-gitlab/python-gitlab/commit/d78afb36e26f41d727dee7b0952d53166e0df850)) * **chore:** Include docs .js files in sdist ([`3010b40`](https://github.com/python-gitlab/python-gitlab/commit/3010b407bc9baabc6cef071507e8fa47c0f1624d)) ## v3.2.0 (2022-02-28) ### Feature * **merge_request_approvals:** Add support for deleting MR approval rules ([`85a734f`](https://github.com/python-gitlab/python-gitlab/commit/85a734fec3111a4a5c4f0ddd7cb36eead96215e9)) * **artifacts:** Add support for project artifacts delete API ([`c01c034`](https://github.com/python-gitlab/python-gitlab/commit/c01c034169789e1d20fd27a0f39f4c3c3628a2bb)) * **mixins:** Allow deleting resources without IDs ([`0717517`](https://github.com/python-gitlab/python-gitlab/commit/0717517212b616cfd52cfd38dd5c587ff8f9c47c)) * **objects:** Add a complete artifacts manager ([`c8c2fa7`](https://github.com/python-gitlab/python-gitlab/commit/c8c2fa763558c4d9906e68031a6602e007fec930)) ### Fix * **services:** Use slug for id_attr instead of custom methods ([`e30f39d`](https://github.com/python-gitlab/python-gitlab/commit/e30f39dff5726266222b0f56c94f4ccfe38ba527)) * Remove custom `delete` method for labels ([`0841a2a`](https://github.com/python-gitlab/python-gitlab/commit/0841a2a686c6808e2f3f90960e529b26c26b268f)) ### Documentation * Enable gitter chat directly in docs ([`bd1ecdd`](https://github.com/python-gitlab/python-gitlab/commit/bd1ecdd5ad654b01b34e7a7a96821cc280b3ca67)) * Add delete methods for runners and project artifacts ([`5e711fd`](https://github.com/python-gitlab/python-gitlab/commit/5e711fdb747fb3dcde1f5879c64dfd37bf25f3c0)) * Add retry_transient infos ([`bb1f054`](https://github.com/python-gitlab/python-gitlab/commit/bb1f05402887c78f9898fbd5bd66e149eff134d9)) * Add transient errors retry info ([`b7a1266`](https://github.com/python-gitlab/python-gitlab/commit/b7a126661175a3b9b73dbb4cb88709868d6d871c)) * **artifacts:** Deprecate artifacts() and artifact() methods ([`64d01ef`](https://github.com/python-gitlab/python-gitlab/commit/64d01ef23b1269b705350106d8ddc2962a780dce)) * Revert "chore: add temporary banner for v3" ([#1864](https://github.com/python-gitlab/python-gitlab/issues/1864)) ([`7a13b9b`](https://github.com/python-gitlab/python-gitlab/commit/7a13b9bfa4aead6c731f9a92e0946dba7577c61b)) ## v3.1.1 (2022-01-28) ### Fix * **cli:** Make 'per_page' and 'page' type explicit ([`d493a5e`](https://github.com/python-gitlab/python-gitlab/commit/d493a5e8685018daa69c92e5942cbe763e5dac62)) * **cli:** Make 'timeout' type explicit ([`bbb7df5`](https://github.com/python-gitlab/python-gitlab/commit/bbb7df526f4375c438be97d8cfa0d9ea9d604e7d)) * **cli:** Allow custom methods in managers ([`8dfed0c`](https://github.com/python-gitlab/python-gitlab/commit/8dfed0c362af2c5e936011fd0b488b8b05e8a8a0)) * **objects:** Make resource access tokens and repos available in CLI ([`e0a3a41`](https://github.com/python-gitlab/python-gitlab/commit/e0a3a41ce60503a25fa5c26cf125364db481b207)) ### Documentation * Enhance release docs for CI_JOB_TOKEN usage ([`5d973de`](https://github.com/python-gitlab/python-gitlab/commit/5d973de8a5edd08f38031cf9be2636b0e12f008d)) * **changelog:** Add missing changelog items ([`01755fb`](https://github.com/python-gitlab/python-gitlab/commit/01755fb56a5330aa6fa4525086e49990e57ce50b)) ## v3.1.0 (2022-01-14) ### Feature * add support for Group Access Token API ([`c01b7c4`](https://github.com/python-gitlab/python-gitlab/commit/c01b7c494192c5462ec673848287ef2a5c9bd737)) * Add support for Groups API method `transfer()` ([`0007006`](https://github.com/python-gitlab/python-gitlab/commit/0007006c184c64128caa96b82dafa3db0ea1101f)) * **api:** Add `project.transfer()` and deprecate `transfer_project()` ([`259668a`](https://github.com/python-gitlab/python-gitlab/commit/259668ad8cb54348e4a41143a45f899a222d2d35)) * **api:** Return result from `SaveMixin.save()` ([`e6258a4`](https://github.com/python-gitlab/python-gitlab/commit/e6258a4193a0e8d0c3cf48de15b926bebfa289f3)) ### Fix * **cli:** Add missing list filters for environments ([`6f64d40`](https://github.com/python-gitlab/python-gitlab/commit/6f64d4098ed4a890838c6cf43d7a679e6be4ac6c)) * Use url-encoded ID in all paths ([`12435d7`](https://github.com/python-gitlab/python-gitlab/commit/12435d74364ca881373d690eab89d2e2baa62a49)) * **members:** Use new *All objects for *AllManager managers ([`755e0a3`](https://github.com/python-gitlab/python-gitlab/commit/755e0a32e8ca96a3a3980eb7d7346a1a899ad58b)) * **api:** Services: add missing `lazy` parameter ([`888f332`](https://github.com/python-gitlab/python-gitlab/commit/888f3328d3b1c82a291efbdd9eb01f11dff0c764)) * broken URL for FAQ about attribute-error-list ([`1863f30`](https://github.com/python-gitlab/python-gitlab/commit/1863f30ea1f6fb7644b3128debdbb6b7bb218836)) * remove default arguments for mergerequests.merge() ([`8e589c4`](https://github.com/python-gitlab/python-gitlab/commit/8e589c43fa2298dc24b97423ffcc0ce18d911e3b)) * remove custom URL encoding ([`3d49e5e`](https://github.com/python-gitlab/python-gitlab/commit/3d49e5e6a2bf1c9a883497acb73d7ce7115b804d)) ### Documentation * **cli:** make examples more easily navigable by generating TOC ([`f33c523`](https://github.com/python-gitlab/python-gitlab/commit/f33c5230cb25c9a41e9f63c0846c1ecba7097ee7)) * update project access token API reference link ([`73ae955`](https://github.com/python-gitlab/python-gitlab/commit/73ae9559dc7f4fba5c80862f0f253959e60f7a0c)) ## v3.0.0 (2022-01-05) ### Feature * **docker:** Remove custom entrypoint from image ([`80754a1`](https://github.com/python-gitlab/python-gitlab/commit/80754a17f66ef4cd8469ff0857e0fc592c89796d)) * **cli:** Allow options from args and environment variables ([`ca58008`](https://github.com/python-gitlab/python-gitlab/commit/ca58008607385338aaedd14a58adc347fa1a41a0)) * **api:** Support file format for repository archive ([`83dcabf`](https://github.com/python-gitlab/python-gitlab/commit/83dcabf3b04af63318c981317778f74857279909)) * Add support for `squash_option` in Projects ([`a246ce8`](https://github.com/python-gitlab/python-gitlab/commit/a246ce8a942b33c5b23ac075b94237da09013fa2)) * **cli:** Do not require config file to run CLI ([`92a893b`](https://github.com/python-gitlab/python-gitlab/commit/92a893b8e230718436582dcad96175685425b1df)) * **api:** Add support for Topics API ([`e7559bf`](https://github.com/python-gitlab/python-gitlab/commit/e7559bfa2ee265d7d664d7a18770b0a3e80cf999)) * Add delete on package_file object ([`124667b`](https://github.com/python-gitlab/python-gitlab/commit/124667bf16b1843ae52e65a3cc9b8d9235ff467e)) * Add support for `projects.groups.list()` ([`68ff595`](https://github.com/python-gitlab/python-gitlab/commit/68ff595967a5745b369a93d9d18fef48b65ebedb)) * **api:** Add support for epic notes ([`7f4edb5`](https://github.com/python-gitlab/python-gitlab/commit/7f4edb53e9413f401c859701d8c3bac4a40706af)) * Remove support for Python 3.6, require 3.7 or higher ([`414009d`](https://github.com/python-gitlab/python-gitlab/commit/414009daebe19a8ae6c36f050dffc690dff40e91)) * **api:** Add project milestone promotion ([`f068520`](https://github.com/python-gitlab/python-gitlab/commit/f0685209f88d1199873c1f27d27f478706908fd3)) * **api:** Add merge trains ([`fd73a73`](https://github.com/python-gitlab/python-gitlab/commit/fd73a738b429be0a2642d5b777d5e56a4c928787)) * **api:** Add merge request approval state ([`f41b093`](https://github.com/python-gitlab/python-gitlab/commit/f41b0937aec5f4a5efba44155cc2db77c7124e5e)) * **api:** Add project label promotion ([`6d7c88a`](https://github.com/python-gitlab/python-gitlab/commit/6d7c88a1fe401d271a34df80943634652195b140)) * **objects:** Support delete package files API ([`4518046`](https://github.com/python-gitlab/python-gitlab/commit/45180466a408cd51c3ea4fead577eb0e1f3fe7f8)) * **objects:** List starred projects of a user ([`47a5606`](https://github.com/python-gitlab/python-gitlab/commit/47a56061421fc8048ee5cceaf47ac031c92aa1da)) * **build:** Officially support and test python 3.10 ([`c042ddc`](https://github.com/python-gitlab/python-gitlab/commit/c042ddc79ea872fc8eb8fe4e32f4107a14ffed2d)) * **objects:** Support Create and Revoke personal access token API ([`e19314d`](https://github.com/python-gitlab/python-gitlab/commit/e19314dcc481b045ba7a12dd76abedc08dbdf032)) * Default to gitlab.com if no URL given ([`8236281`](https://github.com/python-gitlab/python-gitlab/commit/823628153ec813c4490e749e502a47716425c0f1)) * Allow global retry_transient_errors setup ([`3b1d3a4`](https://github.com/python-gitlab/python-gitlab/commit/3b1d3a41da7e7228f3a465d06902db8af564153e)) ### Fix * Handle situation where GitLab does not return values ([`cb824a4`](https://github.com/python-gitlab/python-gitlab/commit/cb824a49af9b0d155b89fe66a4cfebefe52beb7a)) * Stop encoding '.' to '%2E' ([`702e41d`](https://github.com/python-gitlab/python-gitlab/commit/702e41dd0674e76b292d9ea4f559c86f0a99edfe)) * **build:** Do not include docs in wheel package ([`68a97ce`](https://github.com/python-gitlab/python-gitlab/commit/68a97ced521051afb093cf4fb6e8565d9f61f708)) * **api:** Delete invalid 'project-runner get' command ([#1628](https://github.com/python-gitlab/python-gitlab/issues/1628)) ([`905781b`](https://github.com/python-gitlab/python-gitlab/commit/905781bed2afa33634b27842a42a077a160cffb8)) * **api:** Replace deprecated attribute in delete_in_bulk() ([#1536](https://github.com/python-gitlab/python-gitlab/issues/1536)) ([`c59fbdb`](https://github.com/python-gitlab/python-gitlab/commit/c59fbdb0e9311fa84190579769e3c5c6aeb07fe5)) * **objects:** Rename confusing `to_project_id` argument ([`ce4bc0d`](https://github.com/python-gitlab/python-gitlab/commit/ce4bc0daef355e2d877360c6e496c23856138872)) * Raise error if there is a 301/302 redirection ([`d56a434`](https://github.com/python-gitlab/python-gitlab/commit/d56a4345c1ae05823b553e386bfa393541117467)) * **build:** Do not package tests in wheel ([`969dccc`](https://github.com/python-gitlab/python-gitlab/commit/969dccc084e833331fcd26c2a12ddaf448575ab4)) ### Breaking * The gitlab CLI will now accept CLI arguments and environment variables for its global options in addition to configuration file options. This may change behavior for some workflows such as running inside GitLab CI and with certain environment variables configured. ([`ca58008`](https://github.com/python-gitlab/python-gitlab/commit/ca58008607385338aaedd14a58adc347fa1a41a0)) * stop encoding '.' to '%2E'. This could potentially be a breaking change for users who have incorrectly configured GitLab servers which don't handle period '.' characters correctly. ([`702e41d`](https://github.com/python-gitlab/python-gitlab/commit/702e41dd0674e76b292d9ea4f559c86f0a99edfe)) * A config file is no longer needed to run the CLI. python-gitlab will default to https://gitlab.com with no authentication if there is no config file provided. python-gitlab will now also only look for configuration in the provided PYTHON_GITLAB_CFG path, instead of merging it with user- and system-wide config files. If the environment variable is defined and the file cannot be opened, python-gitlab will now explicitly fail. ([`92a893b`](https://github.com/python-gitlab/python-gitlab/commit/92a893b8e230718436582dcad96175685425b1df)) * As of python-gitlab 3.0.0, Python 3.6 is no longer supported. Python 3.7 or higher is required. ([`414009d`](https://github.com/python-gitlab/python-gitlab/commit/414009daebe19a8ae6c36f050dffc690dff40e91)) * As of python-gitlab 3.0.0, the default branch for development has changed from `master` to `main`. ([`545f8ed`](https://github.com/python-gitlab/python-gitlab/commit/545f8ed24124837bf4e55aa34e185270a4b7aeff)) * remove deprecated branch protect methods in favor of the more complete protected branches API. ([`9656a16`](https://github.com/python-gitlab/python-gitlab/commit/9656a16f9f34a1aeb8ea0015564bad68ffb39c26)) * The deprecated `name_regex` attribute has been removed in favor of `name_regex_delete`. (see https://gitlab.com/gitlab-org/gitlab/-/commit/ce99813cf54) ([`c59fbdb`](https://github.com/python-gitlab/python-gitlab/commit/c59fbdb0e9311fa84190579769e3c5c6aeb07fe5)) * rename confusing `to_project_id` argument in transfer_project to `project_id` (`--project-id` in CLI). This is used for the source project, not for the target namespace. ([`ce4bc0d`](https://github.com/python-gitlab/python-gitlab/commit/ce4bc0daef355e2d877360c6e496c23856138872)) * remove deprecated constants defined in gitlab.v4.objects, and use only gitlab.const module ([`3f320af`](https://github.com/python-gitlab/python-gitlab/commit/3f320af347df05bba9c4d0d3bdb714f7b0f7b9bf)) * remove deprecated tag release API. This was removed in GitLab 14.0 ([`2b8a94a`](https://github.com/python-gitlab/python-gitlab/commit/2b8a94a77ba903ae97228e7ffa3cc2bf6ceb19ba)) * remove deprecated project.issuesstatistics in favor of project.issues_statistics ([`ca7777e`](https://github.com/python-gitlab/python-gitlab/commit/ca7777e0dbb82b5d0ff466835a94c99e381abb7c)) * remove deprecated members.all() method in favor of members_all.list() ([`4d7b848`](https://github.com/python-gitlab/python-gitlab/commit/4d7b848e2a826c58e91970a1d65ed7d7c3e07166)) * remove deprecated pipelines() methods in favor of pipelines.list() ([`c4f5ec6`](https://github.com/python-gitlab/python-gitlab/commit/c4f5ec6c615e9f83d533a7be0ec19314233e1ea0)) * python-gitlab will now default to gitlab.com if no URL is given ([`8236281`](https://github.com/python-gitlab/python-gitlab/commit/823628153ec813c4490e749e502a47716425c0f1)) * raise error if there is a 301/302 redirection ([`d56a434`](https://github.com/python-gitlab/python-gitlab/commit/d56a4345c1ae05823b553e386bfa393541117467)) ### Documentation * Switch to Furo and refresh introduction pages ([`ee6b024`](https://github.com/python-gitlab/python-gitlab/commit/ee6b024347bf8a178be1a0998216f2a24c940cee)) * Correct documentation for updating discussion note ([`ee66f4a`](https://github.com/python-gitlab/python-gitlab/commit/ee66f4a777490a47ad915a3014729a9720bf909b)) * Rename documentation files to match names of code files ([`ee3f865`](https://github.com/python-gitlab/python-gitlab/commit/ee3f8659d48a727da5cd9fb633a060a9231392ff)) * **project:** Remove redundant encoding parameter ([`fed613f`](https://github.com/python-gitlab/python-gitlab/commit/fed613f41a298e79a975b7f99203e07e0f45e62c)) * Use annotations for return types ([`79e785e`](https://github.com/python-gitlab/python-gitlab/commit/79e785e765f4219fe6001ef7044235b82c5e7754)) * Update docs to use gitlab.const for constants ([`b3b0b5f`](https://github.com/python-gitlab/python-gitlab/commit/b3b0b5f1da5b9da9bf44eac33856ed6eadf37dd6)) * Only use type annotations for documentation ([`b7dde0d`](https://github.com/python-gitlab/python-gitlab/commit/b7dde0d7aac8dbaa4f47f9bfb03fdcf1f0b01c41)) * Add links to the GitLab API docs ([`e3b5d27`](https://github.com/python-gitlab/python-gitlab/commit/e3b5d27bde3e104e520d976795cbcb1ae792fb05)) * Fix API delete key example ([`b31bb05`](https://github.com/python-gitlab/python-gitlab/commit/b31bb05c868793e4f0cb4573dad6bf9ca01ed5d9)) * **pipelines:** Document take_ownership method ([`69461f6`](https://github.com/python-gitlab/python-gitlab/commit/69461f6982e2a85dcbf95a0b884abd3f4050c1c7)) * **api:** Document the update method for project variables ([`7992911`](https://github.com/python-gitlab/python-gitlab/commit/7992911896c62f23f25742d171001f30af514a9a)) * **api:** Clarify job token usage with auth() ([`3f423ef`](https://github.com/python-gitlab/python-gitlab/commit/3f423efab385b3eb1afe59ad12c2da7eaaa11d76)) * Fix a few typos ([`7ea4ddc`](https://github.com/python-gitlab/python-gitlab/commit/7ea4ddc4248e314998fd27eea17c6667f5214d1d)) * Consolidate changelogs and remove v3 API docs ([`90da8ba`](https://github.com/python-gitlab/python-gitlab/commit/90da8ba0342ebd42b8ec3d5b0d4c5fbb5e701117)) * Correct documented return type ([`acabf63`](https://github.com/python-gitlab/python-gitlab/commit/acabf63c821745bd7e43b7cd3d799547b65e9ed0)) ## v2.10.1 (2021-08-28) ### Fix * **mixins:** Improve deprecation warning ([`57e0187`](https://github.com/python-gitlab/python-gitlab/commit/57e018772492a8522b37d438d722c643594cf580)) * **deps:** Upgrade requests to 2.25.0 (see CVE-2021-33503) ([`ce995b2`](https://github.com/python-gitlab/python-gitlab/commit/ce995b256423a0c5619e2a6c0d88e917aad315ba)) ### Documentation * **mergequests:** Gl.mergequests.list documentation was missleading ([`5b5a7bc`](https://github.com/python-gitlab/python-gitlab/commit/5b5a7bcc70a4ddd621cbd59e134e7004ad2d9ab9)) ## v2.10.0 (2021-07-28) ### Feature * **api:** Add merge_ref for merge requests ([`1e24ab2`](https://github.com/python-gitlab/python-gitlab/commit/1e24ab247cc783ae240e94f6cb379fef1e743a52)) * **api:** Add `name_regex_keep` attribute in `delete_in_bulk()` ([`e49ff3f`](https://github.com/python-gitlab/python-gitlab/commit/e49ff3f868cbab7ff81115f458840b5f6d27d96c)) ### Fix * **api:** Do not require Release name for creation ([`98cd03b`](https://github.com/python-gitlab/python-gitlab/commit/98cd03b7a3085356b5f0f4fcdb7dc729b682f481)) ### Documentation * **readme:** Move contributing docs to CONTRIBUTING.rst ([`edf49a3`](https://github.com/python-gitlab/python-gitlab/commit/edf49a3d855b1ce4e2bd8a7038b7444ff0ab5fdc)) * Add example for mr.merge_ref ([`b30b8ac`](https://github.com/python-gitlab/python-gitlab/commit/b30b8ac27d98ed0a45a13775645d77b76e828f95)) * **project:** Add example on getting a single project using name with namespace ([`ef16a97`](https://github.com/python-gitlab/python-gitlab/commit/ef16a979031a77155907f4160e4f5e159d839737)) ## v2.9.0 (2021-06-28) ### Feature * **release:** Allow to update release ([`b4c4787`](https://github.com/python-gitlab/python-gitlab/commit/b4c4787af54d9db6c1f9e61154be5db9d46de3dd)) * **api:** Add group hooks ([`4a7e9b8`](https://github.com/python-gitlab/python-gitlab/commit/4a7e9b86aa348b72925bce3af1e5d988b8ce3439)) * **api:** Remove responsibility for API inconsistencies for MR reviewers ([`3d985ee`](https://github.com/python-gitlab/python-gitlab/commit/3d985ee8cdd5d27585678f8fbb3eb549818a78eb)) * **api:** Add MR pipeline manager and deprecate pipelines() method ([`954357c`](https://github.com/python-gitlab/python-gitlab/commit/954357c49963ef51945c81c41fd4345002f9fb98)) * **api:** Add support for creating/editing reviewers in project merge requests ([`676d1f6`](https://github.com/python-gitlab/python-gitlab/commit/676d1f6565617a28ee84eae20e945f23aaf3d86f)) ### Documentation * **tags:** Remove deprecated functions ([`1b1a827`](https://github.com/python-gitlab/python-gitlab/commit/1b1a827dd40b489fdacdf0a15b0e17a1a117df40)) * **release:** Add update example ([`6254a5f`](https://github.com/python-gitlab/python-gitlab/commit/6254a5ff6f43bd7d0a26dead304465adf1bd0886)) * Make Gitlab class usable for intersphinx ([`8753add`](https://github.com/python-gitlab/python-gitlab/commit/8753add72061ea01c508a42d16a27388b1d92677)) ## v2.8.0 (2021-06-10) ### Feature * Add keys endpoint ([`a81525a`](https://github.com/python-gitlab/python-gitlab/commit/a81525a2377aaed797af0706b00be7f5d8616d22)) * **objects:** Add support for Group wikis ([#1484](https://github.com/python-gitlab/python-gitlab/issues/1484)) ([`74f5e62`](https://github.com/python-gitlab/python-gitlab/commit/74f5e62ef5bfffc7ba21494d05dbead60b59ecf0)) * **objects:** Add support for generic packages API ([`79d88bd`](https://github.com/python-gitlab/python-gitlab/commit/79d88bde9e5e6c33029e4a9f26c97404e6a7a874)) * **api:** Add deployment mergerequests interface ([`fbbc0d4`](https://github.com/python-gitlab/python-gitlab/commit/fbbc0d400015d7366952a66e4401215adff709f0)) * **objects:** Support all issues statistics endpoints ([`f731707`](https://github.com/python-gitlab/python-gitlab/commit/f731707f076264ebea65afc814e4aca798970953)) * **objects:** Add support for descendant groups API ([`1b70580`](https://github.com/python-gitlab/python-gitlab/commit/1b70580020825adf2d1f8c37803bc4655a97be41)) * **objects:** Add pipeline test report support ([`ee9f96e`](https://github.com/python-gitlab/python-gitlab/commit/ee9f96e61ab5da0ecf469c21cccaafc89130a896)) * **objects:** Add support for billable members ([`fb0b083`](https://github.com/python-gitlab/python-gitlab/commit/fb0b083a0e536a6abab25c9ad377770cc4290fe9)) * Add feature to get inherited member for project/group ([`e444b39`](https://github.com/python-gitlab/python-gitlab/commit/e444b39f9423b4a4c85cdb199afbad987df026f1)) * Add code owner approval as attribute ([`fdc46ba`](https://github.com/python-gitlab/python-gitlab/commit/fdc46baca447e042d3b0a4542970f9758c62e7b7)) * Indicate that we are a typed package ([`e4421ca`](https://github.com/python-gitlab/python-gitlab/commit/e4421caafeeb0236df19fe7b9233300727e1933b)) * Add support for lists of integers to ListAttribute ([`115938b`](https://github.com/python-gitlab/python-gitlab/commit/115938b3e5adf9a2fb5ecbfb34d9c92bf788035e)) ### Fix * Catch invalid type used to initialize RESTObject ([`c7bcc25`](https://github.com/python-gitlab/python-gitlab/commit/c7bcc25a361f9df440f9c972672e5eec3b057625)) * Functional project service test ([#1500](https://github.com/python-gitlab/python-gitlab/issues/1500)) ([`093db9d`](https://github.com/python-gitlab/python-gitlab/commit/093db9d129e0a113995501755ab57a04e461c745)) * Ensure kwargs are passed appropriately for ObjectDeleteMixin ([`4e690c2`](https://github.com/python-gitlab/python-gitlab/commit/4e690c256fc091ddf1649e48dbbf0b40cc5e6b95)) * **cli:** Add missing list filter for jobs ([`b3d1c26`](https://github.com/python-gitlab/python-gitlab/commit/b3d1c267cbe6885ee41b3c688d82890bb2e27316)) * Change mr.merge() to use 'post_data' ([`cb6a3c6`](https://github.com/python-gitlab/python-gitlab/commit/cb6a3c672b9b162f7320c532410713576fbd1cdc)) * **cli:** Fix parsing CLI objects to classnames ([`4252070`](https://github.com/python-gitlab/python-gitlab/commit/42520705a97289ac895a6b110d34d6c115e45500)) * **objects:** Return server data in cancel/retry methods ([`9fed061`](https://github.com/python-gitlab/python-gitlab/commit/9fed06116bfe5df79e6ac5be86ae61017f9a2f57)) * **objects:** Add missing group attributes ([`d20ff4f`](https://github.com/python-gitlab/python-gitlab/commit/d20ff4ff7427519c8abccf53e3213e8929905441)) * **objects:** Allow lists for filters for in all objects ([`603a351`](https://github.com/python-gitlab/python-gitlab/commit/603a351c71196a7f516367fbf90519f9452f3c55)) * Iids not working as a list in projects.issues.list() ([`45f806c`](https://github.com/python-gitlab/python-gitlab/commit/45f806c7a7354592befe58a76b7e33a6d5d0fe6e)) * Add a check to ensure the MRO is correct ([`565d548`](https://github.com/python-gitlab/python-gitlab/commit/565d5488b779de19a720d7a904c6fc14c394a4b9)) ### Documentation * Fix typo in http_delete docstring ([`5226f09`](https://github.com/python-gitlab/python-gitlab/commit/5226f095c39985d04c34e7703d60814e74be96f8)) * **api:** Add behavior in local attributes when updating objects ([`38f65e8`](https://github.com/python-gitlab/python-gitlab/commit/38f65e8e9994f58bdc74fe2e0e9b971fc3edf723)) * Fail on warnings during sphinx build ([`cbd4d52`](https://github.com/python-gitlab/python-gitlab/commit/cbd4d52b11150594ec29b1ce52348c1086a778c8)) ## v2.7.1 (2021-04-26) * fix(files): do not url-encode file paths twice ## v2.7.0 (2021-04-25) ### Bug Fixes * update user's bool data and avatar (3ba27ffb) * argument type was not a tuple as expected (062f8f6a) * correct some type-hints in gitlab/mixins.py (8bd31240) * only append kwargs as query parameters (b9ecc9a8) * only add query_parameters to GitlabList once (1386) * checking if RESTManager._from_parent_attrs is set (8224b406) * handling config value in _get_values_from_helper (9dfb4cd9) * let the homedir be expanded in path of helper (fc7387a0) * make secret helper more user friendly (fc2798fc) * linting issues and test (b04dd2c0) * handle tags like debian/2%2.6-21 as identifiers (b4dac5ce) * remove duplicate class definitions in v4/objects/users.py (7c4e6259) * wrong variable name (15ec41ca) * tox pep8 target, so that it can run (f518e87b) * undefined name errors (48ec9e0f) * extend wait timeout for test_delete_user() (19fde8ed) * test_update_group() dependency on ordering (e78a8d63) * honor parameter value passed (c2f8f0e7) * **objects:** add single get endpoint for instance audit events (c3f0a6f1) * **types:** prevent __dir__ from producing duplicates (5bf7525d) ### Features * add ProjectPackageFile (#1372) * add option to add a helper to lookup token (8ecf5592) * add project audit endpoint (6660dbef) * add personal access token API (2bb16fac) * add import from bitbucket server (ff3013a2) * **api,cli:** make user agent configurable (4bb201b9) * **issues:** add missing get verb to IssueManager (f78ebe06) * **objects:** * add support for resource state events API (d4799c40) * add support for group audit events API (2a0fbdf9) * add Release Links API support (28d75181) * **projects:** add project access token api (1becef02) * **users:** add follow/unfollow API (e456869d) ### Documentation * correct ProjectFile.decode() documentation (b180bafd) * update doc for token helper (3ac6fa12) * better real life token lookup example (9ef83118) ## v2.6.0 (2021-01-29) ### Features * support multipart uploads (2fa3004d) * add MINIMAL_ACCESS constant (49eb3ca7) * unit tests added (f37ebf5f) * added support for pipeline bridges (05cbdc22) * adds support for project merge request approval rules (#1199) (c6fbf399) * **api:** * added wip filter param for merge requests (d6078f80) * added wip filter param for merge requests (aa6e80d5) * add support for user identity provider deletion (e78e1215) * **tests:** test label getter (a41af902) ### Bug Fixes * docs changed using the consts (650b65c3) * typo (9baa9053) * **api:** * use RetrieveMixin for ProjectLabelManager (1a143952) * add missing runner access_level param (92669f2e) * **base:** really refresh object (e1e0d8cb), closes (#1155) * **cli:** * write binary data to stdout buffer (0733ec6c) * add missing args for project lists (c73e2374) ## v2.5.0 (2020-09-01) ### Features * add support to resource milestone events (88f8cc78), closes #1154 * add share/unshare group with group (7c6e541d) * add support for instance variables (4492fc42) * add support for Packages API (71495d12) * add endpoint for latest ref artifacts (b7a07fca) ### Bug Fixes * wrong reconfirmation parameter when updating user's email (b5c267e1) * tests fail when using REUSE_CONTAINER option ([0078f899](https://github.com/python-gitlab/python-gitlab/commit/0078f8993c38df4f02da9aaa3f7616d1c8b97095), closes #1146 * implement Gitlab's behavior change for owned=True (99777991) ## v2.4.0 (2020-07-09) ### Bug Fixes * do not check if kwargs is none (a349b90e) * make query kwargs consistent between call in init and next (72ffa016) * pass kwargs to subsequent queries in gitlab list (1d011ac7) * **merge:** parse arguments as query_data (878098b7) ### Features * add NO_ACCESS const (dab4d0a1) * add masked parameter for variables command (b6339bf8) ## v2.3.1 (2020-06-09) * revert keyset pagination by default ## v2.3.0 (2020-06-08) ### Features * add group runners api (49439916) * add play command to project pipeline schedules (07b99881) * allow an environment variable to specify config location (401e702a) * **api:** added support in the GroupManager to upload Group avatars (28eb7eab) * **services:** add project service list API (fc522218) * **types:** add __dir__ to RESTObject to expose attributes (cad134c0) ### Bug Fixes * use keyset pagination by default for /projects > 50000 (f86ef3bb) * **config:** fix duplicate code (ee2df6f1), closes (#1094) * **project:** add missing project parameters (ad8c67d6) ## v2.2.0 (2020-04-07) ### Bug Fixes * add missing import_project param (9b16614b) * **types:** do not split single value string in ListAttribute (a26e5858) ### Features * add commit GPG signature API (da7a8097) * add create from template args to ProjectManager (f493b73e) * add remote mirrors API (#1056) (4cfaa2fd) * add Gitlab Deploy Token API (01de524c) * add Group Import/Export API (#1037) (6cb9d923) ## v2.1.2 (2020-03-09) ### Bug Fixes * Fix regression, when using keyset pagination with merge requests. Related to https://github.com/python-gitlab/python-gitlab/issues/1044 ## v2.1.1 (2020-03-09) ### Bug Fixes **users**: update user attributes This change was made to migate an issue in Gitlab (again). Fix available in: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26792 ## v2.1.0 (2020-03-08) ### Bug Fixes * do not require empty data dict for create() (99d959f7) * remove trailing slashes from base URL (#913) (2e396e4a) * return response with commit data (b77b945c) * remove null values from features POST data, because it fails with HTTP 500 (1ec1816d) * **docs:** * fix typo in user memberships example (33889bcb) * update to new set approvers call for # of approvers (8e0c5262) * update docs and tests for set_approvers (2cf12c79) * **objects:** * add default name data and use http post (70c0cfb6) * update set_approvers function call (65ecadcf) * update to new gitlab api for path, and args (e512cddd) ### Features * add support for user memberships API (#1009) (c313c2b0) * add support for commit revert API (#991) (5298964e) * add capability to control GitLab features per project or group (7f192b4f) * use keyset pagination by default for `all=True` (99b4484d) * add support for GitLab OAuth Applications API (4e12356d) ## v2.0.1 (2020-02-05) ### Changes * **users:** update user attributes This change was made to migate an issue in Gitlab. See: https://gitlab.com/gitlab-org/gitlab/issues/202070 ## v2.0.0 (2020-01-26) ### This releases drops support for python < 3.6 ### Bug Fixes * **projects:** adjust snippets to match the API (e104e213) ### Features * add global order_by option to ease pagination (d1879253) * support keyset pagination globally (0b71ba4d) * add appearance API (4c4ac5ca) * add autocompletion support (973cb8b9) ## v1.15.0 (2019-12-16) ### Bug Fixes * ignore all parameter, when as_list=True 137d72b3, closes #962 ### Features * allow cfg timeout to be overrided via kwargs e9a8289a * add support for /import/github aa4d41b7 * nicer stacktrace 697cda24 * retry transient HTTP errors 59fe2714, closes #970 * access project's issues statistics 482e57ba, closes #966 * adding project stats db0b00a9, closes #967 * add variable_type/protected to projects ci variables 4724c50e * add variable_type to groups ci variables 0986c931 ## v1.14.0 (2019-12-07) ### Bug Fixes * added missing attributes for project approvals 460ed63c * **labels:** ensure label.save() works 727f5361 * **project-fork:** * copy create fix from ProjectPipelineManager 516307f1 * correct path computation for project-fork list 44a7c278 ### Features * add audit endpoint 2534020b * add project and group clusters ebd053e7 * add support for include_subgroups filter adbcd83f ## v1.13.0 (2019-11-02) ### Features * add users activate, deactivate functionality (32ad6692) * send python-gitlab version as user-agent (c22d49d0) * add deployment creation (ca256a07), closes [#917] * **auth:** remove deprecated session auth (b751cdf4) * **doc:** remove refs to api v3 in docs (6beeaa99) * **test:** unused unittest2, type -> isinstance (33b18012) ### Bug Fixes * **projects:** support `approval_rules` endpoint for projects (2cef2bb4) ## v1.12.1 (2019-10-07) ### Bug Fixes fix: fix not working without auth provided ## v1.12.0 (2019-10-06) ### Features * add support for job token * **project:** * implement update_submodule * add file blame api * **user:** add status api ### Bug Fixes * **cli:** fix cli command user-project list * **labels:** don't mangle label name on update * **todo:** mark_all_as_done doesn't return anything ## v1.11.0 (2019-08-31) ### Features * add methods to retrieve an individual project environment * group labels with subscriptable mixin ### Bug Fixes * projects: avatar uploading for projects * remove empty list default arguments * remove empty dict default arguments * add project and group label update without id to fix cli ## v1.10.0 (2019-07-22) ### Features * add mr rebase method bc4280c2 * get artifact by ref and job cda11745 * add support for board update 908d79fa, closes #801 * add support for issue.related_merge_requests 90a36315, closes #794 ### Bug Fixes * improve pickle support b4b5decb * **cli:** * allow --recursive parameter in repository tree 7969a78c, closes #718, #731 * don't fail when the short print attr value is None 8d1552a0, closes #717, #727 * fix update value for key not working b7662039 ## v1.9.0 (2019-06-19) ### Features * implement artifacts deletion * add endpoint to get the variables of a pipeline * delete ProjectPipeline * implement __eq__ and __hash__ methods * Allow runpy invocation of CLI tool (python -m gitlab) * add project releases api * merged new release & registry apis ### Bug Fixes * convert # to %23 in URLs * pep8 errors * use python2 compatible syntax for super * Make MemberManager.all() return a list of objects * %d replaced by %s * Re-enable command specific help messages * dont ask for id attr if this is \*Manager originating custom action * fix -/_ replacament for \*Manager custom actions * fix repository_id marshaling in cli * register cli action for delete_in_bulk ## v1.8.0 (2019-02-22) * docs(setup): use proper readme on PyPI * docs(readme): provide commit message guidelines * fix(api): make reset_time_estimate() work again * fix: handle empty 'Retry-After' header from GitLab * fix: remove decode() on error_message string * chore: release tags to PyPI automatically * fix(api): avoid parameter conflicts with python and gitlab * fix(api): Don't try to parse raw downloads * feat: Added approve & unapprove method for Mergerequests * fix all kwarg behaviour ## v1.7.0 (2018-12-09) * **docs:** Fix the owned/starred usage documentation * **docs:** Add a warning about http to https redirects * Fix the https redirection test * **docs:** Add a note about GroupProject limited API * Add missing comma in ProjectIssueManager _create_attrs * More flexible docker image * Add project protected tags management * **cli:** Print help and usage without config file * Rename MASTER_ACCESS to MAINTAINER_ACCESS * **docs:** Add docs build information * Use docker image with current sources * **docs:** Add PyYAML requirement notice * Add Gitter badge to README * **docs:** Add an example of pipeline schedule vars listing * **cli:** Exit on config parse error, instead of crashing * Add support for resource label events * **docs:** Fix the milestone filetring doc (iid -> iids) * **docs:** Fix typo in custom attributes example * Improve error message handling in exceptions * Add support for members all() method * Add access control options to protected branch creation ## v1.6.0 (2018-08-25) * **docs:** Don't use hardcoded values for ids * **docs:** Improve the snippets examples * **cli:** Output: handle bytes in API responses * **cli:** Fix the case where we have nothing to print * Project import: fix the override_params parameter * Support group and global MR listing * Implement MR.pipelines() * MR: add the squash attribute for create/update * Added support for listing forks of a project * **docs:** Add/update notes about read-only objects * Raise an exception on https redirects for PUT/POST * **docs:** Add a FAQ * **cli:** Fix the project-export download ## v1.5.1 (2018-06-23) * Fix the ProjectPipelineJob base class (regression) ## v1.5.0 (2018-06-22) * Drop API v3 support * Drop GetFromListMixin * Update the sphinx extension for v4 objects * Add support for user avatar upload * Add support for project import/export * Add support for the search API * Add a global per_page config option * Add support for the discussions API * Add support for merged branches deletion * Add support for Project badges * Implement user_agent_detail for snippets * Implement commit.refs() * Add commit.merge_requests() support * Deployment: add list filters * Deploy key: add missing attributes * Add support for environment stop() * Add feature flags deletion support * Update some group attributes * Issues: add missing attributes and methods * Fix the participants() decorator * Add support for group boards * Implement the markdown rendering API * Update MR attributes * Add pipeline listing filters * Add missing project attributes * Implement runner jobs listing * Runners can be created (registered) * Implement runner token validation * Update the settings attributes * Add support for the gitlab CI lint API * Add support for group badges * Fix the IssueManager path to avoid redirections * time_stats(): use an existing attribute if available * Make ProjectCommitStatus.create work with CLI * Tests: default to python 3 * ProjectPipelineJob was defined twice * Silence logs/warnings in unittests * Add support for MR approval configuration (EE) * Change post_data default value to None * Add geo nodes API support (EE) * Add support for issue links (EE) * Add support for LDAP groups (EE) * Add support for board creation/deletion (EE) * Add support for Project.pull_mirror (EE) * Add project push rules configuration (EE) * Add support for the EE license API * Add support for the LDAP groups API (EE) * Add support for epics API (EE) * Fix the non-verbose output of ProjectCommitComment ## v1.4.0 (2018-05-19) * Require requests>=2.4.2 * ProjectKeys can be updated * Add support for unsharing projects (v3/v4) * **cli:** fix listing for json and yaml output * Fix typos in documentation * Introduce RefreshMixin * **docs:** Fix the time tracking examples * **docs:** Commits: add an example of binary file creation * **cli:** Allow to read args from files * Add support for recursive tree listing * **cli:** Restore the --help option behavior * Add basic unit tests for v4 CLI * **cli:** Fix listing of strings * Support downloading a single artifact file * Update docs copyright years * Implement attribute types to handle special cases * **docs:** fix GitLab reference for notes * Expose additional properties for Gitlab objects * Fix the impersonation token deletion example * feat: obey the rate limit * Fix URL encoding on branch methods * **docs:** add a code example for listing commits of a MR * **docs:** update service.available() example for API v4 * **tests:** fix functional tests for python3 * api-usage: bit more detail for listing with `all` * More efficient .get() for group members * Add docs for the `files` arg in http_* * Deprecate GetFromListMixin ## v1.3.0 (2018-02-18) * Add support for pipeline schedules and schedule variables * Clarify information about supported python version * Add manager for jobs within a pipeline * Fix wrong tag example * Update the groups documentation * Add support for MR participants API * Add support for getting list of user projects * Add Gitlab and User events support * Make trigger_pipeline return the pipeline * Config: support api_version in the global section * Gitlab can be used as context manager * Default to API v4 * Add a simplified example for streamed artifacts * Add documentation about labels update ## v1.2.0 (2018-01-01) * Add mattermost service support * Add users custom attributes support * **doc:** Fix project.triggers.create example with v4 API * Oauth token support * Remove deprecated objects/methods * Rework authentication args handling * Add support for oauth and anonymous auth in config/CLI * Add support for impersonation tokens API * Add support for user activities * Update user docs with gitlab URLs * **docs:** Bad arguments in projects file documentation * Add support for user_agent_detail (issues) * Add a SetMixin * Add support for project housekeeping * Expected HTTP response for subscribe is 201 * Update pagination docs for ProjectCommit * Add doc to get issue from iid * Make todo() raise GitlabTodoError on error * Add support for award emojis * Update project services docs for v4 * Avoid sending empty update data to issue.save * **docstrings:** Explicitly document pagination arguments * **docs:** Add a note about password auth being removed from GitLab * Submanagers: allow having undefined parameters * ProjectFile.create(): don't modify the input data * Update testing tools for /session removal * Update groups tests * Allow per_page to be used with generators * Add groups listing attributes * Add support for subgroups listing * Add supported python versions in setup.py * Add support for pagesdomains * Add support for features flags * Add support for project and group custom variables * Add support for user/group/project filter by custom attribute * Respect content of REQUESTS_CA_BUNDLE and \*_proxy envvars ## v1.1.0 (2017-11-03) * Fix trigger variables in v4 API * Make the delete() method handle / in ids * **docs:** update the file upload samples * Tags release description: support / in tag names * **docs:** improve the labels usage documentation * Add support for listing project users * ProjectFileManager.create: handle / in file paths * Change ProjectUser and GroupProject base class * **docs:** document `get_create_attrs` in the API tutorial * Document the Gitlab session parameter * ProjectFileManager: custom update() method * Project: add support for printing_merge_request_link_enabled attr * Update the ssl_verify docstring * Add support for group milestones * Add support for GPG keys * Add support for wiki pages * Update the repository_blob documentation * Fix the CLI for objects without ID (API v4) * Add a contributed Dockerfile * Pagination generators: expose more information * Module's base objects serialization * **doc:** Add sample code for client-side certificates ## v1.0.2 (2017-09-29) * **docs:** remove example usage of submanagers * Properly handle the labels attribute in ProjectMergeRequest * ProjectFile: handle / in path for delete() and save() ## v1.0.1 (2017-09-21) * Tags can be retrieved by ID * Add the server response in GitlabError exceptions * Add support for project file upload * Minor typo fix in "Switching to v4" documentation * Fix password authentication for v4 * Fix the labels attrs on MR and issues * Exceptions: use a proper error message * Fix http_get method in get artifacts and job trace * CommitStatus: `sha` is parent attribute * Fix a couple listing calls to allow proper pagination * Add missing doc file ## v1.0.0 (2017-09-08) * Support for API v4. See http://python-gitlab.readthedocs.io/en/master/switching-to-v4.html * Support SSL verification via internal CA bundle * Docs: Add link to gitlab docs on obtaining a token * Added dependency injection support for Session * Fixed repository_compare examples * Fix changelog and release notes inclusion in sdist * Missing expires_at in GroupMembers update * Add lower-level methods for Gitlab() ## v0.21.2 (2017-06-11) * Install doc: use sudo for system commands * **v4:** Make MR work properly * Remove extra_attrs argument from `_raw_list` * **v4:** Make project issues work properly * Fix urlencode() usage (python 2/3) (#268) * Fixed spelling mistake (#269) * Add new event types to ProjectHook ## v0.21.1 (2017-05-25) * Fix the manager name for jobs in the Project class * Fix the docs ## v0.21 (2017-05-24) * Add time_stats to ProjectMergeRequest * Update User options for creation and update (#246) * Add milestone.merge_requests() API * Fix docs typo (s/correspnding/corresponding/) * Support milestone start date (#251) * Add support for priority attribute in labels (#256) * Add support for nested groups (#257) * Make GroupProjectManager a subclass of ProjectManager (#255) * Available services: return a list instead of JSON (#258) * MR: add support for time tracking features (#248) * Fixed repository_tree and repository_blob path encoding (#265) * Add 'search' attribute to projects.list() * Initial gitlab API v4 support * Reorganise the code to handle v3 and v4 objects * Allow 202 as delete return code * Deprecate parameter related methods in gitlab.Gitlab ## v0.20 (2017-03-25) * Add time tracking support (#222) * Improve changelog (#229, #230) * Make sure that manager objects are never overwritten (#209) * Include chanlog and release notes in docs * Add DeployKey{,Manager} classes (#212) * Add support for merge request notes deletion (#227) * Properly handle extra args when listing with all=True (#233) * Implement pipeline creation API (#237) * Fix spent_time methods * Add 'delete source branch' option when creating MR (#241) * Provide API wrapper for cherry picking commits (#236) * Stop listing if recursion limit is hit (#234) ## v0.19 (2017-02-21) * Update project.archive() docs * Support the scope attribute in runners.list() * Add support for project runners * Add support for commit creation * Fix install doc * Add builds-email and pipelines-email services * Deploy keys: rework enable/disable * Document the dynamic aspect of objects * Add pipeline_events to ProjectHook attrs * Add due_date attribute to ProjectIssue * Handle settings.domain_whitelist, partly * {Project,Group}Member: support expires_at attribute ## v0.18 (2016-12-27) * Fix JIRA service editing for GitLab 8.14+ * Add jira_issue_transition_id to the JIRA service optional fields * Added support for Snippets (new API in Gitlab 8.15) * **docs:** update pagination section * **docs:** artifacts example: open file in wb mode * **CLI:** ignore empty arguments * **CLI:** Fix wrong use of arguments * **docs:** Add doc for snippets * Fix duplicated data in API docs * Update known attributes for projects * sudo: always use strings ## v0.17 (2016-12-02) * README: add badges for pypi and RTD * Fix ProjectBuild.play (raised error on success) * Pass kwargs to the object factory * Add .tox to ignore to respect default tox settings * Convert response list to single data source for iid requests * Add support for boards API * Add support for Gitlab.version() * Add support for broadcast messages API * Add support for the notification settings API * Don't overwrite attributes returned by the server * Fix bug when retrieving changes for merge request * Feature: enable / disable the deploy key in a project * Docs: add a note for python 3.5 for file content update * ProjectHook: support the token attribute * Rework the API documentation * Fix docstring for http_{username,password} * Build managers on demand on GitlabObject's * API docs: add managers doc in GitlabObject's * Sphinx ext: factorize the build methods * Implement `__repr__` for gitlab objects * Add a 'report a bug' link on doc * Remove deprecated methods * Implement merge requests diff support * Make the manager objects creation more dynamic * Add support for templates API * Add attr 'created_at' to ProjectIssueNote * Add attr 'updated_at' to ProjectIssue * CLI: add support for project all --all * Add support for triggering a new build * Rework requests arguments (support latest requests release) * Fix `should_remove_source_branch` ## v0.16 (2016-10-16) * Add the ability to fork to a specific namespace * JIRA service - add api_url to optional attributes * Fix bug: Missing coma concatenates array values * docs: branch protection notes * Create a project in a group * Add only_allow_merge_if_build_succeeds option to project objects * Add support for --all in CLI * Fix examples for file modification * Use the plural merge_requests URL everywhere * Rework travis and tox setup * Workaround gitlab setup failure in tests * Add ProjectBuild.erase() * Implement ProjectBuild.play() ## v0.15.1 (2016-10-16) * docs: improve the pagination section * Fix and test pagination * 'path' is an existing gitlab attr, don't use it as method argument ## v0.15 (2016-08-28) * Add a basic HTTP debug method * Run more tests in travis * Fix fork creation documentation * Add more API examples in docs * Update the ApplicationSettings attributes * Implement the todo API * Add sidekiq metrics support * Move the constants at the gitlab root level * Remove methods marked as deprecated 7 months ago * Refactor the Gitlab class * Remove _get_list_or_object() and its tests * Fix canGet attribute (typo) * Remove unused ProjectTagReleaseManager class * Add support for project services API * Add support for project pipelines * Add support for access requests * Add support for project deployments ## v0.14 (2016-08-07) * Remove 'next_url' from kwargs before passing it to the cls constructor. * List projects under group * Add support for subscribe and unsubscribe in issues * Project issue: doc and CLI for (un)subscribe * Added support for HTTP basic authentication * Add support for build artifacts and trace * --title is a required argument for ProjectMilestone * Commit status: add optional context url * Commit status: optional get attrs * Add support for commit comments * Issues: add optional listing parameters * Issues: add missing optional listing parameters * Project issue: proper update attributes * Add support for project-issue move * Update ProjectLabel attributes * Milestone: optional listing attrs * Add support for namespaces * Add support for label (un)subscribe * MR: add (un)subscribe support * Add `note_events` to project hooks attributes * Add code examples for a bunch of resources * Implement user emails support * Project: add VISIBILITY_* constants * Fix the Project.archive call * Implement archive/unarchive for a projet * Update ProjectSnippet attributes * Fix ProjectMember update * Implement sharing project with a group * Implement CLI for project archive/unarchive/share * Implement runners global API * Gitlab: add managers for build-related resources * Implement ProjectBuild.keep_artifacts * Allow to stream the downloads when appropriate * Groups can be updated * Replace Snippet.Content() with a new content() method * CLI: refactor _die() * Improve commit statuses and comments * Add support from listing group issues * Added a new project attribute to enable the container registry. * Add a contributing section in README * Add support for global deploy key listing * Add support for project environments * MR: get list of changes and commits * Fix the listing of some resources * MR: fix updates * Handle empty messages from server in exceptions * MR (un)subscribe: don't fail if state doesn't change * MR merge(): update the object ## v0.13 (2016-05-16) * Add support for MergeRequest validation * MR: add support for cancel_merge_when_build_succeeds * MR: add support for closes_issues * Add "external" parameter for users * Add deletion support for issues and MR * Add missing group creation parameters * Add a Session instance for all HTTP requests * Enable updates on ProjectIssueNotes * Add support for Project raw_blob * Implement project compare * Implement project contributors * Drop the next_url attribute when listing * Remove unnecessary canUpdate property from ProjectIssuesNote * Add new optional attributes for projects * Enable deprecation warnings for gitlab only * Rework merge requests update * Rework the Gitlab.delete method * ProjectFile: file_path is required for deletion * Rename some methods to better match the API URLs * Deprecate the file_* methods in favor of the files manager * Implement star/unstar for projects * Implement list/get licenses * Manage optional parameters for list() and get() ## v0.12.2 (2016-03-19) * Add new `ProjectHook` attributes * Add support for user block/unblock * Fix GitlabObject creation in _custom_list * Add support for more CLI subcommands * Add some unit tests for CLI * Add a coverage tox env * Define `GitlabObject.as_dict()` to dump object as a dict * Define `GitlabObject.__eq__()` and `__ne__()` equivalence methods * Define UserManager.search() to search for users * Define UserManager.get_by_username() to get a user by username * Implement "user search" CLI * Improve the doc for UserManager * CLI: implement user get-by-username * Re-implement _custom_list in the Gitlab class * Fix the 'invalid syntax' error on Python 3.2 * Gitlab.update(): use the proper attributes if defined ## v0.12.1 (2016-02-03) * Fix a broken upload to pypi ## v0.12 (2016-02-03) * Improve documentation * Improve unit tests * Improve test scripts * Skip BaseManager attributes when encoding to JSON * Fix the json() method for python 3 * Add Travis CI support * Add a decode method for ProjectFile * Make connection exceptions more explicit * Fix ProjectLabel get and delete * Implement ProjectMilestone.issues() * ProjectTag supports deletion * Implement setting release info on a tag * Implement project triggers support * Implement project variables support * Add support for application settings * Fix the 'password' requirement for User creation * Add sudo support * Fix project update * Fix Project.tree() * Add support for project builds ## v0.11.1 (2016-01-17) * Fix discovery of parents object attrs for managers * Support setting commit status * Support deletion without getting the object first * Improve the documentation ## v0.11 (2016-01-09) * functional_tests.sh: support python 2 and 3 * Add a get method for GitlabObject * CLI: Add the -g short option for --gitlab * Provide a create method for GitlabObject's * Rename the `_created` attribute `_from_api` * More unit tests * CLI: fix error when arguments are missing (python 3) * Remove deprecated methods * Implement managers to get access to resources * Documentation improvements * Add fork project support * Deprecate the "old" Gitlab methods * Add support for groups search ## v0.10 (2015-12-29) * Implement pagination for list() (#63) * Fix url when fetching a single MergeRequest * Add support to update MergeRequestNotes * API: Provide a Gitlab.from_config method * setup.py: require requests>=1 (#69) * Fix deletion of object not using 'id' as ID (#68) * Fix GET/POST for project files * Make 'confirm' an optional attribute for user creation * Python 3 compatibility fixes * Add support for group members update (#73) ## v0.9.2 (2015-07-11) * CLI: fix the update and delete subcommands (#62) ## v0.9.1 (2015-05-15) * Fix the setup.py script ## v0.9 (2015-05-15) * Implement argparse library for parsing argument on CLI * Provide unit tests and (a few) functional tests * Provide PEP8 tests * Use tox to run the tests * CLI: provide a --config-file option * Turn the gitlab module into a proper package * Allow projects to be updated * Use more pythonic names for some methods * Deprecate some Gitlab object methods: * `raw*` methods should never have been exposed; replace them with `_raw_*` methods * setCredentials and setToken are replaced with set_credentials and set_token * Sphinx: don't hardcode the version in `conf.py` ## v0.8 (2014-10-26) * Better python 2.6 and python 3 support * Timeout support in HTTP requests * Gitlab.get() raised GitlabListError instead of GitlabGetError * Support api-objects which don't have id in api response * Add ProjectLabel and ProjectFile classes * Moved url attributes to separate list * Added list for delete attributes ## v0.7 (2014-08-21) * Fix license classifier in `setup.py` * Fix encoding error when printing to redirected output * Fix encoding error when updating with redirected output * Add support for UserKey listing and deletion * Add support for branches creation and deletion * Support state_event in ProjectMilestone (#30) * Support namespace/name for project id (#28) * Fix handling of boolean values (#22) ## v0.6 (2014-01-16) * IDs can be unicode (#15) * ProjectMember: constructor should not create a User object * Add support for extra parameters when listing all projects (#12) * Projects listing: explicitly define arguments for pagination ## v0.5 (2013-12-26) * Add SSH key for user * Fix comments * Add support for project events * Support creation of projects for users * Project: add methods for create/update/delete files * Support projects listing: search, all, owned * System hooks can't be updated * Project.archive(): download tarball of the project * Define new optional attributes for user creation * Provide constants for access permissions in groups ## v0.4 (2013-09-26) * Fix strings encoding (Closes #6) * Allow to get a project commit (GitLab 6.1) * ProjectMergeRequest: fix Note() method * Gitlab 6.1 methods: diff, blob (commit), tree, blob (project) * Add support for Gitlab 6.1 group members ## v0.3 (2013-08-27) * Use PRIVATE-TOKEN header for passing the auth token * provide an AUTHORS file * cli: support ssl_verify config option * Add ssl_verify option to Gitlab object. Defaults to True * Correct url for merge requests API. ## v0.2 (2013-08-08) * provide a pip requirements.txt * drop some debug statements ## v0.1 (2013-07-08) * Initial release ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/COPYING0000644000000000000000000001674314366036457014201 0ustar00rootroot GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/MANIFEST.in0000644000000000000000000000025514366036457014673 0ustar00rootrootinclude COPYING AUTHORS CHANGELOG.md requirements*.txt include tox.ini recursive-include tests * recursive-include docs *j2 *.js *.md *.py *.rst api/*.rst Makefile make.bat ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.326791 python-gitlab-3.13.0/PKG-INFO0000644000000000000000000001554414366036463014236 0ustar00rootrootMetadata-Version: 2.1 Name: python-gitlab Version: 3.13.0 Summary: Interact with GitLab API Home-page: https://github.com/python-gitlab/python-gitlab Author: Gauvain Pocentek Author-email: gauvain@pocentek.net License: LGPL-3.0-or-later Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3) Classifier: Natural Language :: English Classifier: Operating System :: POSIX Classifier: Operating System :: Microsoft :: Windows Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Requires-Python: >=3.7.0 Description-Content-Type: text/x-rst Provides-Extra: autocompletion Provides-Extra: yaml License-File: COPYING License-File: AUTHORS python-gitlab ============= .. image:: https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg :target: https://github.com/python-gitlab/python-gitlab/actions .. image:: https://badge.fury.io/py/python-gitlab.svg :target: https://badge.fury.io/py/python-gitlab .. image:: https://readthedocs.org/projects/python-gitlab/badge/?version=latest :target: https://python-gitlab.readthedocs.org/en/latest/?badge=latest .. image:: https://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=main :target: https://codecov.io/github/python-gitlab/python-gitlab?branch=main .. image:: https://img.shields.io/pypi/pyversions/python-gitlab.svg :target: https://pypi.python.org/pypi/python-gitlab .. image:: https://img.shields.io/gitter/room/python-gitlab/Lobby.svg :target: https://gitter.im/python-gitlab/Lobby .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black .. image:: https://img.shields.io/github/license/python-gitlab/python-gitlab :target: https://github.com/python-gitlab/python-gitlab/blob/main/COPYING ``python-gitlab`` is a Python package providing access to the GitLab server API. It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``). .. _features: Features -------- ``python-gitlab`` enables you to: * write Pythonic code to manage your GitLab resources. * pass arbitrary parameters to the GitLab API. Simply follow GitLab's docs on what parameters are available. * access arbitrary endpoints as soon as they are available on GitLab, by using lower-level API methods. * use persistent requests sessions for authentication, proxy and certificate handling. * handle smart retries on network and server errors, with rate-limit handling. * flexible handling of paginated responses, including lazy iterators. * automatically URL-encode paths and parameters where needed. * automatically convert some complex data structures to API attribute types * merge configuration from config files, environment variables and arguments. Installation ------------ As of 3.0.0, ``python-gitlab`` is compatible with Python 3.7+. Use ``pip`` to install the latest stable version of ``python-gitlab``: .. code-block:: console $ pip install --upgrade python-gitlab The current development version is available on both `GitHub.com `__ and `GitLab.com `__, and can be installed directly from the git repository: .. code-block:: console $ pip install git+https://github.com/python-gitlab/python-gitlab.git From GitLab: .. code-block:: console $ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git Using the docker images ----------------------- ``python-gitlab`` provides Docker images in two flavors, based on the Alpine and Debian slim python `base images `__. The default tag is ``alpine``, but you can explicitly use the alias (see below). The alpine image is smaller, but you may want to use the Debian-based slim tag (currently based on ``-slim-bullseye``) if you are running into issues or need a more complete environment with a bash shell, such as in CI jobs. The images are published on the GitLab registry, for example: * ``registry.gitlab.com/python-gitlab/python-gitlab:latest`` (latest, alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:alpine`` (latest alpine) * ``registry.gitlab.com/python-gitlab/python-gitlab:slim-bullseye`` (latest slim-bullseye) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0`` (alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-alpine`` * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye`` You can run the Docker image directly from the GitLab registry: .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest ... For example, to get a project on GitLab.com (without authentication): .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest project get --id gitlab-org/gitlab You can also mount your own config file: .. code-block:: console $ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest ... Building the image ~~~~~~~~~~~~~~~~~~ To build your own image from this repository, run: .. code-block:: console $ docker build -t python-gitlab:latest . Run your own image: .. code-block:: console $ docker run -it --rm python-gitlab:latest ... Build a Debian slim-based image: .. code-block:: console $ docker build -t python-gitlab:latest --build-arg PYTHON_FLAVOR=slim-bullseye . Bug reports ----------- Please report bugs and feature requests at https://github.com/python-gitlab/python-gitlab/issues. Gitter Community Chat --------------------- We have a `gitter `_ community chat available at https://gitter.im/python-gitlab/Lobby, which you can also directly access via the Open Chat button below. If you have a simple question, the community might be able to help already, without you opening an issue. If you regularly use python-gitlab, we also encourage you to join and participate. You might discover new ideas and use cases yourself! Documentation ------------- The full documentation for CLI and API is available on `readthedocs `_. Build the docs ~~~~~~~~~~~~~~ We use ``tox`` to manage our environment and build the documentation:: pip install tox tox -e docs Contributing ------------ For guidelines for contributing to ``python-gitlab``, refer to `CONTRIBUTING.rst `_. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/README.rst0000644000000000000000000001342714366036457014631 0ustar00rootrootpython-gitlab ============= .. image:: https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg :target: https://github.com/python-gitlab/python-gitlab/actions .. image:: https://badge.fury.io/py/python-gitlab.svg :target: https://badge.fury.io/py/python-gitlab .. image:: https://readthedocs.org/projects/python-gitlab/badge/?version=latest :target: https://python-gitlab.readthedocs.org/en/latest/?badge=latest .. image:: https://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=main :target: https://codecov.io/github/python-gitlab/python-gitlab?branch=main .. image:: https://img.shields.io/pypi/pyversions/python-gitlab.svg :target: https://pypi.python.org/pypi/python-gitlab .. image:: https://img.shields.io/gitter/room/python-gitlab/Lobby.svg :target: https://gitter.im/python-gitlab/Lobby .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black .. image:: https://img.shields.io/github/license/python-gitlab/python-gitlab :target: https://github.com/python-gitlab/python-gitlab/blob/main/COPYING ``python-gitlab`` is a Python package providing access to the GitLab server API. It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``). .. _features: Features -------- ``python-gitlab`` enables you to: * write Pythonic code to manage your GitLab resources. * pass arbitrary parameters to the GitLab API. Simply follow GitLab's docs on what parameters are available. * access arbitrary endpoints as soon as they are available on GitLab, by using lower-level API methods. * use persistent requests sessions for authentication, proxy and certificate handling. * handle smart retries on network and server errors, with rate-limit handling. * flexible handling of paginated responses, including lazy iterators. * automatically URL-encode paths and parameters where needed. * automatically convert some complex data structures to API attribute types * merge configuration from config files, environment variables and arguments. Installation ------------ As of 3.0.0, ``python-gitlab`` is compatible with Python 3.7+. Use ``pip`` to install the latest stable version of ``python-gitlab``: .. code-block:: console $ pip install --upgrade python-gitlab The current development version is available on both `GitHub.com `__ and `GitLab.com `__, and can be installed directly from the git repository: .. code-block:: console $ pip install git+https://github.com/python-gitlab/python-gitlab.git From GitLab: .. code-block:: console $ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git Using the docker images ----------------------- ``python-gitlab`` provides Docker images in two flavors, based on the Alpine and Debian slim python `base images `__. The default tag is ``alpine``, but you can explicitly use the alias (see below). The alpine image is smaller, but you may want to use the Debian-based slim tag (currently based on ``-slim-bullseye``) if you are running into issues or need a more complete environment with a bash shell, such as in CI jobs. The images are published on the GitLab registry, for example: * ``registry.gitlab.com/python-gitlab/python-gitlab:latest`` (latest, alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:alpine`` (latest alpine) * ``registry.gitlab.com/python-gitlab/python-gitlab:slim-bullseye`` (latest slim-bullseye) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0`` (alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-alpine`` * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye`` You can run the Docker image directly from the GitLab registry: .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest ... For example, to get a project on GitLab.com (without authentication): .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest project get --id gitlab-org/gitlab You can also mount your own config file: .. code-block:: console $ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest ... Building the image ~~~~~~~~~~~~~~~~~~ To build your own image from this repository, run: .. code-block:: console $ docker build -t python-gitlab:latest . Run your own image: .. code-block:: console $ docker run -it --rm python-gitlab:latest ... Build a Debian slim-based image: .. code-block:: console $ docker build -t python-gitlab:latest --build-arg PYTHON_FLAVOR=slim-bullseye . Bug reports ----------- Please report bugs and feature requests at https://github.com/python-gitlab/python-gitlab/issues. Gitter Community Chat --------------------- We have a `gitter `_ community chat available at https://gitter.im/python-gitlab/Lobby, which you can also directly access via the Open Chat button below. If you have a simple question, the community might be able to help already, without you opening an issue. If you regularly use python-gitlab, we also encourage you to join and participate. You might discover new ideas and use cases yourself! Documentation ------------- The full documentation for CLI and API is available on `readthedocs `_. Build the docs ~~~~~~~~~~~~~~ We use ``tox`` to manage our environment and build the documentation:: pip install tox tox -e docs Contributing ------------ For guidelines for contributing to ``python-gitlab``, refer to `CONTRIBUTING.rst `_. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.2947912 python-gitlab-3.13.0/docs/0000755000000000000000000000000014366036463014060 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/Makefile0000644000000000000000000001520614366036457015527 0ustar00rootroot# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-gitlab.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-gitlab.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/python-gitlab" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-gitlab" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/__init__.py0000644000000000000000000000000014366036457016162 0ustar00rootroot././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.2907913 python-gitlab-3.13.0/docs/_static/0000755000000000000000000000000014366036463015506 5ustar00rootroot././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.2947912 python-gitlab-3.13.0/docs/_static/js/0000755000000000000000000000000014366036463016122 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/_static/js/gitter.js0000644000000000000000000000011614366036457017757 0ustar00rootroot((window.gitter = {}).chat = {}).options = { room: 'python-gitlab/Lobby' }; ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.2947912 python-gitlab-3.13.0/docs/api/0000755000000000000000000000000014366036463014631 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api/gitlab.rst0000644000000000000000000000252214366036457016631 0ustar00rootrootAPI reference (``gitlab`` package) ================================== Module contents --------------- .. automodule:: gitlab :members: :undoc-members: :show-inheritance: :noindex: .. autoclass:: gitlab.Gitlab :members: :undoc-members: :show-inheritance: .. autoclass:: gitlab.GitlabList :members: :undoc-members: :show-inheritance: Subpackages ----------- .. toctree:: gitlab.v4 Submodules ---------- gitlab.base module ------------------ .. automodule:: gitlab.base :members: :undoc-members: :show-inheritance: gitlab.cli module ----------------- .. automodule:: gitlab.cli :members: :undoc-members: :show-inheritance: gitlab.config module -------------------- .. automodule:: gitlab.config :members: :undoc-members: :show-inheritance: gitlab.const module ------------------- .. automodule:: gitlab.const :members: :undoc-members: :show-inheritance: gitlab.exceptions module ------------------------ .. automodule:: gitlab.exceptions :members: :undoc-members: :show-inheritance: gitlab.mixins module -------------------- .. automodule:: gitlab.mixins :members: :undoc-members: :show-inheritance: gitlab.utils module ------------------- .. automodule:: gitlab.utils :members: :undoc-members: :show-inheritance: ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api/gitlab.v4.rst0000644000000000000000000000050014366036457017153 0ustar00rootrootgitlab.v4 package ================= Submodules ---------- gitlab.v4.objects module ------------------------ .. automodule:: gitlab.v4.objects :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: gitlab.v4 :members: :undoc-members: :show-inheritance: ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api-levels.rst0000644000000000000000000001024514366036457016660 0ustar00rootroot################ Lower-level APIs ################ ``python-gitlab``'s API levels provide different degrees of convenience, control and stability. Main interface - ``Gitlab``, managers and objects ================================================= As shown in previous sections and examples, the high-level API interface wraps GitLab's API endpoints and makes them available from the ``Gitlab`` instance via managers that create objects you can manipulate. This is what most users will want to use, as it covers most of GitLab's API endpoints, and allows you to write idiomatic Python code when interacting with the API. Lower-level API - HTTP methods ============================== .. danger:: At this point, python-gitlab will no longer take care of URL-encoding and other transformations needed to correctly pass API parameter types. You have to construct these correctly yourself. However, you still benefit from many of the client's :ref:`features` such as authentication, requests and retry handling. .. important:: If you've found yourself at this section because of an endpoint not yet implemented in the library - please consider opening a pull request implementing the resource or at least filing an issue so we can track progress. High-quality pull requests for standard endpoints that pass CI and include unit tests and documentation are easy to review, and can land quickly with monthly releases. If you ask, we can also trigger a new release, so you and everyone benefits from the contribution right away! Managers and objects call specific HTTP methods to fetch or send data to the server. These methods can be invoked directly to access endpoints not currently implemented by the client. This essentially gives you some level of usability for any endpoint the moment it is available on your GitLab instance. These methods can be accessed directly via the ``Gitlab`` instance (e.g. ``gl.http_get()``), or via an object's manager (e.g. ``project.manager.gitlab.http_get()``), if the ``Gitlab`` instance is not available in the current context. For example, if you'd like to access GitLab's `undocumented latest pipeline endpoint `__, you can do so by calling ``http_get()`` with the path to the endpoint: .. code-block:: python >>> gl = gitlab.Gitlab(private_token=private_token) >>> >>> pipeline = gl.http_get("/projects/gitlab-org%2Fgitlab/pipelines/latest") >>> pipeline["id"] 449070256 The available methods are: * ``http_get()`` * ``http_post()`` * ``http_put()`` * ``http_delete()`` * ``http_list()`` (a wrapper around ``http_get`` handling pagination, including with lazy generators) * ``http_head()`` (only returns the header dictionary) Lower-lower-level API - HTTP requests ===================================== .. important:: This is mostly intended for internal use in python-gitlab and may have a less stable interface than higher-level APIs. To lessen the chances of a change to the interface impacting your code, we recommend using keyword arguments when calling the interfaces. At the lowest level, HTTP methods call ``http_request()``, which performs the actual request and takes care of details such as timeouts, retries, and handling rate-limits. This method can be invoked directly to or customize this behavior for a single request, or to call custom HTTP methods not currently implemented in the library - while still making use of all of the client's options and authentication methods. For example, if for whatever reason you want to fetch allowed methods for an endpoint at runtime: .. code-block:: python >>> gl = gitlab.Gitlab(private_token=private_token) >>> >>> response = gl.http_request(verb="OPTIONS", path="/projects") >>> response.headers["Allow"] 'OPTIONS, GET, POST, HEAD' Or get the total number of a user's events with a customized HEAD request: .. code-block:: python >>> response = gl.http_request( verb="HEAD", path="/events", query_params={"sudo": "some-user"}, timeout=10 ) >>> response.headers["X-Total"] '123' ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api-objects.rst0000644000000000000000000000315614366036457017022 0ustar00rootroot############ API examples ############ .. toctree:: :maxdepth: 1 gl_objects/access_requests gl_objects/appearance gl_objects/applications gl_objects/emojis gl_objects/badges gl_objects/branches gl_objects/bulk_imports gl_objects/messages gl_objects/ci_lint gl_objects/commits gl_objects/deploy_keys gl_objects/deploy_tokens gl_objects/deployments gl_objects/discussions gl_objects/environments gl_objects/events gl_objects/epics gl_objects/features gl_objects/geo_nodes gl_objects/groups gl_objects/group_access_tokens gl_objects/invitations gl_objects/issues gl_objects/iterations gl_objects/keys gl_objects/boards gl_objects/labels gl_objects/notifications gl_objects/merge_trains gl_objects/merge_requests gl_objects/merge_request_approvals.rst gl_objects/milestones gl_objects/namespaces gl_objects/notes gl_objects/packages gl_objects/pagesdomains gl_objects/personal_access_tokens gl_objects/pipelines_and_jobs gl_objects/projects gl_objects/project_access_tokens gl_objects/protected_branches gl_objects/protected_environments gl_objects/releases gl_objects/runners gl_objects/remote_mirrors gl_objects/repositories gl_objects/repository_tags gl_objects/resource_groups gl_objects/search gl_objects/secure_files gl_objects/settings gl_objects/snippets gl_objects/statistics gl_objects/system_hooks gl_objects/templates gl_objects/todos gl_objects/topics gl_objects/users gl_objects/variables gl_objects/sidekiq gl_objects/wikis gl_objects/clusters ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api-usage-advanced.rst0000644000000000000000000001363014366036457020236 0ustar00rootroot############## Advanced usage ############## Using a custom session ---------------------- python-gitlab relies on ``requests.Session`` objects to perform all the HTTP requests to the Gitlab servers. You can provide your own ``Session`` object with custom configuration when you create a ``Gitlab`` object. Context manager --------------- You can use ``Gitlab`` objects as context managers. This makes sure that the ``requests.Session`` object associated with a ``Gitlab`` instance is always properly closed when you exit a ``with`` block: .. code-block:: python with gitlab.Gitlab(host, token) as gl: gl.projects.list() .. warning:: The context manager will also close the custom ``Session`` object you might have used to build the ``Gitlab`` instance. Proxy configuration ------------------- The following sample illustrates how to define a proxy configuration when using python-gitlab: .. code-block:: python import os import gitlab import requests session = requests.Session() session.proxies = { 'https': os.environ.get('https_proxy'), 'http': os.environ.get('http_proxy'), } gl = gitlab.gitlab(url, token, api_version=4, session=session) Reference: https://requests.readthedocs.io/en/latest/user/advanced/#proxies SSL certificate verification ---------------------------- python-gitlab relies on the CA certificate bundle in the ``certifi`` package that comes with the requests library. If you need python-gitlab to use your system CA store instead, you can provide the path to the CA bundle in the ``REQUESTS_CA_BUNDLE`` environment variable. Reference: https://requests.readthedocs.io/en/latest/user/advanced/#ssl-cert-verification Client side certificate ----------------------- The following sample illustrates how to use a client-side certificate: .. code-block:: python import gitlab import requests session = requests.Session() session.cert = ('/path/to/client.cert', '/path/to/client.key') gl = gitlab.gitlab(url, token, api_version=4, session=session) Reference: https://requests.readthedocs.io/en/latest/user/advanced/#client-side-certificates Rate limits ----------- python-gitlab obeys the rate limit of the GitLab server by default. On receiving a 429 response (Too Many Requests), python-gitlab sleeps for the amount of time in the Retry-After header that GitLab sends back. If GitLab does not return a response with the Retry-After header, python-gitlab will perform an exponential backoff. If you don't want to wait, you can disable the rate-limiting feature, by supplying the ``obey_rate_limit`` argument. .. code-block:: python import gitlab import requests gl = gitlab.gitlab(url, token, api_version=4) gl.projects.list(get_all=True, obey_rate_limit=False) If you do not disable the rate-limiting feature, you can supply a custom value for ``max_retries``; by default, this is set to 10. To retry without bound when throttled, you can set this parameter to -1. This parameter is ignored if ``obey_rate_limit`` is set to ``False``. .. code-block:: python import gitlab import requests gl = gitlab.gitlab(url, token, api_version=4) gl.projects.list(get_all=True, max_retries=12) .. warning:: You will get an Exception, if you then go over the rate limit of your GitLab instance. Transient errors ---------------- GitLab server can sometimes return a transient HTTP error. python-gitlab can automatically retry in such case, when ``retry_transient_errors`` argument is set to ``True``. When enabled, HTTP error codes 500 (Internal Server Error), 502 (502 Bad Gateway), 503 (Service Unavailable), 504 (Gateway Timeout), and Cloudflare errors (520-530) are retried. Additionally, HTTP error code 409 (Conflict) is retried if the reason is a `Resource lock `__. It will retry until reaching the ``max_retries`` value. By default, ``retry_transient_errors`` is set to ``False`` and an exception is raised for these errors. .. code-block:: python import gitlab import requests gl = gitlab.gitlab(url, token, api_version=4) gl.projects.list(get_all=True, retry_transient_errors=True) The default ``retry_transient_errors`` can also be set on the ``Gitlab`` object and overridden by individual API calls. .. code-block:: python import gitlab import requests gl = gitlab.gitlab(url, token, api_version=4, retry_transient_errors=True) gl.projects.list(get_all=True) # retries due to default value gl.projects.list(get_all=True, retry_transient_errors=False) # does not retry Timeout ------- python-gitlab will by default use the ``timeout`` option from its configuration for all requests. This is passed downwards to the ``requests`` module at the time of making the HTTP request. However if you would like to override the global timeout parameter for a particular call, you can provide the ``timeout`` parameter to that API invocation: .. code-block:: python import gitlab gl = gitlab.gitlab(url, token, api_version=4) gl.projects.import_github(ACCESS_TOKEN, 123456, "root", timeout=120.0) Typing ------ Generally, ``python-gitlab`` is a fully typed package. However, currently you may still need to do some `type narrowing `_ on your own, such as for nested API responses and ``Union`` return types. For example: .. code-block:: python from typing import TYPE_CHECKING import gitlab gl = gitlab.gitlab(url, token, api_version=4) license = gl.get_license() if TYPE_CHECKING: assert isinstance(license["plan"], str) Custom session (Bring your own Session) --------------------------------------- You can use configuration files and a custom session to create ``gitlab.Gitlab`` objects: .. code-block:: python gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'], session=custom_session) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/api-usage.rst0000644000000000000000000003431314366036457016474 0ustar00rootroot############################ Getting started with the API ############################ python-gitlab only supports GitLab API v4. ``gitlab.Gitlab`` class ======================= To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab`` object: .. hint:: You can use different types of tokens for authenticated requests against the GitLab API. You will most likely want to use a resource (project/group) access token or a personal access token. For the full list of available options and how to obtain these tokens, please see https://docs.gitlab.com/ee/api/index.html#authentication. .. code-block:: python import gitlab # anonymous read-only access for public resources (GitLab.com) gl = gitlab.Gitlab() # anonymous read-only access for public resources (self-hosted GitLab instance) gl = gitlab.Gitlab('https://gitlab.example.com') # private token or personal token authentication (GitLab.com) gl = gitlab.Gitlab(private_token='JVNSESs8EwWRx5yDxM5q') # private token or personal token authentication (self-hosted GitLab instance) gl = gitlab.Gitlab(url='https://gitlab.example.com', private_token='JVNSESs8EwWRx5yDxM5q') # oauth token authentication gl = gitlab.Gitlab('https://gitlab.example.com', oauth_token='my_long_token_here') # job token authentication (to be used in CI) # bear in mind the limitations of the API endpoints it supports: # https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html import os gl = gitlab.Gitlab('https://gitlab.example.com', job_token=os.environ['CI_JOB_TOKEN']) # Define your own custom user agent for requests gl = gitlab.Gitlab('https://gitlab.example.com', user_agent='my-package/1.0.0') # make an API request to create the gl.user object. This is not required but may be useful # to validate your token authentication. Note that this will not work with job tokens. gl.auth() # Enable "debug" mode. This can be useful when trying to determine what # information is being sent back and forth to the GitLab server. # Note: this will cause credentials and other potentially sensitive # information to be printed to the terminal. gl.enable_debug() You can also use configuration files to create ``gitlab.Gitlab`` objects: .. code-block:: python gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg']) See the :ref:`cli_configuration` section for more information about configuration files. .. warning:: Note that a url that results in 301/302 redirects will raise an error, so it is highly recommended to use the final destination in the ``url`` field. For example, if the GitLab server you are using redirects requests from http to https, make sure to use the ``https://`` protocol in the URL definition. A URL that redirects using 301/302 (rather than 307/308) will most likely `cause malformed POST and PUT requests `_. python-gitlab will therefore raise a ``RedirectionError`` when it encounters a redirect which it believes will cause such an error, to avoid confusion between successful GET and failing POST/PUT requests on the same instance. Note on password authentication ------------------------------- GitLab has long removed password-based basic authentication. You can currently still use the `resource owner password credentials `_ flow to obtain an OAuth token. However, we do not recommend this as it will not work with 2FA enabled, and GitLab is removing ROPC-based flows without client IDs in a future release. We recommend you obtain tokens for automated workflows as linked above or obtain a session cookie from your browser. For a python example of password authentication using the ROPC-based OAuth2 flow, see `this Ansible snippet `_. Managers ======== The ``gitlab.Gitlab`` class provides managers to access the GitLab resources. Each manager provides a set of methods to act on the resources. The available methods depend on the resource type. Examples: .. code-block:: python # list all the projects projects = gl.projects.list(iterator=True) for project in projects: print(project) # get the group with id == 2 group = gl.groups.get(2) for project in group.projects.list(iterator=True): print(project) .. warning:: Calling ``list()`` without any arguments will by default not return the complete list of items. Use either the ``get_all=True`` or ``iterator=True`` parameters to get all the items when using listing methods. See the :ref:`pagination` section for more information. .. code-block:: python # create a new user user_data = {'email': 'jen@foo.com', 'username': 'jen', 'name': 'Jen'} user = gl.users.create(user_data) print(user) .. note:: python-gitlab attempts to sync the required, optional, and mutually exclusive attributes for resource creation and update with the upstream API. You are encouraged to follow upstream API documentation for each resource to find these - each resource documented here links to the corresponding upstream resource documentation at the top of the page. The attributes of objects are defined upon object creation, and depend on the GitLab API itself. To list the available information associated with an object use the ``attributes`` attribute: .. code-block:: python project = gl.projects.get(1) print(project.attributes) Some objects also provide managers to access related GitLab resources: .. code-block:: python # list the issues for a project project = gl.projects.get(1) issues = project.issues.list(get_all=True) python-gitlab allows to send any data to the GitLab server when making queries. In case of invalid or missing arguments python-gitlab will raise an exception with the GitLab server error message: .. code-block:: python >>> gl.projects.list(sort='invalid value') ... GitlabListError: 400: sort does not have a valid value You can use the ``query_parameters`` argument to send arguments that would conflict with python or python-gitlab when using them as kwargs: .. code-block:: python gl.user_activities.list(from='2019-01-01', iterator=True) ## invalid gl.user_activities.list(query_parameters={'from': '2019-01-01'}, iterator=True) # OK .. _objects: Gitlab Objects ============== You can update or delete a remote object when it exists locally: .. code-block:: python # update the attributes of a resource project = gl.projects.get(1) project.wall_enabled = False # don't forget to apply your changes on the server: project.save() # delete the resource project.delete() Some classes provide additional methods, allowing more actions on the GitLab resources. For example: .. code-block:: python # star a git repository project = gl.projects.get(1) project.star() You can print a Gitlab Object. For example: .. code-block:: python project = gl.projects.get(1) print(project) # Or in a prettier format. project.pprint() # Or explicitly via ``pformat()``. This is equivalent to the above. print(project.pformat()) You can also extend the object if the parameter isn't explicitly listed. For example, if you want to update a field that has been newly introduced to the Gitlab API, setting the value on the object is accepted: .. code-block:: python issues = project.issues.list(state='opened') for issue in issues: issue.my_super_awesome_feature_flag = "random_value" issue.save() As a dictionary --------------- You can get a dictionary representation copy of the Gitlab Object. Modifications made to the dictionary will have no impact on the GitLab Object. * ``asdict()`` method. Returns a dictionary representation of the Gitlab object. * ``attributes`` property. Returns a dictionary representation of the Gitlab object. Also returns any relevant parent object attributes. .. code-block:: python project = gl.projects.get(1) project_dict = project.asdict() # Or a dictionary representation also containing some of the parent attributes issue = project.issues.get(1) attribute_dict = issue.attributes # The following will return the same value title = issue.title title = issue.attributes["title"] .. hint:: This can be used to access attributes that clash with python-gitlab's own methods or managers. Note that: ``attributes`` returns the parent object attributes that are defined in ``object._from_parent_attrs``. For example, a ``ProjectIssue`` object will have a ``project_id`` key in the dictionary returned from ``attributes`` but ``asdict()`` will not. As JSON ------- You can get a JSON string represenation of the Gitlab Object. For example: .. code-block:: python project = gl.projects.get(1) print(project.to_json()) # Use arguments supported by ``json.dump()`` print(project.to_json(sort_keys=True, indent=4)) Base types ========== The ``gitlab`` package provides some base types. * ``gitlab.Gitlab`` is the primary class, handling the HTTP requests. It holds the GitLab URL and authentication information. * ``gitlab.base.RESTObject`` is the base class for all the GitLab v4 objects. These objects provide an abstraction for GitLab resources (projects, groups, and so on). * ``gitlab.base.RESTManager`` is the base class for v4 objects managers, providing the API to manipulate the resources and their attributes. Lazy objects ============ To avoid useless API calls to the server you can create lazy objects. These objects are created locally using a known ID, and give access to other managers and methods. The following example will only make one API call to the GitLab server to star a project (the previous example used 2 API calls): .. code-block:: python # star a git repository project = gl.projects.get(1, lazy=True) # no API call project.star() # API call ``head()`` methods ======================== All endpoints that support ``get()`` and ``list()`` also support a ``head()`` method. In this case, the server responds only with headers and not the response JSON or body. This allows more efficient API calls, such as checking repository file size without fetching its content. .. note:: In some cases, GitLab may omit specific headers. See more in the :ref:`pagination` section. .. code-block:: python # See total number of personal access tokens for current user gl.personal_access_tokens.head() print(headers["X-Total"]) # See returned content-type for project GET endpoint headers = gl.projects.head("gitlab-org/gitlab") print(headers["Content-Type"]) .. _pagination: Pagination ========== You can use pagination to iterate over long lists. All the Gitlab objects listing methods support the ``page`` and ``per_page`` parameters: .. code-block:: python ten_first_groups = gl.groups.list(page=1, per_page=10) .. warning:: The first page is page 1, not page 0. By default GitLab does not return the complete list of items. Use the ``get_all`` parameter to get all the items when using listing methods: .. code-block:: python all_groups = gl.groups.list(get_all=True) all_owned_projects = gl.projects.list(owned=True, get_all=True) You can define the ``per_page`` value globally to avoid passing it to every ``list()`` method call: .. code-block:: python gl = gitlab.Gitlab(url, token, per_page=50) Gitlab allows to also use keyset pagination. You can supply it to your project listing, but you can also do so globally. Be aware that GitLab then also requires you to only use supported order options. At the time of writing, only ``order_by="id"`` works. .. code-block:: python gl = gitlab.Gitlab(url, token, pagination="keyset", order_by="id", per_page=100) gl.projects.list() Reference: https://docs.gitlab.com/ce/api/README.html#keyset-based-pagination ``list()`` methods can also return a generator object, by passing the argument ``iterator=True``, which will handle the next calls to the API when required. This is the recommended way to iterate through a large number of items: .. code-block:: python items = gl.groups.list(iterator=True) for item in items: print(item.attributes) The generator exposes extra listing information as received from the server: * ``current_page``: current page number (first page is 1) * ``prev_page``: if ``None`` the current page is the first one * ``next_page``: if ``None`` the current page is the last one * ``per_page``: number of items per page * ``total_pages``: total number of pages available. This may be a ``None`` value. * ``total``: total number of items in the list. This may be a ``None`` value. .. note:: For performance reasons, if a query returns more than 10,000 records, GitLab does not return the ``total_pages`` or ``total`` headers. In this case, ``total_pages`` and ``total`` will have a value of ``None``. For more information see: https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers .. note:: Prior to python-gitlab 3.6.0 the argument ``as_list`` was used instead of ``iterator``. ``as_list=False`` is the equivalent of ``iterator=True``. .. note:: If ``page`` and ``iterator=True`` are used together, the latter is ignored. Sudo ==== If you have the administrator status, you can use ``sudo`` to act as another user. For example: .. code-block:: python p = gl.projects.create({'name': 'awesome_project'}, sudo='user1') .. _object_attributes: Attributes in updated objects ============================= When methods manipulate an existing object, such as with ``refresh()`` and ``save()``, the object will only have attributes that were returned by the server. In some cases, such as when the initial request fetches attributes that are needed later for additional processing, this may not be desired: .. code-block:: python project = gl.projects.get(1, statistics=True) project.statistics project.refresh() project.statistics # AttributeError To avoid this, either copy the object/attributes before calling ``refresh()``/``save()`` or subsequently perform another ``get()`` call as needed, to fetch the attributes you want. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/changelog.md0000644000000000000000000000004114366036457016327 0ustar00rootroot```{include} ../CHANGELOG.md ``` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/cli-examples.rst0000644000000000000000000001677414366036457017217 0ustar00rootroot############ CLI examples ############ .. seealso:: For a complete list of objects and actions available, see :doc:`/cli-objects`. CI Lint ------- Lint a CI YAML configuration from a string: .. note:: To see output, you will need to use the ``-v``/``--verbose`` flag. To exit with non-zero on YAML lint failures instead, use the ``validate`` subcommand shown below. .. code-block:: console $ gitlab --verbose ci-lint create --content \ "--- test: script: - echo hello " Lint a CI YAML configuration from a file (see :ref:`cli_from_files`): .. code-block:: console $ gitlab --verbose ci-lint create --content @.gitlab-ci.yml Validate a CI YAML configuration from a file (lints and exits with non-zero on failure): .. code-block:: console $ gitlab ci-lint validate --content @.gitlab-ci.yml Lint a project's CI YAML configuration: .. code-block:: console $ gitlab --verbose project-ci-lint create --project-id group/my-project --content @.gitlab-ci.yml Validate a project's CI YAML configuration (lints and exits with non-zero on failure): .. code-block:: console $ gitlab project-ci-lint validate --project-id group/my-project --content @.gitlab-ci.yml Lint a project's current CI YAML configuration: .. code-block:: console $ gitlab --verbose project-ci-lint get --project-id group/my-project Lint a project's current CI YAML configuration on a specific branch: .. code-block:: console $ gitlab --verbose project-ci-lint get --project-id group/my-project --ref my-branch Projects -------- List the projects (paginated): .. code-block:: console $ gitlab project list List all the projects: .. code-block:: console $ gitlab project list --get-all List all projects of a group: .. code-block:: console $ gitlab group-project list --get-all --group-id 1 List all projects of a group and its subgroups: .. code-block:: console $ gitlab group-project list --get-all --include-subgroups true --group-id 1 Limit to 5 items per request, display the 1st page only .. code-block:: console $ gitlab project list --page 1 --per-page 5 Get a specific project (id 2): .. code-block:: console $ gitlab project get --id 2 Users ----- Get a specific user by id: .. code-block:: console $ gitlab user get --id 3 Create a user impersonation token (admin-only): .. code-block:: console gitlab user-impersonation-token create --user-id 2 --name test-token --scopes api,read_user Deploy tokens ------------- Create a deploy token for a project: .. code-block:: console $ gitlab -v project-deploy-token create --project-id 2 \ --name bar --username root --expires-at "2021-09-09" --scopes "api,read_repository" List deploy tokens for a group: .. code-block:: console $ gitlab -v group-deploy-token list --group-id 3 Personal access tokens ---------------------- List the current user's personal access tokens (or all users' tokens, if admin): .. code-block:: console $ gitlab -v personal-access-token list Revoke a personal access token by id: .. code-block:: console $ gitlab personal-access-token delete --id 1 Revoke the personal access token currently used: .. code-block:: console $ gitlab personal-access-token delete --id self Create a personal access token for a user (admin only): .. code-block:: console $ gitlab -v user-personal-access-token create --user-id 2 \ --name personal-access-token --expires-at "2023-01-01" --scopes "api,read_repository" Resource access tokens ---------------------- Create a project access token: .. code-block:: console $ gitlab -v project-access-token create --project-id 2 \ --name project-token --expires-at "2023-01-01" --scopes "api,read_repository" List project access tokens: .. code-block:: console $ gitlab -v project-access-token list --project-id 3 Revoke a project access token: .. code-block:: console $ gitlab project-access-token delete --project-id 3 --id 1 Create a group access token: .. code-block:: console $ gitlab -v group-access-token create --group-id 2 \ --name group-token --expires-at "2022-01-01" --scopes "api,read_repository" List group access tokens: .. code-block:: console $ gitlab -v group-access-token list --group-id 3 Revoke a group access token: .. code-block:: console $ gitlab group-access-token delete --group-id 3 --id 1 Packages -------- List packages for a project: .. code-block:: console $ gitlab -v project-package list --project-id 3 List packages for a group: .. code-block:: console $ gitlab -v group-package list --group-id 3 Get a specific project package by id: .. code-block:: console $ gitlab -v project-package get --id 1 --project-id 3 Delete a specific project package by id: .. code-block:: console $ gitlab -v project-package delete --id 1 --project-id 3 Upload a generic package to a project: .. code-block:: console $ gitlab generic-package upload --project-id 1 --package-name hello-world \ --package-version v1.0.0 --file-name hello.tar.gz --path /path/to/hello.tar.gz Download a project's generic package: .. code-block:: console $ gitlab generic-package download --project-id 1 --package-name hello-world \ --package-version v1.0.0 --file-name hello.tar.gz > /path/to/hello.tar.gz Issues ------ Get a list of issues for this project: .. code-block:: console $ gitlab project-issue list --project-id 2 Snippets -------- Delete a snippet (id 3): .. code-block:: console $ gitlab project-snippet delete --id 3 --project-id 2 Update a snippet: .. code-block:: console $ gitlab project-snippet update --id 4 --project-id 2 \ --code "My New Code" Create a snippet: .. code-block:: console $ gitlab project-snippet create --project-id 2 Impossible to create object (Missing attribute(s): title, file-name, code) $ # oops, let's add the attributes: $ gitlab project-snippet create --project-id 2 --title "the title" \ --file-name "the name" --code "the code" Commits ------- Get a specific project commit by its SHA id: .. code-block:: console $ gitlab project-commit get --project-id 2 --id a43290c Get the signature (e.g. GPG or x509) of a signed commit: .. code-block:: console $ gitlab project-commit signature --project-id 2 --id a43290c Define the status of a commit (as would be done from a CI tool for example): .. code-block:: console $ gitlab project-commit-status create --project-id 2 \ --commit-id a43290c --state success --name ci/jenkins \ --target-url http://server/build/123 \ --description "Jenkins build succeeded" Get the merge base for two or more branches, tags or commits: .. code-block:: console gitlab project repository-merge-base --id 1 --refs bd1324e2f,main,v1.0.0 Artifacts --------- Download the artifacts zip archive of a job: .. code-block:: console $ gitlab project-job artifacts --id 10 --project-id 1 > artifacts.zip Runners ------- List owned runners: .. code-block:: console $ gitlab runner list List owned runners with a filter: .. code-block:: console $ gitlab runner list --scope active List all runners in the GitLab instance (specific and shared): .. code-block:: console $ gitlab runner-all list Get a runner's details: .. code-block:: console $ gitlab -v runner get --id 123 Other ----- Use sudo to act as another user (admin only): .. code-block:: console $ gitlab project create --name user_project1 --sudo username List values are comma-separated: .. code-block:: console $ gitlab issue list --labels foo,bar././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/cli-objects.rst0000644000000000000000000000120314366036457017007 0ustar00rootroot################################## CLI reference (``gitlab`` command) ################################## .. warning:: The following is a complete, auto-generated list of subcommands available via the :command:`gitlab` command-line tool. Some of the actions may currently not work as expected or lack functionality available via the API. Please see the existing `list of CLI related issues`_, or open a new one if it is not already listed there. .. _list of CLI related issues: https://github.com/python-gitlab/python-gitlab/issues?q=is%3Aopen+is%3Aissue+label%3Acli .. autoprogram:: gitlab.cli:docs() :prog: gitlab ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/cli-usage.rst0000644000000000000000000002521114366036457016467 0ustar00rootroot############################ Getting started with the CLI ############################ ``python-gitlab`` provides a :command:`gitlab` command-line tool to interact with GitLab servers. This is especially convenient for running quick ad-hoc commands locally, easily interacting with the API inside GitLab CI, or with more advanced shell scripting when integrating with other tooling. .. _cli_configuration: Configuration ============= ``gitlab`` allows setting configuration options via command-line arguments, environment variables, and configuration files. For a complete list of global CLI options and their environment variable equivalents, see :doc:`/cli-objects`. With no configuration provided, ``gitlab`` will default to unauthenticated requests against `GitLab.com `__. With no configuration but running inside a GitLab CI job, it will default to authenticated requests using the current job token against the current instance (via ``CI_SERVER_URL`` and ``CI_JOB_TOKEN`` environment variables). .. warning:: Please note the job token has very limited permissions and can only be used with certain endpoints. You may need to provide a personal access token instead. When you provide configuration, values are evaluated with the following precedence: 1. Explicitly provided CLI arguments, 2. Environment variables, 3. Configuration files: a. explicitly defined config files: i. via the ``--config-file`` CLI argument, ii. via the ``PYTHON_GITLAB_CFG`` environment variable, b. user-specific config file, c. system-level config file, 4. Environment variables always present in CI (``CI_SERVER_URL``, ``CI_JOB_TOKEN``). Additionally, authentication will take the following precedence when multiple options or environment variables are present: 1. Private token, 2. OAuth token, 3. CI job token. Configuration files ------------------- ``gitlab`` looks up 3 configuration files by default: The ``PYTHON_GITLAB_CFG`` environment variable An environment variable that contains the path to a configuration file. ``/etc/python-gitlab.cfg`` System-wide configuration file ``~/.python-gitlab.cfg`` User configuration file You can use a different configuration file with the ``--config-file`` option. .. warning:: If the ``PYTHON_GITLAB_CFG`` environment variable is defined and the target file exists, it will be the only configuration file parsed by ``gitlab``. If the environment variable is defined and the target file cannot be accessed, ``gitlab`` will fail explicitly. Configuration file format ------------------------- The configuration file uses the ``INI`` format. It contains at least a ``[global]`` section, and a specific section for each GitLab server. For example: .. code-block:: ini [global] default = somewhere ssl_verify = true timeout = 5 [somewhere] url = https://some.whe.re private_token = vTbFeqJYCY3sibBP7BZM api_version = 4 [elsewhere] url = http://else.whe.re:8080 private_token = helper: path/to/helper.sh timeout = 1 The ``default`` option of the ``[global]`` section defines the GitLab server to use if no server is explicitly specified with the ``--gitlab`` CLI option. The ``[global]`` section also defines the values for the default connection parameters. You can override the values in each GitLab server section. .. list-table:: Global options :header-rows: 1 * - Option - Possible values - Description * - ``ssl_verify`` - ``True``, ``False``, or a ``str`` - Verify the SSL certificate. Set to ``False`` to disable verification, though this will create warnings. Any other value is interpreted as path to a CA_BUNDLE file or directory with certificates of trusted CAs. * - ``timeout`` - Integer - Number of seconds to wait for an answer before failing. * - ``api_version`` - ``4`` - The API version to use to make queries. Only ``4`` is available since 1.5.0. * - ``per_page`` - Integer between 1 and 100 - The number of items to return in listing queries. GitLab limits the value at 100. * - ``user_agent`` - ``str`` - A string defining a custom user agent to use when ``gitlab`` makes requests. You must define the ``url`` in each GitLab server section. .. warning:: Note that a url that results in 301/302 redirects will raise an error, so it is highly recommended to use the final destination in the ``url`` field. For example, if the GitLab server you are using redirects requests from http to https, make sure to use the ``https://`` protocol in the URL definition. A URL that redirects using 301/302 (rather than 307/308) will most likely `cause malformed POST and PUT requests `_. python-gitlab will therefore raise a ``RedirectionError`` when it encounters a redirect which it believes will cause such an error, to avoid confusion between successful GET and failing POST/PUT requests on the same instance. Only one of ``private_token``, ``oauth_token`` or ``job_token`` should be defined. If neither are defined an anonymous request will be sent to the Gitlab server, with very limited permissions. We recommend that you use `Credential helpers`_ to securely store your tokens. .. list-table:: GitLab server options :header-rows: 1 * - Option - Description * - ``url`` - URL for the GitLab server. Do **NOT** use a URL which redirects. * - ``private_token`` - Your user token. Login/password is not supported. Refer to `the official documentation `__ to learn how to obtain a token. * - ``oauth_token`` - An Oauth token for authentication. The Gitlab server must be configured to support this authentication method. * - ``job_token`` - Your job token. See `the official documentation `__ to learn how to obtain a token. * - ``api_version`` - GitLab API version to use. Only ``4`` is available since 1.5.0. Credential helpers ------------------ For all configuration options that contain secrets (for example, ``personal_token``, ``oauth_token``, ``job_token``), you can specify a helper program to retrieve the secret indicated by a ``helper:`` prefix. This allows you to fetch values from a local keyring store or cloud-hosted vaults such as Bitwarden. Environment variables are expanded if they exist and ``~`` expands to your home directory. It is expected that the helper program prints the secret to standard output. To use shell features such as piping to retrieve the value, you will need to use a wrapper script; see below. Example for a `keyring `_ helper: .. code-block:: ini [global] default = somewhere ssl_verify = true timeout = 5 [somewhere] url = http://somewhe.re private_token = helper: keyring get Service Username timeout = 1 Example for a `pass `_ helper with a wrapper script: .. code-block:: ini [global] default = somewhere ssl_verify = true timeout = 5 [somewhere] url = http://somewhe.re private_token = helper: /path/to/helper.sh timeout = 1 In ``/path/to/helper.sh``: .. code-block:: bash #!/bin/bash pass show path/to/credentials | head -n 1 CLI === Objects and actions ------------------- The ``gitlab`` command expects two mandatory arguments. The first one is the type of object that you want to manipulate. The second is the action that you want to perform. For example: .. code-block:: console $ gitlab project list Use the ``--help`` option to list the available object types and actions: .. code-block:: console $ gitlab --help $ gitlab project --help Some actions require additional parameters. Use the ``--help`` option to list mandatory and optional arguments for an action: .. code-block:: console $ gitlab project create --help Optional arguments ------------------ Use the following optional arguments to change the behavior of ``gitlab``. These options must be defined before the mandatory arguments. ``--verbose``, ``-v`` Outputs detail about retrieved objects. Available for legacy (default) output only. ``--config-file``, ``-c`` Path to a configuration file. ``--gitlab``, ``-g`` ID of a GitLab server defined in the configuration file. ``--output``, ``-o`` Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``. .. important:: The `PyYAML package `_ is required to use the yaml output option. You need to install it explicitly using ``pip install python-gitlab[yaml]`` ``--fields``, ``-f`` Comma-separated list of fields to display (``yaml`` and ``json`` output formats only). If not used, all the object fields are displayed. Example: .. code-block:: console $ gitlab -o yaml -f id,permissions -g elsewhere -c /tmp/gl.cfg project list .. _cli_from_files: Reading values from files ------------------------- You can make ``gitlab`` read values from files instead of providing them on the command line. This is handy for values containing new lines for instance: .. code-block:: console $ cat > /tmp/description << EOF This is the description of my project. It is obviously the best project around EOF $ gitlab project create --name SuperProject --description @/tmp/description Enabling shell autocompletion ============================= To get autocompletion, you'll need to install the package with the extra "autocompletion": .. code-block:: console pip install python_gitlab[autocompletion] Add the appropriate command below to your shell's config file so that it is run on startup. You will likely have to restart or re-login for the autocompletion to start working. Bash ---- .. code-block:: console eval "$(register-python-argcomplete gitlab)" tcsh ---- .. code-block:: console eval ``register-python-argcomplete --shell tcsh gitlab`` fish ---- .. code-block:: console register-python-argcomplete --shell fish gitlab | . Zsh --- .. warning:: Zsh autocompletion support is broken right now in the argcomplete python package. Perhaps it will be fixed in a future release of argcomplete at which point the following instructions will enable autocompletion in zsh. To activate completions for zsh you need to have bashcompinit enabled in zsh: .. code-block:: console autoload -U bashcompinit bashcompinit Afterwards you can enable completion for gitlab: .. code-block:: console eval "$(register-python-argcomplete gitlab)" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/conf.py0000644000000000000000000002320214366036457015361 0ustar00rootroot#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # python-gitlab documentation build configuration file, created by # sphinx-quickstart on Mon Dec 8 15:17:39 2014. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. from __future__ import unicode_literals import os import sys from datetime import datetime from sphinx.domains.python import PythonDomain sys.path.append("../") sys.path.append(os.path.dirname(__file__)) import gitlab # noqa: E402. Needed purely for readthedocs' build # Sphinx will warn when attributes are exported in multiple places. See workaround: # https://github.com/sphinx-doc/sphinx/issues/3866#issuecomment-768167824 # This patch can be removed when this issue is resolved: # https://github.com/sphinx-doc/sphinx/issues/4961 class PatchedPythonDomain(PythonDomain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): if "refspecific" in node: del node["refspecific"] return super(PatchedPythonDomain, self).resolve_xref( env, fromdocname, builder, typ, target, node, contnode ) def setup(sphinx): sphinx.add_domain(PatchedPythonDomain, override=True) on_rtd = os.environ.get("READTHEDOCS", None) == "True" year = datetime.now().year # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.autosummary", "ext.docstrings", "sphinxcontrib.autoprogram", ] autodoc_typehints = "both" # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix of source filenames. source_suffix = {".rst": "restructuredtext", ".md": "markdown"} # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. root_doc = "index" # General information about the project. project = "python-gitlab" copyright = gitlab.__copyright__ # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = gitlab.__version__ # The full version, including alpha/beta/rc tags. release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = "furo" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = f"{project} v{release}" # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] html_js_files = [ "js/gitter.js", ( "https://sidecar.gitter.im/dist/sidecar.v1.js", {"async": "async", "defer": "defer"}, ), ] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. # html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = "python-gitlabdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ( "index", "python-gitlab.tex", "python-gitlab Documentation", "Gauvain Pocentek, Mika Mäenpää", "manual", ) ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ( "index", "python-gitlab", "python-gitlab Documentation", ["Gauvain Pocentek, Mika Mäenpää"], 1, ) ] # If true, show URL addresses after external links. # man_show_urls = False nitpick_ignore_regex = [(r"py:.*", r".*")] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( "index", "python-gitlab", "python-gitlab Documentation", "Gauvain Pocentek, Mika Mäenpää", "python-gitlab", "One line description of project.", "Miscellaneous", ) ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.2947912 python-gitlab-3.13.0/docs/ext/0000755000000000000000000000000014366036463014660 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/ext/__init__.py0000644000000000000000000000000014366036457016762 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/ext/docstrings.py0000644000000000000000000000327214366036457017420 0ustar00rootrootimport inspect import os import jinja2 import sphinx import sphinx.ext.napoleon as napoleon from sphinx.ext.napoleon.docstring import GoogleDocstring def classref(value, short=True): return value if not inspect.isclass(value): return f":class:{value}" tilde = "~" if short else "" return f":class:`{tilde}gitlab.objects.{value.__name__}`" def setup(app): app.connect("autodoc-process-docstring", _process_docstring) app.connect("autodoc-skip-member", napoleon._skip_member) conf = napoleon.Config._config_values for name, (default, rebuild) in conf.items(): app.add_config_value(name, default, rebuild) return {"version": sphinx.__display_version__, "parallel_read_safe": True} def _process_docstring(app, what, name, obj, options, lines): result_lines = lines docstring = GitlabDocstring(result_lines, app.config, app, what, name, obj, options) result_lines = docstring.lines() lines[:] = result_lines[:] class GitlabDocstring(GoogleDocstring): def _build_doc(self, tmpl, **kwargs): env = jinja2.Environment( loader=jinja2.FileSystemLoader(os.path.dirname(__file__)), trim_blocks=False ) env.filters["classref"] = classref template = env.get_template(tmpl) output = template.render(**kwargs) return output.split("\n") def __init__( self, docstring, config=None, app=None, what="", name="", obj=None, options=None ): super().__init__(docstring, config, app, what, name, obj, options) if name.startswith("gitlab.v4.objects") and name.endswith("Manager"): self._parsed_lines.extend(self._build_doc("manager_tmpl.j2", cls=self._obj)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/ext/manager_tmpl.j20000644000000000000000000000233614366036457017572 0ustar00rootroot{% if cls._list_filters %} **Object listing filters** {% for item in cls._list_filters %} - ``{{ item }}`` {% endfor %} {% endif %} {% if cls._create_attrs %} **Object Creation** {% if cls._create_attrs.required %} Required attributes for object create: {% for item in cls._create_attrs.required %} - ``{{ item }}`` {% endfor %} {% endif %} {% if cls._create_attrs.optional %} Optional attributes for object create: {% for item in cls._create_attrs.optional %} - ``{{ item }}`` {% endfor %} {% endif %} {% if cls._create_attrs.exclusive %} Mutually exclusive attributes for object create: {% for item in cls._create_attrs.exclusive %} - ``{{ item }}`` {% endfor %} {% endif %} {% endif %} {% if cls._update_attrs %} **Object update** {% if cls._update_attrs.required %} Required attributes for object update: {% for item in cls._update_attrs.required %} - ``{{ item }}`` {% endfor %} {% endif %} {% if cls._update_attrs.optional %} Optional attributes for object update: {% for item in cls._update_attrs.optional %} - ``{{ item }}`` {% endfor %} {% endif %} {% if cls._update_attrs.exclusive %} Mutually exclusive attributes for object update: {% for item in cls._update_attrs.exclusive %} - ``{{ item }}`` {% endfor %} {% endif %} {% endif %} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/faq.rst0000644000000000000000000000561214366036457015370 0ustar00rootroot### FAQ ### General ------- I cannot edit the merge request / issue I've just retrieved. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""" It is likely that you used a ``MergeRequest``, ``GroupMergeRequest``, ``Issue`` or ``GroupIssue`` object. These objects cannot be edited. But you can create a new ``ProjectMergeRequest`` or ``ProjectIssue`` object to apply changes. For example:: issue = gl.issues.list()[0] project = gl.projects.get(issue.project_id, lazy=True) editable_issue = project.issues.get(issue.iid, lazy=True) # you can now edit the object See the :ref:`merge requests example ` and the :ref:`issues examples `. How can I clone the repository of a project? """""""""""""""""""""""""""""""""""""""""""" python-gitlab does not provide an API to clone a project. You have to use a git library or call the ``git`` command. The git URI is exposed in the ``ssh_url_to_repo`` attribute of ``Project`` objects. Example:: import subprocess project = gl.projects.create(data) # or gl.projects.get(project_id) print(project.attributes) # displays all the attributes git_url = project.ssh_url_to_repo subprocess.call(['git', 'clone', git_url]) Not all items are returned from the API """"""""""""""""""""""""""""""""""""""" If you've passed ``all=True`` (or ``--all`` via the CLI) to the API and still cannot see all items returned, use ``get_all=True`` (or ``--get-all`` via the CLI) instead. See :ref:`pagination` for more details. Common errors ------------- .. _attribute_error_list: ``AttributeError`` when accessing object attributes retrieved via ``list()`` """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Fetching a list of objects does not always include all attributes in the objects. To retrieve an object with all attributes, use a ``get()`` call. Example with projects:: for projects in gl.projects.list(): # Retrieve project object with all attributes project = gl.projects.get(project.id) ``AttributeError`` when accessing attributes after ``save()`` or ``refresh()`` """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" You are most likely trying to access an attribute that was not returned by the server on the second request. Please look at the documentation in :ref:`object_attributes` to see how to avoid this. ``TypeError`` when accessing object attributes """""""""""""""""""""""""""""""""""""""""""""" When you encounter errors such as ``object is not iterable`` or ``object is not subscriptable`` when trying to access object attributes returned from the server, you are most likely trying to access an attribute that is shadowed by python-gitlab's own methods or managers. You can use the object's ``attributes`` dictionary to access it directly instead. See the :ref:`objects` section for more details on how attributes are exposed. ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.302791 python-gitlab-3.13.0/docs/gl_objects/0000755000000000000000000000000014366036463016173 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/access_requests.rst0000644000000000000000000000271714366036457022133 0ustar00rootroot############### Access requests ############### Users can request access to groups and projects. When access is granted the user should be given a numerical access level. The following constants are provided to represent the access levels: * ``gitlab.const.AccessLevel.GUEST``: ``10`` * ``gitlab.const.AccessLevel.REPORTER``: ``20`` * ``gitlab.const.AccessLevel.DEVELOPER``: ``30`` * ``gitlab.const.AccessLevel.MAINTAINER``: ``40`` * ``gitlab.const.AccessLevel.OWNER``: ``50`` References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectAccessRequest` + :class:`gitlab.v4.objects.ProjectAccessRequestManager` + :attr:`gitlab.v4.objects.Project.accessrequests` + :class:`gitlab.v4.objects.GroupAccessRequest` + :class:`gitlab.v4.objects.GroupAccessRequestManager` + :attr:`gitlab.v4.objects.Group.accessrequests` * GitLab API: https://docs.gitlab.com/ce/api/access_requests.html Examples -------- List access requests from projects and groups:: p_ars = project.accessrequests.list() g_ars = group.accessrequests.list() Create an access request:: p_ar = project.accessrequests.create() g_ar = group.accessrequests.create() Approve an access request:: ar.approve() # defaults to DEVELOPER level ar.approve(access_level=gitlab.const.AccessLevel.MAINTAINER) # explicitly set access level Deny (delete) an access request:: project.accessrequests.delete(user_id) group.accessrequests.delete(user_id) # or ar.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/appearance.rst0000644000000000000000000000066314366036457021034 0ustar00rootroot########## Appearance ########## Reference --------- * v4 API: + :class:`gitlab.v4.objects.ApplicationAppearance` + :class:`gitlab.v4.objects.ApplicationAppearanceManager` + :attr:`gitlab.Gitlab.appearance` * GitLab API: https://docs.gitlab.com/ce/api/appearance.html Examples -------- Get the appearance:: appearance = gl.appearance.get() Update the appearance:: appearance.title = "Test" appearance.save() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/applications.rst0000644000000000000000000000115314366036457021416 0ustar00rootroot############ Applications ############ Reference --------- * v4 API: + :class:`gitlab.v4.objects.Applications` + :class:`gitlab.v4.objects.ApplicationManager` + :attr:`gitlab.Gitlab.applications` * GitLab API: https://docs.gitlab.com/ce/api/applications.html Examples -------- List all OAuth applications:: applications = gl.applications.list() Create an application:: gl.applications.create({'name': 'your_app', 'redirect_uri': 'http://application.url', 'scopes': 'read_user openid profile email'}) Delete an applications:: gl.applications.delete(app_id) # or application.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/badges.rst0000644000000000000000000000203214366036457020152 0ustar00rootroot###### Badges ###### Badges can be associated with groups and projects. Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupBadge` + :class:`gitlab.v4.objects.GroupBadgeManager` + :attr:`gitlab.v4.objects.Group.badges` + :class:`gitlab.v4.objects.ProjectBadge` + :class:`gitlab.v4.objects.ProjectBadgeManager` + :attr:`gitlab.v4.objects.Project.badges` * GitLab API: + https://docs.gitlab.com/ce/api/group_badges.html + https://docs.gitlab.com/ce/api/project_badges.html Examples -------- List badges:: badges = group_or_project.badges.list() Get a badge:: badge = group_or_project.badges.get(badge_id) Create a badge:: badge = group_or_project.badges.create({'link_url': link, 'image_url': image_link}) Update a badge:: badge.image_link = new_link badge.save() Delete a badge:: badge.delete() Render a badge (preview the generate URLs):: output = group_or_project.badges.render(link, image_link) print(output['rendered_link_url']) print(output['rendered_image_url']) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/boards.rst0000644000000000000000000000455114366036457020207 0ustar00rootroot############ Issue boards ############ Boards ====== Boards are a visual representation of existing issues for a project or a group. Issues can be moved from one list to the other to track progress and help with priorities. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectBoard` + :class:`gitlab.v4.objects.ProjectBoardManager` + :attr:`gitlab.v4.objects.Project.boards` + :class:`gitlab.v4.objects.GroupBoard` + :class:`gitlab.v4.objects.GroupBoardManager` + :attr:`gitlab.v4.objects.Group.boards` * GitLab API: + https://docs.gitlab.com/ce/api/boards.html + https://docs.gitlab.com/ce/api/group_boards.html Examples -------- Get the list of existing boards for a project or a group:: # item is a Project or a Group boards = project_or_group.boards.list() Get a single board for a project or a group:: board = project_or_group.boards.get(board_id) Create a board:: board = project_or_group.boards.create({'name': 'new-board'}) .. note:: Board creation is not supported in the GitLab CE edition. Delete a board:: board.delete() # or project_or_group.boards.delete(board_id) .. note:: Board deletion is not supported in the GitLab CE edition. Board lists =========== Boards are made of lists of issues. Each list is associated to a label, and issues tagged with this label automatically belong to the list. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectBoardList` + :class:`gitlab.v4.objects.ProjectBoardListManager` + :attr:`gitlab.v4.objects.ProjectBoard.lists` + :class:`gitlab.v4.objects.GroupBoardList` + :class:`gitlab.v4.objects.GroupBoardListManager` + :attr:`gitlab.v4.objects.GroupBoard.lists` * GitLab API: + https://docs.gitlab.com/ce/api/boards.html + https://docs.gitlab.com/ce/api/group_boards.html Examples -------- List the issue lists for a board:: b_lists = board.lists.list() Get a single list:: b_list = board.lists.get(list_id) Create a new list:: # First get a ProjectLabel label = get_or_create_label() # Then use its ID to create the new board list b_list = board.lists.create({'label_id': label.id}) Change a list position. The first list is at position 0. Moving a list will set it at the given position and move the following lists up a position:: b_list.position = 2 b_list.save() Delete a list:: b_list.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/branches.rst0000644000000000000000000000152014366036457020513 0ustar00rootroot######## Branches ######## References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectBranch` + :class:`gitlab.v4.objects.ProjectBranchManager` + :attr:`gitlab.v4.objects.Project.branches` * GitLab API: https://docs.gitlab.com/ce/api/branches.html Examples -------- Get the list of branches for a repository:: branches = project.branches.list() Get a single repository branch:: branch = project.branches.get('main') Create a repository branch:: branch = project.branches.create({'branch': 'feature1', 'ref': 'main'}) Delete a repository branch:: project.branches.delete('feature1') # or branch.delete() Delete the merged branches for a project:: project.delete_merged_branches() To manage protected branches, see :doc:`/gl_objects/protected_branches`. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/bulk_imports.rst0000644000000000000000000000413614366036457021446 0ustar00rootroot######################### Migrations (Bulk Imports) ######################### References ---------- * v4 API: + :class:`gitlab.v4.objects.BulkImport` + :class:`gitlab.v4.objects.BulkImportManager` + :attr:`gitlab.Gitlab.bulk_imports` + :class:`gitlab.v4.objects.BulkImportAllEntity` + :class:`gitlab.v4.objects.BulkImportAllEntityManager` + :attr:`gitlab.Gitlab.bulk_import_entities` + :class:`gitlab.v4.objects.BulkImportEntity` + :class:`gitlab.v4.objects.BulkImportEntityManager` + :attr:`gitlab.v4.objects.BulkImport.entities` * GitLab API: https://docs.gitlab.com/ee/api/bulk_imports.html Examples -------- .. note:: Like the project/group imports and exports, this is an asynchronous operation and you will need to refresh the state from the server to get an accurate migration status. See :ref:`project_import_export` in the import/export section for more details and examples. Start a bulk import/migration of a group and wait for completion:: # Create the migration configuration = { "url": "https://gitlab.example.com", "access_token": private_token, } entity = { "source_full_path": "source_group", "source_type": "group_entity", "destination_slug": "imported-group", "destination_namespace": "imported-namespace", } migration = gl.bulk_imports.create( { "configuration": configuration, "entities": [entity], } ) # Wait for the 'finished' status while migration.status != "finished": time.sleep(1) migration.refresh() List all migrations:: gl.bulk_imports.list() List the entities of all migrations:: gl.bulk_import_entities.list() Get a single migration by ID:: migration = gl.bulk_imports.get(123) List the entities of a single migration:: entities = migration.entities.list() Get a single entity of a migration by ID:: entity = migration.entities.get(123) Refresh the state of a migration or entity from the server:: migration.refresh() entity.refresh() print(migration.status) print(entity.status) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/ci_lint.rst0000644000000000000000000000351114366036457020351 0ustar00rootroot####### CI Lint ####### Reference --------- * v4 API: + :class:`gitlab.v4.objects.CiLint` + :class:`gitlab.v4.objects.CiLintManager` + :attr:`gitlab.Gitlab.ci_lint` + :class:`gitlab.v4.objects.ProjectCiLint` + :class:`gitlab.v4.objects.ProjectCiLintManager` + :attr:`gitlab.v4.objects.Project.ci_lint` * GitLab API: https://docs.gitlab.com/ee/api/lint.html Examples --------- Lint a CI YAML configuration:: gitlab_ci_yml = """.api_test: rules: - if: $CI_PIPELINE_SOURCE=="merge_request_event" changes: - src/api/* deploy: extends: - .api_test rules: - when: manual allow_failure: true script: - echo "hello world" """ lint_result = gl.ci_lint.create({"content": gitlab_ci_yml}) print(lint_result.status) # Print the status of the CI YAML print(lint_result.merged_yaml) # Print the merged YAML file Lint a project's CI configuration:: lint_result = project.ci_lint.get() assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid print(lint_result.merged_yaml) # Print the merged YAML file Lint a CI YAML configuration with a namespace:: lint_result = project.ci_lint.create({"content": gitlab_ci_yml}) assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid print(lint_result.merged_yaml) # Print the merged YAML file Validate a CI YAML configuration (raises ``GitlabCiLintError`` on failures):: # returns None gl.ci_lint.validate({"content": gitlab_ci_yml}) # raises GitlabCiLintError gl.ci_lint.validate({"content": "invalid"}) Validate a CI YAML configuration with a namespace:: # returns None project.ci_lint.validate({"content": gitlab_ci_yml}) # raises GitlabCiLintError project.ci_lint.validate({"content": "invalid"}) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/clusters.rst0000644000000000000000000000361214366036457020576 0ustar00rootroot##################### Clusters (DEPRECATED) ##################### .. warning:: Cluster support was deprecated in GitLab 14.5 and disabled by default as of GitLab 15.0 Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectCluster` + :class:`gitlab.v4.objects.ProjectClusterManager` + :attr:`gitlab.v4.objects.Project.clusters` + :class:`gitlab.v4.objects.GroupCluster` + :class:`gitlab.v4.objects.GroupClusterManager` + :attr:`gitlab.v4.objects.Group.clusters` * GitLab API: https://docs.gitlab.com/ee/api/project_clusters.html * GitLab API: https://docs.gitlab.com/ee/api/group_clusters.html Examples -------- List clusters for a project:: clusters = project.clusters.list() Create an cluster for a project:: cluster = project.clusters.create( { "name": "cluster1", "platform_kubernetes_attributes": { "api_url": "http://url", "token": "tokenval", }, }) Retrieve a specific cluster for a project:: cluster = project.clusters.get(cluster_id) Update an cluster for a project:: cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"} cluster.save() Delete an cluster for a project:: cluster = project.clusters.delete(cluster_id) # or cluster.delete() List clusters for a group:: clusters = group.clusters.list() Create an cluster for a group:: cluster = group.clusters.create( { "name": "cluster1", "platform_kubernetes_attributes": { "api_url": "http://url", "token": "tokenval", }, }) Retrieve a specific cluster for a group:: cluster = group.clusters.get(cluster_id) Update an cluster for a group:: cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"} cluster.save() Delete an cluster for a group:: cluster = group.clusters.delete(cluster_id) # or cluster.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/commits.rst0000644000000000000000000000643214366036457020410 0ustar00rootroot####### Commits ####### Commits ======= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectCommit` + :class:`gitlab.v4.objects.ProjectCommitManager` + :attr:`gitlab.v4.objects.Project.commits` Examples -------- List the commits for a project:: commits = project.commits.list() You can use the ``ref_name``, ``since`` and ``until`` filters to limit the results:: commits = project.commits.list(ref_name='my_branch') commits = project.commits.list(since='2016-01-01T00:00:00Z') List all commits for a project (see :ref:`pagination`) on all branches: commits = project.commits.list(get_all=True, all=True) Create a commit:: # See https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions # for actions detail data = { 'branch': 'main', 'commit_message': 'blah blah blah', 'actions': [ { 'action': 'create', 'file_path': 'README.rst', 'content': open('path/to/file.rst').read(), }, { # Binary files need to be base64 encoded 'action': 'create', 'file_path': 'logo.png', 'content': base64.b64encode(open('logo.png', mode='r+b').read()).decode(), 'encoding': 'base64', } ] } commit = project.commits.create(data) Get a commit detail:: commit = project.commits.get('e3d5a71b') Get the diff for a commit:: diff = commit.diff() Cherry-pick a commit into another branch:: commit.cherry_pick(branch='target_branch') Revert a commit on a given branch:: commit.revert(branch='target_branch') Get the references the commit has been pushed to (branches and tags):: commit.refs() # all references commit.refs('tag') # only tags commit.refs('branch') # only branches Get the signature of the commit (if the commit was signed, e.g. with GPG or x509):: commit.signature() List the merge requests related to a commit:: commit.merge_requests() Commit comments =============== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectCommitComment` + :class:`gitlab.v4.objects.ProjectCommitCommentManager` + :attr:`gitlab.v4.objects.ProjectCommit.comments` * GitLab API: https://docs.gitlab.com/ce/api/commits.html Examples -------- Get the comments for a commit:: comments = commit.comments.list() Add a comment on a commit:: # Global comment commit = commit.comments.create({'note': 'This is a nice comment'}) # Comment on a line in a file (on the new version of the file) commit = commit.comments.create({'note': 'This is another comment', 'line': 12, 'line_type': 'new', 'path': 'README.rst'}) Commit status ============= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectCommitStatus` + :class:`gitlab.v4.objects.ProjectCommitStatusManager` + :attr:`gitlab.v4.objects.ProjectCommit.statuses` * GitLab API: https://docs.gitlab.com/ce/api/commits.html Examples -------- List the statuses for a commit:: statuses = commit.statuses.list() Change the status of a commit:: commit.statuses.create({'state': 'success'}) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/deploy_keys.rst0000644000000000000000000000233714366036457021264 0ustar00rootroot########### Deploy keys ########### Deploy keys =========== Reference --------- * v4 API: + :class:`gitlab.v4.objects.DeployKey` + :class:`gitlab.v4.objects.DeployKeyManager` + :attr:`gitlab.Gitlab.deploykeys` * GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html Examples -------- List the deploy keys:: keys = gl.deploykeys.list() Deploy keys for projects ======================== Deploy keys can be managed on a per-project basis. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectKey` + :class:`gitlab.v4.objects.ProjectKeyManager` + :attr:`gitlab.v4.objects.Project.keys` * GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html Examples -------- List keys for a project:: keys = project.keys.list() Get a single deploy key:: key = project.keys.get(key_id) Create a deploy key for a project:: key = project.keys.create({'title': 'jenkins key', 'key': open('/home/me/.ssh/id_rsa.pub').read()}) Delete a deploy key for a project:: key = project.keys.list(key_id) # or key.delete() Enable a deploy key for a project:: project.keys.enable(key_id) Disable a deploy key for a project:: project.keys.delete(key_id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/deploy_tokens.rst0000644000000000000000000000777514366036457021627 0ustar00rootroot############# Deploy tokens ############# Deploy tokens allow read-only access to your repository and registry images without having a user and a password. Deploy tokens ============= This endpoint requires admin access. Reference --------- * v4 API: + :class:`gitlab.v4.objects.DeployToken` + :class:`gitlab.v4.objects.DeployTokenManager` + :attr:`gitlab.Gitlab.deploytokens` * GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html Examples -------- Use the ``list()`` method to list all deploy tokens across the GitLab instance. :: # List deploy tokens deploy_tokens = gl.deploytokens.list() Project deploy tokens ===================== This endpoint requires project maintainer access or higher. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectDeployToken` + :class:`gitlab.v4.objects.ProjectDeployTokenManager` + :attr:`gitlab.v4.objects.Project.deploytokens` * GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#project-deploy-tokens Examples -------- List the deploy tokens for a project:: deploy_tokens = project.deploytokens.list() Get a deploy token for a project by id:: deploy_token = project.deploytokens.get(deploy_token_id) Create a new deploy token to access registry images of a project: In addition to required parameters ``name`` and ``scopes``, this method accepts the following parameters: * ``expires_at`` Expiration date of the deploy token. Does not expire if no value is provided. * ``username`` Username for deploy token. Default is ``gitlab+deploy-token-{n}`` :: deploy_token = project.deploytokens.create({'name': 'token1', 'scopes': ['read_registry'], 'username':'', 'expires_at':''}) # show its id print(deploy_token.id) # show the token value. Make sure you save it, you won't be able to access it again. print(deploy_token.token) .. warning:: With GitLab 12.9, even though ``username`` and ``expires_at`` are not required, they always have to be passed to the API. You can set them to empty strings, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211878. Also, the ``username``'s value is ignored by the API and will be overridden with ``gitlab+deploy-token-{n}``, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211963 These issues were fixed in GitLab 12.10. Remove a deploy token from the project:: deploy_token.delete() # or project.deploytokens.delete(deploy_token.id) Group deploy tokens =================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupDeployToken` + :class:`gitlab.v4.objects.GroupDeployTokenManager` + :attr:`gitlab.v4.objects.Group.deploytokens` * GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#group-deploy-tokens Examples -------- List the deploy tokens for a group:: deploy_tokens = group.deploytokens.list() Get a deploy token for a group by id:: deploy_token = group.deploytokens.get(deploy_token_id) Create a new deploy token to access all repositories of all projects in a group: In addition to required parameters ``name`` and ``scopes``, this method accepts the following parameters: * ``expires_at`` Expiration date of the deploy token. Does not expire if no value is provided. * ``username`` Username for deploy token. Default is ``gitlab+deploy-token-{n}`` :: deploy_token = group.deploytokens.create({'name': 'token1', 'scopes': ['read_repository'], 'username':'', 'expires_at':''}) # show its id print(deploy_token.id) .. warning:: With GitLab 12.9, even though ``username`` and ``expires_at`` are not required, they always have to be passed to the API. You can set them to empty strings, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211878. Also, the ``username``'s value is ignored by the API and will be overridden with ``gitlab+deploy-token-{n}``, see: https://gitlab.com/gitlab-org/gitlab/-/issues/211963 These issues were fixed in GitLab 12.10. Remove a deploy token from the group:: deploy_token.delete() # or group.deploytokens.delete(deploy_token.id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/deployments.rst0000644000000000000000000000341314366036457021274 0ustar00rootroot########### Deployments ########### Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectDeployment` + :class:`gitlab.v4.objects.ProjectDeploymentManager` + :attr:`gitlab.v4.objects.Project.deployments` * GitLab API: https://docs.gitlab.com/ce/api/deployments.html Examples -------- List deployments for a project:: deployments = project.deployments.list() Get a single deployment:: deployment = project.deployments.get(deployment_id) Create a new deployment:: deployment = project.deployments.create({ "environment": "Test", "sha": "1agf4gs", "ref": "main", "tag": False, "status": "created", }) Update a deployment:: deployment = project.deployments.get(42) deployment.status = "failed" deployment.save() Approve a deployment:: deployment = project.deployments.get(42) # `status` must be either "approved" or "rejected". deployment.approval(status="approved") Reject a deployment:: deployment = project.deployments.get(42) # Using the optional `comment` and `represented_as` arguments deployment.approval(status="rejected", comment="Fails CI", represented_as="security") Merge requests associated with a deployment =========================================== Reference ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequest` + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager` + :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests` * GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment Examples -------- List the merge requests associated with a deployment:: deployment = project.deployments.get(42, lazy=True) mrs = deployment.mergerequests.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/discussions.rst0000644000000000000000000000654714366036457021312 0ustar00rootroot########### Discussions ########### Discussions organize the notes in threads. See the :ref:`project-notes` chapter for more information about notes. Discussions are available for project issues, merge requests, snippets and commits. Reference ========= * v4 API: Issues: + :class:`gitlab.v4.objects.ProjectIssueDiscussion` + :class:`gitlab.v4.objects.ProjectIssueDiscussionManager` + :class:`gitlab.v4.objects.ProjectIssueDiscussionNote` + :class:`gitlab.v4.objects.ProjectIssueDiscussionNoteManager` + :attr:`gitlab.v4.objects.ProjectIssue.notes` MergeRequests: + :class:`gitlab.v4.objects.ProjectMergeRequestDiscussion` + :class:`gitlab.v4.objects.ProjectMergeRequestDiscussionManager` + :class:`gitlab.v4.objects.ProjectMergeRequestDiscussionNote` + :class:`gitlab.v4.objects.ProjectMergeRequestDiscussionNoteManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.notes` Snippets: + :class:`gitlab.v4.objects.ProjectSnippetDiscussion` + :class:`gitlab.v4.objects.ProjectSnippetDiscussionManager` + :class:`gitlab.v4.objects.ProjectSnippetDiscussionNote` + :class:`gitlab.v4.objects.ProjectSnippetDiscussionNoteManager` + :attr:`gitlab.v4.objects.ProjectSnippet.notes` * GitLab API: https://docs.gitlab.com/ce/api/discussions.html Examples ======== List the discussions for a resource (issue, merge request, snippet or commit):: discussions = resource.discussions.list() Get a single discussion:: discussion = resource.discussions.get(discussion_id) You can access the individual notes in the discussion through the ``notes`` attribute. It holds a list of notes in chronological order:: # ``resource.notes`` is a DiscussionNoteManager, so we need to get the # object notes using ``attributes`` for note in discussion.attributes['notes']: print(note['body']) .. note:: The notes are dicts, not objects. You can add notes to existing discussions:: new_note = discussion.notes.create({'body': 'Episode IV: A new note'}) You can get and update a single note using the ``*DiscussionNote`` resources:: discussion = resource.discussions.get(discussion_id) # Get the latest note's id note_id = discussion.attributes['notes'][-1]['id'] last_note = discussion.notes.get(note_id) last_note.body = 'Updated comment' last_note.save() Create a new discussion:: discussion = resource.discussions.create({'body': 'First comment of discussion'}) You can comment on merge requests and commit diffs. Provide the ``position`` dict to define where the comment should appear in the diff:: mr_diff = mr.diffs.get(diff_id) mr.discussions.create({'body': 'Note content', 'position': { 'base_sha': mr_diff.base_commit_sha, 'start_sha': mr_diff.start_commit_sha, 'head_sha': mr_diff.head_commit_sha, 'position_type': 'text', 'new_line': 1, 'old_path': 'README.rst', 'new_path': 'README.rst'} }) Resolve / unresolve a merge request discussion:: mr_d = mr.discussions.get(d_id) mr_d.resolved = True # True to resolve, False to unresolve mr_d.save() Delete a comment:: discussions.notes.delete(note_id) # or note.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/emojis.rst0000644000000000000000000000225414366036457020221 0ustar00rootroot############ Award Emojis ############ Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssueAwardEmoji` + :class:`gitlab.v4.objects.ProjectIssueNoteAwardEmoji` + :class:`gitlab.v4.objects.ProjectMergeRequestAwardEmoji` + :class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmoji` + :class:`gitlab.v4.objects.ProjectSnippetAwardEmoji` + :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmoji` + :class:`gitlab.v4.objects.ProjectIssueAwardEmojiManager` + :class:`gitlab.v4.objects.ProjectIssueNoteAwardEmojiManager` + :class:`gitlab.v4.objects.ProjectMergeRequestAwardEmojiManager` + :class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmojiManager` + :class:`gitlab.v4.objects.ProjectSnippetAwardEmojiManager` + :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager` * GitLab API: https://docs.gitlab.com/ce/api/award_emoji.html Examples -------- List emojis for a resource:: emojis = obj.awardemojis.list() Get a single emoji:: emoji = obj.awardemojis.get(emoji_id) Add (create) an emoji:: emoji = obj.awardemojis.create({'name': 'tractor'}) Delete an emoji:: emoji.delete # or obj.awardemojis.delete(emoji_id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/environments.rst0000644000000000000000000000173014366036457021460 0ustar00rootroot############ Environments ############ Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectEnvironment` + :class:`gitlab.v4.objects.ProjectEnvironmentManager` + :attr:`gitlab.v4.objects.Project.environments` * GitLab API: https://docs.gitlab.com/ce/api/environments.html Examples -------- List environments for a project:: environments = project.environments.list() Create an environment for a project:: environment = project.environments.create({'name': 'production'}) Retrieve a specific environment for a project:: environment = project.environments.get(112) Update an environment for a project:: environment.external_url = 'http://foo.bar.com' environment.save() Delete an environment for a project:: environment = project.environments.delete(environment_id) # or environment.delete() Stop an environment:: environment.stop() To manage protected environments, see :doc:`/gl_objects/protected_environments`. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/epics.rst0000644000000000000000000000242614366036457020037 0ustar00rootroot##### Epics ##### Epics ===== Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupEpic` + :class:`gitlab.v4.objects.GroupEpicManager` + :attr:`gitlab.Gitlab.Group.epics` * GitLab API: https://docs.gitlab.com/ee/api/epics.html (EE feature) Examples -------- List the epics for a group:: epics = groups.epics.list() Get a single epic for a group:: epic = group.epics.get(epic_iid) Create an epic for a group:: epic = group.epics.create({'title': 'My Epic'}) Edit an epic:: epic.title = 'New title' epic.labels = ['label1', 'label2'] epic.save() Delete an epic:: epic.delete() Epics issues ============ Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupEpicIssue` + :class:`gitlab.v4.objects.GroupEpicIssueManager` + :attr:`gitlab.Gitlab.GroupEpic.issues` * GitLab API: https://docs.gitlab.com/ee/api/epic_issues.html (EE feature) Examples -------- List the issues associated with an issue:: ei = epic.issues.list() Associate an issue with an epic:: # use the issue id, not its iid ei = epic.issues.create({'issue_id': 4}) Move an issue in the list:: ei.move_before_id = epic_issue_id_1 # or ei.move_after_id = epic_issue_id_2 ei.save() Delete an issue association:: ei.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/events.rst0000644000000000000000000000423614366036457020241 0ustar00rootroot###### Events ###### Events ====== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Event` + :class:`gitlab.v4.objects.EventManager` + :attr:`gitlab.Gitlab.events` + :class:`gitlab.v4.objects.ProjectEvent` + :class:`gitlab.v4.objects.ProjectEventManager` + :attr:`gitlab.v4.objects.Project.events` + :class:`gitlab.v4.objects.UserEvent` + :class:`gitlab.v4.objects.UserEventManager` + :attr:`gitlab.v4.objects.User.events` * GitLab API: https://docs.gitlab.com/ce/api/events.html Examples -------- You can list events for an entire Gitlab instance (admin), users and projects. You can filter you events you want to retrieve using the ``action`` and ``target_type`` attributes. The possible values for these attributes are available on `the gitlab documentation `_. List all the events (paginated):: events = gl.events.list() List the issue events on a project:: events = project.events.list(target_type='issue') List the user events:: events = project.events.list() Resource state events ===================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssueResourceStateEvent` + :class:`gitlab.v4.objects.ProjectIssueResourceStateEventManager` + :attr:`gitlab.v4.objects.ProjectIssue.resourcestateevents` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceStateEvent` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceStateEventManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcestateevents` * GitLab API: https://docs.gitlab.com/ee/api/resource_state_events.html Examples -------- You can list and get specific resource state events (via their id) for project issues and project merge requests. List the state events of a project issue (paginated):: state_events = issue.resourcestateevents.list() Get a specific state event of a project issue by its id:: state_event = issue.resourcestateevents.get(1) List the state events of a project merge request (paginated):: state_events = mr.resourcestateevents.list() Get a specific state event of a project merge request by its id:: state_event = mr.resourcestateevents.get(1) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/features.rst0000644000000000000000000000116114366036457020545 0ustar00rootroot############## Features flags ############## Reference --------- * v4 API: + :class:`gitlab.v4.objects.Feature` + :class:`gitlab.v4.objects.FeatureManager` + :attr:`gitlab.Gitlab.features` * GitLab API: https://docs.gitlab.com/ce/api/features.html Examples -------- List features:: features = gl.features.list() Create or set a feature:: feature = gl.features.set(feature_name, True) feature = gl.features.set(feature_name, 30) feature = gl.features.set(feature_name, True, user=filipowm) feature = gl.features.set(feature_name, 40, group=mygroup) Delete a feature:: feature.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/geo_nodes.rst0000644000000000000000000000131614366036457020673 0ustar00rootroot######### Geo nodes ######### Reference --------- * v4 API: + :class:`gitlab.v4.objects.GeoNode` + :class:`gitlab.v4.objects.GeoNodeManager` + :attr:`gitlab.Gitlab.geonodes` * GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html (EE feature) Examples -------- List the geo nodes:: nodes = gl.geonodes.list() Get the status of all the nodes:: status = gl.geonodes.status() Get a specific node and its status:: node = gl.geonodes.get(node_id) node.status() Edit a node configuration:: node.url = 'https://secondary.mygitlab.domain' node.save() Delete a node:: node.delete() List the sync failure on the current node:: failures = gl.geonodes.current_failures() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/group_access_tokens.rst0000644000000000000000000000134614366036457022774 0ustar00rootroot##################### Group Access Tokens ##################### Get a list of group access tokens References ---------- * v4 API: + :class:`gitlab.v4.objects.GroupAccessToken` + :class:`gitlab.v4.objects.GroupAccessTokenManager` + :attr:`gitlab.Gitlab.group_access_tokens` * GitLab API: https://docs.gitlab.com/ee/api/group_access_tokens.html Examples -------- List group access tokens:: access_tokens = gl.groups.get(1, lazy=True).access_tokens.list() print(access_tokens[0].name) Create group access token:: access_token = gl.groups.get(1).access_tokens.create({"name": "test", "scopes": ["api"]}) Revoke a group access tokens:: gl.groups.get(1).access_tokens.delete(42) # or access_token.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/groups.rst0000644000000000000000000002474714366036457020265 0ustar00rootroot###### Groups ###### Groups ====== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Group` + :class:`gitlab.v4.objects.GroupManager` + :attr:`gitlab.Gitlab.groups` * GitLab API: https://docs.gitlab.com/ce/api/groups.html Examples -------- List the groups:: groups = gl.groups.list() Get a group's detail:: group = gl.groups.get(group_id) List a group's projects:: projects = group.projects.list() List a group's shared projects:: projects = group.shared_projects.list() .. note:: ``GroupProject`` and ``SharedProject`` objects returned by these two API calls are very limited, and do not provide all the features of ``Project`` objects. If you need to manipulate projects, create a new ``Project`` object:: first_group_project = group.projects.list()[0] manageable_project = gl.projects.get(first_group_project.id, lazy=True) You can filter and sort the result using the following parameters: * ``archived``: limit by archived status * ``visibility``: limit by visibility. Allowed values are ``public``, ``internal`` and ``private`` * ``search``: limit to groups matching the given value * ``order_by``: sort by criteria. Allowed values are ``id``, ``name``, ``path``, ``created_at``, ``updated_at`` and ``last_activity_at`` * ``sort``: sort order: ``asc`` or ``desc`` * ``ci_enabled_first``: return CI enabled groups first * ``include_subgroups``: include projects in subgroups Create a group:: group = gl.groups.create({'name': 'group1', 'path': 'group1'}) .. warning:: On GitLab.com, creating top-level groups is currently `not permitted using the API `_. You can only use the API to create subgroups. Create a subgroup under an existing group:: subgroup = gl.groups.create({'name': 'subgroup1', 'path': 'subgroup1', 'parent_id': parent_group_id}) Update a group:: group.description = 'My awesome group' group.save() Set the avatar image for a group:: # the avatar image can be passed as data (content of the file) or as a file # object opened in binary mode group.avatar = open('path/to/file.png', 'rb') group.save() Remove a group:: gl.groups.delete(group_id) # or group.delete() Restore a Group marked for deletion (Premium only)::: group.restore() Share/unshare the group with a group:: group.share(group2.id, gitlab.const.AccessLevel.DEVELOPER) group.unshare(group2.id) Import / Export =============== You can export groups from gitlab, and re-import them to create new groups. Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupExport` + :class:`gitlab.v4.objects.GroupExportManager` + :attr:`gitlab.v4.objects.Group.exports` + :class:`gitlab.v4.objects.GroupImport` + :class:`gitlab.v4.objects.GroupImportManager` + :attr:`gitlab.v4.objects.Group.imports` + :attr:`gitlab.v4.objects.GroupManager.import_group` * GitLab API: https://docs.gitlab.com/ce/api/group_import_export.html Examples -------- A group export is an asynchronous operation. To retrieve the archive generated by GitLab you need to: #. Create an export using the API #. Wait for the export to be done #. Download the result .. warning:: Unlike the Project Export API, GitLab does not provide an export_status for Group Exports. It is up to the user to ensure the export is finished. However, Group Exports only contain metadata, so they are much faster than Project Exports. :: # Create the export group = gl.groups.get(my_group) export = group.exports.create() # Wait for the export to finish time.sleep(3) # Download the result with open('/tmp/export.tgz', 'wb') as f: export.download(streamed=True, action=f.write) Import the group:: with open('/tmp/export.tgz', 'rb') as f: gl.groups.import_group(f, path='imported-group', name="Imported Group") Subgroups ========= Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupSubgroup` + :class:`gitlab.v4.objects.GroupSubgroupManager` + :attr:`gitlab.v4.objects.Group.subgroups` Examples -------- List the subgroups for a group:: subgroups = group.subgroups.list() .. note:: The ``GroupSubgroup`` objects don't expose the same API as the ``Group`` objects. If you need to manipulate a subgroup as a group, create a new ``Group`` object:: real_group = gl.groups.get(subgroup_id, lazy=True) real_group.issues.list() Descendant Groups ================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupDescendantGroup` + :class:`gitlab.v4.objects.GroupDescendantGroupManager` + :attr:`gitlab.v4.objects.Group.descendant_groups` Examples -------- List the descendant groups of a group:: descendant_groups = group.descendant_groups.list() .. note:: Like the ``GroupSubgroup`` objects described above, ``GroupDescendantGroup`` objects do not expose the same API as the ``Group`` objects. Create a new ``Group`` object instead if needed, as shown in the subgroup example. Group custom attributes ======================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupCustomAttribute` + :class:`gitlab.v4.objects.GroupCustomAttributeManager` + :attr:`gitlab.v4.objects.Group.customattributes` * GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html Examples -------- List custom attributes for a group:: attrs = group.customattributes.list() Get a custom attribute for a group:: attr = group.customattributes.get(attr_key) Set (create or update) a custom attribute for a group:: attr = group.customattributes.set(attr_key, attr_value) Delete a custom attribute for a group:: attr.delete() # or group.customattributes.delete(attr_key) Search groups by custom attribute:: group.customattributes.set('role': 'admin') gl.groups.list(custom_attributes={'role': 'admin'}) Group members ============= The following constants define the supported access levels: * ``gitlab.const.AccessLevel.GUEST = 10`` * ``gitlab.const.AccessLevel.REPORTER = 20`` * ``gitlab.const.AccessLevel.DEVELOPER = 30`` * ``gitlab.const.AccessLevel.MAINTAINER = 40`` * ``gitlab.const.AccessLevel.OWNER = 50`` Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupMember` + :class:`gitlab.v4.objects.GroupMemberManager` + :class:`gitlab.v4.objects.GroupMemberAllManager` + :class:`gitlab.v4.objects.GroupBillableMember` + :class:`gitlab.v4.objects.GroupBillableMemberManager` + :attr:`gitlab.v4.objects.Group.members` + :attr:`gitlab.v4.objects.Group.members_all` + :attr:`gitlab.v4.objects.Group.billable_members` * GitLab API: https://docs.gitlab.com/ce/api/members.html Billable group members are only available in GitLab EE. Examples -------- List only direct group members:: members = group.members.list() List the group members recursively (including inherited members through ancestor groups):: members = group.members_all.list(get_all=True) Get only direct group member:: members = group.members.get(member_id) Get a member of a group, including members inherited through ancestor groups:: members = group.members_all.get(member_id) Add a member to the group:: member = group.members.create({'user_id': user_id, 'access_level': gitlab.const.AccessLevel.GUEST}) Update a member (change the access level):: member.access_level = gitlab.const.AccessLevel.DEVELOPER member.save() Remove a member from the group:: group.members.delete(member_id) # or member.delete() List billable members of a group (top-level groups only):: billable_members = group.billable_members.list() Remove a billable member from the group:: group.billable_members.delete(member_id) # or billable_member.delete() List memberships of a billable member:: billable_member.memberships.list() LDAP group links ================ Add an LDAP group link to an existing GitLab group:: ldap_link = group.ldap_group_links.create({ 'provider': 'ldapmain', 'group_access': gitlab.const.AccessLevel.DEVELOPER, 'cn: 'ldap_group_cn' }) List a group's LDAP group links: group.ldap_group_links.list() Remove a link:: ldap_link.delete() # or by explicitly providing the CN or filter group.ldap_group_links.delete(provider='ldapmain', cn='ldap_group_cn') group.ldap_group_links.delete(provider='ldapmain', filter='(cn=Common Name)') Sync the LDAP groups:: group.ldap_sync() You can use the ``ldapgroups`` manager to list available LDAP groups:: # listing (supports pagination) ldap_groups = gl.ldapgroups.list() # filter using a group name ldap_groups = gl.ldapgroups.list(search='foo') # list the groups for a specific LDAP provider ldap_groups = gl.ldapgroups.list(search='foo', provider='ldapmain') SAML group links ================ Add a SAML group link to an existing GitLab group:: saml_link = group.saml_group_links.create({ "saml_group_name": "", "access_level": }) List a group's SAML group links:: group.saml_group_links.list() Get a SAML group link:: group.saml_group_links.get("") Remove a link:: saml_link.delete() Groups hooks ============ Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupHook` + :class:`gitlab.v4.objects.GroupHookManager` + :attr:`gitlab.v4.objects.Group.hooks` * GitLab API: https://docs.gitlab.com/ce/api/groups.html#hooks Examples -------- List the group hooks:: hooks = group.hooks.list() Get a group hook:: hook = group.hooks.get(hook_id) Create a group hook:: hook = group.hooks.create({'url': 'http://my/action/url', 'push_events': 1}) Update a group hook:: hook.push_events = 0 hook.save() Delete a group hook:: group.hooks.delete(hook_id) # or hook.delete() Group push rules ================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupPushRules` + :class:`gitlab.v4.objects.GroupPushRulesManager` + :attr:`gitlab.v4.objects.Group.pushrules` * GitLab API: https://docs.gitlab.com/ee/api/groups.html#push-rules Examples --------- Create group push rules (at least one rule is necessary):: group.pushrules.create({'deny_delete_tag': True}) Get group push rules:: pr = group.pushrules.get() Edit group push rules:: pr.branch_name_regex = '^(master|develop|support-\d+|release-\d+\..+|hotfix-.+|feature-.+)$' pr.save() Delete group push rules:: pr.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/invitations.rst0000644000000000000000000000401114366036457021273 0ustar00rootroot########### Invitations ########### Invitations let you invite or add users to a group or project. Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupInvitation` + :class:`gitlab.v4.objects.GroupInvitationManager` + :attr:`gitlab.v4.objects.Group.invitations` + :class:`gitlab.v4.objects.ProjectInvitation` + :class:`gitlab.v4.objects.ProjectInvitationManager` + :attr:`gitlab.v4.objects.Project.invitations` * GitLab API: https://docs.gitlab.com/ce/api/invitations.html Examples -------- .. danger:: Creating an invitation with ``create()`` returns a status response, rather than invitation details, because it allows sending multiple invitations at the same time. Thus when using several emails, you do not create a real invitation object you can manipulate, because python-gitlab cannot know which email to track as the ID. In that case, use a **lazy** ``get()`` method shown below using a specific email address to create an invitation object you can manipulate. Create an invitation:: invitation = group_or_project.invitations.create( { "email": "email@example.com", "access_level": gitlab.const.AccessLevel.DEVELOPER, } ) List invitations for a group or project:: invitations = group_or_project.invitations.list() .. warning:: As mentioned above, GitLab does not provide a real GET endpoint for a single invitation. We can create a lazy object to later manipulate it. Update an invitation:: invitation = group_or_project.invitations.get("email@example.com", lazy=True) invitation.access_level = gitlab.const.AccessLevel.DEVELOPER invitation.save() # or group_or_project.invitations.update( "email@example.com", {"access_level": gitlab.const.AccessLevel.DEVELOPER} ) Delete an invitation:: invitation = group_or_project.invitations.get("email@example.com", lazy=True) invitation.delete() # or group_or_project.invitations.delete("email@example.com") ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/issues.rst0000644000000000000000000001541614366036457020252 0ustar00rootroot.. _issues_examples: ###### Issues ###### Reported issues =============== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Issue` + :class:`gitlab.v4.objects.IssueManager` + :attr:`gitlab.Gitlab.issues` * GitLab API: https://docs.gitlab.com/ce/api/issues.html Examples -------- List the issues:: issues = gl.issues.list() Use the ``state`` and ``label`` parameters to filter the results. Use the ``order_by`` and ``sort`` attributes to sort the results:: open_issues = gl.issues.list(state='opened') closed_issues = gl.issues.list(state='closed') tagged_issues = gl.issues.list(labels=['foo', 'bar']) .. note:: It is not possible to edit or delete Issue objects. You need to create a ProjectIssue object to perform changes:: issue = gl.issues.list()[0] project = gl.projects.get(issue.project_id, lazy=True) editable_issue = project.issues.get(issue.iid, lazy=True) editable_issue.title = updated_title editable_issue.save() Group issues ============ Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupIssue` + :class:`gitlab.v4.objects.GroupIssueManager` + :attr:`gitlab.v4.objects.Group.issues` * GitLab API: https://docs.gitlab.com/ce/api/issues.html Examples -------- List the group issues:: issues = group.issues.list() # Filter using the state, labels and milestone parameters issues = group.issues.list(milestone='1.0', state='opened') # Order using the order_by and sort parameters issues = group.issues.list(order_by='created_at', sort='desc') .. note:: It is not possible to edit or delete GroupIssue objects. You need to create a ProjectIssue object to perform changes:: issue = group.issues.list()[0] project = gl.projects.get(issue.project_id, lazy=True) editable_issue = project.issues.get(issue.iid, lazy=True) editable_issue.title = updated_title editable_issue.save() Project issues ============== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssue` + :class:`gitlab.v4.objects.ProjectIssueManager` + :attr:`gitlab.v4.objects.Project.issues` * GitLab API: https://docs.gitlab.com/ce/api/issues.html Examples -------- List the project issues:: issues = project.issues.list() # Filter using the state, labels and milestone parameters issues = project.issues.list(milestone='1.0', state='opened') # Order using the order_by and sort parameters issues = project.issues.list(order_by='created_at', sort='desc') Get a project issue:: issue = project.issues.get(issue_iid) Create a new issue:: issue = project.issues.create({'title': 'I have a bug', 'description': 'Something useful here.'}) Update an issue:: issue.labels = ['foo', 'bar'] issue.save() Close / reopen an issue:: # close an issue issue.state_event = 'close' issue.save() # reopen it issue.state_event = 'reopen' issue.save() Delete an issue (admin or project owner only):: project.issues.delete(issue_id) # pr issue.delete() Assign the issues:: issue = gl.issues.list()[0] issue.assignee_ids = [25, 10, 31, 12] issue.save() .. note:: The Gitlab API explicitly references that the `assignee_id` field is deprecated, so using a list of user IDs for `assignee_ids` is how to assign an issue to a user(s). Subscribe / unsubscribe from an issue:: issue.subscribe() issue.unsubscribe() Move an issue to another project:: issue.move(other_project_id) Reorder an issue on a board:: issue.reorder(move_after_id=2, move_before_id=3) Make an issue as todo:: issue.todo() Get time tracking stats:: issue.time_stats() On recent versions of Gitlab the time stats are also returned as an issue object attribute:: issue = project.issue.get(iid) print(issue.attributes['time_stats']) Set a time estimate for an issue:: issue.time_estimate('3h30m') Reset a time estimate for an issue:: issue.reset_time_estimate() Add spent time for an issue:: issue.add_spent_time('3h30m') Reset spent time for an issue:: issue.reset_spent_time() Get user agent detail for the issue (admin only):: detail = issue.user_agent_detail() Get the list of merge requests that will close an issue when merged:: mrs = issue.closed_by() Get the merge requests related to an issue:: mrs = issue.related_merge_requests() Get the list of participants:: users = issue.participants() Get the list of iteration events:: iteration_events = issue.resource_iteration_events.list() Issue links =========== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssueLink` + :class:`gitlab.v4.objects.ProjectIssueLinkManager` + :attr:`gitlab.v4.objects.ProjectIssue.links` * GitLab API: https://docs.gitlab.com/ee/api/issue_links.html (EE feature) Examples -------- List the issues linked to ``i1``:: links = i1.links.list() Link issue ``i1`` to issue ``i2``:: data = { 'target_project_id': i2.project_id, 'target_issue_iid': i2.iid } src_issue, dest_issue = i1.links.create(data) .. note:: The ``create()`` method returns the source and destination ``ProjectIssue`` objects, not a ``ProjectIssueLink`` object. Delete a link:: i1.links.delete(issue_link_id) Issues statistics ========================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.IssuesStatistics` + :class:`gitlab.v4.objects.IssuesStatisticsManager` + :attr:`gitlab.issues_statistics` + :class:`gitlab.v4.objects.GroupIssuesStatistics` + :class:`gitlab.v4.objects.GroupIssuesStatisticsManager` + :attr:`gitlab.v4.objects.Group.issues_statistics` + :class:`gitlab.v4.objects.ProjectIssuesStatistics` + :class:`gitlab.v4.objects.ProjectIssuesStatisticsManager` + :attr:`gitlab.v4.objects.Project.issues_statistics` * GitLab API: https://docs.gitlab.com/ce/api/issues_statistics.htm Examples --------- Get statistics of all issues created by the current user:: statistics = gl.issues_statistics.get() Get statistics of all issues the user has access to:: statistics = gl.issues_statistics.get(scope='all') Get statistics of issues for the user with ``foobar`` in the ``title`` or the ``description``:: statistics = gl.issues_statistics.get(search='foobar') Get statistics of all issues in a group:: statistics = group.issues_statistics.get() Get statistics of issues in a group with ``foobar`` in the ``title`` or the ``description``:: statistics = group.issues_statistics.get(search='foobar') Get statistics of all issues in a project:: statistics = project.issues_statistics.get() Get statistics of issues in a project with ``foobar`` in the ``title`` or the ``description``:: statistics = project.issues_statistics.get(search='foobar') ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/iterations.rst0000644000000000000000000000126614366036457021116 0ustar00rootroot########## Iterations ########## Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupIteration` + :class:`gitlab.v4.objects.GroupIterationManager` + :attr:`gitlab.v4.objects.Group.iterations` + :class:`gitlab.v4.objects.ProjectIterationManager` + :attr:`gitlab.v4.objects.Project.iterations` * GitLab API: https://docs.gitlab.com/ee/api/iterations.html Examples -------- .. note:: GitLab no longer has project iterations. Using a project endpoint returns the ancestor groups' iterations. List iterations for a project's ancestor groups:: iterations = project.iterations.list() List iterations for a group:: iterations = group.iterations.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/keys.rst0000644000000000000000000000075214366036457017707 0ustar00rootroot#### Keys #### Keys ==== Reference --------- * v4 API + :class:`gitlab.v4.objects.Key` + :class:`gitlab.v4.objects.KeyManager` + :attr:`gitlab.Gitlab.keys` * GitLab API: https://docs.gitlab.com/ce/api/keys.html Examples -------- Get an ssh key by its id (requires admin access):: key = gl.keys.get(key_id) Get an ssh key (requires admin access) or a deploy key by its fingerprint:: key = gl.keys.get(fingerprint="SHA256:ERJJ/OweAM6jA8OjJ/gXs4N5fqUaREEJnz/EyfywfXY") ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/labels.rst0000644000000000000000000000436414366036457020201 0ustar00rootroot###### Labels ###### Project labels ============== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectLabel` + :class:`gitlab.v4.objects.ProjectLabelManager` + :attr:`gitlab.v4.objects.Project.labels` * GitLab API: https://docs.gitlab.com/ce/api/labels.html Examples -------- List labels for a project:: labels = project.labels.list() Create a label for a project:: label = project.labels.create({'name': 'foo', 'color': '#8899aa'}) Update a label for a project:: # change the name of the label: label.new_name = 'bar' label.save() # change its color: label.color = '#112233' label.save() Promote a project label to a group label:: label.promote() Delete a label for a project:: project.labels.delete(label_id) # or label.delete() Manage labels in issues and merge requests:: # Labels are defined as lists in issues and merge requests. The labels must # exist. issue = p.issues.create({'title': 'issue title', 'description': 'issue description', 'labels': ['foo']}) issue.labels.append('bar') issue.save() Label events ============ Resource label events keep track about who, when, and which label was added or removed to an issuable. Group epic label events are only available in the EE edition. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssueResourceLabelEvent` + :class:`gitlab.v4.objects.ProjectIssueResourceLabelEventManager` + :attr:`gitlab.v4.objects.ProjectIssue.resourcelabelevents` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEvent` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEventManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcelabelevents` + :class:`gitlab.v4.objects.GroupEpicResourceLabelEvent` + :class:`gitlab.v4.objects.GroupEpicResourceLabelEventManager` + :attr:`gitlab.v4.objects.GroupEpic.resourcelabelevents` * GitLab API: https://docs.gitlab.com/ee/api/resource_label_events.html Examples -------- Get the events for a resource (issue, merge request or epic):: events = resource.resourcelabelevents.list() Get a specific event for a resource:: event = resource.resourcelabelevents.get(event_id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/merge_request_approvals.rst0000644000000000000000000000555314366036457023676 0ustar00rootroot################################ Merge request approvals settings ################################ Merge request approvals can be defined at the project level or at the merge request level. References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectApproval` + :class:`gitlab.v4.objects.ProjectApprovalManager` + :class:`gitlab.v4.objects.ProjectApprovalRule` + :class:`gitlab.v4.objects.ProjectApprovalRuleManager` + :attr:`gitlab.v4.objects.Project.approvals` + :class:`gitlab.v4.objects.ProjectMergeRequestApproval` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.approvals` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalRule` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalRuleManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.approval_rules` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalState` + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalStateManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.approval_state` * GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html Examples -------- List project-level MR approval rules:: p_mras = project.approvalrules.list() Change project-level MR approval rule:: p_approvalrule.user_ids = [234] p_approvalrule.save() Delete project-level MR approval rule:: p_approvalrule.delete() Get project-level or MR-level MR approvals settings:: p_mras = project.approvals.get() mr_mras = mr.approvals.get() Get MR-level approval state:: mr_approval_state = mr.approval_state.get() Change project-level or MR-level MR approvals settings:: p_mras.approvals_before_merge = 2 p_mras.save() mr.approvals.set_approvers(approvals_required=1) # or mr_mras.approvals_required = 1 mr_mras.save() Create a new MR-level approval rule or change an existing MR-level approval rule:: mr.approvals.set_approvers(approvals_required = 1, approver_ids=[105], approver_group_ids=[653, 654], approval_rule_name="my MR custom approval rule") List MR-level MR approval rules:: mr.approval_rules.list() Get a single MR approval rule:: approval_rule_id = 123 mr_approvalrule = mr.approval_rules.get(approval_rule_id) Delete MR-level MR approval rule:: rules = mr.approval_rules.list() rules[0].delete() # or mr.approval_rules.delete(approval_id) Change MR-level MR approval rule:: mr_approvalrule.user_ids = [105] mr_approvalrule.approvals_required = 2 mr_approvalrule.group_ids = [653, 654] mr_approvalrule.save() Create a MR-level MR approval rule:: mr.approval_rules.create({ "name": "my MR custom approval rule", "approvals_required": 2, "rule_type": "regular", "user_ids": [105], "group_ids": [653, 654], }) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/merge_requests.rst0000644000000000000000000001261014366036457021762 0ustar00rootroot.. _merge_requests_examples: ############## Merge requests ############## You can use merge requests to notify a project that a branch is ready for merging. The owner of the target projet can accept the merge request. Merge requests are linked to projects, but they can be listed globally or for groups. Group and global listing ======================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupMergeRequest` + :class:`gitlab.v4.objects.GroupMergeRequestManager` + :attr:`gitlab.v4.objects.Group.mergerequests` + :class:`gitlab.v4.objects.MergeRequest` + :class:`gitlab.v4.objects.MergeRequestManager` + :attr:`gitlab.Gitlab.mergerequests` * GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html Examples -------- List the merge requests created by the user of the token on the GitLab server:: mrs = gl.mergerequests.list() List the merge requests available on the GitLab server:: mrs = gl.mergerequests.list(scope="all") List the merge requests for a group:: group = gl.groups.get('mygroup') mrs = group.mergerequests.list() .. note:: It is not possible to edit or delete ``MergeRequest`` and ``GroupMergeRequest`` objects. You need to create a ``ProjectMergeRequest`` object to apply changes:: mr = group.mergerequests.list()[0] project = gl.projects.get(mr.project_id, lazy=True) editable_mr = project.mergerequests.get(mr.iid, lazy=True) editable_mr.title = updated_title editable_mr.save() Project merge requests ====================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectMergeRequest` + :class:`gitlab.v4.objects.ProjectMergeRequestManager` + :attr:`gitlab.v4.objects.Project.mergerequests` * GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html Examples -------- List MRs for a project:: mrs = project.mergerequests.list() You can filter and sort the returned list with the following parameters: * ``state``: state of the MR. It can be one of ``all``, ``merged``, ``opened``, ``closed`` or ``locked`` * ``order_by``: sort by ``created_at`` or ``updated_at`` * ``sort``: sort order (``asc`` or ``desc``) You can find a full updated list of parameters here: https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests For example:: mrs = project.mergerequests.list(state='merged', order_by='updated_at') Get a single MR:: mr = project.mergerequests.get(mr_iid) Create a MR:: mr = project.mergerequests.create({'source_branch': 'cool_feature', 'target_branch': 'main', 'title': 'merge cool feature', 'labels': ['label1', 'label2']}) Update a MR:: mr.description = 'New description' mr.labels = ['foo', 'bar'] mr.save() Change the state of a MR (close or reopen):: mr.state_event = 'close' # or 'reopen' mr.save() Delete a MR:: project.mergerequests.delete(mr_iid) # or mr.delete() Accept a MR:: mr.merge() Schedule a MR to merge after the pipeline(s) succeed:: mr.merge(merge_when_pipeline_succeeds=True) Cancel a MR from merging when the pipeline succeeds:: # Cancel a MR from being merged that had been previously set to # 'merge_when_pipeline_succeeds=True' mr.cancel_merge_when_pipeline_succeeds() List commits of a MR:: commits = mr.commits() List the changes of a MR:: changes = mr.changes() List issues that will close on merge:: mr.closes_issues() Subscribe to / unsubscribe from a MR:: mr.subscribe() mr.unsubscribe() Mark a MR as todo:: mr.todo() List the diffs for a merge request:: diffs = mr.diffs.list() Get a diff for a merge request:: diff = mr.diffs.get(diff_id) Get time tracking stats:: time_stats = mr.time_stats() On recent versions of Gitlab the time stats are also returned as a merge request object attribute:: mr = project.mergerequests.get(id) print(mr.attributes['time_stats']) Set a time estimate for a merge request:: mr.time_estimate('3h30m') Reset a time estimate for a merge request:: mr.reset_time_estimate() Add spent time for a merge request:: mr.add_spent_time('3h30m') Reset spent time for a merge request:: mr.reset_spent_time() Get user agent detail for the issue (admin only):: detail = issue.user_agent_detail() Attempt to rebase an MR:: mr.rebase() Clear all approvals of a merge request (possible with project or group access tokens only):: mr.reset_approvals() Get status of a rebase for an MR:: mr = project.mergerequests.get(mr_id, include_rebase_in_progress=True) print(mr.rebase_in_progress, mr.merge_error) For more info see: https://docs.gitlab.com/ee/api/merge_requests.html#rebase-a-merge-request Attempt to merge changes between source and target branch:: response = mr.merge_ref() print(response['commit_id']) Merge Request Pipelines ======================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectMergeRequestPipeline` + :class:`gitlab.v4.objects.ProjectMergeRequestPipelineManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.pipelines` * GitLab API: https://docs.gitlab.com/ee/api/merge_requests.html#list-mr-pipelines Examples -------- List pipelines for a merge request:: pipelines = mr.pipelines.list() Create a pipeline for a merge request:: pipeline = mr.pipelines.create() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/merge_trains.rst0000644000000000000000000000116114366036457021406 0ustar00rootroot############ Merge Trains ############ Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectMergeTrain` + :class:`gitlab.v4.objects.ProjectMergeTrainManager` + :attr:`gitlab.v4.objects.Project.merge_trains` * GitLab API: https://docs.gitlab.com/ee/api/merge_trains.html Examples -------- List merge trains for a project:: merge_trains = project.merge_trains.list() List active merge trains for a project:: merge_trains = project.merge_trains.list(scope="active") List completed (have been merged) merge trains for a project:: merge_trains = project.merge_trains.list(scope="complete")././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/messages.rst0000644000000000000000000000173414366036457020544 0ustar00rootroot################## Broadcast messages ################## You can use broadcast messages to display information on all pages of the gitlab web UI. You must have administration permissions to manipulate broadcast messages. References ---------- * v4 API: + :class:`gitlab.v4.objects.BroadcastMessage` + :class:`gitlab.v4.objects.BroadcastMessageManager` + :attr:`gitlab.Gitlab.broadcastmessages` * GitLab API: https://docs.gitlab.com/ce/api/broadcast_messages.html Examples -------- List the messages:: msgs = gl.broadcastmessages.list() Get a single message:: msg = gl.broadcastmessages.get(msg_id) Create a message:: msg = gl.broadcastmessages.create({'message': 'Important information'}) The date format for the ``starts_at`` and ``ends_at`` parameters is ``YYYY-MM-ddThh:mm:ssZ``. Update a message:: msg.font = '#444444' msg.color = '#999999' msg.save() Delete a message:: gl.broadcastmessages.delete(msg_id) # or msg.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/milestones.rst0000644000000000000000000000515714366036457021122 0ustar00rootroot########## Milestones ########## Project milestones ================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectMilestone` + :class:`gitlab.v4.objects.ProjectMilestoneManager` + :attr:`gitlab.v4.objects.Project.milestones` + :class:`gitlab.v4.objects.GroupMilestone` + :class:`gitlab.v4.objects.GroupMilestoneManager` + :attr:`gitlab.v4.objects.Group.milestones` * GitLab API: + https://docs.gitlab.com/ce/api/milestones.html + https://docs.gitlab.com/ce/api/group_milestones.html Examples -------- List the milestones for a project or a group:: p_milestones = project.milestones.list() g_milestones = group.milestones.list() You can filter the list using the following parameters: * ``iids``: unique IDs of milestones for the project * ``state``: either ``active`` or ``closed`` * ``search``: to search using a string :: p_milestones = project.milestones.list(state='closed') g_milestones = group.milestones.list(state='active') Get a single milestone:: p_milestone = project.milestones.get(milestone_id) g_milestone = group.milestones.get(milestone_id) Create a milestone:: milestone = project.milestones.create({'title': '1.0'}) Edit a milestone:: milestone.description = 'v 1.0 release' milestone.save() Change the state of a milestone (activate / close):: # close a milestone milestone.state_event = 'close' milestone.save() # activate a milestone milestone.state_event = 'activate' milestone.save() Promote a project milestone:: milestone.promote() List the issues related to a milestone:: issues = milestone.issues() List the merge requests related to a milestone:: merge_requests = milestone.merge_requests() Milestone events ================ Resource milestone events keep track of what happens to GitLab issues and merge requests. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIssueResourceMilestoneEvent` + :class:`gitlab.v4.objects.ProjectIssueResourceMilestoneEventManager` + :attr:`gitlab.v4.objects.ProjectIssue.resourcemilestoneevents` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEvent` + :class:`gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEventManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcemilestoneevents` * GitLab API: https://docs.gitlab.com/ee/api/resource_milestone_events.html Examples -------- Get milestones for a resource (issue, merge request):: milestones = resource.resourcemilestoneevents.list() Get a specific milestone for a resource:: milestone = resource.resourcemilestoneevents.get(milestone_id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/namespaces.rst0000644000000000000000000000127114366036457021050 0ustar00rootroot########## Namespaces ########## Reference --------- * v4 API: + :class:`gitlab.v4.objects.Namespace` + :class:`gitlab.v4.objects.NamespaceManager` + :attr:`gitlab.Gitlab.namespaces` * GitLab API: https://docs.gitlab.com/ce/api/namespaces.html Examples -------- List namespaces:: namespaces = gl.namespaces.list() Search namespaces:: namespaces = gl.namespaces.list(search='foo') Get a namespace by ID or path:: namespace = gl.namespaces.get("my-namespace") Get existence of a namespace by path:: namespace = gl.namespaces.exists("new-namespace") if namespace.exists: # get suggestions of namespaces that don't already exist print(namespace.suggests) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/notes.rst0000644000000000000000000000321314366036457020057 0ustar00rootroot.. _project-notes: ##### Notes ##### You can manipulate notes (comments) on group epics, project issues, merge requests and snippets. Reference --------- * v4 API: Epics: * :class:`gitlab.v4.objects.GroupEpicNote` * :class:`gitlab.v4.objects.GroupEpicNoteManager` * :attr:`gitlab.v4.objects.GroupEpic.notes` Issues: + :class:`gitlab.v4.objects.ProjectIssueNote` + :class:`gitlab.v4.objects.ProjectIssueNoteManager` + :attr:`gitlab.v4.objects.ProjectIssue.notes` MergeRequests: + :class:`gitlab.v4.objects.ProjectMergeRequestNote` + :class:`gitlab.v4.objects.ProjectMergeRequestNoteManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.notes` Snippets: + :class:`gitlab.v4.objects.ProjectSnippetNote` + :class:`gitlab.v4.objects.ProjectSnippetNoteManager` + :attr:`gitlab.v4.objects.ProjectSnippet.notes` * GitLab API: https://docs.gitlab.com/ce/api/notes.html Examples -------- List the notes for a resource:: e_notes = epic.notes.list() i_notes = issue.notes.list() mr_notes = mr.notes.list() s_notes = snippet.notes.list() Get a note for a resource:: e_note = epic.notes.get(note_id) i_note = issue.notes.get(note_id) mr_note = mr.notes.get(note_id) s_note = snippet.notes.get(note_id) Create a note for a resource:: e_note = epic.notes.create({'body': 'note content'}) i_note = issue.notes.create({'body': 'note content'}) mr_note = mr.notes.create({'body': 'note content'}) s_note = snippet.notes.create({'body': 'note content'}) Update a note for a resource:: note.body = 'updated note content' note.save() Delete a note for a resource:: note.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/notifications.rst0000644000000000000000000000352514366036457021606 0ustar00rootroot##################### Notification settings ##################### You can define notification settings globally, for groups and for projects. Valid levels are defined as constants: * ``gitlab.const.NotificationLevel.DISABLED`` * ``gitlab.const.NotificationLevel.PARTICIPATING`` * ``gitlab.const.NotificationLevel.WATCH`` * ``gitlab.const.NotificationLevel.GLOBAL`` * ``gitlab.const.NotificationLevel.MENTION`` * ``gitlab.const.NotificationLevel.CUSTOM`` You get access to fine-grained settings if you use the ``NOTIFICATION_LEVEL_CUSTOM`` level. Reference --------- * v4 API: + :class:`gitlab.v4.objects.NotificationSettings` + :class:`gitlab.v4.objects.NotificationSettingsManager` + :attr:`gitlab.Gitlab.notificationsettings` + :class:`gitlab.v4.objects.GroupNotificationSettings` + :class:`gitlab.v4.objects.GroupNotificationSettingsManager` + :attr:`gitlab.v4.objects.Group.notificationsettings` + :class:`gitlab.v4.objects.ProjectNotificationSettings` + :class:`gitlab.v4.objects.ProjectNotificationSettingsManager` + :attr:`gitlab.v4.objects.Project.notificationsettings` * GitLab API: https://docs.gitlab.com/ce/api/notification_settings.html Examples -------- Get the notifications settings:: # global settings settings = gl.notificationsettings.get() # for a group settings = gl.groups.get(group_id).notificationsettings.get() # for a project settings = gl.projects.get(project_id).notificationsettings.get() Update the notifications settings:: # use a predefined level settings.level = gitlab.const.NotificationLevel.WATCH # create a custom setup settings.level = gitlab.const.NotificationLevel.CUSTOM settings.save() # will create additional attributes, but not mandatory settings.new_merge_request = True settings.new_issue = True settings.new_note = True settings.save() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/packages.rst0000644000000000000000000000572214366036457020514 0ustar00rootroot######## Packages ######## Packages allow you to utilize GitLab as a private repository for a variety of common package managers, as well as GitLab's generic package registry. Project Packages ===================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectPackage` + :class:`gitlab.v4.objects.ProjectPackageManager` + :attr:`gitlab.v4.objects.Project.packages` * GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-project Examples -------- List the packages in a project:: packages = project.packages.list() Filter the results by ``package_type`` or ``package_name`` :: packages = project.packages.list(package_type='pypi') Get a specific package of a project by id:: package = project.packages.get(1) Delete a package from a project:: package.delete() # or project.packages.delete(package.id) Group Packages =================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.GroupPackage` + :class:`gitlab.v4.objects.GroupPackageManager` + :attr:`gitlab.v4.objects.Group.packages` * GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-group Examples -------- List the packages in a group:: packages = group.packages.list() Filter the results by ``package_type`` or ``package_name`` :: packages = group.packages.list(package_type='pypi') Project Package Files ===================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectPackageFile` + :class:`gitlab.v4.objects.ProjectPackageFileManager` + :attr:`gitlab.v4.objects.ProjectPackage.package_files` * GitLab API: https://docs.gitlab.com/ee/api/packages.html#list-package-files Examples -------- List package files for package in project:: package = project.packages.get(1) package_files = package.package_files.list() Delete a package file in a project:: package = project.packages.get(1) file = package.package_files.list()[0] file.delete() Generic Packages ================ You can use python-gitlab to upload and download generic packages. Reference --------- * v4 API: + :class:`gitlab.v4.objects.GenericPackage` + :class:`gitlab.v4.objects.GenericPackageManager` + :attr:`gitlab.v4.objects.Project.generic_packages` * GitLab API: https://docs.gitlab.com/ee/user/packages/generic_packages Examples -------- Upload a generic package to a project:: project = gl.projects.get(1, lazy=True) package = project.generic_packages.upload( package_name="hello-world", package_version="v1.0.0", file_name="hello.tar.gz", path="/path/to/local/hello.tar.gz" ) Download a project's generic package:: project = gl.projects.get(1, lazy=True) package = project.generic_packages.download( package_name="hello-world", package_version="v1.0.0", file_name="hello.tar.gz", ) .. hint:: You can use the Packages API described above to find packages and retrieve the metadata you need download them. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/pagesdomains.rst0000644000000000000000000000233014366036457021400 0ustar00rootroot############# Pages domains ############# Admin ===== References ---------- * v4 API: + :class:`gitlab.v4.objects.PagesDomain` + :class:`gitlab.v4.objects.PagesDomainManager` + :attr:`gitlab.Gitlab.pagesdomains` * GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-all-pages-domains Examples -------- List all the existing domains (admin only):: domains = gl.pagesdomains.list() Project pages domain ==================== References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectPagesDomain` + :class:`gitlab.v4.objects.ProjectPagesDomainManager` + :attr:`gitlab.v4.objects.Project.pagesdomains` * GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-pages-domains Examples -------- List domains for a project:: domains = project.pagesdomains.list() Get a single domain:: domain = project.pagesdomains.get('d1.example.com') Create a new domain:: domain = project.pagesdomains.create({'domain': 'd2.example.com}) Update an existing domain:: domain.certificate = open('d2.crt').read() domain.key = open('d2.key').read() domain.save() Delete an existing domain:: domain.delete # or project.pagesdomains.delete('d2.example.com') ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/personal_access_tokens.rst0000644000000000000000000000337014366036457023462 0ustar00rootroot###################### Personal Access Tokens ###################### References ---------- * v4 API: + :class:`gitlab.v4.objects.PersonalAccessToken` + :class:`gitlab.v4.objects.PersonalAcessTokenManager` + :attr:`gitlab.Gitlab.personal_access_tokens` + :class:`gitlab.v4.objects.UserPersonalAccessToken` + :class:`gitlab.v4.objects.UserPersonalAcessTokenManager` + :attr:`gitlab.Gitlab.User.personal_access_tokens` * GitLab API: + https://docs.gitlab.com/ee/api/personal_access_tokens.html + https://docs.gitlab.com/ee/api/users.html#create-a-personal-access-token Examples -------- List personal access tokens:: access_tokens = gl.personal_access_tokens.list() print(access_tokens[0].name) List personal access tokens from other user_id (admin only):: access_tokens = gl.personal_access_tokens.list(user_id=25) Revoke a personal access token fetched via list:: access_token = access_tokens[0] access_token.delete() Revoke a personal access token by id:: gl.personal_access_tokens.delete(123) Revoke the personal access token currently used:: gl.personal_access_tokens.delete("self") Create a personal access token for a user (admin only):: user = gl.users.get(25, lazy=True) access_token = user.personal_access_tokens.create({"name": "test", "scopes": "api"}) .. note:: As you can see above, you can only create personal access tokens via the Users API, but you cannot revoke these objects directly. This is because the create API uses a different endpoint than the list and revoke APIs. You need to fetch the token via the list API first to revoke it. As of 14.2, GitLab does not provide a GET API for single personal access tokens. You must use the list method to retrieve single tokens. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/pipelines_and_jobs.rst0000644000000000000000000002312414366036457022561 0ustar00rootroot################## Pipelines and Jobs ################## Project pipelines ================= A pipeline is a group of jobs executed by GitLab CI. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectPipeline` + :class:`gitlab.v4.objects.ProjectPipelineManager` + :attr:`gitlab.v4.objects.Project.pipelines` * GitLab API: https://docs.gitlab.com/ce/api/pipelines.html Examples -------- List pipelines for a project:: pipelines = project.pipelines.list() Get a pipeline for a project:: pipeline = project.pipelines.get(pipeline_id) Get variables of a pipeline:: variables = pipeline.variables.list() Create a pipeline for a particular reference with custom variables:: pipeline = project.pipelines.create({'ref': 'main', 'variables': [{'key': 'MY_VARIABLE', 'value': 'hello'}]}) Retry the failed builds for a pipeline:: pipeline.retry() Cancel builds in a pipeline:: pipeline.cancel() Delete a pipeline:: pipeline.delete() Triggers ======== Triggers provide a way to interact with the GitLab CI. Using a trigger a user or an application can run a new build/job for a specific commit. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectTrigger` + :class:`gitlab.v4.objects.ProjectTriggerManager` + :attr:`gitlab.v4.objects.Project.triggers` * GitLab API: https://docs.gitlab.com/ce/api/pipeline_triggers.html Examples -------- List triggers:: triggers = project.triggers.list() Get a trigger:: trigger = project.triggers.get(trigger_token) Create a trigger:: trigger = project.triggers.create({'description': 'mytrigger'}) Remove a trigger:: project.triggers.delete(trigger_token) # or trigger.delete() Full example with wait for finish:: def get_or_create_trigger(project): trigger_decription = 'my_trigger_id' for t in project.triggers.list(): if t.description == trigger_decription: return t return project.triggers.create({'description': trigger_decription}) trigger = get_or_create_trigger(project) pipeline = project.trigger_pipeline('main', trigger.token, variables={"DEPLOY_ZONE": "us-west1"}) while pipeline.finished_at is None: pipeline.refresh() time.sleep(1) You can trigger a pipeline using token authentication instead of user authentication. To do so create an anonymous Gitlab instance and use lazy objects to get the associated project:: gl = gitlab.Gitlab(URL) # no authentication project = gl.projects.get(project_id, lazy=True) # no API call project.trigger_pipeline('main', trigger_token) Reference: https://docs.gitlab.com/ee/ci/triggers/#trigger-token Pipeline schedules ================== You can schedule pipeline runs using a cron-like syntax. Variables can be associated with the scheduled pipelines. Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectPipelineSchedule` + :class:`gitlab.v4.objects.ProjectPipelineScheduleManager` + :attr:`gitlab.v4.objects.Project.pipelineschedules` + :class:`gitlab.v4.objects.ProjectPipelineScheduleVariable` + :class:`gitlab.v4.objects.ProjectPipelineScheduleVariableManager` + :attr:`gitlab.v4.objects.ProjectPipelineSchedule.variables` + :class:`gitlab.v4.objects.ProjectPipelineSchedulePipeline` + :class:`gitlab.v4.objects.ProjectPipelineSchedulePipelineManager` + :attr:`gitlab.v4.objects.ProjectPipelineSchedule.pipelines` * GitLab API: https://docs.gitlab.com/ce/api/pipeline_schedules.html Examples -------- List pipeline schedules:: scheds = project.pipelineschedules.list() Get a single schedule:: sched = projects.pipelineschedules.get(schedule_id) Create a new schedule:: sched = project.pipelineschedules.create({ 'ref': 'main', 'description': 'Daily test', 'cron': '0 1 * * *'}) Update a schedule:: sched.cron = '1 2 * * *' sched.save() Take ownership of a schedule: sched.take_ownership() Trigger a pipeline schedule immediately:: sched = projects.pipelineschedules.get(schedule_id) sched.play() Delete a schedule:: sched.delete() List schedule variables:: # note: you need to use get() to retrieve the schedule variables. The # attribute is not present in the response of a list() call sched = projects.pipelineschedules.get(schedule_id) vars = sched.attributes['variables'] Create a schedule variable:: var = sched.variables.create({'key': 'foo', 'value': 'bar'}) Edit a schedule variable:: var.value = 'new_value' var.save() Delete a schedule variable:: var.delete() List all pipelines triggered by a pipeline schedule:: pipelines = sched.pipelines.list() Jobs ==== Jobs are associated to projects, pipelines and commits. They provide information on the jobs that have been run, and methods to manipulate them. Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectJob` + :class:`gitlab.v4.objects.ProjectJobManager` + :attr:`gitlab.v4.objects.Project.jobs` * GitLab API: https://docs.gitlab.com/ce/api/jobs.html Examples -------- Jobs are usually automatically triggered, but you can explicitly trigger a new job:: project.trigger_build('main', trigger_token, {'extra_var1': 'foo', 'extra_var2': 'bar'}) List jobs for the project:: jobs = project.jobs.list() Get a single job:: project.jobs.get(job_id) List the jobs of a pipeline:: project = gl.projects.get(project_id) pipeline = project.pipelines.get(pipeline_id) jobs = pipeline.jobs.list() .. note:: Job methods (play, cancel, and so on) are not available on ``ProjectPipelineJob`` objects. To use these methods create a ``ProjectJob`` object:: pipeline_job = pipeline.jobs.list()[0] job = project.jobs.get(pipeline_job.id, lazy=True) job.retry() Get the artifacts of a job:: build_or_job.artifacts() Get the artifacts of a job by its name from the latest successful pipeline of a branch or tag:: project.artifacts.download(ref_name='main', job='build') .. attention:: An older method ``project.artifacts()`` is deprecated and will be removed in a future version. .. warning:: Artifacts are entirely stored in memory in this example. .. _streaming_example: You can download artifacts as a stream. Provide a callable to handle the stream:: with open("archive.zip", "wb") as f: build_or_job.artifacts(streamed=True, action=f.write) You can also directly stream the output into a file, and unzip it afterwards:: zipfn = "___artifacts.zip" with open(zipfn, "wb") as f: build_or_job.artifacts(streamed=True, action=f.write) subprocess.run(["unzip", "-bo", zipfn]) os.unlink(zipfn) Or, you can also use the underlying response iterator directly:: artifact_bytes_iterator = build_or_job.artifacts(iterator=True) This can be used with frameworks that expect an iterator (such as FastAPI/Starlette's ``StreamingResponse``) to forward a download from GitLab without having to download the entire content server-side first:: @app.get("/download_artifact") def download_artifact(): artifact_bytes_iterator = build_or_job.artifacts(iterator=True) return StreamingResponse(artifact_bytes_iterator, media_type="application/zip") Delete all artifacts of a project that can be deleted:: project.artifacts.delete() Get a single artifact file:: build_or_job.artifact('path/to/file') Get a single artifact file by branch and job:: project.artifacts.raw('branch', 'path/to/file', 'job') .. attention:: An older method ``project.artifact()`` is deprecated and will be removed in a future version. Mark a job artifact as kept when expiration is set:: build_or_job.keep_artifacts() Delete the artifacts of a job:: build_or_job.delete_artifacts() Get a job log file / trace:: build_or_job.trace() .. warning:: Traces are entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Cancel/retry a job:: build_or_job.cancel() build_or_job.retry() Play (trigger) a job:: build_or_job.play() Erase a job (artifacts and trace):: build_or_job.erase() Pipeline bridges ===================== Get a list of bridge jobs (including child pipelines) for a pipeline. Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectPipelineBridge` + :class:`gitlab.v4.objects.ProjectPipelineBridgeManager` + :attr:`gitlab.v4.objects.ProjectPipeline.bridges` * GitLab API: https://docs.gitlab.com/ee/api/jobs.html#list-pipeline-bridges Examples -------- List bridges for the pipeline:: bridges = pipeline.bridges.list() Pipeline test report ==================== Get a pipeline's complete test report. Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectPipelineTestReport` + :class:`gitlab.v4.objects.ProjectPipelineTestReportManager` + :attr:`gitlab.v4.objects.ProjectPipeline.test_report` * GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report Examples -------- Get the test report for a pipeline:: test_report = pipeline.test_report.get() Pipeline test report summary ============================ Get a pipeline’s test report summary. Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummary` + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummaryManager` + :attr:`gitlab.v4.objects.ProjectPipeline.test_report_summary` * GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report-summary Examples -------- Get the test report summary for a pipeline:: test_report_summary = pipeline.test_report_summary.get() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/project_access_tokens.rst0000644000000000000000000000137614366036457023311 0ustar00rootroot##################### Project Access Tokens ##################### Get a list of project access tokens References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectAccessToken` + :class:`gitlab.v4.objects.ProjectAccessTokenManager` + :attr:`gitlab.Gitlab.project_access_tokens` * GitLab API: https://docs.gitlab.com/ee/api/project_access_tokens.html Examples -------- List project access tokens:: access_tokens = gl.projects.get(1, lazy=True).access_tokens.list() print(access_tokens[0].name) Create project access token:: access_token = gl.projects.get(1).access_tokens.create({"name": "test", "scopes": ["api"]}) Revoke a project access tokens:: gl.projects.get(1).access_tokens.delete(42) # or access_token.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/projects.rst0000644000000000000000000005311714366036457020570 0ustar00rootroot######## Projects ######## Projects ======== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Project` + :class:`gitlab.v4.objects.ProjectManager` + :attr:`gitlab.Gitlab.projects` * GitLab API: https://docs.gitlab.com/ce/api/projects.html Examples -------- List projects:: projects = gl.projects.list() The API provides several filtering parameters for the listing methods: * ``archived``: if ``True`` only archived projects will be returned * ``visibility``: returns only projects with the specified visibility (can be ``public``, ``internal`` or ``private``) * ``search``: returns project matching the given pattern Results can also be sorted using the following parameters: * ``order_by``: sort using the given argument. Valid values are ``id``, ``name``, ``path``, ``created_at``, ``updated_at`` and ``last_activity_at``. The default is to sort by ``created_at`` * ``sort``: sort order (``asc`` or ``desc``) :: # List all projects (default 20) projects = gl.projects.list(get_all=True) # Archived projects projects = gl.projects.list(archived=1) # Limit to projects with a defined visibility projects = gl.projects.list(visibility='public') # List owned projects projects = gl.projects.list(owned=True) # List starred projects projects = gl.projects.list(starred=True) # Search projects projects = gl.projects.list(search='keyword') .. note:: To list the starred projects of another user, see the :ref:`Users API docs `. .. note:: Fetching a list of projects, doesn't include all attributes of all projects. To retrieve all attributes, you'll need to fetch a single project Get a single project:: # Get a project by ID project_id = 851 project = gl.projects.get(project_id) # Get a project by name with namespace project_name_with_namespace = "namespace/project_name" project = gl.projects.get(project_name_with_namespace) Create a project:: project = gl.projects.create({'name': 'project1'}) Create a project for a user (admin only):: alice = gl.users.list(username='alice')[0] user_project = alice.projects.create({'name': 'project'}) user_projects = alice.projects.list() Create a project in a group:: # You need to get the id of the group, then use the namespace_id attribute # to create the group group_id = gl.groups.list(search='my-group')[0].id project = gl.projects.create({'name': 'myrepo', 'namespace_id': group_id}) List a project's groups:: # Get a list of ancestor/parent groups for a project. groups = project.groups.list() Update a project:: project.snippets_enabled = 1 project.save() Set the avatar image for a project:: # the avatar image can be passed as data (content of the file) or as a file # object opened in binary mode project.avatar = open('path/to/file.png', 'rb') project.save() Delete a project:: gl.projects.delete(project_id) # or project.delete() Restore a project marked for deletion (Premium only):: project.restore() Fork a project:: fork = project.forks.create({}) # fork to a specific namespace fork = project.forks.create({'namespace': 'myteam'}) Get a list of forks for the project:: forks = project.forks.list() Create/delete a fork relation between projects (requires admin permissions):: project.create_fork_relation(source_project.id) project.delete_fork_relation() Get languages used in the project with percentage value:: languages = project.languages() Star/unstar a project:: project.star() project.unstar() Archive/unarchive a project:: project.archive() project.unarchive() Start the housekeeping job:: project.housekeeping() List the repository tree:: # list the content of the root directory for the default branch items = project.repository_tree() # list the content of a subdirectory on a specific branch items = project.repository_tree(path='docs', ref='branch1') Get the content and metadata of a file for a commit, using a blob sha:: items = project.repository_tree(path='docs', ref='branch1') file_info = p.repository_blob(items[0]['id']) content = base64.b64decode(file_info['content']) size = file_info['size'] Update a project submodule:: items = project.update_submodule( submodule="foo/bar", branch="main", commit_sha="4c3674f66071e30b3311dac9b9ccc90502a72664", commit_message="Message", # optional ) Get the repository archive:: tgz = project.repository_archive() # get the archive for a branch/tag/commit tgz = project.repository_archive(sha='4567abc') # get the archive in a different format zip = project.repository_archive(format='zip') .. note:: For the formats available, refer to https://docs.gitlab.com/ce/api/repositories.html#get-file-archive .. warning:: Archives are entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Get the content of a file using the blob id:: # find the id for the blob (simple search) id = [d['id'] for d in p.repository_tree() if d['name'] == 'README.rst'][0] # get the content file_content = p.repository_raw_blob(id) .. warning:: Blobs are entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Get a snapshot of the repository:: tar_file = project.snapshot() .. warning:: Snapshots are entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Compare two branches, tags or commits:: result = project.repository_compare('main', 'branch1') # get the commits for commit in result['commits']: print(commit) # get the diffs for file_diff in result['diffs']: print(file_diff) Get the merge base for two or more branches, tags or commits:: commit = project.repository_merge_base(['main', 'v1.2.3', 'bd1324e2f']) Get a list of contributors for the repository:: contributors = project.repository_contributors() Get a list of users for the repository:: users = p.users.list() # search for users users = p.users.list(search='pattern') Start the pull mirroring process (EE edition):: project.mirror_pull() Get a project’s pull mirror details (EE edition):: mirror_pull_details = project.mirror_pull_details() Import / Export =============== You can export projects from gitlab, and re-import them to create new projects or overwrite existing ones. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectExport` + :class:`gitlab.v4.objects.ProjectExportManager` + :attr:`gitlab.v4.objects.Project.exports` + :class:`gitlab.v4.objects.ProjectImport` + :class:`gitlab.v4.objects.ProjectImportManager` + :attr:`gitlab.v4.objects.Project.imports` + :attr:`gitlab.v4.objects.ProjectManager.import_project` * GitLab API: https://docs.gitlab.com/ce/api/project_import_export.html .. _project_import_export: Examples -------- A project export is an asynchronous operation. To retrieve the archive generated by GitLab you need to: #. Create an export using the API #. Wait for the export to be done #. Download the result :: # Create the export p = gl.projects.get(my_project) export = p.exports.create() # Wait for the 'finished' status export.refresh() while export.export_status != 'finished': time.sleep(1) export.refresh() # Download the result with open('/tmp/export.tgz', 'wb') as f: export.download(streamed=True, action=f.write) You can export and upload a project to an external URL (see upstream documentation for more details):: project.exports.create( { "upload": { "url": "http://localhost:8080", "method": "POST" } } ) You can also get the status of an existing export, regardless of whether it was created via the API or the Web UI:: project = gl.projects.get(my_project) # Gets the current export status export = project.exports.get() Import the project into the current user's namespace:: with open('/tmp/export.tgz', 'rb') as f: output = gl.projects.import_project( f, path='my_new_project', name='My New Project' ) # Get a ProjectImport object to track the import status project_import = gl.projects.get(output['id'], lazy=True).imports.get() while project_import.import_status != 'finished': time.sleep(1) project_import.refresh() Import the project into a namespace and override parameters:: with open('/tmp/export.tgz', 'rb') as f: output = gl.projects.import_project( f, path='my_new_project', name='My New Project', namespace='my-group', override_params={'visibility': 'private'}, ) Import the project using file stored on a remote URL:: output = gl.projects.remote_import( url="https://whatever.com/url/file.tar.gz", path="my_new_remote_project", name="My New Remote Project", namespace="my-group", override_params={'visibility': 'private'}, ) Import the project using file stored on AWS S3:: output = gl.projects.remote_import_s3( path="my_new_remote_project", region="aws-region", bucket_name="aws-bucket-name", file_key="aws-file-key", access_key_id="aws-access-key-id", secret_access_key="secret-access-key", name="My New Remote Project", namespace="my-group", override_params={'visibility': 'private'}, ) Project custom attributes ========================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectCustomAttribute` + :class:`gitlab.v4.objects.ProjectCustomAttributeManager` + :attr:`gitlab.v4.objects.Project.customattributes` * GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html Examples -------- List custom attributes for a project:: attrs = project.customattributes.list() Get a custom attribute for a project:: attr = project.customattributes.get(attr_key) Set (create or update) a custom attribute for a project:: attr = project.customattributes.set(attr_key, attr_value) Delete a custom attribute for a project:: attr.delete() # or project.customattributes.delete(attr_key) Search projects by custom attribute:: project.customattributes.set('type', 'internal') gl.projects.list(custom_attributes={'type': 'internal'}) Project files ============= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectFile` + :class:`gitlab.v4.objects.ProjectFileManager` + :attr:`gitlab.v4.objects.Project.files` * GitLab API: https://docs.gitlab.com/ce/api/repository_files.html Examples -------- Get a file:: f = project.files.get(file_path='README.rst', ref='main') # get the base64 encoded content print(f.content) # get the decoded content print(f.decode()) Get file details from headers, without fetching its entire content:: headers = project.files.head('README.rst', ref='main') # Get the file size: # For a full list of headers returned, see upstream documentation. # https://docs.gitlab.com/ee/api/repository_files.html#get-file-from-repository print(headers["X-Gitlab-Size"]) Get a raw file:: raw_content = project.files.raw(file_path='README.rst', ref='main') print(raw_content) with open('/tmp/raw-download.txt', 'wb') as f: project.files.raw(file_path='README.rst', ref='main', streamed=True, action=f.write) Create a new file:: f = project.files.create({'file_path': 'testfile.txt', 'branch': 'main', 'content': file_content, 'author_email': 'test@example.com', 'author_name': 'yourname', 'commit_message': 'Create testfile'}) Update a file. The entire content must be uploaded, as plain text or as base64 encoded text:: f.content = 'new content' f.save(branch='main', commit_message='Update testfile') # or for binary data # Note: decode() is required with python 3 for data serialization. You can omit # it with python 2 f.content = base64.b64encode(open('image.png').read()).decode() f.save(branch='main', commit_message='Update testfile', encoding='base64') Delete a file:: f.delete(commit_message='Delete testfile', branch='main') # or project.files.delete(file_path='testfile.txt', commit_message='Delete testfile', branch='main') Get file blame:: b = project.files.blame(file_path='README.rst', ref='main') Project tags ============ Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectTag` + :class:`gitlab.v4.objects.ProjectTagManager` + :attr:`gitlab.v4.objects.Project.tags` * GitLab API: https://docs.gitlab.com/ce/api/tags.html Examples -------- List the project tags:: tags = project.tags.list() Get a tag:: tag = project.tags.get('1.0') Create a tag:: tag = project.tags.create({'tag_name': '1.0', 'ref': 'main'}) Delete a tag:: project.tags.delete('1.0') # or tag.delete() .. _project_snippets: Project snippets ================ The snippet visibility can be defined using the following constants: * ``gitlab.const.Visibility.PRIVATE`` * ``gitlab.const.Visibility.INTERNAL`` * ``gitlab.const.Visibility.PUBLIC`` Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectSnippet` + :class:`gitlab.v4.objects.ProjectSnippetManager` + :attr:`gitlab.v4.objects.Project.files` * GitLab API: https://docs.gitlab.com/ce/api/project_snippets.html Examples -------- List the project snippets:: snippets = project.snippets.list() Get a snippet:: snippet = project.snippets.get(snippet_id) Get the content of a snippet:: print(snippet.content()) .. warning:: The snippet content is entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Create a snippet:: snippet = project.snippets.create({'title': 'sample 1', 'file_name': 'foo.py', 'code': 'import gitlab', 'visibility_level': gitlab.const.Visibility.PRIVATE}) Update a snippet:: snippet.code = 'import gitlab\nimport whatever' snippet.save Delete a snippet:: project.snippets.delete(snippet_id) # or snippet.delete() Get user agent detail (admin only):: detail = snippet.user_agent_detail() Notes ===== See :ref:`project-notes`. Project members =============== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectMember` + :class:`gitlab.v4.objects.ProjectMemberManager` + :class:`gitlab.v4.objects.ProjectMemberAllManager` + :attr:`gitlab.v4.objects.Project.members` + :attr:`gitlab.v4.objects.Project.members_all` * GitLab API: https://docs.gitlab.com/ce/api/members.html Examples -------- List only direct project members:: members = project.members.list() List the project members recursively (including inherited members through ancestor groups):: members = project.members_all.list(get_all=True) Search project members matching a query string:: members = project.members.list(query='bar') Get only direct project member:: member = project.members.get(user_id) Get a member of a project, including members inherited through ancestor groups:: members = project.members_all.get(member_id) Add a project member:: member = project.members.create({'user_id': user.id, 'access_level': gitlab.const.AccessLevel.DEVELOPER}) Modify a project member (change the access level):: member.access_level = gitlab.const.AccessLevel.MAINTAINER member.save() Remove a member from the project team:: project.members.delete(user.id) # or member.delete() Share/unshare the project with a group:: project.share(group.id, gitlab.const.AccessLevel.DEVELOPER) project.unshare(group.id) Project hooks ============= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectHook` + :class:`gitlab.v4.objects.ProjectHookManager` + :attr:`gitlab.v4.objects.Project.hooks` * GitLab API: https://docs.gitlab.com/ce/api/projects.html#hooks Examples -------- List the project hooks:: hooks = project.hooks.list() Get a project hook:: hook = project.hooks.get(hook_id) Create a project hook:: hook = project.hooks.create({'url': 'http://my/action/url', 'push_events': 1}) Update a project hook:: hook.push_events = 0 hook.save() Delete a project hook:: project.hooks.delete(hook_id) # or hook.delete() Project Integrations ==================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectIntegration` + :class:`gitlab.v4.objects.ProjectIntegrationManager` + :attr:`gitlab.v4.objects.Project.integrations` * GitLab API: https://docs.gitlab.com/ce/api/integrations.html Examples --------- .. danger:: Since GitLab 13.12, ``get()`` calls to project integrations return a ``404 Not Found`` response until they have been activated the first time. To avoid this, we recommend using `lazy=True` to prevent making the initial call when activating new integrations unless they have previously already been activated. Configure and enable an integration for the first time:: integration = project.integrations.get('asana', lazy=True) integration.api_key = 'randomkey' integration.save() Get an existing integration:: integration = project.integrations.get('asana') # display its status (enabled/disabled) print(integration.active) List active project integrations:: integration = project.integrations.list() List the code names of available integrations (doesn't return objects):: integrations = project.integrations.available() Disable an integration:: integration.delete() File uploads ============ Reference --------- * v4 API: + :attr:`gitlab.v4.objects.Project.upload` * Gitlab API: https://docs.gitlab.com/ce/api/projects.html#upload-a-file Examples -------- Upload a file into a project using a filesystem path:: project.upload("filename.txt", filepath="/some/path/filename.txt") Upload a file into a project without a filesystem path:: project.upload("filename.txt", filedata="Raw data") Upload a file and comment on an issue using the uploaded file's markdown:: uploaded_file = project.upload("filename.txt", filedata="data") issue = project.issues.get(issue_id) issue.notes.create({ "body": "See the attached file: {}".format(uploaded_file["markdown"]) }) Upload a file and comment on an issue while using custom markdown to reference the uploaded file:: uploaded_file = project.upload("filename.txt", filedata="data") issue = project.issues.get(issue_id) issue.notes.create({ "body": "See the [attached file]({})".format(uploaded_file["url"]) }) Project push rules ================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectPushRules` + :class:`gitlab.v4.objects.ProjectPushRulesManager` + :attr:`gitlab.v4.objects.Project.pushrules` * GitLab API: https://docs.gitlab.com/ee/api/projects.html#push-rules Examples --------- Create project push rules (at least one rule is necessary):: project.pushrules.create({'deny_delete_tag': True}) Get project push rules:: pr = project.pushrules.get() Edit project push rules:: pr.branch_name_regex = '^(main|develop|support-\d+|release-\d+\..+|hotfix-.+|feature-.+)$' pr.save() Delete project push rules:: pr.delete() Project protected tags ====================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectProtectedTag` + :class:`gitlab.v4.objects.ProjectProtectedTagManager` + :attr:`gitlab.v4.objects.Project.protectedtags` * GitLab API: https://docs.gitlab.com/ce/api/protected_tags.html Examples --------- Get a list of protected tags from a project:: protected_tags = project.protectedtags.list() Get a single protected tag or wildcard protected tag:: protected_tag = project.protectedtags.get('v*') Protect a single repository tag or several project repository tags using a wildcard protected tag:: project.protectedtags.create({'name': 'v*', 'create_access_level': '40'}) Unprotect the given protected tag or wildcard protected tag.:: protected_tag.delete() Additional project statistics ============================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectAdditionalStatistics` + :class:`gitlab.v4.objects.ProjectAdditionalStatisticsManager` + :attr:`gitlab.v4.objects.Project.additionalstatistics` * GitLab API: https://docs.gitlab.com/ce/api/project_statistics.html Examples --------- Get all additional statistics of a project:: statistics = project.additionalstatistics.get() Get total fetches in last 30 days of a project:: total_fetches = project.additionalstatistics.get().fetches['total'] Project storage ============================= This endpoint requires admin access. Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectStorage` + :class:`gitlab.v4.objects.ProjectStorageManager` + :attr:`gitlab.v4.objects.Project.storage` * GitLab API: https://docs.gitlab.com/ee/api/projects.html#get-the-path-to-repository-storage Examples --------- Get the repository storage details for a project:: storage = project.storage.get() Get the repository storage disk path:: disk_path = project.storage.get().disk_path ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/protected_branches.rst0000644000000000000000000000253114366036457022567 0ustar00rootroot################## Protected branches ################## You can define a list of protected branch names on a repository. Names can use wildcards (``*``). References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectProtectedBranch` + :class:`gitlab.v4.objects.ProjectProtectedBranchManager` + :attr:`gitlab.v4.objects.Project.protectedbranches` * GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api Examples -------- Get the list of protected branches for a project:: p_branches = project.protectedbranches.list() Get a single protected branch:: p_branch = project.protectedbranches.get('main') Create a protected branch:: p_branch = project.protectedbranches.create({ 'name': '*-stable', 'merge_access_level': gitlab.const.AccessLevel.DEVELOPER, 'push_access_level': gitlab.const.AccessLevel.MAINTAINER }) Create a protected branch with more granular access control:: p_branch = project.protectedbranches.create({ 'name': '*-stable', 'allowed_to_push': [{"user_id": 99}, {"user_id": 98}], 'allowed_to_merge': [{"group_id": 653}], 'allowed_to_unprotect': [{"access_level": gitlab.const.AccessLevel.MAINTAINER}] }) Delete a protected branch:: project.protectedbranches.delete('*-stable') # or p_branch.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/protected_environments.rst0000644000000000000000000000204514366036457023531 0ustar00rootroot###################### Protected environments ###################### You can list and manage protected environments in a project. References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectProtectedEnvironment` + :class:`gitlab.v4.objects.ProjectProtectedEnvironmentManager` + :attr:`gitlab.v4.objects.Project.protected_environment` * GitLab API: https://docs.gitlab.com/ee/api/protected_environments.html Examples -------- Get the list of protected environments for a project:: p_environments = project.protected_environments.list() Get a single protected environment:: p_environments = project.protected_environments.get('production') Protect an existing environment:: p_environment = project.protected_environments.create( { 'name': 'production', 'deploy_access_levels': [ {'access_level': 40} ], } ) Unprotect a protected environment:: p_environment = project.protected_environments.delete('production') # or p_environment.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/releases.rst0000644000000000000000000000376614366036457020547 0ustar00rootroot######## Releases ######## Project releases ================ Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectRelease` + :class:`gitlab.v4.objects.ProjectReleaseManager` + :attr:`gitlab.v4.objects.Project.releases` * Gitlab API: https://docs.gitlab.com/ee/api/releases/index.html Examples -------- Get a list of releases from a project:: project = gl.projects.get(project_id, lazy=True) release = project.releases.list() Get a single release:: release = project.releases.get('v1.2.3') Edit a release:: release.name = "Demo Release" release.description = "release notes go here" release.save() Create a release for a project tag:: release = project.releases.create({'name':'Demo Release', 'tag_name':'v1.2.3', 'description':'release notes go here'}) Delete a release:: # via its tag name from project attributes release = project.releases.delete('v1.2.3') # delete object directly release.delete() .. note:: The Releases API is one of the few working with ``CI_JOB_TOKEN``, but the project can't be fetched with the token. Thus use `lazy` for the project as in the above example. Also be aware that most of the capabilities of the endpoint were not accessible with ``CI_JOB_TOKEN`` until Gitlab version 14.5. Project release links ===================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectReleaseLink` + :class:`gitlab.v4.objects.ProjectReleaseLinkManager` + :attr:`gitlab.v4.objects.ProjectRelease.links` * Gitlab API: https://docs.gitlab.com/ee/api/releases/links.html Examples -------- Get a list of releases from a project:: links = release.links.list() Get a single release link:: link = release.links.get(1) Create a release link for a release:: link = release.links.create({"url": "https://example.com/asset", "name": "asset"}) Delete a release link:: # via its ID from release attributes release.links.delete(1) # delete object directly link.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/remote_mirrors.rst0000644000000000000000000000151614366036457022003 0ustar00rootroot###################### Project Remote Mirrors ###################### Remote Mirrors allow you to set up push mirroring for a project. References ========== * v4 API: + :class:`gitlab.v4.objects.ProjectRemoteMirror` + :class:`gitlab.v4.objects.ProjectRemoteMirrorManager` + :attr:`gitlab.v4.objects.Project.remote_mirrors` * GitLab API: https://docs.gitlab.com/ce/api/remote_mirrors.html Examples -------- Get the list of a project's remote mirrors:: mirrors = project.remote_mirrors.list() Create (and enable) a remote mirror for a project:: mirror = project.remote_mirrors.create({'url': 'https://gitlab.com/example.git', 'enabled': True}) Update an existing remote mirror's attributes:: mirror.enabled = False mirror.only_protected_branches = True mirror.save() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/repositories.rst0000644000000000000000000000137014366036457021460 0ustar00rootroot##################### Registry Repositories ##################### References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectRegistryRepository` + :class:`gitlab.v4.objects.ProjectRegistryRepositoryManager` + :attr:`gitlab.v4.objects.Project.repositories` * Gitlab API: https://docs.gitlab.com/ce/api/container_registry.html Examples -------- Get the list of container registry repositories associated with the project:: repositories = project.repositories.list() Get the list of all project container registry repositories in a group:: repositories = group.registry_repositories.list() Delete repository:: project.repositories.delete(id=x) # or repository = repositories.pop() repository.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/repository_tags.rst0000644000000000000000000000215014366036457022163 0ustar00rootroot######################## Registry Repository Tags ######################## References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectRegistryTag` + :class:`gitlab.v4.objects.ProjectRegistryTagManager` + :attr:`gitlab.v4.objects.Repository.tags` * Gitlab API: https://docs.gitlab.com/ce/api/container_registry.html Examples -------- Get the list of repository tags in given registry:: repositories = project.repositories.list() repository = repositories.pop() tags = repository.tags.list() Get specific tag:: repository.tags.get(id=tag_name) Delete tag:: repository.tags.delete(id=tag_name) # or tag = repository.tags.get(id=tag_name) tag.delete() Delete tag in bulk:: repository.tags.delete_in_bulk(keep_n=1) # or repository.tags.delete_in_bulk(older_than="1m") # or repository.tags.delete_in_bulk(name_regex="v.+", keep_n=2) .. note:: Delete in bulk is asynchronous operation and may take a while. Refer to: https://docs.gitlab.com/ce/api/container_registry.html#delete-repository-tags-in-bulk ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/resource_groups.rst0000644000000000000000000000171214366036457022157 0ustar00rootroot############### Resource Groups ############### Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectResourceGroup` + :class:`gitlab.v4.objects.ProjectResourceGroupManager` + :attr:`gitlab.v4.objects.Project.resource_groups` + :class:`gitlab.v4.objects.ProjectResourceGroupUpcomingJob` + :class:`gitlab.v4.objects.ProjectResourceGroupUpcomingJobManager` + :attr:`gitlab.v4.objects.ProjectResourceGroup.upcoming_jobs` * Gitlab API: https://docs.gitlab.com/ee/api/resource_groups.html Examples -------- List resource groups for a project:: project = gl.projects.get(project_id, lazy=True) resource_group = project.resource_groups.list() Get a single resource group:: resource_group = project.resource_groups.get("production") Edit a resource group:: resource_group.process_mode = "oldest_first" resource_group.save() List upcoming jobs for a resource group:: upcoming_jobs = resource_group.upcoming_jobs.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/runners.rst0000644000000000000000000000700614366036457020427 0ustar00rootroot####### Runners ####### Runners are external processes used to run CI jobs. They are deployed by the administrator and registered to the GitLab instance. Shared runners are available for all projects. Specific runners are enabled for a list of projects. Global runners (admin) ====================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Runner` + :class:`gitlab.v4.objects.RunnerManager` + :attr:`gitlab.Gitlab.runners` + :class:`gitlab.v4.objects.RunnerAll` + :class:`gitlab.v4.objects.RunnerAllManager` + :attr:`gitlab.Gitlab.runners_all` * GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- Use the ``runners.list()`` and ``runners_all.list()`` methods to list runners. ``runners.list()`` - Get a list of specific runners available to the user ``runners_all.list()`` - Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with administrator access. Both methods accept a ``scope`` parameter to filter the list. Allowed values for this parameter are: * ``active`` * ``paused`` * ``online`` * ``specific`` (``runners_all.list()`` only) * ``shared`` (``runners_all.list()`` only) .. note:: The returned objects hold minimal information about the runners. Use the ``get()`` method to retrieve detail about a runner. Runners returned via ``runners_all.list()`` also cannot be manipulated directly. You will need to use the ``get()`` method to create an editable object. :: # List owned runners runners = gl.runners.list() # List owned runners with a filter runners = gl.runners.list(scope='active') # List all runners in the GitLab instance (specific and shared), using a filter runners = gl.runners_all.list(scope='paused') Get a runner's detail:: runner = gl.runners.get(runner_id) Register a new runner:: runner = gl.runners.create({'token': secret_token}) Update a runner:: runner = gl.runners.get(runner_id) runner.tag_list.append('new_tag') runner.save() Remove a runner:: gl.runners.delete(runner_id) # or runner.delete() Remove a runner by its authentication token:: gl.runners.delete(token="runner-auth-token") Verify a registered runner token:: try: gl.runners.verify(runner_token) print("Valid token") except GitlabVerifyError: print("Invalid token") Project/Group runners ===================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.ProjectRunner` + :class:`gitlab.v4.objects.ProjectRunnerManager` + :attr:`gitlab.v4.objects.Project.runners` + :class:`gitlab.v4.objects.GroupRunner` + :class:`gitlab.v4.objects.GroupRunnerManager` + :attr:`gitlab.v4.objects.Group.runners` * GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- List the runners for a project:: runners = project.runners.list() Enable a specific runner for a project:: p_runner = project.runners.create({'runner_id': runner.id}) Disable a specific runner for a project:: project.runners.delete(runner.id) Runner jobs =========== Reference --------- * v4 API: + :class:`gitlab.v4.objects.RunnerJob` + :class:`gitlab.v4.objects.RunnerJobManager` + :attr:`gitlab.v4.objects.Runner.jobs` * GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- List for jobs for a runner:: jobs = runner.jobs.list() Filter the list using the jobs status:: # status can be 'running', 'success', 'failed' or 'canceled' active_jobs = runner.jobs.list(status='running') ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/search.rst0000644000000000000000000000445714366036457020207 0ustar00rootroot########## Search API ########## You can search for resources at the top level, in a project or in a group. Searches are based on a scope (issues, merge requests, and so on) and a search string. The following constants are provided to represent the possible scopes: * Shared scopes (global, group and project): + ``gitlab.const.SearchScope.PROJECTS``: ``projects`` + ``gitlab.const.SearchScope.ISSUES``: ``issues`` + ``gitlab.const.SearchScope.MERGE_REQUESTS``: ``merge_requests`` + ``gitlab.const.SearchScope.MILESTONES``: ``milestones`` + ``gitlab.const.SearchScope.WIKI_BLOBS``: ``wiki_blobs`` + ``gitlab.const.SearchScope.COMMITS``: ``commits`` + ``gitlab.const.SearchScope.BLOBS``: ``blobs`` + ``gitlab.const.SearchScope.USERS``: ``users`` * specific global scope: + ``gitlab.const.SearchScope.GLOBAL_SNIPPET_TITLES``: ``snippet_titles`` * specific project scope: + ``gitlab.const.SearchScope.PROJECT_NOTES``: ``notes`` Reference --------- * v4 API: + :attr:`gitlab.Gitlab.search` + :attr:`gitlab.v4.objects.Group.search` + :attr:`gitlab.v4.objects.Project.search` * GitLab API: https://docs.gitlab.com/ce/api/search.html Examples -------- Search for issues matching a specific string:: # global search gl.search(gitlab.const.SearchScope.ISSUES, 'regression') # group search group = gl.groups.get('mygroup') group.search(gitlab.const.SearchScope.ISSUES, 'regression') # project search project = gl.projects.get('myproject') project.search(gitlab.const.SearchScope.ISSUES, 'regression') The ``search()`` methods implement the pagination support:: # get lists of 10 items, and start at page 2 gl.search(gitlab.const.SearchScope.ISSUES, search_str, page=2, per_page=10) # get a generator that will automatically make required API calls for # pagination for item in gl.search(gitlab.const.SearchScope.ISSUES, search_str, iterator=True): do_something(item) The search API doesn't return objects, but dicts. If you need to act on objects, you need to create them explicitly:: for item in gl.search(gitlab.const.SearchScope.ISSUES, search_str, iterator=True): issue_project = gl.projects.get(item['project_id'], lazy=True) issue = issue_project.issues.get(item['iid']) issue.state = 'closed' issue.save() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/secure_files.rst0000644000000000000000000000201414366036457021375 0ustar00rootroot############ Secure Files ############ secure files ============ References ---------- * v4 API: + :class:`gitlab.v4.objects.ProjectSecureFile` + :class:`gitlab.v4.objects.ProjectSecureFileManager` + :attr:`gitlab.v4.objects.Project.secure_files` * GitLab API: https://docs.gitlab.com/ee/api/secure_files.html Examples -------- Get a project secure file:: secure_files = gl.projects.get(1, lazy=True).secure_files.get(1) print(secure_files.name) List project secure files:: secure_files = gl.projects.get(1, lazy=True).secure_files.list() print(secure_files[0].name) Create project secure file:: secure_file = gl.projects.get(1).secure_files.create({"name": "test", "file": "secure.txt"}) Download a project secure file:: content = secure_file.download() print(content) with open("/tmp/secure.txt", "wb") as f: secure_file.download(streamed=True, action=f.write) Remove a project secure file:: gl.projects.get(1).secure_files.delete(1) # or secure_file.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/settings.rst0000644000000000000000000000064114366036457020571 0ustar00rootroot######## Settings ######## Reference --------- * v4 API: + :class:`gitlab.v4.objects.ApplicationSettings` + :class:`gitlab.v4.objects.ApplicationSettingsManager` + :attr:`gitlab.Gitlab.settings` * GitLab API: https://docs.gitlab.com/ce/api/settings.html Examples -------- Get the settings:: settings = gl.settings.get() Update the settings:: settings.signin_enabled = False settings.save() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/sidekiq.rst0000644000000000000000000000061114366036457020357 0ustar00rootroot############### Sidekiq metrics ############### Reference --------- * v4 API: + :class:`gitlab.v4.objects.SidekiqManager` + :attr:`gitlab.Gitlab.sidekiq` * GitLab API: https://docs.gitlab.com/ce/api/sidekiq_metrics.html Examples -------- .. code-block:: python gl.sidekiq.queue_metrics() gl.sidekiq.process_metrics() gl.sidekiq.job_stats() gl.sidekiq.compound_metrics() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/snippets.rst0000644000000000000000000000270314366036457020577 0ustar00rootroot######## Snippets ######## Reference ========= * v4 API: + :class:`gitlab.v4.objects.Snippet` + :class:`gitlab.v4.objects.SnipptManager` + :attr:`gitlab.Gitlab.snippets` * GitLab API: https://docs.gitlab.com/ce/api/snippets.html Examples ======== List snippets owned by the current user:: snippets = gl.snippets.list() List the public snippets:: public_snippets = gl.snippets.public() Get a snippet:: snippet = gl.snippets.get(snippet_id) # get the content content = snippet.content() .. warning:: Blobs are entirely stored in memory unless you use the streaming feature. See :ref:`the artifacts example `. Create a snippet:: snippet = gl.snippets.create({'title': 'snippet1', 'file_name': 'snippet1.py', 'content': open('snippet1.py').read()}) Update the snippet attributes:: snippet.visibility_level = gitlab.const.Visibility.PUBLIC snippet.save() To update a snippet code you need to create a ``ProjectSnippet`` object:: snippet = gl.snippets.get(snippet_id) project = gl.projects.get(snippet.projec_id, lazy=True) editable_snippet = project.snippets.get(snippet.id) editable_snippet.code = new_snippet_content editable_snippet.save() Delete a snippet:: gl.snippets.delete(snippet_id) # or snippet.delete() Get user agent detail (admin only):: detail = snippet.user_agent_detail() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/statistics.rst0000644000000000000000000000054514366036457021126 0ustar00rootroot########## Statistics ########## Reference --------- * v4 API: + :class:`gitlab.v4.objects.ApplicationStatistics` + :class:`gitlab.v4.objects.ApplicationStatisticsManager` + :attr:`gitlab.Gitlab.statistics` * GitLab API: https://docs.gitlab.com/ee/api/statistics.html Examples -------- Get the statistics:: statistics = gl.statistics.get() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/system_hooks.rst0000644000000000000000000000112414366036457021455 0ustar00rootroot############ System hooks ############ Reference --------- * v4 API: + :class:`gitlab.v4.objects.Hook` + :class:`gitlab.v4.objects.HookManager` + :attr:`gitlab.Gitlab.hooks` * GitLab API: https://docs.gitlab.com/ce/api/system_hooks.html Examples -------- List the system hooks:: hooks = gl.hooks.list() Create a system hook:: gl.hooks.get(hook_id) Test a system hook. The returned object is not usable (it misses the hook ID):: hook = gl.hooks.create({'url': 'http://your.target.url'}) Delete a system hook:: gl.hooks.delete(hook_id) # or hook.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/templates.rst0000644000000000000000000000401614366036457020727 0ustar00rootroot######### Templates ######### You can request templates for different type of files: * License files * .gitignore files * GitLab CI configuration files * Dockerfiles License templates ================= Reference --------- * v4 API: + :class:`gitlab.v4.objects.License` + :class:`gitlab.v4.objects.LicenseManager` + :attr:`gitlab.Gitlab.licenses` * GitLab API: https://docs.gitlab.com/ce/api/templates/licenses.html Examples -------- List known license templates:: licenses = gl.licenses.list() Generate a license content for a project:: license = gl.licenses.get('apache-2.0', project='foobar', fullname='John Doe') print(license.content) .gitignore templates ==================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Gitignore` + :class:`gitlab.v4.objects.GitignoreManager` + :attr:`gitlab.Gitlab.gitignores` * GitLab API: https://docs.gitlab.com/ce/api/templates/gitignores.html Examples -------- List known gitignore templates:: gitignores = gl.gitignores.list() Get a gitignore template:: gitignore = gl.gitignores.get('Python') print(gitignore.content) GitLab CI templates =================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Gitlabciyml` + :class:`gitlab.v4.objects.GitlabciymlManager` + :attr:`gitlab.Gitlab.gitlabciymls` * GitLab API: https://docs.gitlab.com/ce/api/templates/gitlab_ci_ymls.html Examples -------- List known GitLab CI templates:: gitlabciymls = gl.gitlabciymls.list() Get a GitLab CI template:: gitlabciyml = gl.gitlabciymls.get('Pelican') print(gitlabciyml.content) Dockerfile templates ==================== Reference --------- * v4 API: + :class:`gitlab.v4.objects.Dockerfile` + :class:`gitlab.v4.objects.DockerfileManager` + :attr:`gitlab.Gitlab.gitlabciymls` * GitLab API: Not documented. Examples -------- List known Dockerfile templates:: dockerfiles = gl.dockerfiles.list() Get a Dockerfile template:: dockerfile = gl.dockerfiles.get('Python') print(dockerfile.content) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/todos.rst0000644000000000000000000000151014366036457020055 0ustar00rootroot##### Todos ##### Reference --------- * v4 API: + :class:`~gitlab.objects.Todo` + :class:`~gitlab.objects.TodoManager` + :attr:`gitlab.Gitlab.todos` * GitLab API: https://docs.gitlab.com/ce/api/todos.html Examples -------- List active todos:: todos = gl.todos.list() You can filter the list using the following parameters: * ``action``: can be ``assigned``, ``mentioned``, ``build_failed``, ``marked``, or ``approval_required`` * ``author_id`` * ``project_id`` * ``state``: can be ``pending`` or ``done`` * ``type``: can be ``Issue`` or ``MergeRequest`` For example:: todos = gl.todos.list(project_id=1) todos = gl.todos.list(state='done', type='Issue') Mark a todo as done:: todos = gl.todos.list(project_id=1) todos[0].mark_as_done() Mark all the todos as done:: gl.todos.mark_all_as_done() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/topics.rst0000644000000000000000000000171114366036457020231 0ustar00rootroot######## Topics ######## Topics can be used to categorize projects and find similar new projects. Reference --------- * v4 API: + :class:`gitlab.v4.objects.Topic` + :class:`gitlab.v4.objects.TopicManager` + :attr:`gitlab.Gitlab.topics` * GitLab API: https://docs.gitlab.com/ce/api/topics.html This endpoint requires admin access for creating, updating and deleting objects. Examples -------- List project topics on the GitLab instance:: topics = gl.topics.list() Get a specific topic by its ID:: topic = gl.topics.get(topic_id) Create a new topic:: topic = gl.topics.create({"name": "my-topic", "title": "my title"}) Update a topic:: topic.description = "My new topic" topic.save() # or gl.topics.update(topic_id, {"description": "My new topic"}) Delete a topic:: topic.delete() # or gl.topics.delete(topic_id) Merge a source topic into a target topic:: gl.topics.merge(topic_id, target_topic_id) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/users.rst0000644000000000000000000002237314366036457020100 0ustar00rootroot.. _users_examples: ###################### Users and current user ###################### The Gitlab API exposes user-related method that can be manipulated by admins only. The currently logged-in user is also exposed. Users ===== References ---------- * v4 API: + :class:`gitlab.v4.objects.User` + :class:`gitlab.v4.objects.UserManager` + :attr:`gitlab.Gitlab.users` * GitLab API: + https://docs.gitlab.com/ce/api/users.html + https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user Examples -------- Get the list of users:: users = gl.users.list() Search users whose username match a given string:: users = gl.users.list(search='foo') Get a single user:: # by ID user = gl.users.get(user_id) # by username user = gl.users.list(username='root')[0] Create a user:: user = gl.users.create({'email': 'john@doe.com', 'password': 's3cur3s3cr3T', 'username': 'jdoe', 'name': 'John Doe'}) Update a user:: user.name = 'Real Name' user.save() Delete a user:: gl.users.delete(user_id) # or user.delete() Block/Unblock a user:: user.block() user.unblock() Activate/Deactivate a user:: user.activate() user.deactivate() Ban/Unban a user:: user.ban() user.unban() Follow/Unfollow a user:: user.follow() user.unfollow() Set the avatar image for a user:: # the avatar image can be passed as data (content of the file) or as a file # object opened in binary mode user.avatar = open('path/to/file.png', 'rb') user.save() Set an external identity for a user:: user.provider = 'oauth2_generic' user.extern_uid = '3' user.save() Delete an external identity by provider name:: user.identityproviders.delete('oauth2_generic') Get the followers of a user user.followers_users.list() Get the followings of a user user.following_users.list() List a user's starred projects user.starred_projects.list() If the GitLab instance has new user account approval enabled some users may have ``user.state == 'blocked_pending_approval'``. Administrators can approve and reject such users:: user.approve() user.reject() User custom attributes ====================== References ---------- * v4 API: + :class:`gitlab.v4.objects.UserCustomAttribute` + :class:`gitlab.v4.objects.UserCustomAttributeManager` + :attr:`gitlab.v4.objects.User.customattributes` * GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html Examples -------- List custom attributes for a user:: attrs = user.customattributes.list() Get a custom attribute for a user:: attr = user.customattributes.get(attr_key) Set (create or update) a custom attribute for a user:: attr = user.customattributes.set(attr_key, attr_value) Delete a custom attribute for a user:: attr.delete() # or user.customattributes.delete(attr_key) Search users by custom attribute:: user.customattributes.set('role', 'QA') gl.users.list(custom_attributes={'role': 'QA'}) User impersonation tokens ========================= References ---------- * v4 API: + :class:`gitlab.v4.objects.UserImpersonationToken` + :class:`gitlab.v4.objects.UserImpersonationTokenManager` + :attr:`gitlab.v4.objects.User.impersonationtokens` * GitLab API: https://docs.gitlab.com/ce/api/users.html#get-all-impersonation-tokens-of-a-user List impersonation tokens for a user:: i_t = user.impersonationtokens.list(state='active') i_t = user.impersonationtokens.list(state='inactive') Get an impersonation token for a user:: i_t = user.impersonationtokens.get(i_t_id) Create and use an impersonation token for a user:: i_t = user.impersonationtokens.create({'name': 'token1', 'scopes': ['api']}) # use the token to create a new gitlab connection user_gl = gitlab.Gitlab(gitlab_url, private_token=i_t.token) Revoke (delete) an impersonation token for a user:: i_t.delete() User projects ========================= References ---------- * v4 API: + :class:`gitlab.v4.objects.UserProject` + :class:`gitlab.v4.objects.UserProjectManager` + :attr:`gitlab.v4.objects.User.projects` * GitLab API: https://docs.gitlab.com/ee/api/projects.html#list-user-projects List visible projects in the user's namespace:: projects = user.projects.list() .. note:: Only the projects in the user’s namespace are returned. Projects owned by the user in any group or subgroups are not returned. An empty list is returned if a profile is set to private. User memberships ========================= References ---------- * v4 API: + :class:`gitlab.v4.objects.UserMembership` + :class:`gitlab.v4.objects.UserMembershipManager` + :attr:`gitlab.v4.objects.User.memberships` * GitLab API: https://docs.gitlab.com/ee/api/users.html#user-memberships List direct memberships for a user:: memberships = user.memberships.list() List only direct project memberships:: memberships = user.memberships.list(type='Project') List only direct group memberships:: memberships = user.memberships.list(type='Namespace') .. note:: This endpoint requires admin access. Current User ============ References ---------- * v4 API: + :class:`gitlab.v4.objects.CurrentUser` + :class:`gitlab.v4.objects.CurrentUserManager` + :attr:`gitlab.Gitlab.user` * GitLab API: https://docs.gitlab.com/ce/api/users.html Examples -------- Get the current user:: gl.auth() current_user = gl.user GPG keys ======== References ---------- You can manipulate GPG keys for the current user and for the other users if you are admin. * v4 API: + :class:`gitlab.v4.objects.CurrentUserGPGKey` + :class:`gitlab.v4.objects.CurrentUserGPGKeyManager` + :attr:`gitlab.v4.objects.CurrentUser.gpgkeys` + :class:`gitlab.v4.objects.UserGPGKey` + :class:`gitlab.v4.objects.UserGPGKeyManager` + :attr:`gitlab.v4.objects.User.gpgkeys` * GitLab API: https://docs.gitlab.com/ce/api/users.html#list-all-gpg-keys Examples -------- List GPG keys for a user:: gpgkeys = user.gpgkeys.list() Get a GPG gpgkey for a user:: gpgkey = user.gpgkeys.get(key_id) Create a GPG gpgkey for a user:: # get the key with `gpg --export -a GPG_KEY_ID` k = user.gpgkeys.create({'key': public_key_content}) Delete a GPG gpgkey for a user:: user.gpgkeys.delete(key_id) # or gpgkey.delete() SSH keys ======== References ---------- You can manipulate SSH keys for the current user and for the other users if you are admin. * v4 API: + :class:`gitlab.v4.objects.CurrentUserKey` + :class:`gitlab.v4.objects.CurrentUserKeyManager` + :attr:`gitlab.v4.objects.CurrentUser.keys` + :class:`gitlab.v4.objects.UserKey` + :class:`gitlab.v4.objects.UserKeyManager` + :attr:`gitlab.v4.objects.User.keys` * GitLab API: https://docs.gitlab.com/ce/api/users.html#list-ssh-keys Examples -------- List SSH keys for a user:: keys = user.keys.list() Create an SSH key for a user:: key = user.keys.create({'title': 'my_key', 'key': open('/home/me/.ssh/id_rsa.pub').read()}) Get an SSH key for a user by id:: key = user.keys.get(key_id) Delete an SSH key for a user:: user.keys.delete(key_id) # or key.delete() Status ====== References ---------- You can manipulate the status for the current user and you can read the status of other users. * v4 API: + :class:`gitlab.v4.objects.CurrentUserStatus` + :class:`gitlab.v4.objects.CurrentUserStatusManager` + :attr:`gitlab.v4.objects.CurrentUser.status` + :class:`gitlab.v4.objects.UserStatus` + :class:`gitlab.v4.objects.UserStatusManager` + :attr:`gitlab.v4.objects.User.status` * GitLab API: https://docs.gitlab.com/ce/api/users.html#user-status Examples -------- Get current user status:: status = user.status.get() Update the status for the current user:: status = user.status.get() status.message = "message" status.emoji = "thumbsup" status.save() Get the status of other users:: gl.users.get(1).status.get() Emails ====== References ---------- You can manipulate emails for the current user and for the other users if you are admin. * v4 API: + :class:`gitlab.v4.objects.CurrentUserEmail` + :class:`gitlab.v4.objects.CurrentUserEmailManager` + :attr:`gitlab.v4.objects.CurrentUser.emails` + :class:`gitlab.v4.objects.UserEmail` + :class:`gitlab.v4.objects.UserEmailManager` + :attr:`gitlab.v4.objects.User.emails` * GitLab API: https://docs.gitlab.com/ce/api/users.html#list-emails Examples -------- List emails for a user:: emails = user.emails.list() Get an email for a user:: email = user.emails.get(email_id) Create an email for a user:: k = user.emails.create({'email': 'foo@bar.com'}) Delete an email for a user:: user.emails.delete(email_id) # or email.delete() Users activities ================ References ---------- * admin only * v4 API: + :class:`gitlab.v4.objects.UserActivities` + :class:`gitlab.v4.objects.UserActivitiesManager` + :attr:`gitlab.Gitlab.user_activities` * GitLab API: https://docs.gitlab.com/ce/api/users.html#get-user-activities-admin-only Examples -------- Get the users activities:: activities = gl.user_activities.list( query_parameters={'from': '2018-07-01'}, get_all=True, ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/variables.rst0000644000000000000000000000472114366036457020704 0ustar00rootroot############### CI/CD Variables ############### You can configure variables at the instance-level (admin only), or associate variables to projects and groups, to modify pipeline/job scripts behavior. .. warning:: Please always follow GitLab's `rules for CI/CD variables`_, especially for values in masked variables. If you do not, your variables may silently fail to save. .. _rules for CI/CD variables: https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project Instance-level variables ======================== This endpoint requires admin access. Reference --------- * v4 API + :class:`gitlab.v4.objects.Variable` + :class:`gitlab.v4.objects.VariableManager` + :attr:`gitlab.Gitlab.variables` * GitLab API + https://docs.gitlab.com/ce/api/instance_level_ci_variables.html Examples -------- List all instance variables:: variables = gl.variables.list() Get an instance variable by key:: variable = gl.variables.get('key_name') Create an instance variable:: variable = gl.variables.create({'key': 'key1', 'value': 'value1'}) Update a variable value:: variable.value = 'new_value' variable.save() Remove a variable:: gl.variables.delete('key_name') # or variable.delete() Projects and groups variables ============================= Reference --------- * v4 API + :class:`gitlab.v4.objects.ProjectVariable` + :class:`gitlab.v4.objects.ProjectVariableManager` + :attr:`gitlab.v4.objects.Project.variables` + :class:`gitlab.v4.objects.GroupVariable` + :class:`gitlab.v4.objects.GroupVariableManager` + :attr:`gitlab.v4.objects.Group.variables` * GitLab API + https://docs.gitlab.com/ce/api/instance_level_ci_variables.html + https://docs.gitlab.com/ce/api/project_level_variables.html + https://docs.gitlab.com/ce/api/group_level_variables.html Examples -------- List variables:: p_variables = project.variables.list() g_variables = group.variables.list() Get a variable:: p_var = project.variables.get('key_name') g_var = group.variables.get('key_name') Create a variable:: var = project.variables.create({'key': 'key1', 'value': 'value1'}) var = group.variables.create({'key': 'key1', 'value': 'value1'}) Update a variable value:: var.value = 'new_value' var.save() # or project.variables.update("key1", {"value": "new_value"}) Remove a variable:: project.variables.delete('key_name') group.variables.delete('key_name') # or var.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/gl_objects/wikis.rst0000644000000000000000000000263614366036457020065 0ustar00rootroot########## Wiki pages ########## References ========== * v4 API: + :class:`gitlab.v4.objects.ProjectWiki` + :class:`gitlab.v4.objects.ProjectWikiManager` + :attr:`gitlab.v4.objects.Project.wikis` + :class:`gitlab.v4.objects.GroupWiki` + :class:`gitlab.v4.objects.GroupWikiManager` + :attr:`gitlab.v4.objects.Group.wikis` * GitLab API for Projects: https://docs.gitlab.com/ce/api/wikis.html * GitLab API for Groups: https://docs.gitlab.com/ee/api/group_wikis.html Examples -------- Get the list of wiki pages for a project. These do not contain the contents of the wiki page. You will need to call get(slug) to retrieve the content by accessing the content attribute:: pages = project.wikis.list() Get the list of wiki pages for a group. These do not contain the contents of the wiki page. You will need to call get(slug) to retrieve the content by accessing the content attribute:: pages = group.wikis.list() Get a single wiki page for a project:: page = project.wikis.get(page_slug) Get a single wiki page for a group:: page = group.wikis.get(page_slug) Get the contents of a wiki page:: print(page.content) Create a wiki page on a project level:: page = project.wikis.create({'title': 'Wiki Page 1', 'content': open(a_file).read()}) Update a wiki page:: page.content = 'My new content' page.save() Delete a wiki page:: page.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/index.rst0000644000000000000000000000052114366036457015722 0ustar00rootroot.. include:: ../README.rst .. toctree:: :caption: Table of Contents :hidden: cli-usage api-usage api-usage-advanced cli-examples api-objects api/gitlab cli-objects api-levels changelog release-notes faq Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/make.bat0000644000000000000000000001507314366036457015476 0ustar00rootroot@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-gitlab.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-gitlab.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/docs/release-notes.rst0000644000000000000000000001776614366036457017404 0ustar00rootroot############# Release notes ############# Prior to version 2.0.0 and GitHub Releases, a summary of changes was maintained in release notes. They are available below for historical purposes. For the list of current releases, including breaking changes, please see the changelog. Changes from 1.8 to 1.9 ======================= * ``ProjectMemberManager.all()`` and ``GroupMemberManager.all()`` now return a list of ``ProjectMember`` and ``GroupMember`` objects respectively, instead of a list of dicts. Changes from 1.7 to 1.8 ======================= * You can now use the ``query_parameters`` argument in method calls to define arguments to send to the GitLab server. This allows to avoid conflicts between python-gitlab and GitLab server variables, and allows to use the python reserved keywords as GitLab arguments. The following examples make the same GitLab request with the 2 syntaxes:: projects = gl.projects.list(owned=True, starred=True) projects = gl.projects.list(query_parameters={'owned': True, 'starred': True}) The following example only works with the new parameter:: activities = gl.user_activities.list( query_parameters={'from': '2019-01-01'}, all=True) * Additionally the ``all`` paremeter is not sent to the GitLab anymore. Changes from 1.5 to 1.6 ======================= * When python-gitlab detects HTTP redirections from http to https it will raise a RedirectionError instead of a cryptic error. Make sure to use an ``https://`` protocol in your GitLab URL parameter if the server requires it. Changes from 1.4 to 1.5 ======================= * APIv3 support has been removed. Use the 1.4 release/branch if you need v3 support. * GitLab EE features are now supported: Geo nodes, issue links, LDAP groups, project/group boards, project mirror pulling, project push rules, EE license configuration, epics. * The ``GetFromListMixin`` class has been removed. The ``get()`` method is not available anymore for the following managers: - UserKeyManager - DeployKeyManager - GroupAccessRequestManager - GroupIssueManager - GroupProjectManager - GroupSubgroupManager - IssueManager - ProjectCommitStatusManager - ProjectEnvironmentManager - ProjectLabelManager - ProjectPipelineJobManager - ProjectAccessRequestManager - TodoManager * ``ProjectPipelineJob`` do not heritate from ``ProjectJob`` anymore and thus can only be listed. Changes from 1.3 to 1.4 ======================= * 1.4 is the last release supporting the v3 API, and the related code will be removed in the 1.5 version. If you are using a Gitlab server version that does not support the v4 API you can: * upgrade the server (recommended) * make sure to use version 1.4 of python-gitlab (``pip install python-gitlab==1.4``) See also the `Switching to GitLab API v4 documentation `__. * python-gitlab now handles the server rate limiting feature. It will pause for the required time when reaching the limit (`documentation `__) * The ``GetFromListMixin.get()`` method is deprecated and will be removed in the next python-gitlab version. The goal of this mixin/method is to provide a way to get an object by looping through a list for GitLab objects that don't support the GET method. The method `is broken `__ and conflicts with the GET method now supported by some GitLab objects. You can implement your own method with something like: .. code-block:: python def get_from_list(self, id): for obj in self.list(as_list=False): if obj.get_id() == id: return obj * The ``GroupMemberManager``, ``NamespaceManager`` and ``ProjectBoardManager`` managers now use the GET API from GitLab instead of the ``GetFromListMixin.get()`` method. Changes from 1.2 to 1.3 ======================= * ``gitlab.Gitlab`` objects can be used as context managers in a ``with`` block. Changes from 1.1 to 1.2 ======================= * python-gitlab now respects the ``*_proxy``, ``REQUESTS_CA_BUNDLE`` and ``CURL_CA_BUNDLE`` environment variables (#352) * The following deprecated methods and objects have been removed: * gitlab.v3.object ``Key`` and ``KeyManager`` objects: use ``DeployKey`` and ``DeployKeyManager`` instead * gitlab.v3.objects.Project ``archive_`` and ``unarchive_`` methods * gitlab.Gitlab ``credentials_auth``, ``token_auth``, ``set_url``, ``set_token`` and ``set_credentials`` methods. Once a Gitlab object has been created its URL and authentication information cannot be updated: create a new Gitlab object if you need to use new information * The ``todo()`` method raises a ``GitlabTodoError`` exception on error Changes from 1.0.2 to 1.1 ========================= * The ``ProjectUser`` class doesn't inherit from ``User`` anymore, and the ``GroupProject`` class doesn't inherit from ``Project`` anymore. The Gitlab API doesn't provide the same set of features for these objects, so python-gitlab objects shouldn't try to workaround that. You can create ``User`` or ``Project`` objects from ``ProjectUser`` and ``GroupProject`` objects using the ``id`` attribute: .. code-block:: python for gr_project in group.projects.list(): # lazy object creation avoids a Gitlab API request project = gl.projects.get(gr_project.id, lazy=True) project.default_branch = 'develop' project.save() Changes from 0.21 to 1.0.0 ========================== 1.0.0 brings a stable python-gitlab API for the v4 Gitlab API. v3 is still used by default. v4 is mostly compatible with the v3, but some important changes have been introduced. Make sure to read `Switching to GitLab API v4 `_. The development focus will be v4 from now on. v3 has been deprecated by GitLab and will disappear from python-gitlab at some point. Changes from 0.20 to 0.21 ========================= * Initial support for the v4 API (experimental) The support for v4 is stable enough to be tested, but some features might be broken. Please report issues to https://github.com/python-gitlab/python-gitlab/issues/ Be aware that the python-gitlab API for v4 objects might change in the next releases. .. warning:: Consider defining explicitly which API version you want to use in the configuration files or in your ``gitlab.Gitlab`` instances. The default will change from v3 to v4 soon. * Several methods have been deprecated in the ``gitlab.Gitlab`` class: + ``credentials_auth()`` is deprecated and will be removed. Call ``auth()``. + ``token_auth()`` is deprecated and will be removed. Call ``auth()``. + ``set_url()`` is deprecated, create a new ``Gitlab`` instance if you need an updated URL. + ``set_token()`` is deprecated, use the ``private_token`` argument of the ``Gitlab`` constructor. + ``set_credentials()`` is deprecated, use the ``email`` and ``password`` arguments of the ``Gitlab`` constructor. * The service listing method (``ProjectServiceManager.list()``) now returns a python list instead of a JSON string. Changes from 0.19 to 0.20 ========================= * The ``projects`` attribute of ``Group`` objects is not a list of ``Project`` objects anymore. It is a Manager object giving access to ``GroupProject`` objects. To get the list of projects use: .. code-block:: python group.projects.list() Documentation: http://python-gitlab.readthedocs.io/en/stable/gl_objects/groups.html#examples Related issue: https://github.com/python-gitlab/python-gitlab/issues/209 * The ``Key`` objects are deprecated in favor of the new ``DeployKey`` objects. They are exactly the same but the name makes more sense. Documentation: http://python-gitlab.readthedocs.io/en/stable/gl_objects/deploy_keys.html Related issue: https://github.com/python-gitlab/python-gitlab/issues/212 ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.302791 python-gitlab-3.13.0/gitlab/0000755000000000000000000000000014366036463014372 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/__init__.py0000644000000000000000000000433614366036457016514 0ustar00rootroot# -*- coding: utf-8 -*- # # Copyright (C) 2013-2019 Gauvain Pocentek, 2019-2022 python-gitlab team # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License # along with this program. If not, see . """Wrapper for the GitLab API.""" import warnings from typing import Any import gitlab.config # noqa: F401 from gitlab import utils as _utils from gitlab._version import ( # noqa: F401 __author__, __copyright__, __email__, __license__, __title__, __version__, ) from gitlab.client import Gitlab, GitlabList # noqa: F401 from gitlab.exceptions import * # noqa: F401,F403 warnings.filterwarnings("default", category=DeprecationWarning, module="^gitlab") # NOTE(jlvillal): We are deprecating access to the gitlab.const values which # were previously imported into this namespace by the # 'from gitlab.const import *' statement. def __getattr__(name: str) -> Any: # Deprecate direct access to constants without namespace if name in gitlab.const._DEPRECATED: _utils.warn( message=( f"\nDirect access to constants as 'gitlab.{name}' is deprecated and " f"will be removed in a future major python-gitlab release. Please " f"see the usage of constants in the 'gitlab.const' module instead." ), category=DeprecationWarning, ) return getattr(gitlab.const, name) raise AttributeError(f"module {__name__} has no attribute {name}") __all__ = [ "__author__", "__copyright__", "__email__", "__license__", "__title__", "__version__", "Gitlab", "GitlabList", ] __all__.extend(gitlab.const._DEPRECATED) __all__.extend(gitlab.exceptions.__all__) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/__main__.py0000644000000000000000000000010414366036457016462 0ustar00rootrootimport gitlab.cli if __name__ == "__main__": gitlab.cli.main() ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.302791 python-gitlab-3.13.0/gitlab/_backends/0000755000000000000000000000000014366036463016303 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/_backends/__init__.py0000644000000000000000000000030114366036457020411 0ustar00rootroot""" Defines http backends for processing http requests """ from .requests_backend import RequestsBackend, RequestsResponse DefaultBackend = RequestsBackend DefaultResponse = RequestsResponse ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/_backends/requests_backend.py0000644000000000000000000000732514366036457022211 0ustar00rootrootfrom __future__ import annotations from typing import Any, Dict, Optional, Tuple, TYPE_CHECKING, Union import requests from requests.structures import CaseInsensitiveDict from requests_toolbelt.multipart.encoder import MultipartEncoder # type: ignore class RequestsResponse: def __init__(self, response: requests.Response) -> None: self._response: requests.Response = response @property def response(self) -> requests.Response: return self._response @property def status_code(self) -> int: return self._response.status_code @property def headers(self) -> CaseInsensitiveDict[str]: return self._response.headers @property def content(self) -> bytes: return self._response.content @property def reason(self) -> str: return self._response.reason def json(self) -> Any: return self._response.json() class RequestsBackend: def __init__(self, session: Optional[requests.Session] = None) -> None: self._client: requests.Session = session or requests.Session() @property def client(self) -> requests.Session: return self._client @staticmethod def prepare_send_data( files: Optional[Dict[str, Any]] = None, post_data: Optional[Union[Dict[str, Any], bytes]] = None, raw: bool = False, ) -> Tuple[ Optional[Union[Dict[str, Any], bytes]], Optional[Union[Dict[str, Any], MultipartEncoder]], str, ]: if files: if post_data is None: post_data = {} else: # booleans does not exists for data (neither for MultipartEncoder): # cast to string int to avoid: 'bool' object has no attribute 'encode' if TYPE_CHECKING: assert isinstance(post_data, dict) for k, v in post_data.items(): if isinstance(v, bool): post_data[k] = str(int(v)) post_data["file"] = files.get("file") post_data["avatar"] = files.get("avatar") data = MultipartEncoder(post_data) return (None, data, data.content_type) if raw and post_data: return (None, post_data, "application/octet-stream") return (post_data, None, "application/json") def http_request( self, method: str, url: str, json: Optional[Union[Dict[str, Any], bytes]] = None, data: Optional[Union[Dict[str, Any], MultipartEncoder]] = None, params: Optional[Any] = None, timeout: Optional[float] = None, verify: Optional[Union[bool, str]] = True, stream: Optional[bool] = False, **kwargs: Any, ) -> RequestsResponse: """Make HTTP request Args: method: The HTTP method to call ('get', 'post', 'put', 'delete', etc.) url: The full URL data: The data to send to the server in the body of the request json: Data to send in the body in json by default timeout: The timeout, in seconds, for the request verify: Whether SSL certificates should be validated. If the value is a string, it is the path to a CA file used for certificate validation. stream: Whether the data should be streamed Returns: A requests Response object. """ response: requests.Response = self._client.request( method=method, url=url, params=params, data=data, timeout=timeout, stream=stream, verify=verify, json=json, **kwargs, ) return RequestsResponse(response=response) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/_version.py0000644000000000000000000000037214366036457016575 0ustar00rootroot__author__ = "Gauvain Pocentek, python-gitlab team" __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2022 python-gitlab team" __email__ = "gauvainpocentek@gmail.com" __license__ = "LGPL3" __title__ = "python-gitlab" __version__ = "3.13.0" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/base.py0000644000000000000000000003272414366036457015671 0ustar00rootrootimport copy import importlib import json import pprint import textwrap from types import ModuleType from typing import Any, Dict, Iterable, Optional, Type, TYPE_CHECKING, Union import gitlab from gitlab import types as g_types from gitlab.exceptions import GitlabParsingError from .client import Gitlab, GitlabList __all__ = [ "RESTObject", "RESTObjectList", "RESTManager", ] _URL_ATTRIBUTE_ERROR = ( f"https://python-gitlab.readthedocs.io/en/v{gitlab.__version__}/" f"faq.html#attribute-error-list" ) class RESTObject: """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 the unique ID. ``None`` means that the object can be updated without ID in the url. Likewise, you can define a ``_repr_attr`` in subclasses to specify which attribute should be added as a human-readable identifier when called in the object's ``__repr__()`` method. """ _id_attr: Optional[str] = "id" _attrs: Dict[str, Any] _created_from_list: bool # Indicates if object was created from a list() action _module: ModuleType _parent_attrs: Dict[str, Any] _repr_attr: Optional[str] = None _updated_attrs: Dict[str, Any] _lazy: bool manager: "RESTManager" def __init__( self, manager: "RESTManager", attrs: Dict[str, Any], *, created_from_list: bool = False, lazy: bool = False, ) -> None: if not isinstance(attrs, dict): raise GitlabParsingError( f"Attempted to initialize RESTObject with a non-dictionary value: " f"{attrs!r}\nThis likely indicates an incorrect or malformed server " f"response." ) self.__dict__.update( { "manager": manager, "_attrs": attrs, "_updated_attrs": {}, "_module": importlib.import_module(self.__module__), "_created_from_list": created_from_list, "_lazy": lazy, } ) self.__dict__["_parent_attrs"] = self.manager.parent_attrs self._create_managers() def __getstate__(self) -> Dict[str, Any]: state = self.__dict__.copy() module = state.pop("_module") state["_module_name"] = module.__name__ return state def __setstate__(self, state: Dict[str, Any]) -> None: module_name = state.pop("_module_name") self.__dict__.update(state) self.__dict__["_module"] = importlib.import_module(module_name) def __getattr__(self, name: str) -> Any: if name in self.__dict__["_updated_attrs"]: return self.__dict__["_updated_attrs"][name] if name in self.__dict__["_attrs"]: value = self.__dict__["_attrs"][name] # If the value is a list, we copy it in the _updated_attrs dict # because we are not able to detect changes made on the object # (append, insert, pop, ...). Without forcing the attr # creation __setattr__ is never called, the list never ends up # in the _updated_attrs dict, and the update() and save() # method never push the new data to the server. # See https://github.com/python-gitlab/python-gitlab/issues/306 # # note: _parent_attrs will only store simple values (int) so we # don't make this check in the next block. if isinstance(value, list): self.__dict__["_updated_attrs"][name] = value[:] return self.__dict__["_updated_attrs"][name] return value if name in self.__dict__["_parent_attrs"]: return self.__dict__["_parent_attrs"][name] message = f"{type(self).__name__!r} object has no attribute {name!r}" if self._created_from_list: message = ( f"{message}\n\n" + textwrap.fill( f"{self.__class__!r} was created via a list() call and " f"only a subset of the data may be present. To ensure " f"all data is present get the object using a " f"get(object.id) call. For more details, see:" ) + f"\n\n{_URL_ATTRIBUTE_ERROR}" ) elif self._lazy: message = f"{message}\n\n" + textwrap.fill( f"If you tried to access object attributes returned from the server, " f"note that {self.__class__!r} was created as a `lazy` object and was " f"not initialized with any data." ) raise AttributeError(message) def __setattr__(self, name: str, value: Any) -> None: self.__dict__["_updated_attrs"][name] = value def asdict(self, *, with_parent_attrs: bool = False) -> Dict[str, Any]: data = {} if with_parent_attrs: data.update(copy.deepcopy(self._parent_attrs)) data.update(copy.deepcopy(self._attrs)) data.update(copy.deepcopy(self._updated_attrs)) return data @property def attributes(self) -> Dict[str, Any]: return self.asdict(with_parent_attrs=True) def to_json(self, *, with_parent_attrs: bool = False, **kwargs: Any) -> str: return json.dumps(self.asdict(with_parent_attrs=with_parent_attrs), **kwargs) def __str__(self) -> str: return f"{type(self)} => {self.asdict()}" def pformat(self) -> str: return f"{type(self)} => \n{pprint.pformat(self.asdict())}" def pprint(self) -> None: print(self.pformat()) def __repr__(self) -> str: name = self.__class__.__name__ if (self._id_attr and self._repr_value) and (self._id_attr != self._repr_attr): return ( f"<{name} {self._id_attr}:{self.get_id()} " f"{self._repr_attr}:{self._repr_value}>" ) if self._id_attr: return f"<{name} {self._id_attr}:{self.get_id()}>" if self._repr_value: return f"<{name} {self._repr_attr}:{self._repr_value}>" return f"<{name}>" def __eq__(self, other: object) -> bool: if not isinstance(other, RESTObject): return NotImplemented if self.get_id() and other.get_id(): return self.get_id() == other.get_id() return super() == other def __ne__(self, other: object) -> bool: if not isinstance(other, RESTObject): return NotImplemented if self.get_id() and other.get_id(): return self.get_id() != other.get_id() return super() != other def __dir__(self) -> Iterable[str]: return set(self.attributes).union(super().__dir__()) def __hash__(self) -> int: if not self.get_id(): return super().__hash__() return hash(self.get_id()) def _create_managers(self) -> None: # NOTE(jlvillal): We are creating our managers by looking at the class # annotations. If an attribute is annotated as being a *Manager type # then we create the manager and assign it to the attribute. for attr, annotation in sorted(self.__annotations__.items()): # We ignore creating a manager for the 'manager' attribute as that # is done in the self.__init__() method if attr in ("manager",): continue if not isinstance(annotation, (type, str)): continue if isinstance(annotation, type): cls_name = annotation.__name__ else: cls_name = annotation # All *Manager classes are used except for the base "RESTManager" class if cls_name == "RESTManager" or not cls_name.endswith("Manager"): continue cls = getattr(self._module, cls_name) manager = cls(self.manager.gitlab, parent=self) # Since we have our own __setattr__ method, we can't use setattr() self.__dict__[attr] = manager def _update_attrs(self, new_attrs: Dict[str, Any]) -> None: self.__dict__["_updated_attrs"] = {} self.__dict__["_attrs"] = new_attrs def get_id(self) -> Optional[Union[int, str]]: """Returns the id of the resource.""" if self._id_attr is None or not hasattr(self, self._id_attr): return None id_val = getattr(self, self._id_attr) if TYPE_CHECKING: assert id_val is None or isinstance(id_val, (int, str)) return id_val @property def _repr_value(self) -> Optional[str]: """Safely returns the human-readable resource name if present.""" if self._repr_attr is None or not hasattr(self, self._repr_attr): return None repr_val = getattr(self, self._repr_attr) if TYPE_CHECKING: assert isinstance(repr_val, str) return repr_val @property def encoded_id(self) -> Optional[Union[int, str]]: """Ensure that the ID is url-encoded so that it can be safely used in a URL path""" obj_id = self.get_id() if isinstance(obj_id, str): obj_id = gitlab.utils.EncodedId(obj_id) return obj_id class RESTObjectList: """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() Args: manager: Manager to attach to the created objects obj_cls: Type of objects to create from the json data _list: A GitlabList object """ def __init__( self, manager: "RESTManager", obj_cls: Type[RESTObject], _list: GitlabList ) -> None: """Creates an objects list from a GitlabList. You should not create objects of this type, but use managers list() methods instead. Args: manager: the RESTManager to attach to the objects obj_cls: the class of the created objects _list: the GitlabList holding the data """ self.manager = manager self._obj_cls = obj_cls self._list = _list def __iter__(self) -> "RESTObjectList": return self def __len__(self) -> int: return len(self._list) def __next__(self) -> RESTObject: return self.next() def next(self) -> RESTObject: data = self._list.next() return self._obj_cls(self.manager, data, created_from_list=True) @property def current_page(self) -> int: """The current page number.""" return self._list.current_page @property def prev_page(self) -> Optional[int]: """The previous page number. If None, the current page is the first. """ return self._list.prev_page @property def next_page(self) -> Optional[int]: """The next page number. If None, the current page is the last. """ return self._list.next_page @property def per_page(self) -> Optional[int]: """The number of items per page.""" return self._list.per_page @property def total_pages(self) -> Optional[int]: """The total number of pages.""" return self._list.total_pages @property def total(self) -> Optional[int]: """The total number of items.""" return self._list.total class RESTManager: """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 """ _create_attrs: g_types.RequiredOptional = g_types.RequiredOptional() _update_attrs: g_types.RequiredOptional = g_types.RequiredOptional() _path: Optional[str] = None _obj_cls: Optional[Type[RESTObject]] = None _from_parent_attrs: Dict[str, Any] = {} _types: Dict[str, Type[g_types.GitlabAttribute]] = {} _computed_path: Optional[str] _parent: Optional[RESTObject] _parent_attrs: Dict[str, Any] gitlab: Gitlab def __init__(self, gl: Gitlab, parent: Optional[RESTObject] = None) -> None: """REST manager constructor. Args: gl: :class:`~gitlab.Gitlab` connection to use to make requests. parent: REST object to which the manager is attached. """ self.gitlab = gl self._parent = parent # for nested managers self._computed_path = self._compute_path() @property def parent_attrs(self) -> Optional[Dict[str, Any]]: return self._parent_attrs def _compute_path(self, path: Optional[str] = None) -> Optional[str]: self._parent_attrs = {} if path is None: path = self._path if path is None: return None if self._parent is None or not self._from_parent_attrs: return path data: Dict[str, Optional[gitlab.utils.EncodedId]] = {} for self_attr, parent_attr in self._from_parent_attrs.items(): if not hasattr(self._parent, parent_attr): data[self_attr] = None continue data[self_attr] = gitlab.utils.EncodedId(getattr(self._parent, parent_attr)) self._parent_attrs = data return path.format(**data) @property def path(self) -> Optional[str]: return self._computed_path ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/cli.py0000644000000000000000000002606014366036457015522 0ustar00rootrootimport argparse import functools import os import re import sys from types import ModuleType from typing import ( Any, Callable, cast, Dict, Optional, Tuple, Type, TYPE_CHECKING, TypeVar, Union, ) from requests.structures import CaseInsensitiveDict import gitlab.config from gitlab.base import RESTObject # This regex is based on: # https://github.com/jpvanhal/inflection/blob/master/inflection/__init__.py camel_upperlower_regex = re.compile(r"([A-Z]+)([A-Z][a-z])") camel_lowerupper_regex = re.compile(r"([a-z\d])([A-Z])") # custom_actions = { # cls: { # action: (mandatory_args, optional_args, in_obj), # }, # } custom_actions: Dict[str, Dict[str, Tuple[Tuple[str, ...], Tuple[str, ...], bool]]] = {} # For an explanation of how these type-hints work see: # https://mypy.readthedocs.io/en/stable/generics.html#declaring-decorators # # The goal here is that functions which get decorated will retain their types. __F = TypeVar("__F", bound=Callable[..., Any]) class VerticalHelpFormatter(argparse.HelpFormatter): def format_help(self) -> str: result = super().format_help() output = "" indent = self._indent_increment * " " for line in result.splitlines(keepends=True): # All of our resources are on one line and wrapped inside braces. # For example: {application,resource1,resource2} # We then put each resource on its own line to make it easier to read. if line.strip().startswith("{"): choices = line.strip().strip("{}").split(",") choices_str = f"\n{indent}".join(choices) line = f"{indent}{choices_str}\n" output += line return output def register_custom_action( cls_names: Union[str, Tuple[str, ...]], mandatory: Tuple[str, ...] = (), optional: Tuple[str, ...] = (), custom_action: Optional[str] = None, ) -> Callable[[__F], __F]: def wrap(f: __F) -> __F: @functools.wraps(f) def wrapped_f(*args: Any, **kwargs: Any) -> Any: return f(*args, **kwargs) # in_obj defines whether the method belongs to the obj or the manager in_obj = True if isinstance(cls_names, tuple): classes = cls_names else: classes = (cls_names,) for cls_name in classes: final_name = cls_name if cls_name.endswith("Manager"): final_name = cls_name.replace("Manager", "") in_obj = False if final_name not in custom_actions: custom_actions[final_name] = {} action = custom_action or f.__name__.replace("_", "-") custom_actions[final_name][action] = (mandatory, optional, in_obj) return cast(__F, wrapped_f) return wrap def die(msg: str, e: Optional[Exception] = None) -> None: if e: msg = f"{msg} ({e})" sys.stderr.write(f"{msg}\n") sys.exit(1) def gitlab_resource_to_cls( gitlab_resource: str, namespace: ModuleType ) -> Type[RESTObject]: classes = CaseInsensitiveDict(namespace.__dict__) lowercase_class = gitlab_resource.replace("-", "") class_type = classes[lowercase_class] if TYPE_CHECKING: assert isinstance(class_type, type) assert issubclass(class_type, RESTObject) return class_type def cls_to_gitlab_resource(cls: RESTObject) -> str: dasherized_uppercase = camel_upperlower_regex.sub(r"\1-\2", cls.__name__) dasherized_lowercase = camel_lowerupper_regex.sub(r"\1-\2", dasherized_uppercase) return dasherized_lowercase.lower() def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser: parser = argparse.ArgumentParser( add_help=add_help, description="GitLab API Command Line Interface", formatter_class=VerticalHelpFormatter, allow_abbrev=False, ) parser.add_argument("--version", help="Display the version.", action="store_true") parser.add_argument( "-v", "--verbose", "--fancy", help="Verbose mode (legacy format only) [env var: GITLAB_VERBOSE]", action="store_true", default=os.getenv("GITLAB_VERBOSE"), ) parser.add_argument( "-d", "--debug", help="Debug mode (display HTTP requests) [env var: GITLAB_DEBUG]", action="store_true", default=os.getenv("GITLAB_DEBUG"), ) parser.add_argument( "-c", "--config-file", action="append", help=( "Configuration file to use. Can be used multiple times. " "[env var: PYTHON_GITLAB_CFG]" ), ) parser.add_argument( "-g", "--gitlab", help=( "Which configuration section should " "be used. If not defined, the default selection " "will be used." ), required=False, ) parser.add_argument( "-o", "--output", help="Output format (v4 only): json|legacy|yaml", required=False, choices=["json", "legacy", "yaml"], default="legacy", ) parser.add_argument( "-f", "--fields", help=( "Fields to display in the output (comma " "separated). Not used with legacy output" ), required=False, ) parser.add_argument( "--server-url", help=("GitLab server URL [env var: GITLAB_URL]"), required=False, default=os.getenv("GITLAB_URL"), ) parser.add_argument( "--ssl-verify", help=( "Whether SSL certificates should be validated. [env var: GITLAB_SSL_VERIFY]" ), required=False, default=os.getenv("GITLAB_SSL_VERIFY"), ) parser.add_argument( "--timeout", help=( "Timeout to use for requests to the GitLab server. " "[env var: GITLAB_TIMEOUT]" ), required=False, type=int, default=os.getenv("GITLAB_TIMEOUT"), ) parser.add_argument( "--api-version", help=("GitLab API version [env var: GITLAB_API_VERSION]"), required=False, default=os.getenv("GITLAB_API_VERSION"), ) parser.add_argument( "--per-page", help=( "Number of entries to return per page in the response. " "[env var: GITLAB_PER_PAGE]" ), required=False, type=int, default=os.getenv("GITLAB_PER_PAGE"), ) parser.add_argument( "--pagination", help=( "Whether to use keyset or offset pagination [env var: GITLAB_PAGINATION]" ), required=False, default=os.getenv("GITLAB_PAGINATION"), ) parser.add_argument( "--order-by", help=("Set order_by globally [env var: GITLAB_ORDER_BY]"), required=False, default=os.getenv("GITLAB_ORDER_BY"), ) parser.add_argument( "--user-agent", help=( "The user agent to send to GitLab with the HTTP request. " "[env var: GITLAB_USER_AGENT]" ), required=False, default=os.getenv("GITLAB_USER_AGENT"), ) tokens = parser.add_mutually_exclusive_group() tokens.add_argument( "--private-token", help=("GitLab private access token [env var: GITLAB_PRIVATE_TOKEN]"), required=False, default=os.getenv("GITLAB_PRIVATE_TOKEN"), ) tokens.add_argument( "--oauth-token", help=("GitLab OAuth token [env var: GITLAB_OAUTH_TOKEN]"), required=False, default=os.getenv("GITLAB_OAUTH_TOKEN"), ) tokens.add_argument( "--job-token", help=("GitLab CI job token [env var: CI_JOB_TOKEN]"), required=False, ) return parser def _get_parser() -> argparse.ArgumentParser: # NOTE: We must delay import of gitlab.v4.cli until now or # otherwise it will cause circular import errors from gitlab.v4 import cli as v4_cli parser = _get_base_parser() return v4_cli.extend_parser(parser) def _parse_value(v: Any) -> Any: if isinstance(v, str) and v.startswith("@"): # If the user-provided value starts with @, we try to read the file # path provided after @ as the real value. Exit on any error. try: with open(v[1:], encoding="utf-8") as f: return f.read() except Exception as e: sys.stderr.write(f"{e}\n") sys.exit(1) return v def docs() -> argparse.ArgumentParser: # pragma: no cover """ Provide a statically generated parser for sphinx only, so we don't need to provide dummy gitlab config for readthedocs. """ if "sphinx" not in sys.modules: sys.exit("Docs parser is only intended for build_sphinx") return _get_parser() def main() -> None: if "--version" in sys.argv: print(gitlab.__version__) sys.exit(0) parser = _get_base_parser(add_help=False) # This first parsing step is used to find the gitlab config to use, and # load the propermodule (v3 or v4) accordingly. At that point we don't have # any subparser setup (options, _) = parser.parse_known_args(sys.argv) try: config = gitlab.config.GitlabConfigParser(options.gitlab, options.config_file) except gitlab.config.ConfigError as e: if "--help" in sys.argv or "-h" in sys.argv: parser.print_help() sys.exit(0) sys.exit(e) # We only support v4 API at this time if config.api_version not in ("4",): # dead code # pragma: no cover raise ModuleNotFoundError(f"gitlab.v{config.api_version}.cli") # Now we build the entire set of subcommands and do the complete parsing parser = _get_parser() try: import argcomplete # type: ignore argcomplete.autocomplete(parser) # pragma: no cover except Exception: pass args = parser.parse_args() config_files = args.config_file gitlab_id = args.gitlab verbose = args.verbose output = args.output fields = [] if args.fields: fields = [x.strip() for x in args.fields.split(",")] debug = args.debug gitlab_resource = args.gitlab_resource resource_action = args.resource_action args_dict = vars(args) # Remove CLI behavior-related args for item in ( "gitlab", "config_file", "verbose", "debug", "gitlab_resource", "resource_action", "version", "output", "fields", "server_url", "ssl_verify", "timeout", "api_version", "pagination", "user_agent", "private_token", "oauth_token", "job_token", ): args_dict.pop(item) args_dict = {k: _parse_value(v) for k, v in args_dict.items() if v is not None} try: gl = gitlab.Gitlab.merge_config(vars(options), gitlab_id, config_files) if debug: gl.enable_debug() if gl.private_token or gl.oauth_token: gl.auth() except Exception as e: die(str(e)) gitlab.v4.cli.run( gl, gitlab_resource, resource_action, args_dict, verbose, output, fields ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/client.py0000644000000000000000000013615114366036457016234 0ustar00rootroot"""Wrapper for the GitLab API.""" import os import re import time from typing import Any, cast, Dict, List, Optional, Tuple, Type, TYPE_CHECKING, Union from urllib import parse import requests import gitlab import gitlab.config import gitlab.const import gitlab.exceptions from gitlab import _backends, utils REDIRECT_MSG = ( "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update " "your GitLab URL to the correct URL to avoid issues. The redirection was from: " "{source!r} to {target!r}" ) # https://docs.gitlab.com/ee/api/#offset-based-pagination _PAGINATION_URL = ( f"https://python-gitlab.readthedocs.io/en/v{gitlab.__version__}/" f"api-usage.html#pagination" ) class Gitlab: """Represents a GitLab server connection. Args: url: The URL of the GitLab server (defaults to https://gitlab.com). private_token: The user private token oauth_token: An oauth token job_token: A CI job token ssl_verify: 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: Timeout to use for requests to the GitLab server. http_username: Username for HTTP authentication http_password: Password for HTTP authentication api_version: Gitlab API version to use (support for 4 only) pagination: Can be set to 'keyset' to use keyset pagination order_by: Set order_by globally user_agent: A custom user agent to use for making HTTP requests. retry_transient_errors: Whether to retry after 500, 502, 503, 504 or 52x responses. Defaults to False. keep_base_url: keep user-provided base URL for pagination if it differs from response headers Keyword Args: requests.Session session: HTTP Requests Session RequestsBackend backend: Backend that will be used to make http requests """ def __init__( self, 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", per_page: Optional[int] = None, pagination: Optional[str] = None, order_by: Optional[str] = None, user_agent: str = gitlab.const.USER_AGENT, retry_transient_errors: bool = False, keep_base_url: bool = False, **kwargs: Any, ) -> None: self._api_version = str(api_version) self._server_version: Optional[str] = None self._server_revision: Optional[str] = None self._base_url = self._get_base_url(url) self._url = f"{self._base_url}/api/v{api_version}" #: Timeout to use for requests to gitlab server self.timeout = timeout self.retry_transient_errors = retry_transient_errors self.keep_base_url = keep_base_url #: Headers that will be used in request to GitLab self.headers = {"User-Agent": user_agent} #: Whether SSL certificates should be validated self.ssl_verify = ssl_verify self.private_token = private_token self.http_username = http_username self.http_password = http_password self.oauth_token = oauth_token self.job_token = job_token self._set_auth_info() #: Create a session object for requests _backend: Type[_backends.DefaultBackend] = kwargs.pop( "backend", _backends.DefaultBackend ) self._backend = _backend(**kwargs) self.session = self._backend.client self.per_page = per_page self.pagination = pagination self.order_by = order_by # We only support v4 API at this time if self._api_version not in ("4",): raise ModuleNotFoundError(f"gitlab.v{self._api_version}.objects") # NOTE: We must delay import of gitlab.v4.objects until now or # otherwise it will cause circular import errors from gitlab.v4 import objects self._objects = objects self.user: Optional[objects.CurrentUser] = None self.broadcastmessages = objects.BroadcastMessageManager(self) """See :class:`~gitlab.v4.objects.BroadcastMessageManager`""" self.bulk_imports = objects.BulkImportManager(self) """See :class:`~gitlab.v4.objects.BulkImportManager`""" self.bulk_import_entities = objects.BulkImportAllEntityManager(self) """See :class:`~gitlab.v4.objects.BulkImportAllEntityManager`""" self.ci_lint = objects.CiLintManager(self) """See :class:`~gitlab.v4.objects.CiLintManager`""" self.deploykeys = objects.DeployKeyManager(self) """See :class:`~gitlab.v4.objects.DeployKeyManager`""" self.deploytokens = objects.DeployTokenManager(self) """See :class:`~gitlab.v4.objects.DeployTokenManager`""" self.geonodes = objects.GeoNodeManager(self) """See :class:`~gitlab.v4.objects.GeoNodeManager`""" self.gitlabciymls = objects.GitlabciymlManager(self) """See :class:`~gitlab.v4.objects.GitlabciymlManager`""" self.gitignores = objects.GitignoreManager(self) """See :class:`~gitlab.v4.objects.GitignoreManager`""" self.groups = objects.GroupManager(self) """See :class:`~gitlab.v4.objects.GroupManager`""" self.hooks = objects.HookManager(self) """See :class:`~gitlab.v4.objects.HookManager`""" self.issues = objects.IssueManager(self) """See :class:`~gitlab.v4.objects.IssueManager`""" self.issues_statistics = objects.IssuesStatisticsManager(self) """See :class:`~gitlab.v4.objects.IssuesStatisticsManager`""" self.keys = objects.KeyManager(self) """See :class:`~gitlab.v4.objects.KeyManager`""" self.ldapgroups = objects.LDAPGroupManager(self) """See :class:`~gitlab.v4.objects.LDAPGroupManager`""" self.licenses = objects.LicenseManager(self) """See :class:`~gitlab.v4.objects.LicenseManager`""" self.namespaces = objects.NamespaceManager(self) """See :class:`~gitlab.v4.objects.NamespaceManager`""" self.mergerequests = objects.MergeRequestManager(self) """See :class:`~gitlab.v4.objects.MergeRequestManager`""" self.notificationsettings = objects.NotificationSettingsManager(self) """See :class:`~gitlab.v4.objects.NotificationSettingsManager`""" self.projects = objects.ProjectManager(self) """See :class:`~gitlab.v4.objects.ProjectManager`""" self.registry_repositories = objects.RegistryRepositoryManager(self) """See :class:`~gitlab.v4.objects.RegistryRepositoryManager`""" self.runners = objects.RunnerManager(self) """See :class:`~gitlab.v4.objects.RunnerManager`""" self.runners_all = objects.RunnerAllManager(self) """See :class:`~gitlab.v4.objects.RunnerManager`""" self.settings = objects.ApplicationSettingsManager(self) """See :class:`~gitlab.v4.objects.ApplicationSettingsManager`""" self.appearance = objects.ApplicationAppearanceManager(self) """See :class:`~gitlab.v4.objects.ApplicationAppearanceManager`""" self.sidekiq = objects.SidekiqManager(self) """See :class:`~gitlab.v4.objects.SidekiqManager`""" self.snippets = objects.SnippetManager(self) """See :class:`~gitlab.v4.objects.SnippetManager`""" self.users = objects.UserManager(self) """See :class:`~gitlab.v4.objects.UserManager`""" self.todos = objects.TodoManager(self) """See :class:`~gitlab.v4.objects.TodoManager`""" self.dockerfiles = objects.DockerfileManager(self) """See :class:`~gitlab.v4.objects.DockerfileManager`""" self.events = objects.EventManager(self) """See :class:`~gitlab.v4.objects.EventManager`""" self.audit_events = objects.AuditEventManager(self) """See :class:`~gitlab.v4.objects.AuditEventManager`""" self.features = objects.FeatureManager(self) """See :class:`~gitlab.v4.objects.FeatureManager`""" self.pagesdomains = objects.PagesDomainManager(self) """See :class:`~gitlab.v4.objects.PagesDomainManager`""" self.user_activities = objects.UserActivitiesManager(self) """See :class:`~gitlab.v4.objects.UserActivitiesManager`""" self.applications = objects.ApplicationManager(self) """See :class:`~gitlab.v4.objects.ApplicationManager`""" self.variables = objects.VariableManager(self) """See :class:`~gitlab.v4.objects.VariableManager`""" self.personal_access_tokens = objects.PersonalAccessTokenManager(self) """See :class:`~gitlab.v4.objects.PersonalAccessTokenManager`""" self.topics = objects.TopicManager(self) """See :class:`~gitlab.v4.objects.TopicManager`""" self.statistics = objects.ApplicationStatisticsManager(self) """See :class:`~gitlab.v4.objects.ApplicationStatisticsManager`""" def __enter__(self) -> "Gitlab": return self def __exit__(self, *args: Any) -> None: self.session.close() def __getstate__(self) -> Dict[str, Any]: state = self.__dict__.copy() state.pop("_objects") return state def __setstate__(self, state: Dict[str, Any]) -> None: self.__dict__.update(state) # We only support v4 API at this time if self._api_version not in ("4",): raise ModuleNotFoundError( f"gitlab.v{self._api_version}.objects" ) # pragma: no cover, dead code currently # NOTE: We must delay import of gitlab.v4.objects until now or # otherwise it will cause circular import errors from gitlab.v4 import objects self._objects = objects @property def url(self) -> str: """The user-provided server URL.""" return self._base_url @property def api_url(self) -> str: """The computed API base URL.""" return self._url @property def api_version(self) -> str: """The API version used (4 only).""" return self._api_version @classmethod def from_config( cls, gitlab_id: Optional[str] = None, config_files: Optional[List[str]] = None, **kwargs: Any, ) -> "Gitlab": """Create a Gitlab connection from configuration files. Args: gitlab_id: ID of the configuration section. config_files list[str]: List of paths to configuration files. kwargs: session requests.Session: Custom requests Session Returns: A Gitlab connection. Raises: gitlab.config.GitlabDataError: If the configuration is not correct. """ config = gitlab.config.GitlabConfigParser( gitlab_id=gitlab_id, config_files=config_files ) return cls( config.url, private_token=config.private_token, oauth_token=config.oauth_token, job_token=config.job_token, ssl_verify=config.ssl_verify, timeout=config.timeout, http_username=config.http_username, http_password=config.http_password, api_version=config.api_version, per_page=config.per_page, pagination=config.pagination, order_by=config.order_by, user_agent=config.user_agent, retry_transient_errors=config.retry_transient_errors, **kwargs, ) @classmethod def merge_config( cls, options: Dict[str, Any], gitlab_id: Optional[str] = None, config_files: Optional[List[str]] = None, ) -> "Gitlab": """Create a Gitlab connection by merging configuration with the following precedence: 1. Explicitly provided CLI arguments, 2. Environment variables, 3. Configuration files: a. explicitly defined config files: i. via the `--config-file` CLI argument, ii. via the `PYTHON_GITLAB_CFG` environment variable, b. user-specific config file, c. system-level config file, 4. Environment variables always present in CI (CI_SERVER_URL, CI_JOB_TOKEN). Args: options: A dictionary of explicitly provided key-value options. gitlab_id: ID of the configuration section. config_files: List of paths to configuration files. Returns: (gitlab.Gitlab): A Gitlab connection. Raises: gitlab.config.GitlabDataError: If the configuration is not correct. """ config = gitlab.config.GitlabConfigParser( gitlab_id=gitlab_id, config_files=config_files ) url = ( options.get("server_url") or config.url or os.getenv("CI_SERVER_URL") or gitlab.const.DEFAULT_URL ) private_token, oauth_token, job_token = cls._merge_auth(options, config) return cls( url=url, private_token=private_token, oauth_token=oauth_token, job_token=job_token, ssl_verify=options.get("ssl_verify") or config.ssl_verify, timeout=options.get("timeout") or config.timeout, api_version=options.get("api_version") or config.api_version, per_page=options.get("per_page") or config.per_page, pagination=options.get("pagination") or config.pagination, order_by=options.get("order_by") or config.order_by, user_agent=options.get("user_agent") or config.user_agent, ) @staticmethod def _merge_auth( options: Dict[str, Any], config: gitlab.config.GitlabConfigParser ) -> Tuple[Optional[str], Optional[str], Optional[str]]: """ Return a tuple where at most one of 3 token types ever has a value. Since multiple types of tokens may be present in the environment, options, or config files, this precedence ensures we don't inadvertently cause errors when initializing the client. This is especially relevant when executed in CI where user and CI-provided values are both available. """ private_token = options.get("private_token") or config.private_token oauth_token = options.get("oauth_token") or config.oauth_token job_token = ( options.get("job_token") or config.job_token or os.getenv("CI_JOB_TOKEN") ) if private_token: return (private_token, None, None) if oauth_token: return (None, oauth_token, None) if job_token: return (None, None, job_token) return (None, None, None) def auth(self) -> None: """Performs an authentication using private token. Warns the user if a potentially misconfigured URL is detected on the client or server side. The `user` attribute will hold a `gitlab.objects.CurrentUser` object on success. """ self.user = self._objects.CurrentUserManager(self).get() if hasattr(self.user, "web_url") and hasattr(self.user, "username"): self._check_url(self.user.web_url, path=self.user.username) def version(self) -> 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. """ if self._server_version is None: try: data = self.http_get("/version") if isinstance(data, dict): self._server_version = data["version"] self._server_revision = data["revision"] else: self._server_version = "unknown" self._server_revision = "unknown" except Exception: self._server_version = "unknown" self._server_revision = "unknown" return cast(str, self._server_version), cast(str, self._server_revision) @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabVerifyError) def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]: """Validate a gitlab CI configuration. Args: content: 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 """ utils.warn( "`lint()` is deprecated and will be removed in a future version.\n" "Please use `ci_lint.create()` instead.", category=DeprecationWarning, ) post_data = {"content": content} data = self.http_post("/ci/lint", post_data=post_data, **kwargs) if TYPE_CHECKING: assert not isinstance(data, requests.Response) return (data["status"] == "valid", data["errors"]) @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabMarkdownError) def markdown( self, text: str, gfm: bool = False, project: Optional[str] = None, **kwargs: Any ) -> str: """Render an arbitrary Markdown document. Args: text: The markdown text to render gfm: Render text using GitLab Flavored Markdown. Default is False project: Full path of a project used a context when `gfm` is True **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. """ post_data = {"text": text, "gfm": gfm} if project is not None: post_data["project"] = project data = self.http_post("/markdown", post_data=post_data, **kwargs) if TYPE_CHECKING: assert not isinstance(data, requests.Response) assert isinstance(data["html"], str) return data["html"] @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError) def get_license(self, **kwargs: Any) -> Dict[str, Union[str, Dict[str, str]]]: """Retrieve information about the current license. Args: **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 """ result = self.http_get("/license", **kwargs) if isinstance(result, dict): return result return {} @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError) def set_license(self, license: str, **kwargs: Any) -> Dict[str, Any]: """Add a new license. Args: license: 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 """ data = {"license": license} result = self.http_post("/license", post_data=data, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result def _set_auth_info(self) -> None: tokens = [ token for token in [self.private_token, self.oauth_token, self.job_token] if token ] if len(tokens) > 1: raise ValueError( "Only one of private_token, oauth_token or job_token should " "be defined" ) if (self.http_username and not self.http_password) or ( not self.http_username and self.http_password ): raise ValueError("Both http_username and http_password should be defined") if self.oauth_token and self.http_username: raise ValueError( "Only one of oauth authentication or http " "authentication should be defined" ) self._http_auth = None if self.private_token: self.headers.pop("Authorization", None) self.headers["PRIVATE-TOKEN"] = self.private_token self.headers.pop("JOB-TOKEN", None) if self.oauth_token: self.headers["Authorization"] = f"Bearer {self.oauth_token}" self.headers.pop("PRIVATE-TOKEN", None) self.headers.pop("JOB-TOKEN", None) if self.job_token: self.headers.pop("Authorization", None) self.headers.pop("PRIVATE-TOKEN", None) self.headers["JOB-TOKEN"] = self.job_token if self.http_username: self._http_auth = requests.auth.HTTPBasicAuth( self.http_username, self.http_password ) @staticmethod def enable_debug() -> None: import logging from http.client import HTTPConnection # noqa HTTPConnection.debuglevel = 1 logging.basicConfig() logging.getLogger().setLevel(logging.DEBUG) requests_log = logging.getLogger("requests.packages.urllib3") requests_log.setLevel(logging.DEBUG) requests_log.propagate = True def _get_session_opts(self) -> Dict[str, Any]: return { "headers": self.headers.copy(), "auth": self._http_auth, "timeout": self.timeout, "verify": self.ssl_verify, } @staticmethod def _get_base_url(url: Optional[str] = None) -> str: """Return the base URL with the trailing slash stripped. If the URL is a Falsy value, return the default URL. Returns: The base URL """ if not url: return gitlab.const.DEFAULT_URL return url.rstrip("/") def _build_url(self, path: str) -> str: """Returns the full url from path. If path is already a url, return it unchanged. If it's a path, append it to the stored url. Returns: The full URL """ if path.startswith("http://") or path.startswith("https://"): return path return f"{self._url}{path}" def _check_url(self, url: Optional[str], *, path: str = "api") -> Optional[str]: """ Checks if ``url`` starts with a different base URL from the user-provided base URL and warns the user before returning it. If ``keep_base_url`` is set to ``True``, instead returns the URL massaged to match the user-provided base URL. """ if not url or url.startswith(self.url): return url match = re.match(rf"(^.*?)/{path}", url) if not match: return url base_url = match.group(1) if self.keep_base_url: return url.replace(base_url, f"{self._base_url}") utils.warn( message=( f"The base URL in the server response differs from the user-provided " f"base URL ({self.url} -> {base_url}).\nThis is usually caused by a " f"misconfigured base URL on your side or a misconfigured external_url " f"on the server side, and can lead to broken pagination and unexpected " f"behavior. If this is intentional, use `keep_base_url=True` when " f"initializing the Gitlab instance to keep the user-provided base URL." ), category=UserWarning, ) return url @staticmethod def _check_redirects(result: requests.Response) -> None: # Check the requests history to detect 301/302 redirections. # If the initial verb is POST or PUT, the redirected request will use a # GET request, leading to unwanted behaviour. # If we detect a redirection with a POST or a PUT request, we # raise an exception with a useful error message. if not result.history: return for item in result.history: if item.status_code not in (301, 302): continue # GET methods can be redirected without issue if item.request.method == "GET": continue target = item.headers.get("location") raise gitlab.exceptions.RedirectError( REDIRECT_MSG.format( status_code=item.status_code, reason=item.reason, source=item.url, target=target, ) ) def http_request( self, 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, retry_transient_errors: Optional[bool] = None, max_retries: int = 10, **kwargs: Any, ) -> requests.Response: """Make an HTTP request to the Gitlab server. Args: verb: The HTTP method to call ('get', 'post', 'put', 'delete') path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data: Data to send as query parameters post_data: Data to send in the body (will be converted to json by default) raw: If True, do not convert post_data to json streamed: Whether the data should be streamed files: The files to send to the server timeout: The timeout, in seconds, for the request obey_rate_limit: Whether to obey 429 Too Many Request responses. Defaults to True. retry_transient_errors: Whether to retry after 500, 502, 503, 504 or 52x responses. Defaults to False. max_retries: 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 """ query_data = query_data or {} raw_url = self._build_url(path) # parse user-provided URL params to ensure we don't add our own duplicates parsed = parse.urlparse(raw_url) params = parse.parse_qs(parsed.query) utils.copy_dict(src=query_data, dest=params) url = parse.urlunparse(parsed._replace(query="")) # Deal with kwargs: by default a user uses kwargs to send data to the # gitlab server, but this generates problems (python keyword conflicts # and python-gitlab/gitlab conflicts). # So we provide a `query_parameters` key: if it's there we use its dict # value as arguments for the gitlab server, and ignore the other # arguments, except pagination ones (per_page and page) if "query_parameters" in kwargs: utils.copy_dict(src=kwargs["query_parameters"], dest=params) for arg in ("per_page", "page"): if arg in kwargs: params[arg] = kwargs[arg] else: utils.copy_dict(src=kwargs, dest=params) opts = self._get_session_opts() verify = opts.pop("verify") opts_timeout = opts.pop("timeout") # If timeout was passed into kwargs, allow it to override the default if timeout is None: timeout = opts_timeout if retry_transient_errors is None: retry_transient_errors = self.retry_transient_errors # We need to deal with json vs. data when uploading files json, data, content_type = self._backend.prepare_send_data( files, post_data, raw ) opts["headers"]["Content-type"] = content_type cur_retries = 0 while True: try: result = self._backend.http_request( method=verb, url=url, json=json, data=data, params=params, timeout=timeout, verify=verify, stream=streamed, **opts, ) except (requests.ConnectionError, requests.exceptions.ChunkedEncodingError): if retry_transient_errors and ( max_retries == -1 or cur_retries < max_retries ): wait_time = 2**cur_retries * 0.1 cur_retries += 1 time.sleep(wait_time) continue raise self._check_redirects(result.response) if 200 <= result.status_code < 300: return result.response def should_retry() -> bool: if result.status_code == 429 and obey_rate_limit: return True if not retry_transient_errors: return False if result.status_code in gitlab.const.RETRYABLE_TRANSIENT_ERROR_CODES: return True if result.status_code == 409 and "Resource lock" in result.reason: return True return False if should_retry(): # Response headers documentation: # https://docs.gitlab.com/ee/user/admin_area/settings/user_and_ip_rate_limits.html#response-headers if max_retries == -1 or cur_retries < max_retries: wait_time = 2**cur_retries * 0.1 if "Retry-After" in result.headers: wait_time = int(result.headers["Retry-After"]) elif "RateLimit-Reset" in result.headers: wait_time = int(result.headers["RateLimit-Reset"]) - time.time() cur_retries += 1 time.sleep(wait_time) continue error_message = result.content try: error_json = result.json() for k in ("message", "error"): if k in error_json: error_message = error_json[k] except (KeyError, ValueError, TypeError): pass if result.status_code == 401: raise gitlab.exceptions.GitlabAuthenticationError( response_code=result.status_code, error_message=error_message, response_body=result.content, ) raise gitlab.exceptions.GitlabHttpError( response_code=result.status_code, error_message=error_message, response_body=result.content, ) def http_get( self, path: str, query_data: Optional[Dict[str, Any]] = None, streamed: bool = False, raw: bool = False, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Make a GET request to the Gitlab server. Args: path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data: Data to send as query parameters streamed: Whether the data should be streamed raw: 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 is not json. The parsed json data otherwise. Raises: GitlabHttpError: When the return code is not 2xx GitlabParsingError: If the json data could not be parsed """ query_data = query_data or {} result = self.http_request( "get", path, query_data=query_data, streamed=streamed, **kwargs ) if ( result.headers["Content-Type"] == "application/json" and not streamed and not raw ): try: json_result = result.json() if TYPE_CHECKING: assert isinstance(json_result, dict) return json_result except Exception as e: raise gitlab.exceptions.GitlabParsingError( error_message="Failed to parse the server message" ) from e else: return result def http_head( self, path: str, query_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> "requests.structures.CaseInsensitiveDict[Any]": """Make a HEAD request to the Gitlab server. Args: path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data: Data to send as query parameters **kwargs: 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 """ query_data = query_data or {} result = self.http_request("head", path, query_data=query_data, **kwargs) return result.headers def http_list( self, path: str, query_data: Optional[Dict[str, Any]] = None, *, as_list: Optional[bool] = None, # Deprecated in favor of `iterator` iterator: Optional[bool] = None, **kwargs: Any, ) -> Union["GitlabList", List[Dict[str, Any]]]: """Make a GET request to the Gitlab server for list-oriented queries. Args: path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projects') query_data: Data to send as query parameters iterator: Indicate if should return a generator (True) **kwargs: Extra options to send to the server (e.g. sudo, page, per_page) Returns: A list of the objects returned by the server. If `iterator` is True and no pagination-related arguments (`page`, `per_page`, `get_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: GitlabHttpError: When the return code is not 2xx GitlabParsingError: If the json data could not be parsed """ query_data = query_data or {} # Don't allow both `as_list` and `iterator` to be set. if as_list is not None and iterator is not None: raise ValueError( "Only one of `as_list` or `iterator` can be used. " "Use `iterator` instead of `as_list`. `as_list` is deprecated." ) if as_list is not None: iterator = not as_list utils.warn( message=( f"`as_list={as_list}` is deprecated and will be removed in a " f"future version. Use `iterator={iterator}` instead." ), category=DeprecationWarning, ) # Provide a `get_all`` param to avoid clashes with `all` API attributes. get_all = kwargs.pop("get_all", None) if get_all is None: # For now, keep `all` without deprecation. get_all = kwargs.pop("all", None) url = self._build_url(path) page = kwargs.get("page") if iterator and page is not None: arg_used_message = f"iterator={iterator}" if as_list is not None: arg_used_message = f"as_list={as_list}" utils.warn( message=( f"`{arg_used_message}` and `page={page}` were both specified. " f"`{arg_used_message}` will be ignored and a `list` will be " f"returned." ), category=UserWarning, ) if iterator and page is None: # Generator requested return GitlabList(self, url, query_data, **kwargs) if get_all is True: return list(GitlabList(self, url, query_data, **kwargs)) # pagination requested, we return a list gl_list = GitlabList(self, url, query_data, get_next=False, **kwargs) items = list(gl_list) def should_emit_warning() -> bool: # No warning is emitted if any of the following conditions apply: # * `get_all=False` was set in the `list()` call. # * `page` was set in the `list()` call. # * GitLab did not return the `x-per-page` header. # * Number of items received is less than per-page value. # * Number of items received is >= total available. if get_all is False: return False if page is not None: return False if gl_list.per_page is None: return False if len(items) < gl_list.per_page: return False if gl_list.total is not None and len(items) >= gl_list.total: return False return True if not should_emit_warning(): return items # Warn the user that they are only going to retrieve `per_page` # maximum items. This is a common cause of issues filed. total_items = "many" if gl_list.total is None else gl_list.total utils.warn( message=( f"Calling a `list()` method without specifying `get_all=True` or " f"`iterator=True` will return a maximum of {gl_list.per_page} items. " f"Your query returned {len(items)} of {total_items} items. See " f"{_PAGINATION_URL} for more details. If this was done intentionally, " f"then this warning can be supressed by adding the argument " f"`get_all=False` to the `list()` call." ), category=UserWarning, ) return items def http_post( self, 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.Response]: """Make a POST request to the Gitlab server. Args: path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data: Data to send as query parameters post_data: Data to send in the body (will be converted to json by default) raw: If True, do not convert post_data to json files: 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 the raw content Raises: GitlabHttpError: When the return code is not 2xx GitlabParsingError: If the json data could not be parsed """ query_data = query_data or {} post_data = post_data or {} result = self.http_request( "post", path, query_data=query_data, post_data=post_data, files=files, raw=raw, **kwargs, ) try: if result.headers.get("Content-Type", None) == "application/json": json_result = result.json() if TYPE_CHECKING: assert isinstance(json_result, dict) return json_result except Exception as e: raise gitlab.exceptions.GitlabParsingError( error_message="Failed to parse the server message" ) from e return result def http_put( self, 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.Response]: """Make a PUT request to the Gitlab server. Args: path: Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data: Data to send as query parameters post_data: Data to send in the body (will be converted to json by default) raw: If True, do not convert post_data to json files: 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 """ query_data = query_data or {} post_data = post_data or {} result = self.http_request( "put", path, query_data=query_data, post_data=post_data, files=files, raw=raw, **kwargs, ) try: json_result = result.json() if TYPE_CHECKING: assert isinstance(json_result, dict) return json_result except Exception as e: raise gitlab.exceptions.GitlabParsingError( error_message="Failed to parse the server message" ) from e def http_delete(self, path: str, **kwargs: Any) -> requests.Response: """Make a DELETE request to the Gitlab server. Args: path: 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 """ return self.http_request("delete", path, **kwargs) @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabSearchError) def search( self, scope: str, search: str, **kwargs: Any ) -> Union["GitlabList", List[Dict[str, Any]]]: """Search GitLab resources matching the provided string.' Args: scope: Scope of the search search: 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. """ data = {"scope": scope, "search": search} return self.http_list("/search", query_data=data, **kwargs) class GitlabList: """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. """ def __init__( self, gl: Gitlab, url: str, query_data: Dict[str, Any], get_next: bool = True, **kwargs: Any, ) -> None: self._gl = gl # Preserve kwargs for subsequent queries self._kwargs = kwargs.copy() self._query(url, query_data, **self._kwargs) self._get_next = get_next # Remove query_parameters from kwargs, which are saved via the `next` URL self._kwargs.pop("query_parameters", None) def _query( self, url: str, query_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> None: query_data = query_data or {} result = self._gl.http_request("get", url, query_data=query_data, **kwargs) try: next_url = result.links["next"]["url"] except KeyError: next_url = None self._next_url = self._gl._check_url(next_url) self._current_page: Optional[str] = result.headers.get("X-Page") self._prev_page: Optional[str] = result.headers.get("X-Prev-Page") self._next_page: Optional[str] = result.headers.get("X-Next-Page") self._per_page: Optional[str] = result.headers.get("X-Per-Page") self._total_pages: Optional[str] = result.headers.get("X-Total-Pages") self._total: Optional[str] = result.headers.get("X-Total") try: self._data: List[Dict[str, Any]] = result.json() except Exception as e: raise gitlab.exceptions.GitlabParsingError( error_message="Failed to parse the server message" ) from e self._current = 0 @property def current_page(self) -> int: """The current page number.""" if TYPE_CHECKING: assert self._current_page is not None return int(self._current_page) @property def prev_page(self) -> Optional[int]: """The previous page number. If None, the current page is the first. """ return int(self._prev_page) if self._prev_page else None @property def next_page(self) -> Optional[int]: """The next page number. If None, the current page is the last. """ return int(self._next_page) if self._next_page else None @property def per_page(self) -> Optional[int]: """The number of items per page.""" return int(self._per_page) if self._per_page is not None else None # NOTE(jlvillal): When a query returns more than 10,000 items, GitLab doesn't return # the headers 'x-total-pages' and 'x-total'. In those cases we return None. # https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers @property def total_pages(self) -> Optional[int]: """The total number of pages.""" if self._total_pages is not None: return int(self._total_pages) return None @property def total(self) -> Optional[int]: """The total number of items.""" if self._total is not None: return int(self._total) return None def __iter__(self) -> "GitlabList": return self def __len__(self) -> int: if self._total is None: return 0 return int(self._total) def __next__(self) -> Dict[str, Any]: return self.next() def next(self) -> Dict[str, Any]: try: item = self._data[self._current] self._current += 1 return item except IndexError: pass if self._next_url and self._get_next is True: self._query(self._next_url, **self._kwargs) return self.next() raise StopIteration ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/config.py0000644000000000000000000002160014366036457016213 0ustar00rootrootimport configparser import os import shlex import subprocess from os.path import expanduser, expandvars from pathlib import Path from typing import List, Optional, Union from gitlab.const import USER_AGENT _DEFAULT_FILES: List[str] = [ "/etc/python-gitlab.cfg", str(Path.home() / ".python-gitlab.cfg"), ] HELPER_PREFIX = "helper:" HELPER_ATTRIBUTES = ["job_token", "http_password", "private_token", "oauth_token"] _CONFIG_PARSER_ERRORS = (configparser.NoOptionError, configparser.NoSectionError) def _resolve_file(filepath: Union[Path, str]) -> str: resolved = Path(filepath).resolve(strict=True) return str(resolved) def _get_config_files( config_files: Optional[List[str]] = None, ) -> Union[str, List[str]]: """ Return resolved path(s) to config files if they exist, with precedence: 1. Files passed in config_files 2. File defined in PYTHON_GITLAB_CFG 3. User- and system-wide config files """ resolved_files = [] if config_files: for config_file in config_files: try: resolved = _resolve_file(config_file) except OSError as e: raise GitlabConfigMissingError( f"Cannot read config from file: {e}" ) from e resolved_files.append(resolved) return resolved_files try: env_config = os.environ["PYTHON_GITLAB_CFG"] return _resolve_file(env_config) except KeyError: pass except OSError as e: raise GitlabConfigMissingError( f"Cannot read config from PYTHON_GITLAB_CFG: {e}" ) from e for config_file in _DEFAULT_FILES: try: resolved = _resolve_file(config_file) except OSError: continue resolved_files.append(resolved) return resolved_files class ConfigError(Exception): pass class GitlabIDError(ConfigError): pass class GitlabDataError(ConfigError): pass class GitlabConfigMissingError(ConfigError): pass class GitlabConfigHelperError(ConfigError): pass class GitlabConfigParser: def __init__( self, gitlab_id: Optional[str] = None, config_files: Optional[List[str]] = None ) -> None: self.gitlab_id = gitlab_id self.http_username: Optional[str] = None self.http_password: Optional[str] = None self.job_token: Optional[str] = None self.oauth_token: Optional[str] = None self.private_token: Optional[str] = None self.api_version: str = "4" self.order_by: Optional[str] = None self.pagination: Optional[str] = None self.per_page: Optional[int] = None self.retry_transient_errors: bool = False self.ssl_verify: Union[bool, str] = True self.timeout: int = 60 self.url: Optional[str] = None self.user_agent: str = USER_AGENT self.keep_base_url: bool = False self._files = _get_config_files(config_files) if self._files: self._parse_config() if self.gitlab_id and not self._files: raise GitlabConfigMissingError( f"A gitlab id was provided ({self.gitlab_id}) but no config file found" ) def _parse_config(self) -> None: _config = configparser.ConfigParser() _config.read(self._files, encoding="utf-8") if self.gitlab_id and not _config.has_section(self.gitlab_id): raise GitlabDataError( f"A gitlab id was provided ({self.gitlab_id}) " "but no config section found" ) if self.gitlab_id is None: try: self.gitlab_id = _config.get("global", "default") except Exception as e: raise GitlabIDError( "Impossible to get the gitlab id (not specified in config file)" ) from e try: self.url = _config.get(self.gitlab_id, "url") except Exception as e: raise GitlabDataError( "Impossible to get gitlab details from " f"configuration ({self.gitlab_id})" ) from e try: self.ssl_verify = _config.getboolean("global", "ssl_verify") except ValueError: # Value Error means the option exists but isn't a boolean. # Get as a string instead as it should then be a local path to a # CA bundle. self.ssl_verify = _config.get("global", "ssl_verify") except _CONFIG_PARSER_ERRORS: pass try: self.ssl_verify = _config.getboolean(self.gitlab_id, "ssl_verify") except ValueError: # Value Error means the option exists but isn't a boolean. # Get as a string instead as it should then be a local path to a # CA bundle. self.ssl_verify = _config.get(self.gitlab_id, "ssl_verify") except _CONFIG_PARSER_ERRORS: pass try: self.timeout = _config.getint("global", "timeout") except _CONFIG_PARSER_ERRORS: pass try: self.timeout = _config.getint(self.gitlab_id, "timeout") except _CONFIG_PARSER_ERRORS: pass try: self.private_token = _config.get(self.gitlab_id, "private_token") except _CONFIG_PARSER_ERRORS: pass try: self.oauth_token = _config.get(self.gitlab_id, "oauth_token") except _CONFIG_PARSER_ERRORS: pass try: self.job_token = _config.get(self.gitlab_id, "job_token") except _CONFIG_PARSER_ERRORS: pass try: self.http_username = _config.get(self.gitlab_id, "http_username") self.http_password = _config.get( self.gitlab_id, "http_password" ) # pragma: no cover except _CONFIG_PARSER_ERRORS: pass self._get_values_from_helper() try: self.api_version = _config.get("global", "api_version") except _CONFIG_PARSER_ERRORS: pass try: self.api_version = _config.get(self.gitlab_id, "api_version") except _CONFIG_PARSER_ERRORS: pass if self.api_version not in ("4",): raise GitlabDataError(f"Unsupported API version: {self.api_version}") for section in ["global", self.gitlab_id]: try: self.per_page = _config.getint(section, "per_page") except _CONFIG_PARSER_ERRORS: pass if self.per_page is not None and not 0 <= self.per_page <= 100: raise GitlabDataError(f"Unsupported per_page number: {self.per_page}") try: self.pagination = _config.get(self.gitlab_id, "pagination") except _CONFIG_PARSER_ERRORS: pass try: self.order_by = _config.get(self.gitlab_id, "order_by") except _CONFIG_PARSER_ERRORS: pass try: self.user_agent = _config.get("global", "user_agent") except _CONFIG_PARSER_ERRORS: pass try: self.user_agent = _config.get(self.gitlab_id, "user_agent") except _CONFIG_PARSER_ERRORS: pass try: self.keep_base_url = _config.getboolean("global", "keep_base_url") except _CONFIG_PARSER_ERRORS: pass try: self.keep_base_url = _config.getboolean(self.gitlab_id, "keep_base_url") except _CONFIG_PARSER_ERRORS: pass try: self.retry_transient_errors = _config.getboolean( "global", "retry_transient_errors" ) except _CONFIG_PARSER_ERRORS: pass try: self.retry_transient_errors = _config.getboolean( self.gitlab_id, "retry_transient_errors" ) except _CONFIG_PARSER_ERRORS: pass def _get_values_from_helper(self) -> None: """Update attributes that may get values from an external helper program""" for attr in HELPER_ATTRIBUTES: value = getattr(self, attr) if not isinstance(value, str): continue if not value.lower().strip().startswith(HELPER_PREFIX): continue helper = value[len(HELPER_PREFIX) :].strip() commmand = [expanduser(expandvars(token)) for token in shlex.split(helper)] try: value = ( subprocess.check_output(commmand, stderr=subprocess.PIPE) .decode("utf-8") .strip() ) except subprocess.CalledProcessError as e: stderr = e.stderr.decode().strip() raise GitlabConfigHelperError( f"Failed to read {attr} value from helper " f"for {self.gitlab_id}:\n{stderr}" ) from e setattr(self, attr, value) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/const.py0000644000000000000000000001064314366036457016101 0ustar00rootrootfrom enum import Enum, IntEnum from gitlab._version import __title__, __version__ # NOTE(jlvillal): '_DEPRECATED' only affects users accessing constants via the # top-level gitlab.* namespace. See 'gitlab/__init__.py:__getattr__()' for the # consumer of '_DEPRECATED' For example 'x = gitlab.NO_ACCESS'. We want users # to instead use constants by doing code like: gitlab.const.NO_ACCESS. _DEPRECATED = [ "ADMIN_ACCESS", "DEFAULT_URL", "DEVELOPER_ACCESS", "GUEST_ACCESS", "MAINTAINER_ACCESS", "MINIMAL_ACCESS", "NO_ACCESS", "NOTIFICATION_LEVEL_CUSTOM", "NOTIFICATION_LEVEL_DISABLED", "NOTIFICATION_LEVEL_GLOBAL", "NOTIFICATION_LEVEL_MENTION", "NOTIFICATION_LEVEL_PARTICIPATING", "NOTIFICATION_LEVEL_WATCH", "OWNER_ACCESS", "REPORTER_ACCESS", "SEARCH_SCOPE_BLOBS", "SEARCH_SCOPE_COMMITS", "SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES", "SEARCH_SCOPE_ISSUES", "SEARCH_SCOPE_MERGE_REQUESTS", "SEARCH_SCOPE_MILESTONES", "SEARCH_SCOPE_PROJECT_NOTES", "SEARCH_SCOPE_PROJECTS", "SEARCH_SCOPE_USERS", "SEARCH_SCOPE_WIKI_BLOBS", "USER_AGENT", "VISIBILITY_INTERNAL", "VISIBILITY_PRIVATE", "VISIBILITY_PUBLIC", ] class GitlabEnum(str, Enum): """An enum mixed in with str to make it JSON-serializable.""" # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/lib/gitlab/access.rb#L12-18 class AccessLevel(IntEnum): NO_ACCESS: int = 0 MINIMAL_ACCESS: int = 5 GUEST: int = 10 REPORTER: int = 20 DEVELOPER: int = 30 MAINTAINER: int = 40 OWNER: int = 50 ADMIN: int = 60 # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/lib/gitlab/visibility_level.rb#L23-25 class Visibility(GitlabEnum): PRIVATE: str = "private" INTERNAL: str = "internal" PUBLIC: str = "public" class NotificationLevel(GitlabEnum): DISABLED: str = "disabled" PARTICIPATING: str = "participating" WATCH: str = "watch" GLOBAL: str = "global" MENTION: str = "mention" CUSTOM: str = "custom" # https://gitlab.com/gitlab-org/gitlab/-/blob/e97357824bedf007e75f8782259fe07435b64fbb/app/views/search/_category.html.haml#L10-37 class SearchScope(GitlabEnum): # all scopes (global, group and project) PROJECTS: str = "projects" ISSUES: str = "issues" MERGE_REQUESTS: str = "merge_requests" MILESTONES: str = "milestones" WIKI_BLOBS: str = "wiki_blobs" COMMITS: str = "commits" BLOBS: str = "blobs" USERS: str = "users" # specific global scope GLOBAL_SNIPPET_TITLES: str = "snippet_titles" # specific project scope PROJECT_NOTES: str = "notes" DEFAULT_URL: str = "https://gitlab.com" NO_ACCESS = AccessLevel.NO_ACCESS.value MINIMAL_ACCESS = AccessLevel.MINIMAL_ACCESS.value GUEST_ACCESS = AccessLevel.GUEST.value REPORTER_ACCESS = AccessLevel.REPORTER.value DEVELOPER_ACCESS = AccessLevel.DEVELOPER.value MAINTAINER_ACCESS = AccessLevel.MAINTAINER.value OWNER_ACCESS = AccessLevel.OWNER.value ADMIN_ACCESS = AccessLevel.ADMIN.value VISIBILITY_PRIVATE = Visibility.PRIVATE.value VISIBILITY_INTERNAL = Visibility.INTERNAL.value VISIBILITY_PUBLIC = Visibility.PUBLIC.value NOTIFICATION_LEVEL_DISABLED = NotificationLevel.DISABLED.value NOTIFICATION_LEVEL_PARTICIPATING = NotificationLevel.PARTICIPATING.value NOTIFICATION_LEVEL_WATCH = NotificationLevel.WATCH.value NOTIFICATION_LEVEL_GLOBAL = NotificationLevel.GLOBAL.value NOTIFICATION_LEVEL_MENTION = NotificationLevel.MENTION.value NOTIFICATION_LEVEL_CUSTOM = NotificationLevel.CUSTOM.value # Search scopes # all scopes (global, group and project) SEARCH_SCOPE_PROJECTS = SearchScope.PROJECTS.value SEARCH_SCOPE_ISSUES = SearchScope.ISSUES.value SEARCH_SCOPE_MERGE_REQUESTS = SearchScope.MERGE_REQUESTS.value SEARCH_SCOPE_MILESTONES = SearchScope.MILESTONES.value SEARCH_SCOPE_WIKI_BLOBS = SearchScope.WIKI_BLOBS.value SEARCH_SCOPE_COMMITS = SearchScope.COMMITS.value SEARCH_SCOPE_BLOBS = SearchScope.BLOBS.value SEARCH_SCOPE_USERS = SearchScope.USERS.value # specific global scope SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES = SearchScope.GLOBAL_SNIPPET_TITLES.value # specific project scope SEARCH_SCOPE_PROJECT_NOTES = SearchScope.PROJECT_NOTES.value USER_AGENT: str = f"{__title__}/{__version__}" RETRYABLE_TRANSIENT_ERROR_CODES = [500, 502, 503, 504] + list(range(520, 531)) __all__ = [ "AccessLevel", "Visibility", "NotificationLevel", "SearchScope", ] __all__.extend(_DEPRECATED) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/exceptions.py0000644000000000000000000001422614366036457017135 0ustar00rootrootimport functools from typing import Any, Callable, cast, Optional, Type, TYPE_CHECKING, TypeVar, Union class GitlabError(Exception): def __init__( self, error_message: Union[str, bytes] = "", response_code: Optional[int] = None, response_body: Optional[bytes] = None, ) -> None: Exception.__init__(self, error_message) # Http status code self.response_code = response_code # Full http response self.response_body = response_body # Parsed error message from gitlab try: # if we receive str/bytes we try to convert to unicode/str to have # consistent message types (see #616) if TYPE_CHECKING: assert isinstance(error_message, bytes) self.error_message = error_message.decode() except Exception: if TYPE_CHECKING: assert isinstance(error_message, str) self.error_message = error_message def __str__(self) -> str: if self.response_code is not None: return f"{self.response_code}: {self.error_message}" return f"{self.error_message}" class GitlabAuthenticationError(GitlabError): pass class RedirectError(GitlabError): pass class GitlabParsingError(GitlabError): pass class GitlabCiLintError(GitlabError): pass class GitlabConnectionError(GitlabError): pass class GitlabOperationError(GitlabError): pass class GitlabHttpError(GitlabError): pass class GitlabListError(GitlabOperationError): pass class GitlabGetError(GitlabOperationError): pass class GitlabHeadError(GitlabOperationError): pass class GitlabCreateError(GitlabOperationError): pass class GitlabUpdateError(GitlabOperationError): pass class GitlabDeleteError(GitlabOperationError): pass class GitlabSetError(GitlabOperationError): pass class GitlabProtectError(GitlabOperationError): pass class GitlabTransferProjectError(GitlabOperationError): pass class GitlabGroupTransferError(GitlabOperationError): pass class GitlabProjectDeployKeyError(GitlabOperationError): pass class GitlabPromoteError(GitlabOperationError): pass class GitlabCancelError(GitlabOperationError): pass class GitlabPipelineCancelError(GitlabCancelError): pass class GitlabRetryError(GitlabOperationError): pass class GitlabBuildCancelError(GitlabCancelError): pass class GitlabBuildRetryError(GitlabRetryError): pass class GitlabBuildPlayError(GitlabRetryError): pass class GitlabBuildEraseError(GitlabRetryError): pass class GitlabJobCancelError(GitlabCancelError): pass class GitlabJobRetryError(GitlabRetryError): pass class GitlabJobPlayError(GitlabRetryError): pass class GitlabJobEraseError(GitlabRetryError): pass class GitlabPipelinePlayError(GitlabRetryError): pass class GitlabPipelineRetryError(GitlabRetryError): pass class GitlabBlockError(GitlabOperationError): pass class GitlabUnblockError(GitlabOperationError): pass class GitlabDeactivateError(GitlabOperationError): pass class GitlabActivateError(GitlabOperationError): pass class GitlabBanError(GitlabOperationError): pass class GitlabUnbanError(GitlabOperationError): pass class GitlabSubscribeError(GitlabOperationError): pass class GitlabUnsubscribeError(GitlabOperationError): pass class GitlabMRForbiddenError(GitlabOperationError): pass class GitlabMRApprovalError(GitlabOperationError): pass class GitlabMRRebaseError(GitlabOperationError): pass class GitlabMRResetApprovalError(GitlabOperationError): pass class GitlabMRClosedError(GitlabOperationError): pass class GitlabMROnBuildSuccessError(GitlabOperationError): pass class GitlabTodoError(GitlabOperationError): pass class GitlabTopicMergeError(GitlabOperationError): pass class GitlabTimeTrackingError(GitlabOperationError): pass class GitlabUploadError(GitlabOperationError): pass class GitlabAttachFileError(GitlabOperationError): pass class GitlabImportError(GitlabOperationError): pass class GitlabInvitationError(GitlabOperationError): pass class GitlabCherryPickError(GitlabOperationError): pass class GitlabHousekeepingError(GitlabOperationError): pass class GitlabOwnershipError(GitlabOperationError): pass class GitlabSearchError(GitlabOperationError): pass class GitlabStopError(GitlabOperationError): pass class GitlabMarkdownError(GitlabOperationError): pass class GitlabVerifyError(GitlabOperationError): pass class GitlabRenderError(GitlabOperationError): pass class GitlabRepairError(GitlabOperationError): pass class GitlabRestoreError(GitlabOperationError): pass class GitlabRevertError(GitlabOperationError): pass class GitlabLicenseError(GitlabOperationError): pass class GitlabFollowError(GitlabOperationError): pass class GitlabUnfollowError(GitlabOperationError): pass class GitlabUserApproveError(GitlabOperationError): pass class GitlabUserRejectError(GitlabOperationError): pass class GitlabDeploymentApprovalError(GitlabOperationError): pass # For an explanation of how these type-hints work see: # https://mypy.readthedocs.io/en/stable/generics.html#declaring-decorators # # The goal here is that functions which get decorated will retain their types. __F = TypeVar("__F", bound=Callable[..., Any]) def on_http_error(error: Type[Exception]) -> Callable[[__F], __F]: """Manage GitlabHttpError exceptions. This decorator function can be used to catch GitlabHttpError exceptions raise specialized exceptions instead. Args: The exception type to raise -- must inherit from GitlabError """ def wrap(f: __F) -> __F: @functools.wraps(f) def wrapped_f(*args: Any, **kwargs: Any) -> Any: try: return f(*args, **kwargs) except GitlabHttpError as e: raise error(e.error_message, e.response_code, e.response_body) from e return cast(__F, wrapped_f) return wrap __all__ = [name for name in dir() if name.endswith("Error")] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/mixins.py0000644000000000000000000007573614366036457016300 0ustar00rootrootfrom types import ModuleType from typing import ( Any, Callable, Dict, Iterator, List, Optional, Tuple, Type, TYPE_CHECKING, Union, ) import requests import gitlab from gitlab import base, cli from gitlab import exceptions as exc from gitlab import utils __all__ = [ "GetMixin", "GetWithoutIdMixin", "RefreshMixin", "ListMixin", "RetrieveMixin", "CreateMixin", "UpdateMixin", "SetMixin", "DeleteMixin", "CRUDMixin", "NoUpdateMixin", "SaveMixin", "ObjectDeleteMixin", "UserAgentDetailMixin", "AccessRequestMixin", "DownloadMixin", "SubscribableMixin", "TodoMixin", "TimeTrackingMixin", "ParticipantsMixin", "BadgeRenderMixin", ] if TYPE_CHECKING: # When running mypy we use these as the base classes _RestManagerBase = base.RESTManager _RestObjectBase = base.RESTObject else: _RestManagerBase = object _RestObjectBase = object class HeadMixin(_RestManagerBase): @exc.on_http_error(exc.GitlabHeadError) def head( self, id: Optional[Union[str, int]] = None, **kwargs: Any ) -> "requests.structures.CaseInsensitiveDict[Any]": """Retrieve headers from an endpoint. Args: id: ID of the object to retrieve **kwargs: Extra options to send to the server (e.g. sudo) Returns: A requests header object. Raises: GitlabAuthenticationError: If authentication is not correct GitlabHeadError: If the server cannot perform the request """ if TYPE_CHECKING: assert self.path is not None path = self.path if id is not None: path = f"{path}/{utils.EncodedId(id)}" return self.gitlab.http_head(path, **kwargs) class GetMixin(HeadMixin, _RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _optional_get_attrs: Tuple[str, ...] = () _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabGetError) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> base.RESTObject: """Retrieve a single object. Args: id: ID of the object to retrieve lazy: 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) Returns: The generated RESTObject. Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the server cannot perform the request """ if isinstance(id, str): id = utils.EncodedId(id) path = f"{self.path}/{id}" if TYPE_CHECKING: assert self._obj_cls is not None if lazy is True: if TYPE_CHECKING: assert self._obj_cls._id_attr is not None return self._obj_cls(self, {self._obj_cls._id_attr: id}, lazy=lazy) server_data = self.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) return self._obj_cls(self, server_data, lazy=lazy) class GetWithoutIdMixin(HeadMixin, _RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _optional_get_attrs: Tuple[str, ...] = () _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabGetError) def get(self, **kwargs: Any) -> base.RESTObject: """Retrieve a single object. Args: **kwargs: Extra options to send to the server (e.g. sudo) Returns: The generated RESTObject Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the server cannot perform the request """ if TYPE_CHECKING: assert self.path is not None server_data = self.gitlab.http_get(self.path, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) assert self._obj_cls is not None return self._obj_cls(self, server_data) class RefreshMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @exc.on_http_error(exc.GitlabGetError) def refresh(self, **kwargs: Any) -> None: """Refresh a single object from server. Args: **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 """ if self._id_attr: path = f"{self.manager.path}/{self.encoded_id}" else: if TYPE_CHECKING: assert self.manager.path is not None path = self.manager.path server_data = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) self._update_attrs(server_data) class ListMixin(HeadMixin, _RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _list_filters: Tuple[str, ...] = () _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabListError) def list(self, **kwargs: Any) -> Union[base.RESTObjectList, List[base.RESTObject]]: """Retrieve a list of objects. Args: 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) iterator: If set to True and no pagination option is defined, 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 if `iterator` is True Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server cannot perform the request """ data, _ = utils._transform_types( data=kwargs, custom_types=self._types, transform_data=True, transform_files=False, ) if self.gitlab.per_page: data.setdefault("per_page", self.gitlab.per_page) # global keyset pagination if self.gitlab.pagination: data.setdefault("pagination", self.gitlab.pagination) if self.gitlab.order_by: data.setdefault("order_by", self.gitlab.order_by) # Allow to overwrite the path, handy for custom listings path = data.pop("path", self.path) if TYPE_CHECKING: assert self._obj_cls is not None obj = self.gitlab.http_list(path, **data) if isinstance(obj, list): return [self._obj_cls(self, item, created_from_list=True) for item in obj] return base.RESTObjectList(self, self._obj_cls, obj) class RetrieveMixin(ListMixin, GetMixin): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab class CreateMixin(_RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabCreateError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> base.RESTObject: """Create a new object. Args: data: parameters to send to the server to create the resource **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 Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request """ if data is None: data = {} self._create_attrs.validate_attrs(data=data) data, files = utils._transform_types( data=data, custom_types=self._types, transform_data=False ) # Handle specific URL for creation path = kwargs.pop("path", self.path) server_data = self.gitlab.http_post(path, post_data=data, files=files, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) assert self._obj_cls is not None return self._obj_cls(self, server_data) class UpdateMixin(_RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] _update_uses_post: bool = False gitlab: gitlab.Gitlab def _get_update_method( self, ) -> Callable[..., Union[Dict[str, Any], requests.Response]]: """Return the HTTP method to use. Returns: http_put (default) or http_post """ if self._update_uses_post: http_method = self.gitlab.http_post else: http_method = self.gitlab.http_put return http_method @exc.on_http_error(exc.GitlabUpdateError) def update( self, id: Optional[Union[str, int]] = None, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> Dict[str, Any]: """Update an object on the server. Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object **kwargs: Extra options to send to the server (e.g. sudo) Returns: The new object data (*not* a RESTObject) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ new_data = new_data or {} if id is None: path = self.path else: path = f"{self.path}/{utils.EncodedId(id)}" excludes = [] if self._obj_cls is not None and self._obj_cls._id_attr is not None: excludes = [self._obj_cls._id_attr] self._update_attrs.validate_attrs(data=new_data, excludes=excludes) new_data, files = utils._transform_types( data=new_data, custom_types=self._types, transform_data=False ) http_method = self._get_update_method() result = http_method(path, post_data=new_data, files=files, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result class SetMixin(_RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabSetError) def set(self, key: str, value: str, **kwargs: Any) -> base.RESTObject: """Create or update the object. Args: key: The key of the object to create/update value: The value to set for the object **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabSetError: If an error occurred Returns: The created/updated attribute """ path = f"{self.path}/{utils.EncodedId(key)}" data = {"value": value} server_data = self.gitlab.http_put(path, post_data=data, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) assert self._obj_cls is not None return self._obj_cls(self, server_data) class DeleteMixin(_RestManagerBase): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab @exc.on_http_error(exc.GitlabDeleteError) def delete(self, id: Optional[Union[str, int]] = None, **kwargs: Any) -> None: """Delete an object on the server. Args: 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 """ if id is None: path = self.path else: path = f"{self.path}/{utils.EncodedId(id)}" if TYPE_CHECKING: assert path is not None self.gitlab.http_delete(path, **kwargs) class CRUDMixin(GetMixin, ListMixin, CreateMixin, UpdateMixin, DeleteMixin): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab class NoUpdateMixin(GetMixin, ListMixin, CreateMixin, DeleteMixin): _computed_path: Optional[str] _from_parent_attrs: Dict[str, Any] _obj_cls: Optional[Type[base.RESTObject]] _parent: Optional[base.RESTObject] _parent_attrs: Dict[str, Any] _path: Optional[str] gitlab: gitlab.Gitlab class SaveMixin(_RestObjectBase): """Mixin for RESTObject's that can be updated.""" _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager def _get_updated_data(self) -> Dict[str, Any]: updated_data = {} for attr in self.manager._update_attrs.required: # Get everything required, no matter if it's been updated updated_data[attr] = getattr(self, attr) # Add the updated attributes updated_data.update(self._updated_attrs) return updated_data def save(self, **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. Args: **kwargs: Extra options to send to the server (e.g. sudo) Returns: The new object data (*not* a RESTObject) Raise: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ updated_data = self._get_updated_data() # Nothing to update. Server fails if sent an empty dict. if not updated_data: return None # call the manager obj_id = self.encoded_id if TYPE_CHECKING: assert isinstance(self.manager, UpdateMixin) server_data = self.manager.update(obj_id, updated_data, **kwargs) self._update_attrs(server_data) return server_data class ObjectDeleteMixin(_RestObjectBase): """Mixin for RESTObject's that can be deleted.""" _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager def delete(self, **kwargs: Any) -> None: """Delete the object from the server. Args: **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 """ if TYPE_CHECKING: assert isinstance(self.manager, DeleteMixin) assert self.encoded_id is not None self.manager.delete(self.encoded_id, **kwargs) class UserAgentDetailMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action(("Snippet", "ProjectSnippet", "ProjectIssue")) @exc.on_http_error(exc.GitlabGetError) def user_agent_detail(self, **kwargs: Any) -> Dict[str, Any]: """Get the user agent detail. Args: **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 """ path = f"{self.manager.path}/{self.encoded_id}/user_agent_detail" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result class AccessRequestMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action( ("ProjectAccessRequest", "GroupAccessRequest"), (), ("access_level",) ) @exc.on_http_error(exc.GitlabUpdateError) def approve( self, access_level: int = gitlab.const.DEVELOPER_ACCESS, **kwargs: Any ) -> None: """Approve an access request. Args: access_level: 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 """ path = f"{self.manager.path}/{self.encoded_id}/approve" data = {"access_level": access_level} server_data = self.manager.gitlab.http_put(path, post_data=data, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) self._update_attrs(server_data) class DownloadMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action(("GroupExport", "ProjectExport")) @exc.on_http_error(exc.GitlabGetError) def download( self, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Download the archive of a resource export. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 """ path = f"{self.manager.path}/download" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) class SubscribableMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action( ("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel") ) @exc.on_http_error(exc.GitlabSubscribeError) def subscribe(self, **kwargs: Any) -> None: """Subscribe to the object notifications. Args: **kwargs: Extra options to send to the server (e.g. sudo) raises: GitlabAuthenticationError: If authentication is not correct GitlabSubscribeError: If the subscription cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/subscribe" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) self._update_attrs(server_data) @cli.register_custom_action( ("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel") ) @exc.on_http_error(exc.GitlabUnsubscribeError) def unsubscribe(self, **kwargs: Any) -> None: """Unsubscribe from the object notifications. Args: **kwargs: Extra options to send to the server (e.g. sudo) raises: GitlabAuthenticationError: If authentication is not correct GitlabUnsubscribeError: If the unsubscription cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/unsubscribe" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert not isinstance(server_data, requests.Response) self._update_attrs(server_data) class TodoMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest")) @exc.on_http_error(exc.GitlabTodoError) def todo(self, **kwargs: Any) -> None: """Create a todo associated to the object. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTodoError: If the todo cannot be set """ path = f"{self.manager.path}/{self.encoded_id}/todo" self.manager.gitlab.http_post(path, **kwargs) class TimeTrackingMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest")) @exc.on_http_error(exc.GitlabTimeTrackingError) def time_stats(self, **kwargs: Any) -> Dict[str, Any]: """Get time stats for the object. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTimeTrackingError: If the time tracking update cannot be done """ # Use the existing time_stats attribute if it exist, otherwise make an # API call if "time_stats" in self.attributes: time_stats = self.attributes["time_stats"] if TYPE_CHECKING: assert isinstance(time_stats, dict) return time_stats path = f"{self.manager.path}/{self.encoded_id}/time_stats" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"), ("duration",)) @exc.on_http_error(exc.GitlabTimeTrackingError) def time_estimate(self, duration: str, **kwargs: Any) -> Dict[str, Any]: """Set an estimated time of work for the object. Args: duration: Duration in human format (e.g. 3h30) **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTimeTrackingError: If the time tracking update cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/time_estimate" data = {"duration": duration} result = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest")) @exc.on_http_error(exc.GitlabTimeTrackingError) def reset_time_estimate(self, **kwargs: Any) -> Dict[str, Any]: """Resets estimated time for the object to 0 seconds. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTimeTrackingError: If the time tracking update cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/reset_time_estimate" result = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"), ("duration",)) @exc.on_http_error(exc.GitlabTimeTrackingError) def add_spent_time(self, duration: str, **kwargs: Any) -> Dict[str, Any]: """Add time spent working on the object. Args: duration: Duration in human format (e.g. 3h30) **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTimeTrackingError: If the time tracking update cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/add_spent_time" data = {"duration": duration} result = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest")) @exc.on_http_error(exc.GitlabTimeTrackingError) def reset_spent_time(self, **kwargs: Any) -> Dict[str, Any]: """Resets the time spent working on the object. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTimeTrackingError: If the time tracking update cannot be done """ path = f"{self.manager.path}/{self.encoded_id}/reset_spent_time" result = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result class ParticipantsMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] manager: base.RESTManager @cli.register_custom_action(("ProjectMergeRequest", "ProjectIssue")) @exc.on_http_error(exc.GitlabListError) def participants(self, **kwargs: Any) -> Dict[str, Any]: """List the participants. Args: 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) **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 """ path = f"{self.manager.path}/{self.encoded_id}/participants" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result class BadgeRenderMixin(_RestManagerBase): @cli.register_custom_action( ("GroupBadgeManager", "ProjectBadgeManager"), ("link_url", "image_url") ) @exc.on_http_error(exc.GitlabRenderError) def render(self, link_url: str, image_url: str, **kwargs: Any) -> Dict[str, Any]: """Preview link_url and image_url after interpolation. Args: link_url: URL of the badge link image_url: 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 """ path = f"{self.path}/render" data = {"link_url": link_url, "image_url": image_url} result = self.gitlab.http_get(path, data, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result class PromoteMixin(_RestObjectBase): _id_attr: Optional[str] _attrs: Dict[str, Any] _module: ModuleType _parent_attrs: Dict[str, Any] _updated_attrs: Dict[str, Any] _update_uses_post: bool = False manager: base.RESTManager def _get_update_method( self, ) -> Callable[..., Union[Dict[str, Any], requests.Response]]: """Return the HTTP method to use. Returns: http_put (default) or http_post """ if self._update_uses_post: http_method = self.manager.gitlab.http_post else: http_method = self.manager.gitlab.http_put return http_method @exc.on_http_error(exc.GitlabPromoteError) def promote(self, **kwargs: Any) -> Dict[str, Any]: """Promote the item. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabPromoteError: If the item could not be promoted GitlabParsingError: If the json data could not be parsed Returns: The updated object data (*not* a RESTObject) """ path = f"{self.manager.path}/{self.encoded_id}/promote" http_method = self._get_update_method() result = http_method(path, **kwargs) if TYPE_CHECKING: assert not isinstance(result, requests.Response) return result ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/py.typed0000644000000000000000000000000014366036457016062 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/types.py0000644000000000000000000000636014366036457016120 0ustar00rootrootimport dataclasses from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING @dataclasses.dataclass(frozen=True) class RequiredOptional: required: Tuple[str, ...] = () optional: Tuple[str, ...] = () exclusive: Tuple[str, ...] = () def validate_attrs( self, *, data: Dict[str, Any], excludes: Optional[List[str]] = None, ) -> None: if excludes is None: excludes = [] if self.required: required = [k for k in self.required if k not in excludes] missing = [attr for attr in required if attr not in data] if missing: raise AttributeError(f"Missing attributes: {', '.join(missing)}") if self.exclusive: exclusives = [attr for attr in data if attr in self.exclusive] if len(exclusives) > 1: raise AttributeError( f"Provide only one of these attributes: {', '.join(exclusives)}" ) if not exclusives: raise AttributeError( f"Must provide one of these attributes: " f"{', '.join(self.exclusive)}" ) class GitlabAttribute: def __init__(self, value: Any = None) -> None: self._value = value def get(self) -> Any: return self._value def set_from_cli(self, cli_value: Any) -> None: self._value = cli_value def get_for_api(self, *, key: str) -> Tuple[str, Any]: return (key, self._value) class _ListArrayAttribute(GitlabAttribute): """Helper class to support `list` / `array` types.""" def set_from_cli(self, cli_value: str) -> None: if not cli_value.strip(): self._value = [] else: self._value = [item.strip() for item in cli_value.split(",")] def get_for_api(self, *, key: str) -> Tuple[str, str]: # Do not comma-split single value passed as string if isinstance(self._value, str): return (key, self._value) if TYPE_CHECKING: assert isinstance(self._value, list) return (key, ",".join([str(x) for x in self._value])) class ArrayAttribute(_ListArrayAttribute): """To support `array` types as documented in https://docs.gitlab.com/ee/api/#array""" def get_for_api(self, *, key: str) -> Tuple[str, Any]: if isinstance(self._value, str): return (f"{key}[]", self._value) if TYPE_CHECKING: assert isinstance(self._value, list) return (f"{key}[]", self._value) class CommaSeparatedListAttribute(_ListArrayAttribute): """For values which are sent to the server as a Comma Separated Values (CSV) string. We allow them to be specified as a list and we convert it into a CSV""" class LowercaseStringAttribute(GitlabAttribute): def get_for_api(self, *, key: str) -> Tuple[str, str]: return (key, str(self._value).lower()) class FileAttribute(GitlabAttribute): @staticmethod def get_file_name(attr_name: Optional[str] = None) -> Optional[str]: return attr_name class ImageAttribute(FileAttribute): @staticmethod def get_file_name(attr_name: Optional[str] = None) -> str: return f"{attr_name}.png" if attr_name else "image.png" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/utils.py0000644000000000000000000001246014366036457016112 0ustar00rootrootimport pathlib import traceback import urllib.parse import warnings from typing import Any, Callable, Dict, Iterator, Optional, Tuple, Type, Union import requests from gitlab import types class _StdoutStream: def __call__(self, chunk: Any) -> None: print(chunk) def response_content( response: requests.Response, streamed: bool, action: Optional[Callable[[bytes], None]], chunk_size: int, *, iterator: bool, ) -> Optional[Union[bytes, Iterator[Any]]]: if iterator: return response.iter_content(chunk_size=chunk_size) if streamed is False: return response.content if action is None: action = _StdoutStream() for chunk in response.iter_content(chunk_size=chunk_size): if chunk: action(chunk) return None def _transform_types( data: Dict[str, Any], custom_types: Dict[str, Any], *, transform_data: bool, transform_files: Optional[bool] = True, ) -> Tuple[Dict[str, Any], Dict[str, Any]]: """Copy the data dict with attributes that have custom types and transform them before being sent to the server. ``transform_files``: If ``True`` (default), also populates the ``files`` dict for FileAttribute types with tuples to prepare fields for requests' MultipartEncoder: https://toolbelt.readthedocs.io/en/latest/user.html#multipart-form-data-encoder ``transform_data``: If ``True`` transforms the ``data`` dict with fields suitable for encoding as query parameters for GitLab's API: https://docs.gitlab.com/ee/api/#encoding-api-parameters-of-array-and-hash-types Returns: A tuple of the transformed data dict and files dict""" # Duplicate data to avoid messing with what the user sent us data = data.copy() if not transform_files and not transform_data: return data, {} files = {} for attr_name, attr_class in custom_types.items(): if attr_name not in data: continue gitlab_attribute = attr_class(data[attr_name]) # if the type is FileAttribute we need to pass the data as file if isinstance(gitlab_attribute, types.FileAttribute) and transform_files: key = gitlab_attribute.get_file_name(attr_name) files[attr_name] = (key, data.pop(attr_name)) continue if not transform_data: continue if isinstance(gitlab_attribute, types.GitlabAttribute): key, value = gitlab_attribute.get_for_api(key=attr_name) if key != attr_name: del data[attr_name] data[key] = value return data, files def copy_dict( *, src: Dict[str, Any], dest: Dict[str, Any], ) -> None: for k, v in src.items(): if isinstance(v, dict): # NOTE(jlvillal): This provides some support for the `hash` type # https://docs.gitlab.com/ee/api/#hash # Transform dict values to new attributes. For example: # custom_attributes: {'foo', 'bar'} => # "custom_attributes['foo']": "bar" for dict_k, dict_v in v.items(): dest[f"{k}[{dict_k}]"] = dict_v else: dest[k] = v class EncodedId(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 """ def __new__(cls, value: Union[str, int, "EncodedId"]) -> "EncodedId": if isinstance(value, EncodedId): return value if not isinstance(value, (int, str)): raise TypeError(f"Unsupported type received: {type(value)}") if isinstance(value, str): value = urllib.parse.quote(value, safe="") return super().__new__(cls, value) def remove_none_from_dict(data: Dict[str, Any]) -> Dict[str, Any]: return {k: v for k, v in data.items() if v is not None} def warn( message: str, *, category: Optional[Type[Warning]] = None, source: Optional[Any] = None, ) -> None: """This `warnings.warn` wrapper function attempts to show the location causing the warning in the user code that called the library. It does this by walking up the stack trace to find the first frame located outside the `gitlab/` directory. This is helpful to users as it shows them their code that is causing the warning. """ # Get `stacklevel` for user code so we indicate where issue is in # their code. pg_dir = pathlib.Path(__file__).parent.resolve() stack = traceback.extract_stack() stacklevel = 1 warning_from = "" for stacklevel, frame in enumerate(reversed(stack), start=1): if stacklevel == 2: warning_from = f" (python-gitlab: {frame.filename}:{frame.lineno})" frame_dir = str(pathlib.Path(frame.filename).parent.resolve()) if not frame_dir.startswith(str(pg_dir)): break warnings.warn( message=message + warning_from, category=category, stacklevel=stacklevel, source=source, ) ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.302791 python-gitlab-3.13.0/gitlab/v4/0000755000000000000000000000000014366036463014723 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/__init__.py0000644000000000000000000000000014366036457017025 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/cli.py0000644000000000000000000005047314366036457016060 0ustar00rootrootimport argparse import operator import sys from typing import Any, Dict, List, Optional, Type, TYPE_CHECKING, Union import gitlab import gitlab.base import gitlab.v4.objects from gitlab import cli from gitlab.exceptions import GitlabCiLintError class GitlabCLI: def __init__( self, gl: gitlab.Gitlab, gitlab_resource: str, resource_action: str, args: Dict[str, str], ) -> None: self.cls: Type[gitlab.base.RESTObject] = cli.gitlab_resource_to_cls( gitlab_resource, namespace=gitlab.v4.objects ) self.cls_name = self.cls.__name__ self.gitlab_resource = gitlab_resource.replace("-", "_") self.resource_action = resource_action.lower() self.gl = gl self.args = args self.parent_args: Dict[str, Any] = {} self.mgr_cls: Union[ Type[gitlab.mixins.CreateMixin], Type[gitlab.mixins.DeleteMixin], Type[gitlab.mixins.GetMixin], Type[gitlab.mixins.GetWithoutIdMixin], Type[gitlab.mixins.ListMixin], Type[gitlab.mixins.UpdateMixin], ] = getattr(gitlab.v4.objects, f"{self.cls.__name__}Manager") # We could do something smart, like splitting the manager name to find # parents, build the chain of managers to get to the final object. # Instead we do something ugly and efficient: interpolate variables in # the class _path attribute, and replace the value with the result. if TYPE_CHECKING: assert self.mgr_cls._path is not None self._process_from_parent_attrs() self.mgr_cls._path = self.mgr_cls._path.format(**self.parent_args) self.mgr = self.mgr_cls(gl) if self.mgr_cls._types: for attr_name, type_cls in self.mgr_cls._types.items(): if attr_name in self.args.keys(): obj = type_cls() obj.set_from_cli(self.args[attr_name]) self.args[attr_name] = obj.get() def _process_from_parent_attrs(self) -> None: """Items in the path need to be url-encoded. There is a 1:1 mapping from mgr_cls._from_parent_attrs <--> mgr_cls._path. Those values must be url-encoded as they may contain a slash '/'.""" for key in self.mgr_cls._from_parent_attrs: if key not in self.args: continue self.parent_args[key] = gitlab.utils.EncodedId(self.args[key]) # If we don't delete it then it will be added to the URL as a query-string del self.args[key] def run(self) -> Any: # Check for a method that matches gitlab_resource + action method = f"do_{self.gitlab_resource}_{self.resource_action}" if hasattr(self, method): return getattr(self, method)() # Fallback to standard actions (get, list, create, ...) method = f"do_{self.resource_action}" if hasattr(self, method): return getattr(self, method)() # Finally try to find custom methods return self.do_custom() def do_custom(self) -> Any: class_instance: Union[gitlab.base.RESTManager, gitlab.base.RESTObject] in_obj = cli.custom_actions[self.cls_name][self.resource_action][2] # Get the object (lazy), then act if in_obj: data = {} if self.mgr._from_parent_attrs: for k in self.mgr._from_parent_attrs: data[k] = self.parent_args[k] if not issubclass(self.cls, gitlab.mixins.GetWithoutIdMixin): if TYPE_CHECKING: assert isinstance(self.cls._id_attr, str) data[self.cls._id_attr] = self.args.pop(self.cls._id_attr) class_instance = self.cls(self.mgr, data) else: class_instance = self.mgr method_name = self.resource_action.replace("-", "_") return getattr(class_instance, method_name)(**self.args) def do_project_export_download(self) -> None: try: project = self.gl.projects.get(self.parent_args["project_id"], lazy=True) export_status = project.exports.get() if TYPE_CHECKING: assert export_status is not None data = export_status.download() if TYPE_CHECKING: assert data is not None assert isinstance(data, bytes) sys.stdout.buffer.write(data) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to download the export", e) def do_validate(self) -> None: if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.v4.objects.CiLintManager) try: self.mgr.validate(self.args) except GitlabCiLintError as e: # pragma: no cover, cli.die is unit-tested cli.die("CI YAML Lint failed", e) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Cannot validate CI YAML", e) def do_create(self) -> gitlab.base.RESTObject: if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.mixins.CreateMixin) try: result = self.mgr.create(self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to create object", e) return result def do_list( self, ) -> Union[gitlab.base.RESTObjectList, List[gitlab.base.RESTObject]]: if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.mixins.ListMixin) try: result = self.mgr.list(**self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to list objects", e) return result def do_get(self) -> Optional[gitlab.base.RESTObject]: if isinstance(self.mgr, gitlab.mixins.GetWithoutIdMixin): try: result = self.mgr.get(id=None, **self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to get object", e) return result if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.mixins.GetMixin) assert isinstance(self.cls._id_attr, str) id = self.args.pop(self.cls._id_attr) try: result = self.mgr.get(id, lazy=False, **self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to get object", e) return result def do_delete(self) -> None: if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.mixins.DeleteMixin) assert isinstance(self.cls._id_attr, str) id = self.args.pop(self.cls._id_attr) try: self.mgr.delete(id, **self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to destroy object", e) def do_update(self) -> Dict[str, Any]: if TYPE_CHECKING: assert isinstance(self.mgr, gitlab.mixins.UpdateMixin) if issubclass(self.mgr_cls, gitlab.mixins.GetWithoutIdMixin): id = None else: if TYPE_CHECKING: assert isinstance(self.cls._id_attr, str) id = self.args.pop(self.cls._id_attr) try: result = self.mgr.update(id, self.args) except Exception as e: # pragma: no cover, cli.die is unit-tested cli.die("Impossible to update object", e) return result # https://github.com/python/typeshed/issues/7539#issuecomment-1076581049 if TYPE_CHECKING: _SubparserType = argparse._SubParsersAction[argparse.ArgumentParser] else: _SubparserType = Any def _populate_sub_parser_by_class( cls: Type[gitlab.base.RESTObject], sub_parser: _SubparserType, ) -> None: mgr_cls_name = f"{cls.__name__}Manager" mgr_cls = getattr(gitlab.v4.objects, mgr_cls_name) action_parsers: Dict[str, argparse.ArgumentParser] = {} for action_name in ["list", "get", "create", "update", "delete"]: if not hasattr(mgr_cls, action_name): continue sub_parser_action = sub_parser.add_parser( action_name, conflict_handler="resolve" ) action_parsers[action_name] = sub_parser_action sub_parser_action.add_argument("--sudo", required=False) if mgr_cls._from_parent_attrs: for x in mgr_cls._from_parent_attrs: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) if action_name == "list": for x in mgr_cls._list_filters: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) sub_parser_action.add_argument("--page", required=False, type=int) sub_parser_action.add_argument("--per-page", required=False, type=int) sub_parser_action.add_argument( "--get-all", required=False, action="store_true", help="Return all items from the server, without pagination.", ) sub_parser_action.add_argument( "--all", required=False, action="store_true", help="Deprecated. Use --get-all instead.", ) if action_name == "delete": if cls._id_attr is not None: id_attr = cls._id_attr.replace("_", "-") sub_parser_action.add_argument(f"--{id_attr}", required=True) if action_name == "get": if not issubclass(cls, gitlab.mixins.GetWithoutIdMixin): if cls._id_attr is not None: id_attr = cls._id_attr.replace("_", "-") sub_parser_action.add_argument(f"--{id_attr}", required=True) for x in mgr_cls._optional_get_attrs: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) if action_name == "create": for x in mgr_cls._create_attrs.required: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) for x in mgr_cls._create_attrs.optional: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) if action_name == "update": if cls._id_attr is not None: id_attr = cls._id_attr.replace("_", "-") sub_parser_action.add_argument(f"--{id_attr}", required=True) for x in mgr_cls._update_attrs.required: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) for x in mgr_cls._update_attrs.optional: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) if cls.__name__ in cli.custom_actions: name = cls.__name__ for action_name in cli.custom_actions[name]: # NOTE(jlvillal): If we put a function for the `default` value of # the `get` it will always get called, which will break things. action_parser = action_parsers.get(action_name) if action_parser is None: sub_parser_action = sub_parser.add_parser(action_name) else: sub_parser_action = action_parser # Get the attributes for URL/path construction if mgr_cls._from_parent_attrs: for x in mgr_cls._from_parent_attrs: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) sub_parser_action.add_argument("--sudo", required=False) # We need to get the object somehow if not issubclass(cls, gitlab.mixins.GetWithoutIdMixin): if cls._id_attr is not None: id_attr = cls._id_attr.replace("_", "-") sub_parser_action.add_argument(f"--{id_attr}", required=True) required, optional, dummy = cli.custom_actions[name][action_name] for x in required: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) for x in optional: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) if mgr_cls.__name__ in cli.custom_actions: name = mgr_cls.__name__ for action_name in cli.custom_actions[name]: # NOTE(jlvillal): If we put a function for the `default` value of # the `get` it will always get called, which will break things. action_parser = action_parsers.get(action_name) if action_parser is None: sub_parser_action = sub_parser.add_parser(action_name) else: sub_parser_action = action_parser if mgr_cls._from_parent_attrs: for x in mgr_cls._from_parent_attrs: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) sub_parser_action.add_argument("--sudo", required=False) required, optional, dummy = cli.custom_actions[name][action_name] for x in required: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=True ) for x in optional: if x != cls._id_attr: sub_parser_action.add_argument( f"--{x.replace('_', '-')}", required=False ) def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser: subparsers = parser.add_subparsers( title="resource", dest="gitlab_resource", help="The GitLab resource to manipulate.", ) subparsers.required = True # populate argparse for all Gitlab Object classes = set() for cls in gitlab.v4.objects.__dict__.values(): if not isinstance(cls, type): continue if issubclass(cls, gitlab.base.RESTManager): if cls._obj_cls is not None: classes.add(cls._obj_cls) for cls in sorted(classes, key=operator.attrgetter("__name__")): arg_name = cli.cls_to_gitlab_resource(cls) object_group = subparsers.add_parser( arg_name, formatter_class=cli.VerticalHelpFormatter ) object_subparsers = object_group.add_subparsers( title="action", dest="resource_action", help="Action to execute on the GitLab resource.", ) _populate_sub_parser_by_class(cls, object_subparsers) object_subparsers.required = True return parser def get_dict( obj: Union[str, Dict[str, Any], gitlab.base.RESTObject], fields: List[str] ) -> Union[str, Dict[str, Any]]: if not isinstance(obj, gitlab.base.RESTObject): return obj if fields: return {k: v for k, v in obj.attributes.items() if k in fields} return obj.attributes class JSONPrinter: @staticmethod def display(d: Union[str, Dict[str, Any]], **_kwargs: Any) -> None: import json # noqa print(json.dumps(d)) @staticmethod def display_list( data: List[Union[str, Dict[str, Any], gitlab.base.RESTObject]], fields: List[str], **_kwargs: Any, ) -> None: import json # noqa print(json.dumps([get_dict(obj, fields) for obj in data])) class YAMLPrinter: @staticmethod def display(d: Union[str, Dict[str, Any]], **_kwargs: Any) -> None: try: import yaml # noqa print(yaml.safe_dump(d, default_flow_style=False)) except ImportError: sys.exit( "PyYaml is not installed.\n" "Install it with `pip install PyYaml` " "to use the yaml output feature" ) @staticmethod def display_list( data: List[Union[str, Dict[str, Any], gitlab.base.RESTObject]], fields: List[str], **_kwargs: Any, ) -> None: try: import yaml # noqa print( yaml.safe_dump( [get_dict(obj, fields) for obj in data], default_flow_style=False ) ) except ImportError: sys.exit( "PyYaml is not installed.\n" "Install it with `pip install PyYaml` " "to use the yaml output feature" ) class LegacyPrinter: def display(self, _d: Union[str, Dict[str, Any]], **kwargs: Any) -> None: verbose = kwargs.get("verbose", False) padding = kwargs.get("padding", 0) obj: Optional[Union[Dict[str, Any], gitlab.base.RESTObject]] = kwargs.get("obj") if TYPE_CHECKING: assert obj is not None def display_dict(d: Dict[str, Any], padding: int) -> None: for k in sorted(d.keys()): v = d[k] if isinstance(v, dict): print(f"{' ' * padding}{k.replace('_', '-')}:") new_padding = padding + 2 self.display(v, verbose=True, padding=new_padding, obj=v) continue print(f"{' ' * padding}{k.replace('_', '-')}: {v}") if verbose: if isinstance(obj, dict): display_dict(obj, padding) return # not a dict, we assume it's a RESTObject if obj._id_attr: id = getattr(obj, obj._id_attr, None) print(f"{obj._id_attr}: {id}") attrs = obj.attributes if obj._id_attr: attrs.pop(obj._id_attr) display_dict(attrs, padding) else: if TYPE_CHECKING: assert isinstance(obj, gitlab.base.RESTObject) if obj._id_attr: id = getattr(obj, obj._id_attr) print(f"{obj._id_attr.replace('_', '-')}: {id}") if obj._repr_attr: value = getattr(obj, obj._repr_attr, "None") or "None" value = value.replace("\r", "").replace("\n", " ") # If the attribute is a note (ProjectCommitComment) then we do # some modifications to fit everything on one line line = f"{obj._repr_attr}: {value}" # ellipsize long lines (comments) if len(line) > 79: line = f"{line[:76]}..." print(line) def display_list( self, data: List[Union[str, gitlab.base.RESTObject]], fields: List[str], **kwargs: Any, ) -> None: verbose = kwargs.get("verbose", False) for obj in data: if isinstance(obj, gitlab.base.RESTObject): self.display(get_dict(obj, fields), verbose=verbose, obj=obj) else: print(obj) print("") PRINTERS: Dict[ str, Union[Type[JSONPrinter], Type[LegacyPrinter], Type[YAMLPrinter]] ] = { "json": JSONPrinter, "legacy": LegacyPrinter, "yaml": YAMLPrinter, } def run( gl: gitlab.Gitlab, gitlab_resource: str, resource_action: str, args: Dict[str, Any], verbose: bool, output: str, fields: List[str], ) -> None: g_cli = GitlabCLI( gl=gl, gitlab_resource=gitlab_resource, resource_action=resource_action, args=args, ) data = g_cli.run() printer: Union[JSONPrinter, LegacyPrinter, YAMLPrinter] = PRINTERS[output]() if isinstance(data, dict): printer.display(data, verbose=True, obj=data) elif isinstance(data, list): printer.display_list(data, fields, verbose=verbose) elif isinstance(data, gitlab.base.RESTObject): printer.display(get_dict(data, fields), verbose=verbose, obj=data) elif isinstance(data, str): print(data) elif isinstance(data, bytes): sys.stdout.buffer.write(data) elif hasattr(data, "decode"): print(data.decode()) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3107913 python-gitlab-3.13.0/gitlab/v4/objects/0000755000000000000000000000000014366036463016354 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/__init__.py0000644000000000000000000000352314366036457020473 0ustar00rootrootfrom .access_requests import * from .appearance import * from .applications import * from .artifacts import * from .audit_events import * from .award_emojis import * from .badges import * from .boards import * from .branches import * from .broadcast_messages import * from .bulk_imports import * from .ci_lint import * from .clusters import * from .commits import * from .container_registry import * from .custom_attributes import * from .deploy_keys import * from .deploy_tokens import * from .deployments import * from .discussions import * from .environments import * from .epics import * from .events import * from .export_import import * from .features import * from .files import * from .geo_nodes import * from .group_access_tokens import * from .groups import * from .hooks import * from .integrations import * from .invitations import * from .issues import * from .iterations import * from .jobs import * from .keys import * from .labels import * from .ldap import * from .members import * from .merge_request_approvals import * from .merge_requests import * from .merge_trains import * from .milestones import * from .namespaces import * from .notes import * from .notification_settings import * from .packages import * from .pages import * from .personal_access_tokens import * from .pipelines import * from .project_access_tokens import * from .projects import * from .push_rules import * from .releases import * from .repositories import * from .resource_groups import * from .runners import * from .secure_files import * from .settings import * from .sidekiq import * from .snippets import * from .statistics import * from .tags import * from .templates import * from .todos import * from .topics import * from .triggers import * from .users import * from .variables import * from .wikis import * __all__ = [name for name in dir() if not name.startswith("_")] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/access_requests.py0000644000000000000000000000163314366036457022130 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( AccessRequestMixin, CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, ) __all__ = [ "GroupAccessRequest", "GroupAccessRequestManager", "ProjectAccessRequest", "ProjectAccessRequestManager", ] class GroupAccessRequest(AccessRequestMixin, ObjectDeleteMixin, RESTObject): pass class GroupAccessRequestManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/access_requests" _obj_cls = GroupAccessRequest _from_parent_attrs = {"group_id": "id"} class ProjectAccessRequest(AccessRequestMixin, ObjectDeleteMixin, RESTObject): pass class ProjectAccessRequestManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/access_requests" _obj_cls = ProjectAccessRequest _from_parent_attrs = {"project_id": "id"} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/appearance.py0000644000000000000000000000361314366036457021033 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, Union from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import GetWithoutIdMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional __all__ = [ "ApplicationAppearance", "ApplicationAppearanceManager", ] class ApplicationAppearance(SaveMixin, RESTObject): _id_attr = None class ApplicationAppearanceManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/application/appearance" _obj_cls = ApplicationAppearance _update_attrs = RequiredOptional( optional=( "title", "description", "logo", "header_logo", "favicon", "new_project_guidelines", "header_message", "footer_message", "message_background_color", "message_font_color", "email_header_and_footer_enabled", ), ) @exc.on_http_error(exc.GitlabUpdateError) def update( self, id: Optional[Union[str, int]] = None, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> Dict[str, Any]: """Update an object on the server. Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object **kwargs: Extra options to send to the server (e.g. sudo) Returns: The new object data (*not* a RESTObject) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ new_data = new_data or {} data = new_data.copy() return super().update(id, data, **kwargs) def get(self, **kwargs: Any) -> ApplicationAppearance: return cast(ApplicationAppearance, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/applications.py0000644000000000000000000000111714366036457021417 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin from gitlab.types import RequiredOptional __all__ = [ "Application", "ApplicationManager", ] class Application(ObjectDeleteMixin, RESTObject): _url = "/applications" _repr_attr = "name" class ApplicationManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/applications" _obj_cls = Application _create_attrs = RequiredOptional( required=("name", "redirect_uri", "scopes"), optional=("confidential",) ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/artifacts.py0000644000000000000000000001313414366036457020713 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/job_artifacts.html """ from typing import Any, Callable, Iterator, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject __all__ = ["ProjectArtifact", "ProjectArtifactManager"] class ProjectArtifact(RESTObject): """Dummy object to manage custom actions on artifacts""" _id_attr = "ref_name" class ProjectArtifactManager(RESTManager): _obj_cls = ProjectArtifact _path = "/projects/{project_id}/jobs/artifacts" _from_parent_attrs = {"project_id": "id"} @cli.register_custom_action( "Project", ("ref_name", "job"), ("job_token",), custom_action="artifacts" ) def __call__( self, *args: Any, **kwargs: Any, ) -> Optional[bytes]: utils.warn( message=( "The project.artifacts() method is deprecated and will be removed in a " "future version. Use project.artifacts.download() instead.\n" ), category=DeprecationWarning, ) data = self.download( *args, **kwargs, ) if TYPE_CHECKING: assert data is not None assert isinstance(data, bytes) return data @exc.on_http_error(exc.GitlabDeleteError) def delete(self, **kwargs: Any) -> None: """Delete the project's artifacts on the server. Args: **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 """ path = self._compute_path("/projects/{project_id}/artifacts") if TYPE_CHECKING: assert path is not None self.gitlab.http_delete(path, **kwargs) @cli.register_custom_action( "ProjectArtifactManager", ("ref_name", "job"), ("job_token",) ) @exc.on_http_error(exc.GitlabGetError) def download( self, ref_name: str, job: str, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Get the job artifacts archive from a specific tag or branch. Args: ref_name: Branch or tag name in repository. HEAD or SHA references are not supported. job: The name of the job. job_token: Job token for multi-project pipeline triggers. streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The artifacts if `streamed` is False, None otherwise. """ path = f"{self.path}/{ref_name}/download" result = self.gitlab.http_get( path, job=job, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action( "ProjectArtifactManager", ("ref_name", "artifact_path", "job") ) @exc.on_http_error(exc.GitlabGetError) def raw( self, ref_name: str, artifact_path: str, job: str, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Download a single artifact file from a specific tag or branch from within the job's artifacts archive. Args: ref_name: Branch or tag name in repository. HEAD or SHA references are not supported. artifact_path: Path to a file inside the artifacts archive. job: The name of the job. streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The artifact if `streamed` is False, None otherwise. """ path = f"{self.path}/{ref_name}/raw/{artifact_path}" result = self.gitlab.http_get( path, streamed=streamed, raw=True, job=job, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/audit_events.py0000644000000000000000000000356514366036457021434 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/audit_events.html """ from typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import RetrieveMixin __all__ = [ "AuditEvent", "AuditEventManager", "GroupAuditEvent", "GroupAuditEventManager", "ProjectAuditEvent", "ProjectAuditEventManager", "ProjectAudit", "ProjectAuditManager", ] class AuditEvent(RESTObject): _id_attr = "id" class AuditEventManager(RetrieveMixin, RESTManager): _path = "/audit_events" _obj_cls = AuditEvent _list_filters = ("created_after", "created_before", "entity_type", "entity_id") def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> AuditEvent: return cast(AuditEvent, super().get(id=id, lazy=lazy, **kwargs)) class GroupAuditEvent(RESTObject): _id_attr = "id" class GroupAuditEventManager(RetrieveMixin, RESTManager): _path = "/groups/{group_id}/audit_events" _obj_cls = GroupAuditEvent _from_parent_attrs = {"group_id": "id"} _list_filters = ("created_after", "created_before") def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupAuditEvent: return cast(GroupAuditEvent, super().get(id=id, lazy=lazy, **kwargs)) class ProjectAuditEvent(RESTObject): _id_attr = "id" class ProjectAuditEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/audit_events" _obj_cls = ProjectAuditEvent _from_parent_attrs = {"project_id": "id"} _list_filters = ("created_after", "created_before") def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectAuditEvent: return cast(ProjectAuditEvent, super().get(id=id, lazy=lazy, **kwargs)) class ProjectAudit(ProjectAuditEvent): pass class ProjectAuditManager(ProjectAuditEventManager): pass ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/award_emojis.py0000644000000000000000000001337114366036457021402 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin from gitlab.types import RequiredOptional __all__ = [ "GroupEpicAwardEmoji", "GroupEpicAwardEmojiManager", "GroupEpicNoteAwardEmoji", "GroupEpicNoteAwardEmojiManager", "ProjectIssueAwardEmoji", "ProjectIssueAwardEmojiManager", "ProjectIssueNoteAwardEmoji", "ProjectIssueNoteAwardEmojiManager", "ProjectMergeRequestAwardEmoji", "ProjectMergeRequestAwardEmojiManager", "ProjectMergeRequestNoteAwardEmoji", "ProjectMergeRequestNoteAwardEmojiManager", "ProjectSnippetAwardEmoji", "ProjectSnippetAwardEmojiManager", "ProjectSnippetNoteAwardEmoji", "ProjectSnippetNoteAwardEmojiManager", ] class GroupEpicAwardEmoji(ObjectDeleteMixin, RESTObject): pass class GroupEpicAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/groups/{group_id}/epics/{epic_iid}/award_emoji" _obj_cls = GroupEpicAwardEmoji _from_parent_attrs = {"group_id": "group_id", "epic_iid": "iid"} _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupEpicAwardEmoji: return cast(GroupEpicAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)) class GroupEpicNoteAwardEmoji(ObjectDeleteMixin, RESTObject): pass class GroupEpicNoteAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/groups/{group_id}/epics/{epic_iid}/notes/{note_id}/award_emoji" _obj_cls = GroupEpicNoteAwardEmoji _from_parent_attrs = { "group_id": "group_id", "epic_iid": "epic_iid", "note_id": "id", } _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupEpicNoteAwardEmoji: return cast(GroupEpicNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)) class ProjectIssueAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectIssueAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/award_emoji" _obj_cls = ProjectIssueAwardEmoji _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueAwardEmoji: return cast(ProjectIssueAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)) class ProjectIssueNoteAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectIssueNoteAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/notes/{note_id}/award_emoji" _obj_cls = ProjectIssueNoteAwardEmoji _from_parent_attrs = { "project_id": "project_id", "issue_iid": "issue_iid", "note_id": "id", } _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueNoteAwardEmoji: return cast(ProjectIssueNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMergeRequestAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectMergeRequestAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/award_emoji" _obj_cls = ProjectMergeRequestAwardEmoji _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestAwardEmoji: return cast( ProjectMergeRequestAwardEmoji, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectMergeRequestNoteAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectMergeRequestNoteAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/notes/{note_id}/award_emoji" _obj_cls = ProjectMergeRequestNoteAwardEmoji _from_parent_attrs = { "project_id": "project_id", "mr_iid": "mr_iid", "note_id": "id", } _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestNoteAwardEmoji: return cast( ProjectMergeRequestNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectSnippetAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectSnippetAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/snippets/{snippet_id}/award_emoji" _obj_cls = ProjectSnippetAwardEmoji _from_parent_attrs = {"project_id": "project_id", "snippet_id": "id"} _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippetAwardEmoji: return cast(ProjectSnippetAwardEmoji, super().get(id=id, lazy=lazy, **kwargs)) class ProjectSnippetNoteAwardEmoji(ObjectDeleteMixin, RESTObject): pass class ProjectSnippetNoteAwardEmojiManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/snippets/{snippet_id}/notes/{note_id}/award_emoji" _obj_cls = ProjectSnippetNoteAwardEmoji _from_parent_attrs = { "project_id": "project_id", "snippet_id": "snippet_id", "note_id": "id", } _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippetNoteAwardEmoji: return cast( ProjectSnippetNoteAwardEmoji, super().get(id=id, lazy=lazy, **kwargs) ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/badges.py0000644000000000000000000000267014366036457020163 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import BadgeRenderMixin, CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "GroupBadge", "GroupBadgeManager", "ProjectBadge", "ProjectBadgeManager", ] class GroupBadge(SaveMixin, ObjectDeleteMixin, RESTObject): pass class GroupBadgeManager(BadgeRenderMixin, CRUDMixin, RESTManager): _path = "/groups/{group_id}/badges" _obj_cls = GroupBadge _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional(required=("link_url", "image_url")) _update_attrs = RequiredOptional(optional=("link_url", "image_url")) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupBadge: return cast(GroupBadge, super().get(id=id, lazy=lazy, **kwargs)) class ProjectBadge(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectBadgeManager(BadgeRenderMixin, CRUDMixin, RESTManager): _path = "/projects/{project_id}/badges" _obj_cls = ProjectBadge _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("link_url", "image_url")) _update_attrs = RequiredOptional(optional=("link_url", "image_url")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectBadge: return cast(ProjectBadge, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/boards.py0000644000000000000000000000517014366036457020206 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "GroupBoardList", "GroupBoardListManager", "GroupBoard", "GroupBoardManager", "ProjectBoardList", "ProjectBoardListManager", "ProjectBoard", "ProjectBoardManager", ] class GroupBoardList(SaveMixin, ObjectDeleteMixin, RESTObject): pass class GroupBoardListManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/boards/{board_id}/lists" _obj_cls = GroupBoardList _from_parent_attrs = {"group_id": "group_id", "board_id": "id"} _create_attrs = RequiredOptional( exclusive=("label_id", "assignee_id", "milestone_id") ) _update_attrs = RequiredOptional(required=("position",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupBoardList: return cast(GroupBoardList, super().get(id=id, lazy=lazy, **kwargs)) class GroupBoard(SaveMixin, ObjectDeleteMixin, RESTObject): lists: GroupBoardListManager class GroupBoardManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/boards" _obj_cls = GroupBoard _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional(required=("name",)) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupBoard: return cast(GroupBoard, super().get(id=id, lazy=lazy, **kwargs)) class ProjectBoardList(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectBoardListManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/boards/{board_id}/lists" _obj_cls = ProjectBoardList _from_parent_attrs = {"project_id": "project_id", "board_id": "id"} _create_attrs = RequiredOptional( exclusive=("label_id", "assignee_id", "milestone_id") ) _update_attrs = RequiredOptional(required=("position",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectBoardList: return cast(ProjectBoardList, super().get(id=id, lazy=lazy, **kwargs)) class ProjectBoard(SaveMixin, ObjectDeleteMixin, RESTObject): lists: ProjectBoardListManager class ProjectBoardManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/boards" _obj_cls = ProjectBoard _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("name",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectBoard: return cast(ProjectBoard, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/branches.py0000644000000000000000000000321214366036457020514 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin from gitlab.types import RequiredOptional __all__ = [ "ProjectBranch", "ProjectBranchManager", "ProjectProtectedBranch", "ProjectProtectedBranchManager", ] class ProjectBranch(ObjectDeleteMixin, RESTObject): _id_attr = "name" class ProjectBranchManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/repository/branches" _obj_cls = ProjectBranch _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("branch", "ref")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectBranch: return cast(ProjectBranch, super().get(id=id, lazy=lazy, **kwargs)) class ProjectProtectedBranch(ObjectDeleteMixin, RESTObject): _id_attr = "name" class ProjectProtectedBranchManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/protected_branches" _obj_cls = ProjectProtectedBranch _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name",), optional=( "push_access_level", "merge_access_level", "unprotect_access_level", "allowed_to_push", "allowed_to_merge", "allowed_to_unprotect", "code_owner_approval_required", ), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectProtectedBranch: return cast(ProjectProtectedBranch, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/broadcast_messages.py0000644000000000000000000000211714366036457022563 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "BroadcastMessage", "BroadcastMessageManager", ] class BroadcastMessage(SaveMixin, ObjectDeleteMixin, RESTObject): pass class BroadcastMessageManager(CRUDMixin, RESTManager): _path = "/broadcast_messages" _obj_cls = BroadcastMessage _create_attrs = RequiredOptional( required=("message",), optional=("starts_at", "ends_at", "color", "font", "target_access_levels"), ) _update_attrs = RequiredOptional( optional=( "message", "starts_at", "ends_at", "color", "font", "target_access_levels", ) ) _types = {"target_access_levels": ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> BroadcastMessage: return cast(BroadcastMessage, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/bulk_imports.py0000644000000000000000000000304514366036457021445 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, ListMixin, RefreshMixin, RetrieveMixin from gitlab.types import RequiredOptional __all__ = [ "BulkImport", "BulkImportManager", "BulkImportAllEntity", "BulkImportAllEntityManager", "BulkImportEntity", "BulkImportEntityManager", ] class BulkImport(RefreshMixin, RESTObject): entities: "BulkImportEntityManager" class BulkImportManager(CreateMixin, RetrieveMixin, RESTManager): _path = "/bulk_imports" _obj_cls = BulkImport _create_attrs = RequiredOptional(required=("configuration", "entities")) _list_filters = ("sort", "status") def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> BulkImport: return cast(BulkImport, super().get(id=id, lazy=lazy, **kwargs)) class BulkImportEntity(RefreshMixin, RESTObject): pass class BulkImportEntityManager(RetrieveMixin, RESTManager): _path = "/bulk_imports/{bulk_import_id}/entities" _obj_cls = BulkImportEntity _from_parent_attrs = {"bulk_import_id": "id"} _list_filters = ("sort", "status") def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> BulkImportEntity: return cast(BulkImportEntity, super().get(id=id, lazy=lazy, **kwargs)) class BulkImportAllEntity(RESTObject): pass class BulkImportAllEntityManager(ListMixin, RESTManager): _path = "/bulk_imports/entities" _obj_cls = BulkImportAllEntity _list_filters = ("sort", "status") ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/ci_lint.py0000644000000000000000000000424114366036457020353 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/lint.html """ from typing import Any, cast from gitlab.base import RESTManager, RESTObject from gitlab.cli import register_custom_action from gitlab.exceptions import GitlabCiLintError from gitlab.mixins import CreateMixin, GetWithoutIdMixin from gitlab.types import RequiredOptional __all__ = [ "CiLint", "CiLintManager", "ProjectCiLint", "ProjectCiLintManager", ] class CiLint(RESTObject): _id_attr = None class CiLintManager(CreateMixin, RESTManager): _path = "/ci/lint" _obj_cls = CiLint _create_attrs = RequiredOptional( required=("content",), optional=("include_merged_yaml", "include_jobs") ) @register_custom_action( "CiLintManager", ("content",), optional=("include_merged_yaml", "include_jobs"), ) def validate(self, *args: Any, **kwargs: Any) -> None: """Raise an error if the CI Lint results are not valid. This is a custom python-gitlab method to wrap lint endpoints.""" result = self.create(*args, **kwargs) if result.status != "valid": message = ",\n".join(result.errors) raise GitlabCiLintError(message) class ProjectCiLint(RESTObject): _id_attr = None class ProjectCiLintManager(GetWithoutIdMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/ci/lint" _obj_cls = ProjectCiLint _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("content",), optional=("dry_run", "include_jobs", "ref") ) def get(self, **kwargs: Any) -> ProjectCiLint: return cast(ProjectCiLint, super().get(**kwargs)) @register_custom_action( "ProjectCiLintManager", ("content",), optional=("dry_run", "include_jobs", "ref"), ) def validate(self, *args: Any, **kwargs: Any) -> None: """Raise an error if the Project CI Lint results are not valid. This is a custom python-gitlab method to wrap lint endpoints.""" result = self.create(*args, **kwargs) if not result.valid: message = ",\n".join(result.errors) raise GitlabCiLintError(message) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/clusters.py0000644000000000000000000000724614366036457020606 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, Union from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "GroupCluster", "GroupClusterManager", "ProjectCluster", "ProjectClusterManager", ] class GroupCluster(SaveMixin, ObjectDeleteMixin, RESTObject): pass class GroupClusterManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/clusters" _obj_cls = GroupCluster _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("name", "platform_kubernetes_attributes"), optional=("domain", "enabled", "managed", "environment_scope"), ) _update_attrs = RequiredOptional( optional=( "name", "domain", "management_project_id", "platform_kubernetes_attributes", "environment_scope", ), ) @exc.on_http_error(exc.GitlabStopError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> GroupCluster: """Create a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo or 'ref_name', 'stage', 'name', 'all') Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the manage object class build with the data sent by the server """ path = f"{self.path}/user" return cast(GroupCluster, CreateMixin.create(self, data, path=path, **kwargs)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupCluster: return cast(GroupCluster, super().get(id=id, lazy=lazy, **kwargs)) class ProjectCluster(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectClusterManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/clusters" _obj_cls = ProjectCluster _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name", "platform_kubernetes_attributes"), optional=("domain", "enabled", "managed", "environment_scope"), ) _update_attrs = RequiredOptional( optional=( "name", "domain", "management_project_id", "platform_kubernetes_attributes", "environment_scope", ), ) @exc.on_http_error(exc.GitlabStopError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> ProjectCluster: """Create a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo or 'ref_name', 'stage', 'name', 'all') Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the manage object class build with the data sent by the server """ path = f"{self.path}/user" return cast(ProjectCluster, CreateMixin.create(self, data, path=path, **kwargs)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectCluster: return cast(ProjectCluster, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/commits.py0000644000000000000000000002000714366036457020403 0ustar00rootrootfrom typing import Any, cast, Dict, List, Optional, TYPE_CHECKING, Union import requests import gitlab from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, ListMixin, RefreshMixin, RetrieveMixin from gitlab.types import RequiredOptional from .discussions import ProjectCommitDiscussionManager # noqa: F401 __all__ = [ "ProjectCommit", "ProjectCommitManager", "ProjectCommitComment", "ProjectCommitCommentManager", "ProjectCommitStatus", "ProjectCommitStatusManager", ] class ProjectCommit(RESTObject): _repr_attr = "title" comments: "ProjectCommitCommentManager" discussions: ProjectCommitDiscussionManager statuses: "ProjectCommitStatusManager" @cli.register_custom_action("ProjectCommit") @exc.on_http_error(exc.GitlabGetError) def diff(self, **kwargs: Any) -> Union[gitlab.GitlabList, List[Dict[str, Any]]]: """Generate the commit diff. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the diff could not be retrieved Returns: The changes done in this commit """ path = f"{self.manager.path}/{self.encoded_id}/diff" return self.manager.gitlab.http_list(path, **kwargs) @cli.register_custom_action("ProjectCommit", ("branch",)) @exc.on_http_error(exc.GitlabCherryPickError) def cherry_pick(self, branch: str, **kwargs: Any) -> None: """Cherry-pick a commit into a branch. Args: branch: Name of target branch **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCherryPickError: If the cherry-pick could not be performed """ path = f"{self.manager.path}/{self.encoded_id}/cherry_pick" post_data = {"branch": branch} self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) @cli.register_custom_action("ProjectCommit", optional=("type",)) @exc.on_http_error(exc.GitlabGetError) def refs( self, type: str = "all", **kwargs: Any ) -> Union[gitlab.GitlabList, List[Dict[str, Any]]]: """List the references the commit is pushed to. Args: type: The scope of references ('branch', 'tag' or 'all') **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the references could not be retrieved Returns: The references the commit is pushed to. """ path = f"{self.manager.path}/{self.encoded_id}/refs" query_data = {"type": type} return self.manager.gitlab.http_list(path, query_data=query_data, **kwargs) @cli.register_custom_action("ProjectCommit") @exc.on_http_error(exc.GitlabGetError) def merge_requests( self, **kwargs: Any ) -> Union[gitlab.GitlabList, List[Dict[str, Any]]]: """List the merge requests related to the commit. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the references could not be retrieved Returns: The merge requests related to the commit. """ path = f"{self.manager.path}/{self.encoded_id}/merge_requests" return self.manager.gitlab.http_list(path, **kwargs) @cli.register_custom_action("ProjectCommit", ("branch",)) @exc.on_http_error(exc.GitlabRevertError) def revert( self, branch: str, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Revert a commit on a given branch. Args: branch: Name of target branch **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabRevertError: If the revert could not be performed Returns: The new commit data (*not* a RESTObject) """ path = f"{self.manager.path}/{self.encoded_id}/revert" post_data = {"branch": branch} return self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) @cli.register_custom_action("ProjectCommit") @exc.on_http_error(exc.GitlabGetError) def signature(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Get the signature of the commit. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the signature could not be retrieved Returns: The commit's signature data """ path = f"{self.manager.path}/{self.encoded_id}/signature" return self.manager.gitlab.http_get(path, **kwargs) class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/repository/commits" _obj_cls = ProjectCommit _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("branch", "commit_message", "actions"), optional=("author_email", "author_name"), ) _list_filters = ( "ref_name", "since", "until", "path", "with_stats", "first_parent", "order", "trailers", ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectCommit: return cast(ProjectCommit, super().get(id=id, lazy=lazy, **kwargs)) class ProjectCommitComment(RESTObject): _id_attr = None _repr_attr = "note" class ProjectCommitCommentManager(ListMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/repository/commits/{commit_id}/comments" _obj_cls = ProjectCommitComment _from_parent_attrs = {"project_id": "project_id", "commit_id": "id"} _create_attrs = RequiredOptional( required=("note",), optional=("path", "line", "line_type") ) class ProjectCommitStatus(RefreshMixin, RESTObject): pass class ProjectCommitStatusManager(ListMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/repository/commits/{commit_id}/statuses" _obj_cls = ProjectCommitStatus _from_parent_attrs = {"project_id": "project_id", "commit_id": "id"} _create_attrs = RequiredOptional( required=("state",), optional=("description", "name", "context", "ref", "target_url", "coverage"), ) @exc.on_http_error(exc.GitlabCreateError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> ProjectCommitStatus: """Create a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo or 'ref_name', 'stage', 'name', 'all') Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the manage object class build with the data sent by the server """ # project_id and commit_id are in the data dict when using the CLI, but # they are missing when using only the API # See #511 base_path = "/projects/{project_id}/statuses/{commit_id}" path: Optional[str] if data is not None and "project_id" in data and "commit_id" in data: path = base_path.format(**data) else: path = self._compute_path(base_path) if TYPE_CHECKING: assert path is not None return cast( ProjectCommitStatus, CreateMixin.create(self, data, path=path, **kwargs) ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/container_registry.py0000644000000000000000000000641514366036457022651 0ustar00rootrootfrom typing import Any, cast, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( DeleteMixin, GetMixin, ListMixin, ObjectDeleteMixin, RetrieveMixin, ) __all__ = [ "GroupRegistryRepositoryManager", "ProjectRegistryRepository", "ProjectRegistryRepositoryManager", "ProjectRegistryTag", "ProjectRegistryTagManager", "RegistryRepository", "RegistryRepositoryManager", ] class ProjectRegistryRepository(ObjectDeleteMixin, RESTObject): tags: "ProjectRegistryTagManager" class ProjectRegistryRepositoryManager(DeleteMixin, ListMixin, RESTManager): _path = "/projects/{project_id}/registry/repositories" _obj_cls = ProjectRegistryRepository _from_parent_attrs = {"project_id": "id"} class ProjectRegistryTag(ObjectDeleteMixin, RESTObject): _id_attr = "name" class ProjectRegistryTagManager(DeleteMixin, RetrieveMixin, RESTManager): _obj_cls = ProjectRegistryTag _from_parent_attrs = {"project_id": "project_id", "repository_id": "id"} _path = "/projects/{project_id}/registry/repositories/{repository_id}/tags" @cli.register_custom_action( "ProjectRegistryTagManager", ("name_regex_delete",), optional=("keep_n", "name_regex_keep", "older_than"), ) @exc.on_http_error(exc.GitlabDeleteError) def delete_in_bulk(self, name_regex_delete: str, **kwargs: Any) -> None: """Delete Tag in bulk Args: name_regex_delete: The regex of the name to delete. To delete all tags specify .*. keep_n: The amount of latest tags of given name to keep. name_regex_keep: The regex of the name to keep. This value overrides any matches from name_regex. older_than: Tags to delete that are older than the given time, written in human readable form 1h, 1d, 1month. **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 """ valid_attrs = ["keep_n", "name_regex_keep", "older_than"] data = {"name_regex_delete": name_regex_delete} data.update({k: v for k, v in kwargs.items() if k in valid_attrs}) if TYPE_CHECKING: assert self.path is not None self.gitlab.http_delete(self.path, query_data=data, **kwargs) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectRegistryTag: return cast(ProjectRegistryTag, super().get(id=id, lazy=lazy, **kwargs)) class GroupRegistryRepositoryManager(ListMixin, RESTManager): _path = "/groups/{group_id}/registry/repositories" _obj_cls = ProjectRegistryRepository _from_parent_attrs = {"group_id": "id"} class RegistryRepository(RESTObject): _repr_attr = "path" class RegistryRepositoryManager(GetMixin, RESTManager): _path = "/registry/repositories" _obj_cls = RegistryRepository def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> RegistryRepository: return cast(RegistryRepository, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/custom_attributes.py0000644000000000000000000000352314366036457022514 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import DeleteMixin, ObjectDeleteMixin, RetrieveMixin, SetMixin __all__ = [ "GroupCustomAttribute", "GroupCustomAttributeManager", "ProjectCustomAttribute", "ProjectCustomAttributeManager", "UserCustomAttribute", "UserCustomAttributeManager", ] class GroupCustomAttribute(ObjectDeleteMixin, RESTObject): _id_attr = "key" class GroupCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/custom_attributes" _obj_cls = GroupCustomAttribute _from_parent_attrs = {"group_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupCustomAttribute: return cast(GroupCustomAttribute, super().get(id=id, lazy=lazy, **kwargs)) class ProjectCustomAttribute(ObjectDeleteMixin, RESTObject): _id_attr = "key" class ProjectCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/custom_attributes" _obj_cls = ProjectCustomAttribute _from_parent_attrs = {"project_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectCustomAttribute: return cast(ProjectCustomAttribute, super().get(id=id, lazy=lazy, **kwargs)) class UserCustomAttribute(ObjectDeleteMixin, RESTObject): _id_attr = "key" class UserCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin, RESTManager): _path = "/users/{user_id}/custom_attributes" _obj_cls = UserCustomAttribute _from_parent_attrs = {"user_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> UserCustomAttribute: return cast(UserCustomAttribute, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/deploy_keys.py0000644000000000000000000000344214366036457021263 0ustar00rootrootfrom typing import Any, cast, Dict, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ListMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "DeployKey", "DeployKeyManager", "ProjectKey", "ProjectKeyManager", ] class DeployKey(RESTObject): pass class DeployKeyManager(ListMixin, RESTManager): _path = "/deploy_keys" _obj_cls = DeployKey class ProjectKey(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectKeyManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/deploy_keys" _obj_cls = ProjectKey _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("title", "key"), optional=("can_push",)) _update_attrs = RequiredOptional(optional=("title", "can_push")) @cli.register_custom_action("ProjectKeyManager", ("key_id",)) @exc.on_http_error(exc.GitlabProjectDeployKeyError) def enable( self, key_id: int, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Enable a deploy key for a project. Args: key_id: The ID of the key to enable **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabProjectDeployKeyError: If the key could not be enabled Returns: A dict of the result. """ path = f"{self.path}/{key_id}/enable" return self.gitlab.http_post(path, **kwargs) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectKey: return cast(ProjectKey, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/deploy_tokens.py0000644000000000000000000000407614366036457021617 0ustar00rootrootfrom typing import Any, cast, Union from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, RetrieveMixin, ) from gitlab.types import RequiredOptional __all__ = [ "DeployToken", "DeployTokenManager", "GroupDeployToken", "GroupDeployTokenManager", "ProjectDeployToken", "ProjectDeployTokenManager", ] class DeployToken(ObjectDeleteMixin, RESTObject): pass class DeployTokenManager(ListMixin, RESTManager): _path = "/deploy_tokens" _obj_cls = DeployToken class GroupDeployToken(ObjectDeleteMixin, RESTObject): pass class GroupDeployTokenManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/deploy_tokens" _from_parent_attrs = {"group_id": "id"} _obj_cls = GroupDeployToken _create_attrs = RequiredOptional( required=( "name", "scopes", ), optional=( "expires_at", "username", ), ) _list_filters = ("scopes",) _types = {"scopes": types.ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupDeployToken: return cast(GroupDeployToken, super().get(id=id, lazy=lazy, **kwargs)) class ProjectDeployToken(ObjectDeleteMixin, RESTObject): pass class ProjectDeployTokenManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/deploy_tokens" _from_parent_attrs = {"project_id": "id"} _obj_cls = ProjectDeployToken _create_attrs = RequiredOptional( required=( "name", "scopes", ), optional=( "expires_at", "username", ), ) _list_filters = ("scopes",) _types = {"scopes": types.ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectDeployToken: return cast(ProjectDeployToken, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/deployments.py0000644000000000000000000000547714366036457021311 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/deployments.html """ from typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, RetrieveMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional from .merge_requests import ProjectDeploymentMergeRequestManager # noqa: F401 __all__ = [ "ProjectDeployment", "ProjectDeploymentManager", ] class ProjectDeployment(SaveMixin, RESTObject): mergerequests: ProjectDeploymentMergeRequestManager @cli.register_custom_action( "ProjectDeployment", mandatory=("status",), optional=("comment", "represented_as"), ) @exc.on_http_error(exc.GitlabDeploymentApprovalError) def approval( self, status: str, comment: Optional[str] = None, represented_as: Optional[str] = None, **kwargs: Any, ) -> Dict[str, Any]: """Approve or reject a blocked deployment. Args: status: Either "approved" or "rejected" comment: A comment to go with the approval represented_as: The name of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRApprovalError: If the approval failed Returns: A dict containing the result. https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment """ path = f"{self.manager.path}/{self.encoded_id}/approval" data = {"status": status} if comment is not None: data["comment"] = comment if represented_as is not None: data["represented_as"] = represented_as server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return server_data class ProjectDeploymentManager(RetrieveMixin, CreateMixin, UpdateMixin, RESTManager): _path = "/projects/{project_id}/deployments" _obj_cls = ProjectDeployment _from_parent_attrs = {"project_id": "id"} _list_filters = ( "order_by", "sort", "updated_after", "updated_before", "environment", "status", ) _create_attrs = RequiredOptional( required=("sha", "ref", "tag", "status", "environment") ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectDeployment: return cast(ProjectDeployment, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/discussions.py0000644000000000000000000000660114366036457021302 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, RetrieveMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional from .notes import ( # noqa: F401 ProjectCommitDiscussionNoteManager, ProjectIssueDiscussionNoteManager, ProjectMergeRequestDiscussionNoteManager, ProjectSnippetDiscussionNoteManager, ) __all__ = [ "ProjectCommitDiscussion", "ProjectCommitDiscussionManager", "ProjectIssueDiscussion", "ProjectIssueDiscussionManager", "ProjectMergeRequestDiscussion", "ProjectMergeRequestDiscussionManager", "ProjectSnippetDiscussion", "ProjectSnippetDiscussionManager", ] class ProjectCommitDiscussion(RESTObject): notes: ProjectCommitDiscussionNoteManager class ProjectCommitDiscussionManager(RetrieveMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/repository/commits/{commit_id}/discussions" _obj_cls = ProjectCommitDiscussion _from_parent_attrs = {"project_id": "project_id", "commit_id": "id"} _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectCommitDiscussion: return cast(ProjectCommitDiscussion, super().get(id=id, lazy=lazy, **kwargs)) class ProjectIssueDiscussion(RESTObject): notes: ProjectIssueDiscussionNoteManager class ProjectIssueDiscussionManager(RetrieveMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/discussions" _obj_cls = ProjectIssueDiscussion _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueDiscussion: return cast(ProjectIssueDiscussion, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMergeRequestDiscussion(SaveMixin, RESTObject): notes: ProjectMergeRequestDiscussionNoteManager class ProjectMergeRequestDiscussionManager( RetrieveMixin, CreateMixin, UpdateMixin, RESTManager ): _path = "/projects/{project_id}/merge_requests/{mr_iid}/discussions" _obj_cls = ProjectMergeRequestDiscussion _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} _create_attrs = RequiredOptional( required=("body",), optional=("created_at", "position") ) _update_attrs = RequiredOptional(required=("resolved",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestDiscussion: return cast( ProjectMergeRequestDiscussion, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectSnippetDiscussion(RESTObject): notes: ProjectSnippetDiscussionNoteManager class ProjectSnippetDiscussionManager(RetrieveMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/snippets/{snippet_id}/discussions" _obj_cls = ProjectSnippetDiscussion _from_parent_attrs = {"project_id": "project_id", "snippet_id": "id"} _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippetDiscussion: return cast(ProjectSnippetDiscussion, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/environments.py0000644000000000000000000000524614366036457021467 0ustar00rootrootfrom typing import Any, cast, Dict, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, DeleteMixin, ObjectDeleteMixin, RetrieveMixin, SaveMixin, UpdateMixin, ) from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "ProjectEnvironment", "ProjectEnvironmentManager", "ProjectProtectedEnvironment", "ProjectProtectedEnvironmentManager", ] class ProjectEnvironment(SaveMixin, ObjectDeleteMixin, RESTObject): @cli.register_custom_action("ProjectEnvironment") @exc.on_http_error(exc.GitlabStopError) def stop(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Stop the environment. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabStopError: If the operation failed Returns: A dict of the result. """ path = f"{self.manager.path}/{self.encoded_id}/stop" return self.manager.gitlab.http_post(path, **kwargs) class ProjectEnvironmentManager( RetrieveMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/environments" _obj_cls = ProjectEnvironment _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("name",), optional=("external_url",)) _update_attrs = RequiredOptional(optional=("name", "external_url")) _list_filters = ("name", "search", "states") def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectEnvironment: return cast(ProjectEnvironment, super().get(id=id, lazy=lazy, **kwargs)) class ProjectProtectedEnvironment(ObjectDeleteMixin, RESTObject): _id_attr = "name" _repr_attr = "name" class ProjectProtectedEnvironmentManager( RetrieveMixin, CreateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/protected_environments" _obj_cls = ProjectProtectedEnvironment _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=( "name", "deploy_access_levels", ), optional=("required_approval_count", "approval_rules"), ) _types = {"deploy_access_levels": ArrayAttribute, "approval_rules": ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectProtectedEnvironment: return cast( ProjectProtectedEnvironment, super().get(id=id, lazy=lazy, **kwargs) ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/epics.py0000644000000000000000000001006614366036457020037 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional from .events import GroupEpicResourceLabelEventManager # noqa: F401 from .notes import GroupEpicNoteManager # noqa: F401 __all__ = [ "GroupEpic", "GroupEpicManager", "GroupEpicIssue", "GroupEpicIssueManager", ] class GroupEpic(ObjectDeleteMixin, SaveMixin, RESTObject): _id_attr = "iid" issues: "GroupEpicIssueManager" resourcelabelevents: GroupEpicResourceLabelEventManager notes: GroupEpicNoteManager class GroupEpicManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/epics" _obj_cls = GroupEpic _from_parent_attrs = {"group_id": "id"} _list_filters = ("author_id", "labels", "order_by", "sort", "search") _create_attrs = RequiredOptional( required=("title",), optional=("labels", "description", "start_date", "end_date"), ) _update_attrs = RequiredOptional( optional=("title", "labels", "description", "start_date", "end_date"), ) _types = {"labels": types.CommaSeparatedListAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupEpic: return cast(GroupEpic, super().get(id=id, lazy=lazy, **kwargs)) class GroupEpicIssue(ObjectDeleteMixin, SaveMixin, RESTObject): _id_attr = "epic_issue_id" # Define type for 'manager' here So mypy won't complain about # 'self.manager.update()' call in the 'save' method. manager: "GroupEpicIssueManager" def save(self, **kwargs: Any) -> None: """Save the changes made to the object to the server. The object is updated to match what the server returns. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raise: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ updated_data = self._get_updated_data() # Nothing to update. Server fails if sent an empty dict. if not updated_data: return # call the manager obj_id = self.encoded_id self.manager.update(obj_id, updated_data, **kwargs) class GroupEpicIssueManager( ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/groups/{group_id}/epics/{epic_iid}/issues" _obj_cls = GroupEpicIssue _from_parent_attrs = {"group_id": "group_id", "epic_iid": "iid"} _create_attrs = RequiredOptional(required=("issue_id",)) _update_attrs = RequiredOptional(optional=("move_before_id", "move_after_id")) @exc.on_http_error(exc.GitlabCreateError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> GroupEpicIssue: """Create a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the manage object class build with the data sent by the server """ if TYPE_CHECKING: assert data is not None self._create_attrs.validate_attrs(data=data) path = f"{self.path}/{data.pop('issue_id')}" server_data = self.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) # The epic_issue_id attribute doesn't exist when creating the resource, # but is used everywhere elese. Let's create it to be consistent client # side server_data["epic_issue_id"] = server_data["id"] return self._obj_cls(self, server_data) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/events.py0000644000000000000000000001437214366036457020244 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ListMixin, RetrieveMixin __all__ = [ "Event", "EventManager", "GroupEpicResourceLabelEvent", "GroupEpicResourceLabelEventManager", "ProjectEvent", "ProjectEventManager", "ProjectIssueResourceLabelEvent", "ProjectIssueResourceLabelEventManager", "ProjectIssueResourceMilestoneEvent", "ProjectIssueResourceMilestoneEventManager", "ProjectIssueResourceStateEvent", "ProjectIssueResourceIterationEventManager", "ProjectIssueResourceIterationEvent", "ProjectIssueResourceStateEventManager", "ProjectMergeRequestResourceLabelEvent", "ProjectMergeRequestResourceLabelEventManager", "ProjectMergeRequestResourceMilestoneEvent", "ProjectMergeRequestResourceMilestoneEventManager", "ProjectMergeRequestResourceStateEvent", "ProjectMergeRequestResourceStateEventManager", "UserEvent", "UserEventManager", ] class Event(RESTObject): _id_attr = None _repr_attr = "target_title" class EventManager(ListMixin, RESTManager): _path = "/events" _obj_cls = Event _list_filters = ("action", "target_type", "before", "after", "sort") class GroupEpicResourceLabelEvent(RESTObject): pass class GroupEpicResourceLabelEventManager(RetrieveMixin, RESTManager): _path = "/groups/{group_id}/epics/{epic_id}/resource_label_events" _obj_cls = GroupEpicResourceLabelEvent _from_parent_attrs = {"group_id": "group_id", "epic_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupEpicResourceLabelEvent: return cast( GroupEpicResourceLabelEvent, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectEvent(Event): pass class ProjectEventManager(EventManager): _path = "/projects/{project_id}/events" _obj_cls = ProjectEvent _from_parent_attrs = {"project_id": "id"} class ProjectIssueResourceLabelEvent(RESTObject): pass class ProjectIssueResourceLabelEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/resource_label_events" _obj_cls = ProjectIssueResourceLabelEvent _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueResourceLabelEvent: return cast( ProjectIssueResourceLabelEvent, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectIssueResourceMilestoneEvent(RESTObject): pass class ProjectIssueResourceMilestoneEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/resource_milestone_events" _obj_cls = ProjectIssueResourceMilestoneEvent _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueResourceMilestoneEvent: return cast( ProjectIssueResourceMilestoneEvent, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectIssueResourceStateEvent(RESTObject): pass class ProjectIssueResourceStateEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/resource_state_events" _obj_cls = ProjectIssueResourceStateEvent _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueResourceStateEvent: return cast( ProjectIssueResourceStateEvent, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectIssueResourceIterationEvent(RESTObject): pass class ProjectIssueResourceIterationEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/resource_iteration_events" _obj_cls = ProjectIssueResourceIterationEvent _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueResourceIterationEvent: return cast( ProjectIssueResourceIterationEvent, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectMergeRequestResourceLabelEvent(RESTObject): pass class ProjectMergeRequestResourceLabelEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/resource_label_events" _obj_cls = ProjectMergeRequestResourceLabelEvent _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestResourceLabelEvent: return cast( ProjectMergeRequestResourceLabelEvent, super().get(id=id, lazy=lazy, **kwargs), ) class ProjectMergeRequestResourceMilestoneEvent(RESTObject): pass class ProjectMergeRequestResourceMilestoneEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/resource_milestone_events" _obj_cls = ProjectMergeRequestResourceMilestoneEvent _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestResourceMilestoneEvent: return cast( ProjectMergeRequestResourceMilestoneEvent, super().get(id=id, lazy=lazy, **kwargs), ) class ProjectMergeRequestResourceStateEvent(RESTObject): pass class ProjectMergeRequestResourceStateEventManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/resource_state_events" _obj_cls = ProjectMergeRequestResourceStateEvent _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestResourceStateEvent: return cast( ProjectMergeRequestResourceStateEvent, super().get(id=id, lazy=lazy, **kwargs), ) class UserEvent(Event): pass class UserEventManager(EventManager): _path = "/users/{user_id}/events" _obj_cls = UserEvent _from_parent_attrs = {"user_id": "id"} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/export_import.py0000644000000000000000000000356514366036457021655 0ustar00rootrootfrom typing import Any, cast from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, DownloadMixin, GetWithoutIdMixin, RefreshMixin from gitlab.types import RequiredOptional __all__ = [ "GroupExport", "GroupExportManager", "GroupImport", "GroupImportManager", "ProjectExport", "ProjectExportManager", "ProjectImport", "ProjectImportManager", ] class GroupExport(DownloadMixin, RESTObject): _id_attr = None class GroupExportManager(GetWithoutIdMixin, CreateMixin, RESTManager): _path = "/groups/{group_id}/export" _obj_cls = GroupExport _from_parent_attrs = {"group_id": "id"} def get(self, **kwargs: Any) -> GroupExport: return cast(GroupExport, super().get(**kwargs)) class GroupImport(RESTObject): _id_attr = None class GroupImportManager(GetWithoutIdMixin, RESTManager): _path = "/groups/{group_id}/import" _obj_cls = GroupImport _from_parent_attrs = {"group_id": "id"} def get(self, **kwargs: Any) -> GroupImport: return cast(GroupImport, super().get(**kwargs)) class ProjectExport(DownloadMixin, RefreshMixin, RESTObject): _id_attr = None class ProjectExportManager(GetWithoutIdMixin, CreateMixin, RESTManager): _path = "/projects/{project_id}/export" _obj_cls = ProjectExport _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(optional=("description",)) def get(self, **kwargs: Any) -> ProjectExport: return cast(ProjectExport, super().get(**kwargs)) class ProjectImport(RefreshMixin, RESTObject): _id_attr = None class ProjectImportManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/import" _obj_cls = ProjectImport _from_parent_attrs = {"project_id": "id"} def get(self, **kwargs: Any) -> ProjectImport: return cast(ProjectImport, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/features.py0000644000000000000000000000366414366036457020560 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/features.html """ from typing import Any, Optional, TYPE_CHECKING, Union from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import DeleteMixin, ListMixin, ObjectDeleteMixin __all__ = [ "Feature", "FeatureManager", ] class Feature(ObjectDeleteMixin, RESTObject): _id_attr = "name" class FeatureManager(ListMixin, DeleteMixin, RESTManager): _path = "/features/" _obj_cls = Feature @exc.on_http_error(exc.GitlabSetError) def set( self, name: str, value: Union[bool, int], feature_group: Optional[str] = None, user: Optional[str] = None, group: Optional[str] = None, project: Optional[str] = None, **kwargs: Any, ) -> Feature: """Create or update the object. Args: name: The value to set for the object value: The value to set for the object feature_group: A feature group name user: A GitLab username group: A GitLab group project: A GitLab project in form group/project **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabSetError: If an error occurred Returns: The created/updated attribute """ name = utils.EncodedId(name) path = f"{self.path}/{name}" data = { "value": value, "feature_group": feature_group, "user": user, "group": group, "project": project, } data = utils.remove_none_from_dict(data) server_data = self.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return self._obj_cls(self, server_data) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/files.py0000644000000000000000000002405214366036457020036 0ustar00rootrootimport base64 from typing import ( Any, Callable, cast, Dict, Iterator, List, Optional, TYPE_CHECKING, Union, ) import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, DeleteMixin, GetMixin, ObjectDeleteMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "ProjectFile", "ProjectFileManager", ] class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "file_path" _repr_attr = "file_path" branch: str commit_message: str file_path: str manager: "ProjectFileManager" def decode(self) -> bytes: """Returns the decoded content of the file. Returns: The decoded content. """ return base64.b64decode(self.content) # NOTE(jlvillal): Signature doesn't match SaveMixin.save() so ignore # type error def save( # type: ignore self, branch: str, commit_message: str, **kwargs: Any ) -> None: """Save the changes made to the file to the server. The object is updated to match what the server returns. Args: branch: Branch in which the file will be updated commit_message: Message to send with the commit **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ self.branch = branch self.commit_message = commit_message self.file_path = utils.EncodedId(self.file_path) super().save(**kwargs) @exc.on_http_error(exc.GitlabDeleteError) # NOTE(jlvillal): Signature doesn't match DeleteMixin.delete() so ignore # type error def delete( # type: ignore self, branch: str, commit_message: str, **kwargs: Any ) -> None: """Delete the file from the server. Args: branch: Branch from which the file will be removed commit_message: Commit message for the deletion **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 """ file_path = self.encoded_id if TYPE_CHECKING: assert isinstance(file_path, str) self.manager.delete(file_path, branch, commit_message, **kwargs) class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/repository/files" _obj_cls = ProjectFile _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("file_path", "branch", "content", "commit_message"), optional=("encoding", "author_email", "author_name"), ) _update_attrs = RequiredOptional( required=("file_path", "branch", "content", "commit_message"), optional=("encoding", "author_email", "author_name"), ) @cli.register_custom_action("ProjectFileManager", ("file_path", "ref")) # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore # type error def get( # type: ignore self, file_path: str, ref: str, **kwargs: Any ) -> ProjectFile: """Retrieve a single file. Args: file_path: Path of the file to retrieve ref: Name of the branch, tag or commit **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the file could not be retrieved Returns: The generated RESTObject """ return cast(ProjectFile, GetMixin.get(self, file_path, ref=ref, **kwargs)) @cli.register_custom_action( "ProjectFileManager", ("file_path", "branch", "content", "commit_message"), ("encoding", "author_email", "author_name"), ) @exc.on_http_error(exc.GitlabCreateError) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> ProjectFile: """Create a new object. Args: data: parameters to send to the server to create the resource **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 Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request """ if TYPE_CHECKING: assert data is not None self._create_attrs.validate_attrs(data=data) new_data = data.copy() file_path = utils.EncodedId(new_data.pop("file_path")) path = f"{self.path}/{file_path}" server_data = self.gitlab.http_post(path, post_data=new_data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return self._obj_cls(self, server_data) @exc.on_http_error(exc.GitlabUpdateError) # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore # type error def update( # type: ignore self, file_path: str, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> Dict[str, Any]: """Update an object on the server. Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object **kwargs: Extra options to send to the server (e.g. sudo) Returns: The new object data (*not* a RESTObject) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ new_data = new_data or {} data = new_data.copy() file_path = utils.EncodedId(file_path) data["file_path"] = file_path path = f"{self.path}/{file_path}" self._update_attrs.validate_attrs(data=data) result = self.gitlab.http_put(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result @cli.register_custom_action( "ProjectFileManager", ("file_path", "branch", "commit_message") ) @exc.on_http_error(exc.GitlabDeleteError) # NOTE(jlvillal): Signature doesn't match DeleteMixin.delete() so ignore # type error def delete( # type: ignore self, file_path: str, branch: str, commit_message: str, **kwargs: Any ) -> None: """Delete a file on the server. Args: file_path: Path of the file to remove branch: Branch from which the file will be removed commit_message: Commit message for the deletion **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 """ file_path = utils.EncodedId(file_path) path = f"{self.path}/{file_path}" data = {"branch": branch, "commit_message": commit_message} self.gitlab.http_delete(path, query_data=data, **kwargs) @cli.register_custom_action("ProjectFileManager", ("file_path", "ref")) @exc.on_http_error(exc.GitlabGetError) def raw( self, file_path: str, ref: str, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return the content of a file for a commit. Args: ref: ID of the commit filepath: Path of the file to return streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 file could not be retrieved Returns: The file content """ file_path = utils.EncodedId(file_path) path = f"{self.path}/{file_path}/raw" query_data = {"ref": ref} result = self.gitlab.http_get( path, query_data=query_data, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("ProjectFileManager", ("file_path", "ref")) @exc.on_http_error(exc.GitlabListError) def blame(self, file_path: str, ref: str, **kwargs: Any) -> List[Dict[str, Any]]: """Return the content of a file for a commit. Args: file_path: Path of the file to retrieve ref: Name of the branch, tag or commit **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server failed to perform the request Returns: A list of commits/lines matching the file """ file_path = utils.EncodedId(file_path) path = f"{self.path}/{file_path}/blame" query_data = {"ref": ref} result = self.gitlab.http_list(path, query_data, **kwargs) if TYPE_CHECKING: assert isinstance(result, list) return result ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/geo_nodes.py0000644000000000000000000000707614366036457020705 0ustar00rootrootfrom typing import Any, cast, Dict, List, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( DeleteMixin, ObjectDeleteMixin, RetrieveMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "GeoNode", "GeoNodeManager", ] class GeoNode(SaveMixin, ObjectDeleteMixin, RESTObject): @cli.register_custom_action("GeoNode") @exc.on_http_error(exc.GitlabRepairError) def repair(self, **kwargs: Any) -> None: """Repair the OAuth authentication of the geo node. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabRepairError: If the server failed to perform the request """ path = f"/geo_nodes/{self.encoded_id}/repair" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("GeoNode") @exc.on_http_error(exc.GitlabGetError) def status(self, **kwargs: Any) -> Dict[str, Any]: """Get the status of the geo node. Args: **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 status of the geo node """ path = f"/geo_nodes/{self.encoded_id}/status" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result class GeoNodeManager(RetrieveMixin, UpdateMixin, DeleteMixin, RESTManager): _path = "/geo_nodes" _obj_cls = GeoNode _update_attrs = RequiredOptional( optional=("enabled", "url", "files_max_capacity", "repos_max_capacity"), ) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GeoNode: return cast(GeoNode, super().get(id=id, lazy=lazy, **kwargs)) @cli.register_custom_action("GeoNodeManager") @exc.on_http_error(exc.GitlabGetError) def status(self, **kwargs: Any) -> List[Dict[str, Any]]: """Get the status of all the geo nodes. Args: **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 status of all the geo nodes """ result = self.gitlab.http_list("/geo_nodes/status", **kwargs) if TYPE_CHECKING: assert isinstance(result, list) return result @cli.register_custom_action("GeoNodeManager") @exc.on_http_error(exc.GitlabGetError) def current_failures(self, **kwargs: Any) -> List[Dict[str, Any]]: """Get the list of failures on the current geo node. Args: **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 list of failures """ result = self.gitlab.http_list("/geo_nodes/current/failures", **kwargs) if TYPE_CHECKING: assert isinstance(result, list) return result ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/group_access_tokens.py0000644000000000000000000000126214366036457022772 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "GroupAccessToken", "GroupAccessTokenManager", ] class GroupAccessToken(ObjectDeleteMixin, RESTObject): pass class GroupAccessTokenManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/access_tokens" _obj_cls = GroupAccessToken _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("name", "scopes"), optional=("access_level", "expires_at") ) _types = {"scopes": ArrayAttribute} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/groups.py0000644000000000000000000004303614366036457020256 0ustar00rootrootfrom typing import Any, BinaryIO, cast, Dict, List, Optional, Type, TYPE_CHECKING, Union import requests import gitlab from gitlab import cli from gitlab import exceptions as exc from gitlab import types, utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, ListMixin, NoUpdateMixin, ObjectDeleteMixin, SaveMixin, ) from gitlab.types import RequiredOptional from .access_requests import GroupAccessRequestManager # noqa: F401 from .audit_events import GroupAuditEventManager # noqa: F401 from .badges import GroupBadgeManager # noqa: F401 from .boards import GroupBoardManager # noqa: F401 from .clusters import GroupClusterManager # noqa: F401 from .container_registry import GroupRegistryRepositoryManager # noqa: F401 from .custom_attributes import GroupCustomAttributeManager # noqa: F401 from .deploy_tokens import GroupDeployTokenManager # noqa: F401 from .epics import GroupEpicManager # noqa: F401 from .export_import import GroupExportManager, GroupImportManager # noqa: F401 from .group_access_tokens import GroupAccessTokenManager # noqa: F401 from .hooks import GroupHookManager # noqa: F401 from .invitations import GroupInvitationManager # noqa: F401 from .issues import GroupIssueManager # noqa: F401 from .iterations import GroupIterationManager # noqa: F401 from .labels import GroupLabelManager # noqa: F401 from .members import ( # noqa: F401 GroupBillableMemberManager, GroupMemberAllManager, GroupMemberManager, ) from .merge_requests import GroupMergeRequestManager # noqa: F401 from .milestones import GroupMilestoneManager # noqa: F401 from .notification_settings import GroupNotificationSettingsManager # noqa: F401 from .packages import GroupPackageManager # noqa: F401 from .projects import GroupProjectManager, SharedProjectManager # noqa: F401 from .push_rules import GroupPushRulesManager from .runners import GroupRunnerManager # noqa: F401 from .statistics import GroupIssuesStatisticsManager # noqa: F401 from .variables import GroupVariableManager # noqa: F401 from .wikis import GroupWikiManager # noqa: F401 __all__ = [ "Group", "GroupManager", "GroupDescendantGroup", "GroupDescendantGroupManager", "GroupLDAPGroupLink", "GroupLDAPGroupLinkManager", "GroupSubgroup", "GroupSubgroupManager", "GroupSAMLGroupLink", "GroupSAMLGroupLinkManager", ] class Group(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "name" access_tokens: GroupAccessTokenManager accessrequests: GroupAccessRequestManager audit_events: GroupAuditEventManager badges: GroupBadgeManager billable_members: GroupBillableMemberManager boards: GroupBoardManager clusters: GroupClusterManager customattributes: GroupCustomAttributeManager deploytokens: GroupDeployTokenManager descendant_groups: "GroupDescendantGroupManager" epics: GroupEpicManager exports: GroupExportManager hooks: GroupHookManager imports: GroupImportManager invitations: GroupInvitationManager issues: GroupIssueManager issues_statistics: GroupIssuesStatisticsManager iterations: GroupIterationManager labels: GroupLabelManager ldap_group_links: "GroupLDAPGroupLinkManager" members: GroupMemberManager members_all: GroupMemberAllManager mergerequests: GroupMergeRequestManager milestones: GroupMilestoneManager notificationsettings: GroupNotificationSettingsManager packages: GroupPackageManager projects: GroupProjectManager shared_projects: SharedProjectManager pushrules: GroupPushRulesManager registry_repositories: GroupRegistryRepositoryManager runners: GroupRunnerManager subgroups: "GroupSubgroupManager" variables: GroupVariableManager wikis: GroupWikiManager saml_group_links: "GroupSAMLGroupLinkManager" @cli.register_custom_action("Group", ("project_id",)) @exc.on_http_error(exc.GitlabTransferProjectError) def transfer_project(self, project_id: int, **kwargs: Any) -> None: """Transfer a project to this group. Args: to_project_id: ID of the project to transfer **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTransferProjectError: If the project could not be transferred """ path = f"/groups/{self.encoded_id}/projects/{project_id}" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("Group", (), ("group_id",)) @exc.on_http_error(exc.GitlabGroupTransferError) def transfer(self, group_id: Optional[int] = None, **kwargs: Any) -> None: """Transfer the group to a new parent group or make it a top-level group. Requires GitLab ≥14.6. Args: group_id: ID of the new parent group. When not specified, the group to transfer is instead turned into a top-level group. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGroupTransferError: If the group could not be transferred """ path = f"/groups/{self.encoded_id}/transfer" post_data = {} if group_id is not None: post_data["group_id"] = group_id self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) @cli.register_custom_action("Group", ("scope", "search")) @exc.on_http_error(exc.GitlabSearchError) def search( self, scope: str, search: str, **kwargs: Any ) -> Union[gitlab.GitlabList, List[Dict[str, Any]]]: """Search the group resources matching the provided string. Args: scope: Scope of the search search: 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. """ data = {"scope": scope, "search": search} path = f"/groups/{self.encoded_id}/search" return self.manager.gitlab.http_list(path, query_data=data, **kwargs) @cli.register_custom_action("Group", ("cn", "group_access", "provider")) @exc.on_http_error(exc.GitlabCreateError) def add_ldap_group_link( self, cn: str, group_access: int, provider: str, **kwargs: Any ) -> None: """Add an LDAP group link. Args: cn: CN of the LDAP group group_access: Minimum access level for members of the LDAP group provider: LDAP provider for the LDAP group **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request """ utils.warn( message=( "The add_ldap_group_link() method is deprecated and will be removed " "in a future version. Use ldap_group_links.create() instead." ), category=DeprecationWarning, ) path = f"/groups/{self.encoded_id}/ldap_group_links" data = {"cn": cn, "group_access": group_access, "provider": provider} self.manager.gitlab.http_post(path, post_data=data, **kwargs) @cli.register_custom_action("Group", ("cn",), ("provider",)) @exc.on_http_error(exc.GitlabDeleteError) def delete_ldap_group_link( self, cn: str, provider: Optional[str] = None, **kwargs: Any ) -> None: """Delete an LDAP group link. Args: cn: CN of the LDAP group provider: LDAP provider for the LDAP group **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 """ utils.warn( message=( "The delete_ldap_group_link() method is deprecated and will be " "removed in a future version. Use ldap_group_links.delete() instead." ), category=DeprecationWarning, ) path = f"/groups/{self.encoded_id}/ldap_group_links" if provider is not None: path += f"/{provider}" path += f"/{cn}" self.manager.gitlab.http_delete(path, **kwargs) @cli.register_custom_action("Group") @exc.on_http_error(exc.GitlabCreateError) def ldap_sync(self, **kwargs: Any) -> None: """Sync LDAP groups. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request """ path = f"/groups/{self.encoded_id}/ldap_sync" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("Group", ("group_id", "group_access"), ("expires_at",)) @exc.on_http_error(exc.GitlabCreateError) def share( self, group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any, ) -> None: """Share the group with a group. Args: group_id: ID of the group. group_access: Access level for the group. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request Returns: Group """ path = f"/groups/{self.encoded_id}/share" data = { "group_id": group_id, "group_access": group_access, "expires_at": expires_at, } server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("Group", ("group_id",)) @exc.on_http_error(exc.GitlabDeleteError) def unshare(self, group_id: int, **kwargs: Any) -> None: """Delete a shared group link within a group. Args: group_id: ID of the group. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/groups/{self.encoded_id}/share/{group_id}" self.manager.gitlab.http_delete(path, **kwargs) @cli.register_custom_action("Group") @exc.on_http_error(exc.GitlabRestoreError) def restore(self, **kwargs: Any) -> None: """Restore a group marked for deletion.. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabRestoreError: If the server failed to perform the request """ path = f"/groups/{self.encoded_id}/restore" self.manager.gitlab.http_post(path, **kwargs) class GroupManager(CRUDMixin, RESTManager): _path = "/groups" _obj_cls = Group _list_filters = ( "skip_groups", "all_available", "search", "order_by", "sort", "statistics", "owned", "with_custom_attributes", "min_access_level", "top_level_only", ) _create_attrs = RequiredOptional( required=("name", "path"), optional=( "description", "membership_lock", "visibility", "share_with_group_lock", "require_two_factor_authentication", "two_factor_grace_period", "project_creation_level", "auto_devops_enabled", "subgroup_creation_level", "emails_disabled", "avatar", "mentions_disabled", "lfs_enabled", "request_access_enabled", "parent_id", "default_branch_protection", "shared_runners_minutes_limit", "extra_shared_runners_minutes_limit", ), ) _update_attrs = RequiredOptional( optional=( "name", "path", "description", "membership_lock", "share_with_group_lock", "visibility", "require_two_factor_authentication", "two_factor_grace_period", "project_creation_level", "auto_devops_enabled", "subgroup_creation_level", "emails_disabled", "avatar", "mentions_disabled", "lfs_enabled", "request_access_enabled", "default_branch_protection", "file_template_project_id", "shared_runners_minutes_limit", "extra_shared_runners_minutes_limit", "prevent_forking_outside_group", "shared_runners_setting", ), ) _types = {"avatar": types.ImageAttribute, "skip_groups": types.ArrayAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Group: return cast(Group, super().get(id=id, lazy=lazy, **kwargs)) @exc.on_http_error(exc.GitlabImportError) def import_group( self, file: BinaryIO, path: str, name: str, parent_id: Optional[str] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a group from an archive file. Args: file: Data or file object containing the group path: The path for the new group to be imported. name: The name for the new group. parent_id: ID of a parent group that the group will be imported into. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabImportError: If the server failed to perform the request Returns: A representation of the import status. """ files = {"file": ("file.tar.gz", file, "application/octet-stream")} data = {"path": path, "name": name} if parent_id is not None: data["parent_id"] = parent_id return self.gitlab.http_post( "/groups/import", post_data=data, files=files, **kwargs ) class GroupSubgroup(RESTObject): pass class GroupSubgroupManager(ListMixin, RESTManager): _path = "/groups/{group_id}/subgroups" _obj_cls: Union[Type["GroupDescendantGroup"], Type[GroupSubgroup]] = GroupSubgroup _from_parent_attrs = {"group_id": "id"} _list_filters = ( "skip_groups", "all_available", "search", "order_by", "sort", "statistics", "owned", "with_custom_attributes", "min_access_level", ) _types = {"skip_groups": types.ArrayAttribute} class GroupDescendantGroup(RESTObject): pass class GroupDescendantGroupManager(GroupSubgroupManager): """ This manager inherits from GroupSubgroupManager as descendant groups share all attributes with subgroups, except the path and object class. """ _path = "/groups/{group_id}/descendant_groups" _obj_cls: Type[GroupDescendantGroup] = GroupDescendantGroup class GroupLDAPGroupLink(RESTObject): _repr_attr = "provider" def _get_link_attrs(self) -> Dict[str, str]: # https://docs.gitlab.com/ee/api/groups.html#add-ldap-group-link-with-cn-or-filter # https://docs.gitlab.com/ee/api/groups.html#delete-ldap-group-link-with-cn-or-filter # We can tell what attribute to use based on the data returned data = {"provider": self.provider} if self.cn: data["cn"] = self.cn else: data["filter"] = self.filter return data def delete(self, **kwargs: Any) -> None: """Delete the LDAP group link from the server. Args: **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 """ if TYPE_CHECKING: assert isinstance(self.manager, DeleteMixin) self.manager.delete( self.encoded_id, query_data=self._get_link_attrs(), **kwargs ) class GroupLDAPGroupLinkManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/ldap_group_links" _obj_cls: Type[GroupLDAPGroupLink] = GroupLDAPGroupLink _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("provider", "group_access"), exclusive=("cn", "filter") ) class GroupSAMLGroupLink(ObjectDeleteMixin, RESTObject): _id_attr = "name" _repr_attr = "name" class GroupSAMLGroupLinkManager(NoUpdateMixin, RESTManager): _path = "/groups/{group_id}/saml_group_links" _obj_cls: Type[GroupSAMLGroupLink] = GroupSAMLGroupLink _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional(required=("saml_group_name", "access_level")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupSAMLGroupLink: return cast(GroupSAMLGroupLink, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/hooks.py0000644000000000000000000000701614366036457020060 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, NoUpdateMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "Hook", "HookManager", "ProjectHook", "ProjectHookManager", "GroupHook", "GroupHookManager", ] class Hook(ObjectDeleteMixin, RESTObject): _url = "/hooks" _repr_attr = "url" class HookManager(NoUpdateMixin, RESTManager): _path = "/hooks" _obj_cls = Hook _create_attrs = RequiredOptional(required=("url",)) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Hook: return cast(Hook, super().get(id=id, lazy=lazy, **kwargs)) class ProjectHook(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "url" class ProjectHookManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/hooks" _obj_cls = ProjectHook _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("url",), optional=( "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "job_events", "pipeline_events", "wiki_page_events", "enable_ssl_verification", "token", ), ) _update_attrs = RequiredOptional( required=("url",), optional=( "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "job_events", "pipeline_events", "wiki_events", "enable_ssl_verification", "token", ), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectHook: return cast(ProjectHook, super().get(id=id, lazy=lazy, **kwargs)) class GroupHook(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "url" class GroupHookManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/hooks" _obj_cls = GroupHook _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("url",), optional=( "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "job_events", "pipeline_events", "wiki_page_events", "deployment_events", "releases_events", "subgroup_events", "enable_ssl_verification", "token", ), ) _update_attrs = RequiredOptional( required=("url",), optional=( "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "job_events", "pipeline_events", "wiki_page_events", "deployment_events", "releases_events", "subgroup_events", "enable_ssl_verification", "token", ), ) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupHook: return cast(GroupHook, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/integrations.py0000644000000000000000000002176514366036457021452 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/integrations.html """ from typing import Any, cast, List, Union from gitlab import cli from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( DeleteMixin, GetMixin, ListMixin, ObjectDeleteMixin, SaveMixin, UpdateMixin, ) __all__ = [ "ProjectIntegration", "ProjectIntegrationManager", "ProjectService", "ProjectServiceManager", ] class ProjectIntegration(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "slug" class ProjectIntegrationManager( GetMixin, UpdateMixin, DeleteMixin, ListMixin, RESTManager ): _path = "/projects/{project_id}/integrations" _from_parent_attrs = {"project_id": "id"} _obj_cls = ProjectIntegration _service_attrs = { "asana": (("api_key",), ("restrict_to_branch", "push_events")), "assembla": (("token",), ("subdomain", "push_events")), "bamboo": ( ("bamboo_url", "build_key", "username", "password"), ("push_events",), ), "bugzilla": ( ("new_issue_url", "issues_url", "project_url"), ("description", "title", "push_events"), ), "buildkite": ( ("token", "project_url"), ("enable_ssl_verification", "push_events"), ), "campfire": (("token",), ("subdomain", "room", "push_events")), "circuit": ( ("webhook",), ( "notify_only_broken_pipelines", "branches_to_be_notified", "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "pipeline_events", "wiki_page_events", ), ), "custom-issue-tracker": ( ("new_issue_url", "issues_url", "project_url"), ("description", "title", "push_events"), ), "drone-ci": ( ("token", "drone_url"), ( "enable_ssl_verification", "push_events", "merge_requests_events", "tag_push_events", ), ), "emails-on-push": ( ("recipients",), ( "disable_diffs", "send_from_committer_email", "push_events", "tag_push_events", "branches_to_be_notified", ), ), "pipelines-email": ( ("recipients",), ( "add_pusher", "notify_only_broken_builds", "branches_to_be_notified", "notify_only_default_branch", "pipeline_events", ), ), "external-wiki": (("external_wiki_url",), ()), "flowdock": (("token",), ("push_events",)), "github": (("token", "repository_url"), ("static_context",)), "hangouts-chat": ( ("webhook",), ( "notify_only_broken_pipelines", "notify_only_default_branch", "branches_to_be_notified", "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "pipeline_events", "wiki_page_events", ), ), "hipchat": ( ("token",), ( "color", "notify", "room", "api_version", "server", "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "pipeline_events", ), ), "irker": ( ("recipients",), ( "default_irc_uri", "server_port", "server_host", "colorize_messages", "push_events", ), ), "jira": ( ( "url", "username", "password", ), ( "api_url", "active", "jira_issue_transition_id", "commit_events", "merge_requests_events", "comment_on_event_enabled", ), ), "slack-slash-commands": (("token",), ()), "mattermost-slash-commands": (("token",), ("username",)), "packagist": ( ("username", "token"), ("server", "push_events", "merge_requests_events", "tag_push_events"), ), "mattermost": ( ("webhook",), ( "username", "channel", "notify_only_broken_pipelines", "notify_only_default_branch", "branches_to_be_notified", "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "pipeline_events", "wiki_page_events", "push_channel", "issue_channel", "confidential_issue_channel", "merge_request_channel", "note_channel", "confidential_note_channel", "tag_push_channel", "pipeline_channel", "wiki_page_channel", ), ), "pivotaltracker": (("token",), ("restrict_to_branch", "push_events")), "prometheus": (("api_url",), ()), "pushover": ( ("api_key", "user_key", "priority"), ("device", "sound", "push_events"), ), "redmine": ( ("new_issue_url", "project_url", "issues_url"), ("description", "push_events"), ), "slack": ( ("webhook",), ( "username", "channel", "notify_only_broken_pipelines", "notify_only_default_branch", "branches_to_be_notified", "commit_events", "confidential_issue_channel", "confidential_issues_events", "confidential_note_channel", "confidential_note_events", "deployment_channel", "deployment_events", "issue_channel", "issues_events", "job_events", "merge_request_channel", "merge_requests_events", "note_channel", "note_events", "pipeline_channel", "pipeline_events", "push_channel", "push_events", "tag_push_channel", "tag_push_events", "wiki_page_channel", "wiki_page_events", ), ), "microsoft-teams": ( ("webhook",), ( "notify_only_broken_pipelines", "notify_only_default_branch", "branches_to_be_notified", "push_events", "issues_events", "confidential_issues_events", "merge_requests_events", "tag_push_events", "note_events", "confidential_note_events", "pipeline_events", "wiki_page_events", ), ), "teamcity": ( ("teamcity_url", "build_type", "username", "password"), ("push_events",), ), "jenkins": (("jenkins_url", "project_name"), ("username", "password")), "mock-ci": (("mock_service_url",), ()), "youtrack": (("issues_url", "project_url"), ("description", "push_events")), } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIntegration: return cast(ProjectIntegration, super().get(id=id, lazy=lazy, **kwargs)) @cli.register_custom_action(("ProjectIntegrationManager", "ProjectServiceManager")) def available(self) -> List[str]: """List the services known by python-gitlab. Returns: The list of service code names. """ return list(self._service_attrs.keys()) class ProjectService(ProjectIntegration): pass class ProjectServiceManager(ProjectIntegrationManager): _obj_cls = ProjectService def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectService: return cast(ProjectService, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/invitations.py0000644000000000000000000000525614366036457021310 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.exceptions import GitlabInvitationError from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import ArrayAttribute, CommaSeparatedListAttribute, RequiredOptional __all__ = [ "ProjectInvitation", "ProjectInvitationManager", "GroupInvitation", "GroupInvitationManager", ] class InvitationMixin(CRUDMixin): def create(self, *args: Any, **kwargs: Any) -> RESTObject: invitation = super().create(*args, **kwargs) if invitation.status == "error": raise GitlabInvitationError(invitation.message) return invitation class ProjectInvitation(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "email" class ProjectInvitationManager(InvitationMixin, RESTManager): _path = "/projects/{project_id}/invitations" _obj_cls = ProjectInvitation _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("access_level",), optional=( "expires_at", "invite_source", "tasks_to_be_done", "tasks_project_id", ), exclusive=("email", "user_id"), ) _update_attrs = RequiredOptional( optional=("access_level", "expires_at"), ) _list_filters = ("query",) _types = { "email": CommaSeparatedListAttribute, "user_id": CommaSeparatedListAttribute, "tasks_to_be_done": ArrayAttribute, } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectInvitation: return cast(ProjectInvitation, super().get(id=id, lazy=lazy, **kwargs)) class GroupInvitation(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "email" class GroupInvitationManager(InvitationMixin, RESTManager): _path = "/groups/{group_id}/invitations" _obj_cls = GroupInvitation _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("access_level",), optional=( "expires_at", "invite_source", "tasks_to_be_done", "tasks_project_id", ), exclusive=("email", "user_id"), ) _update_attrs = RequiredOptional( optional=("access_level", "expires_at"), ) _list_filters = ("query",) _types = { "email": CommaSeparatedListAttribute, "user_id": CommaSeparatedListAttribute, "tasks_to_be_done": ArrayAttribute, } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupInvitation: return cast(GroupInvitation, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/issues.py0000644000000000000000000002337314366036457020254 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, Tuple, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, ParticipantsMixin, RetrieveMixin, SaveMixin, SubscribableMixin, TimeTrackingMixin, TodoMixin, UserAgentDetailMixin, ) from gitlab.types import RequiredOptional from .award_emojis import ProjectIssueAwardEmojiManager # noqa: F401 from .discussions import ProjectIssueDiscussionManager # noqa: F401 from .events import ( # noqa: F401 ProjectIssueResourceIterationEventManager, ProjectIssueResourceLabelEventManager, ProjectIssueResourceMilestoneEventManager, ProjectIssueResourceStateEventManager, ) from .notes import ProjectIssueNoteManager # noqa: F401 __all__ = [ "Issue", "IssueManager", "GroupIssue", "GroupIssueManager", "ProjectIssue", "ProjectIssueManager", "ProjectIssueLink", "ProjectIssueLinkManager", ] class Issue(RESTObject): _url = "/issues" _repr_attr = "title" class IssueManager(RetrieveMixin, RESTManager): _path = "/issues" _obj_cls = Issue _list_filters = ( "state", "labels", "milestone", "scope", "author_id", "assignee_id", "my_reaction_emoji", "iids", "order_by", "sort", "search", "created_after", "created_before", "updated_after", "updated_before", ) _types = {"iids": types.ArrayAttribute, "labels": types.CommaSeparatedListAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Issue: return cast(Issue, super().get(id=id, lazy=lazy, **kwargs)) class GroupIssue(RESTObject): pass class GroupIssueManager(ListMixin, RESTManager): _path = "/groups/{group_id}/issues" _obj_cls = GroupIssue _from_parent_attrs = {"group_id": "id"} _list_filters = ( "state", "labels", "milestone", "order_by", "sort", "iids", "author_id", "assignee_id", "my_reaction_emoji", "search", "created_after", "created_before", "updated_after", "updated_before", ) _types = {"iids": types.ArrayAttribute, "labels": types.CommaSeparatedListAttribute} class ProjectIssue( UserAgentDetailMixin, SubscribableMixin, TodoMixin, TimeTrackingMixin, ParticipantsMixin, SaveMixin, ObjectDeleteMixin, RESTObject, ): _repr_attr = "title" _id_attr = "iid" awardemojis: ProjectIssueAwardEmojiManager discussions: ProjectIssueDiscussionManager links: "ProjectIssueLinkManager" notes: ProjectIssueNoteManager resourcelabelevents: ProjectIssueResourceLabelEventManager resourcemilestoneevents: ProjectIssueResourceMilestoneEventManager resourcestateevents: ProjectIssueResourceStateEventManager resource_iteration_events: ProjectIssueResourceIterationEventManager @cli.register_custom_action("ProjectIssue", ("to_project_id",)) @exc.on_http_error(exc.GitlabUpdateError) def move(self, to_project_id: int, **kwargs: Any) -> None: """Move the issue to another project. Args: to_project_id: ID of the target project **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the issue could not be moved """ path = f"{self.manager.path}/{self.encoded_id}/move" data = {"to_project_id": to_project_id} server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("ProjectIssue", ("move_after_id", "move_before_id")) @exc.on_http_error(exc.GitlabUpdateError) def reorder( self, move_after_id: Optional[int] = None, move_before_id: Optional[int] = None, **kwargs: Any, ) -> None: """Reorder an issue on a board. Args: move_after_id: ID of an issue that should be placed after this issue move_before_id: ID of an issue that should be placed before this issue **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the issue could not be reordered """ path = f"{self.manager.path}/{self.encoded_id}/reorder" data: Dict[str, Any] = {} if move_after_id is not None: data["move_after_id"] = move_after_id if move_before_id is not None: data["move_before_id"] = move_before_id server_data = self.manager.gitlab.http_put(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("ProjectIssue") @exc.on_http_error(exc.GitlabGetError) def related_merge_requests(self, **kwargs: Any) -> Dict[str, Any]: """List merge requests related to the issue. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetErrot: If the merge requests could not be retrieved Returns: The list of merge requests. """ path = f"{self.manager.path}/{self.encoded_id}/related_merge_requests" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result @cli.register_custom_action("ProjectIssue") @exc.on_http_error(exc.GitlabGetError) def closed_by(self, **kwargs: Any) -> Dict[str, Any]: """List merge requests that will close the issue when merged. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetErrot: If the merge requests could not be retrieved Returns: The list of merge requests. """ path = f"{self.manager.path}/{self.encoded_id}/closed_by" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result class ProjectIssueManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/issues" _obj_cls = ProjectIssue _from_parent_attrs = {"project_id": "id"} _list_filters = ( "iids", "state", "labels", "milestone", "scope", "author_id", "assignee_id", "my_reaction_emoji", "order_by", "sort", "search", "created_after", "created_before", "updated_after", "updated_before", ) _create_attrs = RequiredOptional( required=("title",), optional=( "description", "confidential", "assignee_ids", "assignee_id", "milestone_id", "labels", "created_at", "due_date", "merge_request_to_resolve_discussions_of", "discussion_to_resolve", ), ) _update_attrs = RequiredOptional( optional=( "title", "description", "confidential", "assignee_ids", "assignee_id", "milestone_id", "labels", "state_event", "updated_at", "due_date", "discussion_locked", ), ) _types = {"iids": types.ArrayAttribute, "labels": types.CommaSeparatedListAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssue: return cast(ProjectIssue, super().get(id=id, lazy=lazy, **kwargs)) class ProjectIssueLink(ObjectDeleteMixin, RESTObject): _id_attr = "issue_link_id" class ProjectIssueLinkManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/links" _obj_cls = ProjectIssueLink _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} _create_attrs = RequiredOptional(required=("target_project_id", "target_issue_iid")) @exc.on_http_error(exc.GitlabCreateError) # NOTE(jlvillal): Signature doesn't match CreateMixin.create() so ignore # type error def create( # type: ignore self, data: Dict[str, Any], **kwargs: Any ) -> Tuple[RESTObject, RESTObject]: """Create a new object. Args: data: parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo) Returns: The source and target issues Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request """ self._create_attrs.validate_attrs(data=data) if TYPE_CHECKING: assert self.path is not None server_data = self.gitlab.http_post(self.path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) assert self._parent is not None source_issue = ProjectIssue(self._parent.manager, server_data["source_issue"]) target_issue = ProjectIssue(self._parent.manager, server_data["target_issue"]) return source_issue, target_issue ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/iterations.py0000644000000000000000000000131614366036457021113 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import ListMixin __all__ = [ "ProjectIterationManager", "GroupIteration", "GroupIterationManager", ] class GroupIteration(RESTObject): _repr_attr = "title" class GroupIterationManager(ListMixin, RESTManager): _path = "/groups/{group_id}/iterations" _obj_cls = GroupIteration _from_parent_attrs = {"group_id": "id"} _list_filters = ("state", "search", "include_ancestors") class ProjectIterationManager(ListMixin, RESTManager): _path = "/projects/{project_id}/iterations" _obj_cls = GroupIteration _from_parent_attrs = {"project_id": "id"} _list_filters = ("state", "search", "include_ancestors") ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/jobs.py0000644000000000000000000002150114366036457017665 0ustar00rootrootfrom typing import Any, Callable, cast, Dict, Iterator, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import RefreshMixin, RetrieveMixin from gitlab.types import ArrayAttribute __all__ = [ "ProjectJob", "ProjectJobManager", ] class ProjectJob(RefreshMixin, RESTObject): @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabJobCancelError) def cancel(self, **kwargs: Any) -> Dict[str, Any]: """Cancel the job. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabJobCancelError: If the job could not be canceled """ path = f"{self.manager.path}/{self.encoded_id}/cancel" result = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabJobRetryError) def retry(self, **kwargs: Any) -> Dict[str, Any]: """Retry the job. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabJobRetryError: If the job could not be retried """ path = f"{self.manager.path}/{self.encoded_id}/retry" result = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabJobPlayError) def play(self, **kwargs: Any) -> None: """Trigger a job explicitly. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabJobPlayError: If the job could not be triggered """ path = f"{self.manager.path}/{self.encoded_id}/play" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabJobEraseError) def erase(self, **kwargs: Any) -> None: """Erase the job (remove job artifacts and trace). Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabJobEraseError: If the job could not be erased """ path = f"{self.manager.path}/{self.encoded_id}/erase" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabCreateError) def keep_artifacts(self, **kwargs: Any) -> None: """Prevent artifacts from being deleted when expiration is set. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the request could not be performed """ path = f"{self.manager.path}/{self.encoded_id}/artifacts/keep" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabCreateError) def delete_artifacts(self, **kwargs: Any) -> None: """Delete artifacts of a job. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the request could not be performed """ path = f"{self.manager.path}/{self.encoded_id}/artifacts" self.manager.gitlab.http_delete(path, **kwargs) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabGetError) def artifacts( self, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Get the job artifacts. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The artifacts if `streamed` is False, None otherwise. """ path = f"{self.manager.path}/{self.encoded_id}/artifacts" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabGetError) def artifact( self, path: str, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Get a single artifact file from within the job's artifacts archive. Args: path: Path of the artifact streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The artifacts if `streamed` is False, None otherwise. """ path = f"{self.manager.path}/{self.encoded_id}/artifacts/{path}" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("ProjectJob") @exc.on_http_error(exc.GitlabGetError) def trace( self, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Dict[str, Any]: """Get the job trace. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The trace """ path = f"{self.manager.path}/{self.encoded_id}/trace" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return_value = utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) if TYPE_CHECKING: assert isinstance(return_value, dict) return return_value class ProjectJobManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/jobs" _obj_cls = ProjectJob _from_parent_attrs = {"project_id": "id"} _list_filters = ("scope",) _types = {"scope": ArrayAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectJob: return cast(ProjectJob, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/keys.py0000644000000000000000000000156214366036457017710 0ustar00rootrootfrom typing import Any, cast, Optional, TYPE_CHECKING, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import GetMixin __all__ = [ "Key", "KeyManager", ] class Key(RESTObject): pass class KeyManager(GetMixin, RESTManager): _path = "/keys" _obj_cls = Key def get( self, id: Optional[Union[int, str]] = None, lazy: bool = False, **kwargs: Any ) -> Key: if id is not None: return cast(Key, super().get(id, lazy=lazy, **kwargs)) if "fingerprint" not in kwargs: raise AttributeError("Missing attribute: id or fingerprint") if TYPE_CHECKING: assert self.path is not None server_data = self.gitlab.http_get(self.path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return self._obj_cls(self, server_data) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/labels.py0000644000000000000000000001117614366036457020201 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, Union from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, DeleteMixin, ObjectDeleteMixin, PromoteMixin, RetrieveMixin, SaveMixin, SubscribableMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "GroupLabel", "GroupLabelManager", "ProjectLabel", "ProjectLabelManager", ] class GroupLabel(SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "name" manager: "GroupLabelManager" # Update without ID, but we need an ID to get from list. @exc.on_http_error(exc.GitlabUpdateError) def save(self, **kwargs: Any) -> None: """Saves the changes made to the object to the server. The object is updated to match what the server returns. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct. GitlabUpdateError: If the server cannot perform the request. """ updated_data = self._get_updated_data() # call the manager server_data = self.manager.update(None, updated_data, **kwargs) self._update_attrs(server_data) class GroupLabelManager( RetrieveMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/groups/{group_id}/labels" _obj_cls = GroupLabel _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("name", "color"), optional=("description", "priority") ) _update_attrs = RequiredOptional( required=("name",), optional=("new_name", "color", "description", "priority") ) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupLabel: return cast(GroupLabel, super().get(id=id, lazy=lazy, **kwargs)) # Update without ID. # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore # type error def update( # type: ignore self, name: Optional[str], new_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> Dict[str, Any]: """Update a Label on the server. Args: name: The name of the label **kwargs: Extra options to send to the server (e.g. sudo) """ new_data = new_data or {} if name: new_data["name"] = name return super().update(id=None, new_data=new_data, **kwargs) class ProjectLabel( PromoteMixin, SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject ): _id_attr = "name" manager: "ProjectLabelManager" # Update without ID, but we need an ID to get from list. @exc.on_http_error(exc.GitlabUpdateError) def save(self, **kwargs: Any) -> None: """Saves the changes made to the object to the server. The object is updated to match what the server returns. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct. GitlabUpdateError: If the server cannot perform the request. """ updated_data = self._get_updated_data() # call the manager server_data = self.manager.update(None, updated_data, **kwargs) self._update_attrs(server_data) class ProjectLabelManager( RetrieveMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/labels" _obj_cls = ProjectLabel _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name", "color"), optional=("description", "priority") ) _update_attrs = RequiredOptional( required=("name",), optional=("new_name", "color", "description", "priority") ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectLabel: return cast(ProjectLabel, super().get(id=id, lazy=lazy, **kwargs)) # Update without ID. # NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore # type error def update( # type: ignore self, name: Optional[str], new_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> Dict[str, Any]: """Update a Label on the server. Args: name: The name of the label **kwargs: Extra options to send to the server (e.g. sudo) """ new_data = new_data or {} if name: new_data["name"] = name return super().update(id=None, new_data=new_data, **kwargs) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/ldap.py0000644000000000000000000000317614366036457017660 0ustar00rootrootfrom typing import Any, List, Union from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject, RESTObjectList __all__ = [ "LDAPGroup", "LDAPGroupManager", ] class LDAPGroup(RESTObject): _id_attr = None class LDAPGroupManager(RESTManager): _path = "/ldap/groups" _obj_cls = LDAPGroup _list_filters = ("search", "provider") @exc.on_http_error(exc.GitlabListError) def list(self, **kwargs: Any) -> Union[List[LDAPGroup], RESTObjectList]: """Retrieve a list of objects. Args: 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) iterator: If set to True and no pagination option is defined, 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 if `iterator` is True Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server cannot perform the request """ data = kwargs.copy() if self.gitlab.per_page: data.setdefault("per_page", self.gitlab.per_page) if "provider" in data: path = f"/ldap/{data['provider']}/groups" else: path = self._path obj = self.gitlab.http_list(path, **data) if isinstance(obj, list): return [self._obj_cls(self, item) for item in obj] return RESTObjectList(self, self._obj_cls, obj) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/members.py0000644000000000000000000000737414366036457020376 0ustar00rootrootfrom typing import Any, cast, Union from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CRUDMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, RetrieveMixin, SaveMixin, ) from gitlab.types import RequiredOptional __all__ = [ "GroupBillableMember", "GroupBillableMemberManager", "GroupBillableMemberMembership", "GroupBillableMemberMembershipManager", "GroupMember", "GroupMemberAll", "GroupMemberManager", "GroupMemberAllManager", "ProjectMember", "ProjectMemberAll", "ProjectMemberManager", "ProjectMemberAllManager", ] class GroupMember(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "username" class GroupMemberManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/members" _obj_cls = GroupMember _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("access_level", "user_id"), optional=("expires_at", "tasks_to_be_done"), ) _update_attrs = RequiredOptional( required=("access_level",), optional=("expires_at",) ) _types = { "user_ids": types.ArrayAttribute, "tasks_to_be_done": types.ArrayAttribute, } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupMember: return cast(GroupMember, super().get(id=id, lazy=lazy, **kwargs)) class GroupBillableMember(ObjectDeleteMixin, RESTObject): _repr_attr = "username" memberships: "GroupBillableMemberMembershipManager" class GroupBillableMemberManager(ListMixin, DeleteMixin, RESTManager): _path = "/groups/{group_id}/billable_members" _obj_cls = GroupBillableMember _from_parent_attrs = {"group_id": "id"} _list_filters = ("search", "sort") class GroupBillableMemberMembership(RESTObject): _id_attr = "user_id" class GroupBillableMemberMembershipManager(ListMixin, RESTManager): _path = "/groups/{group_id}/billable_members/{user_id}/memberships" _obj_cls = GroupBillableMemberMembership _from_parent_attrs = {"group_id": "group_id", "user_id": "id"} class GroupMemberAll(RESTObject): _repr_attr = "username" class GroupMemberAllManager(RetrieveMixin, RESTManager): _path = "/groups/{group_id}/members/all" _obj_cls = GroupMemberAll _from_parent_attrs = {"group_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupMemberAll: return cast(GroupMemberAll, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMember(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "username" class ProjectMemberManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/members" _obj_cls = ProjectMember _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("access_level", "user_id"), optional=("expires_at", "tasks_to_be_done"), ) _update_attrs = RequiredOptional( required=("access_level",), optional=("expires_at",) ) _types = { "user_ids": types.ArrayAttribute, "tasks_to_be_dones": types.ArrayAttribute, } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMember: return cast(ProjectMember, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMemberAll(RESTObject): _repr_attr = "username" class ProjectMemberAllManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/members/all" _obj_cls = ProjectMemberAll _from_parent_attrs = {"project_id": "id"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMemberAll: return cast(ProjectMemberAll, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/merge_request_approvals.py0000644000000000000000000001770214366036457023676 0ustar00rootrootfrom typing import Any, cast, Dict, List, Optional, TYPE_CHECKING, Union from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, GetWithoutIdMixin, ListMixin, ObjectDeleteMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "ProjectApproval", "ProjectApprovalManager", "ProjectApprovalRule", "ProjectApprovalRuleManager", "ProjectMergeRequestApproval", "ProjectMergeRequestApprovalManager", "ProjectMergeRequestApprovalRule", "ProjectMergeRequestApprovalRuleManager", "ProjectMergeRequestApprovalState", "ProjectMergeRequestApprovalStateManager", ] class ProjectApproval(SaveMixin, RESTObject): _id_attr = None class ProjectApprovalManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/projects/{project_id}/approvals" _obj_cls = ProjectApproval _from_parent_attrs = {"project_id": "id"} _update_attrs = RequiredOptional( optional=( "approvals_before_merge", "reset_approvals_on_push", "disable_overriding_approvers_per_merge_request", "merge_requests_author_approval", "merge_requests_disable_committers_approval", ), ) _update_uses_post = True def get(self, **kwargs: Any) -> ProjectApproval: return cast(ProjectApproval, super().get(**kwargs)) class ProjectApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "id" class ProjectApprovalRuleManager( ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/approval_rules" _obj_cls = ProjectApprovalRule _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name", "approvals_required"), optional=("user_ids", "group_ids", "protected_branch_ids"), ) class ProjectMergeRequestApproval(SaveMixin, RESTObject): _id_attr = None class ProjectMergeRequestApprovalManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/approvals" _obj_cls = ProjectMergeRequestApproval _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} _update_attrs = RequiredOptional(required=("approvals_required",)) _update_uses_post = True def get(self, **kwargs: Any) -> ProjectMergeRequestApproval: return cast(ProjectMergeRequestApproval, super().get(**kwargs)) @exc.on_http_error(exc.GitlabUpdateError) def set_approvers( self, approvals_required: int, approver_ids: Optional[List[int]] = None, approver_group_ids: Optional[List[int]] = None, approval_rule_name: str = "name", **kwargs: Any, ) -> RESTObject: """Change MR-level allowed approvers and approver groups. Args: approvals_required: The number of required approvals for this rule approver_ids: User IDs that can approve MRs approver_group_ids: Group IDs whose members can approve MRs Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server failed to perform the request """ approver_ids = approver_ids or [] approver_group_ids = approver_group_ids or [] data = { "name": approval_rule_name, "approvals_required": approvals_required, "rule_type": "regular", "user_ids": approver_ids, "group_ids": approver_group_ids, } if TYPE_CHECKING: assert self._parent is not None approval_rules: ProjectMergeRequestApprovalRuleManager = ( self._parent.approval_rules ) # update any existing approval rule matching the name existing_approval_rules = approval_rules.list() for ar in existing_approval_rules: if ar.name == approval_rule_name: ar.user_ids = data["user_ids"] ar.approvals_required = data["approvals_required"] ar.group_ids = data["group_ids"] ar.save() return ar # if there was no rule matching the rule name, create a new one return approval_rules.create(data=data, **kwargs) class ProjectMergeRequestApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "name" id: int approval_rule_id: int merge_request_iid: int @exc.on_http_error(exc.GitlabUpdateError) def save(self, **kwargs: Any) -> None: """Save the changes made to the object to the server. The object is updated to match what the server returns. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raise: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ # There is a mismatch between the name of our id attribute and the put # REST API name for the project_id, so we override it here. self.approval_rule_id = self.id self.merge_request_iid = self._parent_attrs["mr_iid"] self.id = self._parent_attrs["project_id"] # save will update self.id with the result from the server, so no need # to overwrite with what it was before we overwrote it. SaveMixin.save(self, **kwargs) class ProjectMergeRequestApprovalRuleManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/approval_rules" _obj_cls = ProjectMergeRequestApprovalRule _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} _update_attrs = RequiredOptional( required=( "id", "merge_request_iid", "approval_rule_id", "name", "approvals_required", ), optional=("user_ids", "group_ids"), ) # Important: When approval_project_rule_id is set, the name, users and # groups of project-level rule will be copied. The approvals_required # specified will be used. _create_attrs = RequiredOptional( required=("id", "merge_request_iid", "name", "approvals_required"), optional=("approval_project_rule_id", "user_ids", "group_ids"), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestApprovalRule: return cast( ProjectMergeRequestApprovalRule, super().get(id=id, lazy=lazy, **kwargs) ) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> RESTObject: """Create a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo or 'ref_name', 'stage', 'name', 'all') Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the manage object class build with the data sent by the server """ if TYPE_CHECKING: assert data is not None new_data = data.copy() new_data["id"] = self._from_parent_attrs["project_id"] new_data["merge_request_iid"] = self._from_parent_attrs["mr_iid"] return CreateMixin.create(self, new_data, **kwargs) class ProjectMergeRequestApprovalState(RESTObject): pass class ProjectMergeRequestApprovalStateManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/approval_state" _obj_cls = ProjectMergeRequestApprovalState _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} def get(self, **kwargs: Any) -> ProjectMergeRequestApprovalState: return cast(ProjectMergeRequestApprovalState, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/merge_requests.py0000644000000000000000000004125014366036457021765 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/merge_requests.html https://docs.gitlab.com/ee/api/merge_request_approvals.html """ from typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union import requests import gitlab from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject, RESTObjectList from gitlab.mixins import ( CRUDMixin, ListMixin, ObjectDeleteMixin, ParticipantsMixin, RetrieveMixin, SaveMixin, SubscribableMixin, TimeTrackingMixin, TodoMixin, ) from gitlab.types import RequiredOptional from .award_emojis import ProjectMergeRequestAwardEmojiManager # noqa: F401 from .commits import ProjectCommit, ProjectCommitManager from .discussions import ProjectMergeRequestDiscussionManager # noqa: F401 from .events import ( # noqa: F401 ProjectMergeRequestResourceLabelEventManager, ProjectMergeRequestResourceMilestoneEventManager, ProjectMergeRequestResourceStateEventManager, ) from .issues import ProjectIssue, ProjectIssueManager from .merge_request_approvals import ( # noqa: F401 ProjectMergeRequestApprovalManager, ProjectMergeRequestApprovalRuleManager, ProjectMergeRequestApprovalStateManager, ) from .notes import ProjectMergeRequestNoteManager # noqa: F401 from .pipelines import ProjectMergeRequestPipelineManager # noqa: F401 __all__ = [ "MergeRequest", "MergeRequestManager", "GroupMergeRequest", "GroupMergeRequestManager", "ProjectMergeRequest", "ProjectMergeRequestManager", "ProjectDeploymentMergeRequest", "ProjectDeploymentMergeRequestManager", "ProjectMergeRequestDiff", "ProjectMergeRequestDiffManager", ] class MergeRequest(RESTObject): pass class MergeRequestManager(ListMixin, RESTManager): _path = "/merge_requests" _obj_cls = MergeRequest _list_filters = ( "state", "order_by", "sort", "milestone", "view", "labels", "with_labels_details", "with_merge_status_recheck", "created_after", "created_before", "updated_after", "updated_before", "scope", "author_id", "author_username", "assignee_id", "approver_ids", "approved_by_ids", "reviewer_id", "reviewer_username", "my_reaction_emoji", "source_branch", "target_branch", "search", "in", "wip", "not", "environment", "deployed_before", "deployed_after", ) _types = { "approver_ids": types.ArrayAttribute, "approved_by_ids": types.ArrayAttribute, "in": types.CommaSeparatedListAttribute, "labels": types.CommaSeparatedListAttribute, } class GroupMergeRequest(RESTObject): pass class GroupMergeRequestManager(ListMixin, RESTManager): _path = "/groups/{group_id}/merge_requests" _obj_cls = GroupMergeRequest _from_parent_attrs = {"group_id": "id"} _list_filters = ( "state", "order_by", "sort", "milestone", "view", "labels", "created_after", "created_before", "updated_after", "updated_before", "scope", "author_id", "assignee_id", "approver_ids", "approved_by_ids", "my_reaction_emoji", "source_branch", "target_branch", "search", "wip", ) _types = { "approver_ids": types.ArrayAttribute, "approved_by_ids": types.ArrayAttribute, "labels": types.CommaSeparatedListAttribute, } class ProjectMergeRequest( SubscribableMixin, TodoMixin, TimeTrackingMixin, ParticipantsMixin, SaveMixin, ObjectDeleteMixin, RESTObject, ): _id_attr = "iid" approval_rules: ProjectMergeRequestApprovalRuleManager approval_state: ProjectMergeRequestApprovalStateManager approvals: ProjectMergeRequestApprovalManager awardemojis: ProjectMergeRequestAwardEmojiManager diffs: "ProjectMergeRequestDiffManager" discussions: ProjectMergeRequestDiscussionManager notes: ProjectMergeRequestNoteManager pipelines: ProjectMergeRequestPipelineManager resourcelabelevents: ProjectMergeRequestResourceLabelEventManager resourcemilestoneevents: ProjectMergeRequestResourceMilestoneEventManager resourcestateevents: ProjectMergeRequestResourceStateEventManager @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabMROnBuildSuccessError) def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> Dict[str, str]: """Cancel merge when the pipeline succeeds. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMROnBuildSuccessError: If the server could not handle the request Returns: dict of the parsed json returned by the server """ path = ( f"{self.manager.path}/{self.encoded_id}/cancel_merge_when_pipeline_succeeds" ) server_data = self.manager.gitlab.http_post(path, **kwargs) # 2022-10-30: The docs at # https://docs.gitlab.com/ee/api/merge_requests.html#cancel-merge-when-pipeline-succeeds # are incorrect in that the return value is actually just: # {'status': 'success'} for a successful cancel. if TYPE_CHECKING: assert isinstance(server_data, dict) return server_data @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabListError) def closes_issues(self, **kwargs: Any) -> RESTObjectList: """List issues that will close on merge." Args: 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) **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: List of issues """ path = f"{self.manager.path}/{self.encoded_id}/closes_issues" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, gitlab.GitlabList) manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent) return RESTObjectList(manager, ProjectIssue, data_list) @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabListError) def commits(self, **kwargs: Any) -> RESTObjectList: """List the merge request commits. Args: 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) **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 commits """ path = f"{self.manager.path}/{self.encoded_id}/commits" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, gitlab.GitlabList) manager = ProjectCommitManager(self.manager.gitlab, parent=self.manager._parent) return RESTObjectList(manager, ProjectCommit, data_list) @cli.register_custom_action("ProjectMergeRequest", optional=("access_raw_diffs",)) @exc.on_http_error(exc.GitlabListError) def changes(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """List the merge request changes. Args: **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: List of changes """ path = f"{self.manager.path}/{self.encoded_id}/changes" return self.manager.gitlab.http_get(path, **kwargs) @cli.register_custom_action("ProjectMergeRequest", (), ("sha",)) @exc.on_http_error(exc.GitlabMRApprovalError) def approve(self, sha: Optional[str] = None, **kwargs: Any) -> Dict[str, Any]: """Approve the merge request. Args: sha: Head SHA of MR **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRApprovalError: If the approval failed Returns: A dict containing the result. https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request """ path = f"{self.manager.path}/{self.encoded_id}/approve" data = {} if sha: data["sha"] = sha server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) return server_data @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabMRApprovalError) def unapprove(self, **kwargs: Any) -> None: """Unapprove the merge request. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRApprovalError: If the unapproval failed https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request """ path = f"{self.manager.path}/{self.encoded_id}/unapprove" data: Dict[str, Any] = {} server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabMRRebaseError) def rebase(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Attempt to rebase the source branch onto the target branch Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRRebaseError: If rebasing failed """ path = f"{self.manager.path}/{self.encoded_id}/rebase" data: Dict[str, Any] = {} return self.manager.gitlab.http_put(path, post_data=data, **kwargs) @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabMRResetApprovalError) def reset_approvals( self, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Clear all approvals of the merge request. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRResetApprovalError: If reset approval failed """ path = f"{self.manager.path}/{self.encoded_id}/reset_approvals" data: Dict[str, Any] = {} return self.manager.gitlab.http_put(path, post_data=data, **kwargs) @cli.register_custom_action("ProjectMergeRequest") @exc.on_http_error(exc.GitlabGetError) def merge_ref(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Attempt to merge changes between source and target branches into `refs/merge-requests/:iid/merge`. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabGetError: If cannot be merged """ path = f"{self.manager.path}/{self.encoded_id}/merge_ref" return self.manager.gitlab.http_get(path, **kwargs) @cli.register_custom_action( "ProjectMergeRequest", (), ( "merge_commit_message", "should_remove_source_branch", "merge_when_pipeline_succeeds", ), ) @exc.on_http_error(exc.GitlabMRClosedError) def merge( self, merge_commit_message: Optional[str] = None, should_remove_source_branch: Optional[bool] = None, merge_when_pipeline_succeeds: Optional[bool] = None, **kwargs: Any, ) -> Dict[str, Any]: """Accept the merge request. Args: merge_commit_message: Commit message should_remove_source_branch: If True, removes the source branch merge_when_pipeline_succeeds: Wait for the build to succeed, then merge **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabMRClosedError: If the merge failed """ path = f"{self.manager.path}/{self.encoded_id}/merge" data: Dict[str, Any] = {} if merge_commit_message: data["merge_commit_message"] = merge_commit_message if should_remove_source_branch is not None: data["should_remove_source_branch"] = should_remove_source_branch if merge_when_pipeline_succeeds is not None: data["merge_when_pipeline_succeeds"] = merge_when_pipeline_succeeds server_data = self.manager.gitlab.http_put(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) return server_data class ProjectMergeRequestManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/merge_requests" _obj_cls = ProjectMergeRequest _from_parent_attrs = {"project_id": "id"} _optional_get_attrs = ( "render_html", "include_diverged_commits_count", "include_rebase_in_progress", ) _create_attrs = RequiredOptional( required=("source_branch", "target_branch", "title"), optional=( "allow_collaboration", "allow_maintainer_to_push", "approvals_before_merge", "assignee_id", "assignee_ids", "description", "labels", "milestone_id", "remove_source_branch", "reviewer_ids", "squash", "target_project_id", ), ) _update_attrs = RequiredOptional( optional=( "target_branch", "assignee_id", "title", "description", "state_event", "labels", "milestone_id", "remove_source_branch", "discussion_locked", "allow_maintainer_to_push", "squash", "reviewer_ids", ), ) _list_filters = ( "state", "order_by", "sort", "milestone", "view", "labels", "created_after", "created_before", "updated_after", "updated_before", "scope", "iids", "author_id", "assignee_id", "approver_ids", "approved_by_ids", "my_reaction_emoji", "source_branch", "target_branch", "search", "wip", ) _types = { "approver_ids": types.ArrayAttribute, "approved_by_ids": types.ArrayAttribute, "iids": types.ArrayAttribute, "labels": types.CommaSeparatedListAttribute, } def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequest: return cast(ProjectMergeRequest, super().get(id=id, lazy=lazy, **kwargs)) class ProjectDeploymentMergeRequest(MergeRequest): pass class ProjectDeploymentMergeRequestManager(MergeRequestManager): _path = "/projects/{project_id}/deployments/{deployment_id}/merge_requests" _obj_cls = ProjectDeploymentMergeRequest _from_parent_attrs = {"deployment_id": "id", "project_id": "project_id"} class ProjectMergeRequestDiff(RESTObject): pass class ProjectMergeRequestDiffManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/versions" _obj_cls = ProjectMergeRequestDiff _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestDiff: return cast(ProjectMergeRequestDiff, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/merge_trains.py0000644000000000000000000000064614366036457021416 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import ListMixin __all__ = [ "ProjectMergeTrain", "ProjectMergeTrainManager", ] class ProjectMergeTrain(RESTObject): pass class ProjectMergeTrainManager(ListMixin, RESTManager): _path = "/projects/{project_id}/merge_trains" _obj_cls = ProjectMergeTrain _from_parent_attrs = {"project_id": "id"} _list_filters = ("scope",) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/milestones.py0000644000000000000000000001551014366036457021115 0ustar00rootrootfrom typing import Any, cast, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject, RESTObjectList from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, PromoteMixin, SaveMixin from gitlab.types import RequiredOptional from .issues import GroupIssue, GroupIssueManager, ProjectIssue, ProjectIssueManager from .merge_requests import ( GroupMergeRequest, ProjectMergeRequest, ProjectMergeRequestManager, ) __all__ = [ "GroupMilestone", "GroupMilestoneManager", "ProjectMilestone", "ProjectMilestoneManager", ] class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "title" @cli.register_custom_action("GroupMilestone") @exc.on_http_error(exc.GitlabListError) def issues(self, **kwargs: Any) -> RESTObjectList: """List issues related to this milestone. Args: 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) **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 issues """ path = f"{self.manager.path}/{self.encoded_id}/issues" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, RESTObjectList) manager = GroupIssueManager(self.manager.gitlab, parent=self.manager._parent) # FIXME(gpocentek): the computed manager path is not correct return RESTObjectList(manager, GroupIssue, data_list) @cli.register_custom_action("GroupMilestone") @exc.on_http_error(exc.GitlabListError) def merge_requests(self, **kwargs: Any) -> RESTObjectList: """List the merge requests related to this milestone. Args: 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) **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 merge requests """ path = f"{self.manager.path}/{self.encoded_id}/merge_requests" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, RESTObjectList) manager = GroupIssueManager(self.manager.gitlab, parent=self.manager._parent) # FIXME(gpocentek): the computed manager path is not correct return RESTObjectList(manager, GroupMergeRequest, data_list) class GroupMilestoneManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/milestones" _obj_cls = GroupMilestone _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("title",), optional=("description", "due_date", "start_date") ) _update_attrs = RequiredOptional( optional=("title", "description", "due_date", "start_date", "state_event"), ) _list_filters = ("iids", "state", "search") _types = {"iids": types.ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupMilestone: return cast(GroupMilestone, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "title" _update_uses_post = True @cli.register_custom_action("ProjectMilestone") @exc.on_http_error(exc.GitlabListError) def issues(self, **kwargs: Any) -> RESTObjectList: """List issues related to this milestone. Args: 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) **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 issues """ path = f"{self.manager.path}/{self.encoded_id}/issues" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, RESTObjectList) manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent) # FIXME(gpocentek): the computed manager path is not correct return RESTObjectList(manager, ProjectIssue, data_list) @cli.register_custom_action("ProjectMilestone") @exc.on_http_error(exc.GitlabListError) def merge_requests(self, **kwargs: Any) -> RESTObjectList: """List the merge requests related to this milestone. Args: 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) **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 merge requests """ path = f"{self.manager.path}/{self.encoded_id}/merge_requests" data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs) if TYPE_CHECKING: assert isinstance(data_list, RESTObjectList) manager = ProjectMergeRequestManager( self.manager.gitlab, parent=self.manager._parent ) # FIXME(gpocentek): the computed manager path is not correct return RESTObjectList(manager, ProjectMergeRequest, data_list) class ProjectMilestoneManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/milestones" _obj_cls = ProjectMilestone _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("title",), optional=("description", "due_date", "start_date", "state_event"), ) _update_attrs = RequiredOptional( optional=("title", "description", "due_date", "start_date", "state_event"), ) _list_filters = ("iids", "state", "search") _types = {"iids": types.ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMilestone: return cast(ProjectMilestone, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/namespaces.py0000644000000000000000000000273614366036457021060 0ustar00rootrootfrom typing import Any, cast, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import RetrieveMixin from gitlab.utils import EncodedId __all__ = [ "Namespace", "NamespaceManager", ] class Namespace(RESTObject): pass class NamespaceManager(RetrieveMixin, RESTManager): _path = "/namespaces" _obj_cls = Namespace _list_filters = ("search",) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Namespace: return cast(Namespace, super().get(id=id, lazy=lazy, **kwargs)) @cli.register_custom_action("NamespaceManager", ("namespace", "parent_id")) @exc.on_http_error(exc.GitlabGetError) def exists(self, namespace: str, **kwargs: Any) -> Namespace: """Get existence of a namespace by path. Args: namespace: The path to the namespace. **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: Data on namespace existence returned from the server. """ path = f"{self.path}/{EncodedId(namespace)}/exists" server_data = self.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return self._obj_cls(self, server_data) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/notes.py0000644000000000000000000002061414366036457020064 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, GetMixin, ObjectDeleteMixin, RetrieveMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional from .award_emojis import ( # noqa: F401 GroupEpicNoteAwardEmojiManager, ProjectIssueNoteAwardEmojiManager, ProjectMergeRequestNoteAwardEmojiManager, ProjectSnippetNoteAwardEmojiManager, ) __all__ = [ "GroupEpicNote", "GroupEpicNoteManager", "GroupEpicDiscussionNote", "GroupEpicDiscussionNoteManager", "ProjectNote", "ProjectNoteManager", "ProjectCommitDiscussionNote", "ProjectCommitDiscussionNoteManager", "ProjectIssueNote", "ProjectIssueNoteManager", "ProjectIssueDiscussionNote", "ProjectIssueDiscussionNoteManager", "ProjectMergeRequestNote", "ProjectMergeRequestNoteManager", "ProjectMergeRequestDiscussionNote", "ProjectMergeRequestDiscussionNoteManager", "ProjectSnippetNote", "ProjectSnippetNoteManager", "ProjectSnippetDiscussionNote", "ProjectSnippetDiscussionNoteManager", ] class GroupEpicNote(SaveMixin, ObjectDeleteMixin, RESTObject): awardemojis: GroupEpicNoteAwardEmojiManager class GroupEpicNoteManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/epics/{epic_id}/notes" _obj_cls = GroupEpicNote _from_parent_attrs = {"group_id": "group_id", "epic_id": "id"} _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupEpicNote: return cast(GroupEpicNote, super().get(id=id, lazy=lazy, **kwargs)) class GroupEpicDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass class GroupEpicDiscussionNoteManager( GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/groups/{group_id}/epics/{epic_id}/discussions/{discussion_id}/notes" _obj_cls = GroupEpicDiscussionNote _from_parent_attrs = { "group_id": "group_id", "epic_id": "epic_id", "discussion_id": "id", } _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupEpicDiscussionNote: return cast(GroupEpicDiscussionNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectNote(RESTObject): pass class ProjectNoteManager(RetrieveMixin, RESTManager): _path = "/projects/{project_id}/notes" _obj_cls = ProjectNote _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectNote: return cast(ProjectNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectCommitDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectCommitDiscussionNoteManager( GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = ( "/projects/{project_id}/repository/commits/{commit_id}/" "discussions/{discussion_id}/notes" ) _obj_cls = ProjectCommitDiscussionNote _from_parent_attrs = { "project_id": "project_id", "commit_id": "commit_id", "discussion_id": "id", } _create_attrs = RequiredOptional( required=("body",), optional=("created_at", "position") ) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectCommitDiscussionNote: return cast( ProjectCommitDiscussionNote, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectIssueNote(SaveMixin, ObjectDeleteMixin, RESTObject): awardemojis: ProjectIssueNoteAwardEmojiManager class ProjectIssueNoteManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/issues/{issue_iid}/notes" _obj_cls = ProjectIssueNote _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"} _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueNote: return cast(ProjectIssueNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectIssueDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectIssueDiscussionNoteManager( GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = ( "/projects/{project_id}/issues/{issue_iid}/discussions/{discussion_id}/notes" ) _obj_cls = ProjectIssueDiscussionNote _from_parent_attrs = { "project_id": "project_id", "issue_iid": "issue_iid", "discussion_id": "id", } _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectIssueDiscussionNote: return cast(ProjectIssueDiscussionNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMergeRequestNote(SaveMixin, ObjectDeleteMixin, RESTObject): awardemojis: ProjectMergeRequestNoteAwardEmojiManager class ProjectMergeRequestNoteManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/notes" _obj_cls = ProjectMergeRequestNote _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} _create_attrs = RequiredOptional(required=("body",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestNote: return cast(ProjectMergeRequestNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectMergeRequestDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectMergeRequestDiscussionNoteManager( GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = ( "/projects/{project_id}/merge_requests/{mr_iid}/" "discussions/{discussion_id}/notes" ) _obj_cls = ProjectMergeRequestDiscussionNote _from_parent_attrs = { "project_id": "project_id", "mr_iid": "mr_iid", "discussion_id": "id", } _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectMergeRequestDiscussionNote: return cast( ProjectMergeRequestDiscussionNote, super().get(id=id, lazy=lazy, **kwargs) ) class ProjectSnippetNote(SaveMixin, ObjectDeleteMixin, RESTObject): awardemojis: ProjectSnippetNoteAwardEmojiManager class ProjectSnippetNoteManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/snippets/{snippet_id}/notes" _obj_cls = ProjectSnippetNote _from_parent_attrs = {"project_id": "project_id", "snippet_id": "id"} _create_attrs = RequiredOptional(required=("body",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippetNote: return cast(ProjectSnippetNote, super().get(id=id, lazy=lazy, **kwargs)) class ProjectSnippetDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectSnippetDiscussionNoteManager( GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = ( "/projects/{project_id}/snippets/{snippet_id}/" "discussions/{discussion_id}/notes" ) _obj_cls = ProjectSnippetDiscussionNote _from_parent_attrs = { "project_id": "project_id", "snippet_id": "snippet_id", "discussion_id": "id", } _create_attrs = RequiredOptional(required=("body",), optional=("created_at",)) _update_attrs = RequiredOptional(required=("body",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippetDiscussionNote: return cast( ProjectSnippetDiscussionNote, super().get(id=id, lazy=lazy, **kwargs) ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/notification_settings.py0000644000000000000000000000401514366036457023337 0ustar00rootrootfrom typing import Any, cast from gitlab.base import RESTManager, RESTObject from gitlab.mixins import GetWithoutIdMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional __all__ = [ "NotificationSettings", "NotificationSettingsManager", "GroupNotificationSettings", "GroupNotificationSettingsManager", "ProjectNotificationSettings", "ProjectNotificationSettingsManager", ] class NotificationSettings(SaveMixin, RESTObject): _id_attr = None class NotificationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/notification_settings" _obj_cls = NotificationSettings _update_attrs = RequiredOptional( optional=( "level", "notification_email", "new_note", "new_issue", "reopen_issue", "close_issue", "reassign_issue", "new_merge_request", "reopen_merge_request", "close_merge_request", "reassign_merge_request", "merge_merge_request", ), ) def get(self, **kwargs: Any) -> NotificationSettings: return cast(NotificationSettings, super().get(**kwargs)) class GroupNotificationSettings(NotificationSettings): pass class GroupNotificationSettingsManager(NotificationSettingsManager): _path = "/groups/{group_id}/notification_settings" _obj_cls = GroupNotificationSettings _from_parent_attrs = {"group_id": "id"} def get(self, **kwargs: Any) -> GroupNotificationSettings: return cast(GroupNotificationSettings, super().get(id=id, **kwargs)) class ProjectNotificationSettings(NotificationSettings): pass class ProjectNotificationSettingsManager(NotificationSettingsManager): _path = "/projects/{project_id}/notification_settings" _obj_cls = ProjectNotificationSettings _from_parent_attrs = {"project_id": "id"} def get(self, **kwargs: Any) -> ProjectNotificationSettings: return cast(ProjectNotificationSettings, super().get(id=id, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/packages.py0000644000000000000000000001350514366036457020513 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/packages.html https://docs.gitlab.com/ee/user/packages/generic_packages/ """ from pathlib import Path from typing import Any, Callable, cast, Iterator, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import DeleteMixin, GetMixin, ListMixin, ObjectDeleteMixin __all__ = [ "GenericPackage", "GenericPackageManager", "GroupPackage", "GroupPackageManager", "ProjectPackage", "ProjectPackageManager", "ProjectPackageFile", "ProjectPackageFileManager", ] class GenericPackage(RESTObject): _id_attr = "package_name" class GenericPackageManager(RESTManager): _path = "/projects/{project_id}/packages/generic" _obj_cls = GenericPackage _from_parent_attrs = {"project_id": "id"} @cli.register_custom_action( "GenericPackageManager", ("package_name", "package_version", "file_name", "path"), ) @exc.on_http_error(exc.GitlabUploadError) def upload( self, package_name: str, package_version: str, file_name: str, path: Union[str, Path], **kwargs: Any, ) -> GenericPackage: """Upload a file as a generic package. Args: package_name: The package name. Must follow generic package name regex rules package_version: The package version. Must follow semantic version regex rules file_name: The name of the file as uploaded in the registry path: The path to a local file to upload Raises: GitlabConnectionError: If the server cannot be reached GitlabUploadError: If the file upload fails GitlabUploadError: If ``filepath`` cannot be read Returns: An object storing the metadata of the uploaded package. https://docs.gitlab.com/ee/user/packages/generic_packages/ """ try: with open(path, "rb") as f: file_data = f.read() except OSError as e: raise exc.GitlabUploadError(f"Failed to read package file {path}") from e url = f"{self._computed_path}/{package_name}/{package_version}/{file_name}" server_data = self.gitlab.http_put(url, post_data=file_data, raw=True, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return self._obj_cls( self, attrs={ "package_name": package_name, "package_version": package_version, "file_name": file_name, "path": path, "message": server_data["message"], }, ) @cli.register_custom_action( "GenericPackageManager", ("package_name", "package_version", "file_name"), ) @exc.on_http_error(exc.GitlabGetError) def download( self, package_name: str, package_version: str, file_name: str, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Download a generic package. Args: package_name: The package name. package_version: The package version. file_name: The name of the file in the registry streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 package content if streamed is False, None otherwise """ path = f"{self._computed_path}/{package_name}/{package_version}/{file_name}" result = self.gitlab.http_get(path, streamed=streamed, raw=True, **kwargs) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) class GroupPackage(RESTObject): pass class GroupPackageManager(ListMixin, RESTManager): _path = "/groups/{group_id}/packages" _obj_cls = GroupPackage _from_parent_attrs = {"group_id": "id"} _list_filters = ( "exclude_subgroups", "order_by", "sort", "package_type", "package_name", ) class ProjectPackage(ObjectDeleteMixin, RESTObject): package_files: "ProjectPackageFileManager" class ProjectPackageManager(ListMixin, GetMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/packages" _obj_cls = ProjectPackage _from_parent_attrs = {"project_id": "id"} _list_filters = ( "order_by", "sort", "package_type", "package_name", ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectPackage: return cast(ProjectPackage, super().get(id=id, lazy=lazy, **kwargs)) class ProjectPackageFile(ObjectDeleteMixin, RESTObject): pass class ProjectPackageFileManager(DeleteMixin, ListMixin, RESTManager): _path = "/projects/{project_id}/packages/{package_id}/package_files" _obj_cls = ProjectPackageFile _from_parent_attrs = {"project_id": "project_id", "package_id": "id"} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/pages.py0000644000000000000000000000216514366036457020034 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ListMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "PagesDomain", "PagesDomainManager", "ProjectPagesDomain", "ProjectPagesDomainManager", ] class PagesDomain(RESTObject): _id_attr = "domain" class PagesDomainManager(ListMixin, RESTManager): _path = "/pages/domains" _obj_cls = PagesDomain class ProjectPagesDomain(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "domain" class ProjectPagesDomainManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/pages/domains" _obj_cls = ProjectPagesDomain _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("domain",), optional=("certificate", "key") ) _update_attrs = RequiredOptional(optional=("certificate", "key")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectPagesDomain: return cast(ProjectPagesDomain, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/personal_access_tokens.py0000644000000000000000000000172614366036457023466 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "PersonalAccessToken", "PersonalAccessTokenManager", "UserPersonalAccessToken", "UserPersonalAccessTokenManager", ] class PersonalAccessToken(ObjectDeleteMixin, RESTObject): pass class PersonalAccessTokenManager(DeleteMixin, ListMixin, RESTManager): _path = "/personal_access_tokens" _obj_cls = PersonalAccessToken _list_filters = ("user_id",) class UserPersonalAccessToken(RESTObject): pass class UserPersonalAccessTokenManager(CreateMixin, RESTManager): _path = "/users/{user_id}/personal_access_tokens" _obj_cls = UserPersonalAccessToken _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional( required=("name", "scopes"), optional=("expires_at",) ) _types = {"scopes": ArrayAttribute} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/pipelines.py0000644000000000000000000002277314366036457020734 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, GetWithoutIdMixin, ListMixin, ObjectDeleteMixin, RefreshMixin, RetrieveMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "ProjectMergeRequestPipeline", "ProjectMergeRequestPipelineManager", "ProjectPipeline", "ProjectPipelineManager", "ProjectPipelineJob", "ProjectPipelineJobManager", "ProjectPipelineBridge", "ProjectPipelineBridgeManager", "ProjectPipelineVariable", "ProjectPipelineVariableManager", "ProjectPipelineScheduleVariable", "ProjectPipelineScheduleVariableManager", "ProjectPipelineSchedulePipeline", "ProjectPipelineSchedulePipelineManager", "ProjectPipelineSchedule", "ProjectPipelineScheduleManager", "ProjectPipelineTestReport", "ProjectPipelineTestReportManager", "ProjectPipelineTestReportSummary", "ProjectPipelineTestReportSummaryManager", ] class ProjectMergeRequestPipeline(RESTObject): pass class ProjectMergeRequestPipelineManager(CreateMixin, ListMixin, RESTManager): _path = "/projects/{project_id}/merge_requests/{mr_iid}/pipelines" _obj_cls = ProjectMergeRequestPipeline _from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"} class ProjectPipeline(RefreshMixin, ObjectDeleteMixin, RESTObject): bridges: "ProjectPipelineBridgeManager" jobs: "ProjectPipelineJobManager" test_report: "ProjectPipelineTestReportManager" test_report_summary: "ProjectPipelineTestReportSummaryManager" variables: "ProjectPipelineVariableManager" @cli.register_custom_action("ProjectPipeline") @exc.on_http_error(exc.GitlabPipelineCancelError) def cancel(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Cancel the job. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabPipelineCancelError: If the request failed """ path = f"{self.manager.path}/{self.encoded_id}/cancel" return self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("ProjectPipeline") @exc.on_http_error(exc.GitlabPipelineRetryError) def retry(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Retry the job. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabPipelineRetryError: If the request failed """ path = f"{self.manager.path}/{self.encoded_id}/retry" return self.manager.gitlab.http_post(path, **kwargs) class ProjectPipelineManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/pipelines" _obj_cls = ProjectPipeline _from_parent_attrs = {"project_id": "id"} _list_filters = ( "scope", "status", "source", "ref", "sha", "yaml_errors", "name", "username", "order_by", "sort", ) _create_attrs = RequiredOptional(required=("ref",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectPipeline: return cast(ProjectPipeline, super().get(id=id, lazy=lazy, **kwargs)) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> ProjectPipeline: """Creates a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the managed object class build with the data sent by the server """ if TYPE_CHECKING: assert self.path is not None path = self.path[:-1] # drop the 's' return cast( ProjectPipeline, CreateMixin.create(self, data, path=path, **kwargs) ) class ProjectPipelineJob(RESTObject): pass class ProjectPipelineJobManager(ListMixin, RESTManager): _path = "/projects/{project_id}/pipelines/{pipeline_id}/jobs" _obj_cls = ProjectPipelineJob _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"} _list_filters = ("scope", "include_retried") class ProjectPipelineBridge(RESTObject): pass class ProjectPipelineBridgeManager(ListMixin, RESTManager): _path = "/projects/{project_id}/pipelines/{pipeline_id}/bridges" _obj_cls = ProjectPipelineBridge _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"} _list_filters = ("scope",) class ProjectPipelineVariable(RESTObject): _id_attr = "key" class ProjectPipelineVariableManager(ListMixin, RESTManager): _path = "/projects/{project_id}/pipelines/{pipeline_id}/variables" _obj_cls = ProjectPipelineVariable _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"} class ProjectPipelineScheduleVariable(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "key" class ProjectPipelineScheduleVariableManager( CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/pipeline_schedules/{pipeline_schedule_id}/variables" _obj_cls = ProjectPipelineScheduleVariable _from_parent_attrs = {"project_id": "project_id", "pipeline_schedule_id": "id"} _create_attrs = RequiredOptional(required=("key", "value")) _update_attrs = RequiredOptional(required=("key", "value")) class ProjectPipelineSchedulePipeline(RESTObject): pass class ProjectPipelineSchedulePipelineManager(ListMixin, RESTManager): _path = "/projects/{project_id}/pipeline_schedules/{pipeline_schedule_id}/pipelines" _obj_cls = ProjectPipelineSchedulePipeline _from_parent_attrs = {"project_id": "project_id", "pipeline_schedule_id": "id"} class ProjectPipelineSchedule(SaveMixin, ObjectDeleteMixin, RESTObject): variables: ProjectPipelineScheduleVariableManager pipelines: ProjectPipelineSchedulePipelineManager @cli.register_custom_action("ProjectPipelineSchedule") @exc.on_http_error(exc.GitlabOwnershipError) def take_ownership(self, **kwargs: Any) -> None: """Update the owner of a pipeline schedule. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabOwnershipError: If the request failed """ path = f"{self.manager.path}/{self.encoded_id}/take_ownership" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("ProjectPipelineSchedule") @exc.on_http_error(exc.GitlabPipelinePlayError) def play(self, **kwargs: Any) -> Dict[str, Any]: """Trigger a new scheduled pipeline, which runs immediately. The next scheduled run of this pipeline is not affected. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabPipelinePlayError: If the request failed """ path = f"{self.manager.path}/{self.encoded_id}/play" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) return server_data class ProjectPipelineScheduleManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/pipeline_schedules" _obj_cls = ProjectPipelineSchedule _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("description", "ref", "cron"), optional=("cron_timezone", "active") ) _update_attrs = RequiredOptional( optional=("description", "ref", "cron", "cron_timezone", "active"), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectPipelineSchedule: return cast(ProjectPipelineSchedule, super().get(id=id, lazy=lazy, **kwargs)) class ProjectPipelineTestReport(RESTObject): _id_attr = None class ProjectPipelineTestReportManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/pipelines/{pipeline_id}/test_report" _obj_cls = ProjectPipelineTestReport _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"} def get(self, **kwargs: Any) -> ProjectPipelineTestReport: return cast(ProjectPipelineTestReport, super().get(**kwargs)) class ProjectPipelineTestReportSummary(RESTObject): _id_attr = None class ProjectPipelineTestReportSummaryManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/pipelines/{pipeline_id}/test_report_summary" _obj_cls = ProjectPipelineTestReportSummary _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"} def get(self, **kwargs: Any) -> ProjectPipelineTestReportSummary: return cast(ProjectPipelineTestReportSummary, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/project_access_tokens.py0000644000000000000000000000130214366036457023277 0ustar00rootrootfrom gitlab.base import RESTManager, RESTObject from gitlab.mixins import CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "ProjectAccessToken", "ProjectAccessTokenManager", ] class ProjectAccessToken(ObjectDeleteMixin, RESTObject): pass class ProjectAccessTokenManager(ListMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/projects/{project_id}/access_tokens" _obj_cls = ProjectAccessToken _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name", "scopes"), optional=("access_level", "expires_at") ) _types = {"scopes": ArrayAttribute} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/projects.py0000644000000000000000000013276414366036457020577 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/projects.html """ from typing import ( Any, Callable, cast, Dict, Iterator, List, Optional, TYPE_CHECKING, Union, ) import requests from gitlab import cli, client from gitlab import exceptions as exc from gitlab import types, utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, GetWithoutIdMixin, ListMixin, ObjectDeleteMixin, RefreshMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional from .access_requests import ProjectAccessRequestManager # noqa: F401 from .artifacts import ProjectArtifactManager # noqa: F401 from .audit_events import ProjectAuditEventManager # noqa: F401 from .badges import ProjectBadgeManager # noqa: F401 from .boards import ProjectBoardManager # noqa: F401 from .branches import ProjectBranchManager, ProjectProtectedBranchManager # noqa: F401 from .ci_lint import ProjectCiLintManager # noqa: F401 from .clusters import ProjectClusterManager # noqa: F401 from .commits import ProjectCommitManager # noqa: F401 from .container_registry import ProjectRegistryRepositoryManager # noqa: F401 from .custom_attributes import ProjectCustomAttributeManager # noqa: F401 from .deploy_keys import ProjectKeyManager # noqa: F401 from .deploy_tokens import ProjectDeployTokenManager # noqa: F401 from .deployments import ProjectDeploymentManager # noqa: F401 from .environments import ( # noqa: F401 ProjectEnvironmentManager, ProjectProtectedEnvironmentManager, ) from .events import ProjectEventManager # noqa: F401 from .export_import import ProjectExportManager, ProjectImportManager # noqa: F401 from .files import ProjectFileManager # noqa: F401 from .hooks import ProjectHookManager # noqa: F401 from .integrations import ProjectIntegrationManager, ProjectServiceManager # noqa: F401 from .invitations import ProjectInvitationManager # noqa: F401 from .issues import ProjectIssueManager # noqa: F401 from .iterations import ProjectIterationManager # noqa: F401 from .jobs import ProjectJobManager # noqa: F401 from .labels import ProjectLabelManager # noqa: F401 from .members import ProjectMemberAllManager, ProjectMemberManager # noqa: F401 from .merge_request_approvals import ( # noqa: F401 ProjectApprovalManager, ProjectApprovalRuleManager, ) from .merge_requests import ProjectMergeRequestManager # noqa: F401 from .merge_trains import ProjectMergeTrainManager # noqa: F401 from .milestones import ProjectMilestoneManager # noqa: F401 from .notes import ProjectNoteManager # noqa: F401 from .notification_settings import ProjectNotificationSettingsManager # noqa: F401 from .packages import GenericPackageManager, ProjectPackageManager # noqa: F401 from .pages import ProjectPagesDomainManager # noqa: F401 from .pipelines import ( # noqa: F401 ProjectPipeline, ProjectPipelineManager, ProjectPipelineScheduleManager, ) from .project_access_tokens import ProjectAccessTokenManager # noqa: F401 from .push_rules import ProjectPushRulesManager # noqa: F401 from .releases import ProjectReleaseManager # noqa: F401 from .repositories import RepositoryMixin from .resource_groups import ProjectResourceGroupManager from .runners import ProjectRunnerManager # noqa: F401 from .secure_files import ProjectSecureFileManager # noqa: F401 from .snippets import ProjectSnippetManager # noqa: F401 from .statistics import ( # noqa: F401 ProjectAdditionalStatisticsManager, ProjectIssuesStatisticsManager, ) from .tags import ProjectProtectedTagManager, ProjectTagManager # noqa: F401 from .triggers import ProjectTriggerManager # noqa: F401 from .users import ProjectUserManager # noqa: F401 from .variables import ProjectVariableManager # noqa: F401 from .wikis import ProjectWikiManager # noqa: F401 __all__ = [ "GroupProject", "GroupProjectManager", "Project", "ProjectManager", "ProjectFork", "ProjectForkManager", "ProjectRemoteMirror", "ProjectRemoteMirrorManager", "ProjectStorage", "ProjectStorageManager", "SharedProject", "SharedProjectManager", ] class GroupProject(RESTObject): pass class GroupProjectManager(ListMixin, RESTManager): _path = "/groups/{group_id}/projects" _obj_cls = GroupProject _from_parent_attrs = {"group_id": "id"} _list_filters = ( "archived", "visibility", "order_by", "sort", "search", "simple", "owned", "starred", "with_custom_attributes", "include_subgroups", "with_issues_enabled", "with_merge_requests_enabled", "with_shared", "min_access_level", "with_security_reports", ) class ProjectGroup(RESTObject): pass class ProjectGroupManager(ListMixin, RESTManager): _path = "/projects/{project_id}/groups" _obj_cls = ProjectGroup _from_parent_attrs = {"project_id": "id"} _list_filters = ( "search", "skip_groups", "with_shared", "shared_min_access_level", "shared_visible_only", ) _types = {"skip_groups": types.ArrayAttribute} class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTObject): _repr_attr = "path_with_namespace" access_tokens: ProjectAccessTokenManager accessrequests: ProjectAccessRequestManager additionalstatistics: ProjectAdditionalStatisticsManager approvalrules: ProjectApprovalRuleManager approvals: ProjectApprovalManager artifacts: ProjectArtifactManager audit_events: ProjectAuditEventManager badges: ProjectBadgeManager boards: ProjectBoardManager branches: ProjectBranchManager ci_lint: ProjectCiLintManager clusters: ProjectClusterManager commits: ProjectCommitManager customattributes: ProjectCustomAttributeManager deployments: ProjectDeploymentManager deploytokens: ProjectDeployTokenManager environments: ProjectEnvironmentManager events: ProjectEventManager exports: ProjectExportManager files: ProjectFileManager forks: "ProjectForkManager" generic_packages: GenericPackageManager groups: ProjectGroupManager hooks: ProjectHookManager imports: ProjectImportManager integrations: ProjectIntegrationManager invitations: ProjectInvitationManager issues: ProjectIssueManager issues_statistics: ProjectIssuesStatisticsManager iterations: ProjectIterationManager jobs: ProjectJobManager keys: ProjectKeyManager labels: ProjectLabelManager members: ProjectMemberManager members_all: ProjectMemberAllManager mergerequests: ProjectMergeRequestManager merge_trains: ProjectMergeTrainManager milestones: ProjectMilestoneManager notes: ProjectNoteManager notificationsettings: ProjectNotificationSettingsManager packages: ProjectPackageManager pagesdomains: ProjectPagesDomainManager pipelines: ProjectPipelineManager pipelineschedules: ProjectPipelineScheduleManager protected_environments: ProjectProtectedEnvironmentManager protectedbranches: ProjectProtectedBranchManager protectedtags: ProjectProtectedTagManager pushrules: ProjectPushRulesManager releases: ProjectReleaseManager resource_groups: ProjectResourceGroupManager remote_mirrors: "ProjectRemoteMirrorManager" repositories: ProjectRegistryRepositoryManager runners: ProjectRunnerManager secure_files: ProjectSecureFileManager services: ProjectServiceManager snippets: ProjectSnippetManager storage: "ProjectStorageManager" tags: ProjectTagManager triggers: ProjectTriggerManager users: ProjectUserManager variables: ProjectVariableManager wikis: ProjectWikiManager @cli.register_custom_action("Project", ("forked_from_id",)) @exc.on_http_error(exc.GitlabCreateError) def create_fork_relation(self, forked_from_id: int, **kwargs: Any) -> None: """Create a forked from/to relation between existing projects. Args: forked_from_id: The ID of the project that was forked from **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the relation could not be created """ path = f"/projects/{self.encoded_id}/fork/{forked_from_id}" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabDeleteError) def delete_fork_relation(self, **kwargs: Any) -> None: """Delete a forked relation between existing projects. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/fork" self.manager.gitlab.http_delete(path, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabGetError) def languages(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Get languages used in the project with percentage value. Args: **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 """ path = f"/projects/{self.encoded_id}/languages" return self.manager.gitlab.http_get(path, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabCreateError) def star(self, **kwargs: Any) -> None: """Star a project. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/star" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabDeleteError) def unstar(self, **kwargs: Any) -> None: """Unstar a project. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/unstar" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabCreateError) def archive(self, **kwargs: Any) -> None: """Archive a project. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/archive" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabDeleteError) def unarchive(self, **kwargs: Any) -> None: """Unarchive a project. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/unarchive" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) @cli.register_custom_action( "Project", ("group_id", "group_access"), ("expires_at",) ) @exc.on_http_error(exc.GitlabCreateError) def share( self, group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any, ) -> None: """Share the project with a group. Args: group_id: ID of the group. group_access: Access level for the group. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/share" data = { "group_id": group_id, "group_access": group_access, "expires_at": expires_at, } self.manager.gitlab.http_post(path, post_data=data, **kwargs) @cli.register_custom_action("Project", ("group_id",)) @exc.on_http_error(exc.GitlabDeleteError) def unshare(self, group_id: int, **kwargs: Any) -> None: """Delete a shared project link within a group. Args: group_id: ID of the group. **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/share/{group_id}" self.manager.gitlab.http_delete(path, **kwargs) # variables not supported in CLI @cli.register_custom_action("Project", ("ref", "token")) @exc.on_http_error(exc.GitlabCreateError) def trigger_pipeline( self, ref: str, token: str, variables: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> ProjectPipeline: """Trigger a CI build. See https://gitlab.com/help/ci/triggers/README.md#trigger-a-build Args: ref: Commit to build; can be a branch name or a tag token: The trigger token variables: Variables passed to the build script **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request """ variables = variables or {} path = f"/projects/{self.encoded_id}/trigger/pipeline" post_data = {"ref": ref, "token": token, "variables": variables} attrs = self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) if TYPE_CHECKING: assert isinstance(attrs, dict) return ProjectPipeline(self.pipelines, attrs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabHousekeepingError) def housekeeping(self, **kwargs: Any) -> None: """Start the housekeeping task. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabHousekeepingError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/housekeeping" self.manager.gitlab.http_post(path, **kwargs) # see #56 - add file attachment features @cli.register_custom_action("Project", ("filename", "filepath")) @exc.on_http_error(exc.GitlabUploadError) def upload( self, filename: str, filedata: Optional[bytes] = None, filepath: Optional[str] = None, **kwargs: Any, ) -> Dict[str, Any]: """Upload the specified file into the project. .. note:: Either ``filedata`` or ``filepath`` *MUST* be specified. Args: filename: The name of the file being uploaded filedata: The raw data of the file being uploaded filepath: The path to a local file to upload (optional) Raises: GitlabConnectionError: If the server cannot be reached GitlabUploadError: If the file upload fails GitlabUploadError: If ``filedata`` and ``filepath`` are not specified GitlabUploadError: If both ``filedata`` and ``filepath`` are specified Returns: A ``dict`` with the keys: * ``alt`` - The alternate text for the upload * ``url`` - The direct url to the uploaded file * ``markdown`` - Markdown for the uploaded file """ if filepath is None and filedata is None: raise exc.GitlabUploadError("No file contents or path specified") if filedata is not None and filepath is not None: raise exc.GitlabUploadError("File contents and file path specified") if filepath is not None: with open(filepath, "rb") as f: filedata = f.read() url = f"/projects/{self.encoded_id}/uploads" file_info = {"file": (filename, filedata)} data = self.manager.gitlab.http_post(url, files=file_info, **kwargs) if TYPE_CHECKING: assert isinstance(data, dict) return {"alt": data["alt"], "url": data["url"], "markdown": data["markdown"]} @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabRestoreError) def restore(self, **kwargs: Any) -> None: """Restore a project marked for deletion. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabRestoreError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/restore" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("Project", optional=("wiki",)) @exc.on_http_error(exc.GitlabGetError) def snapshot( self, wiki: bool = False, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return a snapshot of the repository. Args: wiki: If True return the wiki repository streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment. iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 content could not be retrieved Returns: The uncompressed tar archive of the repository """ path = f"/projects/{self.encoded_id}/snapshot" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, wiki=wiki, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("Project", ("scope", "search")) @exc.on_http_error(exc.GitlabSearchError) def search( self, scope: str, search: str, **kwargs: Any ) -> Union[client.GitlabList, List[Dict[str, Any]]]: """Search the project resources matching the provided string.' Args: scope: Scope of the search search: 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. """ data = {"scope": scope, "search": search} path = f"/projects/{self.encoded_id}/search" return self.manager.gitlab.http_list(path, query_data=data, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabCreateError) def mirror_pull(self, **kwargs: Any) -> None: """Start the pull mirroring process for the project. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/mirror/pull" self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabGetError) def mirror_pull_details(self, **kwargs: Any) -> Dict[str, Any]: """Get a project's pull mirror details. Introduced in GitLab 15.5. Args: **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: dict of the parsed json returned by the server """ path = f"/projects/{self.encoded_id}/mirror/pull" result = self.manager.gitlab.http_get(path, **kwargs) if TYPE_CHECKING: assert isinstance(result, dict) return result @cli.register_custom_action("Project", ("to_namespace",)) @exc.on_http_error(exc.GitlabTransferProjectError) def transfer(self, to_namespace: Union[int, str], **kwargs: Any) -> None: """Transfer a project to the given namespace ID Args: to_namespace: ID or path of the namespace to transfer the project to **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTransferProjectError: If the project could not be transferred """ path = f"/projects/{self.encoded_id}/transfer" self.manager.gitlab.http_put( path, post_data={"namespace": to_namespace}, **kwargs ) @cli.register_custom_action("Project", ("to_namespace",)) def transfer_project(self, *args: Any, **kwargs: Any) -> None: utils.warn( message=( "The project.transfer_project() method is deprecated and will be " "removed in a future version. Use project.transfer() instead." ), category=DeprecationWarning, ) return self.transfer(*args, **kwargs) @cli.register_custom_action("Project", ("ref_name", "artifact_path", "job")) @exc.on_http_error(exc.GitlabGetError) def artifact( self, *args: Any, **kwargs: Any, ) -> Optional[bytes]: utils.warn( message=( "The project.artifact() method is deprecated and will be " "removed in a future version. Use project.artifacts.raw() instead." ), category=DeprecationWarning, ) data = self.artifacts.raw(*args, **kwargs) if TYPE_CHECKING: assert data is not None assert isinstance(data, bytes) return data class ProjectManager(CRUDMixin, RESTManager): _path = "/projects" _obj_cls = Project # Please keep these _create_attrs in same order as they are at: # https://docs.gitlab.com/ee/api/projects.html#create-project _create_attrs = RequiredOptional( optional=( "name", "path", "allow_merge_on_skipped_pipeline", "only_allow_merge_if_all_status_checks_passed", "analytics_access_level", "approvals_before_merge", "auto_cancel_pending_pipelines", "auto_devops_deploy_strategy", "auto_devops_enabled", "autoclose_referenced_issues", "avatar", "build_coverage_regex", "build_git_strategy", "build_timeout", "builds_access_level", "ci_config_path", "container_expiration_policy_attributes", "container_registry_access_level", "container_registry_enabled", "default_branch", "description", "emails_disabled", "external_authorization_classification_label", "forking_access_level", "group_with_project_templates_id", "import_url", "initialize_with_readme", "issues_access_level", "issues_enabled", "jobs_enabled", "lfs_enabled", "merge_method", "merge_pipelines_enabled", "merge_requests_access_level", "merge_requests_enabled", "mirror_trigger_builds", "mirror", "namespace_id", "operations_access_level", "only_allow_merge_if_all_discussions_are_resolved", "only_allow_merge_if_pipeline_succeeds", "packages_enabled", "pages_access_level", "requirements_access_level", "printing_merge_request_link_enabled", "public_builds", "releases_access_level", "environments_access_level", "feature_flags_access_level", "infrastructure_access_level", "monitor_access_level", "remove_source_branch_after_merge", "repository_access_level", "repository_storage", "request_access_enabled", "resolve_outdated_diff_discussions", "security_and_compliance_access_level", "shared_runners_enabled", "show_default_award_emojis", "snippets_access_level", "snippets_enabled", "squash_option", "tag_list", "topics", "template_name", "template_project_id", "use_custom_template", "visibility", "wiki_access_level", "wiki_enabled", ), ) # Please keep these _update_attrs in same order as they are at: # https://docs.gitlab.com/ee/api/projects.html#edit-project _update_attrs = RequiredOptional( optional=( "allow_merge_on_skipped_pipeline", "only_allow_merge_if_all_status_checks_passed", "analytics_access_level", "approvals_before_merge", "auto_cancel_pending_pipelines", "auto_devops_deploy_strategy", "auto_devops_enabled", "autoclose_referenced_issues", "avatar", "build_coverage_regex", "build_git_strategy", "build_timeout", "builds_access_level", "ci_config_path", "ci_default_git_depth", "ci_forward_deployment_enabled", "ci_allow_fork_pipelines_to_run_in_parent_project", "ci_separated_caches", "container_expiration_policy_attributes", "container_registry_access_level", "container_registry_enabled", "default_branch", "description", "emails_disabled", "enforce_auth_checks_on_uploads", "external_authorization_classification_label", "forking_access_level", "import_url", "issues_access_level", "issues_enabled", "issues_template", "jobs_enabled", "keep_latest_artifact", "lfs_enabled", "merge_commit_template", "merge_method", "merge_pipelines_enabled", "merge_requests_access_level", "merge_requests_enabled", "merge_requests_template", "merge_trains_enabled", "mirror_overwrites_diverged_branches", "mirror_trigger_builds", "mirror_user_id", "mirror", "mr_default_target_self", "name", "operations_access_level", "only_allow_merge_if_all_discussions_are_resolved", "only_allow_merge_if_pipeline_succeeds", "only_mirror_protected_branches", "packages_enabled", "pages_access_level", "requirements_access_level", "restrict_user_defined_variables", "path", "public_builds", "releases_access_level", "environments_access_level", "feature_flags_access_level", "infrastructure_access_level", "monitor_access_level", "remove_source_branch_after_merge", "repository_access_level", "repository_storage", "request_access_enabled", "resolve_outdated_diff_discussions", "security_and_compliance_access_level", "service_desk_enabled", "shared_runners_enabled", "show_default_award_emojis", "snippets_access_level", "snippets_enabled", "issue_branch_template", "squash_commit_template", "squash_option", "suggestion_commit_message", "tag_list", "topics", "visibility", "wiki_access_level", "wiki_enabled", ), ) _list_filters = ( "archived", "id_after", "id_before", "last_activity_after", "last_activity_before", "membership", "min_access_level", "order_by", "owned", "repository_checksum_failed", "repository_storage", "search_namespaces", "search", "simple", "sort", "starred", "statistics", "topic", "visibility", "wiki_checksum_failed", "with_custom_attributes", "with_issues_enabled", "with_merge_requests_enabled", "with_programming_language", ) _types = { "avatar": types.ImageAttribute, "topic": types.CommaSeparatedListAttribute, "topics": types.ArrayAttribute, } def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Project: return cast(Project, super().get(id=id, lazy=lazy, **kwargs)) @exc.on_http_error(exc.GitlabImportError) def import_project( self, file: str, path: str, name: Optional[str] = None, namespace: Optional[str] = None, overwrite: bool = False, override_params: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a project from an archive file. Args: file: Data or file object containing the project path: Name and path for the new project name: The name of the project to import. If not provided, defaults to the path of the project. namespace: The ID or path of the namespace that the project will be imported to overwrite: If True overwrite an existing project with the same path override_params: Set the specific settings for the project **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabImportError: If the server failed to perform the request Returns: A representation of the import status. """ files = {"file": ("file.tar.gz", file, "application/octet-stream")} data = {"path": path, "overwrite": str(overwrite)} if override_params: for k, v in override_params.items(): data[f"override_params[{k}]"] = v if name is not None: data["name"] = name if namespace: data["namespace"] = namespace return self.gitlab.http_post( "/projects/import", post_data=data, files=files, **kwargs ) @exc.on_http_error(exc.GitlabImportError) def remote_import( self, url: str, path: str, name: Optional[str] = None, namespace: Optional[str] = None, overwrite: bool = False, override_params: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a project from an archive file stored on a remote URL. Args: url: URL for the file containing the project data to import path: Name and path for the new project name: The name of the project to import. If not provided, defaults to the path of the project. namespace: The ID or path of the namespace that the project will be imported to overwrite: If True overwrite an existing project with the same path override_params: Set the specific settings for the project **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabImportError: If the server failed to perform the request Returns: A representation of the import status. """ data = {"path": path, "overwrite": str(overwrite), "url": url} if override_params: for k, v in override_params.items(): data[f"override_params[{k}]"] = v if name is not None: data["name"] = name if namespace: data["namespace"] = namespace return self.gitlab.http_post( "/projects/remote-import", post_data=data, **kwargs ) @exc.on_http_error(exc.GitlabImportError) def remote_import_s3( self, path: str, region: str, bucket_name: str, file_key: str, access_key_id: str, secret_access_key: str, name: Optional[str] = None, namespace: Optional[str] = None, overwrite: bool = False, override_params: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a project from an archive file stored on AWS S3. Args: region: AWS S3 region name where the file is stored bucket_name: AWS S3 bucket name where the file is stored file_key: AWS S3 file key to identify the file. access_key_id: AWS S3 access key ID. secret_access_key: AWS S3 secret access key. path: Name and path for the new project name: The name of the project to import. If not provided, defaults to the path of the project. namespace: The ID or path of the namespace that the project will be imported to overwrite: If True overwrite an existing project with the same path override_params: Set the specific settings for the project **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabImportError: If the server failed to perform the request Returns: A representation of the import status. """ data = { "region": region, "bucket_name": bucket_name, "file_key": file_key, "access_key_id": access_key_id, "secret_access_key": secret_access_key, "path": path, "overwrite": str(overwrite), } if override_params: for k, v in override_params.items(): data[f"override_params[{k}]"] = v if name is not None: data["name"] = name if namespace: data["namespace"] = namespace return self.gitlab.http_post( "/projects/remote-import-s3", post_data=data, **kwargs ) def import_bitbucket_server( self, bitbucket_server_url: str, bitbucket_server_username: str, personal_access_token: str, bitbucket_server_project: str, bitbucket_server_repo: str, new_name: Optional[str] = None, target_namespace: Optional[str] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a project from BitBucket Server to Gitlab (schedule the import) This method will return when an import operation has been safely queued, or an error has occurred. After triggering an import, check the ``import_status`` of the newly created project to detect when the import operation has completed. .. note:: This request may take longer than most other API requests. So this method will specify a 60 second default timeout if none is specified. A timeout can be specified via kwargs to override this functionality. Args: bitbucket_server_url: Bitbucket Server URL bitbucket_server_username: Bitbucket Server Username personal_access_token: Bitbucket Server personal access token/password bitbucket_server_project: Bitbucket Project Key bitbucket_server_repo: Bitbucket Repository Name new_name: New repository name (Optional) target_namespace: Namespace to import repository into. Supports subgroups like /namespace/subgroup (Optional) **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server failed to perform the request Returns: A representation of the import status. Example: .. code-block:: python gl = gitlab.Gitlab_from_config() print("Triggering import") result = gl.projects.import_bitbucket_server( bitbucket_server_url="https://some.server.url", bitbucket_server_username="some_bitbucket_user", personal_access_token="my_password_or_access_token", bitbucket_server_project="my_project", bitbucket_server_repo="my_repo", new_name="gl_project_name", target_namespace="gl_project_path" ) project = gl.projects.get(ret['id']) print("Waiting for import to complete") while project.import_status == u'started': time.sleep(1.0) project = gl.projects.get(project.id) print("BitBucket import complete") """ data = { "bitbucket_server_url": bitbucket_server_url, "bitbucket_server_username": bitbucket_server_username, "personal_access_token": personal_access_token, "bitbucket_server_project": bitbucket_server_project, "bitbucket_server_repo": bitbucket_server_repo, } if new_name: data["new_name"] = new_name if target_namespace: data["target_namespace"] = target_namespace if ( "timeout" not in kwargs or self.gitlab.timeout is None or self.gitlab.timeout < 60.0 ): # Ensure that this HTTP request has a longer-than-usual default timeout # The base gitlab object tends to have a default that is <10 seconds, # and this is too short for this API command, typically. # On the order of 24 seconds has been measured on a typical gitlab instance. kwargs["timeout"] = 60.0 result = self.gitlab.http_post( "/import/bitbucket_server", post_data=data, **kwargs ) return result def import_github( self, personal_access_token: str, repo_id: int, target_namespace: str, new_name: Optional[str] = None, **kwargs: Any, ) -> Union[Dict[str, Any], requests.Response]: """Import a project from Github to Gitlab (schedule the import) This method will return when an import operation has been safely queued, or an error has occurred. After triggering an import, check the ``import_status`` of the newly created project to detect when the import operation has completed. .. note:: This request may take longer than most other API requests. So this method will specify a 60 second default timeout if none is specified. A timeout can be specified via kwargs to override this functionality. Args: personal_access_token: GitHub personal access token repo_id: Github repository ID target_namespace: Namespace to import repo into new_name: New repo name (Optional) **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server failed to perform the request Returns: A representation of the import status. Example: .. code-block:: python gl = gitlab.Gitlab_from_config() print("Triggering import") result = gl.projects.import_github(ACCESS_TOKEN, 123456, "my-group/my-subgroup") project = gl.projects.get(ret['id']) print("Waiting for import to complete") while project.import_status == u'started': time.sleep(1.0) project = gl.projects.get(project.id) print("Github import complete") """ data = { "personal_access_token": personal_access_token, "repo_id": repo_id, "target_namespace": target_namespace, } if new_name: data["new_name"] = new_name if ( "timeout" not in kwargs or self.gitlab.timeout is None or self.gitlab.timeout < 60.0 ): # Ensure that this HTTP request has a longer-than-usual default timeout # The base gitlab object tends to have a default that is <10 seconds, # and this is too short for this API command, typically. # On the order of 24 seconds has been measured on a typical gitlab instance. kwargs["timeout"] = 60.0 result = self.gitlab.http_post("/import/github", post_data=data, **kwargs) return result class ProjectFork(RESTObject): pass class ProjectForkManager(CreateMixin, ListMixin, RESTManager): _path = "/projects/{project_id}/forks" _obj_cls = ProjectFork _from_parent_attrs = {"project_id": "id"} _list_filters = ( "archived", "visibility", "order_by", "sort", "search", "simple", "owned", "membership", "starred", "statistics", "with_custom_attributes", "with_issues_enabled", "with_merge_requests_enabled", ) _create_attrs = RequiredOptional(optional=("namespace",)) def create( self, data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> ProjectFork: """Creates a new object. Args: data: Parameters to send to the server to create the resource **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabCreateError: If the server cannot perform the request Returns: A new instance of the managed object class build with the data sent by the server """ if TYPE_CHECKING: assert self.path is not None path = self.path[:-1] # drop the 's' return cast(ProjectFork, CreateMixin.create(self, data, path=path, **kwargs)) class ProjectRemoteMirror(SaveMixin, RESTObject): pass class ProjectRemoteMirrorManager(ListMixin, CreateMixin, UpdateMixin, RESTManager): _path = "/projects/{project_id}/remote_mirrors" _obj_cls = ProjectRemoteMirror _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("url",), optional=("enabled", "only_protected_branches") ) _update_attrs = RequiredOptional(optional=("enabled", "only_protected_branches")) class ProjectStorage(RefreshMixin, RESTObject): pass class ProjectStorageManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/storage" _obj_cls = ProjectStorage _from_parent_attrs = {"project_id": "id"} def get(self, **kwargs: Any) -> ProjectStorage: return cast(ProjectStorage, super().get(**kwargs)) class SharedProject(RESTObject): pass class SharedProjectManager(ListMixin, RESTManager): _path = "/groups/{group_id}/projects/shared" _obj_cls = SharedProject _from_parent_attrs = {"group_id": "id"} _list_filters = ( "archived", "visibility", "order_by", "sort", "search", "simple", "starred", "with_issues_enabled", "with_merge_requests_enabled", "min_access_level", "with_custom_attributes", ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/push_rules.py0000644000000000000000000000574114366036457021131 0ustar00rootrootfrom typing import Any, cast from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, DeleteMixin, GetWithoutIdMixin, ObjectDeleteMixin, SaveMixin, UpdateMixin, ) from gitlab.types import RequiredOptional __all__ = [ "GroupPushRules", "GroupPushRulesManager", "ProjectPushRules", "ProjectPushRulesManager", ] class ProjectPushRules(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = None class ProjectPushRulesManager( GetWithoutIdMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/projects/{project_id}/push_rule" _obj_cls = ProjectPushRules _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( optional=( "author_email_regex", "branch_name_regex", "commit_committer_check", "commit_message_negative_regex", "commit_message_regex", "deny_delete_tag", "file_name_regex", "max_file_size", "member_check", "prevent_secrets", "reject_unsigned_commits", ), ) _update_attrs = RequiredOptional( optional=( "author_email_regex", "branch_name_regex", "commit_committer_check", "commit_message_negative_regex", "commit_message_regex", "deny_delete_tag", "file_name_regex", "max_file_size", "member_check", "prevent_secrets", "reject_unsigned_commits", ), ) def get(self, **kwargs: Any) -> ProjectPushRules: return cast(ProjectPushRules, super().get(**kwargs)) class GroupPushRules(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = None class GroupPushRulesManager( GetWithoutIdMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager ): _path = "/groups/{group_id}/push_rule" _obj_cls = GroupPushRules _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( optional=( "deny_delete_tag", "member_check", "prevent_secrets", "commit_message_regex", "commit_message_negative_regex", "branch_name_regex", "author_email_regex", "file_name_regex", "max_file_size", "commit_committer_check", "reject_unsigned_commits", ), ) _update_attrs = RequiredOptional( optional=( "deny_delete_tag", "member_check", "prevent_secrets", "commit_message_regex", "commit_message_negative_regex", "branch_name_regex", "author_email_regex", "file_name_regex", "max_file_size", "commit_committer_check", "reject_unsigned_commits", ), ) def get(self, **kwargs: Any) -> GroupPushRules: return cast(GroupPushRules, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/releases.py0000644000000000000000000000356314366036457020543 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import ArrayAttribute, RequiredOptional __all__ = [ "ProjectRelease", "ProjectReleaseManager", "ProjectReleaseLink", "ProjectReleaseLinkManager", ] class ProjectRelease(SaveMixin, RESTObject): _id_attr = "tag_name" links: "ProjectReleaseLinkManager" class ProjectReleaseManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/releases" _obj_cls = ProjectRelease _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("tag_name",), optional=("name", "description", "ref", "assets") ) _list_filters = ( "order_by", "sort", "include_html_description", ) _update_attrs = RequiredOptional( optional=("name", "description", "milestones", "released_at") ) _types = {"milestones": ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectRelease: return cast(ProjectRelease, super().get(id=id, lazy=lazy, **kwargs)) class ProjectReleaseLink(ObjectDeleteMixin, SaveMixin, RESTObject): pass class ProjectReleaseLinkManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/releases/{tag_name}/assets/links" _obj_cls = ProjectReleaseLink _from_parent_attrs = {"project_id": "project_id", "tag_name": "tag_name"} _create_attrs = RequiredOptional( required=("name", "url"), optional=("filepath", "link_type") ) _update_attrs = RequiredOptional(optional=("name", "url", "filepath", "link_type")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectReleaseLink: return cast(ProjectReleaseLink, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/repositories.py0000644000000000000000000002544714366036457021474 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/repositories.html Currently this module only contains repository-related methods for projects. """ from typing import Any, Callable, Dict, Iterator, List, Optional, TYPE_CHECKING, Union import requests import gitlab from gitlab import cli from gitlab import exceptions as exc from gitlab import types, utils if TYPE_CHECKING: # When running mypy we use these as the base classes _RestObjectBase = gitlab.base.RESTObject else: _RestObjectBase = object class RepositoryMixin(_RestObjectBase): @cli.register_custom_action("Project", ("submodule", "branch", "commit_sha")) @exc.on_http_error(exc.GitlabUpdateError) def update_submodule( self, submodule: str, branch: str, commit_sha: str, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Update a project submodule Args: submodule: Full path to the submodule branch: Name of the branch to commit into commit_sha: Full commit SHA to update the submodule to commit_message: Commit message. If no message is provided, a default one will be set (optional) Raises: GitlabAuthenticationError: If authentication is not correct GitlabPutError: If the submodule could not be updated """ submodule = utils.EncodedId(submodule) path = f"/projects/{self.encoded_id}/repository/submodules/{submodule}" data = {"branch": branch, "commit_sha": commit_sha} if "commit_message" in kwargs: data["commit_message"] = kwargs["commit_message"] return self.manager.gitlab.http_put(path, post_data=data) @cli.register_custom_action("Project", (), ("path", "ref", "recursive")) @exc.on_http_error(exc.GitlabGetError) def repository_tree( self, path: str = "", ref: str = "", recursive: bool = False, **kwargs: Any ) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]: """Return a list of files in the repository. Args: path: Path of the top folder (/ by default) ref: Reference to a commit or branch recursive: Whether to get the tree recursively 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) iterator: If set to True and no pagination option is defined, 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 GitlabGetError: If the server failed to perform the request Returns: The representation of the tree """ gl_path = f"/projects/{self.encoded_id}/repository/tree" query_data: Dict[str, Any] = {"recursive": recursive} if path: query_data["path"] = path if ref: query_data["ref"] = ref return self.manager.gitlab.http_list(gl_path, query_data=query_data, **kwargs) @cli.register_custom_action("Project", ("sha",)) @exc.on_http_error(exc.GitlabGetError) def repository_blob( self, sha: str, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Return a file by blob SHA. Args: sha: ID of the blob **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 and metadata """ path = f"/projects/{self.encoded_id}/repository/blobs/{sha}" return self.manager.gitlab.http_get(path, **kwargs) @cli.register_custom_action("Project", ("sha",)) @exc.on_http_error(exc.GitlabGetError) def repository_raw_blob( self, sha: str, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return the raw file contents for a blob. Args: sha: ID of the blob streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 """ path = f"/projects/{self.encoded_id}/repository/blobs/{sha}/raw" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("Project", ("from_", "to")) @exc.on_http_error(exc.GitlabGetError) def repository_compare( self, from_: str, to: str, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Return a diff between two branches/commits. Args: from_: Source branch/SHA to: Destination branch/SHA **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 diff """ path = f"/projects/{self.encoded_id}/repository/compare" query_data = {"from": from_, "to": to} return self.manager.gitlab.http_get(path, query_data=query_data, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabGetError) def repository_contributors( self, **kwargs: Any ) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]: """Return a list of contributors for the project. Args: 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) iterator: If set to True and no pagination option is defined, 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 GitlabGetError: If the server failed to perform the request Returns: The contributors """ path = f"/projects/{self.encoded_id}/repository/contributors" return self.manager.gitlab.http_list(path, **kwargs) @cli.register_custom_action("Project", (), ("sha", "format")) @exc.on_http_error(exc.GitlabListError) def repository_archive( self, sha: Optional[str] = None, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, format: Optional[str] = None, path: Optional[str] = None, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return an archive of the repository. Args: sha: ID of the commit (default branch by default) streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: Size of each chunk format: file format (tar.gz by default) path: The subpath of the repository to download (all files by default) **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server failed to perform the request Returns: The binary data of the archive """ url_path = f"/projects/{self.encoded_id}/repository/archive" if format: url_path += "." + format query_data = {} if sha: query_data["sha"] = sha if path is not None: query_data["path"] = path result = self.manager.gitlab.http_get( url_path, query_data=query_data, raw=True, streamed=streamed, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) @cli.register_custom_action("Project", ("refs",)) @exc.on_http_error(exc.GitlabGetError) def repository_merge_base( self, refs: List[str], **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Return a diff between two branches/commits. Args: refs: The refs to find the common ancestor of. Multiple refs can be passed. **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 common ancestor commit (*not* a RESTObject) """ path = f"/projects/{self.encoded_id}/repository/merge_base" query_data, _ = utils._transform_types( data={"refs": refs}, custom_types={"refs": types.ArrayAttribute}, transform_data=True, ) return self.manager.gitlab.http_get(path, query_data=query_data, **kwargs) @cli.register_custom_action("Project") @exc.on_http_error(exc.GitlabDeleteError) def delete_merged_branches(self, **kwargs: Any) -> None: """Delete merged branches. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeleteError: If the server failed to perform the request """ path = f"/projects/{self.encoded_id}/repository/merged_branches" self.manager.gitlab.http_delete(path, **kwargs) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/resource_groups.py0000644000000000000000000000262314366036457022162 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ListMixin, RetrieveMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional __all__ = [ "ProjectResourceGroup", "ProjectResourceGroupManager", "ProjectResourceGroupUpcomingJob", "ProjectResourceGroupUpcomingJobManager", ] class ProjectResourceGroup(SaveMixin, RESTObject): _id_attr = "key" upcoming_jobs: "ProjectResourceGroupUpcomingJobManager" class ProjectResourceGroupManager(RetrieveMixin, UpdateMixin, RESTManager): _path = "/projects/{project_id}/resource_groups" _obj_cls = ProjectResourceGroup _from_parent_attrs = {"project_id": "id"} _list_filters = ( "order_by", "sort", "include_html_description", ) _update_attrs = RequiredOptional(optional=("process_mode",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectResourceGroup: return cast(ProjectResourceGroup, super().get(id=id, lazy=lazy, **kwargs)) class ProjectResourceGroupUpcomingJob(RESTObject): pass class ProjectResourceGroupUpcomingJobManager(ListMixin, RESTManager): _path = "/projects/{project_id}/resource_groups/{resource_group_key}/upcoming_jobs" _obj_cls = ProjectResourceGroupUpcomingJob _from_parent_attrs = {"project_id": "project_id", "resource_group_key": "key"} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/runners.py0000644000000000000000000001142314366036457020426 0ustar00rootrootfrom typing import Any, cast, List, Optional, Union from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, ListMixin, ObjectDeleteMixin, SaveMixin, ) from gitlab.types import RequiredOptional __all__ = [ "RunnerJob", "RunnerJobManager", "Runner", "RunnerManager", "RunnerAll", "RunnerAllManager", "GroupRunner", "GroupRunnerManager", "ProjectRunner", "ProjectRunnerManager", ] class RunnerJob(RESTObject): pass class RunnerJobManager(ListMixin, RESTManager): _path = "/runners/{runner_id}/jobs" _obj_cls = RunnerJob _from_parent_attrs = {"runner_id": "id"} _list_filters = ("status",) class Runner(SaveMixin, ObjectDeleteMixin, RESTObject): jobs: RunnerJobManager _repr_attr = "description" class RunnerManager(CRUDMixin, RESTManager): _path = "/runners" _obj_cls = Runner _create_attrs = RequiredOptional( required=("token",), optional=( "description", "info", "active", "locked", "run_untagged", "tag_list", "access_level", "maximum_timeout", ), ) _update_attrs = RequiredOptional( optional=( "description", "active", "tag_list", "run_untagged", "locked", "access_level", "maximum_timeout", ), ) _list_filters = ("scope", "type", "status", "paused", "tag_list") _types = {"tag_list": types.CommaSeparatedListAttribute} @cli.register_custom_action("RunnerManager", (), ("scope",)) @exc.on_http_error(exc.GitlabListError) def all(self, scope: Optional[str] = None, **kwargs: Any) -> List[Runner]: """List all the runners. Args: scope: The scope of runners to show, one of: specific, shared, active, paused, online 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) iterator: If set to True and no pagination option is defined, 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 server failed to perform the request Returns: A list of runners matching the scope. """ path = "/runners/all" query_data = {} if scope is not None: query_data["scope"] = scope obj = self.gitlab.http_list(path, query_data, **kwargs) return [self._obj_cls(self, item) for item in obj] @cli.register_custom_action("RunnerManager", ("token",)) @exc.on_http_error(exc.GitlabVerifyError) def verify(self, token: str, **kwargs: Any) -> None: """Validates authentication credentials for a registered Runner. Args: token: The runner's authentication token **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabVerifyError: If the server failed to verify the token """ path = "/runners/verify" post_data = {"token": token} self.gitlab.http_post(path, post_data=post_data, **kwargs) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Runner: return cast(Runner, super().get(id=id, lazy=lazy, **kwargs)) class RunnerAll(RESTObject): _repr_attr = "description" class RunnerAllManager(ListMixin, RESTManager): _path = "/runners/all" _obj_cls = RunnerAll _list_filters = ("scope", "type", "status", "paused", "tag_list") _types = {"tag_list": types.CommaSeparatedListAttribute} class GroupRunner(RESTObject): pass class GroupRunnerManager(ListMixin, RESTManager): _path = "/groups/{group_id}/runners" _obj_cls = GroupRunner _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional(required=("runner_id",)) _list_filters = ("scope", "tag_list") _types = {"tag_list": types.CommaSeparatedListAttribute} class ProjectRunner(ObjectDeleteMixin, RESTObject): pass class ProjectRunnerManager(CreateMixin, DeleteMixin, ListMixin, RESTManager): _path = "/projects/{project_id}/runners" _obj_cls = ProjectRunner _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("runner_id",)) _list_filters = ("scope", "tag_list") _types = {"tag_list": types.CommaSeparatedListAttribute} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/secure_files.py0000644000000000000000000000471614366036457021411 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/secure_files.html """ from typing import Any, Callable, cast, Iterator, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin from gitlab.types import FileAttribute, RequiredOptional __all__ = ["ProjectSecureFile", "ProjectSecureFileManager"] class ProjectSecureFile(ObjectDeleteMixin, RESTObject): @cli.register_custom_action("ProjectSecureFile") @exc.on_http_error(exc.GitlabGetError) def download( self, streamed: bool = False, action: Optional[Callable[[bytes], None]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Download the secure file. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 artifacts could not be retrieved Returns: The artifacts if `streamed` is False, None otherwise.""" path = f"{self.manager.path}/{self.id}/download" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) class ProjectSecureFileManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/secure_files" _obj_cls = ProjectSecureFile _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("name", "file")) _types = {"file": FileAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSecureFile: return cast(ProjectSecureFile, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/settings.py0000644000000000000000000001030614366036457020571 0ustar00rootrootfrom typing import Any, cast, Dict, Optional, Union from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import GetWithoutIdMixin, SaveMixin, UpdateMixin from gitlab.types import RequiredOptional __all__ = [ "ApplicationSettings", "ApplicationSettingsManager", ] class ApplicationSettings(SaveMixin, RESTObject): _id_attr = None class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/application/settings" _obj_cls = ApplicationSettings _update_attrs = RequiredOptional( optional=( "id", "default_projects_limit", "signup_enabled", "password_authentication_enabled_for_web", "gravatar_enabled", "sign_in_text", "created_at", "updated_at", "home_page_url", "default_branch_protection", "restricted_visibility_levels", "max_attachment_size", "session_expire_delay", "default_project_visibility", "default_snippet_visibility", "default_group_visibility", "outbound_local_requests_whitelist", "disabled_oauth_sign_in_sources", "domain_whitelist", "domain_blacklist_enabled", "domain_blacklist", "domain_allowlist", "domain_denylist_enabled", "domain_denylist", "external_authorization_service_enabled", "external_authorization_service_url", "external_authorization_service_default_label", "external_authorization_service_timeout", "import_sources", "user_oauth_applications", "after_sign_out_path", "container_registry_token_expire_delay", "repository_storages", "plantuml_enabled", "plantuml_url", "terminal_max_session_time", "polling_interval_multiplier", "rsa_key_restriction", "dsa_key_restriction", "ecdsa_key_restriction", "ed25519_key_restriction", "first_day_of_week", "enforce_terms", "terms", "performance_bar_allowed_group_id", "instance_statistics_visibility_private", "user_show_add_ssh_key_message", "file_template_project_id", "local_markdown_version", "asset_proxy_enabled", "asset_proxy_url", "asset_proxy_whitelist", "asset_proxy_allowlist", "geo_node_allowed_ips", "allow_local_requests_from_hooks_and_services", "allow_local_requests_from_web_hooks_and_services", "allow_local_requests_from_system_hooks", ), ) _types = { "asset_proxy_allowlist": types.ArrayAttribute, "disabled_oauth_sign_in_sources": types.ArrayAttribute, "domain_allowlist": types.ArrayAttribute, "domain_denylist": types.ArrayAttribute, "import_sources": types.ArrayAttribute, "restricted_visibility_levels": types.ArrayAttribute, } @exc.on_http_error(exc.GitlabUpdateError) def update( self, id: Optional[Union[str, int]] = None, new_data: Optional[Dict[str, Any]] = None, **kwargs: Any ) -> Dict[str, Any]: """Update an object on the server. Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object **kwargs: Extra options to send to the server (e.g. sudo) Returns: The new object data (*not* a RESTObject) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUpdateError: If the server cannot perform the request """ new_data = new_data or {} data = new_data.copy() if "domain_whitelist" in data and data["domain_whitelist"] is None: data.pop("domain_whitelist") return super().update(id, data, **kwargs) def get(self, **kwargs: Any) -> ApplicationSettings: return cast(ApplicationSettings, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/sidekiq.py0000644000000000000000000000561414366036457020370 0ustar00rootrootfrom typing import Any, Dict, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager __all__ = [ "SidekiqManager", ] class SidekiqManager(RESTManager): """Manager for the Sidekiq methods. This manager doesn't actually manage objects but provides helper function for the sidekiq metrics API. """ @cli.register_custom_action("SidekiqManager") @exc.on_http_error(exc.GitlabGetError) def queue_metrics(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Return the registered queues information. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the information couldn't be retrieved Returns: Information about the Sidekiq queues """ return self.gitlab.http_get("/sidekiq/queue_metrics", **kwargs) @cli.register_custom_action("SidekiqManager") @exc.on_http_error(exc.GitlabGetError) def process_metrics( self, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Return the registered sidekiq workers. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the information couldn't be retrieved Returns: Information about the register Sidekiq worker """ return self.gitlab.http_get("/sidekiq/process_metrics", **kwargs) @cli.register_custom_action("SidekiqManager") @exc.on_http_error(exc.GitlabGetError) def job_stats(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Return statistics about the jobs performed. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the information couldn't be retrieved Returns: Statistics about the Sidekiq jobs performed """ return self.gitlab.http_get("/sidekiq/job_stats", **kwargs) @cli.register_custom_action("SidekiqManager") @exc.on_http_error(exc.GitlabGetError) def compound_metrics( self, **kwargs: Any ) -> Union[Dict[str, Any], requests.Response]: """Return all available metrics and statistics. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabGetError: If the information couldn't be retrieved Returns: All available Sidekiq metrics and statistics """ return self.gitlab.http_get("/sidekiq/compound_metrics", **kwargs) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/snippets.py0000644000000000000000000001304214366036457020576 0ustar00rootrootfrom typing import Any, Callable, cast, Iterator, List, Optional, TYPE_CHECKING, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import utils from gitlab.base import RESTManager, RESTObject, RESTObjectList from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin, UserAgentDetailMixin from gitlab.types import RequiredOptional from .award_emojis import ProjectSnippetAwardEmojiManager # noqa: F401 from .discussions import ProjectSnippetDiscussionManager # noqa: F401 from .notes import ProjectSnippetNoteManager # noqa: F401 __all__ = [ "Snippet", "SnippetManager", "ProjectSnippet", "ProjectSnippetManager", ] class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "title" @cli.register_custom_action("Snippet") @exc.on_http_error(exc.GitlabGetError) def content( self, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return the content of a snippet. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment. iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 content could not be retrieved Returns: The snippet content """ path = f"/snippets/{self.encoded_id}/raw" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) class SnippetManager(CRUDMixin, RESTManager): _path = "/snippets" _obj_cls = Snippet _create_attrs = RequiredOptional( required=("title", "file_name", "content"), optional=("lifetime", "visibility") ) _update_attrs = RequiredOptional( optional=("title", "file_name", "content", "visibility") ) @cli.register_custom_action("SnippetManager") def public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]: """List all the public snippets. Args: all: If True the returned object will be a list **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabListError: If the list could not be retrieved Returns: A generator for the snippets list """ return self.list(path="/snippets/public", **kwargs) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Snippet: return cast(Snippet, super().get(id=id, lazy=lazy, **kwargs)) class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject): _url = "/projects/{project_id}/snippets" _repr_attr = "title" awardemojis: ProjectSnippetAwardEmojiManager discussions: ProjectSnippetDiscussionManager notes: ProjectSnippetNoteManager @cli.register_custom_action("ProjectSnippet") @exc.on_http_error(exc.GitlabGetError) def content( self, streamed: bool = False, action: Optional[Callable[..., Any]] = None, chunk_size: int = 1024, *, iterator: bool = False, **kwargs: Any, ) -> Optional[Union[bytes, Iterator[Any]]]: """Return the content of a snippet. Args: streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment. iterator: If True directly return the underlying response iterator action: Callable responsible of dealing with chunk of data chunk_size: 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 content could not be retrieved Returns: The snippet content """ path = f"{self.manager.path}/{self.encoded_id}/raw" result = self.manager.gitlab.http_get( path, streamed=streamed, raw=True, **kwargs ) if TYPE_CHECKING: assert isinstance(result, requests.Response) return utils.response_content( result, streamed, action, chunk_size, iterator=iterator ) class ProjectSnippetManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/snippets" _obj_cls = ProjectSnippet _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("title", "file_name", "content", "visibility"), optional=("description",), ) _update_attrs = RequiredOptional( optional=("title", "file_name", "content", "visibility", "description"), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectSnippet: return cast(ProjectSnippet, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/statistics.py0000644000000000000000000000511614366036457021126 0ustar00rootrootfrom typing import Any, cast from gitlab.base import RESTManager, RESTObject from gitlab.mixins import GetWithoutIdMixin, RefreshMixin from gitlab.types import ArrayAttribute __all__ = [ "GroupIssuesStatistics", "GroupIssuesStatisticsManager", "ProjectAdditionalStatistics", "ProjectAdditionalStatisticsManager", "IssuesStatistics", "IssuesStatisticsManager", "ProjectIssuesStatistics", "ProjectIssuesStatisticsManager", "ApplicationStatistics", "ApplicationStatisticsManager", ] class ProjectAdditionalStatistics(RefreshMixin, RESTObject): _id_attr = None class ProjectAdditionalStatisticsManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/statistics" _obj_cls = ProjectAdditionalStatistics _from_parent_attrs = {"project_id": "id"} def get(self, **kwargs: Any) -> ProjectAdditionalStatistics: return cast(ProjectAdditionalStatistics, super().get(**kwargs)) class IssuesStatistics(RefreshMixin, RESTObject): _id_attr = None class IssuesStatisticsManager(GetWithoutIdMixin, RESTManager): _path = "/issues_statistics" _obj_cls = IssuesStatistics _list_filters = ("iids",) _types = {"iids": ArrayAttribute} def get(self, **kwargs: Any) -> IssuesStatistics: return cast(IssuesStatistics, super().get(**kwargs)) class GroupIssuesStatistics(RefreshMixin, RESTObject): _id_attr = None class GroupIssuesStatisticsManager(GetWithoutIdMixin, RESTManager): _path = "/groups/{group_id}/issues_statistics" _obj_cls = GroupIssuesStatistics _from_parent_attrs = {"group_id": "id"} _list_filters = ("iids",) _types = {"iids": ArrayAttribute} def get(self, **kwargs: Any) -> GroupIssuesStatistics: return cast(GroupIssuesStatistics, super().get(**kwargs)) class ProjectIssuesStatistics(RefreshMixin, RESTObject): _id_attr = None class ProjectIssuesStatisticsManager(GetWithoutIdMixin, RESTManager): _path = "/projects/{project_id}/issues_statistics" _obj_cls = ProjectIssuesStatistics _from_parent_attrs = {"project_id": "id"} _list_filters = ("iids",) _types = {"iids": ArrayAttribute} def get(self, **kwargs: Any) -> ProjectIssuesStatistics: return cast(ProjectIssuesStatistics, super().get(**kwargs)) class ApplicationStatistics(RESTObject): _id_attr = None class ApplicationStatisticsManager(GetWithoutIdMixin, RESTManager): _path = "/application/statistics" _obj_cls = ApplicationStatistics def get(self, **kwargs: Any) -> ApplicationStatistics: return cast(ApplicationStatistics, super().get(**kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/tags.py0000644000000000000000000000265514366036457017677 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin from gitlab.types import RequiredOptional __all__ = [ "ProjectTag", "ProjectTagManager", "ProjectProtectedTag", "ProjectProtectedTagManager", ] class ProjectTag(ObjectDeleteMixin, RESTObject): _id_attr = "name" _repr_attr = "name" class ProjectTagManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/repository/tags" _obj_cls = ProjectTag _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("tag_name", "ref"), optional=("message",) ) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectTag: return cast(ProjectTag, super().get(id=id, lazy=lazy, **kwargs)) class ProjectProtectedTag(ObjectDeleteMixin, RESTObject): _id_attr = "name" _repr_attr = "name" class ProjectProtectedTagManager(NoUpdateMixin, RESTManager): _path = "/projects/{project_id}/protected_tags" _obj_cls = ProjectProtectedTag _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name",), optional=("create_access_level",) ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectProtectedTag: return cast(ProjectProtectedTag, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/templates.py0000644000000000000000000000327614366036457020737 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import RetrieveMixin __all__ = [ "Dockerfile", "DockerfileManager", "Gitignore", "GitignoreManager", "Gitlabciyml", "GitlabciymlManager", "License", "LicenseManager", ] class Dockerfile(RESTObject): _id_attr = "name" class DockerfileManager(RetrieveMixin, RESTManager): _path = "/templates/dockerfiles" _obj_cls = Dockerfile def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Dockerfile: return cast(Dockerfile, super().get(id=id, lazy=lazy, **kwargs)) class Gitignore(RESTObject): _id_attr = "name" class GitignoreManager(RetrieveMixin, RESTManager): _path = "/templates/gitignores" _obj_cls = Gitignore def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Gitignore: return cast(Gitignore, super().get(id=id, lazy=lazy, **kwargs)) class Gitlabciyml(RESTObject): _id_attr = "name" class GitlabciymlManager(RetrieveMixin, RESTManager): _path = "/templates/gitlab_ci_ymls" _obj_cls = Gitlabciyml def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> Gitlabciyml: return cast(Gitlabciyml, super().get(id=id, lazy=lazy, **kwargs)) class License(RESTObject): _id_attr = "key" class LicenseManager(RetrieveMixin, RESTManager): _path = "/templates/licenses" _obj_cls = License _list_filters = ("popular",) _optional_get_attrs = ("project", "fullname") def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> License: return cast(License, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/todos.py0000644000000000000000000000344214366036457020064 0ustar00rootrootfrom typing import Any, Dict, TYPE_CHECKING from gitlab import cli from gitlab import exceptions as exc from gitlab.base import RESTManager, RESTObject from gitlab.mixins import DeleteMixin, ListMixin, ObjectDeleteMixin __all__ = [ "Todo", "TodoManager", ] class Todo(ObjectDeleteMixin, RESTObject): @cli.register_custom_action("Todo") @exc.on_http_error(exc.GitlabTodoError) def mark_as_done(self, **kwargs: Any) -> Dict[str, Any]: """Mark the todo as done. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTodoError: If the server failed to perform the request Returns: A dict with the result """ path = f"{self.manager.path}/{self.encoded_id}/mark_as_done" server_data = self.manager.gitlab.http_post(path, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) self._update_attrs(server_data) return server_data class TodoManager(ListMixin, DeleteMixin, RESTManager): _path = "/todos" _obj_cls = Todo _list_filters = ("action", "author_id", "project_id", "state", "type") @cli.register_custom_action("TodoManager") @exc.on_http_error(exc.GitlabTodoError) def mark_all_as_done(self, **kwargs: Any) -> None: """Mark all the todos as done. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTodoError: If the server failed to perform the request Returns: The number of todos marked done """ self.gitlab.http_post("/todos/mark_as_done", **kwargs) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/topics.py0000644000000000000000000000422714366036457020237 0ustar00rootrootfrom typing import Any, cast, Dict, TYPE_CHECKING, Union from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "Topic", "TopicManager", ] class Topic(SaveMixin, ObjectDeleteMixin, RESTObject): pass class TopicManager(CRUDMixin, RESTManager): _path = "/topics" _obj_cls = Topic _create_attrs = RequiredOptional( # NOTE: The `title` field was added and is required in GitLab 15.0 or # newer. But not present before that. required=("name",), optional=("avatar", "description", "title"), ) _update_attrs = RequiredOptional(optional=("avatar", "description", "name")) _types = {"avatar": types.ImageAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Topic: return cast(Topic, super().get(id=id, lazy=lazy, **kwargs)) @cli.register_custom_action( "TopicManager", mandatory=("source_topic_id", "target_topic_id"), ) @exc.on_http_error(exc.GitlabMRClosedError) def merge( self, source_topic_id: Union[int, str], target_topic_id: Union[int, str], **kwargs: Any, ) -> Dict[str, Any]: """Merge two topics, assigning all projects to the target topic. Args: source_topic_id: ID of source project topic target_topic_id: ID of target project topic **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabTopicMergeError: If the merge failed Returns: The merged topic data (*not* a RESTObject) """ path = f"{self.path}/merge" data = { "source_topic_id": source_topic_id, "target_topic_id": target_topic_id, } server_data = self.gitlab.http_post(path, post_data=data, **kwargs) if TYPE_CHECKING: assert isinstance(server_data, dict) return server_data ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/triggers.py0000644000000000000000000000147014366036457020561 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "ProjectTrigger", "ProjectTriggerManager", ] class ProjectTrigger(SaveMixin, ObjectDeleteMixin, RESTObject): pass class ProjectTriggerManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/triggers" _obj_cls = ProjectTrigger _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional(required=("description",)) _update_attrs = RequiredOptional(required=("description",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectTrigger: return cast(ProjectTrigger, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/users.py0000644000000000000000000005012514366036457020075 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/users.html https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user """ from typing import Any, cast, Dict, List, Optional, Union import requests from gitlab import cli from gitlab import exceptions as exc from gitlab import types from gitlab.base import RESTManager, RESTObject, RESTObjectList from gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, GetWithoutIdMixin, ListMixin, NoUpdateMixin, ObjectDeleteMixin, RetrieveMixin, SaveMixin, UpdateMixin, ) from gitlab.types import ArrayAttribute, RequiredOptional from .custom_attributes import UserCustomAttributeManager # noqa: F401 from .events import UserEventManager # noqa: F401 from .personal_access_tokens import UserPersonalAccessTokenManager # noqa: F401 __all__ = [ "CurrentUserEmail", "CurrentUserEmailManager", "CurrentUserGPGKey", "CurrentUserGPGKeyManager", "CurrentUserKey", "CurrentUserKeyManager", "CurrentUserStatus", "CurrentUserStatusManager", "CurrentUser", "CurrentUserManager", "User", "UserManager", "ProjectUser", "ProjectUserManager", "StarredProject", "StarredProjectManager", "UserEmail", "UserEmailManager", "UserActivities", "UserStatus", "UserStatusManager", "UserActivitiesManager", "UserGPGKey", "UserGPGKeyManager", "UserKey", "UserKeyManager", "UserIdentityProviderManager", "UserImpersonationToken", "UserImpersonationTokenManager", "UserMembership", "UserMembershipManager", "UserProject", "UserProjectManager", ] class CurrentUserEmail(ObjectDeleteMixin, RESTObject): _repr_attr = "email" class CurrentUserEmailManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/user/emails" _obj_cls = CurrentUserEmail _create_attrs = RequiredOptional(required=("email",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> CurrentUserEmail: return cast(CurrentUserEmail, super().get(id=id, lazy=lazy, **kwargs)) class CurrentUserGPGKey(ObjectDeleteMixin, RESTObject): pass class CurrentUserGPGKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/user/gpg_keys" _obj_cls = CurrentUserGPGKey _create_attrs = RequiredOptional(required=("key",)) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> CurrentUserGPGKey: return cast(CurrentUserGPGKey, super().get(id=id, lazy=lazy, **kwargs)) class CurrentUserKey(ObjectDeleteMixin, RESTObject): _repr_attr = "title" class CurrentUserKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/user/keys" _obj_cls = CurrentUserKey _create_attrs = RequiredOptional(required=("title", "key")) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> CurrentUserKey: return cast(CurrentUserKey, super().get(id=id, lazy=lazy, **kwargs)) class CurrentUserStatus(SaveMixin, RESTObject): _id_attr = None _repr_attr = "message" class CurrentUserStatusManager(GetWithoutIdMixin, UpdateMixin, RESTManager): _path = "/user/status" _obj_cls = CurrentUserStatus _update_attrs = RequiredOptional(optional=("emoji", "message")) def get(self, **kwargs: Any) -> CurrentUserStatus: return cast(CurrentUserStatus, super().get(**kwargs)) class CurrentUser(RESTObject): _id_attr = None _repr_attr = "username" emails: CurrentUserEmailManager gpgkeys: CurrentUserGPGKeyManager keys: CurrentUserKeyManager status: CurrentUserStatusManager class CurrentUserManager(GetWithoutIdMixin, RESTManager): _path = "/user" _obj_cls = CurrentUser def get(self, **kwargs: Any) -> CurrentUser: return cast(CurrentUser, super().get(**kwargs)) class User(SaveMixin, ObjectDeleteMixin, RESTObject): _repr_attr = "username" customattributes: UserCustomAttributeManager emails: "UserEmailManager" events: UserEventManager followers_users: "UserFollowersManager" following_users: "UserFollowingManager" gpgkeys: "UserGPGKeyManager" identityproviders: "UserIdentityProviderManager" impersonationtokens: "UserImpersonationTokenManager" keys: "UserKeyManager" memberships: "UserMembershipManager" personal_access_tokens: UserPersonalAccessTokenManager projects: "UserProjectManager" starred_projects: "StarredProjectManager" status: "UserStatusManager" @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabBlockError) def block(self, **kwargs: Any) -> Optional[bool]: """Block the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabBlockError: If the user could not be blocked Returns: Whether the user status has been changed """ path = f"/users/{self.encoded_id}/block" # NOTE: Undocumented behavior of the GitLab API is that it returns a # boolean or None server_data = cast( Optional[bool], self.manager.gitlab.http_post(path, **kwargs) ) if server_data is True: self._attrs["state"] = "blocked" return server_data @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabFollowError) def follow(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Follow the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabFollowError: If the user could not be followed Returns: The new object data (*not* a RESTObject) """ path = f"/users/{self.encoded_id}/follow" return self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabUnfollowError) def unfollow(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Unfollow the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUnfollowError: If the user could not be followed Returns: The new object data (*not* a RESTObject) """ path = f"/users/{self.encoded_id}/unfollow" return self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabUnblockError) def unblock(self, **kwargs: Any) -> Optional[bool]: """Unblock the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUnblockError: If the user could not be unblocked Returns: Whether the user status has been changed """ path = f"/users/{self.encoded_id}/unblock" # NOTE: Undocumented behavior of the GitLab API is that it returns a # boolean or None server_data = cast( Optional[bool], self.manager.gitlab.http_post(path, **kwargs) ) if server_data is True: self._attrs["state"] = "active" return server_data @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabDeactivateError) def deactivate(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Deactivate the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabDeactivateError: If the user could not be deactivated Returns: Whether the user status has been changed """ path = f"/users/{self.encoded_id}/deactivate" server_data = self.manager.gitlab.http_post(path, **kwargs) if server_data: self._attrs["state"] = "deactivated" return server_data @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabActivateError) def activate(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Activate the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabActivateError: If the user could not be activated Returns: Whether the user status has been changed """ path = f"/users/{self.encoded_id}/activate" server_data = self.manager.gitlab.http_post(path, **kwargs) if server_data: self._attrs["state"] = "active" return server_data @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabUserApproveError) def approve(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Approve a user creation request. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUserApproveError: If the user could not be activated Returns: The new object data (*not* a RESTObject) """ path = f"/users/{self.encoded_id}/approve" return self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabUserRejectError) def reject(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Reject a user creation request. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUserRejectError: If the user could not be rejected Returns: The new object data (*not* a RESTObject) """ path = f"/users/{self.encoded_id}/reject" return self.manager.gitlab.http_post(path, **kwargs) @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabBanError) def ban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Ban the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabBanError: If the user could not be banned Returns: Whether the user has been banned """ path = f"/users/{self.encoded_id}/ban" server_data = self.manager.gitlab.http_post(path, **kwargs) if server_data: self._attrs["state"] = "banned" return server_data @cli.register_custom_action("User") @exc.on_http_error(exc.GitlabUnbanError) def unban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]: """Unban the user. Args: **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct GitlabUnbanError: If the user could not be unbanned Returns: Whether the user has been unbanned """ path = f"/users/{self.encoded_id}/unban" server_data = self.manager.gitlab.http_post(path, **kwargs) if server_data: self._attrs["state"] = "active" return server_data class UserManager(CRUDMixin, RESTManager): _path = "/users" _obj_cls = User _list_filters = ( "active", "blocked", "username", "extern_uid", "provider", "external", "search", "custom_attributes", "status", "two_factor", ) _create_attrs = RequiredOptional( optional=( "email", "username", "name", "password", "reset_password", "skype", "linkedin", "twitter", "projects_limit", "extern_uid", "provider", "bio", "admin", "can_create_group", "website_url", "skip_confirmation", "external", "organization", "location", "avatar", "public_email", "private_profile", "color_scheme_id", "theme_id", ), ) _update_attrs = RequiredOptional( required=("email", "username", "name"), optional=( "password", "skype", "linkedin", "twitter", "projects_limit", "extern_uid", "provider", "bio", "admin", "can_create_group", "website_url", "skip_reconfirmation", "external", "organization", "location", "avatar", "public_email", "private_profile", "color_scheme_id", "theme_id", ), ) _types = {"confirm": types.LowercaseStringAttribute, "avatar": types.ImageAttribute} def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> User: return cast(User, super().get(id=id, lazy=lazy, **kwargs)) class ProjectUser(RESTObject): pass class ProjectUserManager(ListMixin, RESTManager): _path = "/projects/{project_id}/users" _obj_cls = ProjectUser _from_parent_attrs = {"project_id": "id"} _list_filters = ("search", "skip_users") _types = {"skip_users": types.ArrayAttribute} class UserEmail(ObjectDeleteMixin, RESTObject): _repr_attr = "email" class UserEmailManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/users/{user_id}/emails" _obj_cls = UserEmail _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional(required=("email",)) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> UserEmail: return cast(UserEmail, super().get(id=id, lazy=lazy, **kwargs)) class UserActivities(RESTObject): _id_attr = "username" class UserStatus(RESTObject): _id_attr = None _repr_attr = "message" class UserStatusManager(GetWithoutIdMixin, RESTManager): _path = "/users/{user_id}/status" _obj_cls = UserStatus _from_parent_attrs = {"user_id": "id"} def get(self, **kwargs: Any) -> UserStatus: return cast(UserStatus, super().get(**kwargs)) class UserActivitiesManager(ListMixin, RESTManager): _path = "/user/activities" _obj_cls = UserActivities class UserGPGKey(ObjectDeleteMixin, RESTObject): pass class UserGPGKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/users/{user_id}/gpg_keys" _obj_cls = UserGPGKey _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional(required=("key",)) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> UserGPGKey: return cast(UserGPGKey, super().get(id=id, lazy=lazy, **kwargs)) class UserKey(ObjectDeleteMixin, RESTObject): pass class UserKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager): _path = "/users/{user_id}/keys" _obj_cls = UserKey _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional(required=("title", "key")) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> UserKey: return cast(UserKey, super().get(id=id, lazy=lazy, **kwargs)) class UserIdentityProviderManager(DeleteMixin, RESTManager): """Manager for user identities. This manager does not actually manage objects but enables functionality for deletion of user identities by provider. """ _path = "/users/{user_id}/identities" _from_parent_attrs = {"user_id": "id"} class UserImpersonationToken(ObjectDeleteMixin, RESTObject): pass class UserImpersonationTokenManager(NoUpdateMixin, RESTManager): _path = "/users/{user_id}/impersonation_tokens" _obj_cls = UserImpersonationToken _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional( required=("name", "scopes"), optional=("expires_at",) ) _list_filters = ("state",) _types = {"scopes": ArrayAttribute} def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> UserImpersonationToken: return cast(UserImpersonationToken, super().get(id=id, lazy=lazy, **kwargs)) class UserMembership(RESTObject): _id_attr = "source_id" class UserMembershipManager(RetrieveMixin, RESTManager): _path = "/users/{user_id}/memberships" _obj_cls = UserMembership _from_parent_attrs = {"user_id": "id"} _list_filters = ("type",) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> UserMembership: return cast(UserMembership, super().get(id=id, lazy=lazy, **kwargs)) # Having this outside projects avoids circular imports due to ProjectUser class UserProject(RESTObject): pass class UserProjectManager(ListMixin, CreateMixin, RESTManager): _path = "/projects/user/{user_id}" _obj_cls = UserProject _from_parent_attrs = {"user_id": "id"} _create_attrs = RequiredOptional( required=("name",), optional=( "default_branch", "issues_enabled", "wall_enabled", "merge_requests_enabled", "wiki_enabled", "snippets_enabled", "squash_option", "public", "visibility", "description", "builds_enabled", "public_builds", "import_url", "only_allow_merge_if_build_succeeds", ), ) _list_filters = ( "archived", "visibility", "order_by", "sort", "search", "simple", "owned", "membership", "starred", "statistics", "with_issues_enabled", "with_merge_requests_enabled", "with_custom_attributes", "with_programming_language", "wiki_checksum_failed", "repository_checksum_failed", "min_access_level", "id_after", "id_before", ) def list(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]: """Retrieve a list of objects. Args: 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) iterator: If set to True and no pagination option is defined, 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 if `iterator` is True Raises: GitlabAuthenticationError: If authentication is not correct GitlabListError: If the server cannot perform the request """ if self._parent: path = f"/users/{self._parent.id}/projects" else: path = f"/users/{kwargs['user_id']}/projects" return ListMixin.list(self, path=path, **kwargs) class StarredProject(RESTObject): pass class StarredProjectManager(ListMixin, RESTManager): _path = "/users/{user_id}/starred_projects" _obj_cls = StarredProject _from_parent_attrs = {"user_id": "id"} _list_filters = ( "archived", "membership", "min_access_level", "order_by", "owned", "search", "simple", "sort", "starred", "statistics", "visibility", "with_custom_attributes", "with_issues_enabled", "with_merge_requests_enabled", ) class UserFollowersManager(ListMixin, RESTManager): _path = "/users/{user_id}/followers" _obj_cls = User _from_parent_attrs = {"user_id": "id"} class UserFollowingManager(ListMixin, RESTManager): _path = "/users/{user_id}/following" _obj_cls = User _from_parent_attrs = {"user_id": "id"} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/variables.py0000644000000000000000000000510214366036457020677 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/instance_level_ci_variables.html https://docs.gitlab.com/ee/api/project_level_variables.html https://docs.gitlab.com/ee/api/group_level_variables.html """ from typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "Variable", "VariableManager", "GroupVariable", "GroupVariableManager", "ProjectVariable", "ProjectVariableManager", ] class Variable(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "key" class VariableManager(CRUDMixin, RESTManager): _path = "/admin/ci/variables" _obj_cls = Variable _create_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked") ) _update_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked") ) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Variable: return cast(Variable, super().get(id=id, lazy=lazy, **kwargs)) class GroupVariable(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "key" class GroupVariableManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/variables" _obj_cls = GroupVariable _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked") ) _update_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked") ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> GroupVariable: return cast(GroupVariable, super().get(id=id, lazy=lazy, **kwargs)) class ProjectVariable(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "key" class ProjectVariableManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/variables" _obj_cls = ProjectVariable _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked", "environment_scope"), ) _update_attrs = RequiredOptional( required=("key", "value"), optional=("protected", "variable_type", "masked", "environment_scope"), ) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectVariable: return cast(ProjectVariable, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/gitlab/v4/objects/wikis.py0000644000000000000000000000312014366036457020053 0ustar00rootrootfrom typing import Any, cast, Union from gitlab.base import RESTManager, RESTObject from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin from gitlab.types import RequiredOptional __all__ = [ "ProjectWiki", "ProjectWikiManager", "GroupWiki", "GroupWikiManager", ] class ProjectWiki(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "slug" _repr_attr = "slug" class ProjectWikiManager(CRUDMixin, RESTManager): _path = "/projects/{project_id}/wikis" _obj_cls = ProjectWiki _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("title", "content"), optional=("format",) ) _update_attrs = RequiredOptional(optional=("title", "content", "format")) _list_filters = ("with_content",) def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> ProjectWiki: return cast(ProjectWiki, super().get(id=id, lazy=lazy, **kwargs)) class GroupWiki(SaveMixin, ObjectDeleteMixin, RESTObject): _id_attr = "slug" _repr_attr = "slug" class GroupWikiManager(CRUDMixin, RESTManager): _path = "/groups/{group_id}/wikis" _obj_cls = GroupWiki _from_parent_attrs = {"group_id": "id"} _create_attrs = RequiredOptional( required=("title", "content"), optional=("format",) ) _update_attrs = RequiredOptional(optional=("title", "content", "format")) _list_filters = ("with_content",) def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> GroupWiki: return cast(GroupWiki, super().get(id=id, lazy=lazy, **kwargs)) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/pyproject.toml0000644000000000000000000000363314366036457016054 0ustar00rootroot[tool.isort] profile = "black" multi_line_output = 3 order_by_type = false [tool.mypy] files = "." exclude = "build/.*" strict = true # Overrides for currently untyped modules [[tool.mypy.overrides]] module = [ "docs.*", "docs.ext.*", "tests.unit.*", ] ignore_errors = true [[tool.mypy.overrides]] module = [ "tests.functional.*", "tests.functional.api.*", "tests.meta.*", "tests.smoke.*", ] disable_error_code = ["no-untyped-def"] [tool.semantic_release] branch = "main" version_variable = "gitlab/_version.py:__version__" commit_subject = "chore: release v{version}" commit_message = "" [tool.pylint.messages_control] max-line-length = 88 jobs = 0 # Use auto-detected number of multiple processes to speed up Pylint. # TODO(jlvilla): Work on removing these disables over time. disable = [ "arguments-differ", "arguments-renamed", "broad-except", "cyclic-import", "duplicate-code", "import-outside-toplevel", "invalid-name", "missing-class-docstring", "missing-function-docstring", "missing-module-docstring", "not-callable", "protected-access", "redefined-builtin", "signature-differs", "too-few-public-methods", "too-many-ancestors", "too-many-arguments", "too-many-branches", "too-many-instance-attributes", "too-many-lines", "too-many-locals", "too-many-statements", "unsubscriptable-object", ] [tool.pytest.ini_options] xfail_strict = true markers = [ "gitlab_premium: marks tests that require GitLab Premium", "gitlab_ultimate: marks tests that require GitLab Ultimate", ] # If 'log_cli=True' the following apply # NOTE: If set 'log_cli_level' to 'DEBUG' will show a log of all of the HTTP requests # made in functional tests. log_cli_level = "INFO" log_cli_format = "%(asctime)s.%(msecs)03d [%(levelname)8s] (%(filename)s:%(funcName)s:L%(lineno)s) %(message)s" log_cli_date_format = "%Y-%m-%d %H:%M:%S" ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3107913 python-gitlab-3.13.0/python_gitlab.egg-info/0000755000000000000000000000000014366036463017465 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/PKG-INFO0000644000000000000000000001554414366036463020573 0ustar00rootrootMetadata-Version: 2.1 Name: python-gitlab Version: 3.13.0 Summary: Interact with GitLab API Home-page: https://github.com/python-gitlab/python-gitlab Author: Gauvain Pocentek Author-email: gauvain@pocentek.net License: LGPL-3.0-or-later Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3) Classifier: Natural Language :: English Classifier: Operating System :: POSIX Classifier: Operating System :: Microsoft :: Windows Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Requires-Python: >=3.7.0 Description-Content-Type: text/x-rst Provides-Extra: autocompletion Provides-Extra: yaml License-File: COPYING License-File: AUTHORS python-gitlab ============= .. image:: https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg :target: https://github.com/python-gitlab/python-gitlab/actions .. image:: https://badge.fury.io/py/python-gitlab.svg :target: https://badge.fury.io/py/python-gitlab .. image:: https://readthedocs.org/projects/python-gitlab/badge/?version=latest :target: https://python-gitlab.readthedocs.org/en/latest/?badge=latest .. image:: https://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=main :target: https://codecov.io/github/python-gitlab/python-gitlab?branch=main .. image:: https://img.shields.io/pypi/pyversions/python-gitlab.svg :target: https://pypi.python.org/pypi/python-gitlab .. image:: https://img.shields.io/gitter/room/python-gitlab/Lobby.svg :target: https://gitter.im/python-gitlab/Lobby .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black .. image:: https://img.shields.io/github/license/python-gitlab/python-gitlab :target: https://github.com/python-gitlab/python-gitlab/blob/main/COPYING ``python-gitlab`` is a Python package providing access to the GitLab server API. It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``). .. _features: Features -------- ``python-gitlab`` enables you to: * write Pythonic code to manage your GitLab resources. * pass arbitrary parameters to the GitLab API. Simply follow GitLab's docs on what parameters are available. * access arbitrary endpoints as soon as they are available on GitLab, by using lower-level API methods. * use persistent requests sessions for authentication, proxy and certificate handling. * handle smart retries on network and server errors, with rate-limit handling. * flexible handling of paginated responses, including lazy iterators. * automatically URL-encode paths and parameters where needed. * automatically convert some complex data structures to API attribute types * merge configuration from config files, environment variables and arguments. Installation ------------ As of 3.0.0, ``python-gitlab`` is compatible with Python 3.7+. Use ``pip`` to install the latest stable version of ``python-gitlab``: .. code-block:: console $ pip install --upgrade python-gitlab The current development version is available on both `GitHub.com `__ and `GitLab.com `__, and can be installed directly from the git repository: .. code-block:: console $ pip install git+https://github.com/python-gitlab/python-gitlab.git From GitLab: .. code-block:: console $ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git Using the docker images ----------------------- ``python-gitlab`` provides Docker images in two flavors, based on the Alpine and Debian slim python `base images `__. The default tag is ``alpine``, but you can explicitly use the alias (see below). The alpine image is smaller, but you may want to use the Debian-based slim tag (currently based on ``-slim-bullseye``) if you are running into issues or need a more complete environment with a bash shell, such as in CI jobs. The images are published on the GitLab registry, for example: * ``registry.gitlab.com/python-gitlab/python-gitlab:latest`` (latest, alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:alpine`` (latest alpine) * ``registry.gitlab.com/python-gitlab/python-gitlab:slim-bullseye`` (latest slim-bullseye) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0`` (alpine alias) * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-alpine`` * ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye`` You can run the Docker image directly from the GitLab registry: .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest ... For example, to get a project on GitLab.com (without authentication): .. code-block:: console $ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest project get --id gitlab-org/gitlab You can also mount your own config file: .. code-block:: console $ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest ... Building the image ~~~~~~~~~~~~~~~~~~ To build your own image from this repository, run: .. code-block:: console $ docker build -t python-gitlab:latest . Run your own image: .. code-block:: console $ docker run -it --rm python-gitlab:latest ... Build a Debian slim-based image: .. code-block:: console $ docker build -t python-gitlab:latest --build-arg PYTHON_FLAVOR=slim-bullseye . Bug reports ----------- Please report bugs and feature requests at https://github.com/python-gitlab/python-gitlab/issues. Gitter Community Chat --------------------- We have a `gitter `_ community chat available at https://gitter.im/python-gitlab/Lobby, which you can also directly access via the Open Chat button below. If you have a simple question, the community might be able to help already, without you opening an issue. If you regularly use python-gitlab, we also encourage you to join and participate. You might discover new ideas and use cases yourself! Documentation ------------- The full documentation for CLI and API is available on `readthedocs `_. Build the docs ~~~~~~~~~~~~~~ We use ``tox`` to manage our environment and build the documentation:: pip install tox tox -e docs Contributing ------------ For guidelines for contributing to ``python-gitlab``, refer to `CONTRIBUTING.rst `_. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/SOURCES.txt0000644000000000000000000002403614366036463021356 0ustar00rootrootAUTHORS CHANGELOG.md COPYING MANIFEST.in README.rst pyproject.toml requirements-docker.txt requirements-docs.txt requirements-lint.txt requirements-precommit.txt requirements-test.txt requirements.txt setup.py tox.ini docs/Makefile docs/__init__.py docs/api-levels.rst docs/api-objects.rst docs/api-usage-advanced.rst docs/api-usage.rst docs/changelog.md docs/cli-examples.rst docs/cli-objects.rst docs/cli-usage.rst docs/conf.py docs/faq.rst docs/index.rst docs/make.bat docs/release-notes.rst docs/_static/js/gitter.js docs/api/gitlab.rst docs/api/gitlab.v4.rst docs/ext/__init__.py docs/ext/docstrings.py docs/ext/manager_tmpl.j2 docs/gl_objects/access_requests.rst docs/gl_objects/appearance.rst docs/gl_objects/applications.rst docs/gl_objects/badges.rst docs/gl_objects/boards.rst docs/gl_objects/branches.rst docs/gl_objects/bulk_imports.rst docs/gl_objects/ci_lint.rst docs/gl_objects/clusters.rst docs/gl_objects/commits.rst docs/gl_objects/deploy_keys.rst docs/gl_objects/deploy_tokens.rst docs/gl_objects/deployments.rst docs/gl_objects/discussions.rst docs/gl_objects/emojis.rst docs/gl_objects/environments.rst docs/gl_objects/epics.rst docs/gl_objects/events.rst docs/gl_objects/features.rst docs/gl_objects/geo_nodes.rst docs/gl_objects/group_access_tokens.rst docs/gl_objects/groups.rst docs/gl_objects/invitations.rst docs/gl_objects/issues.rst docs/gl_objects/iterations.rst docs/gl_objects/keys.rst docs/gl_objects/labels.rst docs/gl_objects/merge_request_approvals.rst docs/gl_objects/merge_requests.rst docs/gl_objects/merge_trains.rst docs/gl_objects/messages.rst docs/gl_objects/milestones.rst docs/gl_objects/namespaces.rst docs/gl_objects/notes.rst docs/gl_objects/notifications.rst docs/gl_objects/packages.rst docs/gl_objects/pagesdomains.rst docs/gl_objects/personal_access_tokens.rst docs/gl_objects/pipelines_and_jobs.rst docs/gl_objects/project_access_tokens.rst docs/gl_objects/projects.rst docs/gl_objects/protected_branches.rst docs/gl_objects/protected_environments.rst docs/gl_objects/releases.rst docs/gl_objects/remote_mirrors.rst docs/gl_objects/repositories.rst docs/gl_objects/repository_tags.rst docs/gl_objects/resource_groups.rst docs/gl_objects/runners.rst docs/gl_objects/search.rst docs/gl_objects/secure_files.rst docs/gl_objects/settings.rst docs/gl_objects/sidekiq.rst docs/gl_objects/snippets.rst docs/gl_objects/statistics.rst docs/gl_objects/system_hooks.rst docs/gl_objects/templates.rst docs/gl_objects/todos.rst docs/gl_objects/topics.rst docs/gl_objects/users.rst docs/gl_objects/variables.rst docs/gl_objects/wikis.rst gitlab/__init__.py gitlab/__main__.py gitlab/_version.py gitlab/base.py gitlab/cli.py gitlab/client.py gitlab/config.py gitlab/const.py gitlab/exceptions.py gitlab/mixins.py gitlab/py.typed gitlab/types.py gitlab/utils.py gitlab/_backends/__init__.py gitlab/_backends/requests_backend.py gitlab/v4/__init__.py gitlab/v4/cli.py gitlab/v4/objects/__init__.py gitlab/v4/objects/access_requests.py gitlab/v4/objects/appearance.py gitlab/v4/objects/applications.py gitlab/v4/objects/artifacts.py gitlab/v4/objects/audit_events.py gitlab/v4/objects/award_emojis.py gitlab/v4/objects/badges.py gitlab/v4/objects/boards.py gitlab/v4/objects/branches.py gitlab/v4/objects/broadcast_messages.py gitlab/v4/objects/bulk_imports.py gitlab/v4/objects/ci_lint.py gitlab/v4/objects/clusters.py gitlab/v4/objects/commits.py gitlab/v4/objects/container_registry.py gitlab/v4/objects/custom_attributes.py gitlab/v4/objects/deploy_keys.py gitlab/v4/objects/deploy_tokens.py gitlab/v4/objects/deployments.py gitlab/v4/objects/discussions.py gitlab/v4/objects/environments.py gitlab/v4/objects/epics.py gitlab/v4/objects/events.py gitlab/v4/objects/export_import.py gitlab/v4/objects/features.py gitlab/v4/objects/files.py gitlab/v4/objects/geo_nodes.py gitlab/v4/objects/group_access_tokens.py gitlab/v4/objects/groups.py gitlab/v4/objects/hooks.py gitlab/v4/objects/integrations.py gitlab/v4/objects/invitations.py gitlab/v4/objects/issues.py gitlab/v4/objects/iterations.py gitlab/v4/objects/jobs.py gitlab/v4/objects/keys.py gitlab/v4/objects/labels.py gitlab/v4/objects/ldap.py gitlab/v4/objects/members.py gitlab/v4/objects/merge_request_approvals.py gitlab/v4/objects/merge_requests.py gitlab/v4/objects/merge_trains.py gitlab/v4/objects/milestones.py gitlab/v4/objects/namespaces.py gitlab/v4/objects/notes.py gitlab/v4/objects/notification_settings.py gitlab/v4/objects/packages.py gitlab/v4/objects/pages.py gitlab/v4/objects/personal_access_tokens.py gitlab/v4/objects/pipelines.py gitlab/v4/objects/project_access_tokens.py gitlab/v4/objects/projects.py gitlab/v4/objects/push_rules.py gitlab/v4/objects/releases.py gitlab/v4/objects/repositories.py gitlab/v4/objects/resource_groups.py gitlab/v4/objects/runners.py gitlab/v4/objects/secure_files.py gitlab/v4/objects/settings.py gitlab/v4/objects/sidekiq.py gitlab/v4/objects/snippets.py gitlab/v4/objects/statistics.py gitlab/v4/objects/tags.py gitlab/v4/objects/templates.py gitlab/v4/objects/todos.py gitlab/v4/objects/topics.py gitlab/v4/objects/triggers.py gitlab/v4/objects/users.py gitlab/v4/objects/variables.py gitlab/v4/objects/wikis.py python_gitlab.egg-info/PKG-INFO python_gitlab.egg-info/SOURCES.txt python_gitlab.egg-info/dependency_links.txt python_gitlab.egg-info/entry_points.txt python_gitlab.egg-info/requires.txt python_gitlab.egg-info/top_level.txt tests/__init__.py tests/conftest.py tests/functional/__init__.py tests/functional/conftest.py tests/functional/ee-test.py tests/functional/helpers.py tests/functional/api/__init__.py tests/functional/api/test_boards.py tests/functional/api/test_branches.py tests/functional/api/test_bulk_imports.py tests/functional/api/test_current_user.py tests/functional/api/test_deploy_keys.py tests/functional/api/test_deploy_tokens.py tests/functional/api/test_epics.py tests/functional/api/test_gitlab.py tests/functional/api/test_groups.py tests/functional/api/test_import_export.py tests/functional/api/test_issues.py tests/functional/api/test_keys.py tests/functional/api/test_lazy_objects.py tests/functional/api/test_merge_requests.py tests/functional/api/test_packages.py tests/functional/api/test_projects.py tests/functional/api/test_push_rules.py tests/functional/api/test_releases.py tests/functional/api/test_repository.py tests/functional/api/test_services.py tests/functional/api/test_snippets.py tests/functional/api/test_statistics.py tests/functional/api/test_topics.py tests/functional/api/test_users.py tests/functional/api/test_variables.py tests/functional/api/test_wikis.py tests/functional/cli/__init__.py tests/functional/cli/conftest.py tests/functional/cli/test_cli.py tests/functional/cli/test_cli_artifacts.py tests/functional/cli/test_cli_packages.py tests/functional/cli/test_cli_projects.py tests/functional/cli/test_cli_repository.py tests/functional/cli/test_cli_resource_access_tokens.py tests/functional/cli/test_cli_users.py tests/functional/cli/test_cli_v4.py tests/functional/cli/test_cli_variables.py tests/functional/fixtures/.env tests/functional/fixtures/__init__.py tests/functional/fixtures/avatar.png tests/functional/fixtures/create_license.rb tests/functional/fixtures/docker-compose.yml tests/functional/fixtures/docker.py tests/functional/fixtures/invalid_auth.cfg tests/functional/fixtures/invalid_version.cfg tests/functional/fixtures/set_token.rb tests/install/test_install.py tests/meta/__init__.py tests/meta/test_ensure_type_hints.py tests/meta/test_mro.py tests/meta/test_v4_objects_imported.py tests/smoke/__init__.py tests/smoke/test_dists.py tests/unit/__init__.py tests/unit/conftest.py tests/unit/helpers.py tests/unit/test_base.py tests/unit/test_cli.py tests/unit/test_config.py tests/unit/test_exceptions.py tests/unit/test_gitlab.py tests/unit/test_gitlab_auth.py tests/unit/test_gitlab_http_methods.py tests/unit/test_types.py tests/unit/test_utils.py tests/unit/fixtures/todo.json tests/unit/mixins/__init__.py tests/unit/mixins/test_meta_mixins.py tests/unit/mixins/test_mixin_methods.py tests/unit/mixins/test_object_mixins_attributes.py tests/unit/objects/__init__.py tests/unit/objects/conftest.py tests/unit/objects/test_appearance.py tests/unit/objects/test_applications.py tests/unit/objects/test_audit_events.py tests/unit/objects/test_badges.py tests/unit/objects/test_bridges.py tests/unit/objects/test_bulk_imports.py tests/unit/objects/test_ci_lint.py tests/unit/objects/test_commits.py tests/unit/objects/test_deploy_tokens.py tests/unit/objects/test_deployments.py tests/unit/objects/test_environments.py tests/unit/objects/test_group_access_tokens.py tests/unit/objects/test_groups.py tests/unit/objects/test_hooks.py tests/unit/objects/test_invitations.py tests/unit/objects/test_issues.py tests/unit/objects/test_iterations.py tests/unit/objects/test_job_artifacts.py tests/unit/objects/test_jobs.py tests/unit/objects/test_keys.py tests/unit/objects/test_members.py tests/unit/objects/test_merge_request_pipelines.py tests/unit/objects/test_merge_requests.py tests/unit/objects/test_merge_trains.py tests/unit/objects/test_packages.py tests/unit/objects/test_personal_access_tokens.py tests/unit/objects/test_pipeline_schedules.py tests/unit/objects/test_pipelines.py tests/unit/objects/test_project_access_tokens.py tests/unit/objects/test_project_import_export.py tests/unit/objects/test_project_merge_request_approvals.py tests/unit/objects/test_project_statistics.py tests/unit/objects/test_projects.py tests/unit/objects/test_registry_repositories.py tests/unit/objects/test_releases.py tests/unit/objects/test_remote_mirrors.py tests/unit/objects/test_repositories.py tests/unit/objects/test_resource_groups.py tests/unit/objects/test_resource_iteration_events.py tests/unit/objects/test_resource_label_events.py tests/unit/objects/test_resource_milestone_events.py tests/unit/objects/test_resource_state_events.py tests/unit/objects/test_runners.py tests/unit/objects/test_secure_files.py tests/unit/objects/test_services.py tests/unit/objects/test_snippets.py tests/unit/objects/test_statistics.py tests/unit/objects/test_submodules.py tests/unit/objects/test_todos.py tests/unit/objects/test_topics.py tests/unit/objects/test_users.py tests/unit/objects/test_variables.py tests/unit/v4/__init__.py././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/dependency_links.txt0000644000000000000000000000000114366036463023533 0ustar00rootroot ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/entry_points.txt0000644000000000000000000000005314366036463022761 0ustar00rootroot[console_scripts] gitlab = gitlab.cli:main ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/requires.txt0000644000000000000000000000015014366036463022061 0ustar00rootrootrequests>=2.25.0 requests-toolbelt>=0.10.1 [autocompletion] argcomplete<3,>=1.10.0 [yaml] PyYaml>=5.2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115827.0 python-gitlab-3.13.0/python_gitlab.egg-info/top_level.txt0000644000000000000000000000000714366036463022214 0ustar00rootrootgitlab ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements-docker.txt0000644000000000000000000000013114366036457017657 0ustar00rootroot-r requirements.txt -r requirements-test.txt docker-compose==1.29.2 pytest-docker==1.0.1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements-docs.txt0000644000000000000000000000016514366036457017347 0ustar00rootroot-r requirements.txt furo==2022.9.29 jinja2==3.1.2 myst-parser==0.18.1 sphinx==5.1.1 sphinxcontrib-autoprogram==0.1.7 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements-lint.txt0000644000000000000000000000035214366036457017363 0ustar00rootroot-r requirements.txt argcomplete==2.0.0 black==22.10.0 commitizen==2.35.0 flake8==5.0.4 isort==5.10.1 mypy==0.981 pylint==2.15.3 pytest==7.1.3 responses==0.21.0 types-PyYAML==6.0.12 types-requests==2.28.11.2 types-setuptools==65.5.0.1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements-precommit.txt0000644000000000000000000000002314366036457020407 0ustar00rootrootpre-commit==2.20.0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements-test.txt0000644000000000000000000000027614366036457017401 0ustar00rootroot-r requirements.txt build==0.9.0 coverage==6.5.0 pytest-console-scripts==1.3.1 pytest-cov==4.0.0 pytest-github-actions-annotate-failures==0.1.7 pytest==7.1.3 PyYaml==5.4.1 responses==0.21.0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/requirements.txt0000644000000000000000000000005314366036457016415 0ustar00rootrootrequests==2.28.2 requests-toolbelt==0.10.1 ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.326791 python-gitlab-3.13.0/setup.cfg0000644000000000000000000000004614366036463014751 0ustar00rootroot[egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/setup.py0000644000000000000000000000355514366036457014655 0ustar00rootroot#!/usr/bin/python # -*- coding: utf-8 -*- from setuptools import find_packages, setup def get_version() -> str: version = "" with open("gitlab/_version.py", "r", encoding="utf-8") as f: for line in f: if line.startswith("__version__"): version = eval(line.split("=")[-1]) break return version with open("README.rst", "r", encoding="utf-8") as f: readme = f.read() setup( name="python-gitlab", version=get_version(), description="Interact with GitLab API", long_description=readme, long_description_content_type="text/x-rst", author="Gauvain Pocentek", author_email="gauvain@pocentek.net", license="LGPL-3.0-or-later", url="https://github.com/python-gitlab/python-gitlab", packages=find_packages(exclude=["docs*", "tests*"]), install_requires=["requests>=2.25.0", "requests-toolbelt>=0.10.1"], package_data={ "gitlab": ["py.typed"], }, python_requires=">=3.7.0", entry_points={"console_scripts": ["gitlab = gitlab.cli:main"]}, classifiers=[ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", "Natural Language :: English", "Operating System :: POSIX", "Operating System :: Microsoft :: Windows", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", ], extras_require={ "autocompletion": ["argcomplete>=1.10.0,<3"], "yaml": ["PyYaml>=5.2"], }, ) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3107913 python-gitlab-3.13.0/tests/0000755000000000000000000000000014366036463014272 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/__init__.py0000644000000000000000000000000014366036457016374 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/conftest.py0000644000000000000000000000210214366036457016467 0ustar00rootrootimport pathlib import _pytest.config import pytest import gitlab @pytest.fixture(scope="session") def test_dir(pytestconfig: _pytest.config.Config) -> pathlib.Path: return pytestconfig.rootdir / "tests" # type: ignore @pytest.fixture(autouse=True) def mock_clean_config(monkeypatch: pytest.MonkeyPatch) -> None: """Ensures user-defined environment variables do not interfere with tests.""" monkeypatch.delenv("PYTHON_GITLAB_CFG", raising=False) monkeypatch.delenv("GITLAB_PRIVATE_TOKEN", raising=False) monkeypatch.delenv("GITLAB_URL", raising=False) monkeypatch.delenv("CI_JOB_TOKEN", raising=False) monkeypatch.delenv("CI_SERVER_URL", raising=False) @pytest.fixture(autouse=True) def default_files(monkeypatch: pytest.MonkeyPatch) -> None: """Ensures user configuration files do not interfere with tests.""" monkeypatch.setattr(gitlab.config, "_DEFAULT_FILES", []) @pytest.fixture def valid_gitlab_ci_yml() -> str: return """--- :test_job: :script: echo 1 """ @pytest.fixture def invalid_gitlab_ci_yml() -> str: return "invalid" ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3147912 python-gitlab-3.13.0/tests/functional/0000755000000000000000000000000014366036463016434 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/__init__.py0000644000000000000000000000000014366036457020536 0ustar00rootroot././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3147912 python-gitlab-3.13.0/tests/functional/api/0000755000000000000000000000000014366036463017205 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/__init__.py0000644000000000000000000000000014366036457021307 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_boards.py0000644000000000000000000000073414366036457022077 0ustar00rootrootdef test_project_boards(project): assert not project.boards.list() board = project.boards.create({"name": "testboard"}) board = project.boards.get(board.id) project.boards.delete(board.id) assert not project.boards.list() def test_group_boards(group): assert not group.boards.list() board = group.boards.create({"name": "testboard"}) board = group.boards.get(board.id) group.boards.delete(board.id) assert not group.boards.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_branches.py0000644000000000000000000000075614366036457022416 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/branches.html """ def test_branch_name_with_period(project): # Make sure we can create and get a branch name containing a period '.' branch_name = "my.branch.name" branch = project.branches.create({"branch": branch_name, "ref": "main"}) assert branch.name == branch_name # Ensure we can get the branch fetched_branch = project.branches.get(branch_name) assert branch.name == fetched_branch.name branch.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_bulk_imports.py0000644000000000000000000000230014366036457023326 0ustar00rootrootdef test_bulk_imports(gl, group): destination = f"{group.full_path}-import" configuration = { "url": gl.url, "access_token": gl.private_token, } migration_entity = { "source_full_path": group.full_path, "source_type": "group_entity", "destination_slug": destination, "destination_namespace": destination, } created_migration = gl.bulk_imports.create( { "configuration": configuration, "entities": [migration_entity], } ) assert created_migration.source_type == "gitlab" assert created_migration.status == "created" migration = gl.bulk_imports.get(created_migration.id) assert migration == created_migration migration.refresh() assert migration == created_migration migrations = gl.bulk_imports.list() assert migration in migrations all_entities = gl.bulk_import_entities.list() entities = migration.entities.list() assert isinstance(entities, list) assert entities[0] in all_entities entity = migration.entities.get(entities[0].id) assert entity == entities[0] entity.refresh() assert entity.created_at == entities[0].created_at ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_current_user.py0000644000000000000000000000204314366036457023340 0ustar00rootrootdef test_current_user_email(gl): gl.auth() mail = gl.user.emails.create({"email": "current@user.com"}) assert mail in gl.user.emails.list() mail.delete() assert mail not in gl.user.emails.list() def test_current_user_gpg_keys(gl, GPG_KEY): gl.auth() gkey = gl.user.gpgkeys.create({"key": GPG_KEY}) assert gkey in gl.user.gpgkeys.list() # Seems broken on the gitlab side gkey = gl.user.gpgkeys.get(gkey.id) gkey.delete() assert gkey not in gl.user.gpgkeys.list() def test_current_user_ssh_keys(gl, SSH_KEY): gl.auth() key = gl.user.keys.create({"title": "testkey", "key": SSH_KEY}) assert key in gl.user.keys.list() key.delete() assert key not in gl.user.keys.list() def test_current_user_status(gl): gl.auth() message = "Test" emoji = "thumbsup" status = gl.user.status.get() status.message = message status.emoji = emoji status.save() new_status = gl.user.status.get() assert new_status.message == message assert new_status.emoji == emoji ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_deploy_keys.py0000644000000000000000000000067414366036457023157 0ustar00rootrootdef test_project_deploy_keys(gl, project, DEPLOY_KEY): deploy_key = project.keys.create({"title": "foo@bar", "key": DEPLOY_KEY}) assert deploy_key in project.keys.list() project2 = gl.projects.create({"name": "deploy-key-project"}) project2.keys.enable(deploy_key.id) assert deploy_key in project2.keys.list() project2.keys.delete(deploy_key.id) assert deploy_key not in project2.keys.list() project2.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_deploy_tokens.py0000644000000000000000000000255114366036457023503 0ustar00rootrootdef test_project_deploy_tokens(gl, project): deploy_token = project.deploytokens.create( { "name": "foo", "username": "bar", "expires_at": "2022-01-01", "scopes": ["read_registry"], } ) assert deploy_token in project.deploytokens.list() assert set(project.deploytokens.list()) <= set(gl.deploytokens.list()) deploy_token = project.deploytokens.get(deploy_token.id) assert deploy_token.name == "foo" assert deploy_token.expires_at == "2022-01-01T00:00:00.000Z" assert deploy_token.scopes == ["read_registry"] assert deploy_token.username == "bar" deploy_token.delete() assert deploy_token not in project.deploytokens.list() assert deploy_token not in gl.deploytokens.list() def test_group_deploy_tokens(gl, group): deploy_token = group.deploytokens.create( { "name": "foo", "scopes": ["read_registry"], } ) assert deploy_token in group.deploytokens.list() assert set(group.deploytokens.list()) <= set(gl.deploytokens.list()) deploy_token = group.deploytokens.get(deploy_token.id) assert deploy_token.name == "foo" assert deploy_token.scopes == ["read_registry"] deploy_token.delete() assert deploy_token not in group.deploytokens.list() assert deploy_token not in gl.deploytokens.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_epics.py0000644000000000000000000000141114366036457021721 0ustar00rootrootimport pytest pytestmark = pytest.mark.gitlab_premium def test_epics(group): epic = group.epics.create({"title": "Test epic"}) epic.title = "Fixed title" epic.labels = ["label1", "label2"] epic.save() epic = group.epics.get(epic.iid) assert epic.title == "Fixed title" assert epic.labels == ["label1", "label2"] assert group.epics.list() @pytest.mark.xfail(reason="404 on issue.id") def test_epic_issues(epic, issue): assert not epic.issues.list() epic_issue = epic.issues.create({"issue_id": issue.id}) assert epic.issues.list() epic_issue.delete() assert not epic.issues.list() def test_epic_notes(epic): assert not epic.notes.list() epic.notes.create({"body": "Test note"}) assert epic.notes.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_gitlab.py0000644000000000000000000002047514366036457022073 0ustar00rootrootimport pytest import requests import gitlab @pytest.fixture( scope="session", params=[{"get_all": True}, {"all": True}], ids=["get_all=True", "all=True"], ) def get_all_kwargs(request): """A tiny parametrized fixture to inject both `get_all=True` and `all=True` to ensure they behave the same way for pagination.""" return request.param def test_auth_from_config(gl, gitlab_config, temp_dir): """Test token authentication from config file""" test_gitlab = gitlab.Gitlab.from_config(config_files=[gitlab_config]) test_gitlab.auth() assert isinstance(test_gitlab.user, gitlab.v4.objects.CurrentUser) def test_no_custom_session(gl, temp_dir): """Test no custom session""" custom_session = requests.Session() test_gitlab = gitlab.Gitlab.from_config( config_files=[temp_dir / "python-gitlab.cfg"] ) assert test_gitlab.session != custom_session def test_custom_session(gl, temp_dir): """Test custom session""" custom_session = requests.Session() test_gitlab = gitlab.Gitlab.from_config( config_files=[temp_dir / "python-gitlab.cfg"], session=custom_session ) assert test_gitlab.session == custom_session def test_broadcast_messages(gl, get_all_kwargs): msg = gl.broadcastmessages.create({"message": "this is the message"}) msg.color = "#444444" msg.save() msg_id = msg.id msg = gl.broadcastmessages.list(**get_all_kwargs)[0] assert msg.color == "#444444" msg = gl.broadcastmessages.get(msg_id) assert msg.color == "#444444" msg.delete() assert msg not in gl.broadcastmessages.list() def test_markdown(gl): html = gl.markdown("foo") assert "foo" in html def test_markdown_in_project(gl, project): html = gl.markdown("foo", project=project.path_with_namespace) assert "foo" in html def test_lint(gl): with pytest.deprecated_call(): success, errors = gl.lint("Invalid") assert success is False assert errors def test_sidekiq_queue_metrics(gl): out = gl.sidekiq.queue_metrics() assert isinstance(out, dict) assert "default" in out["queues"] def test_sidekiq_process_metrics(gl): out = gl.sidekiq.process_metrics() assert isinstance(out, dict) assert "hostname" in out["processes"][0] def test_sidekiq_job_stats(gl): out = gl.sidekiq.job_stats() assert isinstance(out, dict) assert "processed" in out["jobs"] def test_sidekiq_compound_metrics(gl): out = gl.sidekiq.compound_metrics() assert isinstance(out, dict) assert "jobs" in out assert "processes" in out assert "queues" in out @pytest.mark.gitlab_premium def test_geo_nodes(gl): # Very basic geo nodes tests because we only have 1 node. nodes = gl.geonodes.list() assert isinstance(nodes, list) status = gl.geonodes.status() assert isinstance(status, list) @pytest.mark.gitlab_premium def test_gitlab_license(gl): license = gl.get_license() assert "user_limit" in license with pytest.raises(gitlab.GitlabLicenseError, match="The license key is invalid."): gl.set_license("dummy key") def test_gitlab_settings(gl): settings = gl.settings.get() settings.default_projects_limit = 42 settings.save() settings = gl.settings.get() assert settings.default_projects_limit == 42 def test_template_dockerfile(gl): assert gl.dockerfiles.list() dockerfile = gl.dockerfiles.get("Node") assert dockerfile.content is not None def test_template_gitignore(gl, get_all_kwargs): assert gl.gitignores.list(**get_all_kwargs) gitignore = gl.gitignores.get("Node") assert gitignore.content is not None def test_template_gitlabciyml(gl, get_all_kwargs): assert gl.gitlabciymls.list(**get_all_kwargs) gitlabciyml = gl.gitlabciymls.get("Nodejs") assert gitlabciyml.content is not None def test_template_license(gl): assert gl.licenses.list() license = gl.licenses.get( "bsd-2-clause", project="mytestproject", fullname="mytestfullname" ) assert "mytestfullname" in license.content def test_hooks(gl): hook = gl.hooks.create({"url": "http://whatever.com"}) assert hook in gl.hooks.list() hook.delete() assert hook not in gl.hooks.list() def test_namespaces(gl, get_all_kwargs): gl.auth() current_user = gl.user.username namespaces = gl.namespaces.list(**get_all_kwargs) assert namespaces namespaces = gl.namespaces.list(search=current_user, **get_all_kwargs) assert namespaces[0].kind == "user" namespace = gl.namespaces.get(current_user) assert namespace.kind == "user" namespace = gl.namespaces.exists(current_user) assert namespace.exists def test_notification_settings(gl): settings = gl.notificationsettings.get() settings.level = gitlab.const.NotificationLevel.WATCH settings.save() settings = gl.notificationsettings.get() assert settings.level == gitlab.const.NotificationLevel.WATCH def test_search(gl): result = gl.search(scope=gitlab.const.SearchScope.USERS, search="Administrator") assert result[0]["id"] == 1 def test_user_activities(gl): activities = gl.user_activities.list(query_parameters={"from": "2019-01-01"}) assert isinstance(activities, list) def test_events(gl): events = gl.events.list() assert isinstance(events, list) @pytest.mark.skip def test_features(gl): feat = gl.features.set("foo", 30) assert feat.name == "foo" assert feat in gl.features.list() feat.delete() assert feat not in gl.features.list() def test_pagination(gl, project): project2 = gl.projects.create({"name": "project-page-2"}) list1 = gl.projects.list(per_page=1, page=1) list2 = gl.projects.list(per_page=1, page=2) assert len(list1) == 1 assert len(list2) == 1 assert list1[0].id != list2[0].id project2.delete() def test_rate_limits(gl): settings = gl.settings.get() settings.throttle_authenticated_api_enabled = True settings.throttle_authenticated_api_requests_per_period = 1 settings.throttle_authenticated_api_period_in_seconds = 3 settings.save() projects = [] for i in range(0, 20): projects.append(gl.projects.create({"name": f"{str(i)}ok"})) with pytest.raises(gitlab.GitlabCreateError) as e: for i in range(20, 40): projects.append( gl.projects.create( {"name": f"{str(i)}shouldfail"}, obey_rate_limit=False ) ) assert "Retry later" in str(e.value) settings.throttle_authenticated_api_enabled = False settings.save() [project.delete() for project in projects] def test_list_default_warning(gl): """When there are more than 20 items and use default `list()` then warning is generated""" with pytest.warns(UserWarning, match="python-gitlab.readthedocs.io") as record: gl.gitlabciymls.list() assert len(record) == 1 warning = record[0] assert __file__ == warning.filename def test_list_page_nowarning(gl, recwarn): """Using `page=X` will disable the warning""" gl.gitlabciymls.list(page=1) assert not recwarn def test_list_all_false_nowarning(gl, recwarn): """Using `all=False` will disable the warning""" gl.gitlabciymls.list(all=False) assert not recwarn def test_list_all_true_nowarning(gl, get_all_kwargs, recwarn): """Using `get_all=True` will disable the warning""" items = gl.gitlabciymls.list(**get_all_kwargs) for warn in recwarn: if issubclass(warn.category, UserWarning): # Our warning has a link to the docs in it, make sure we don't have # that. assert "python-gitlab.readthedocs.io" not in str(warn.message) assert len(items) > 20 def test_list_iterator_true_nowarning(gl, recwarn): """Using `iterator=True` will disable the warning""" items = gl.gitlabciymls.list(iterator=True) assert not recwarn assert len(list(items)) > 20 def test_list_as_list_false_warnings(gl): """Using `as_list=False` will disable the UserWarning but cause a DeprecationWarning""" with pytest.warns(DeprecationWarning) as record: items = gl.gitlabciymls.list(as_list=False) assert len(record) == 1 assert len(list(items)) > 20 def test_list_with_as_list_and_iterator_raises(gl): with pytest.raises(ValueError, match="`as_list` or `iterator`"): gl.gitlabciymls.list(as_list=False, iterator=True) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_groups.py0000644000000000000000000002313114366036457022140 0ustar00rootrootimport pytest import gitlab def test_groups(gl): # TODO: This one still needs lots of work user = gl.users.create( { "email": "user@test.com", "username": "user", "name": "user", "password": "user_pass", } ) user2 = gl.users.create( { "email": "user2@test.com", "username": "user2", "name": "user2", "password": "user2_pass", } ) group1 = gl.groups.create( {"name": "gitlab-test-group1", "path": "gitlab-test-group1"} ) group2 = gl.groups.create( {"name": "gitlab-test-group2", "path": "gitlab-test-group2"} ) p_id = gl.groups.list(search="gitlab-test-group2")[0].id group3 = gl.groups.create( {"name": "gitlab-test-group3", "path": "gitlab-test-group3", "parent_id": p_id} ) group4 = gl.groups.create( {"name": "gitlab-test-group4", "path": "gitlab-test-group4"} ) assert {group1, group2, group3, group4} <= set(gl.groups.list()) assert gl.groups.list(search="gitlab-test-group1")[0].id == group1.id assert group3.parent_id == p_id assert group2.subgroups.list()[0].id == group3.id assert group2.descendant_groups.list()[0].id == group3.id filtered_groups = gl.groups.list(skip_groups=[group3.id, group4.id]) assert group3 not in filtered_groups assert group4 not in filtered_groups filtered_groups = gl.groups.list(skip_groups=[group3.id]) assert group3 not in filtered_groups assert group4 in filtered_groups group1.members.create( {"access_level": gitlab.const.AccessLevel.OWNER, "user_id": user.id} ) group1.members.create( {"access_level": gitlab.const.AccessLevel.GUEST, "user_id": user2.id} ) group2.members.create( {"access_level": gitlab.const.AccessLevel.OWNER, "user_id": user2.id} ) group4.share(group1.id, gitlab.const.AccessLevel.DEVELOPER) group4.share(group2.id, gitlab.const.AccessLevel.MAINTAINER) # Reload group4 to have updated shared_with_groups group4 = gl.groups.get(group4.id) assert len(group4.shared_with_groups) == 2 group4.unshare(group1.id) # Reload group4 to have updated shared_with_groups group4 = gl.groups.get(group4.id) assert len(group4.shared_with_groups) == 1 # User memberships (admin only) memberships1 = user.memberships.list() assert len(memberships1) == 1 memberships2 = user2.memberships.list() assert len(memberships2) == 2 membership = memberships1[0] assert membership.source_type == "Namespace" assert membership.access_level == gitlab.const.AccessLevel.OWNER project_memberships = user.memberships.list(type="Project") assert len(project_memberships) == 0 group_memberships = user.memberships.list(type="Namespace") assert len(group_memberships) == 1 with pytest.raises(gitlab.GitlabListError) as e: membership = user.memberships.list(type="Invalid") assert "type does not have a valid value" in str(e.value) with pytest.raises(gitlab.GitlabListError) as e: user.memberships.list(sudo=user.name) assert "403 Forbidden" in str(e.value) # Administrator belongs to the groups assert len(group1.members.list()) == 3 assert len(group2.members.list()) == 2 # Test `user_ids` array result = group1.members.list(user_ids=[user.id, 99999]) assert len(result) == 1 assert result[0].id == user.id group1.members.delete(user.id) assert user not in group1.members.list() assert group1.members_all.list() member = group1.members.get(user2.id) member.access_level = gitlab.const.AccessLevel.OWNER member.save() member = group1.members.get(user2.id) assert member.access_level == gitlab.const.AccessLevel.OWNER gl.auth() group2.members.delete(gl.user.id) def test_group_labels(group): group.labels.create({"name": "foo", "description": "bar", "color": "#112233"}) label = group.labels.get("foo") assert label.description == "bar" label.description = "baz" label.save() label = group.labels.get("foo") assert label.description == "baz" assert label in group.labels.list() label.new_name = "Label:that requires:encoding" label.save() assert label.name == "Label:that requires:encoding" label = group.labels.get("Label:that requires:encoding") assert label.name == "Label:that requires:encoding" label.delete() assert label not in group.labels.list() @pytest.mark.gitlab_premium @pytest.mark.xfail(reason="/ldap/groups endpoint not documented") def test_ldap_groups(gl): assert isinstance(gl.ldapgroups.list(), list) @pytest.mark.gitlab_premium def test_group_ldap_links(group): ldap_cn = "common-name" ldap_provider = "ldap-provider" ldap_cn_link = group.ldap_group_links.create( {"provider": ldap_provider, "group_access": 30, "cn": ldap_cn} ) ldap_filter_link = group.ldap_group_links.create( {"provider": ldap_provider, "group_access": 30, "filter": "(cn=Common Name)"} ) ldap_links = group.ldap_group_links.list() assert ldap_cn_link.cn == ldap_links[0].cn assert ldap_filter_link.filter == ldap_links[1].filter with pytest.raises(gitlab.GitlabCreateError): # todo - can we configure dummy LDAP in the container? group.ldap_sync() ldap_filter_link.delete() group.ldap_group_links.delete(provider=ldap_provider, cn=ldap_cn) with pytest.raises(gitlab.GitlabListError, match="No linked LDAP groups found"): group.ldap_group_links.list() def test_group_notification_settings(group): settings = group.notificationsettings.get() settings.level = "disabled" settings.save() settings = group.notificationsettings.get() assert settings.level == "disabled" def test_group_badges(group): badge_image = "http://example.com" badge_link = "http://example/img.svg" badge = group.badges.create({"link_url": badge_link, "image_url": badge_image}) assert badge in group.badges.list() badge.image_url = "http://another.example.com" badge.save() badge = group.badges.get(badge.id) assert badge.image_url == "http://another.example.com" badge.delete() assert badge not in group.badges.list() def test_group_milestones(group): milestone = group.milestones.create({"title": "groupmilestone1"}) assert milestone in group.milestones.list() milestone.due_date = "2020-01-01T00:00:00Z" milestone.save() milestone.state_event = "close" milestone.save() milestone = group.milestones.get(milestone.id) assert milestone.state == "closed" assert not milestone.issues() assert not milestone.merge_requests() def test_group_custom_attributes(gl, group): attrs = group.customattributes.list() assert not attrs attr = group.customattributes.set("key", "value1") assert group in gl.groups.list(custom_attributes={"key": "value1"}) assert attr.key == "key" assert attr.value == "value1" assert attr in group.customattributes.list() attr = group.customattributes.set("key", "value2") attr = group.customattributes.get("key") assert attr.value == "value2" assert attr in group.customattributes.list() attr.delete() assert attr not in group.customattributes.list() def test_group_subgroups_projects(gl, user): # TODO: fixture factories group1 = gl.groups.list(search="group1")[0] group2 = gl.groups.list(search="group2")[0] group3 = gl.groups.create( {"name": "subgroup1", "path": "subgroup1", "parent_id": group1.id} ) group4 = gl.groups.create( {"name": "subgroup2", "path": "subgroup2", "parent_id": group2.id} ) gr1_project = gl.projects.create({"name": "gr1_project", "namespace_id": group1.id}) gr2_project = gl.projects.create({"name": "gr2_project", "namespace_id": group3.id}) assert group3.parent_id == group1.id assert group4.parent_id == group2.id assert gr1_project.namespace["id"] == group1.id assert gr2_project.namespace["parent_id"] == group1.id gr1_project.delete() gr2_project.delete() group3.delete() group4.delete() @pytest.mark.gitlab_premium def test_group_wiki(group): content = "Group Wiki page content" wiki = group.wikis.create({"title": "groupwikipage", "content": content}) assert wiki in group.wikis.list() wiki = group.wikis.get(wiki.slug) assert wiki.content == content wiki.content = "new content" wiki.save() wiki.delete() assert wiki not in group.wikis.list() @pytest.mark.gitlab_premium def test_group_hooks(group): hook = group.hooks.create({"url": "http://hook.url"}) assert hook in group.hooks.list() hook.note_events = True hook.save() hook = group.hooks.get(hook.id) assert hook.note_events is True hook.delete() assert hook not in group.hooks.list() def test_group_transfer(gl, group): transfer_group = gl.groups.create( {"name": "transfer-test-group", "path": "transfer-test-group"} ) transfer_group = gl.groups.get(transfer_group.id) assert transfer_group.parent_id != group.id transfer_group.transfer(group.id) transferred_group = gl.groups.get(transfer_group.id) assert transferred_group.parent_id == group.id transfer_group.transfer() transferred_group = gl.groups.get(transfer_group.id) assert transferred_group.path == transferred_group.full_path @pytest.mark.gitlab_premium @pytest.mark.xfail(reason="need to setup an identity provider or it's mock") def test_group_saml_group_links(group): group.saml_group_links.create( {"saml_group_name": "saml-group-1", "access_level": 10} ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_import_export.py0000644000000000000000000000576514366036457023551 0ustar00rootrootimport time import pytest import gitlab def test_group_import_export(gl, group, temp_dir): export = group.exports.create() assert export.message == "202 Accepted" # We cannot check for export_status with group export API time.sleep(10) import_archive = temp_dir / "gitlab-group-export.tgz" import_path = "imported_group" import_name = "Imported Group" with open(import_archive, "wb") as f: export.download(streamed=True, action=f.write) with open(import_archive, "rb") as f: output = gl.groups.import_group(f, import_path, import_name) assert output["message"] == "202 Accepted" # We cannot check for returned ID with group import API time.sleep(10) group_import = gl.groups.get(import_path) assert group_import.path == import_path assert group_import.name == import_name def test_project_import_export(gl, project, temp_dir): export = project.exports.create() assert export.message == "202 Accepted" export = project.exports.get() assert isinstance(export, gitlab.v4.objects.ProjectExport) count = 0 while export.export_status != "finished": time.sleep(1) export.refresh() count += 1 if count == 15: raise Exception("Project export taking too much time") with open(temp_dir / "gitlab-export.tgz", "wb") as f: export.download(streamed=True, action=f.write) # type: ignore[arg-type] output = gl.projects.import_project( open(temp_dir / "gitlab-export.tgz", "rb"), "imported_project", name="Imported Project", ) project_import = gl.projects.get(output["id"], lazy=True).imports.get() assert project_import.path == "imported_project" assert project_import.name == "Imported Project" count = 0 while project_import.import_status != "finished": time.sleep(1) project_import.refresh() count += 1 if count == 15: raise Exception("Project import taking too much time") def test_project_remote_import(gl): with pytest.raises(gitlab.exceptions.GitlabImportError) as err_info: gl.projects.remote_import( "ftp://whatever.com/url", "remote-project", "remote-project", "root" ) assert err_info.value.response_code == 400 assert ( "File url is blocked: Only allowed schemes are https" in err_info.value.error_message ) def test_project_remote_import_s3(gl): gl.features.set("import_project_from_remote_file_s3", True) with pytest.raises(gitlab.exceptions.GitlabImportError) as err_info: gl.projects.remote_import_s3( "remote-project", "aws-region", "aws-bucket-name", "aws-file-key", "aws-access-key-id", "secret-access-key", "remote-project", "root", ) assert err_info.value.response_code == 400 assert ( "Failed to open 'aws-file-key' in 'aws-bucket-name'" in err_info.value.error_message ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_issues.py0000644000000000000000000000664214366036457022144 0ustar00rootrootimport gitlab def test_create_issue(project): issue = project.issues.create({"title": "my issue 1"}) issue2 = project.issues.create({"title": "my issue 2"}) issues = project.issues.list() issue_iids = [issue.iid for issue in issues] assert {issue, issue2} <= set(issues) # Test 'iids' as a list filtered_issues = project.issues.list(iids=issue_iids) assert {issue, issue2} == set(filtered_issues) issue2.state_event = "close" issue2.save() assert issue in project.issues.list(state="opened") assert issue2 in project.issues.list(state="closed") assert isinstance(issue.user_agent_detail(), dict) assert issue.user_agent_detail()["user_agent"] assert issue.participants() assert type(issue.closed_by()) == list assert type(issue.related_merge_requests()) == list def test_issue_notes(issue): note = issue.notes.create({"body": "This is an issue note"}) assert note in issue.notes.list() emoji = note.awardemojis.create({"name": "tractor"}) assert emoji in note.awardemojis.list() emoji.delete() assert emoji not in note.awardemojis.list() note.delete() assert note not in issue.notes.list() def test_issue_labels(project, issue): project.labels.create({"name": "label2", "color": "#aabbcc"}) issue.labels = ["label2"] issue.save() assert issue in project.issues.list(labels=["label2"]) assert issue in project.issues.list(labels="label2") assert issue in project.issues.list(labels="Any") assert issue not in project.issues.list(labels="None") def test_issue_links(project, issue): linked_issue = project.issues.create({"title": "Linked issue"}) source_issue, target_issue = issue.links.create( {"target_project_id": project.id, "target_issue_iid": linked_issue.iid} ) assert source_issue == issue assert target_issue == linked_issue links = issue.links.list() assert links link_id = links[0].issue_link_id issue.links.delete(link_id) assert not issue.links.list() def test_issue_events(issue): events = issue.resourcelabelevents.list() assert isinstance(events, list) event = issue.resourcelabelevents.get(events[0].id) assert isinstance(event, gitlab.v4.objects.ProjectIssueResourceLabelEvent) def test_issue_milestones(project, milestone): data = {"title": "my issue 1", "milestone_id": milestone.id} issue = project.issues.create(data) assert milestone.issues().next().title == "my issue 1" milestone_events = issue.resourcemilestoneevents.list() assert isinstance(milestone_events, list) milestone_event = issue.resourcemilestoneevents.get(milestone_events[0].id) assert isinstance( milestone_event, gitlab.v4.objects.ProjectIssueResourceMilestoneEvent ) assert issue in project.issues.list(milestone=milestone.title) def test_issue_discussions(issue): discussion = issue.discussions.create({"body": "Discussion body"}) assert discussion in issue.discussions.list() d_note = discussion.notes.create({"body": "first note"}) d_note_from_get = discussion.notes.get(d_note.id) d_note_from_get.body = "updated body" d_note_from_get.save() discussion = issue.discussions.get(discussion.id) assert discussion.attributes["notes"][-1]["body"] == "updated body" d_note_from_get.delete() discussion = issue.discussions.get(discussion.id) assert len(discussion.attributes["notes"]) == 1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_keys.py0000644000000000000000000000234714366036457021602 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ce/api/keys.html """ import base64 import hashlib def key_fingerprint(key: str) -> str: key_part = key.split()[1] decoded = base64.b64decode(key_part.encode("ascii")) digest = hashlib.sha256(decoded).digest() return f"SHA256:{base64.b64encode(digest).rstrip(b'=').decode('utf-8')}" def test_keys_ssh(gl, user, SSH_KEY): key = user.keys.create({"title": "foo@bar", "key": SSH_KEY}) # Get key by ID (admin only). key_by_id = gl.keys.get(key.id) assert key_by_id.title == key.title assert key_by_id.key == key.key fingerprint = key_fingerprint(SSH_KEY) # Get key by fingerprint (admin only). key_by_fingerprint = gl.keys.get(fingerprint=fingerprint) assert key_by_fingerprint.title == key.title assert key_by_fingerprint.key == key.key key.delete() def test_keys_deploy(gl, project, DEPLOY_KEY): key = project.keys.create({"title": "foo@bar", "key": DEPLOY_KEY}) fingerprint = key_fingerprint(DEPLOY_KEY) key_by_fingerprint = gl.keys.get(fingerprint=fingerprint) assert key_by_fingerprint.title == key.title assert key_by_fingerprint.key == key.key assert len(key_by_fingerprint.deploy_keys_projects) == 1 key.delete() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_lazy_objects.py0000644000000000000000000000225614366036457023316 0ustar00rootrootimport pytest import gitlab @pytest.fixture def lazy_project(gl, project): assert "/" in project.path_with_namespace return gl.projects.get(project.path_with_namespace, lazy=True) def test_lazy_id(project, lazy_project): assert isinstance(lazy_project.id, str) assert isinstance(lazy_project.id, gitlab.utils.EncodedId) assert lazy_project.id == gitlab.utils.EncodedId(project.path_with_namespace) def test_refresh_after_lazy_get_with_path(project, lazy_project): lazy_project.refresh() assert lazy_project.id == project.id def test_save_after_lazy_get_with_path(project, lazy_project): lazy_project.description = "A new description" lazy_project.save() assert lazy_project.id == project.id assert lazy_project.description == "A new description" def test_delete_after_lazy_get_with_path(gl, group, wait_for_sidekiq): project = gl.projects.create({"name": "lazy_project", "namespace_id": group.id}) wait_for_sidekiq(timeout=60) lazy_project = gl.projects.get(project.path_with_namespace, lazy=True) lazy_project.delete() def test_list_children_after_lazy_get_with_path(gl, lazy_project): lazy_project.mergerequests.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_merge_requests.py0000644000000000000000000002230314366036457023653 0ustar00rootrootimport time import pytest import gitlab import gitlab.v4.objects def test_merge_requests(project): project.files.create( { "file_path": "README.rst", "branch": "main", "content": "Initial content", "commit_message": "Initial commit", } ) source_branch = "branch1" project.branches.create({"branch": source_branch, "ref": "main"}) project.files.create( { "file_path": "README2.rst", "branch": source_branch, "content": "Initial content", "commit_message": "New commit in new branch", } ) project.mergerequests.create( {"source_branch": "branch1", "target_branch": "main", "title": "MR readme2"} ) def test_merge_requests_get(project, merge_request): new_mr = merge_request(source_branch="test_get") mr_iid = new_mr.iid mr = project.mergerequests.get(mr_iid) assert mr.iid == mr_iid mr = project.mergerequests.get(str(mr_iid)) assert mr.iid == mr_iid @pytest.mark.gitlab_premium def test_merge_requests_list_approver_ids(project): # show https://github.com/python-gitlab/python-gitlab/issues/1698 is now # fixed project.mergerequests.list( all=True, state="opened", author_id=423, approver_ids=[423], ) def test_merge_requests_get_lazy(project, merge_request): new_mr = merge_request(source_branch="test_get") mr_iid = new_mr.iid mr = project.mergerequests.get(mr_iid, lazy=True) assert mr.iid == mr_iid def test_merge_request_discussion(project): mr = project.mergerequests.list()[0] discussion = mr.discussions.create({"body": "Discussion body"}) assert discussion in mr.discussions.list() note = discussion.notes.create({"body": "first note"}) note_from_get = discussion.notes.get(note.id) note_from_get.body = "updated body" note_from_get.save() discussion = mr.discussions.get(discussion.id) assert discussion.attributes["notes"][-1]["body"] == "updated body" note_from_get.delete() discussion = mr.discussions.get(discussion.id) assert len(discussion.attributes["notes"]) == 1 def test_merge_request_labels(project): mr = project.mergerequests.list()[0] mr.labels = ["label2"] mr.save() events = mr.resourcelabelevents.list() assert events event = mr.resourcelabelevents.get(events[0].id) assert event def test_merge_request_milestone_events(project, milestone): mr = project.mergerequests.list()[0] mr.milestone_id = milestone.id mr.save() milestones = mr.resourcemilestoneevents.list() assert milestones milestone = mr.resourcemilestoneevents.get(milestones[0].id) assert milestone def test_merge_request_basic(project): mr = project.mergerequests.list()[0] # basic testing: only make sure that the methods exist mr.commits() mr.changes() assert mr.participants() def test_merge_request_rebase(project): mr = project.mergerequests.list()[0] assert mr.rebase() @pytest.mark.gitlab_premium @pytest.mark.xfail(reason="project /approvers endpoint is gone") def test_project_approvals(project): mr = project.mergerequests.list()[0] approval = project.approvals.get() reset_value = approval.reset_approvals_on_push approval.reset_approvals_on_push = not reset_value approval.save() approval = project.approvals.get() assert reset_value != approval.reset_approvals_on_push project.approvals.set_approvers([1], []) approval = project.approvals.get() assert approval.approvers[0]["user"]["id"] == 1 approval = mr.approvals.get() approval.approvals_required = 2 approval.save() approval = mr.approvals.get() assert approval.approvals_required == 2 approval.approvals_required = 3 approval.save() approval = mr.approvals.get() assert approval.approvals_required == 3 mr.approvals.set_approvers(1, [1], []) approval = mr.approvals.get() assert approval.approvers[0]["user"]["id"] == 1 @pytest.mark.gitlab_premium def test_project_merge_request_approval_rules(group, project): approval_rules = project.approvalrules.list(get_all=True) assert not approval_rules project.approvalrules.create( {"name": "approval-rule", "approvals_required": 2, "group_ids": [group.id]} ) approval_rules = project.approvalrules.list(get_all=True) assert len(approval_rules) == 1 assert approval_rules[0].approvals_required == 2 approval_rules[0].save() approval_rules = project.approvalrules.list(get_all=True) assert len(approval_rules) == 1 assert approval_rules[0].approvals_required == 2 approval_rules[0].delete() ars = project.approvalrules.list(get_all=True) assert len(ars) == 0 def test_merge_request_reset_approvals(gitlab_url, project, wait_for_sidekiq): bot = project.access_tokens.create({"name": "bot", "scopes": ["api"]}) bot_gitlab = gitlab.Gitlab(gitlab_url, private_token=bot.token) bot_project = bot_gitlab.projects.get(project.id, lazy=True) wait_for_sidekiq(timeout=60) mr = bot_project.mergerequests.list()[0] # type: ignore[index] assert mr.reset_approvals() def test_cancel_merge_when_pipeline_succeeds(project, merge_request, wait_for_sidekiq): mr = merge_request(source_branch="test_merge_request_merge", create_pipeline=True) wait_for_sidekiq(timeout=60) # Set to merge when the pipeline succeeds, which should never happen mr.merge(merge_when_pipeline_succeeds=True) wait_for_sidekiq(timeout=60) mr = project.mergerequests.get(mr.iid) assert mr.merged_at is None assert mr.merge_when_pipeline_succeeds is True cancel = mr.cancel_merge_when_pipeline_succeeds() assert cancel == {"status": "success"} def test_merge_request_merge(project, merge_request, wait_for_sidekiq): mr = merge_request(source_branch="test_merge_request_merge") mr.merge() wait_for_sidekiq(timeout=60) mr = project.mergerequests.get(mr.iid) assert mr.merged_at is not None assert mr.merge_when_pipeline_succeeds is False with pytest.raises(gitlab.GitlabMRClosedError): # Two merge attempts should raise GitlabMRClosedError mr.merge() def test_merge_request_should_remove_source_branch( project, merge_request, wait_for_sidekiq ) -> None: """Test to ensure https://github.com/python-gitlab/python-gitlab/issues/1120 is fixed. Bug reported that they could not use 'should_remove_source_branch' in mr.merge() call""" source_branch = "remove_source_branch" mr = merge_request(source_branch=source_branch) mr.merge(should_remove_source_branch=True) wait_for_sidekiq(timeout=60) # Wait until it is merged mr_iid = mr.iid for _ in range(60): mr = project.mergerequests.get(mr_iid) if mr.merged_at is not None: break time.sleep(0.5) assert mr.merged_at is not None time.sleep(0.5) wait_for_sidekiq(timeout=60) # Ensure we can NOT get the MR branch with pytest.raises(gitlab.exceptions.GitlabGetError): result = project.branches.get(source_branch) # Help to debug in case the expected exception doesn't happen. import pprint print("mr:", pprint.pformat(mr)) print("mr.merged_at:", pprint.pformat(mr.merged_at)) print("result:", pprint.pformat(result)) def test_merge_request_large_commit_message( project, merge_request, wait_for_sidekiq ) -> None: """Test to ensure https://github.com/python-gitlab/python-gitlab/issues/1452 is fixed. Bug reported that very long 'merge_commit_message' in mr.merge() would cause an error: 414 Request too large """ source_branch = "large_commit_message" mr = merge_request(source_branch=source_branch) merge_commit_message = "large_message\r\n" * 1_000 assert len(merge_commit_message) > 10_000 mr.merge( merge_commit_message=merge_commit_message, should_remove_source_branch=False ) wait_for_sidekiq(timeout=60) # Wait until it is merged mr_iid = mr.iid for _ in range(60): mr = project.mergerequests.get(mr_iid) if mr.merged_at is not None: break time.sleep(0.5) assert mr.merged_at is not None time.sleep(0.5) # Ensure we can get the MR branch project.branches.get(source_branch) def test_merge_request_merge_ref(merge_request) -> None: source_branch = "merge_ref_test" mr = merge_request(source_branch=source_branch) response = mr.merge_ref() assert response and "commit_id" in response def test_merge_request_merge_ref_should_fail( project, merge_request, wait_for_sidekiq ) -> None: source_branch = "merge_ref_test2" mr = merge_request(source_branch=source_branch) # Create conflict project.files.create( { "file_path": f"README.{source_branch}", "branch": project.default_branch, "content": "Different initial content", "commit_message": "Another commit in main branch", } ) wait_for_sidekiq(timeout=60) # Check for non-existing merge_ref for MR with conflicts with pytest.raises(gitlab.exceptions.GitlabGetError): response = mr.merge_ref() assert "commit_id" not in response ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_packages.py0000644000000000000000000000502014366036457022374 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ce/api/packages.html https://docs.gitlab.com/ee/user/packages/generic_packages """ from collections.abc import Iterator from gitlab.v4.objects import GenericPackage package_name = "hello-world" package_version = "v1.0.0" file_name = "hello.tar.gz" file_content = "package content" def test_list_project_packages(project): packages = project.packages.list() assert isinstance(packages, list) def test_list_group_packages(group): packages = group.packages.list() assert isinstance(packages, list) def test_upload_generic_package(tmp_path, project): path = tmp_path / file_name path.write_text(file_content) package = project.generic_packages.upload( package_name=package_name, package_version=package_version, file_name=file_name, path=path, ) assert isinstance(package, GenericPackage) assert package.message == "201 Created" def test_download_generic_package(project): package = project.generic_packages.download( package_name=package_name, package_version=package_version, file_name=file_name, ) assert isinstance(package, bytes) assert package.decode("utf-8") == file_content def test_stream_generic_package(project): bytes_iterator = project.generic_packages.download( package_name=package_name, package_version=package_version, file_name=file_name, iterator=True, ) assert isinstance(bytes_iterator, Iterator) package = bytes() for chunk in bytes_iterator: package += chunk assert isinstance(package, bytes) assert package.decode("utf-8") == file_content def test_download_generic_package_to_file(tmp_path, project): path = tmp_path / file_name with open(path, "wb") as f: project.generic_packages.download( package_name=package_name, package_version=package_version, file_name=file_name, streamed=True, action=f.write, ) with open(path, "r") as f: assert f.read() == file_content def test_stream_generic_package_to_file(tmp_path, project): path = tmp_path / file_name bytes_iterator = project.generic_packages.download( package_name=package_name, package_version=package_version, file_name=file_name, iterator=True, ) with open(path, "wb") as f: for chunk in bytes_iterator: f.write(chunk) with open(path, "r") as f: assert f.read() == file_content ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_projects.py0000644000000000000000000002506014366036457022455 0ustar00rootrootimport uuid import pytest import gitlab from gitlab.const import AccessLevel from gitlab.v4.objects.projects import ProjectStorage def test_projects_head(gl): headers = gl.projects.head() assert headers["x-total"] def test_project_head(gl, project): headers = gl.projects.head(project.id) assert headers["content-type"] == "application/json" def test_create_project(gl, user): # Moved from group tests chunk in legacy tests, TODO cleanup admin_project = gl.projects.create({"name": "admin_project"}) assert isinstance(admin_project, gitlab.v4.objects.Project) assert admin_project in gl.projects.list(search="admin_project") sudo_project = gl.projects.create({"name": "sudo_project"}, sudo=user.id) created = gl.projects.list() created_gen = gl.projects.list(iterator=True) owned = gl.projects.list(owned=True) assert admin_project in created and sudo_project in created assert admin_project in owned and sudo_project not in owned assert len(created) == len(list(created_gen)) admin_project.delete() sudo_project.delete() def test_project_members(user, project): member = project.members.create( {"user_id": user.id, "access_level": AccessLevel.DEVELOPER} ) assert member in project.members.list() assert member.access_level == 30 member.delete() assert member not in project.members.list() def test_project_badges(project): badge_image = "http://example.com" badge_link = "http://example/img.svg" badge = project.badges.create({"link_url": badge_link, "image_url": badge_image}) assert badge in project.badges.list() badge.image_url = "http://another.example.com" badge.save() badge = project.badges.get(badge.id) assert badge.image_url == "http://another.example.com" badge.delete() assert badge not in project.badges.list() @pytest.mark.skip(reason="Commented out in legacy test") def test_project_boards(project): boards = project.boards.list() assert boards board = boards[0] lists = board.lists.list() last_list = lists[-1] last_list.position = 0 last_list.save() last_list.delete() assert last_list not in board.lists.list() def test_project_custom_attributes(gl, project): attrs = project.customattributes.list() assert not attrs attr = project.customattributes.set("key", "value1") assert attr.key == "key" assert attr.value == "value1" assert attr in project.customattributes.list() assert project in gl.projects.list(custom_attributes={"key": "value1"}) attr = project.customattributes.set("key", "value2") attr = project.customattributes.get("key") assert attr.value == "value2" assert attr in project.customattributes.list() attr.delete() assert attr not in project.customattributes.list() def test_project_environments(project): environment = project.environments.create( {"name": "env1", "external_url": "http://fake.env/whatever"} ) environments = project.environments.list() assert environment in environments environment = environments[0] environment.external_url = "http://new.env/whatever" environment.save() environment = project.environments.list()[0] assert environment.external_url == "http://new.env/whatever" environment.stop() environment.delete() assert environment not in project.environments.list() def test_project_events(project): events = project.events.list() assert isinstance(events, list) def test_project_file_uploads(project): filename = "test.txt" file_contents = "testing contents" uploaded_file = project.upload(filename, file_contents) alt, url = uploaded_file["alt"], uploaded_file["url"] assert alt == filename assert url.startswith("/uploads/") assert url.endswith(f"/{filename}") assert uploaded_file["markdown"] == f"[{alt}]({url})" def test_project_forks(gl, project, user): fork = project.forks.create({"namespace": user.username}) fork_project = gl.projects.get(fork.id) assert fork_project.forked_from_project["id"] == project.id forks = project.forks.list() assert fork.id in [fork_project.id for fork_project in forks] def test_project_hooks(project): hook = project.hooks.create({"url": "http://hook.url"}) assert hook in project.hooks.list() hook.note_events = True hook.save() hook = project.hooks.get(hook.id) assert hook.note_events is True hook.delete() assert hook not in project.hooks.list() def test_project_housekeeping(project): project.housekeeping() def test_project_labels(project): label = project.labels.create({"name": "label", "color": "#778899"}) labels = project.labels.list() assert label in labels label = project.labels.get("label") assert label == labels[0] label.new_name = "Label:that requires:encoding" label.save() assert label.name == "Label:that requires:encoding" label = project.labels.get("Label:that requires:encoding") assert label.name == "Label:that requires:encoding" label.subscribe() assert label.subscribed is True label.unsubscribe() assert label.subscribed is False label.delete() assert label not in project.labels.list() def test_project_label_promotion(gl, group): """ Label promotion requires the project to be a child of a group (not in a user namespace) """ _id = uuid.uuid4().hex data = { "name": f"test-project-{_id}", "namespace_id": group.id, } project = gl.projects.create(data) label_name = "promoteme" promoted_label = project.labels.create({"name": label_name, "color": "#112233"}) promoted_label.promote() assert any(label.name == label_name for label in group.labels.list()) group.labels.delete(label_name) assert not any(label.name == label_name for label in group.labels.list()) def test_project_milestones(project): milestone = project.milestones.create({"title": "milestone1"}) assert milestone in project.milestones.list() milestone.due_date = "2020-01-01T00:00:00Z" milestone.save() milestone.state_event = "close" milestone.save() milestone = project.milestones.get(milestone.id) assert milestone.state == "closed" assert not milestone.issues() assert not milestone.merge_requests() def test_project_milestone_promotion(gl, group): """ Milestone promotion requires the project to be a child of a group (not in a user namespace) """ _id = uuid.uuid4().hex data = { "name": f"test-project-{_id}", "namespace_id": group.id, } project = gl.projects.create(data) milestone_title = "promoteme" promoted_milestone = project.milestones.create({"title": milestone_title}) promoted_milestone.promote() assert any( milestone.title == milestone_title for milestone in group.milestones.list() ) def test_project_pages_domains(gl, project): domain = project.pagesdomains.create({"domain": "foo.domain.com"}) assert domain in project.pagesdomains.list() assert domain in gl.pagesdomains.list() domain = project.pagesdomains.get("foo.domain.com") assert domain.domain == "foo.domain.com" domain.delete() assert domain not in project.pagesdomains.list() def test_project_protected_branches(project): p_b = project.protectedbranches.create({"name": "*-stable"}) assert p_b.name == "*-stable" assert p_b in project.protectedbranches.list() p_b = project.protectedbranches.get("*-stable") p_b.delete() assert p_b not in project.protectedbranches.list() def test_project_remote_mirrors(project): mirror_url = "https://gitlab.example.com/root/mirror.git" mirror = project.remote_mirrors.create({"url": mirror_url}) assert mirror.url == mirror_url mirror.enabled = True mirror.save() mirror = project.remote_mirrors.list()[0] assert isinstance(mirror, gitlab.v4.objects.ProjectRemoteMirror) assert mirror.url == mirror_url assert mirror.enabled is True def test_project_services(project): # Use 'update' to create a service as we don't have a 'create' method and # to add one is somewhat complicated so it hasn't been done yet. project.services.update("asana", api_key="foo") service = project.services.get("asana") assert service.active is True service.api_key = "whatever" service.save() service = project.services.get("asana") assert service.active is True service.delete() service = project.services.get("asana") assert service.active is False def test_project_stars(project): project.star() assert project.star_count == 1 project.unstar() assert project.star_count == 0 def test_project_storage(project): storage = project.storage.get() assert isinstance(storage, ProjectStorage) assert storage.repository_storage == "default" def test_project_tags(project, project_file): tag = project.tags.create({"tag_name": "v1.0", "ref": "main"}) assert tag in project.tags.list() tag.delete() assert tag not in project.tags.list() def test_project_triggers(project): trigger = project.triggers.create({"description": "trigger1"}) assert trigger in project.triggers.list() trigger.delete() assert trigger not in project.triggers.list() def test_project_wiki(project): content = "Wiki page content" wiki = project.wikis.create({"title": "wikipage", "content": content}) assert wiki in project.wikis.list() wiki = project.wikis.get(wiki.slug) assert wiki.content == content # update and delete seem broken wiki.content = "new content" wiki.save() wiki.delete() assert wiki not in project.wikis.list() def test_project_groups_list(gl, group): """Test listing groups of a project""" # Create a subgroup of our top-group, we will place our new project inside # this group. group2 = gl.groups.create( {"name": "group2_proj", "path": "group2_proj", "parent_id": group.id} ) data = { "name": "test-project-tpsg", "namespace_id": group2.id, } project = gl.projects.create(data) groups = project.groups.list() group_ids = set([x.id for x in groups]) assert {group.id, group2.id} == group_ids def test_project_transfer(gl, project, group): assert project.namespace["path"] != group.full_path project.transfer(group.id) project = gl.projects.get(project.id) assert project.namespace["path"] == group.full_path gl.auth() project.transfer(gl.user.username) project = gl.projects.get(project.id) assert project.namespace["path"] == gl.user.username ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_push_rules.py0000644000000000000000000000130614366036457023012 0ustar00rootrootimport pytest import gitlab @pytest.mark.gitlab_premium def test_project_push_rules(project): with pytest.raises(gitlab.GitlabParsingError): # when no rules are defined the API call returns back `None` which # causes a gitlab.GitlabParsingError in RESTObject.__init__() project.pushrules.get() push_rules = project.pushrules.create({"deny_delete_tag": True}) assert push_rules.deny_delete_tag push_rules.deny_delete_tag = False push_rules.save() push_rules = project.pushrules.get() assert push_rules assert not push_rules.deny_delete_tag push_rules.delete() with pytest.raises(gitlab.GitlabParsingError): project.pushrules.get() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_releases.py0000644000000000000000000000402214366036457022422 0ustar00rootrootrelease_name = "Demo Release" release_tag_name = "v1.2.3" release_description = "release notes go here" link_data = {"url": "https://example.com", "name": "link_name"} def test_create_project_release(project, project_file): project.refresh() # Gets us the current default branch release = project.releases.create( { "name": release_name, "tag_name": release_tag_name, "description": release_description, "ref": project.default_branch, } ) assert release in project.releases.list() assert project.releases.get(release_tag_name) assert release.name == release_name assert release.tag_name == release_tag_name assert release.description == release_description def test_create_project_release_no_name(project, project_file): unnamed_release_tag_name = "v2.3.4" project.refresh() # Gets us the current default branch release = project.releases.create( { "tag_name": unnamed_release_tag_name, "description": release_description, "ref": project.default_branch, } ) assert release in project.releases.list() assert project.releases.get(unnamed_release_tag_name) assert release.tag_name == unnamed_release_tag_name assert release.description == release_description def test_update_save_project_release(project, release): updated_description = f"{release.description} updated" release.description = updated_description release.save() release = project.releases.get(release.tag_name) assert release.description == updated_description def test_delete_project_release(project, release): project.releases.delete(release.tag_name) assert release not in project.releases.list() def test_create_project_release_links(project, release): release.links.create(link_data) release = project.releases.get(release.tag_name) assert release.assets["links"][0]["url"] == link_data["url"] assert release.assets["links"][0]["name"] == link_data["name"] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_repository.py0000644000000000000000000001311414366036457023040 0ustar00rootrootimport base64 import os import sys import tarfile import time import zipfile from io import BytesIO import pytest import gitlab def test_repository_files(project): project.files.create( { "file_path": "README.md", "branch": "main", "content": "Initial content", "commit_message": "Initial commit", } ) readme = project.files.get(file_path="README.md", ref="main") readme.content = base64.b64encode(b"Improved README").decode() time.sleep(2) readme.save(branch="main", commit_message="new commit") readme.delete(commit_message="Removing README", branch="main") project.files.create( { "file_path": "README.rst", "branch": "main", "content": "Initial content", "commit_message": "New commit", } ) readme = project.files.get(file_path="README.rst", ref="main") # The first decode() is the ProjectFile method, the second one is the bytes # object method assert readme.decode().decode() == "Initial content" headers = project.files.head("README.rst", ref="main") assert headers["X-Gitlab-File-Path"] == "README.rst" blame = project.files.blame(file_path="README.rst", ref="main") assert blame raw_file = project.files.raw(file_path="README.rst", ref="main") assert os.fsdecode(raw_file) == "Initial content" def test_repository_tree(project): tree = project.repository_tree() assert tree assert tree[0]["name"] == "README.rst" blob_id = tree[0]["id"] blob = project.repository_raw_blob(blob_id) assert blob.decode() == "Initial content" snapshot = project.snapshot() assert isinstance(snapshot, bytes) def test_repository_archive(project): archive = project.repository_archive() assert isinstance(archive, bytes) archive2 = project.repository_archive("main") assert archive == archive2 # NOTE(jlvillal): Support for using tarfile.is_tarfile() on a file or file-like object # was added in Python 3.9 @pytest.mark.skipif(sys.version_info < (3, 9), reason="requires python3.9 or higher") @pytest.mark.parametrize( "format,assertion", [ ("tbz", tarfile.is_tarfile), ("tbz2", tarfile.is_tarfile), ("tb2", tarfile.is_tarfile), ("bz2", tarfile.is_tarfile), ("tar", tarfile.is_tarfile), ("tar.gz", tarfile.is_tarfile), ("tar.bz2", tarfile.is_tarfile), ("zip", zipfile.is_zipfile), ], ) def test_repository_archive_formats(project, format, assertion): archive = project.repository_archive(format=format) assert assertion(BytesIO(archive)) def test_create_commit(project): data = { "branch": "main", "commit_message": "blah blah blah", "actions": [{"action": "create", "file_path": "blah", "content": "blah"}], } commit = project.commits.create(data) assert "@@" in project.commits.list()[0].diff()[0]["diff"] assert isinstance(commit.refs(), list) assert isinstance(commit.merge_requests(), list) def test_list_all_commits(project): data = { "branch": "new-branch", "start_branch": "main", "commit_message": "New commit on new branch", "actions": [ {"action": "create", "file_path": "new-file", "content": "new content"} ], } commit = project.commits.create(data) commits = project.commits.list(all=True) assert commit not in commits # Listing commits on other branches requires `all` parameter passed to the API all_commits = project.commits.list(get_all=True, all=True) assert commit in all_commits assert len(all_commits) > len(commits) def test_create_commit_status(project): commit = project.commits.list()[0] status = commit.statuses.create({"state": "success", "sha": commit.id}) assert status in commit.statuses.list() def test_commit_signature(project): commit = project.commits.list()[0] with pytest.raises(gitlab.GitlabGetError) as e: commit.signature() assert "404 Signature Not Found" in str(e.value) def test_commit_comment(project): commit = project.commits.list()[0] commit.comments.create({"note": "This is a commit comment"}) assert len(commit.comments.list()) == 1 def test_commit_discussion(project): commit = project.commits.list()[0] discussion = commit.discussions.create({"body": "Discussion body"}) assert discussion in commit.discussions.list() note = discussion.notes.create({"body": "first note"}) note_from_get = discussion.notes.get(note.id) note_from_get.body = "updated body" note_from_get.save() discussion = commit.discussions.get(discussion.id) # assert discussion.attributes["notes"][-1]["body"] == "updated body" note_from_get.delete() discussion = commit.discussions.get(discussion.id) # assert len(discussion.attributes["notes"]) == 1 def test_revert_commit(project): commit = project.commits.list()[0] revert_commit = commit.revert(branch="main") expected_message = f'Revert "{commit.message}"\n\nThis reverts commit {commit.id}' assert revert_commit["message"] == expected_message with pytest.raises(gitlab.GitlabRevertError): # Two revert attempts should raise GitlabRevertError commit.revert(branch="main") def test_repository_merge_base(project): refs = [commit.id for commit in project.commits.list(all=True)] commit = project.repository_merge_base(refs) assert commit["id"] in refs with pytest.raises(gitlab.GitlabGetError, match="Provide at least 2 refs"): commit = project.repository_merge_base(refs[0]) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_services.py0000644000000000000000000000202014366036457022436 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/integrations.html """ import gitlab def test_get_service_lazy(project): service = project.services.get("jira", lazy=True) assert isinstance(service, gitlab.v4.objects.ProjectService) def test_update_service(project): service_dict = project.services.update( "emails-on-push", {"recipients": "email@example.com"} ) assert service_dict["active"] def test_list_services(project, service): services = project.services.list() assert isinstance(services[0], gitlab.v4.objects.ProjectService) assert services[0].active def test_get_service(project, service): service_object = project.services.get(service["slug"]) assert isinstance(service_object, gitlab.v4.objects.ProjectService) assert service_object.active def test_delete_service(project, service): service_object = project.services.get(service["slug"]) service_object.delete() service_object = project.services.get(service["slug"]) assert not service_object.active ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_snippets.py0000644000000000000000000000402314366036457022465 0ustar00rootrootimport gitlab def test_snippets(gl): snippets = gl.snippets.list(get_all=True) assert not snippets snippet = gl.snippets.create( {"title": "snippet1", "file_name": "snippet1.py", "content": "import gitlab"} ) snippet = gl.snippets.get(snippet.id) snippet.title = "updated_title" snippet.save() snippet = gl.snippets.get(snippet.id) assert snippet.title == "updated_title" content = snippet.content() assert content.decode() == "import gitlab" assert snippet.user_agent_detail()["user_agent"] snippet.delete() assert snippet not in gl.snippets.list(get_all=True) def test_project_snippets(project): project.snippets_enabled = True project.save() snippet = project.snippets.create( { "title": "snip1", "file_name": "foo.py", "content": "initial content", "visibility": gitlab.const.VISIBILITY_PRIVATE, } ) assert snippet.user_agent_detail()["user_agent"] def test_project_snippet_discussion(project): snippet = project.snippets.list()[0] discussion = snippet.discussions.create({"body": "Discussion body"}) assert discussion in snippet.discussions.list() note = discussion.notes.create({"body": "first note"}) note_from_get = discussion.notes.get(note.id) note_from_get.body = "updated body" note_from_get.save() discussion = snippet.discussions.get(discussion.id) assert discussion.attributes["notes"][-1]["body"] == "updated body" note_from_get.delete() discussion = snippet.discussions.get(discussion.id) assert len(discussion.attributes["notes"]) == 1 def test_project_snippet_file(project): snippet = project.snippets.list()[0] snippet.file_name = "bar.py" snippet.save() snippet = project.snippets.get(snippet.id) assert snippet.content().decode() == "initial content" assert snippet.file_name == "bar.py" assert snippet in project.snippets.list() snippet.delete() assert snippet not in project.snippets.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_statistics.py0000644000000000000000000000044714366036457023020 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/statistics.html """ def test_get_statistics(gl): statistics = gl.statistics.get() assert statistics.snippets.isdigit() assert statistics.users.isdigit() assert statistics.groups.isdigit() assert statistics.projects.isdigit() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_topics.py0000644000000000000000000000175314366036457022130 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ce/api/topics.html """ def test_topics(gl, gitlab_version): assert not gl.topics.list() create_dict = {"name": "my-topic", "description": "My Topic"} if gitlab_version.major >= 15: create_dict["title"] = "my topic title" topic = gl.topics.create(create_dict) assert topic.name == "my-topic" if gitlab_version.major >= 15: assert topic.title == "my topic title" assert gl.topics.list() topic.description = "My Updated Topic" topic.save() updated_topic = gl.topics.get(topic.id) assert updated_topic.description == topic.description create_dict = {"name": "my-second-topic", "description": "My Second Topic"} if gitlab_version.major >= 15: create_dict["title"] = "my second topic title" topic2 = gl.topics.create(create_dict) merged_topic = gl.topics.merge(topic.id, topic2.id) assert merged_topic["id"] == topic2.id topic2.delete() assert not gl.topics.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_users.py0000644000000000000000000001162614366036457021770 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/users.html https://docs.gitlab.com/ee/api/users.html#delete-authentication-identity-from-user """ import requests def test_create_user(gl, fixture_dir): user = gl.users.create( { "email": "foo@bar.com", "username": "foo", "name": "foo", "password": "foo_password", "avatar": open(fixture_dir / "avatar.png", "rb"), } ) created_user = gl.users.list(username="foo")[0] assert created_user.username == user.username assert created_user.email == user.email avatar_url = user.avatar_url.replace("gitlab.test", "localhost:8080") uploaded_avatar = requests.get(avatar_url).content with open(fixture_dir / "avatar.png", "rb") as f: assert uploaded_avatar == f.read() def test_block_user(gl, user): result = user.block() assert result is True users = gl.users.list(blocked=True) assert user in users # block again result = user.block() # Trying to block an already blocked user returns None assert result is None result = user.unblock() assert result is True users = gl.users.list(blocked=False) assert user in users # unblock again result = user.unblock() # Trying to unblock an already blocked user returns False assert result is False def test_ban_user(gl, user): user.ban() retrieved_user = gl.users.get(user.id) assert retrieved_user.state == "banned" user.unban() retrieved_user = gl.users.get(user.id) assert retrieved_user.state == "active" def test_delete_user(gl, wait_for_sidekiq): new_user = gl.users.create( { "email": "delete-user@test.com", "username": "delete-user", "name": "delete-user", "password": "delete-user-pass", } ) new_user.delete() wait_for_sidekiq(timeout=60) assert new_user.id not in [user.id for user in gl.users.list()] def test_user_projects_list(gl, user): projects = user.projects.list() assert isinstance(projects, list) assert not projects def test_user_events_list(gl, user): events = user.events.list() assert isinstance(events, list) assert not events def test_user_bio(gl, user): user.bio = "This is the user bio" user.save() def test_list_multiple_users(gl, user): second_email = f"{user.email}.2" second_username = f"{user.username}_2" second_user = gl.users.create( { "email": second_email, "username": second_username, "name": "Foo Bar", "password": "foobar_password", } ) assert gl.users.list(search=second_user.username)[0].id == second_user.id expected = [user, second_user] actual = list(gl.users.list(search=user.username)) assert set(expected) == set(actual) assert not gl.users.list(search="asdf") def test_user_gpg_keys(gl, user, GPG_KEY): gkey = user.gpgkeys.create({"key": GPG_KEY}) assert gkey in user.gpgkeys.list() # Seems broken on the gitlab side # gkey = user.gpgkeys.get(gkey.id) gkey.delete() assert gkey not in user.gpgkeys.list() def test_user_ssh_keys(gl, user, SSH_KEY): key = user.keys.create({"title": "testkey", "key": SSH_KEY}) assert key in user.keys.list() get_key = user.keys.get(key.id) assert get_key.key == key.key key.delete() assert key not in user.keys.list() def test_user_email(gl, user): email = user.emails.create({"email": "foo2@bar.com"}) assert email in user.emails.list() email.delete() assert email not in user.emails.list() def test_user_custom_attributes(gl, user): attrs = user.customattributes.list() assert not attrs attr = user.customattributes.set("key", "value1") assert user in gl.users.list(custom_attributes={"key": "value1"}) assert attr.key == "key" assert attr.value == "value1" assert attr in user.customattributes.list() attr = user.customattributes.set("key", "value2") attr = user.customattributes.get("key") assert attr.value == "value2" assert attr in user.customattributes.list() attr.delete() assert attr not in user.customattributes.list() def test_user_impersonation_tokens(gl, user): token = user.impersonationtokens.create( {"name": "token1", "scopes": ["api", "read_user"]} ) assert token in user.impersonationtokens.list(state="active") token.delete() assert token not in user.impersonationtokens.list(state="active") assert token in user.impersonationtokens.list(state="inactive") def test_user_identities(gl, user): provider = "test_provider" user.provider = provider user.extern_uid = "1" user.save() assert provider in [item["provider"] for item in user.identities] user.identityproviders.delete(provider) user = gl.users.get(user.id) assert provider not in [item["provider"] for item in user.identities] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_variables.py0000644000000000000000000000263614366036457022600 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/instance_level_ci_variables.html https://docs.gitlab.com/ee/api/project_level_variables.html https://docs.gitlab.com/ee/api/group_level_variables.html """ def test_instance_variables(gl): variable = gl.variables.create({"key": "key1", "value": "value1"}) assert variable.value == "value1" assert variable in gl.variables.list() variable.value = "new_value1" variable.save() variable = gl.variables.get(variable.key) assert variable.value == "new_value1" variable.delete() assert variable not in gl.variables.list() def test_group_variables(group): variable = group.variables.create({"key": "key1", "value": "value1"}) assert variable.value == "value1" assert variable in group.variables.list() variable.value = "new_value1" variable.save() variable = group.variables.get(variable.key) assert variable.value == "new_value1" variable.delete() assert variable not in group.variables.list() def test_project_variables(project): variable = project.variables.create({"key": "key1", "value": "value1"}) assert variable.value == "value1" assert variable in project.variables.list() variable.value = "new_value1" variable.save() variable = project.variables.get(variable.key) assert variable.value == "new_value1" variable.delete() assert variable not in project.variables.list() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/api/test_wikis.py0000644000000000000000000000042514366036457021750 0ustar00rootroot""" GitLab API: https://docs.gitlab.com/ee/api/wikis.html """ def test_wikis(project): page = project.wikis.create({"title": "title/subtitle", "content": "test content"}) page.content = "update content" page.title = "subtitle" page.save() page.delete() ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/functional/cli/0000755000000000000000000000000014366036463017203 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/__init__.py0000644000000000000000000000000014366036457021305 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/conftest.py0000644000000000000000000000220314366036457021402 0ustar00rootrootimport pytest import responses from gitlab.const import DEFAULT_URL @pytest.fixture def gitlab_cli(script_runner, gitlab_config): """Wrapper fixture to help make test cases less verbose.""" def _gitlab_cli(subcommands): """ Return a script_runner.run method that takes a default gitlab command, and subcommands passed as arguments inside test cases. """ command = ["gitlab", "--config-file", gitlab_config] for subcommand in subcommands: # ensure we get strings (e.g from IDs) command.append(str(subcommand)) return script_runner.run(*command) return _gitlab_cli @pytest.fixture def resp_get_project(): return { "method": responses.GET, "url": f"{DEFAULT_URL}/api/v4/projects/1", "json": {"name": "name", "path": "test-path", "id": 1}, "content_type": "application/json", "status": 200, } @pytest.fixture def resp_delete_registry_tags_in_bulk(): return { "method": responses.DELETE, "url": f"{DEFAULT_URL}/api/v4/projects/1/registry/repositories/1/tags", "status": 202, } ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli.py0000644000000000000000000001355114366036457021373 0ustar00rootroot""" Some test cases are run in-process to intercept requests to gitlab.com and example servers. """ import copy import json import pytest import responses import yaml from gitlab import __version__, config from gitlab.const import DEFAULT_URL PRIVATE_TOKEN = "glpat-abc123" CI_JOB_TOKEN = "ci-job-token" CI_SERVER_URL = "https://gitlab.example.com" def test_main_entrypoint(script_runner, gitlab_config): ret = script_runner.run("python", "-m", "gitlab", "--config-file", gitlab_config) assert ret.returncode == 2 def test_version(script_runner): ret = script_runner.run("gitlab", "--version") assert ret.stdout.strip() == __version__ def test_config_error_with_help_prints_help(script_runner): ret = script_runner.run("gitlab", "-c", "invalid-file", "--help") assert ret.stdout.startswith("usage:") assert ret.returncode == 0 def test_global_help_prints_resources_vertically(script_runner): ret = script_runner.run("gitlab", "--help") assert """resource:\n application\n application-appearance\n""" in ret.stdout assert ret.returncode == 0 def test_resource_help_prints_actions_vertically(script_runner): ret = script_runner.run("gitlab", "project", "--help") assert """action:\n list\n get""" in ret.stdout assert ret.returncode == 0 @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_defaults_to_gitlab_com(script_runner, resp_get_project, monkeypatch): responses.add(**resp_get_project) monkeypatch.setattr(config, "_DEFAULT_FILES", []) ret = script_runner.run("gitlab", "project", "get", "--id", "1") assert ret.success assert "id: 1" in ret.stdout @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_uses_ci_server_url(monkeypatch, script_runner, resp_get_project): monkeypatch.setenv("CI_SERVER_URL", CI_SERVER_URL) monkeypatch.setattr(config, "_DEFAULT_FILES", []) resp_get_project_in_ci = copy.deepcopy(resp_get_project) resp_get_project_in_ci.update(url=f"{CI_SERVER_URL}/api/v4/projects/1") responses.add(**resp_get_project_in_ci) ret = script_runner.run("gitlab", "project", "get", "--id", "1") assert ret.success @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_uses_ci_job_token(monkeypatch, script_runner, resp_get_project): monkeypatch.setenv("CI_JOB_TOKEN", CI_JOB_TOKEN) monkeypatch.setattr(config, "_DEFAULT_FILES", []) resp_get_project_in_ci = copy.deepcopy(resp_get_project) resp_get_project_in_ci.update( match=[responses.matchers.header_matcher({"JOB-TOKEN": CI_JOB_TOKEN})], ) responses.add(**resp_get_project_in_ci) ret = script_runner.run("gitlab", "project", "get", "--id", "1") assert ret.success @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_private_token_overrides_job_token( monkeypatch, script_runner, resp_get_project ): monkeypatch.setenv("GITLAB_PRIVATE_TOKEN", PRIVATE_TOKEN) monkeypatch.setenv("CI_JOB_TOKEN", CI_JOB_TOKEN) resp_get_project_with_token = copy.deepcopy(resp_get_project) resp_get_project_with_token.update( match=[responses.matchers.header_matcher({"PRIVATE-TOKEN": PRIVATE_TOKEN})], ) # CLI first calls .auth() when private token is present resp_auth_with_token = copy.deepcopy(resp_get_project_with_token) resp_auth_with_token.update(url=f"{DEFAULT_URL}/api/v4/user") resp_auth_with_token["json"].update(username="user", web_url=f"{DEFAULT_URL}/user") responses.add(**resp_get_project_with_token) responses.add(**resp_auth_with_token) ret = script_runner.run("gitlab", "project", "get", "--id", "1") assert ret.success def test_env_config_missing_file_raises(script_runner, monkeypatch): monkeypatch.setenv("PYTHON_GITLAB_CFG", "non-existent") ret = script_runner.run("gitlab", "project", "list") assert not ret.success assert ret.stderr.startswith("Cannot read config from PYTHON_GITLAB_CFG") def test_arg_config_missing_file_raises(script_runner): ret = script_runner.run( "gitlab", "--config-file", "non-existent", "project", "list" ) assert not ret.success assert ret.stderr.startswith("Cannot read config from file") def test_invalid_config(script_runner): ret = script_runner.run("gitlab", "--gitlab", "invalid") assert not ret.success assert not ret.stdout def test_invalid_config_prints_help(script_runner): ret = script_runner.run("gitlab", "--gitlab", "invalid", "--help") assert ret.success assert ret.stdout def test_invalid_api_version(script_runner, monkeypatch, fixture_dir): monkeypatch.setenv("PYTHON_GITLAB_CFG", str(fixture_dir / "invalid_version.cfg")) ret = script_runner.run("gitlab", "--gitlab", "test", "project", "list") assert not ret.success assert ret.stderr.startswith("Unsupported API version:") def test_invalid_auth_config(script_runner, monkeypatch, fixture_dir): monkeypatch.setenv("PYTHON_GITLAB_CFG", str(fixture_dir / "invalid_auth.cfg")) ret = script_runner.run("gitlab", "--gitlab", "test", "project", "list") assert not ret.success assert "401" in ret.stderr format_matrix = [ ("json", json.loads), ("yaml", yaml.safe_load), ] @pytest.mark.parametrize("format,loader", format_matrix) def test_cli_display(gitlab_cli, project, format, loader): cmd = ["-o", format, "project", "get", "--id", project.id] ret = gitlab_cli(cmd) assert ret.success content = loader(ret.stdout.strip()) assert content["id"] == project.id @pytest.mark.parametrize("format,loader", format_matrix) def test_cli_fields_in_list(gitlab_cli, project_file, format, loader): cmd = [ "-o", format, "--fields", "default_branch", "project", "list", ] ret = gitlab_cli(cmd) assert ret.success content = loader(ret.stdout.strip()) assert ["default_branch" in item for item in content] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_artifacts.py0000644000000000000000000000713014366036457023427 0ustar00rootrootimport subprocess import textwrap import time from io import BytesIO from zipfile import is_zipfile import pytest content = textwrap.dedent( """\ test-artifact: script: echo "test" > artifact.txt artifacts: untracked: true """ ) data = { "file_path": ".gitlab-ci.yml", "branch": "main", "content": content, "commit_message": "Initial commit", } @pytest.fixture(scope="module") def job_with_artifacts(gitlab_runner, project): project.files.create(data) jobs = None while not jobs: time.sleep(0.5) jobs = project.jobs.list(scope="success") return project.jobs.get(jobs[0].id) def test_cli_job_artifacts(capsysbinary, gitlab_config, job_with_artifacts): cmd = [ "gitlab", "--config-file", gitlab_config, "project-job", "artifacts", "--id", str(job_with_artifacts.id), "--project-id", str(job_with_artifacts.pipeline["project_id"]), ] with capsysbinary.disabled(): artifacts = subprocess.check_output(cmd) assert isinstance(artifacts, bytes) artifacts_zip = BytesIO(artifacts) assert is_zipfile(artifacts_zip) def test_cli_project_artifact_download(gitlab_config, job_with_artifacts): cmd = [ "gitlab", "--config-file", gitlab_config, "project-artifact", "download", "--project-id", str(job_with_artifacts.pipeline["project_id"]), "--ref-name", job_with_artifacts.ref, "--job", job_with_artifacts.name, ] artifacts = subprocess.run(cmd, capture_output=True, check=True) assert isinstance(artifacts.stdout, bytes) artifacts_zip = BytesIO(artifacts.stdout) assert is_zipfile(artifacts_zip) def test_cli_project_artifacts_warns_deprecated(gitlab_config, job_with_artifacts): cmd = [ "gitlab", "--config-file", gitlab_config, "project", "artifacts", "--id", str(job_with_artifacts.pipeline["project_id"]), "--ref-name", job_with_artifacts.ref, "--job", job_with_artifacts.name, ] artifacts = subprocess.run(cmd, capture_output=True, check=True) assert isinstance(artifacts.stdout, bytes) assert b"DeprecationWarning" in artifacts.stderr artifacts_zip = BytesIO(artifacts.stdout) assert is_zipfile(artifacts_zip) def test_cli_project_artifact_raw(gitlab_config, job_with_artifacts): cmd = [ "gitlab", "--config-file", gitlab_config, "project-artifact", "raw", "--project-id", str(job_with_artifacts.pipeline["project_id"]), "--ref-name", job_with_artifacts.ref, "--job", job_with_artifacts.name, "--artifact-path", "artifact.txt", ] artifacts = subprocess.run(cmd, capture_output=True, check=True) assert isinstance(artifacts.stdout, bytes) assert artifacts.stdout == b"test\n" def test_cli_project_artifact_warns_deprecated(gitlab_config, job_with_artifacts): cmd = [ "gitlab", "--config-file", gitlab_config, "project", "artifact", "--id", str(job_with_artifacts.pipeline["project_id"]), "--ref-name", job_with_artifacts.ref, "--job", job_with_artifacts.name, "--artifact-path", "artifact.txt", ] artifacts = subprocess.run(cmd, capture_output=True, check=True) assert isinstance(artifacts.stdout, bytes) assert b"DeprecationWarning" in artifacts.stderr assert artifacts.stdout == b"test\n" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_packages.py0000644000000000000000000000245014366036457023225 0ustar00rootrootpackage_name = "hello-world" package_version = "v1.0.0" file_name = "hello.tar.gz" file_content = "package content" def test_list_project_packages(gitlab_cli, project): cmd = ["project-package", "list", "--project-id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_list_group_packages(gitlab_cli, group): cmd = ["group-package", "list", "--group-id", group.id] ret = gitlab_cli(cmd) assert ret.success def test_upload_generic_package(tmp_path, gitlab_cli, project): path = tmp_path / file_name path.write_text(file_content) cmd = [ "-v", "generic-package", "upload", "--project-id", project.id, "--package-name", package_name, "--path", path, "--package-version", package_version, "--file-name", file_name, ] ret = gitlab_cli(cmd) assert "201 Created" in ret.stdout def test_download_generic_package(gitlab_cli, project): cmd = [ "generic-package", "download", "--project-id", project.id, "--package-name", package_name, "--package-version", package_version, "--file-name", file_name, ] ret = gitlab_cli(cmd) assert ret.stdout == file_content ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_projects.py0000644000000000000000000000323514366036457023302 0ustar00rootrootimport subprocess import time import pytest import responses @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_project_registry_delete_in_bulk( script_runner, resp_delete_registry_tags_in_bulk ): responses.add(**resp_delete_registry_tags_in_bulk) cmd = [ "gitlab", "project-registry-tag", "delete-in-bulk", "--project-id", "1", "--repository-id", "1", "--name-regex-delete", "^.*dev.*$", # TODO: remove `name` after deleting without ID is possible # See #849 and #1631 "--name", ".*", ] ret = ret = script_runner.run(*cmd) assert ret.success @pytest.fixture def project_export(project): export = project.exports.create() export.refresh() count = 0 while export.export_status != "finished": time.sleep(0.5) export.refresh() count += 1 if count == 30: raise Exception("Project export taking too much time") return export def test_project_export_download_custom_action(gitlab_config, project_export): """Tests custom action on ProjectManager""" cmd = [ "gitlab", "--config-file", gitlab_config, "project-export", "download", "--project-id", str(project_export.id), ] export = subprocess.run(cmd, capture_output=True, check=True) assert export.returncode == 0 def test_project_languages_custom_action(gitlab_cli, project, project_file): """Tests custom action on Project/RESTObject""" cmd = ["project", "languages", "--id", project.id] ret = gitlab_cli(cmd) assert ret.success ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_repository.py0000644000000000000000000000602614366036457023671 0ustar00rootrootimport json import time def test_project_create_file(gitlab_cli, project): file_path = "README" branch = "main" content = "CONTENT" commit_message = "Initial commit" cmd = [ "project-file", "create", "--project-id", project.id, "--file-path", file_path, "--branch", branch, "--content", content, "--commit-message", commit_message, ] ret = gitlab_cli(cmd) assert ret.success def test_list_all_commits(gitlab_cli, project): data = { "branch": "new-branch", "start_branch": "main", "commit_message": "New commit on new branch", "actions": [ {"action": "create", "file_path": "new-file", "content": "new content"} ], } commit = project.commits.create(data) cmd = ["project-commit", "list", "--project-id", project.id, "--get-all"] ret = gitlab_cli(cmd) assert commit.id not in ret.stdout # Listing commits on other branches requires `all` parameter passed to the API cmd = ["project-commit", "list", "--project-id", project.id, "--get-all", "--all"] ret_all = gitlab_cli(cmd) assert commit.id in ret_all.stdout assert len(ret_all.stdout) > len(ret.stdout) def test_commit_merge_requests(gitlab_cli, project, merge_request, wait_for_sidekiq): """This tests the `project-commit merge-requests` command and also tests that we can print the result using the `json` formatter""" # create and then merge a merge-request mr = merge_request(source_branch="test_commit_merge_requests") merge_result = mr.merge(should_remove_source_branch=True) wait_for_sidekiq(timeout=60) # Wait until it is merged mr_iid = mr.iid for _ in range(60): mr = project.mergerequests.get(mr_iid) if mr.merged_at is not None: break time.sleep(0.5) assert mr.merged_at is not None time.sleep(0.5) wait_for_sidekiq(timeout=60) commit_sha = merge_result["sha"] cmd = [ "-o", "json", "project-commit", "merge-requests", "--project-id", project.id, "--id", commit_sha, ] ret = gitlab_cli(cmd) assert ret.success json_list = json.loads(ret.stdout) assert isinstance(json_list, list) assert len(json_list) == 1 mr_dict = json_list[0] assert mr_dict["id"] == mr.id assert mr_dict["iid"] == mr.iid def test_revert_commit(gitlab_cli, project): commit = project.commits.list()[0] cmd = [ "project-commit", "revert", "--project-id", project.id, "--id", commit.id, "--branch", "main", ] ret = gitlab_cli(cmd) assert ret.success def test_get_commit_signature_not_found(gitlab_cli, project): commit = project.commits.list()[0] cmd = ["project-commit", "signature", "--project-id", project.id, "--id", commit.id] ret = gitlab_cli(cmd) assert not ret.success assert "404 Signature Not Found" in ret.stderr ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_resource_access_tokens.py0000644000000000000000000000204114366036457026176 0ustar00rootrootimport pytest def test_list_project_access_tokens(gitlab_cli, project): cmd = ["project-access-token", "list", "--project-id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_create_project_access_token_with_scopes(gitlab_cli, project): cmd = [ "project-access-token", "create", "--project-id", project.id, "--name", "test-token", "--scopes", "api,read_repository", ] ret = gitlab_cli(cmd) assert ret.success @pytest.mark.skip(reason="Requires GitLab 14.7") def test_list_group_access_tokens(gitlab_cli, group): cmd = ["group-access-token", "list", "--group-id", group.id] ret = gitlab_cli(cmd) assert ret.success def test_create_group_access_token_with_scopes(gitlab_cli, group): cmd = [ "group-access-token", "create", "--group-id", group.id, "--name", "test-token", "--scopes", "api,read_repository", ] ret = gitlab_cli(cmd) assert ret.success ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_users.py0000644000000000000000000000047514366036457022615 0ustar00rootrootdef test_create_user_impersonation_token_with_scopes(gitlab_cli, user): cmd = [ "user-impersonation-token", "create", "--user-id", user.id, "--name", "test-token", "--scopes", "api,read_user", ] ret = gitlab_cli(cmd) assert ret.success ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_v4.py0000644000000000000000000003645014366036457022007 0ustar00rootrootimport os import time def test_create_project(gitlab_cli): name = "test-project1" cmd = ["project", "create", "--name", name] ret = gitlab_cli(cmd) assert ret.success assert name in ret.stdout def test_update_project(gitlab_cli, project): description = "My New Description" cmd = ["project", "update", "--id", project.id, "--description", description] ret = gitlab_cli(cmd) assert ret.success assert description in ret.stdout def test_create_ci_lint(gitlab_cli, valid_gitlab_ci_yml): cmd = ["ci-lint", "create", "--content", valid_gitlab_ci_yml] ret = gitlab_cli(cmd) assert ret.success def test_validate_ci_lint(gitlab_cli, valid_gitlab_ci_yml): cmd = ["ci-lint", "validate", "--content", valid_gitlab_ci_yml] ret = gitlab_cli(cmd) assert ret.success def test_validate_ci_lint_invalid_exits_non_zero(gitlab_cli, invalid_gitlab_ci_yml): cmd = ["ci-lint", "validate", "--content", invalid_gitlab_ci_yml] ret = gitlab_cli(cmd) assert not ret.success assert "CI YAML Lint failed (Invalid configuration format)" in ret.stderr def test_validate_project_ci_lint(gitlab_cli, project, valid_gitlab_ci_yml): cmd = [ "project-ci-lint", "validate", "--project-id", project.id, "--content", valid_gitlab_ci_yml, ] ret = gitlab_cli(cmd) assert ret.success def test_validate_project_ci_lint_invalid_exits_non_zero( gitlab_cli, project, invalid_gitlab_ci_yml ): cmd = [ "project-ci-lint", "validate", "--project-id", project.id, "--content", invalid_gitlab_ci_yml, ] ret = gitlab_cli(cmd) assert not ret.success assert "CI YAML Lint failed (Invalid configuration format)" in ret.stderr def test_create_group(gitlab_cli): name = "test-group1" path = "group1" cmd = ["group", "create", "--name", name, "--path", path] ret = gitlab_cli(cmd) assert ret.success assert name in ret.stdout assert path in ret.stdout def test_update_group(gitlab_cli, gl, group): description = "My New Description" cmd = ["group", "update", "--id", group.id, "--description", description] ret = gitlab_cli(cmd) assert ret.success group = gl.groups.get(group.id) assert group.description == description def test_create_user(gitlab_cli, gl): email = "fake@email.com" username = "user1" name = "User One" password = "fakepassword" cmd = [ "user", "create", "--email", email, "--username", username, "--name", name, "--password", password, ] ret = gitlab_cli(cmd) assert ret.success user = gl.users.list(username=username)[0] assert user.email == email assert user.username == username assert user.name == name def test_get_user_by_id(gitlab_cli, user): cmd = ["user", "get", "--id", user.id] ret = gitlab_cli(cmd) assert ret.success assert str(user.id) in ret.stdout def test_list_users_verbose_output(gitlab_cli): cmd = ["-v", "user", "list"] ret = gitlab_cli(cmd) assert ret.success assert "avatar-url" in ret.stdout def test_cli_args_not_in_output(gitlab_cli): cmd = ["-v", "user", "list"] ret = gitlab_cli(cmd) assert "config-file" not in ret.stdout def test_add_member_to_project(gitlab_cli, project, user): access_level = "40" cmd = [ "project-member", "create", "--project-id", project.id, "--user-id", user.id, "--access-level", access_level, ] ret = gitlab_cli(cmd) assert ret.success def test_list_user_memberships(gitlab_cli, user): cmd = ["user-membership", "list", "--user-id", user.id] ret = gitlab_cli(cmd) assert ret.success def test_create_project_issue(gitlab_cli, project): title = "my issue" description = "my issue description" cmd = [ "project-issue", "create", "--project-id", project.id, "--title", title, "--description", description, ] ret = gitlab_cli(cmd) assert ret.success assert title in ret.stdout def test_create_issue_note(gitlab_cli, issue): body = "body" cmd = [ "project-issue-note", "create", "--project-id", issue.project_id, "--issue-iid", issue.iid, "--body", body, ] ret = gitlab_cli(cmd) assert ret.success def test_create_branch(gitlab_cli, project): branch = "branch1" cmd = [ "project-branch", "create", "--project-id", project.id, "--branch", branch, "--ref", "main", ] ret = gitlab_cli(cmd) assert ret.success def test_create_merge_request(gitlab_cli, project): branch = "branch1" cmd = [ "project-merge-request", "create", "--project-id", project.id, "--source-branch", branch, "--target-branch", "main", "--title", "Update README", ] ret = gitlab_cli(cmd) assert ret.success def test_accept_request_merge(gitlab_cli, project, wait_for_sidekiq): # MR needs at least 1 commit before we can merge mr = project.mergerequests.list()[0] file_data = { "branch": mr.source_branch, "file_path": "README2", "content": "Content", "commit_message": "Pre-merge commit", } project.files.create(file_data) time.sleep(2) wait_for_sidekiq(timeout=60) cmd = [ "project-merge-request", "merge", "--project-id", project.id, "--iid", mr.iid, ] ret = gitlab_cli(cmd) assert ret.success def test_create_project_label(gitlab_cli, project): name = "prjlabel1" description = "prjlabel1 description" color = "#112233" cmd = [ "-v", "project-label", "create", "--project-id", project.id, "--name", name, "--description", description, "--color", color, ] ret = gitlab_cli(cmd) assert ret.success def test_list_project_labels(gitlab_cli, project): cmd = ["-v", "project-label", "list", "--project-id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_update_project_label(gitlab_cli, label): new_label = "prjlabel2" new_description = "prjlabel2 description" new_color = "#332211" cmd = [ "-v", "project-label", "update", "--project-id", label.project_id, "--name", label.name, "--new-name", new_label, "--description", new_description, "--color", new_color, ] ret = gitlab_cli(cmd) assert ret.success def test_delete_project_label(gitlab_cli, label): # TODO: due to update above, we'd need a function-scope label fixture label_name = "prjlabel2" cmd = [ "-v", "project-label", "delete", "--project-id", label.project_id, "--name", label_name, ] ret = gitlab_cli(cmd) assert ret.success def test_create_group_label(gitlab_cli, group): name = "grouplabel1" description = "grouplabel1 description" color = "#112233" cmd = [ "-v", "group-label", "create", "--group-id", group.id, "--name", name, "--description", description, "--color", color, ] ret = gitlab_cli(cmd) assert ret.success def test_list_group_labels(gitlab_cli, group): cmd = ["-v", "group-label", "list", "--group-id", group.id] ret = gitlab_cli(cmd) assert ret.success def test_update_group_label(gitlab_cli, group_label): new_label = "grouplabel2" new_description = "grouplabel2 description" new_color = "#332211" cmd = [ "-v", "group-label", "update", "--group-id", group_label.group_id, "--name", group_label.name, "--new-name", new_label, "--description", new_description, "--color", new_color, ] ret = gitlab_cli(cmd) assert ret.success def test_delete_group_label(gitlab_cli, group_label): # TODO: due to update above, we'd need a function-scope label fixture new_label = "grouplabel2" cmd = [ "-v", "group-label", "delete", "--group-id", group_label.group_id, "--name", new_label, ] ret = gitlab_cli(cmd) assert ret.success def test_create_project_variable(gitlab_cli, project): key = "junk" value = "car" cmd = [ "-v", "project-variable", "create", "--project-id", project.id, "--key", key, "--value", value, ] ret = gitlab_cli(cmd) assert ret.success def test_get_project_variable(gitlab_cli, variable): cmd = [ "-v", "project-variable", "get", "--project-id", variable.project_id, "--key", variable.key, ] ret = gitlab_cli(cmd) assert ret.success def test_update_project_variable(gitlab_cli, variable): new_value = "bus" cmd = [ "-v", "project-variable", "update", "--project-id", variable.project_id, "--key", variable.key, "--value", new_value, ] ret = gitlab_cli(cmd) assert ret.success def test_list_project_variables(gitlab_cli, project): cmd = ["-v", "project-variable", "list", "--project-id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_delete_project_variable(gitlab_cli, variable): cmd = [ "-v", "project-variable", "delete", "--project-id", variable.project_id, "--key", variable.key, ] ret = gitlab_cli(cmd) assert ret.success def test_delete_branch(gitlab_cli, project): # TODO: branch fixture branch = "branch1" cmd = ["project-branch", "delete", "--project-id", project.id, "--name", branch] ret = gitlab_cli(cmd) assert ret.success def test_project_upload_file(gitlab_cli, project): cmd = [ "project", "upload", "--id", project.id, "--filename", __file__, "--filepath", os.path.realpath(__file__), ] ret = gitlab_cli(cmd) assert ret.success def test_get_application_settings(gitlab_cli): cmd = ["application-settings", "get"] ret = gitlab_cli(cmd) assert ret.success def test_update_application_settings(gitlab_cli): cmd = ["application-settings", "update", "--signup-enabled", "false"] ret = gitlab_cli(cmd) assert ret.success def test_create_project_with_values_from_file(gitlab_cli, tmpdir): name = "gitlab-project-from-file" description = "Multiline\n\nData\n" from_file = tmpdir.join(name) from_file.write(description) from_file_path = f"@{str(from_file)}" cmd = [ "-v", "project", "create", "--name", name, "--description", from_file_path, ] ret = gitlab_cli(cmd) assert ret.success assert description in ret.stdout def test_create_project_deploy_token(gitlab_cli, project): name = "project-token" username = "root" expires_at = "2021-09-09" scopes = "read_registry" cmd = [ "-v", "project-deploy-token", "create", "--project-id", project.id, "--name", name, "--username", username, "--expires-at", expires_at, "--scopes", scopes, ] ret = gitlab_cli(cmd) assert ret.success assert name in ret.stdout assert username in ret.stdout assert expires_at in ret.stdout assert scopes in ret.stdout def test_list_all_deploy_tokens(gitlab_cli, deploy_token): cmd = ["-v", "deploy-token", "list"] ret = gitlab_cli(cmd) assert ret.success assert deploy_token.name in ret.stdout assert str(deploy_token.id) in ret.stdout assert deploy_token.username in ret.stdout assert deploy_token.expires_at in ret.stdout assert deploy_token.scopes[0] in ret.stdout def test_list_project_deploy_tokens(gitlab_cli, deploy_token): cmd = [ "-v", "project-deploy-token", "list", "--project-id", deploy_token.project_id, ] ret = gitlab_cli(cmd) assert ret.success assert deploy_token.name in ret.stdout assert str(deploy_token.id) in ret.stdout assert deploy_token.username in ret.stdout assert deploy_token.expires_at in ret.stdout assert deploy_token.scopes[0] in ret.stdout def test_delete_project_deploy_token(gitlab_cli, deploy_token): cmd = [ "-v", "project-deploy-token", "delete", "--project-id", deploy_token.project_id, "--id", deploy_token.id, ] ret = gitlab_cli(cmd) assert ret.success # TODO assert not in list def test_create_group_deploy_token(gitlab_cli, group): name = "group-token" username = "root" expires_at = "2021-09-09" scopes = "read_registry" cmd = [ "-v", "group-deploy-token", "create", "--group-id", group.id, "--name", name, "--username", username, "--expires-at", expires_at, "--scopes", scopes, ] ret = gitlab_cli(cmd) assert ret.success assert name in ret.stdout assert username in ret.stdout assert expires_at in ret.stdout assert scopes in ret.stdout def test_list_group_deploy_tokens(gitlab_cli, group_deploy_token): cmd = [ "-v", "group-deploy-token", "list", "--group-id", group_deploy_token.group_id, ] ret = gitlab_cli(cmd) assert ret.success assert group_deploy_token.name in ret.stdout assert str(group_deploy_token.id) in ret.stdout assert group_deploy_token.username in ret.stdout assert group_deploy_token.expires_at in ret.stdout assert group_deploy_token.scopes[0] in ret.stdout def test_delete_group_deploy_token(gitlab_cli, group_deploy_token): cmd = [ "-v", "group-deploy-token", "delete", "--group-id", group_deploy_token.group_id, "--id", group_deploy_token.id, ] ret = gitlab_cli(cmd) assert ret.success # TODO assert not in list def test_project_member_all(gitlab_cli, project): cmd = [ "project-member-all", "list", "--project-id", project.id, ] ret = gitlab_cli(cmd) assert ret.success def test_group_member_all(gitlab_cli, group): cmd = [ "group-member-all", "list", "--group-id", group.id, ] ret = gitlab_cli(cmd) assert ret.success # Deleting the project and group. Add your tests above here. def test_delete_project(gitlab_cli, project): cmd = ["project", "delete", "--id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_delete_group(gitlab_cli, group): cmd = ["group", "delete", "--id", group.id] ret = gitlab_cli(cmd) assert ret.success # Don't add tests below here as the group and project have been deleted ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/cli/test_cli_variables.py0000644000000000000000000000247714366036457023430 0ustar00rootrootimport copy import pytest import responses from gitlab.const import DEFAULT_URL def test_list_instance_variables(gitlab_cli, gl): cmd = ["variable", "list"] ret = gitlab_cli(cmd) assert ret.success def test_list_group_variables(gitlab_cli, group): cmd = ["group-variable", "list", "--group-id", group.id] ret = gitlab_cli(cmd) assert ret.success def test_list_project_variables(gitlab_cli, project): cmd = ["project-variable", "list", "--project-id", project.id] ret = gitlab_cli(cmd) assert ret.success def test_list_project_variables_with_path(gitlab_cli, project): cmd = ["project-variable", "list", "--project-id", project.path_with_namespace] ret = gitlab_cli(cmd) assert ret.success @pytest.mark.script_launch_mode("inprocess") @responses.activate def test_list_project_variables_with_path_url_check(script_runner, resp_get_project): resp_get_project_variables = copy.deepcopy(resp_get_project) resp_get_project_variables.update( url=f"{DEFAULT_URL}/api/v4/projects/project%2Fwith%2Fa%2Fnamespace/variables" ) resp_get_project_variables.update(json=[]) responses.add(**resp_get_project_variables) ret = script_runner.run( "gitlab", "project-variable", "list", "--project-id", "project/with/a/namespace" ) assert ret.success ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/conftest.py0000644000000000000000000005066714366036457020654 0ustar00rootrootimport dataclasses import logging import pathlib import tempfile import time import uuid from subprocess import check_output from typing import Optional import pytest import requests import gitlab import gitlab.base from tests.functional import helpers from tests.functional.fixtures.docker import * # noqa SLEEP_TIME = 10 @dataclasses.dataclass class GitlabVersion: major: int minor: int patch: str revision: str def __post_init__(self): self.major, self.minor = int(self.major), int(self.minor) @pytest.fixture(scope="session") def gitlab_version(gl) -> GitlabVersion: version, revision = gl.version() major, minor, patch = version.split(".") return GitlabVersion(major=major, minor=minor, patch=patch, revision=revision) @pytest.fixture(scope="session") def fixture_dir(test_dir: pathlib.Path) -> pathlib.Path: return test_dir / "functional" / "fixtures" @pytest.fixture(scope="session") def gitlab_service_name() -> str: """The "service" name is the one defined in the `docker-compose.yml` file""" return "gitlab" @pytest.fixture(scope="session") def gitlab_container_name() -> str: """The "container" name is the one defined in the `docker-compose.yml` file for the "gitlab" service""" return "gitlab-test" @pytest.fixture(scope="session") def gitlab_docker_port(docker_services, gitlab_service_name: str) -> int: port: int = docker_services.port_for(gitlab_service_name, container_port=80) return port @pytest.fixture(scope="session") def gitlab_url(docker_ip: str, gitlab_docker_port: int) -> str: return f"http://{docker_ip}:{gitlab_docker_port}" def reset_gitlab(gl: gitlab.Gitlab) -> None: """Delete resources (such as projects, groups, users) that shouldn't exist.""" if helpers.get_gitlab_plan(gl): logging.info("GitLab EE detected") # NOTE(jlvillal): By default in GitLab EE it will wait 7 days before # deleting a group. Disable delayed group/project deletion. settings = gl.settings.get() modified_settings = False if settings.delayed_group_deletion: logging.info("Setting `delayed_group_deletion` to False") settings.delayed_group_deletion = False modified_settings = True if settings.delayed_project_deletion: logging.info("Setting `delayed_project_deletion` to False") settings.delayed_project_deletion = False modified_settings = True if modified_settings: settings.save() for project in gl.projects.list(): for deploy_token in project.deploytokens.list(): logging.info( f"Deleting deploy token: {deploy_token.username!r} in " f"project: {project.path_with_namespace!r}" ) helpers.safe_delete(deploy_token) logging.info(f"Deleting project: {project.path_with_namespace!r}") helpers.safe_delete(project) for group in gl.groups.list(): # skip deletion of a descendant group to prevent scenarios where parent group # gets deleted leaving a dangling descendant whose deletion will throw 404s. if group.parent_id: logging.info( f"Skipping deletion of {group.full_path} as it is a descendant " f"group and will be removed when the parent group is deleted" ) continue for deploy_token in group.deploytokens.list(): logging.info( f"Deleting deploy token: {deploy_token.username!r} in " f"group: {group.path_with_namespace!r}" ) helpers.safe_delete(deploy_token) logging.info(f"Deleting group: {group.full_path!r}") helpers.safe_delete(group) for topic in gl.topics.list(): logging.info(f"Deleting topic: {topic.name!r}") helpers.safe_delete(topic) for variable in gl.variables.list(): logging.info(f"Deleting variable: {variable.key!r}") helpers.safe_delete(variable) for user in gl.users.list(): if user.username not in ["root", "ghost"]: logging.info(f"Deleting user: {user.username!r}") helpers.safe_delete(user, hard_delete=True) def set_token(container: str, fixture_dir: pathlib.Path) -> str: logging.info("Creating API token.") set_token_rb = fixture_dir / "set_token.rb" with open(set_token_rb, "r", encoding="utf-8") as f: set_token_command = f.read().strip() rails_command = [ "docker", "exec", container, "gitlab-rails", "runner", set_token_command, ] output = check_output(rails_command).decode().strip() logging.info("Finished creating API token.") return output def pytest_report_collectionfinish(config, startdir, items): return [ "", "Starting GitLab container.", "Waiting for GitLab to reconfigure.", "This will take a few minutes.", ] def pytest_addoption(parser): parser.addoption( "--keep-containers", action="store_true", help="Keep containers running after testing", ) @pytest.fixture(scope="session") def temp_dir() -> pathlib.Path: return pathlib.Path(tempfile.gettempdir()) @pytest.fixture(scope="session") def check_is_alive(): """ Return a healthcheck function fixture for the GitLab container spinup. """ def _check( *, container: str, start_time: float, gitlab_url: str, ) -> bool: setup_time = time.perf_counter() - start_time minutes, seconds = int(setup_time / 60), int(setup_time % 60) logging.info( f"Checking if GitLab container is up. " f"Have been checking for {minutes} minute(s), {seconds} seconds ..." ) logs = ["docker", "logs", container] if "gitlab Reconfigured!" not in check_output(logs).decode(): return False logging.debug("GitLab has finished reconfiguring.") for check in ("health", "readiness", "liveness"): url = f"{gitlab_url}/-/{check}" logging.debug(f"Checking {check!r} endpoint at: {url}") try: result = requests.get(url, timeout=1.0) except requests.exceptions.Timeout: logging.info(f"{check!r} check timed out") return False if result.status_code != 200: logging.info(f"{check!r} check did not return 200: {result!r}") return False logging.debug(f"{check!r} check passed: {result!r}") logging.debug(f"Sleeping for {SLEEP_TIME}") time.sleep(SLEEP_TIME) return True return _check @pytest.fixture def wait_for_sidekiq(gl): """ Return a helper function to wait until there are no busy sidekiq processes. Use this with asserts for slow tasks (group/project/user creation/deletion). """ def _wait(timeout: int = 30, step: float = 0.5, allow_fail: bool = False) -> bool: for count in range(timeout): time.sleep(step) busy = False processes = gl.sidekiq.process_metrics()["processes"] for process in processes: if process["busy"]: busy = True if not busy: return True logging.info(f"sidekiq busy {count} of {timeout}") assert allow_fail, "sidekiq process should have terminated but did not." return False return _wait @pytest.fixture(scope="session") def gitlab_token( check_is_alive, gitlab_container_name: str, gitlab_url: str, docker_services, fixture_dir: pathlib.Path, ) -> str: start_time = time.perf_counter() logging.info("Waiting for GitLab container to become ready.") docker_services.wait_until_responsive( timeout=300, pause=10, check=lambda: check_is_alive( container=gitlab_container_name, start_time=start_time, gitlab_url=gitlab_url, ), ) setup_time = time.perf_counter() - start_time minutes, seconds = int(setup_time / 60), int(setup_time % 60) logging.info( f"GitLab container is now ready after {minutes} minute(s), {seconds} seconds" ) return set_token(gitlab_container_name, fixture_dir=fixture_dir) @pytest.fixture(scope="session") def gitlab_config(gitlab_url: str, gitlab_token: str, temp_dir: pathlib.Path): config_file = temp_dir / "python-gitlab.cfg" config = f"""[global] default = local timeout = 60 [local] url = {gitlab_url} private_token = {gitlab_token} api_version = 4""" with open(config_file, "w", encoding="utf-8") as f: f.write(config) return config_file @pytest.fixture(scope="session") def gl(gitlab_url: str, gitlab_token: str) -> gitlab.Gitlab: """Helper instance to make fixtures and asserts directly via the API.""" logging.info("Instantiating python-gitlab gitlab.Gitlab instance") instance = gitlab.Gitlab(gitlab_url, private_token=gitlab_token) logging.info("Reset GitLab") reset_gitlab(instance) return instance @pytest.fixture(scope="session") def gitlab_plan(gl: gitlab.Gitlab) -> Optional[str]: return helpers.get_gitlab_plan(gl) @pytest.fixture(autouse=True) def gitlab_premium(gitlab_plan, request) -> None: if gitlab_plan in ("premium", "ultimate"): return if request.node.get_closest_marker("gitlab_ultimate"): pytest.skip("Test requires GitLab Premium plan") @pytest.fixture(autouse=True) def gitlab_ultimate(gitlab_plan, request) -> None: if gitlab_plan == "ultimate": return if request.node.get_closest_marker("gitlab_ultimate"): pytest.skip("Test requires GitLab Ultimate plan") @pytest.fixture(scope="session") def gitlab_runner(gl): container = "gitlab-runner-test" runner_name = "python-gitlab-runner" token = "registration-token" url = "http://gitlab" docker_exec = ["docker", "exec", container, "gitlab-runner"] register = [ "register", "--run-untagged", "--non-interactive", "--registration-token", token, "--name", runner_name, "--url", url, "--clone-url", url, "--executor", "shell", ] unregister = ["unregister", "--name", runner_name] yield check_output(docker_exec + register).decode() check_output(docker_exec + unregister).decode() @pytest.fixture(scope="module") def group(gl): """Group fixture for group API resource tests.""" _id = uuid.uuid4().hex data = { "name": f"test-group-{_id}", "path": f"group-{_id}", } group = gl.groups.create(data) yield group helpers.safe_delete(group) @pytest.fixture(scope="module") def project(gl): """Project fixture for project API resource tests.""" _id = uuid.uuid4().hex name = f"test-project-{_id}" project = gl.projects.create(name=name) yield project helpers.safe_delete(project) @pytest.fixture(scope="function") def merge_request(project, wait_for_sidekiq): """Fixture used to create a merge_request. It will create a branch, add a commit to the branch, and then create a merge request against project.default_branch. The MR will be returned. When finished any created merge requests and branches will be deleted. NOTE: No attempt is made to restore project.default_branch to its previous state. So if the merge request is merged then its content will be in the project.default_branch branch. """ to_delete = [] def _merge_request(*, source_branch: str, create_pipeline: bool = False): # Wait for processes to be done before we start... # NOTE(jlvillal): Sometimes the CI would give a "500 Internal Server # Error". Hoping that waiting until all other processes are done will # help with that. result = wait_for_sidekiq(timeout=60) assert result is True, "sidekiq process should have terminated but did not" project.refresh() # Gets us the current default branch mr_branch = project.branches.create( {"branch": source_branch, "ref": project.default_branch} ) # NOTE(jlvillal): Must create a commit in the new branch before we can # create an MR that will work. project.files.create( { "file_path": f"README.{source_branch}", "branch": source_branch, "content": "Initial content", "commit_message": "New commit in new branch", } ) if create_pipeline: project.files.create( { "file_path": ".gitlab-ci.yml", "branch": source_branch, "content": """ test: rules: - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' script: - sleep 24h # We don't expect this to finish """, "commit_message": "Add a simple pipeline", } ) mr = project.mergerequests.create( { "source_branch": source_branch, "target_branch": project.default_branch, "title": "Should remove source branch", "remove_source_branch": True, } ) result = wait_for_sidekiq(timeout=60) assert result is True, "sidekiq process should have terminated but did not" mr_iid = mr.iid for _ in range(60): mr = project.mergerequests.get(mr_iid) if mr.merge_status != "checking": break time.sleep(0.5) assert mr.merge_status != "checking" to_delete.extend([mr, mr_branch]) return mr yield _merge_request for object in to_delete: helpers.safe_delete(object) @pytest.fixture(scope="module") def project_file(project): """File fixture for tests requiring a project with files and branches.""" project_file = project.files.create( { "file_path": "README", "branch": "main", "content": "Initial content", "commit_message": "Initial commit", } ) return project_file @pytest.fixture(scope="function") def release(project, project_file): _id = uuid.uuid4().hex name = f"we_have_a_slash/test-release-{_id}" project.refresh() # Gets us the current default branch release = project.releases.create( { "name": name, "tag_name": _id, "description": "description", "ref": project.default_branch, } ) return release @pytest.fixture(scope="function") def service(project): """This is just a convenience fixture to make test cases slightly prettier. Project services are not idempotent. A service cannot be retrieved until it is enabled. After it is enabled the first time, it can never be fully deleted, only disabled.""" service = project.services.update("asana", {"api_key": "api_key"}) yield service try: project.services.delete("asana") except gitlab.exceptions.GitlabDeleteError as e: print(f"Service already disabled: {e}") @pytest.fixture(scope="module") def user(gl): """User fixture for user API resource tests.""" _id = uuid.uuid4().hex email = f"user{_id}@email.com" username = f"user{_id}" name = f"User {_id}" password = "fakepassword" user = gl.users.create(email=email, username=username, name=name, password=password) yield user # Use `hard_delete=True` or a 'Ghost User' may be created. helpers.safe_delete(user, hard_delete=True) @pytest.fixture(scope="module") def issue(project): """Issue fixture for issue API resource tests.""" _id = uuid.uuid4().hex data = {"title": f"Issue {_id}", "description": f"Issue {_id} description"} return project.issues.create(data) @pytest.fixture(scope="module") def milestone(project): _id = uuid.uuid4().hex data = {"title": f"milestone{_id}"} return project.milestones.create(data) @pytest.fixture(scope="module") def label(project): """Label fixture for project label API resource tests.""" _id = uuid.uuid4().hex data = { "name": f"prjlabel{_id}", "description": f"prjlabel1 {_id} description", "color": "#112233", } return project.labels.create(data) @pytest.fixture(scope="module") def group_label(group): """Label fixture for group label API resource tests.""" _id = uuid.uuid4().hex data = { "name": f"grplabel{_id}", "description": f"grplabel1 {_id} description", "color": "#112233", } return group.labels.create(data) @pytest.fixture(scope="module") def epic(group): """Fixture for group epic API resource tests.""" _id = uuid.uuid4().hex return group.epics.create({"title": f"epic-{_id}", "description": f"Epic {_id}"}) @pytest.fixture(scope="module") def variable(project): """Variable fixture for project variable API resource tests.""" _id = uuid.uuid4().hex data = {"key": f"var{_id}", "value": f"Variable {_id}"} return project.variables.create(data) @pytest.fixture(scope="module") def deploy_token(project): """Deploy token fixture for project deploy token API resource tests.""" _id = uuid.uuid4().hex data = { "name": f"token-{_id}", "username": "root", "expires_at": "2021-09-09", "scopes": "read_registry", } return project.deploytokens.create(data) @pytest.fixture(scope="module") def group_deploy_token(group): """Deploy token fixture for group deploy token API resource tests.""" _id = uuid.uuid4().hex data = { "name": f"group-token-{_id}", "username": "root", "expires_at": "2021-09-09", "scopes": "read_registry", } return group.deploytokens.create(data) @pytest.fixture(scope="session") def GPG_KEY(): return """-----BEGIN PGP PUBLIC KEY BLOCK----- mQENBFn5mzYBCADH6SDVPAp1zh/hxmTi0QplkOfExBACpuY6OhzNdIg+8/528b3g Y5YFR6T/HLv/PmeHskUj21end1C0PNG2T9dTx+2Vlh9ISsSG1kyF9T5fvMR3bE0x Dl6S489CXZrjPTS9SHk1kF+7dwjUxLJyxF9hPiSihFefDFu3NeOtG/u8vbC1mewQ ZyAYue+mqtqcCIFFoBz7wHKMWjIVSJSyTkXExu4OzpVvy3l2EikbvavI3qNz84b+ Mgkv/kiBlNoCy3CVuPk99RYKZ3lX1vVtqQ0OgNGQvb4DjcpyjmbKyibuZwhDjIOh au6d1OyEbayTntd+dQ4j9EMSnEvm/0MJ4eXPABEBAAG0G0dpdGxhYlRlc3QxIDxm YWtlQGZha2UudGxkPokBNwQTAQgAIQUCWfmbNgIbAwULCQgHAgYVCAkKCwIEFgID AQIeAQIXgAAKCRBgxELHf8f3hF3yB/wNJlWPKY65UsB4Lo0hs1OxdxCDqXogSi0u 6crDEIiyOte62pNZKzWy8TJcGZvznRTZ7t8hXgKFLz3PRMcl+vAiRC6quIDUj+2V eYfwaItd1lUfzvdCaC7Venf4TQ74f5vvNg/zoGwE6eRoSbjlLv9nqsxeA0rUBUQL LYikWhVMP3TrlfgfduYvh6mfgh57BDLJ9kJVpyfxxx9YLKZbaas9sPa6LgBtR555 JziUxHmbEv8XCsUU8uoFeP1pImbNBplqE3wzJwzOMSmmch7iZzrAwfN7N2j3Wj0H B5kQddJ9dmB4BbU0IXGhWczvdpxboI2wdY8a1JypxOdePoph/43iuQENBFn5mzYB CADnTPY0Zf3d9zLjBNgIb3yDl94uOcKCq0twNmyjMhHzGqw+UMe9BScy34GL94Al xFRQoaL+7P8hGsnsNku29A/VDZivcI+uxTx4WQ7OLcn7V0bnHV4d76iky2ufbUt/ GofthjDs1SonePO2N09sS4V4uK0d5N4BfCzzXgvg8etCLxNmC9BGt7AaKUUzKBO4 2QvNNaC2C/8XEnOgNWYvR36ylAXAmo0sGFXUsBCTiq1fugS9pwtaS2JmaVpZZ3YT pMZlS0+SjC5BZYFqSmKCsA58oBRzCxQz57nR4h5VEflgD+Hy0HdW0UHETwz83E6/ U0LL6YyvhwFr6KPq5GxinSvfABEBAAGJAR8EGAEIAAkFAln5mzYCGwwACgkQYMRC x3/H94SJgwgAlKQb10/xcL/epdDkR7vbiei7huGLBpRDb/L5fM8B5W77Qi8Xmuqj cCu1j99ZCA5hs/vwVn8j8iLSBGMC5gxcuaar/wtmiaEvT9fO/h6q4opG7NcuiJ8H wRj8ccJmRssNqDD913PLz7T40Ts62blhrEAlJozGVG/q7T3RAZcskOUHKeHfc2RI YzGsC/I9d7k6uxAv1L9Nm5F2HaAQDzhkdd16nKkGaPGR35cT1JLInkfl5cdm7ldN nxs4TLO3kZjUTgWKdhpgRNF5hwaz51ZjpebaRf/ZqRuNyX4lIRolDxzOn/+O1o8L qG2ZdhHHmSK2LaQLFiSprUkikStNU9BqSQ== =5OGa -----END PGP PUBLIC KEY BLOCK-----""" @pytest.fixture(scope="session") def SSH_KEY(): return ( "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDZAjAX8vTiHD7Yi3/EzuVaDChtih" "79HyJZ6H9dEqxFfmGA1YnncE0xujQ64TCebhkYJKzmTJCImSVkOu9C4hZgsw6eE76n" "+Cg3VwEeDUFy+GXlEJWlHaEyc3HWioxgOALbUp3rOezNh+d8BDwwqvENGoePEBsz5l" "a6WP5lTi/HJIjAl6Hu+zHgdj1XVExeH+S52EwpZf/ylTJub0Bl5gHwf/siVE48mLMI" "sqrukXTZ6Zg+8EHAIvIQwJ1dKcXe8P5IoLT7VKrbkgAnolS0I8J+uH7KtErZJb5oZh" "S4OEwsNpaXMAr+6/wWSpircV2/e7sFLlhlKBC4Iq1MpqlZ7G3p foo@bar" ) @pytest.fixture(scope="session") def DEPLOY_KEY(): return ( "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDFdRyjJQh+1niBpXqE2I8dzjG" "MXFHlRjX9yk/UfOn075IdaockdU58sw2Ai1XIWFpZpfJkW7z+P47ZNSqm1gzeXI" "rtKa9ZUp8A7SZe8vH4XVn7kh7bwWCUirqtn8El9XdqfkzOs/+FuViriUWoJVpA6" "WZsDNaqINFKIA5fj/q8XQw+BcS92L09QJg9oVUuH0VVwNYbU2M2IRmSpybgC/gu" "uWTrnCDMmLItksATifLvRZwgdI8dr+q6tbxbZknNcgEPrI2jT0hYN9ZcjNeWuyv" "rke9IepE7SPBT41C+YtUX4dfDZDmczM1cE0YL/krdUCfuZHMa4ZS2YyNd6slufc" "vn bar@foo" ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/ee-test.py0000755000000000000000000000000014366036457020350 0ustar00rootroot././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/functional/fixtures/0000755000000000000000000000000014366036463020305 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/.env0000644000000000000000000000006514366036457021102 0ustar00rootrootGITLAB_IMAGE=gitlab/gitlab-ee GITLAB_TAG=15.4.0-ee.0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/__init__.py0000644000000000000000000000000014366036457022407 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/avatar.png0000644000000000000000000000112014366036457022266 0ustar00rootrootPNG  IHDRaIDAT8mn0ECRQ)]UD % 3Ggg<L80 8瘦 !RJ(PJ!@0um4 mvDQncgK:4 땪kC$Iv Z#st]vrPӉ,i(x||$sy}Ǒ먪(x}}# sVZιmϼS5qs^R1ڭc꺦,K3E'Y|>S%4Mq-y~4 u]SUՂJJ:sw~_cֶ)y\% Ð,H$I8($IȲ0 RM4M9m'#i)PJR c Za`&i߀<ϱbY0J)1ppv!Z,cEƘB SJEY1#v}?xrX}uVA@󖀿] > T.]IENDB`././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/create_license.rb0000644000000000000000000000354414366036457023610 0ustar00rootroot# NOTE: As of 2022-06-01 the GitLab Enterprise Edition License has the following # section: # Notwithstanding the foregoing, you may copy and modify the Software for development # and testing purposes, without requiring a subscription. # # https://gitlab.com/gitlab-org/gitlab/-/blob/29503bc97b96af8d4876dc23fc8996e3dab7d211/ee/LICENSE # # This code is strictly intended for use in the testing framework of python-gitlab # Code inspired by MIT licensed code at: https://github.com/CONIGUERO/gitlab-license.git require 'openssl' require 'gitlab/license' # Generate a 2048 bit key pair. license_encryption_key = OpenSSL::PKey::RSA.generate(2048) # Save the private key File.open("/.license_encryption_key", "w") { |f| f.write(license_encryption_key.to_pem) } # Save the public key public_key = license_encryption_key.public_key File.open("/.license_encryption_key.pub", "w") { |f| f.write(public_key.to_pem) } File.open("/opt/gitlab/embedded/service/gitlab-rails/.license_encryption_key.pub", "w") { |f| f.write(public_key.to_pem) } Gitlab::License.encryption_key = license_encryption_key # Build a new license. license = Gitlab::License.new license.licensee = { "Name" => "python-gitlab-ci", "Company" => "python-gitlab-ci", "Email" => "python-gitlab-ci@example.com", } # The date the license starts. license.starts_at = Date.today # Want to make sure we get at least 1 day of usage. Do two days after because if CI # started at 23:59 we could be expired in one minute if we only did one next_day. license.expires_at = Date.today.next_day.next_day # Use 'ultimate' plan so that we can test all features in the CI license.restrictions = { :plan => "ultimate", :id => rand(1000..99999999) } # Export the license, which encrypts and encodes it. data = license.export File.open("/python-gitlab-ci.gitlab-license", 'w') { |file| file.write(data) } ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/docker-compose.yml0000644000000000000000000000326514366036457023753 0ustar00rootrootversion: '3.5' networks: gitlab-network: name: gitlab-network services: gitlab: image: '${GITLAB_IMAGE}:${GITLAB_TAG}' container_name: 'gitlab-test' hostname: 'gitlab.test' privileged: true # Just in case https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/1350 environment: GITLAB_ROOT_PASSWORD: 5iveL!fe GITLAB_SHARED_RUNNERS_REGISTRATION_TOKEN: registration-token GITLAB_OMNIBUS_CONFIG: | external_url 'http://127.0.0.1:8080' registry['enable'] = false nginx['redirect_http_to_https'] = false nginx['listen_port'] = 80 nginx['listen_https'] = false pages_external_url 'http://pages.gitlab.lxd' gitlab_pages['enable'] = true gitlab_pages['inplace_chroot'] = true prometheus['enable'] = false alertmanager['enable'] = false node_exporter['enable'] = false redis_exporter['enable'] = false postgres_exporter['enable'] = false pgbouncer_exporter['enable'] = false gitlab_exporter['enable'] = false grafana['enable'] = false letsencrypt['enable'] = false gitlab_rails['initial_license_file'] = '/python-gitlab-ci.gitlab-license' gitlab_rails['monitoring_whitelist'] = ['0.0.0.0/0'] entrypoint: - /bin/sh - -c - ruby /create_license.rb && /assets/wrapper volumes: - ${PWD}/tests/functional/fixtures/create_license.rb:/create_license.rb ports: - '8080:80' - '2222:22' networks: - gitlab-network gitlab-runner: image: gitlab/gitlab-runner:latest container_name: 'gitlab-runner-test' depends_on: - gitlab networks: - gitlab-network ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/docker.py0000644000000000000000000000127014366036457022131 0ustar00rootroot""" pytest-docker fixture overrides. See https://github.com/avast/pytest-docker#available-fixtures. """ import pytest @pytest.fixture(scope="session") def docker_compose_project_name(): """Set a consistent project name to enable optional reuse of containers.""" return "pytest-python-gitlab" @pytest.fixture(scope="session") def docker_compose_file(fixture_dir): return fixture_dir / "docker-compose.yml" @pytest.fixture(scope="session") def docker_cleanup(request): """Conditionally keep containers around by overriding the cleanup command.""" if request.config.getoption("--keep-containers"): # Print version and exit. return "-v" return "down -v" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/invalid_auth.cfg0000644000000000000000000000006714366036457023443 0ustar00rootroot[test] url = https://gitlab.com private_token = abc123 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/invalid_version.cfg0000644000000000000000000000007014366036457024161 0ustar00rootroot[test] api_version = 3 url = https://gitlab.example.com ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/fixtures/set_token.rb0000644000000000000000000000050214366036457022625 0ustar00rootroot# https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#programmatically-creating-a-personal-access-token user = User.find_by_username('root') token = user.personal_access_tokens.first_or_create(scopes: [:api, :sudo], name: 'default'); token.set_token('python-gitlab-token'); token.save! puts token.token ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/functional/helpers.py0000644000000000000000000000303214366036457020451 0ustar00rootrootimport logging import time from typing import Optional, TYPE_CHECKING import pytest import gitlab import gitlab.base import gitlab.exceptions SLEEP_INTERVAL = 0.5 TIMEOUT = 60 # seconds before timeout will occur MAX_ITERATIONS = int(TIMEOUT / SLEEP_INTERVAL) def get_gitlab_plan(gl: gitlab.Gitlab) -> Optional[str]: """Determine the license available on the GitLab instance""" try: license = gl.get_license() except gitlab.exceptions.GitlabLicenseError: # Without a license we assume only Free features are available return None if TYPE_CHECKING: assert isinstance(license["plan"], str) return license["plan"] def safe_delete( object: gitlab.base.RESTObject, *, hard_delete: bool = False, ) -> None: """Ensure the object specified can not be retrieved. If object still exists after timeout period, fail the test""" manager = object.manager for index in range(MAX_ITERATIONS): try: object = manager.get(object.get_id()) # type: ignore[attr-defined] except gitlab.exceptions.GitlabGetError: return if index: logging.info(f"Attempt {index+1} to delete {object!r}.") try: if hard_delete: object.delete(hard_delete=True) else: object.delete() except gitlab.exceptions.GitlabDeleteError: logging.info(f"{object!r} already deleted.") pass time.sleep(SLEEP_INTERVAL) pytest.fail(f"{object!r} was not deleted") ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/install/0000755000000000000000000000000014366036463015740 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/install/test_install.py0000644000000000000000000000017514366036457021025 0ustar00rootrootimport pytest def test_install() -> None: with pytest.raises(ImportError): import httpx # type: ignore # noqa ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/meta/0000755000000000000000000000000014366036463015220 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/meta/__init__.py0000644000000000000000000000000014366036457017322 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/meta/test_ensure_type_hints.py0000644000000000000000000001040014366036457022376 0ustar00rootroot""" Ensure type-hints are setup correctly and detect if missing functions. Original notes by John L. Villalovos """ import dataclasses import functools import inspect from typing import Optional, Type import pytest import gitlab.mixins import gitlab.v4.objects @functools.total_ordering @dataclasses.dataclass(frozen=True) class ClassInfo: name: str type: Type # type: ignore[type-arg] def __lt__(self, other: object) -> bool: if not isinstance(other, ClassInfo): return NotImplemented return (self.type.__module__, self.name) < (other.type.__module__, other.name) def __eq__(self, other: object) -> bool: if not isinstance(other, ClassInfo): return NotImplemented return (self.type.__module__, self.name) == (other.type.__module__, other.name) def pytest_generate_tests(metafunc: pytest.Metafunc) -> None: """Find all of the classes in gitlab.v4.objects and pass them to our test function""" class_info_set = set() for _, module_value in inspect.getmembers(gitlab.v4.objects): if not inspect.ismodule(module_value): # We only care about the modules continue # Iterate through all the classes in our module for class_name, class_value in inspect.getmembers(module_value): if not inspect.isclass(class_value): continue module_name = class_value.__module__ # Ignore imported classes from gitlab.base if module_name == "gitlab.base": continue if not class_name.endswith("Manager"): continue class_info_set.add(ClassInfo(name=class_name, type=class_value)) metafunc.parametrize("class_info", sorted(class_info_set)) GET_ID_METHOD_TEMPLATE = """ def get( self, id: Union[str, int], lazy: bool = False, **kwargs: Any ) -> {obj_cls.__name__}: return cast({obj_cls.__name__}, super().get(id=id, lazy=lazy, **kwargs)) You may also need to add the following imports: from typing import Any, cast, Union" """ GET_WITHOUT_ID_METHOD_TEMPLATE = """ def get(self, **kwargs: Any) -> {obj_cls.__name__}: return cast({obj_cls.__name__}, super().get(**kwargs)) You may also need to add the following imports: from typing import Any, cast" """ class TestTypeHints: def test_check_get_function_type_hints(self, class_info: ClassInfo) -> None: """Ensure classes derived from GetMixin have defined a 'get()' method with correct type-hints. """ self.get_check_helper( base_type=gitlab.mixins.GetMixin, class_info=class_info, method_template=GET_ID_METHOD_TEMPLATE, optional_return=False, ) def test_check_get_without_id_function_type_hints( self, class_info: ClassInfo ) -> None: """Ensure classes derived from GetMixin have defined a 'get()' method with correct type-hints. """ self.get_check_helper( base_type=gitlab.mixins.GetWithoutIdMixin, class_info=class_info, method_template=GET_WITHOUT_ID_METHOD_TEMPLATE, optional_return=False, ) def get_check_helper( self, *, base_type: Type, # type: ignore[type-arg] class_info: ClassInfo, method_template: str, optional_return: bool, ) -> None: if not class_info.name.endswith("Manager"): return mro = class_info.type.mro() # The class needs to be derived from GetMixin or we ignore it if base_type not in mro: return obj_cls = class_info.type._obj_cls signature = inspect.signature(class_info.type.get) filename = inspect.getfile(class_info.type) fail_message = ( f"class definition for {class_info.name!r} in file {filename!r} " f"must have defined a 'get' method with a return annotation of " f"{obj_cls} but found {signature.return_annotation}\n" f"Recommend adding the following method:\n" ) fail_message += method_template.format(obj_cls=obj_cls) check_type = obj_cls if optional_return: check_type = Optional[obj_cls] assert check_type == signature.return_annotation, fail_message ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/meta/test_mro.py0000644000000000000000000000766714366036457017451 0ustar00rootroot""" Ensure objects defined in gitlab.v4.objects have REST* as last item in class definition Original notes by John L. Villalovos An example of an incorrect definition: class ProjectPipeline(RESTObject, RefreshMixin, ObjectDeleteMixin): ^^^^^^^^^^ This should be at the end. Correct way would be: class ProjectPipeline(RefreshMixin, ObjectDeleteMixin, RESTObject): Correctly at the end ^^^^^^^^^^ Why this is an issue: When we do type-checking for gitlab/mixins.py we make RESTObject or RESTManager the base class for the mixins Here is how our classes look when type-checking: class RESTObject: def __init__(self, manager: "RESTManager", attrs: Dict[str, Any]) -> None: ... class Mixin(RESTObject): ... # Wrong ordering here class Wrongv4Object(RESTObject, RefreshMixin): ... If we actually ran this in Python we would get the following error: class Wrongv4Object(RESTObject, Mixin): TypeError: Cannot create a consistent method resolution order (MRO) for bases RESTObject, Mixin When we are type-checking it fails to understand the class Wrongv4Object and thus we can't type check it correctly. Almost all classes in gitlab/v4/objects/*py were already correct before this check was added. """ import inspect import pytest import gitlab.v4.objects def test_show_issue() -> None: """Test case to demonstrate the TypeError that occurs""" class RESTObject: def __init__(self, manager: str, attrs: int) -> None: ... class Mixin(RESTObject): ... with pytest.raises(TypeError) as exc_info: # Wrong ordering here class Wrongv4Object(RESTObject, Mixin): # type: ignore ... # The error message in the exception should be: # TypeError: Cannot create a consistent method resolution # order (MRO) for bases RESTObject, Mixin # Make sure the exception string contains "MRO" assert "MRO" in exc_info.exconly() # Correctly ordered class, no exception class Correctv4Object(Mixin, RESTObject): ... def test_mros() -> None: """Ensure objects defined in gitlab.v4.objects have REST* as last item in class definition. We do this as we need to ensure the MRO (Method Resolution Order) is correct. """ failed_messages = [] for module_name, module_value in inspect.getmembers(gitlab.v4.objects): if not inspect.ismodule(module_value): # We only care about the modules continue # Iterate through all the classes in our module for class_name, class_value in inspect.getmembers(module_value): if not inspect.isclass(class_value): continue # Ignore imported classes from gitlab.base if class_value.__module__ == "gitlab.base": continue mro = class_value.mro() # We only check classes which have a 'gitlab.base' class in their MRO has_base = False for count, obj in enumerate(mro, start=1): if obj.__module__ == "gitlab.base": has_base = True base_classname = obj.__name__ if has_base: filename = inspect.getfile(class_value) # NOTE(jlvillal): The very last item 'mro[-1]' is always going # to be 'object'. That is why we are checking 'mro[-2]'. if mro[-2].__module__ != "gitlab.base": failed_messages.append( ( f"class definition for {class_name!r} in file {filename!r} " f"must have {base_classname!r} as the last class in the " f"class definition" ) ) failed_msg = "\n".join(failed_messages) assert not failed_messages, failed_msg ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/meta/test_v4_objects_imported.py0000644000000000000000000000167114366036457022606 0ustar00rootroot""" Ensure objects defined in gitlab.v4.objects are imported in `gitlab/v4/objects/__init__.py` """ import pkgutil from typing import Set import gitlab.v4.objects def test_verify_v4_objects_imported() -> None: assert len(gitlab.v4.objects.__path__) == 1 init_files: Set[str] = set() with open(gitlab.v4.objects.__file__, "r", encoding="utf-8") as in_file: for line in in_file.readlines(): if line.startswith("from ."): init_files.add(line.rstrip()) object_files = set() for module in pkgutil.iter_modules(gitlab.v4.objects.__path__): object_files.add(f"from .{module.name} import *") missing_in_init = object_files - init_files error_message = ( f"\nThe file {gitlab.v4.objects.__file__!r} is missing the following imports:" ) for missing in sorted(missing_in_init): error_message += f"\n {missing}" assert not missing_in_init, error_message ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/smoke/0000755000000000000000000000000014366036463015410 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/smoke/__init__.py0000644000000000000000000000000014366036457017512 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/smoke/test_dists.py0000644000000000000000000000201714366036457020152 0ustar00rootrootimport tarfile import zipfile from pathlib import Path from sys import version_info import pytest from setuptools import sandbox from gitlab._version import __title__, __version__ DIST_DIR = Path("dist") DOCS_DIR = "docs" TEST_DIR = "tests" SDIST_FILE = f"{__title__}-{__version__}.tar.gz" WHEEL_FILE = ( f"{__title__.replace('-', '_')}-{__version__}-py{version_info.major}-none-any.whl" ) @pytest.fixture(scope="function") def build() -> None: sandbox.run_setup("setup.py", ["--quiet", "clean", "--all"]) # type: ignore[no-untyped-call] sandbox.run_setup("setup.py", ["--quiet", "sdist", "bdist_wheel"]) # type: ignore[no-untyped-call] def test_sdist_includes_tests(build): sdist = tarfile.open(DIST_DIR / SDIST_FILE, "r:gz") test_dir = sdist.getmember(f"{__title__}-{__version__}/{TEST_DIR}") assert test_dir.isdir() def test_wheel_excludes_docs_and_tests(build): wheel = zipfile.ZipFile(DIST_DIR / WHEEL_FILE) assert not any(file.startswith((DOCS_DIR, TEST_DIR)) for file in wheel.namelist()) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/unit/0000755000000000000000000000000014366036463015251 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/__init__.py0000644000000000000000000000000014366036457017353 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/conftest.py0000644000000000000000000000354414366036457017461 0ustar00rootrootimport pytest import gitlab @pytest.fixture(scope="session") def fixture_dir(test_dir): return test_dir / "unit" / "fixtures" @pytest.fixture def gl(): return gitlab.Gitlab( "http://localhost", private_token="private_token", ssl_verify=True, api_version="4", ) @pytest.fixture def gl_retry(): return gitlab.Gitlab( "http://localhost", private_token="private_token", ssl_verify=True, api_version="4", retry_transient_errors=True, ) # Todo: parametrize, but check what tests it's really useful for @pytest.fixture def gl_trailing(): return gitlab.Gitlab( "http://localhost/", private_token="private_token", api_version="4" ) @pytest.fixture def default_config(tmpdir): valid_config = """[global] default = one ssl_verify = true timeout = 2 [one] url = http://one.url private_token = ABCDEF """ config_path = tmpdir.join("python-gitlab.cfg") config_path.write(valid_config) return str(config_path) @pytest.fixture def tag_name(): return "v1.0.0" @pytest.fixture def group(gl): return gl.groups.get(1, lazy=True) @pytest.fixture def project(gl): return gl.projects.get(1, lazy=True) @pytest.fixture def another_project(gl): return gl.projects.get(2, lazy=True) @pytest.fixture def project_issue(project): return project.issues.get(1, lazy=True) @pytest.fixture def project_merge_request(project): return project.mergerequests.get(1, lazy=True) @pytest.fixture def release(project, tag_name): return project.releases.get(tag_name, lazy=True) @pytest.fixture def schedule(project): return project.pipelineschedules.get(1, lazy=True) @pytest.fixture def user(gl): return gl.users.get(1, lazy=True) @pytest.fixture def migration(gl): return gl.bulk_imports.get(1, lazy=True) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1675115827.3187912 python-gitlab-3.13.0/tests/unit/fixtures/0000755000000000000000000000000014366036463017122 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/fixtures/todo.json0000644000000000000000000000506714366036457020775 0ustar00rootroot[ { "id": 102, "project": { "id": 2, "name": "Gitlab Ce", "name_with_namespace": "Gitlab Org / Gitlab Ce", "path": "gitlab-ce", "path_with_namespace": "gitlab-org/gitlab-ce" }, "author": { "name": "Administrator", "username": "root", "id": 1, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "web_url": "https://gitlab.example.com/root" }, "action_name": "marked", "target_type": "MergeRequest", "target": { "id": 34, "iid": 7, "project_id": 2, "title": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.", "description": "Et ea et omnis illum cupiditate. Dolor aspernatur tenetur ducimus facilis est nihil. Quo esse cupiditate molestiae illo corrupti qui quidem dolor.", "state": "opened", "created_at": "2016-06-17T07:49:24.419Z", "updated_at": "2016-06-17T07:52:43.484Z", "target_branch": "tutorials_git_tricks", "source_branch": "DNSBL_docs", "upvotes": 0, "downvotes": 0, "author": { "name": "Maxie Medhurst", "username": "craig_rutherford", "id": 12, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon", "web_url": "https://gitlab.example.com/craig_rutherford" }, "assignee": { "name": "Administrator", "username": "root", "id": 1, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "web_url": "https://gitlab.example.com/root" }, "source_project_id": 2, "target_project_id": 2, "labels": [], "work_in_progress": false, "milestone": { "id": 32, "iid": 2, "project_id": 2, "title": "v1.0", "description": "Assumenda placeat ea voluptatem voluptate qui.", "state": "active", "created_at": "2016-06-17T07:47:34.163Z", "updated_at": "2016-06-17T07:47:34.163Z", "due_date": null }, "merge_when_pipeline_succeeds": false, "merge_status": "cannot_be_merged", "subscribed": true, "user_notes_count": 7 }, "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ce/merge_requests/7", "body": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.", "state": "pending", "created_at": "2016-06-17T07:52:35.225Z" } ] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/helpers.py0000644000000000000000000000411214366036457017266 0ustar00rootrootimport datetime import io import json from typing import Optional import requests import responses MATCH_EMPTY_QUERY_PARAMS = [responses.matchers.query_param_matcher({})] # NOTE: The function `httmock_response` and the class `Headers` is taken from # https://github.com/patrys/httmock/ which is licensed under the Apache License, Version # 2.0. Thus it is allowed to be used in this project. # https://www.apache.org/licenses/GPL-compatibility.html class Headers(object): def __init__(self, res): self.headers = res.headers def get_all(self, name, failobj=None): return self.getheaders(name) def getheaders(self, name): return [self.headers.get(name)] def httmock_response( status_code: int = 200, content: str = "", headers=None, reason=None, elapsed=0, request: Optional[requests.models.PreparedRequest] = None, stream: bool = False, http_vsn=11, ) -> requests.models.Response: res = requests.Response() res.status_code = status_code if isinstance(content, (dict, list)): content = json.dumps(content).encode("utf-8") if isinstance(content, str): content = content.encode("utf-8") res._content = content res._content_consumed = content res.headers = requests.structures.CaseInsensitiveDict(headers or {}) res.encoding = requests.utils.get_encoding_from_headers(res.headers) res.reason = reason res.elapsed = datetime.timedelta(elapsed) res.request = request if hasattr(request, "url"): res.url = request.url if isinstance(request.url, bytes): res.url = request.url.decode("utf-8") if "set-cookie" in res.headers: res.cookies.extract_cookies( requests.cookies.MockResponse(Headers(res)), requests.cookies.MockRequest(request), ) if stream: res.raw = io.BytesIO(content) else: res.raw = io.BytesIO(b"") res.raw.version = http_vsn # normally this closes the underlying connection, # but we have nothing to free. res.close = lambda *args, **kwargs: None return res ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1675115827.322791 python-gitlab-3.13.0/tests/unit/mixins/0000755000000000000000000000000014366036463016560 5ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/mixins/__init__.py0000644000000000000000000000000014366036457020662 0ustar00rootroot././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/mixins/test_meta_mixins.py0000644000000000000000000000255714366036457022522 0ustar00rootrootfrom gitlab.mixins import ( CreateMixin, CRUDMixin, DeleteMixin, GetMixin, ListMixin, NoUpdateMixin, RetrieveMixin, UpdateMixin, ) def test_retrieve_mixin(): class M(RetrieveMixin): pass obj = M() assert hasattr(obj, "list") assert hasattr(obj, "get") assert not hasattr(obj, "create") assert not hasattr(obj, "update") assert not hasattr(obj, "delete") assert isinstance(obj, ListMixin) assert isinstance(obj, GetMixin) def test_crud_mixin(): class M(CRUDMixin): pass obj = M() assert hasattr(obj, "get") assert hasattr(obj, "list") assert hasattr(obj, "create") assert hasattr(obj, "update") assert hasattr(obj, "delete") assert isinstance(obj, ListMixin) assert isinstance(obj, GetMixin) assert isinstance(obj, CreateMixin) assert isinstance(obj, UpdateMixin) assert isinstance(obj, DeleteMixin) def test_no_update_mixin(): class M(NoUpdateMixin): pass obj = M() assert hasattr(obj, "get") assert hasattr(obj, "list") assert hasattr(obj, "create") assert not hasattr(obj, "update") assert hasattr(obj, "delete") assert isinstance(obj, ListMixin) assert isinstance(obj, GetMixin) assert isinstance(obj, CreateMixin) assert not isinstance(obj, UpdateMixin) assert isinstance(obj, DeleteMixin) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1675115823.0 python-gitlab-3.13.0/tests/unit/mixins/test_mixin_methods.py0000644000000000000000000003161314366036457023047 0ustar00rootrootimport pytest import requests import responses from gitlab import base from gitlab import types as gl_types from gitlab.mixins import ( CreateMixin, DeleteMixin, GetMixin, GetWithoutIdMixin, ListMixin, RefreshMixin, SaveMixin, SetMixin, UpdateMixin, ) class FakeObject(base.RESTObject): pass class FakeManager(base.RESTManager): _path = "/tests" _obj_cls = FakeObject @responses.activate def test_get_mixin(gl): class M(GetMixin, FakeManager): pass url = "http://localhost/api/v4/tests/42" responses.add( method=responses.GET, url=url, json={"id": 42, "foo": "bar"}, status=200, match=[responses.matchers.query_param_matcher({})], ) mgr = M(gl) obj = mgr.get(42) assert isinstance(obj, FakeObject) assert obj.foo == "bar" assert obj.id == 42 assert obj._lazy is False assert responses.assert_call_count(url, 1) is True def test_get_mixin_lazy(gl): class M(GetMixin, FakeManager): pass url = "http://localhost/api/v4/tests/42" mgr = M(gl) with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: rsps.add( method=responses.GET, url=url, json={"id": 42, "foo": "bar"}, status=200, match=[responses.matchers.query_param_matcher({})], ) obj = mgr.get(42, lazy=True) assert isinstance(obj, FakeObject) assert not hasattr(obj, "foo") assert obj.id == 42 assert obj._lazy is True # a `lazy` get does not make a network request assert not rsps.calls def test_get_mixin_lazy_missing_attribute(gl): class FakeGetManager(GetMixin, FakeManager): pass manager = FakeGetManager(gl) obj = manager.get(1, lazy=True) assert obj.id == 1 with pytest.raises(AttributeError) as exc: obj.missing_attribute # undo `textwrap.fill()` message = str(exc.value).replace("\n", " ") assert "'FakeObject' object has no attribute 'missing_attribute'" in message assert ( "note that was " "created as a `lazy` object and was not initialized with any data." ) in message @responses.activate def test_head_mixin(gl): class M(GetMixin, FakeManager): pass url = "http://localhost/api/v4/tests/42" responses.add( method=responses.HEAD, url=url, headers={"X-GitLab-Header": "test"}, status=200, match=[responses.matchers.query_param_matcher({})], ) manager = M(gl) result = manager.head(42) assert isinstance(result, requests.structures.CaseInsensitiveDict) assert result["x-gitlab-header"] == "test" @responses.activate def test_refresh_mixin(gl): class TestClass(RefreshMixin, FakeObject): pass url = "http://localhost/api/v4/tests/42" responses.add( method=responses.GET, url=url, json={"id": 42, "foo": "bar"}, status=200, match=[responses.matchers.query_param_matcher({})], ) mgr = FakeManager(gl) obj = TestClass(mgr, {"id": 42}) res = obj.refresh() assert res is None assert obj.foo == "bar" assert obj.id == 42 assert responses.assert_call_count(url, 1) is True @responses.activate def test_get_without_id_mixin(gl): class M(GetWithoutIdMixin, FakeManager): pass url = "http://localhost/api/v4/tests" responses.add( method=responses.GET, url=url, json={"foo": "bar"}, status=200, match=[responses.matchers.query_param_matcher({})], ) mgr = M(gl) obj = mgr.get() assert isinstance(obj, FakeObject) assert obj.foo == "bar" assert not hasattr(obj, "id") assert responses.assert_call_count(url, 1) is True @responses.activate def test_list_mixin(gl): class M(ListMixin, FakeManager): pass url = "http://localhost/api/v4/tests" headers = { "X-Page": "1", "X-Next-Page": "2", "X-Per-Page": "1", "X-Total-Pages": "2", "X-Total": "2", "Link": ("