OpenAPITools / OpenAPITools/openapi-generator

Python generator produces unnecessary imports to __init__.py

Open
#18,144 2 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

In Python, speed of imports of larger codebases is quite crucial. Therefore, minimising the number of imports makes sense. Currently the generated Python code includes every sub-module in the __init__.py (for both main module, as well as api/ and models/) sub directories).

Describe the solution you'd like

The extra imports should be an option (if we want to be backwards compatible, by default on).

Describe alternatives you've considered

My current alternative is horrifying - post-processor step which does:

	echo > X/openapi_client/__init__.py
	echo > X/openapi_client/api/__init__.py
	echo > X/openapi_client/models/__init__.py

(where X is where I'm generating them)

Additional context

By doing ^ the import speed for tools which e.g. import ApiClient and use only one API over doubled. This is for project with few api/models to boot - with more, it gets even faster (in relation).

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

The request concerns generated init.py files in the main package and its api/ and models/ subdirectories. Start by locating the Python generator entry point and templates that produce these files, then inspect how generator options are defined. Done means the extra imports are controlled by an option and generated output reflects both settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.