@JohnVillalovos Regarding Current Mypy Type Checking Issues in python-gitlab Project

I'm currently facing two issues in the project that require some assistance, both related to mypy type checking. These issues might impact code robustness and future extensibility:

1. Incompatible Types in Assignment (gitlab/client.py:1426)
   When running tox for type checking, mypy reports an Incompatible types in assignment error on line 1426 of gitlab/client.py. Specifically, during the initialization of GraphQL(_BaseGraphQL).init and AsyncGraphQL.init, mypy indicates that the type of the assigned expression (gql.client.Client) is incompatible with the variable's expected type (httpx._client.Client | None).
   This discrepancy seems to stem from the type assignment self.client = client within GitlabTransport.init in python-gitlab/gitlab/_backends/graphql.py. While this type mismatch doesn't seem to affect runtime behavior, I believe it's a type hinting issue that likely requires adjustments to the relevant test code or type declarations, rather than a fundamental logic error.
2. Missing GraphQL Query Argument and Test Writing Challenges
   To enhance our GraphQL query capabilities, I've added a variable_values parameter to the execute method within the GraphQL class. The aim is to support passing GraphQL variables directly into queries, enabling resource retrieval with variable-based requests. However, mypy is flagging a Missing positional argument "variable_values" error on line 19 of tests/functional/api/test_graphql.py. This indicates that our existing test code is not correctly providing this newly added argument when calling the execute method.
   I'm not yet proficient in writing text (unit or integration) tests to validate the functionality of this variable_values parameter, nor am I sure how to ensure mypy passes its checks successfully for this change. I would appreciate your guidance or assistance in this area.

Although I've currently installed my modified package and it's working fine, I'm keen to contribute to this project. Therefore, I'd like to resolve the issues I mentioned above.

I look forward to your support and advice on these matters. Thank you.

class GraphQL(_BaseGraphQL):
    def __init__(
        self,
        url: str | None = None,
        *,
        private_token: str | None = None,
        oauth_token: str | None = None,
        job_token: str | None = None,
        ssl_verify: bool | str = True,
        client: httpx.Client | None = None,
        http_username: str | None = None,

        self._http_client = client or httpx.AsyncClient(**self._client_opts)
        self._transport = GitlabAsyncTransport(self._url, client=self._http_client)
        self._client = gql.Client(
            transport=self._transport,
            fetch_schema_from_transport=fetch_schema_from_transport,
        )
        self._gql = gql.gql

       #: 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

Error log:

tests/install/test_install.py:6: error: Unused "type: ignore" comment  [unused-ignore]
tests/functional/cli/test_cli_variables.py:4: error: Cannot find implementation or library stub for module named "responses"  [import-not-found]
tests/functional/cli/test_cli_projects.py:5: error: Cannot find implementation or library stub for module named "responses"  [import-not-found]
tests/functional/cli/conftest.py:2: error: Cannot find implementation or library stub for module named "responses"  [import-not-found]
gitlab/client.py:1426: error: Incompatible types in assignment (expression has type "gql.client.Client", variable has type "httpx._client.Client | None")  [assignment]
gitlab/client.py:1454: error: Item "Client" of "Client | None" has no attribute "execute"  [union-attr]
gitlab/client.py:1454: error: Item "None" of "Client | None" has no attribute "execute"  [union-attr]
gitlab/client.py:1499: error: Incompatible return value type (got "GraphQL", expected "Gitlab")  [return-value]
gitlab/client.py:1670: error: Incompatible types in assignment (expression has type "gql.client.Client", variable has type "httpx._client.Client | None")  [assignment]
gitlab/client.py:1698: error: Item "Client" of "Client | None" has no attribute "execute_async"  [union-attr]
gitlab/client.py:1698: error: Item "None" of "Client | None" has no attribute "execute_async"  [union-attr]
gitlab/client.py:1743: error: Incompatible return value type (got "AsyncGraphQL", expected "Gitlab")  [return-value]
gitlab/cli.py:352: error: Unused "type: ignore" comment  [unused-ignore]
gitlab/v4/cli.py:458: error: Library stubs not installed for "yaml"  [import-untyped]
gitlab/v4/cli.py:458: note: Hint: "python3 -m pip install types-PyYAML"
gitlab/v4/cli.py:458: note: (or run "mypy --install-types" to install all missing stub packages)
gitlab/v4/cli.py:458: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
tests/functional/cli/test_cli.py:10: error: Cannot find implementation or library stub for module named "responses"  [import-not-found]
tests/functional/cli/test_cli.py:11: error: Library stubs not installed for "yaml"  [import-untyped]
tests/functional/api/test_graphql.py:19: error: Missing positional argument "variable_values" in call to "execute" of "GraphQL"  [call-arg]
tests/functional/api/test_graphql.py:27: error: Missing positional argument "variable_values" in call to "execute" of "AsyncGraphQL"  [call-arg]
tests/functional/conftest.py:151: error: Name "pytest.Config" is not defined  [name-defined]
Found 19 errors in 10 files (checked 246 source files)

@timmy61109 thanks for this PR.

I'm not sure if some of or how much of this was made with the help of AI, but most of the changes do not apply to the GraphQL client. There is only a single way to authenticate against the API when using header auth, which we do (see https://docs.gitlab.com/api/graphql/#header-authentication). Likewise pagination and other things are not done the same way for GraphQL.

Could you maybe first elaborate on what you're trying to achieve and we can discuss this (possibly in an issue/discussion)?

I'm not sure if some of or how much of this was made with the help of AI, but most of the changes do not apply to the GraphQL client. There is only a single way to authenticate against the API when using header auth, which we do (see https://docs.gitlab.com/api/graphql/#header-authentication). Likewise pagination and other things are not done the same way for GraphQL.

Could you maybe first elaborate on what you're trying to achieve and we can discuss this (possibly in an issue/discussion)?

@nejch @JohnVillalovos 裡面只有 git commit 是 AI 協助幫我翻譯完成，因為我的英文不是很好。為了可以快速可以用，因此我只是將 GitLab API Class 裡面功能參考與複製到 GraphQL API Class 裡面，並盡可能修改到可以使用。

我主要希望有以下目標：

1. 可以使用 GraphQL ，因為 GitLab 有些新功能 RSET API 目前尚未製作好，很多都是需要從 GraphQL 取得
2. 可以直接透過 from_config 取得資料，其實這個是我目前開這個合併請求的主要原因，我可以直接從 gl.cfg 匯入金鑰，這樣我不會遺忘要將金鑰刪除
3. 由於現在 GraphQL 其實都是要自己寫指令，那這樣使用 Python 設計好取得資料的方式優勢就沒有，因此我希望未來可以有現成的 function 可以使用
4. 目前我製作的 function 是 timelogs ，我目前還在自我測試中，程式可能也沒有設計的很好，可以參考： https://gitlab.atcatw.org/atca/community-edition/workflow-automation-design/-/blob/9-csv-3/workflow_automation_design/expenses.py?ref_type=heads

Only the git commit part was translated with AI assistance because my English isn't very good. To make it usable quickly, I simply referenced and copied the functionality from the GitLab API Class into the GraphQL API Class and modified it as much as possible to make it usable.

My main goals are as follows:

1. To use GraphQL because some of GitLab's new features, such as the RSET API, are not yet available, and many require data to be retrieved from GraphQL.
2. Be able to retrieve data directly via from_config. This is actually the main reason I opened this merge request. I can directly import the key from gl.cfg, so I won't forget to delete the key.
3. Since GraphQL currently requires writing commands manually, the advantage of using Python to design a data retrieval method is lost. Therefore, I hope there will be pre-built functions available in the future.
4. The function I've created so far is timelogs. I'm still testing it myself, and the code might not be well-designed yet. You can check it out here: https://gitlab.atcatw.org/atca/community-edition/workflow-automation-design/-/blob/9-csv-3/workflow_automation_design/expenses.py?ref_type=heads

Translated with DeepL.com (free version)

Only git commit was translated by AI because my English is not very good. In order to make it usable quickly, I just copied the function references in GitLab API Class to GraphQL API Class and modified it as much as possible to make it usable.

I mainly hope to achieve the following goals:

1. Use GraphQL, because some new features of GitLab, RSET API, are not yet ready, and many of them need to be obtained from GraphQL
2. Data can be obtained directly through from_config. In fact, this is the main reason why I opened this merge request. I can import the key directly from gl.cfg, so I won’t forget to delete the key
3. Since GraphQL actually requires you to write your own instructions, there is no advantage in using Python to design a way to obtain data. Therefore, I hope that there will be ready-made functions available in the future
4. The function I have created is timelogs. I am still testing it myself, and the program may not be designed very well. You can refer to: https://gitlab.atcatw.org/atca/community-edition/workflow-automation-design/-/blob/9-csv-3/workflow_automation_design/expenses.py?ref_type=heads

Translated with Google Translate

@nejch @JohnVillalovos You've discovered a great improvement! Adding variable_values to the execute function significantly enhances its flexibility and reusability. This allows for dynamic input without altering the core logic.

gq.execute(  # type: ignore[attr-defined]
                query,
                variable_values=self.variable_values,
            )

Execution status:

query get_timeslogs(
        $group_fullpath: ID! = "atca",
        $projects_first: Int = 1,
        $projects_after: String = "eyJpZCI6IjQyMCJ9",
        $timelogs_first: Int = 100,
        $timelogs_after: String = ""
        ) {
    group(fullPath: $group_fullpath) {
        projects(
                first: $projects_first,
                after: $projects_after,
                includeSubgroups: true
                ) {
            count
            nodes {
                timelogs(first: $timelogs_first, after: $timelogs_after) {
                    totalSpentTime
                    nodes {
                        id
                        mergeRequest {

                            projectId
                            id
                            name
                            iid
                            webPath
                            webUrl
                            state

                            timeEstimate
                            totalTimeSpent
                            humanTimeEstimate
                            humanTotalTimeSpent

                            labels {
                                edges {
                                    node {
                                        title
                                    }
                                }
                            }
                            author {
                                username
                            }
                            assignees(after: "", first: 100) {
                                nodes {
                                    username
                                }
                            }

                            createdAt
                            closedAt
                            updatedAt
                            mergedAt
                            preparedAt

                            approved
                            draft
                            mergeStatusEnum
                            mergeOngoing
                            mergeableDiscussionsState

                            reviewers {
                                edges {
                                    node {
                                        username
                                    }
                                }
                            }
                            approvedBy {
                                edges {
                                    node {
                                        username
                                    }
                                }
                            }
                            mergeUser {
                                username
                            }
                        }
                        spentAt
                        summary
                        timeSpent
                        user {
                            username
                        }
                      
                    }
                    pageInfo {
                        endCursor
                      	startCursor
                        hasNextPage
                      	hasPreviousPage
                    }
                }
            }
            pageInfo {
                endCursor
                startCursor
                hasNextPage
                hasPreviousPage
            }
        }
    }
}

Execution Result:

{
  "data": {
    "group": {
      "projects": {
        "count": null,
        "nodes": [
          {
            "timelogs": {
              "totalSpentTime": null,
              "nodes": [
                {
                  "id": null,
                  "mergeRequest": null,
                  "spentAt": null,
                  "summary": null,
                  "timeSpent": null,
                  "user": {
                    "username": null
                  }
                },
                {
                  "id": null,
                  "mergeRequest": null,
                  "spentAt": null,
                  "summary": null,
                  "timeSpent": null,
                  "user": {
                    "username": null
                  }
                },
                {
                  "id": null,
                  "mergeRequest": null,
                  "spentAt": null,
                  "summary": null,
                  "timeSpent": null,
                  "user": {
                    "username": null
                  }
                },
                {
                  "id": null,
                  "mergeRequest": null,
                  "spentAt": null,
                  "summary": null,
                  "timeSpent": null,
                  "user": {
                    "username": null
                  }
                }
              ],
              "pageInfo": {
                "endCursor": null,
                "startCursor": null,
                "hasNextPage": null,
                "hasPreviousPage": null
              }
            }
          }
        ],
        "pageInfo": {
          "endCursor": null,
          "startCursor": null,
          "hasNextPage": null,
          "hasPreviousPage": null
        }
      }
    }
  },
  "correlationId": null
}

This Pull Request (PR) was marked stale because it has been open 90 days with no activity. Please remove the stale label or comment on this PR. Otherwise, it will be closed in 15 days.

This PR was closed because it has been marked stale for 15 days with no activity. If this PR is still valid, please re-open.