Python-gitlab

Bug Fixes

- Optionally keep user-provided base URL for pagination
([2149](https://github.com/python-gitlab/python-gitlab/pull/2149),
[`e2ea8b8`](https://github.com/python-gitlab/python-gitlab/commit/e2ea8b89a7b0aebdb1eb3b99196d7c0034076df8))

- **client**: Ensure encoded query params are never duplicated
([`1398426`](https://github.com/python-gitlab/python-gitlab/commit/1398426cd748fdf492fe6184b03ac2fcb7e4fd6e))

Chores

- Change `_repr_attr` for Project to be `path_with_namespace`
([`7cccefe`](https://github.com/python-gitlab/python-gitlab/commit/7cccefe6da0e90391953734d95debab2fe07ea49))

Previously `_repr_attr` was `path` but that only gives the basename of the path. So
https://gitlab.com/gitlab-org/gitlab would only show "gitlab". Using `path_with_namespace` it will
now show "gitlab-org/gitlab"

- Enable mypy check `disallow_any_generics`
([`24d17b4`](https://github.com/python-gitlab/python-gitlab/commit/24d17b43da16dd11ab37b2cee561d9392c90f32e))

- Enable mypy check `no_implicit_optional`
([`64b208e`](https://github.com/python-gitlab/python-gitlab/commit/64b208e0e91540af2b645da595f0ef79ee7522e1))

- Enable mypy check `warn_return_any`
([`76ec4b4`](https://github.com/python-gitlab/python-gitlab/commit/76ec4b481fa931ea36a195ac474812c11babef7b))

Update code so that the `warn_return_any` check passes.

- Make code PEP597 compliant
([`433dba0`](https://github.com/python-gitlab/python-gitlab/commit/433dba02e0d4462ae84a73d8699fe7f3e07aa410))

Use `encoding="utf-8"` in `open()` and open-like functions.

https://peps.python.org/pep-0597/

- Use `urlunparse` instead of string replace
([`6d1b62d`](https://github.com/python-gitlab/python-gitlab/commit/6d1b62d4b248c4c021a59cd234c3a2b19e6fad07))

Use the `urlunparse()` function to reconstruct the URL without the query parameters.

- **ci**: Bump semantic-release for fixed commit parser
([`1e063ae`](https://github.com/python-gitlab/python-gitlab/commit/1e063ae1c4763c176be3c5e92da4ffc61cb5d415))

- **clusters**: Deprecate clusters support
([`b46b379`](https://github.com/python-gitlab/python-gitlab/commit/b46b3791707ac76d501d6b7b829d1370925fd614))

Cluster support was deprecated in GitLab 14.5 [1]. And disabled by default in GitLab 15.0 [2]

* Update docs to mark clusters as deprecated * Remove testing of clusters

[1] https://docs.gitlab.com/ee/api/project_clusters.html [2]
https://gitlab.com/groups/gitlab-org/configure/-/epics/8

- **deps**: Update dependency commitizen to v2.29.2
([`30274ea`](https://github.com/python-gitlab/python-gitlab/commit/30274ead81205946a5a7560e592f346075035e0e))

- **deps**: Update dependency flake8 to v5
([`cdc384b`](https://github.com/python-gitlab/python-gitlab/commit/cdc384b8a2096e31aff12ea98383e2b1456c5731))

- **deps**: Update dependency types-requests to v2.28.6
([`54dd4c3`](https://github.com/python-gitlab/python-gitlab/commit/54dd4c3f857f82aa8781b0daf22fa2dd3c60c2c4))

- **deps**: Update pre-commit hook commitizen-tools/commitizen to v2.29.2
([`4988c02`](https://github.com/python-gitlab/python-gitlab/commit/4988c029e0dda89ff43375d1cd2f407abdbe3dc7))

- **topics**: 'title' is required when creating a topic
([`271f688`](https://github.com/python-gitlab/python-gitlab/commit/271f6880dbb15b56305efc1fc73924ac26fb97ad))

In GitLab >= 15.0 `title` is required when creating a topic.

Documentation

- Describe self-revoking personal access tokens
([`5ea48fc`](https://github.com/python-gitlab/python-gitlab/commit/5ea48fc3c28f872dd1184957a6f2385da075281c))

Features

- Support downloading archive subpaths
([`cadb0e5`](https://github.com/python-gitlab/python-gitlab/commit/cadb0e55347cdac149e49f611c99b9d53a105520))

- **client**: Warn user on misconfigured URL in `auth()`
([`0040b43`](https://github.com/python-gitlab/python-gitlab/commit/0040b4337bae815cfe1a06f8371a7a720146f271))

Refactoring

- **client**: Factor out URL check into a helper
([`af21a18`](https://github.com/python-gitlab/python-gitlab/commit/af21a1856aa904f331859983493fe966d5a2969b))

- **client**: Remove handling for incorrect link header
([`77c04b1`](https://github.com/python-gitlab/python-gitlab/commit/77c04b1acb2815290bcd6f50c37d75329409e9d3))

This was a quirk only present in GitLab 13.0 and fixed with 13.1. See
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33714 and
https://gitlab.com/gitlab-org/gitlab/-/issues/218504 for more context.

Testing

- Attempt to make functional test startup more reliable
([`67508e8`](https://github.com/python-gitlab/python-gitlab/commit/67508e8100be18ce066016dcb8e39fa9f0c59e51))

The functional tests have been erratic. Current theory is that we are starting the tests before the
GitLab container is fully up and running.

* Add checking of the Health Check[1] endpoints. * Add a 20 second delay after we believe it is up
and running. * Increase timeout from 300 to 400 seconds

[1] https://docs.gitlab.com/ee/user/admin_area/monitoring/health_check.html

- **functional**: Bump GitLab docker image to 15.2.0-ee.0
([`69014e9`](https://github.com/python-gitlab/python-gitlab/commit/69014e9be3a781be6742478af820ea097d004791))

Use the GitLab docker image 15.2.0-ee.0 in the functional testing.

- **unit**: Reproduce duplicate encoded query params
([`6f71c66`](https://github.com/python-gitlab/python-gitlab/commit/6f71c663a302b20632558b4c94be428ba831ee7f))

Bug Fixes

- Add `get_all` param (and `--get-all`) to allow passing `all` to API
([`7c71d5d`](https://github.com/python-gitlab/python-gitlab/commit/7c71d5db1199164b3fa9958e3c3bc6ec96efc78d))

- Enable epic notes
([`5fc3216`](https://github.com/python-gitlab/python-gitlab/commit/5fc3216788342a2325662644b42e8c249b655ded))

Add the notes attribute to GroupEpic

- Ensure path elements are escaped
([`5d9c198`](https://github.com/python-gitlab/python-gitlab/commit/5d9c198769b00c8e7661e62aaf5f930ed32ef829))

Ensure the path elements that are passed to the server are escaped. For example a "/" will be
changed to "%2F"

Closes: 2116

- Results returned by `attributes` property to show updates
([`e5affc8`](https://github.com/python-gitlab/python-gitlab/commit/e5affc8749797293c1373c6af96334f194875038))

Previously the `attributes` method would show the original values in a Gitlab Object even if they
had been updated. Correct this so that the updated value will be returned.

Also use copy.deepcopy() to ensure that modifying the dictionary returned can not also modify the
object.

- 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))

1. If a value is of type ArrayAttribute then append '[]' to the name of the value for query
parameters (`params`).

This is step 3 in a series of steps of our goal to add full support for the GitLab API data
types[1]: * array * hash * array of hashes

Step one was: commit 5127b1594c00c7364e9af15e42d2e2f2d909449b Step two was: commit
a57334f1930752c70ea15847a39324fa94042460

Fixes: 1698

[1] https://docs.gitlab.com/ee/api/#encoding-api-parameters-of-array-and-hash-types

- **cli**: Remove irrelevant MR approval rule list filters
([`0daec5f`](https://github.com/python-gitlab/python-gitlab/commit/0daec5fa1428a56a6a927b133613e8b296248167))

- **config**: Raise error when gitlab id provided but no config file found
([`ac46c1c`](https://github.com/python-gitlab/python-gitlab/commit/ac46c1cb291c03ad14bc76f5f16c9f98f2a5a82d))

- **config**: Raise error when gitlab id provided but no config section found
([`1ef7018`](https://github.com/python-gitlab/python-gitlab/commit/1ef70188da1e29cd8ba95bf58c994ba7dd3010c5))

- **runners**: Fix listing for /runners/all
([`c6dd57c`](https://github.com/python-gitlab/python-gitlab/commit/c6dd57c56e92abb6184badf4708f5f5e65c6d582))

Chores

- Add a `lazy` boolean attribute to `RESTObject`
([`a7e8cfb`](https://github.com/python-gitlab/python-gitlab/commit/a7e8cfbae8e53d2c4b1fb75d57d42f00db8abd81))

This can be used to tell if a `RESTObject` was created using `lazy=True`.

Add a message to the `AttributeError` if attribute access fails for an instance created with
`lazy=True`.

- Change name of API functional test to `api_func_v4`
([`8cf5cd9`](https://github.com/python-gitlab/python-gitlab/commit/8cf5cd935cdeaf36a6877661c8dfb0be6c69f587))

The CLI test is `cli_func_v4` and using `api_func_v4` matches with that naming convention.

- Enable mypy check `strict_equality`
([`a29cd6c`](https://github.com/python-gitlab/python-gitlab/commit/a29cd6ce1ff7fa7f31a386cea3e02aa9ba3fb6c2))

Enable the `mypy` `strict_equality` check.

- Enable using GitLab EE in functional tests
([`17c01ea`](https://github.com/python-gitlab/python-gitlab/commit/17c01ea55806c722523f2f9aef0175455ec942c5))

Enable using GitLab Enterprise Edition (EE) in the functional tests. This will allow us to add
functional tests for EE only features in the functional tests.

- Fix misspelling
([`2d08fc8`](https://github.com/python-gitlab/python-gitlab/commit/2d08fc89fb67de25ad41f64c86a9b8e96e4c261a))

- Fixtures: after delete() wait to verify deleted
([`1f73b6b`](https://github.com/python-gitlab/python-gitlab/commit/1f73b6b20f08a0fe4ce4cf9195702a03656a54e1))

In our fixtures that create: - groups - project merge requests - projects - users

They delete the created objects after use. Now wait to ensure the objects are deleted before
continuing as having unexpected objects existing can impact some of our tests.

- Make reset_gitlab() better
([`d87d6b1`](https://github.com/python-gitlab/python-gitlab/commit/d87d6b12fd3d73875559924cda3fd4b20402d336))

Saw issues in the CI where reset_gitlab() would fail. It would fail to delete the group that is
created when GitLab starts up. Extending the timeout didn't fix the issue.

Changed the code to use the new `helpers.safe_delete()` function. Which will delete the resource and
then make sure it is deleted before returning.

Also added some logging functionality that can be seen if logging is turned on in pytest.

- Revert "test(functional): simplify token creation"
([`4b798fc`](https://github.com/python-gitlab/python-gitlab/commit/4b798fc2fdc44b73790c493c329147013464de14))

This reverts commit 67ab24fe5ae10a9f8cc9122b1a08848e8927635d.

- Simplify multi-nested try blocks
([`e734470`](https://github.com/python-gitlab/python-gitlab/commit/e7344709d931e2b254d225d77ca1474bc69971f8))

Instead of have a multi-nested series of try blocks. Convert it to a more readable series of `if`
statements.

- **authors**: Fix email and do the ABC
([`9833632`](https://github.com/python-gitlab/python-gitlab/commit/98336320a66d1859ba73e084a5e86edc3aa1643c))

- **ci_lint**: Add create attributes
([`6e1342f`](https://github.com/python-gitlab/python-gitlab/commit/6e1342fc0b7cf740b25a939942ea02cdd18a9625))

- **deps**: Update black to v22.6.0
([`82bd596`](https://github.com/python-gitlab/python-gitlab/commit/82bd59673c5c66da0cfa3b24d58b627946fe2cc3))

- **deps**: Update dependency commitizen to v2.28.0
([`8703dd3`](https://github.com/python-gitlab/python-gitlab/commit/8703dd3c97f382920075e544b1b9d92fab401cc8))

- **deps**: Update dependency commitizen to v2.29.0
([`c365be1`](https://github.com/python-gitlab/python-gitlab/commit/c365be1b908c5e4fda445680c023607bdf6c6281))

- **deps**: Update dependency mypy to v0.971
([`7481d27`](https://github.com/python-gitlab/python-gitlab/commit/7481d271512eaa234315bcdbaf329026589bfda7))

- **deps**: Update dependency pylint to v2.14.4
([`2cee2d4`](https://github.com/python-gitlab/python-gitlab/commit/2cee2d4a86e76d3f63f3608ed6a92e64813613d3))

- **deps**: Update dependency pylint to v2.14.5
([`e153636`](https://github.com/python-gitlab/python-gitlab/commit/e153636d74a0a622b0cc18308aee665b3eca58a4))

- **deps**: Update dependency requests to v2.28.1
([`be33245`](https://github.com/python-gitlab/python-gitlab/commit/be3324597aa3f22b0692d3afa1df489f2709a73e))

- **deps**: Update pre-commit hook commitizen-tools/commitizen to v2.28.0
([`d238e1b`](https://github.com/python-gitlab/python-gitlab/commit/d238e1b464c98da86677934bf99b000843d36747))

- **deps**: Update pre-commit hook commitizen-tools/commitizen to v2.29.0
([`ad8d62a`](https://github.com/python-gitlab/python-gitlab/commit/ad8d62ae9612c173a749d413f7a84e5b8c0167cf))

- **deps**: Update pre-commit hook pycqa/pylint to v2.14.4
([`5cd39be`](https://github.com/python-gitlab/python-gitlab/commit/5cd39be000953907cdc2ce877a6bf267d601b707))

- **deps**: Update pre-commit hook pycqa/pylint to v2.14.5
([`c75a1d8`](https://github.com/python-gitlab/python-gitlab/commit/c75a1d860709e17a7c3324c5d85c7027733ea1e1))

- **deps**: Update typing dependencies
([`f2209a0`](https://github.com/python-gitlab/python-gitlab/commit/f2209a0ea084eaf7fbc89591ddfea138d99527a6))

- **deps**: Update typing dependencies
([`e772248`](https://github.com/python-gitlab/python-gitlab/commit/e77224818e63e818c10a7fad69f90e16d618bdf7))

- **docs**: Convert tabs to spaces
([`9ea5520`](https://github.com/python-gitlab/python-gitlab/commit/9ea5520cec8979000d7f5dbcc950f2250babea96))

Some tabs snuck into the documentation. Convert them to 4-spaces.

Documentation

- Describe fetching existing export status
([`9c5b8d5`](https://github.com/python-gitlab/python-gitlab/commit/9c5b8d54745a58b9fe72ba535b7868d1510379c0))

- Describe ROPC flow in place of password authentication
([`91c17b7`](https://github.com/python-gitlab/python-gitlab/commit/91c17b704f51e9a06b241d549f9a07a19c286118))

- Document CI Lint usage
([`d5de4b1`](https://github.com/python-gitlab/python-gitlab/commit/d5de4b1fe38bedc07862bd9446dfd48b92cb078d))

- Update return type of pushrules
([`53cbecc`](https://github.com/python-gitlab/python-gitlab/commit/53cbeccd581318ce4ff6bec0acf3caf935bda0cf))

Update the return type of pushrules to surround None with back-ticks to make it code-formatted.

- **authors**: Add John
([`e2afb84`](https://github.com/python-gitlab/python-gitlab/commit/e2afb84dc4a259e8f40b7cc83e56289983c7db47))

- **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))

- **readme**: Remove redundant `-v` that breaks the command
([`c523e18`](https://github.com/python-gitlab/python-gitlab/commit/c523e186cc48f6bcac5245e3109b50a3852d16ef))

- **users**: Add docs about listing a user's projects
([`065a1a5`](https://github.com/python-gitlab/python-gitlab/commit/065a1a5a32d34286df44800084285b30b934f911))

Add docs about listing a user's projects.

Update docs on the membership API to update the URL to the upstream docs and also add a note that it
requires Administrator access to use.

Features

- Add 'merge_pipelines_enabled' project attribute
([`fc33c93`](https://github.com/python-gitlab/python-gitlab/commit/fc33c934d54fb94451bd9b9ad65645c9c3d6fe2e))

Boolean. Enable or disable merge pipelines.

See: https://docs.gitlab.com/ee/api/projects.html#edit-project
https://docs.gitlab.com/ee/ci/pipelines/merged_results_pipelines.html

- Add `asdict()` and `to_json()` methods to Gitlab Objects
([`08ac071`](https://github.com/python-gitlab/python-gitlab/commit/08ac071abcbc28af04c0fa655576e25edbdaa4e2))

Add an `asdict()` method that returns a dictionary representation copy of the Gitlab Object. This is
a copy and changes made to it will have no impact on the Gitlab Object.

The `asdict()` method name was chosen as both the `dataclasses` and `attrs` libraries have an
`asdict()` function which has the similar purpose of creating a dictionary represenation of an
object.

Also add a `to_json()` method that returns a JSON string representation of the object.

Closes: 1116

- Add support for filtering jobs by scope
([`0e1c0dd`](https://github.com/python-gitlab/python-gitlab/commit/0e1c0dd795886ae4741136e64c33850b164084a1))

See: 'scope' here:

https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs

- Add support for group and project invitations API
([`7afd340`](https://github.com/python-gitlab/python-gitlab/commit/7afd34027a26b5238a979e3303d8e5d8a0320a07))

- Add support for group push rules
([`b5cdc09`](https://github.com/python-gitlab/python-gitlab/commit/b5cdc097005c8a48a16e793a69c343198b14e035))

Add the GroupPushRules and GroupPushRulesManager classes.

Closes: 1259

- Add support for iterations API
([`194ee01`](https://github.com/python-gitlab/python-gitlab/commit/194ee0100c2868c1a9afb161c15f3145efb01c7c))

- Allow sort/ordering for project releases
([`b1dd284`](https://github.com/python-gitlab/python-gitlab/commit/b1dd284066b4b94482b9d41310ac48b75bcddfee))

See: https://docs.gitlab.com/ee/api/releases/#list-releases

- Support validating CI lint results
([`3b1ede4`](https://github.com/python-gitlab/python-gitlab/commit/3b1ede4a27cd730982d4c579437c5c689a8799e5))

- **api**: Add support for `get` for a MR approval rule
([`89c18c6`](https://github.com/python-gitlab/python-gitlab/commit/89c18c6255ec912db319f73f141b47ace87a713b))

In GitLab 14.10 they added support to get a single merge request approval rule [1]

Add support for it to ProjectMergeRequestApprovalRuleManager

[1]
https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-a-single-merge-request-level-rule

- **api**: Add support for instance-level registry repositories
([`284d739`](https://github.com/python-gitlab/python-gitlab/commit/284d73950ad5cf5dfbdec2f91152ed13931bd0ee))

- **cli**: Add a custom help formatter
([`005ba93`](https://github.com/python-gitlab/python-gitlab/commit/005ba93074d391f818c39e46390723a0d0d16098))

Add a custom argparse help formatter that overrides the output format to list items vertically.

The formatter is derived from argparse.HelpFormatter with minimal changes.

Co-authored-by: John Villalovos <johnsodarock.com>

Co-authored-by: Nejc Habjan <nejc.habjansiemens.com>

- **cli**: Add support for global CI lint
([`3f67c4b`](https://github.com/python-gitlab/python-gitlab/commit/3f67c4b0fb0b9a39c8b93529a05b1541fcebcabe))

- **groups**: Add support for group-level registry repositories
([`70148c6`](https://github.com/python-gitlab/python-gitlab/commit/70148c62a3aba16dd8a9c29f15ed16e77c01a247))

- **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))

- **objects**: Add Project CI Lint support
([`b213dd3`](https://github.com/python-gitlab/python-gitlab/commit/b213dd379a4108ab32181b9d3700d2526d950916))

Add support for validating a project's CI configuration [1]

[1] https://docs.gitlab.com/ee/api/lint.html

- **projects**: Add support for project restore API
([`4794ecc`](https://github.com/python-gitlab/python-gitlab/commit/4794ecc45d7aa08785c622918d08bb046e7359ae))

Refactoring

- Migrate services to integrations
([`a428051`](https://github.com/python-gitlab/python-gitlab/commit/a4280514546cc6e39da91d1671921b74b56c3283))

- **objects**: Move ci lint to separate file
([`6491f1b`](https://github.com/python-gitlab/python-gitlab/commit/6491f1bbb68ffe04c719eb9d326b7ca3e78eba84))

- **test-projects**: Apply suggestions and use fixtures
([`a51f848`](https://github.com/python-gitlab/python-gitlab/commit/a51f848db4204b2f37ae96fd235ae33cb7c2fe98))

- **test-projects**: Remove test_restore_project
([`9be0875`](https://github.com/python-gitlab/python-gitlab/commit/9be0875c3793324b4c4dde29519ee62b39a8cc18))

Testing

- Add more tests for container registries
([`f6b6e18`](https://github.com/python-gitlab/python-gitlab/commit/f6b6e18f96f4cdf67c8c53ae79e6a8259dcce9ee))

- Add test to show issue fixed
([`75bec7d`](https://github.com/python-gitlab/python-gitlab/commit/75bec7d543dd740c50452b21b0b4509377cd40ce))

https://github.com/python-gitlab/python-gitlab/issues/1698 has been fixed. Add test to show that.

- Allow `podman` users to run functional tests
([`ff215b7`](https://github.com/python-gitlab/python-gitlab/commit/ff215b7056ce2adf2b85ecc1a6c3227d2b1a5277))

Users of `podman` will likely have `DOCKER_HOST` set to something like
`unix:///run/user/1000/podman/podman.sock`

Pass this environment variable so that it will be used during the functional tests.

- Always ensure clean config environment
([`8d4f13b`](https://github.com/python-gitlab/python-gitlab/commit/8d4f13b192afd5d4610eeaf2bbea71c3b6a25964))

- Fix broken test if user had config files
([`864fc12`](https://github.com/python-gitlab/python-gitlab/commit/864fc1218e6366b9c1d8b1b3832e06049c238d8c))

Use `monkeypatch` to ensure that no config files are reported for the test.

Closes: 2172

- **api_func_v4**: Catch deprecation warning for `gl.lint()`
([`95fe924`](https://github.com/python-gitlab/python-gitlab/commit/95fe9247fcc9cba65c4afef934f816be06027ff5))

Catch the deprecation warning for the call to `gl.lint()`, so it won't show up in the log.

- **cli**: Add tests for token scopes
([`263fe3d`](https://github.com/python-gitlab/python-gitlab/commit/263fe3d24836b34dccdcee0221bd417e0b74fb2e))

- **ee**: Add an EE specific test
([`10987b3`](https://github.com/python-gitlab/python-gitlab/commit/10987b3089d4fe218dd2116dd871e0a070db3f7f))

- **functional**: Replace len() calls with list membership checks
([`97e0eb9`](https://github.com/python-gitlab/python-gitlab/commit/97e0eb9267202052ed14882258dceca0f6c4afd7))

- **functional**: Simplify token creation
([`67ab24f`](https://github.com/python-gitlab/python-gitlab/commit/67ab24fe5ae10a9f8cc9122b1a08848e8927635d))

- **functional**: Use both get_all and all in list() tests
([`201298d`](https://github.com/python-gitlab/python-gitlab/commit/201298d7b5795b7d7338793da8033dc6c71d6572))

- **projects**: Add unit tests for projects
([`67942f0`](https://github.com/python-gitlab/python-gitlab/commit/67942f0d46b7d445f28f80d3f57aa91eeea97a24))

Bug Fixes

- **base**: Do not fail repr() on lazy objects
([`1efb123`](https://github.com/python-gitlab/python-gitlab/commit/1efb123f63eab57600228b75a1744f8787c16671))

- **cli**: Fix project export download for CLI
([`5d14867`](https://github.com/python-gitlab/python-gitlab/commit/5d1486785793b02038ac6f527219801744ee888b))

Since ac1c619cae6481833f5df91862624bf0380fef67 we delete parent arg keys from the args dict so this
has been trying to access the wrong attribute.

- **cli**: Project-merge-request-approval-rule
([`15a242c`](https://github.com/python-gitlab/python-gitlab/commit/15a242c3303759b77b380c5b3ff9d1e0bf2d800c))

Using the CLI the command: gitlab project-merge-request-approval-rule list --mr-iid 1 --project-id
foo/bar

Would raise an exception. This was due to the fact that `_id_attr` and `_repr_attr` were set for
keys which are not returned in the response.

Add a unit test which shows the `repr` function now works. Before it did not.

This is an EE feature so we can't functional test it.

Closes: 2065

Chores

- Add link to Commitizen in Github workflow
([`d08d07d`](https://github.com/python-gitlab/python-gitlab/commit/d08d07deefae345397fc30280c4f790c7e61cbe2))

Add a link to the Commitizen website in the Github workflow. Hopefully this will help people when
their job fails.

- Bump mypy pre-commit hook
([`0bbcad7`](https://github.com/python-gitlab/python-gitlab/commit/0bbcad7612f60f7c7b816c06a244ad8db9da68d9))

- Correct ModuleNotFoundError() arguments
([`0b7933c`](https://github.com/python-gitlab/python-gitlab/commit/0b7933c5632c2f81c89f9a97e814badf65d1eb38))

Previously in commit 233b79ed442aac66faf9eb4b0087ea126d6dffc5 I had used the `name` argument for
`ModuleNotFoundError()`. This basically is the equivalent of not passing any message to
`ModuleNotFoundError()`. So when the exception was raised it wasn't very helpful.

Correct that and add a unit-test that shows we get the message we expect.

- Enable 'consider-using-sys-exit' pylint check
([`0afcc3e`](https://github.com/python-gitlab/python-gitlab/commit/0afcc3eca4798801ff3635b05b871e025078ef31))

Enable the 'consider-using-sys-exit' pylint check and fix errors raised.

- Enable pylint check "raise-missing-from"
([`1a2781e`](https://github.com/python-gitlab/python-gitlab/commit/1a2781e477471626e2b00129bef5169be9c7cc06))

Enable the pylint check "raise-missing-from" and fix errors detected.

- Enable pylint check: "attribute-defined-outside-init"
([`d6870a9`](https://github.com/python-gitlab/python-gitlab/commit/d6870a981259ee44c64210a756b63dc19a6f3957))

Enable the pylint check: "attribute-defined-outside-init" and fix errors detected.

- Enable pylint check: "no-else-return"
([`d0b0811`](https://github.com/python-gitlab/python-gitlab/commit/d0b0811211f69f08436dcf7617c46617fe5c0b8b))

Enable the pylint check "no-else-return" and fix the errors detected.

- Enable pylint check: "no-self-use"
([`80aadaf`](https://github.com/python-gitlab/python-gitlab/commit/80aadaf4262016a8181b5150ca7e17c8139c15fa))

Enable the pylint check "no-self-use" and fix the errors detected.

- Enable pylint check: "redefined-outer-name",
([`1324ce1`](https://github.com/python-gitlab/python-gitlab/commit/1324ce1a439befb4620953a4df1f70b74bf70cbd))

Enable the pylint check "redefined-outer-name" and fix the errors detected.

- Enable pylint checks
([`1e89164`](https://github.com/python-gitlab/python-gitlab/commit/1e8916438f7c4f67bd7745103b870d84f6ba2d01))

Enable the pylint checks: * unnecessary-pass * unspecified-encoding

Update code to resolve errors found

- Enable pylint checks which require no changes
([`50fdbc4`](https://github.com/python-gitlab/python-gitlab/commit/50fdbc474c524188952e0ef7c02b0bd92df82357))

Enabled the pylint checks that don't require any code changes. Previously these checks were
disabled.

- Fix issue found with pylint==2.14.3
([`eeab035`](https://github.com/python-gitlab/python-gitlab/commit/eeab035ab715e088af73ada00e0a3b0c03527187))

A new error was reported when running pylint==2.14.3: gitlab/client.py:488:0: W1404: Implicit string
concatenation found in call (implicit-str-concat)

Fixed this issue.

- Have `EncodedId` creation always return `EncodedId`
([`a1a246f`](https://github.com/python-gitlab/python-gitlab/commit/a1a246fbfcf530732249a263ee42757a862181aa))

There is no reason to return an `int` as we can always return a `str` version of the `int`

Change `EncodedId` to always return an `EncodedId`. This removes the need to have `mypy` ignore the
error raised.

- Move `RequiredOptional` to the `gitlab.types` module
([`7d26530`](https://github.com/python-gitlab/python-gitlab/commit/7d26530640eb406479f1604cb64748d278081864))

By having `RequiredOptional` in the `gitlab.base` module it makes it difficult with circular
imports. Move it to the `gitlab.types` module which has no dependencies on any other gitlab
module.

- Move `utils._validate_attrs` inside `types.RequiredOptional`
([`9d629bb`](https://github.com/python-gitlab/python-gitlab/commit/9d629bb97af1e14ce8eb4679092de2393e1e3a05))

Move the `validate_attrs` function to be inside the `RequiredOptional` class. It makes sense for it
to be part of the class as it is working on data related to the class.

- Patch sphinx for explicit re-exports
([`06871ee`](https://github.com/python-gitlab/python-gitlab/commit/06871ee05b79621f0a6fea47243783df105f64d6))

- Remove use of '%' string formatter in `gitlab/utils.py`
([`0c5a121`](https://github.com/python-gitlab/python-gitlab/commit/0c5a1213ba3bb3ec4ed5874db4588d21969e9e80))

Replace usage with f-string

- Rename `__call__()` to `run()` in GitlabCLI
([`6189437`](https://github.com/python-gitlab/python-gitlab/commit/6189437d2c8d18f6c7d72aa7743abd6d36fb4efa))

Less confusing to have it be a normal method.

- Rename `whaction` and `action` to `resource_action` in CLI
([`fb3f28a`](https://github.com/python-gitlab/python-gitlab/commit/fb3f28a053f0dcf0a110bb8b6fd11696b4ba3dd9))

Rename the variables `whaction` and `action` to `resource_action` to improve code-readability.

- Rename `what` to `gitlab_resource`
([`c86e471`](https://github.com/python-gitlab/python-gitlab/commit/c86e471dead930468172f4b7439ea6fa207f12e8))

Naming a variable `what` makes it difficult to understand what it is used for.

Rename it to `gitlab_resource` as that is what is being stored.

The Gitlab documentation talks about them being resources:
https://docs.gitlab.com/ee/api/api_resources.html

This will improve code readability.

- Require f-strings
([`96e994d`](https://github.com/python-gitlab/python-gitlab/commit/96e994d9c5c1abd11b059fe9f0eec7dac53d2f3a))

We previously converted all string formatting to use f-strings. Enable pylint check to enforce this.

- Update type-hints return signature for GetWithoutIdMixin methods
([`aa972d4`](https://github.com/python-gitlab/python-gitlab/commit/aa972d49c57f2ebc983d2de1cfb8d18924af6734))

Commit f0152dc3cc9a42aa4dc3c0014b4c29381e9b39d6 removed situation where `get()` in a
`GetWithoutIdMixin` based class could return `None`

Update the type-hints to no longer return `Optional` AKA `None`

- Use multiple processors when running PyLint
([`7f2240f`](https://github.com/python-gitlab/python-gitlab/commit/7f2240f1b9231e8b856706952ec84234177a495b))

Use multiple processors when running PyLint. On my system it took about 10.3 seconds to run PyLint
before this change. After this change it takes about 5.8 seconds to run PyLint.

- **ci**: Increase timeout for docker container to come online
([`bda020b`](https://github.com/python-gitlab/python-gitlab/commit/bda020bf5f86d20253f39698c3bb32f8d156de60))

Have been seeing timeout issues more and more. Increase timeout from 200 seconds to 300 seconds (5
minutes).

- **ci**: Pin 3.11 to beta.1
([`7119f2d`](https://github.com/python-gitlab/python-gitlab/commit/7119f2d228115fe83ab23612e189c9986bb9fd1b))

- **cli**: Ignore coverage on exceptions triggering cli.die
([`98ccc3c`](https://github.com/python-gitlab/python-gitlab/commit/98ccc3c2622a3cdb24797fd8790e921f5f2c1e6a))

- **cli**: Rename "object" to "GitLab resource"
([`62e64a6`](https://github.com/python-gitlab/python-gitlab/commit/62e64a66dab4b3704d80d19a5dbc68b025b18e3c))

Make the parser name more user friendly by renaming from generic "object" to "GitLab resource"

- **deps**: Ignore python-semantic-release updates
([`f185b17`](https://github.com/python-gitlab/python-gitlab/commit/f185b17ff5aabedd32d3facd2a46ebf9069c9692))

- **deps**: Update actions/setup-python action to v4
([`77c1f03`](https://github.com/python-gitlab/python-gitlab/commit/77c1f0352adc8488041318e5dfd2fa98a5b5af62))

- **deps**: Update dependency commitizen to v2.27.1
([`456f9f1`](https://github.com/python-gitlab/python-gitlab/commit/456f9f14453f2090fdaf88734fe51112bf4e7fde))

- **deps**: Update dependency mypy to v0.960
([`8c016c7`](https://github.com/python-gitlab/python-gitlab/commit/8c016c7a53c543d07d16153039053bb370a6945b))

- **deps**: Update dependency mypy to v0.961
([`f117b2f`](https://github.com/python-gitlab/python-gitlab/commit/f117b2f92226a507a8adbb42023143dac0cc07fc))

- **deps**: Update dependency pylint to v2.14.3
([`9a16bb1`](https://github.com/python-gitlab/python-gitlab/commit/9a16bb158f3cb34a4c4cb7451127fbc7c96642e2))

- **deps**: Update dependency requests to v2.28.0
([`d361f4b`](https://github.com/python-gitlab/python-gitlab/commit/d361f4bd4ec066452a75cf04f64334234478bb02))

- **deps**: Update pre-commit hook commitizen-tools/commitizen to v2.27.1
([`22c5db4`](https://github.com/python-gitlab/python-gitlab/commit/22c5db4bcccf592f5cf7ea34c336208c21769896))

- **deps**: Update pre-commit hook pycqa/pylint to v2.14.3
([`d1fe838`](https://github.com/python-gitlab/python-gitlab/commit/d1fe838b65ccd1a68fb6301bbfd06cd19425a75c))

- **deps**: Update typing dependencies
([`acc5c39`](https://github.com/python-gitlab/python-gitlab/commit/acc5c3971f13029288dff2909692a0171f4a66f7))

- **deps**: Update typing dependencies
([`aebf9c8`](https://github.com/python-gitlab/python-gitlab/commit/aebf9c83a4cbf7cf4243cb9b44375ca31f9cc878))

- **deps**: Update typing dependencies
([`f3f79c1`](https://github.com/python-gitlab/python-gitlab/commit/f3f79c1d3afa923405b83dcea905fec213201452))

- **docs**: Ignore nitpicky warnings
([`1c3efb5`](https://github.com/python-gitlab/python-gitlab/commit/1c3efb50bb720a87b95307f4d6642e3b7f28f6f0))

- **gitlab**: Fix implicit re-exports for mpypy
([`981b844`](https://github.com/python-gitlab/python-gitlab/commit/981b8448dbadc63d70867dc069e33d4c4d1cfe95))

- **mixins**: Remove None check as http_get always returns value
([`f0152dc`](https://github.com/python-gitlab/python-gitlab/commit/f0152dc3cc9a42aa4dc3c0014b4c29381e9b39d6))

- **workflows**: Explicitly use python-version
([`eb14475`](https://github.com/python-gitlab/python-gitlab/commit/eb1447588dfbbdfe724fca9009ea5451061b5ff0))

Documentation

- Documentation updates to reflect addition of mutually exclusive attributes
([`24b720e`](https://github.com/python-gitlab/python-gitlab/commit/24b720e49636044f4be7e4d6e6ce3da341f2aeb8))

- Drop deprecated setuptools build_sphinx
([`048d66a`](https://github.com/python-gitlab/python-gitlab/commit/048d66af51cef385b22d223ed2a5cd30e2256417))

- Use `as_list=False` or `all=True` in Getting started
([`de8c6e8`](https://github.com/python-gitlab/python-gitlab/commit/de8c6e80af218d93ca167f8b5ff30319a2781d91))

In the "Getting started with the API" section of the documentation, use either `as_list=False` or
`all=True` in the example usages of the `list()` method.

Also add a warning about the fact that `list()` by default does not return all items.

- **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))

- **api**: Fix incorrect docs for merge_request_approvals
([2094](https://github.com/python-gitlab/python-gitlab/pull/2094),
[`5583eaa`](https://github.com/python-gitlab/python-gitlab/commit/5583eaa108949386c66290fecef4d064f44b9e83))

* docs(api): fix incorrect docs for merge_request_approvals

The `set_approvers()` method is on the `ProjectApprovalManager` class. It is not part of the
`ProjectApproval` class.

The docs were previously showing to call `set_approvers` using a `ProjectApproval` instance, which
would fail. Correct the documentation.

This was pointed out by a question on the Gitter channel.

Co-authored-by: Nejc Habjan <nejc.habjansiemens.com>

- **api**: Stop linking to python-requests.org
([`49c7e83`](https://github.com/python-gitlab/python-gitlab/commit/49c7e83f768ee7a3fec19085a0fa0a67eadb12df))

- **api-usage**: Add import os in example
([`2194a44`](https://github.com/python-gitlab/python-gitlab/commit/2194a44be541e9d2c15d3118ba584a4a173927a2))

- **ext**: Fix rendering for RequiredOptional dataclass
([`4d431e5`](https://github.com/python-gitlab/python-gitlab/commit/4d431e5a6426d0fd60945c2d1ff00a00a0a95b6c))

- **projects**: Document 404 gotcha with unactivated integrations
([`522ecff`](https://github.com/python-gitlab/python-gitlab/commit/522ecffdb6f07e6c017139df4eb5d3fc42a585b7))

- **projects**: Provide more detailed import examples
([`8f8611a`](https://github.com/python-gitlab/python-gitlab/commit/8f8611a1263b8c19fd19ce4a904a310b0173b6bf))

- **usage**: Refer to upsteam docs instead of custom attributes
([`ae7d3b0`](https://github.com/python-gitlab/python-gitlab/commit/ae7d3b09352b2a1bd287f95d4587b04136c7a4ed))

- **variables**: Instruct users to follow GitLab rules for values
([`194b6be`](https://github.com/python-gitlab/python-gitlab/commit/194b6be7ccec019fefc04754f98b9ec920c29568))

Features

- Add support for Protected Environments
([`1dc9d0f`](https://github.com/python-gitlab/python-gitlab/commit/1dc9d0f91757eed9f28f0c7172654b9b2a730216))

- https://docs.gitlab.com/ee/api/protected_environments.html -
https://github.com/python-gitlab/python-gitlab/issues/1130

no write operation are implemented yet as I have no use case right now and am not sure how it should
be done

- Support mutually exclusive attributes and consolidate validation to fix board lists
([2037](https://github.com/python-gitlab/python-gitlab/pull/2037),
[`3fa330c`](https://github.com/python-gitlab/python-gitlab/commit/3fa330cc341bbedb163ba757c7f6578d735c6efb))

add exclusive tuple to RequiredOptional data class to support for mutually exclusive attributes

consolidate _check_missing_create_attrs and _check_missing_update_attrs from mixins.py into
_validate_attrs in utils.py

change _create_attrs in board list manager classes from required=('label_ld',) to
exclusive=('label_id','asignee_id','milestone_id')

closes https://github.com/python-gitlab/python-gitlab/issues/1897

- **api**: Convert gitlab.const to Enums
([`c3c6086`](https://github.com/python-gitlab/python-gitlab/commit/c3c6086c548c03090ccf3f59410ca3e6b7999791))

This allows accessing the elements by value, i.e.:

import gitlab.const gitlab.const.AccessLevel(20)

- **api**: Implement HEAD method
([`90635a7`](https://github.com/python-gitlab/python-gitlab/commit/90635a7db3c9748745471d2282260418e31c7797))

- **api**: Support head() method for get and list endpoints
([`ce9216c`](https://github.com/python-gitlab/python-gitlab/commit/ce9216ccc542d834be7f29647c7ee98c2ca5bb01))

- **client**: Introduce `iterator=True` and deprecate `as_list=False` in `list()`
([`cdc6605`](https://github.com/python-gitlab/python-gitlab/commit/cdc6605767316ea59e1e1b849683be7b3b99e0ae))

`as_list=False` is confusing as it doesn't explain what is being returned. Replace it with
`iterator=True` which more clearly explains to the user that an iterator/generator will be
returned.

This maintains backward compatibility with `as_list` but does issue a DeprecationWarning if
`as_list` is set.

- **docker**: Provide a Debian-based slim image
([`384031c`](https://github.com/python-gitlab/python-gitlab/commit/384031c530e813f55da52f2b2c5635ea935f9d91))

- **downloads**: Allow streaming downloads access to response iterator
([1956](https://github.com/python-gitlab/python-gitlab/pull/1956),
[`b644721`](https://github.com/python-gitlab/python-gitlab/commit/b6447211754e126f64e12fc735ad74fe557b7fb4))

* feat(downloads): allow streaming downloads access to response iterator

Allow access to the underlying response iterator when downloading in streaming mode by specifying
`iterator=True`.

Update type annotations to support this change.

* docs(api-docs): add iterator example to artifact download

Document the usage of the `iterator=True` option when downloading artifacts

* test(packages): add tests for streaming downloads

- **users**: Add approve and reject methods to User
([`f57139d`](https://github.com/python-gitlab/python-gitlab/commit/f57139d8f1dafa6eb19d0d954b3634c19de6413c))

As requested in 1604.

Co-authored-by: John Villalovos <johnsodarock.com>

- **users**: Add ban and unban methods
([`0d44b11`](https://github.com/python-gitlab/python-gitlab/commit/0d44b118f85f92e7beb1a05a12bdc6e070dce367))

Refactoring

- Avoid possible breaking change in iterator
([2107](https://github.com/python-gitlab/python-gitlab/pull/2107),
[`212ddfc`](https://github.com/python-gitlab/python-gitlab/commit/212ddfc9e9c5de50d2507cc637c01ceb31aaba41))

Commit b6447211754e126f64e12fc735ad74fe557b7fb4 inadvertently introduced a possible breaking change
as it added a new argument `iterator` and added it in between existing (potentially positional)
arguments.

This moves the `iterator` argument to the end of the argument list and requires it to be a
keyword-only argument.

- Do not recommend plain gitlab.const constants
([`d652133`](https://github.com/python-gitlab/python-gitlab/commit/d65213385a6f497c2595d3af3a41756919b9c9a1))

- Remove no-op id argument in GetWithoutIdMixin
([`0f2a602`](https://github.com/python-gitlab/python-gitlab/commit/0f2a602d3a9d6579f5fdfdf945a236ae44e93a12))

- **mixins**: Extract custom type transforms into utils
([`09b3b22`](https://github.com/python-gitlab/python-gitlab/commit/09b3b2225361722f2439952d2dbee6a48a9f9fd9))

Testing

- Add more tests for RequiredOptional
([`ce40fde`](https://github.com/python-gitlab/python-gitlab/commit/ce40fde9eeaabb4a30c5a87d9097b1d4eced1c1b))

- Add tests and clean up usage for new enums
([`323ab3c`](https://github.com/python-gitlab/python-gitlab/commit/323ab3c5489b0d35f268bc6c22ade782cade6ba4))

- Increase client coverage
([`00aec96`](https://github.com/python-gitlab/python-gitlab/commit/00aec96ed0b60720362c6642b416567ff39aef09))

- Move back to using latest Python 3.11 version
([`8c34781`](https://github.com/python-gitlab/python-gitlab/commit/8c347813e7aaf26a33fe5ae4ae73448beebfbc6c))

- **api**: Add tests for HEAD method
([`b0f02fa`](https://github.com/python-gitlab/python-gitlab/commit/b0f02facef2ea30f24dbfb3c52974f34823e9bba))

- **cli**: Improve coverage for custom actions
([`7327f78`](https://github.com/python-gitlab/python-gitlab/commit/7327f78073caa2fb8aaa6bf0e57b38dd7782fa57))

- **gitlab**: Increase unit test coverage
([`df072e1`](https://github.com/python-gitlab/python-gitlab/commit/df072e130aa145a368bbdd10be98208a25100f89))

- **pylint**: Enable pylint "unused-argument" check
([`23feae9`](https://github.com/python-gitlab/python-gitlab/commit/23feae9b0906d34043a784a01d31d1ff19ebc9a4))

Enable the pylint "unused-argument" check and resolve issues it found.

* Quite a few functions were accepting `**kwargs` but not then passing them on through to the next
level. Now pass `**kwargs` to next level. * Other functions had no reason to accept `**kwargs`, so
remove it * And a few other fixes.

- Enforce python version requirements
([`70176db`](https://github.com/python-gitlab/python-gitlab/commit/70176dbbb96a56ee7891885553eb13110197494c))

Documentation

- Fix snippet get in project
([`3a4ff2f`](https://github.com/python-gitlab/python-gitlab/commit/3a4ff2fbf51d5f7851db02de6d8f0e84508b11a0))

- **projects**: Add raw file download docs
([`939e9d3`](https://github.com/python-gitlab/python-gitlab/commit/939e9d32e6e249e2a642d2bf3c1a34fde288c842))

Fixes 969

Features

- Add appearance API
([`4c4ac5c`](https://github.com/python-gitlab/python-gitlab/commit/4c4ac5ca1e5cabc4ea4b12734a7b091bc4c224b5))

- Add autocompletion support
([`973cb8b`](https://github.com/python-gitlab/python-gitlab/commit/973cb8b962e13280bcc8473905227cf351661bf0))

- Add global order_by option to ease pagination
([`d187925`](https://github.com/python-gitlab/python-gitlab/commit/d1879253dae93e182710fe22b0a6452296e2b532))

- Support keyset pagination globally
([`0b71ba4`](https://github.com/python-gitlab/python-gitlab/commit/0b71ba4d2965658389b705c1bb0d83d1ff2ee8f2))

Refactoring

- Remove six dependency
([`9fb4645`](https://github.com/python-gitlab/python-gitlab/commit/9fb46454c6dab1a86ab4492df2368ed74badf7d6))

- Support new list filters
([`bded2de`](https://github.com/python-gitlab/python-gitlab/commit/bded2de51951902444bc62aa016a3ad34aab799e))

This is most likely only useful for the CLI

Testing

- Add project snippet tests
([`0952c55`](https://github.com/python-gitlab/python-gitlab/commit/0952c55a316fc8f68854badd68b4fc57658af9e7))

- Adjust functional tests for project snippets
([`ac0ea91`](https://github.com/python-gitlab/python-gitlab/commit/ac0ea91f22b08590f85a2b0ffc17cd41ae6e0ff7))

Bug Fixes

- Duplicate subparsers being added to argparse
([`f553fd3`](https://github.com/python-gitlab/python-gitlab/commit/f553fd3c79579ab596230edea5899dc5189b0ac6))

Python 3.11 added an additional check in the argparse libary which detected duplicate subparsers
being added. We had duplicate subparsers being added.

Make sure we don't add duplicate subparsers.

Closes: 2015

- **cli**: Changed default `allow_abbrev` value to fix arguments collision problem
([2013](https://github.com/python-gitlab/python-gitlab/pull/2013),
[`d68cacf`](https://github.com/python-gitlab/python-gitlab/commit/d68cacfeda5599c62a593ecb9da2505c22326644))

fix(cli): change default `allow_abbrev` value to fix argument collision

Chores

- Add `cz` to default tox environment list and skip_missing_interpreters
([`ba8c052`](https://github.com/python-gitlab/python-gitlab/commit/ba8c0522dc8a116e7a22c42e21190aa205d48253))

Add the `cz` (`comittizen`) check by default.

Set skip_missing_interpreters = True so that when a user runs tox and doesn't have a specific
version of Python it doesn't mark it as an error.

- Exclude `build/` directory from mypy check
([`989a12b`](https://github.com/python-gitlab/python-gitlab/commit/989a12b79ac7dff8bf0d689f36ccac9e3494af01))

The `build/` directory is created by the tox environment `twine-check`. When the `build/` directory
exists `mypy` will have an error.

- Rename the test which runs `flake8` to be `flake8`
([`78b4f99`](https://github.com/python-gitlab/python-gitlab/commit/78b4f995afe99c530858b7b62d3eee620f3488f2))

Previously the test was called `pep8`. The test only runs `flake8` so call it `flake8` to be more
precise.

- Run the `pylint` check by default in tox
([`55ace1d`](https://github.com/python-gitlab/python-gitlab/commit/55ace1d67e75fae9d74b4a67129ff842de7e1377))

Since we require `pylint` to pass in the CI. Let's run it by default in tox.

- **ci**: Fix prefix for action version
([`1c02189`](https://github.com/python-gitlab/python-gitlab/commit/1c021892e94498dbb6b3fa824d6d8c697fb4db7f))

- **ci**: Pin semantic-release version
([`0ea61cc`](https://github.com/python-gitlab/python-gitlab/commit/0ea61ccecae334c88798f80b6451c58f2fbb77c6))

- **ci**: Replace commitlint with commitizen
([`b8d15fe`](https://github.com/python-gitlab/python-gitlab/commit/b8d15fed0740301617445e5628ab76b6f5b8baeb))

- **deps**: Update dependency pylint to v2.13.8
([`b235bb0`](https://github.com/python-gitlab/python-gitlab/commit/b235bb00f3c09be5bb092a5bb7298e7ca55f2366))

- **deps**: Update dependency pylint to v2.13.9
([`4224950`](https://github.com/python-gitlab/python-gitlab/commit/422495073492fd52f4f3b854955c620ada4c1daa))

- **deps**: Update dependency types-requests to v2.27.23
([`a6fed8b`](https://github.com/python-gitlab/python-gitlab/commit/a6fed8b4a0edbe66bf29cd7a43d51d2f5b8b3e3a))

- **deps**: Update dependency types-requests to v2.27.24
([`f88e3a6`](https://github.com/python-gitlab/python-gitlab/commit/f88e3a641ebb83818e11713eb575ebaa597440f0))

- **deps**: Update dependency types-requests to v2.27.25
([`d6ea47a`](https://github.com/python-gitlab/python-gitlab/commit/d6ea47a175c17108e5388213abd59c3e7e847b02))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.8
([`1835593`](https://github.com/python-gitlab/python-gitlab/commit/18355938d1b410ad5e17e0af4ef0667ddb709832))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.9
([`1e22790`](https://github.com/python-gitlab/python-gitlab/commit/1e2279028533c3dc15995443362e290a4d2c6ae0))

- **renovate**: Set schedule to reduce noise
([`882fe7a`](https://github.com/python-gitlab/python-gitlab/commit/882fe7a681ae1c5120db5be5e71b196ae555eb3e))

Documentation

- Add missing Admin access const value
([`3e0d4d9`](https://github.com/python-gitlab/python-gitlab/commit/3e0d4d9006e2ca6effae2b01cef3926dd0850e52))

As shown here, Admin access is set to 60:
https://docs.gitlab.com/ee/api/protected_branches.html#protected-branches-api

- 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))

- **merge_requests**: Add new possible merge request state and link to the upstream docs
([`e660fa8`](https://github.com/python-gitlab/python-gitlab/commit/e660fa8386ed7783da5c076bc0fef83e6a66f9a8))

The actual documentation do not mention the locked state for a merge request

Features

- Display human-readable attribute in `repr()` if present
([`6b47c26`](https://github.com/python-gitlab/python-gitlab/commit/6b47c26d053fe352d68eb22a1eaf4b9a3c1c93e7))

- **objects**: Support get project storage endpoint
([`8867ee5`](https://github.com/python-gitlab/python-gitlab/commit/8867ee59884ae81d6457ad6e561a0573017cf6b2))

- **ux**: Display project.name_with_namespace on project repr
([`e598762`](https://github.com/python-gitlab/python-gitlab/commit/e5987626ca1643521b16658555f088412be2a339))

This change the repr from:

$ gitlab.projects.get(id=some_id) <Project id:some_id>

To:

$ gitlab.projects.get(id=some_id) <Project id:some_id name_with_namespace:"group_name /
project_name">

This is especially useful when working on random projects or listing of projects since users
generally don't remember projects ids.

Testing

- **projects**: Add tests for list project methods
([`fa47829`](https://github.com/python-gitlab/python-gitlab/commit/fa47829056a71e6b9b7f2ce913f2aebc36dc69e9))

Bug Fixes

- Add 52x range to retry transient failures and tests
([`c3ef1b5`](https://github.com/python-gitlab/python-gitlab/commit/c3ef1b5c1eaf1348a18d753dbf7bda3c129e3262))

- Add ChunkedEncodingError to list of retryable exceptions
([`7beb20f`](https://github.com/python-gitlab/python-gitlab/commit/7beb20ff7b7b85fb92fc6b647d9c1bdb7568f27c))

- Also retry HTTP-based transient errors
([`3b49e4d`](https://github.com/python-gitlab/python-gitlab/commit/3b49e4d61e6f360f1c787aa048edf584aec55278))

- 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))

Chores

- **client**: Remove duplicate code
([`5cbbf26`](https://github.com/python-gitlab/python-gitlab/commit/5cbbf26e6f6f3ce4e59cba735050e3b7f9328388))

- **deps**: Update black to v22.3.0
([`8d48224`](https://github.com/python-gitlab/python-gitlab/commit/8d48224c89cf280e510fb5f691e8df3292577f64))

- **deps**: Update codecov/codecov-action action to v3
([`292e91b`](https://github.com/python-gitlab/python-gitlab/commit/292e91b3cbc468c4a40ed7865c3c98180c1fe864))

- **deps**: Update dependency mypy to v0.950
([`241e626`](https://github.com/python-gitlab/python-gitlab/commit/241e626c8e88bc1b6b3b2fc37e38ed29b6912b4e))

- **deps**: Update dependency pylint to v2.13.3
([`0ae3d20`](https://github.com/python-gitlab/python-gitlab/commit/0ae3d200563819439be67217a7fc0e1552f07c90))

- **deps**: Update dependency pylint to v2.13.4
([`a9a9392`](https://github.com/python-gitlab/python-gitlab/commit/a9a93921b795eee0db16e453733f7c582fa13bc9))

- **deps**: Update dependency pylint to v2.13.5
([`5709675`](https://github.com/python-gitlab/python-gitlab/commit/570967541ecd46bfb83461b9d2c95bb0830a84fa))

- **deps**: Update dependency pylint to v2.13.7
([`5fb2234`](https://github.com/python-gitlab/python-gitlab/commit/5fb2234dddf73851b5de7af5d61b92de022a892a))

- **deps**: Update dependency pytest to v7.1.2
([`fd3fa23`](https://github.com/python-gitlab/python-gitlab/commit/fd3fa23bd4f7e0d66b541780f94e15635851e0db))

- **deps**: Update dependency types-requests to v2.27.16
([`ad799fc`](https://github.com/python-gitlab/python-gitlab/commit/ad799fca51a6b2679e2bcca8243a139e0bd0acf5))

- **deps**: Update dependency types-requests to v2.27.21
([`0fb0955`](https://github.com/python-gitlab/python-gitlab/commit/0fb0955b93ee1c464b3a5021bc22248103742f1d))

- **deps**: Update dependency types-requests to v2.27.22
([`22263e2`](https://github.com/python-gitlab/python-gitlab/commit/22263e24f964e56ec76d8cb5243f1cad1d139574))

- **deps**: Update dependency types-setuptools to v57.4.12
([`6551353`](https://github.com/python-gitlab/python-gitlab/commit/65513538ce60efdde80e5e0667b15739e6d90ac1))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.3
([`8f0a3af`](https://github.com/python-gitlab/python-gitlab/commit/8f0a3af46a1f49e6ddba31ee964bbe08c54865e0))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.4
([`9d0b252`](https://github.com/python-gitlab/python-gitlab/commit/9d0b25239773f98becea3b5b512d50f89631afb5))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.5
([`17d5c6c`](https://github.com/python-gitlab/python-gitlab/commit/17d5c6c3ba26f8b791ec4571726c533f5bbbde7d))

- **deps**: Update pre-commit hook pycqa/pylint to v2.13.7
([`1396221`](https://github.com/python-gitlab/python-gitlab/commit/1396221a96ea2f447b0697f589a50a9c22504c00))

- **deps**: Update typing dependencies
([`c12466a`](https://github.com/python-gitlab/python-gitlab/commit/c12466a0e7ceebd3fb9f161a472bbbb38e9bd808))

- **deps**: Update typing dependencies
([`d27cc6a`](https://github.com/python-gitlab/python-gitlab/commit/d27cc6a1219143f78aad7e063672c7442e15672e))

- **deps**: Upgrade gitlab-ce to 14.9.2-ce.0
([`d508b18`](https://github.com/python-gitlab/python-gitlab/commit/d508b1809ff3962993a2279b41b7d20e42d6e329))

Documentation

- **api-docs**: Docs fix for application scopes
([`e1ad93d`](https://github.com/python-gitlab/python-gitlab/commit/e1ad93df90e80643866611fe52bd5c59428e7a88))

Features

- Emit a warning when using a `list()` method returns max
([`1339d64`](https://github.com/python-gitlab/python-gitlab/commit/1339d645ce58a2e1198b898b9549ba5917b1ff12))

A common cause of issues filed and questions raised is that a user will call a `list()` method and
only get 20 items. As this is the default maximum of items that will be returned from a `list()`
method.

To help with this we now emit a warning when the result from a `list()` method is greater-than or
equal to 20 (or the specified `per_page` value) and the user is not using either `all=True`,
`all=False`, `as_list=False`, or `page=X`.

- **api**: Re-add topic delete endpoint
([`d1d96bd`](https://github.com/python-gitlab/python-gitlab/commit/d1d96bda5f1c6991c8ea61dca8f261e5b74b5ab6))

This reverts commit e3035a799a484f8d6c460f57e57d4b59217cd6de.

- **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))