openapi-generators / openapi-generators/openapi-python-client

`py.typed` file is generated with client, but exports do not follow rules, causing `reportPrivateImportUsage` error

Open
#1,127 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2k
Forks
293
Avg merge
34m
Merged PRs (30d)
1

Description

This tool generates a py.typed file but does not follow the associated export rules, causing a reportPrivateImportUsage when one imports from the generated client.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the generated py.typed file and the linked Pyright library-interface export rules. Reproduce the reportPrivateImportUsage error when importing from a generated client, then verify that the generated exports follow those rules without the diagnostic.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.